import {z} from 'zod' export type GettyImagesServicesConnectPublicControllersSearchModelAgeOfPeopleFilterType = 'newborn' | 'baby' | 'child' | 'teenager' | 'young_adult' | 'adult' | 'adults_only' | 'mature_adult' | 'senior_adult' | '0-1_months' | '2-5_months' | '6-11_months' | '12-17_months' | '18-23_months' | '2-3_years' | '4-5_years' | '6-7_years' | '8-9_years' | '10-11_years' | '12-13_years' | '14-15_years' | '16-17_years' | '18-19_years' | '20-24_years' | '20-29_years' | '25-29_years' | '30-34_years' | '30-39_years' | '35-39_years' | '40-44_years' | '40-49_years' | '45-49_years' | '50-54_years' | '50-59_years' | '55-59_years' | '60-64_years' | '60-69_years' | '65-69_years' | '70-79_years' | '80-89_years' | '90_plus_years' | '100_over'; export type GettyImagesServicesConnectPublicControllersSearchModelCollectionsFilterType = 'include' | 'exclude'; export type GettyImagesServicesConnectPublicControllersSearchModelCompositionsFilterType = 'abstract' | 'candid' | 'close_up' | 'copy_space' | 'cut_out' | 'full_frame' | 'full_length' | 'headshot' | 'looking_at_camera' | 'macro' | 'medium_shot' | 'part_of_a_series' | 'portrait' | 'sparse' | 'still_life' | 'three_quarter_length' | 'waist_up' | 'wide_shot'; export type GettyImagesServicesConnectPublicModelsEditorialSegmentContract = 'archival' | 'entertainment' | 'news' | 'publicity' | 'royalty' | 'sport'; export type GettyImagesServicesConnectPublicControllersSearchModelEthnicityFilterType = 'black' | 'white' | 'east_asian' | 'hispanic_latinx' | 'japanese' | 'middle_eastern' | 'multiracial_person' | 'multiethnic_group' | 'native_american_first_nations' | 'pacific_islander' | 'south_asian' | 'southeast_asian'; export type GettyImagesServicesConnectPublicControllersSearchModelEditorialImagesFieldValues = 'allowed_use' | 'alternative_ids' | 'artist' | 'asset_family' | 'call_for_image' | 'caption' | 'collection_code' | 'collection_id' | 'collection_name' | 'color_type' | 'comp' | 'comp_webp' | 'copyright' | 'date_camera_shot' | 'date_created' | 'date_submitted' | 'display_set' | 'download_product' | 'download_sizes' | 'editorial_segments' | 'editorial_source' | 'event_ids' | 'graphical_style' | 'id' | 'keywords' | 'largest_downloads' | 'license_model' | 'max_dimensions' | 'orientation' | 'people' | 'preview' | 'product_types' | 'quality_rank' | 'referral_destinations' | 'summary_set' | 'thumb' | 'title' | 'uri_oembed'; export type GettyImagesServicesConnectPublicControllersSearchModelSearchFileType = 'eps'; export type GettyImagesServicesConnectPublicControllersSearchModelEditorialGraphicalStyle = 'photography' | 'illustration' | 'vector'; export type GettyImagesServicesConnectPublicControllersSearchModelGraphicalStylesFilterType = 'include' | 'exclude'; export type GettyImagesServicesConnectPublicModelsTeeShirtSize = 'x_small' | 'small' | 'medium' | 'large' | 'x_large' | 'xx_large' | 'vector'; export type GettyImagesServicesConnectPublicControllersSearchModelNumberOfPeopleFilterType = 'none' | 'one' | 'two' | 'group'; export type GettyImagesServicesConnectPublicModelsImageOrientationRequest = 'horizontal' | 'vertical' | 'square' | 'panoramic_horizontal' | 'panoramic_vertical'; export type GettyImagesServicesConnectPublicControllersSearchModelSortOrder = 'best_match' | 'most_popular' | 'newest' | 'oldest' | 'random'; export type GettyImagesServicesConnectPublicControllersSearchFacetsEditorialImageSearchFacetsFields = 'artists' | 'events' | 'locations' | 'specific_people'; export type GetApiV3SearchImagesEditorialArgs = {'Accept-Language'?: string | undefined, 'GI-Country-Code'?: string | undefined, age_of_people?: Array | undefined, artists?: string | undefined, collection_codes?: Array | undefined, collections_filter_type?: GettyImagesServicesConnectPublicControllersSearchModelCollectionsFilterType | undefined, compositions?: Array | undefined, date_from?: string | undefined, date_to?: string | undefined, download_product?: string | undefined, editorial_segments?: Array | undefined, embed_content_only?: boolean | undefined, enhanced_search?: boolean | undefined, ethnicity?: Array | undefined, event_ids?: Array | undefined, exclude_keyword_ids?: Array | undefined, fields?: Array | undefined, file_types?: Array | undefined, graphical_styles?: Array | undefined, graphical_styles_filter_type?: GettyImagesServicesConnectPublicControllersSearchModelGraphicalStylesFilterType | undefined, include_related_searches?: boolean | undefined, keyword_ids?: Array | undefined, minimum_size?: GettyImagesServicesConnectPublicModelsTeeShirtSize | undefined, number_of_people?: Array | undefined, orientations?: Array | undefined, page?: number | undefined, page_size?: number | undefined, phrase?: string | undefined, sort_order?: GettyImagesServicesConnectPublicControllersSearchModelSortOrder | undefined, specific_people?: Array | undefined, minimum_quality_rank?: number | undefined, facet_fields?: Array | undefined, include_facets?: boolean | undefined, facet_max_count?: number | undefined}; export type GetApiV3SearchImagesEditorialOptions = {baseUrl: string, ApiKey?: string | undefined, fetch?: typeof fetch | undefined}; export const gettyImagesServicesConnectPublicModelsSearchEditorialSource = z.object({id: z.number().int().optional()}); export const gettyImagesServicesConnectPublicModelsAllowedUse = z.object({how_can_i_use_it: z.string().nullable().optional(), release_info: z.string().nullable().optional(), usage_restrictions: z.array(z.string()).nullable().optional(), editorial_use_only: z.boolean().optional()}); export const gettyImagesServicesConnectPublicModelsContributor = z.object({member_name: z.string().nullable().optional(), display_name: z.string().nullable().optional()}); export const gettyImagesServicesConnectPublicModelsSearchImageSearchItemDisplaySize = z.object({is_watermarked: z.boolean().optional(), name: z.string().nullable().optional(), uri: z.string().nullable().optional()}); export const gettyImagesServicesConnectPublicModelsImagesImageDownloadAuthorization = z.object({product_id: z.string().nullable().optional(), product_type: z.string().nullable().optional(), uri: z.string().nullable().optional(), agreement_name: z.string().nullable().optional()}); export const gettyImagesServicesConnectPublicModelsTeeShirtSize = z.enum(["x_small", "small", "medium", "large", "x_large", "xx_large", "vector"]); export const gettyImagesServicesConnectPublicModelsImagesImageDownloadSize = z.object({bytes: z.number().int().optional(), downloads: z.array(gettyImagesServicesConnectPublicModelsImagesImageDownloadAuthorization).nullable().optional(), height: z.number().int().optional(), media_type: z.string().nullable().optional(), name: gettyImagesServicesConnectPublicModelsTeeShirtSize.optional(), width: z.number().int().optional(), dpi: z.number().int().optional()}); export const gettyImagesServicesConnectPublicModelsKeyword = z.object({keyword_id: z.string().nullable().optional(), text: z.string().nullable().optional(), type: z.string().nullable().optional(), relevance: z.number().int().nullable().optional()}); export const gettyImagesServicesConnectPublicModelsDownload = z.object({product_id: z.string().nullable().optional(), product_type: z.string().nullable().optional(), uri: z.string().nullable().optional(), agreement_name: z.string().nullable().optional()}); export const gettyImagesServicesConnectPublicModelsMaxDimensions = z.object({height: z.number().int().optional(), width: z.number().int().optional()}); export const gettyImagesServicesConnectPublicModelsReferralDestination = z.object({site_name: z.string().nullable().optional(), uri: z.string().nullable().optional()}); export const gettyImagesServicesConnectPublicModelsTerritoryRestriction = z.object({country_code: z.string().nullable().optional(), type: z.string().nullable().optional(), description: z.string().nullable().optional()}); export const gettyImagesServicesConnectPublicModelsSearchNewModelsEditorialImage = z.object({istock_collection: z.string().nullable().optional(), editorial_segments: z.array(z.string()).nullable().optional(), editorial_source: gettyImagesServicesConnectPublicModelsSearchEditorialSource.optional(), event_ids: z.array(z.number().int()).nullable().optional(), era: z.string().nullable().optional(), people: z.array(z.string()).nullable().optional(), istock_exclusive: z.boolean().nullable().optional(), allowed_use: gettyImagesServicesConnectPublicModelsAllowedUse.optional(), alternative_ids: z.record(z.string(), z.string().nullable()).nullable().optional(), artist: z.string().nullable().optional(), asset_family: z.string().nullable().optional(), asset_type: z.string().nullable().optional(), call_for_image: z.boolean().nullable().optional(), caption: z.string().nullable().optional(), collection_code: z.string().nullable().optional(), collection_id: z.number().int().nullable().optional(), collection_name: z.string().nullable().optional(), color_type: z.string().nullable().optional(), contributor: gettyImagesServicesConnectPublicModelsContributor.optional(), copyright: z.string().nullable().optional(), date_camera_shot: z.string().nullable().optional(), date_created: z.string().nullable().optional(), display_sizes: z.array(gettyImagesServicesConnectPublicModelsSearchImageSearchItemDisplaySize).nullable().optional(), download_product: z.string().nullable().optional(), download_sizes: z.array(gettyImagesServicesConnectPublicModelsImagesImageDownloadSize).nullable().optional(), graphical_style: z.string().nullable().optional(), id: z.string().nullable().optional(), keywords: z.array(gettyImagesServicesConnectPublicModelsKeyword).nullable().optional(), largest_downloads: z.array(gettyImagesServicesConnectPublicModelsDownload).nullable().optional(), license_model: z.string().nullable().optional(), max_dimensions: gettyImagesServicesConnectPublicModelsMaxDimensions.optional(), orientation: z.string().nullable().optional(), product_types: z.array(z.string()).nullable().optional(), quality_rank: z.number().int().nullable().optional(), referral_destinations: z.array(gettyImagesServicesConnectPublicModelsReferralDestination).nullable().optional(), territory_restrictions: z.array(gettyImagesServicesConnectPublicModelsTerritoryRestriction).nullable().optional(), title: z.string().nullable().optional(), uri_oembed: z.string().nullable().optional(), date_submitted: z.string().nullable().optional()}); export const gettyImagesServicesConnectPublicControllersSearchFacetsSpecificPeople = z.object({id: z.number().int().optional(), name: z.string().nullable().optional()}); export const gettyImagesServicesConnectPublicControllersSearchFacetsFacetEvent = z.object({id: z.number().int().optional(), name: z.string().nullable().optional(), date: z.string().optional()}); export const gettyImagesServicesConnectPublicControllersSearchFacetsLocation = z.object({id: z.number().int().optional(), name: z.string().nullable().optional()}); export const gettyImagesServicesConnectPublicControllersSearchFacetsArtist = z.object({name: z.string().nullable().optional()}); export const gettyImagesServicesConnectPublicControllersSearchFacetsEntertainment = z.object({id: z.number().int().optional(), name: z.string().nullable().optional()}); export const gettyImagesServicesConnectPublicControllersSearchFacetsSearchFacetsResponse = z.object({specific_people: z.array(gettyImagesServicesConnectPublicControllersSearchFacetsSpecificPeople).nullable().optional(), events: z.array(gettyImagesServicesConnectPublicControllersSearchFacetsFacetEvent).nullable().optional(), locations: z.array(gettyImagesServicesConnectPublicControllersSearchFacetsLocation).nullable().optional(), artists: z.array(gettyImagesServicesConnectPublicControllersSearchFacetsArtist).nullable().optional(), entertainment: z.array(gettyImagesServicesConnectPublicControllersSearchFacetsEntertainment).nullable().optional()}); export const gettyImagesServicesConnectPublicModelsSearchAutoCorrections = z.object({phrase: z.string().nullable().optional()}); export const gettyImagesServicesConnectPublicDomainServicesAssetRelatedSearch = z.object({phrase: z.string().nullable().optional(), url: z.string().nullable().optional()}); export const gettyImagesServicesConnectPublicModelsSearchNewModelsSearchResponse1GettyImagesServicesConnectPublicModelsSearchNewModelsEditorialImage = z.object({result_count: z.number().int().optional(), images: z.array(gettyImagesServicesConnectPublicModelsSearchNewModelsEditorialImage).nullable().optional(), facets: gettyImagesServicesConnectPublicControllersSearchFacetsSearchFacetsResponse.optional(), auto_corrections: gettyImagesServicesConnectPublicModelsSearchAutoCorrections.optional(), related_searches: z.array(gettyImagesServicesConnectPublicDomainServicesAssetRelatedSearch).nullable().optional()}); export const validateResponse = async ( schema: { readonly '~standard': { readonly validate: (value: unknown) => ({ readonly value: Output; readonly issues?: undefined } | { readonly issues: ReadonlyArray<{ readonly message: string; readonly path?: ReadonlyArray | undefined }> }) | Promise<{ readonly value: Output; readonly issues?: undefined } | { readonly issues: ReadonlyArray<{ readonly message: string; readonly path?: ReadonlyArray | undefined }> }> } }, value: unknown ): Promise => { const result = await schema['~standard'].validate(value) if (result.issues !== undefined) { const detail = result.issues .map(({ message, path }) => path?.length ? `${path.map((segment) => String(typeof segment === 'object' ? segment.key : segment)).join('.')}: ${message}` : message ) .join('; ') throw new Error(`Response does not match the schema: ${detail}`, { cause: { issues: result.issues } }) } return result.value }; /** * Search for editorial images only * * GET /v3/search/images/editorial * * Also accepts auth: OAuth2 */ export const getApiV3SearchImagesEditorial = async (args: GetApiV3SearchImagesEditorialArgs, options: GetApiV3SearchImagesEditorialOptions) => { const {baseUrl, fetch: fetchFn = fetch, ApiKey} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (args['Accept-Language'] != null) headers.set("Accept-Language", String(args['Accept-Language'])) if (args['GI-Country-Code'] != null) headers.set("GI-Country-Code", String(args['GI-Country-Code'])) if (args.age_of_people != null) query.append("age_of_people", args.age_of_people.join(',')) if (args.artists != null) query.append("artists", String(args.artists)) if (args.collection_codes != null) query.append("collection_codes", args.collection_codes.join(',')) if (args.collections_filter_type != null) query.append("collections_filter_type", String(args.collections_filter_type)) if (args.compositions != null) query.append("compositions", args.compositions.join(',')) if (args.date_from != null) query.append("date_from", String(args.date_from)) if (args.date_to != null) query.append("date_to", String(args.date_to)) if (args.download_product != null) query.append("download_product", String(args.download_product)) if (args.editorial_segments != null) query.append("editorial_segments", args.editorial_segments.join(',')) if (args.embed_content_only != null) query.append("embed_content_only", String(args.embed_content_only)) if (args.enhanced_search != null) query.append("enhanced_search", String(args.enhanced_search)) if (args.ethnicity != null) query.append("ethnicity", args.ethnicity.join(',')) if (args.event_ids != null) query.append("event_ids", args.event_ids.join(',')) if (args.exclude_keyword_ids != null) query.append("exclude_keyword_ids", args.exclude_keyword_ids.join(',')) if (args.fields != null) query.append("fields", args.fields.join(',')) if (args.file_types != null) query.append("file_types", args.file_types.join(',')) if (args.graphical_styles != null) query.append("graphical_styles", args.graphical_styles.join(',')) if (args.graphical_styles_filter_type != null) query.append("graphical_styles_filter_type", String(args.graphical_styles_filter_type)) if (args.include_related_searches != null) query.append("include_related_searches", String(args.include_related_searches)) if (args.keyword_ids != null) query.append("keyword_ids", args.keyword_ids.join(',')) if (args.minimum_size != null) query.append("minimum_size", String(args.minimum_size)) if (args.number_of_people != null) query.append("number_of_people", args.number_of_people.join(',')) if (args.orientations != null) query.append("orientations", args.orientations.join(',')) if (args.page != null) query.append("page", String(args.page)) if (args.page_size != null) query.append("page_size", String(args.page_size)) if (args.phrase != null) query.append("phrase", String(args.phrase)) if (args.sort_order != null) query.append("sort_order", String(args.sort_order)) if (args.specific_people != null) query.append("specific_people", args.specific_people.join(',')) if (args.minimum_quality_rank != null) query.append("minimum_quality_rank", String(args.minimum_quality_rank)) if (args.facet_fields != null) query.append("facet_fields", args.facet_fields.join(',')) if (args.include_facets != null) query.append("include_facets", String(args.include_facets)) if (args.facet_max_count != null) query.append("facet_max_count", String(args.facet_max_count)) if (ApiKey !== undefined) headers.set("Api-Key", ApiKey) const url = `${baseUrl.replace(/\/+$/, '')}/v3/search/images/editorial${query.size > 0 ? `?${query}` : ''}` const res = await fetchFn(url, {method: "GET", headers}) if (!res.ok) throw new Error(`Request failed with status ${res.status}`, {cause: {status: res.status, body: await res.text()}}) return validateResponse(gettyImagesServicesConnectPublicModelsSearchNewModelsSearchResponse1GettyImagesServicesConnectPublicModelsSearchNewModelsEditorialImage, await res.json()) };