import {z} from 'zod' export type Country = 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AO' | 'AQ' | 'AR' | 'AS' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BV' | 'BW' | 'BY' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CK' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CU' | 'CV' | 'CW' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FM' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GS' | 'GT' | 'GU' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IO' | 'IQ' | 'IR' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'LY' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MH' | 'MK' | 'ML' | 'MM' | 'MN' | 'MO' | 'MP' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MW' | 'MX' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PR' | 'PS' | 'PT' | 'PW' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RU' | 'RW' | 'SA' | 'SB' | 'SC' | 'SD' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'SS' | 'ST' | 'SV' | 'SX' | 'SY' | 'SZ' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VE' | 'VG' | 'VI' | 'VN' | 'VU' | 'WF' | 'WS' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW'; export type CatalogsItemsPostFilters = {catalog_id?: string | undefined, catalog_type: 'RETAIL', item_ids: Array} | {catalog_id?: string | undefined, catalog_type: 'HOTEL', hotel_ids: Array} | {catalog_id?: string | undefined, catalog_type: 'CREATIVE_ASSETS', creative_assets_ids: Array}; export type CatalogsLocale = 'af-ZA' | 'ar-SA' | 'bg-BG' | 'bn-IN' | 'cs-CZ' | 'da-DK' | 'de' | 'el-GR' | 'en-AU' | 'en-CA' | 'en-GB' | 'en-IN' | 'en-US' | 'es-419' | 'es-AR' | 'es-ES' | 'es-MX' | 'fi-FI' | 'fr' | 'fr-CA' | 'he-IL' | 'hi-IN' | 'hr-HR' | 'hu-HU' | 'id-ID' | 'it' | 'ja' | 'ko-KR' | 'ms-MY' | 'nb-NO' | 'nl' | 'pl-PL' | 'pt-BR' | 'pt-PT' | 'ro-RO' | 'ru-RU' | 'sk-SK' | 'sv-SE' | 'te-IN' | 'th-TH' | 'tl-PH' | 'tr' | 'uk-UA' | 'vi-VN' | 'zh-CN' | 'zh-TW'; export type Language = 'AM' | 'AR' | 'AZ' | 'BG' | 'BN' | 'BS' | 'CA' | 'CS' | 'DA' | 'DV' | 'DZ' | 'DE' | 'EL' | 'EN' | 'ES' | 'ET' | 'FA' | 'FI' | 'FR' | 'HE' | 'HI' | 'HR' | 'HU' | 'HY' | 'ID' | 'IN' | 'IS' | 'IT' | 'IW' | 'JA' | 'KA' | 'KM' | 'KO' | 'LO' | 'LT' | 'LV' | 'MK' | 'MN' | 'MS' | 'MY' | 'NB' | 'NE' | 'NL' | 'NO' | 'PL' | 'PT' | 'RO' | 'RU' | 'SK' | 'SL' | 'SQ' | 'SR' | 'SV' | 'TL' | 'UK' | 'VI' | 'TE' | 'TH' | 'TR' | 'XX' | 'ZH'; export type CatalogsItemsRequest = {country: Country, filters: CatalogsItemsPostFilters, language: CatalogsLocale | Language}; export type CreateApiCatalogsItemsArgs = {ad_account_id?: string | undefined, body: CatalogsItemsRequest}; export type CreateApiCatalogsItemsOptions = {baseUrl?: string | undefined, pinterestOauth2?: string | undefined, fetch?: typeof fetch | undefined}; export const updatableItemAttributesGtinString = z.string().nullable(); export const updatableItemAttributesGtinInteger = z.number().int().nullable(); export const updatableItemAttributesGtin = z.union([updatableItemAttributesGtinString, updatableItemAttributesGtinInteger]).nullable(); export const itemAttributes = z.object({ad_image_0_link: z.string().max(2000).nullable().optional(), ad_image_0_tag: z.string().max(511).nullable().optional(), ad_image_10_link: z.string().max(2000).nullable().optional(), ad_image_10_tag: z.string().max(511).nullable().optional(), ad_image_11_link: z.string().max(2000).nullable().optional(), ad_image_11_tag: z.string().max(511).nullable().optional(), ad_image_12_link: z.string().max(2000).nullable().optional(), ad_image_12_tag: z.string().max(511).nullable().optional(), ad_image_13_link: z.string().max(2000).nullable().optional(), ad_image_13_tag: z.string().max(511).nullable().optional(), ad_image_14_link: z.string().max(2000).nullable().optional(), ad_image_14_tag: z.string().max(511).nullable().optional(), ad_image_15_link: z.string().max(2000).nullable().optional(), ad_image_15_tag: z.string().max(511).nullable().optional(), ad_image_16_link: z.string().max(2000).nullable().optional(), ad_image_16_tag: z.string().max(511).nullable().optional(), ad_image_17_link: z.string().max(2000).nullable().optional(), ad_image_17_tag: z.string().max(511).nullable().optional(), ad_image_18_link: z.string().max(2000).nullable().optional(), ad_image_18_tag: z.string().max(511).nullable().optional(), ad_image_19_link: z.string().max(2000).nullable().optional(), ad_image_19_tag: z.string().max(511).nullable().optional(), ad_image_1_link: z.string().max(2000).nullable().optional(), ad_image_1_tag: z.string().max(511).nullable().optional(), ad_image_2_link: z.string().max(2000).nullable().optional(), ad_image_2_tag: z.string().max(511).nullable().optional(), ad_image_3_link: z.string().max(2000).nullable().optional(), ad_image_3_tag: z.string().max(511).nullable().optional(), ad_image_4_link: z.string().max(2000).nullable().optional(), ad_image_4_tag: z.string().max(511).nullable().optional(), ad_image_5_link: z.string().max(2000).nullable().optional(), ad_image_5_tag: z.string().max(511).nullable().optional(), ad_image_6_link: z.string().max(2000).nullable().optional(), ad_image_6_tag: z.string().max(511).nullable().optional(), ad_image_7_link: z.string().max(2000).nullable().optional(), ad_image_7_tag: z.string().max(511).nullable().optional(), ad_image_8_link: z.string().max(2000).nullable().optional(), ad_image_8_tag: z.string().max(511).nullable().optional(), ad_image_9_link: z.string().max(2000).nullable().optional(), ad_image_9_tag: z.string().max(511).nullable().optional(), ad_link: z.string().nullable().optional(), ad_video_0_link: z.string().max(2000).nullable().optional(), ad_video_0_tag: z.string().max(511).nullable().optional(), ad_video_1_link: z.string().max(2000).nullable().optional(), ad_video_1_tag: z.string().max(511).nullable().optional(), ad_video_2_link: z.string().max(2000).nullable().optional(), ad_video_2_tag: z.string().max(511).nullable().optional(), adult: z.boolean().nullable().optional(), age_group: z.string().nullable().optional(), android_deep_link: z.string().optional(), availability: z.string().optional(), average_review_rating: z.number().nullable().optional(), brand: z.string().nullable().optional(), checkout_enabled: z.boolean().nullable().optional(), color: z.string().nullable().optional(), condition: z.string().nullable().optional(), custom_label_0: z.string().max(511).nullable().optional(), custom_label_1: z.string().max(511).nullable().optional(), custom_label_2: z.string().max(511).nullable().optional(), custom_label_3: z.string().max(511).nullable().optional(), custom_label_4: z.string().max(511).nullable().optional(), custom_number_0: z.number().int().nullable().optional(), custom_number_1: z.number().int().nullable().optional(), custom_number_2: z.number().int().nullable().optional(), custom_number_3: z.number().int().nullable().optional(), custom_number_4: z.number().int().nullable().optional(), description: z.string().optional(), free_shipping_label: z.boolean().nullable().optional(), free_shipping_limit: z.string().nullable().optional(), gender: z.string().nullable().optional(), google_product_category: z.string().nullable().optional(), gtin: updatableItemAttributesGtin.optional(), id: z.string().optional(), installment_price: z.string().nullable().optional(), ios_deep_link: z.string().optional(), item_group_id: z.string().nullable().optional(), last_updated_time: z.number().int().nullable().optional(), link: z.string().optional(), material: z.string().nullable().optional(), min_ad_price: z.string().nullable().optional(), mobile_link: z.string().nullable().optional(), mpn: z.string().nullable().optional(), number_of_ratings: z.number().int().nullable().optional(), number_of_reviews: z.number().int().nullable().optional(), pattern: z.string().nullable().optional(), price: z.string().optional(), product_type: z.string().nullable().optional(), promotion_id: z.string().nullable().optional(), sale_price: z.string().nullable().optional(), sale_price_effective_date: z.string().nullable().optional(), shipping: z.string().nullable().optional(), shipping_height: z.string().nullable().optional(), shipping_weight: z.string().nullable().optional(), shipping_width: z.string().nullable().optional(), size: z.string().nullable().optional(), size_system: z.string().nullable().optional(), size_type: z.string().nullable().optional(), tax: z.string().nullable().optional(), title: z.string().optional(), unit_pricing_base_measure: z.string().nullable().optional(), unit_pricing_measure: z.string().nullable().optional(), variant_names: z.array(z.string()).nullable().optional(), variant_values: z.array(z.string()).nullable().optional()}); export const aiDisclosureItem = z.enum(["AI_MODIFIED", "SYNTHETIC_PERFORMER"]); export const aiDisclosures = z.object({values: z.array(aiDisclosureItem)}); export const boardOwner = z.object({username: z.string().optional()}); export const creativeType = z.enum(["REGULAR", "VIDEO", "SHOPPING", "CAROUSEL", "MAX_VIDEO", "SHOP_THE_PIN", "COLLECTION", "IDEA", "SHOWCASE", "QUIZ", "COLLAGE", "MAX_WIDTH_REGULAR_COLLECTION", "MAX_WIDTH_VIDEO_COLLECTION", "APP"]); export const imageDetails = z.object({height: z.number().int().nullable(), url: z.string(), width: z.number().int().nullable()}); export const imageSize = z.object({"1200x": imageDetails.optional(), "150x150": imageDetails.optional(), "400x300": imageDetails.optional(), "600x": imageDetails.optional()}); export const imageMetadata = z.object({description: z.string().nullable().optional(), images: imageSize.optional(), item_type: z.literal("image"), link: z.string().nullable().optional(), title: z.string().nullable().optional()}); export const videoMetadataWithItemType = z.object({cover_image_url: z.string().optional(), duration: z.number().nullable().optional(), height: z.number().int().nullable().optional(), item_type: z.literal("video"), video_url: z.string().nullable().optional(), video_url_hls: z.string().nullable().optional(), width: z.number().int().nullable().optional()}); export const pinMediaMetadata = z.discriminatedUnion("item_type", [z.object({description: z.string().nullable().optional(), images: imageSize.optional(), item_type: z.literal("image"), link: z.string().nullable().optional(), title: z.string().nullable().optional()}), z.object({cover_image_url: z.string().optional(), duration: z.number().nullable().optional(), height: z.number().int().nullable().optional(), item_type: z.literal("video"), video_url: z.string().nullable().optional(), video_url_hls: z.string().nullable().optional(), width: z.number().int().nullable().optional()})]); export const pinMedia = z.discriminatedUnion("media_type", [z.object({images: imageSize.optional(), media_type: z.literal("image")}), z.object({cover_image_url: z.string().optional(), duration: z.number().nullable().optional(), height: z.number().int().nullable().optional(), images: imageSize.optional(), media_type: z.literal("video"), video_url: z.string().nullable().optional(), video_url_hls: z.string().nullable().optional(), width: z.number().int().nullable().optional()}), z.object({items: z.array(imageMetadata).optional(), media_type: z.literal("multiple_images")}), z.object({items: z.array(videoMetadataWithItemType).optional(), media_type: z.literal("multiple_videos")}), z.object({items: z.array(pinMediaMetadata).optional(), media_type: z.literal("multiple_mixed")})]); export const pin = z.object({ai_disclosures: aiDisclosures.optional(), board_id: z.string().optional(), board_owner: boardOwner.optional(), board_section_id: z.string().nullable().optional(), created_at: z.string().optional(), creative_type: creativeType.nullable().optional(), dominant_color: z.string().nullable().optional(), has_been_promoted: z.boolean().optional(), id: z.string(), is_owner: z.boolean().optional(), is_product: z.boolean().optional(), is_standard: z.boolean().optional(), media: pinMedia.optional(), parent_pin_id: z.string().nullable().optional(), pin_metrics: z.object({}).nullable().optional()}); export const catalogsHotelAddress = z.object({addr1: z.string().optional(), city: z.string().optional(), country: z.string().optional(), postal_code: z.string().optional(), region: z.string().optional()}); export const catalogsHotelGuestRatings = z.object({max_score: z.number().nullable().optional(), number_of_reviewers: z.number().int().nullable().optional(), rating_system: z.string().nullable().optional(), score: z.number().nullable().optional()}); export const catalogsHotelAttributes = z.object({address: catalogsHotelAddress.optional(), base_price: z.string().nullable().optional(), brand: z.string().nullable().optional(), category: z.string().nullable().optional(), custom_label_0: z.string().nullable().optional(), custom_label_1: z.string().nullable().optional(), custom_label_2: z.string().nullable().optional(), custom_label_3: z.string().nullable().optional(), custom_label_4: z.string().nullable().optional(), description: z.string().nullable().optional(), guest_ratings: catalogsHotelGuestRatings.optional(), latitude: z.number().optional(), link: z.string().nullable().optional(), longitude: z.number().nullable().optional(), name: z.string().nullable().optional(), neighborhood: z.array(z.string()).nullable().optional(), sale_price: z.string().nullable().optional()}); export const catalogsCreativeAssetsAttributes = z.object({android_deep_link: z.string().nullable().optional(), custom_label_0: z.string().nullable().optional(), custom_label_1: z.string().nullable().optional(), custom_label_2: z.string().nullable().optional(), custom_label_3: z.string().nullable().optional(), custom_label_4: z.string().nullable().optional(), description: z.string().optional(), google_product_category: z.string().nullable().optional(), ios_deep_link: z.string().nullable().optional(), link: z.string().optional(), title: z.string().optional(), visibility: z.string().nullable().optional()}); export const itemValidationEvent = z.object({attribute: z.string().optional(), code: z.number().int().optional(), message: z.string().optional()}); export const itemResponse = z.discriminatedUnion("item_response_kind", [z.object({attributes: itemAttributes.optional(), catalog_type: z.literal("RETAIL"), item_id: z.string().optional(), item_response_kind: z.literal("retail_item"), pins: z.array(pin).nullable().optional()}), z.object({attributes: catalogsHotelAttributes.optional(), catalog_type: z.literal("HOTEL"), hotel_id: z.string().optional(), item_response_kind: z.literal("hotel_item"), pins: z.array(pin).nullable().optional()}), z.object({attributes: catalogsCreativeAssetsAttributes.optional(), catalog_type: z.literal("CREATIVE_ASSETS"), creative_assets_id: z.string().optional(), item_response_kind: z.literal("creative_assets_item"), pins: z.array(pin).nullable().optional()}), z.object({catalog_type: z.literal("RETAIL"), errors: z.array(itemValidationEvent), item_id: z.string().optional(), item_response_kind: z.literal("retail_item_error")}), z.object({catalog_type: z.literal("HOTEL"), errors: z.array(itemValidationEvent), hotel_id: z.string().optional(), item_response_kind: z.literal("hotel_item_error")}), z.object({catalog_type: z.literal("CREATIVE_ASSETS"), creative_assets_id: z.string().optional(), errors: z.array(itemValidationEvent), item_response_kind: z.literal("creative_assets_item_error")})]); export const createApiCatalogsItemsResponse = z.object({items: z.array(itemResponse)}); 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 }; /** * Get catalogs items (POST) * * POST /catalogs/items */ export const createApiCatalogsItems = async (args: CreateApiCatalogsItemsArgs, options?: CreateApiCatalogsItemsOptions) => { const {baseUrl = "https://api.pinterest.com/v5", fetch: fetchFn = fetch, pinterestOauth2} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('content-type', "application/json") headers.set('accept', "application/json") if (args.ad_account_id != null) query.append("ad_account_id", String(args.ad_account_id)) if (pinterestOauth2 !== undefined) headers.set('authorization', `Bearer ${pinterestOauth2}`) const url = `${baseUrl.replace(/\/+$/, '')}/catalogs/items${query.size > 0 ? `?${query}` : ''}` const res = await fetchFn(url, {method: "POST", headers, body: JSON.stringify(args.body)}) if (!res.ok) throw new Error(`Request failed with status ${res.status}`, {cause: {status: res.status, body: await res.text()}}) return validateResponse(createApiCatalogsItemsResponse, await res.json()) };