import {z} from 'zod' export type V3ListCampaignFiltersSortOptionSortOptionKey = 'SORT_OPTION_KEY_UPDATE_TIME' | 'SORT_OPTION_KEY_NAME' | 'SORT_OPTION_KEY_END_TIME' | 'SORT_OPTION_KEY_APPROVAL_STATE' | 'SORT_OPTION_KEY_CAMPAIGN_STATE'; export type V3ListCampaignFiltersSortOptionSortOptionOrder = 'SORT_OPTION_ORDER_ASC' | 'SORT_OPTION_ORDER_DESC'; export type V3ListCampaignFiltersSortOption = {key?: V3ListCampaignFiltersSortOptionSortOptionKey | undefined, order?: V3ListCampaignFiltersSortOptionSortOptionOrder | undefined, lastValue?: string | undefined}; export type V3ListCampaignFilters = {pageToken?: string | undefined, pageSize?: unknown | undefined, sortOptions?: V3ListCampaignFiltersSortOption | undefined, name?: string | undefined, placementId?: string | undefined, teamId?: string | undefined, approvalState?: string | undefined, campaignState?: string | undefined, catalogIds?: Array | undefined, managedOnly?: boolean | undefined, requestTeamId: string, walletId?: string | undefined, campaignType?: string | undefined, ids?: Array | undefined, fromDate?: string | undefined, toDate?: string | undefined}; export type V3ListCampaignsRequest = {filters?: V3ListCampaignFilters | undefined}; export type CreateApiV3CampaignsArgs = {body: V3ListCampaignsRequest}; export type CreateApiV3CampaignsOptions = {baseUrl?: string | undefined, fetch?: typeof fetch | undefined}; export const campaignv3CampaignState = z.enum(["CAMPAIGN_STATE_UNSPECIFIED", "CAMPAIGN_STATE_ACTIVE", "CAMPAIGN_STATE_PAUSED", "CAMPAIGN_STATE_DRAFT", "CAMPAIGN_STATE_ARCHIVED"]); export const campaignv3CatalogProductSeller = z.object({catalogId: z.string().optional(), productCode: z.string().optional(), sellerId: z.string().optional()}); export const campaignv3AdvertisedProducts = z.object({productsByKey: z.array(campaignv3CatalogProductSeller).optional(), productGroupList: z.array(z.string()).optional()}); export const campaignv3SearchTermMatchType = z.enum(["MATCH_TYPE_UNSPECIFIED", "MATCH_TYPE_PHRASE_MATCH", "MATCH_TYPE_EXACT_MATCH"]); export const campaignv3SearchTerm = z.object({phrase: z.string().optional(), matchType: campaignv3SearchTermMatchType.optional(), collectionName: z.string().optional(), suggested: z.boolean().optional(), excludedProducts: z.array(campaignv3CatalogProductSeller).optional(), maxBid: z.string().optional(), treatAsCustom: z.boolean().optional()}); export const campaignv3CrossSell = z.object({targetProductsByKey: z.array(campaignv3CatalogProductSeller).optional()}); export const campaignv3Upsell = z.object({targetProductsByKey: z.array(campaignv3CatalogProductSeller).optional()}); export const campaignv3TargetedFilter = z.object({catalogId: z.string().optional(), filter: z.string().optional()}); export const v3NegativeSearchTermMatchType = z.enum(["MATCH_TYPE_UNSPECIFIED", "MATCH_TYPE_EXACT_MATCH", "MATCH_TYPE_PHRASE_MATCH"]); export const v3NegativeSearchTerm = z.object({phrase: z.string().optional(), matchType: v3NegativeSearchTermMatchType.optional()}); export const v3SegmentsSet = z.object({segmentIds: z.array(z.string()).optional()}); export const v3Audience = z.object({includeSegmentsSets: z.array(v3SegmentsSet).optional()}); export const campaignv3Targeting = z.object({searchTerms: z.array(campaignv3SearchTerm).optional(), crossSell: campaignv3CrossSell.optional(), upsell: campaignv3Upsell.optional(), excludeFilters: z.array(campaignv3TargetedFilter).optional(), includeFilters: z.array(campaignv3TargetedFilter).optional(), negativeSearchTerms: z.array(v3NegativeSearchTerm).optional(), audience: v3Audience.optional()}); export const campaignv3SpendLimit = z.object({daily: z.string().optional(), total: z.string().optional()}); export const campaignv3Auction = z.object({maxBid: z.string().optional(), spendLimit: campaignv3SpendLimit.optional()}); export const campaignv3CatalogCost = z.object({catalogId: z.string().optional(), catalogCostPercentage: z.number().lte(1).optional()}); export const campaignv3FixedTenancy = z.object({cost: z.string().optional(), positions: z.array(z.number().int().gte(1)).optional(), catalogCosts: z.array(campaignv3CatalogCost).optional()}); export const campaignv3Strategy = z.object({auction: campaignv3Auction.optional(), fixedTenancy: campaignv3FixedTenancy.optional()}); export const campaignv3FixedCosts = z.object({dataCost: z.string().optional(), creativeCost: z.string().optional(), otherCost: z.string().optional()}); export const campaignv3CustomField = z.object({customFieldId: z.string().optional(), content: z.string().optional()}); export const campaignv3CustomQuestion = z.object({customQuestionId: z.string().optional(), answers: z.array(z.string()).optional()}); export const bannerXConfigBannerXSlotType = z.enum(["BANNER_X_SLOT_TYPE_UNSPECIFIED", "BANNER_X_SLOT_TYPE_BANNER", "BANNER_X_SLOT_TYPE_SINGLE_TILE", "BANNER_X_SLOT_TYPE_DOUBLE_TILE"]); export const v3BannerXConfigBannerXBackgroundImagePosition = z.enum(["BANNER_X_BACKGROUND_IMAGE_POSITION_UNSPECIFIED", "BANNER_X_BACKGROUND_IMAGE_POSITION_REPEATING", "BANNER_X_BACKGROUND_IMAGE_POSITION_LEFTALIGNED", "BANNER_X_BACKGROUND_IMAGE_POSITION_RIGHTALIGNED", "BANNER_X_BACKGROUND_IMAGE_POSITION_TOPALIGNED", "BANNER_X_BACKGROUND_IMAGE_POSITION_BOTTOMALIGNED", "BANNER_X_BACKGROUND_IMAGE_POSITION_FILL"]); export const v3BannerXConfigBannerXHeroImageMode = z.enum(["BANNER_X_HERO_IMAGE_MODE_UNSPECIFIED", "BANNER_X_HERO_IMAGE_MODE_BLOCK", "BANNER_X_HERO_IMAGE_MODE_LANDSCAPE", "BANNER_X_HERO_IMAGE_MODE_PORTRAIT"]); export const v3AdditionalFields = z.object({id: z.string().optional(), value: z.string().optional()}); export const trackingTagTrackingTagProvider = z.enum(["TRACKING_TAG_PROVIDER_UNSPECIFIED", "TRACKING_TAG_PROVIDER_DV", "TRACKING_TAG_PROVIDER_DCM_CLICK", "TRACKING_TAG_PROVIDER_DCM_IMPRESSION", "TRACKING_TAG_PROVIDER_MOAT", "TRACKING_TAG_PROVIDER_IAS", "TRACKING_TAG_PROVIDER_GTM360", "TRACKING_TAG_PROVIDER_SIZMEK", "TRACKING_TAG_PROVIDER_ADFORM_CLICK", "TRACKING_TAG_PROVIDER_ADFORM_IMPRESSION", "TRACKING_TAG_PROVIDER_DV_IMAGE"]); export const v3TrackingTag = z.object({provider: trackingTagTrackingTagProvider.optional(), content: z.string().optional()}); export const bannerXConfigVideoConfig = z.object({fileId: z.string().optional()}); export const v3BannerXConfig = z.object({contentStandardId: z.string().optional(), slotId: z.string().optional(), slotType: bannerXConfigBannerXSlotType.optional(), headingText: z.string().optional(), bannerText: z.string().optional(), bannerTextColourHex: z.string().optional(), ctaFlag: z.boolean().optional(), ctaText: z.string().optional(), ctaTextAccessibility: z.string().optional(), ctaLink: z.string().optional(), backgroundColourHex: z.string().optional(), backgroundImageId: z.string().optional(), backgroundImagePosition: v3BannerXConfigBannerXBackgroundImagePosition.optional(), secondaryBackgroundImageId: z.string().optional(), secondaryBackgroundImagePosition: v3BannerXConfigBannerXBackgroundImagePosition.optional(), heroImageId: z.string().optional(), heroImageAltText: z.string().optional(), heroMode: v3BannerXConfigBannerXHeroImageMode.optional(), secondaryHeroImageId: z.string().optional(), secondaryHeroImageAltText: z.string().optional(), secondaryHeroMode: v3BannerXConfigBannerXHeroImageMode.optional(), additionalFields: z.array(v3AdditionalFields).optional(), trackingTagProvider: z.array(v3TrackingTag).optional(), primaryVideoConfig: bannerXConfigVideoConfig.optional(), companionProducts: z.array(campaignv3CatalogProductSeller).optional()}); export const v3SlotsConfiguration = z.object({slotId: z.string().optional(), artworkImageId: z.string().optional(), link: z.string().optional(), altText: z.string().optional(), text: z.string().optional(), trackingTagProvider: z.array(v3TrackingTag).optional()}); export const v3BannerConfig = z.object({contentStandardId: z.string().optional(), slotsConfiguration: z.array(v3SlotsConfiguration).optional()}); export const v3Campaign = z.object({id: z.string(), updateTime: z.string().optional(), name: z.string().optional(), namespaceId: z.string().optional(), campaignState: campaignv3CampaignState.optional(), templateId: z.string().optional(), managerTeamId: z.string().optional(), teamId: z.string().optional(), startTime: z.string().optional(), endTime: z.string().optional(), walletId: z.string().optional(), placementId: z.string().optional(), catalogIds: z.array(z.string()).optional(), advertisedProducts: campaignv3AdvertisedProducts.optional(), targeting: campaignv3Targeting.optional(), strategy: campaignv3Strategy.optional(), fixedCosts: campaignv3FixedCosts.optional(), customFields: z.array(campaignv3CustomField).optional(), customQuestions: z.array(campaignv3CustomQuestion).optional(), sellerId: z.string().optional(), bannerXConfig: v3BannerXConfig.optional(), bannerConfig: v3BannerConfig.optional()}); export const v3ListCampaignsResponse = z.object({campaigns: z.array(v3Campaign).optional(), nextPageToken: z.string().optional(), totalCount: z.string().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 }; /** * Retrieve list of all campaigns * * POST /v3/campaigns */ export const createApiV3Campaigns = async (args: CreateApiV3CampaignsArgs, options?: CreateApiV3CampaignsOptions) => { const {baseUrl = "https://auth..citrusad.com", fetch: fetchFn = fetch} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('content-type', "application/json") headers.set('accept', "application/json") const url = `${baseUrl.replace(/\/+$/, '')}/v3/campaigns${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(v3ListCampaignsResponse, await res.json()) };