@unified-api/typescript-sdk 2.83.11 → 2.83.13

package/src/sdk/models/shared/adscreative.ts

@@ -9,6 +9,12 @@ import * as openEnums from "../../types/enums.js";
 import { OpenEnum } from "../../types/enums.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  AdsMetadata,
+  AdsMetadata$inboundSchema,
+  AdsMetadata$Outbound,
+  AdsMetadata$outboundSchema,
+} from "./adsmetadata.js";
 
 export const CreativeType = {
   Unspecified: "UNSPECIFIED",
@@ -47,9 +53,11 @@ export type AdsCreative = {
    * Hosted asset mode (best-effort, provider-specific
    */
   assetUrls?: Array<string> | undefined;
+  body?: string | undefined;
   campaignId?: string | undefined;
   createdAt?: Date | undefined;
   creativeType?: CreativeType | undefined;
+  cta?: string | undefined;
   externalAdReference?: string | undefined;
   externalCreativeReference?: string | undefined;
   externalPlacementReference?: string | undefined;
@@ -57,14 +65,23 @@ export type AdsCreative = {
   height?: number | undefined;
   hostingSource?: HostingSource | undefined;
   id?: string | undefined;
+  imageHash?: string | undefined;
   itemId?: string | undefined;
+  linkUrl?: string | undefined;
+  metadata?: Array<AdsMetadata> | undefined;
   name?: string | undefined;
   organizationId?: string | undefined;
+  pageIdentifier?: string | undefined;
+  path1?: string | undefined;
+  path2?: string | undefined;
   raw?: { [k: string]: any } | undefined;
   status?: AdsCreativeStatus | undefined;
   thirdPartyTag?: string | undefined;
+  thumbnailUrl?: string | undefined;
+  title?: string | undefined;
   updatedAt?: Date | undefined;
   vastTagUrl?: string | undefined;
+  videoId?: string | undefined;
   width?: number | undefined;
 };
 
@@ -114,10 +131,12 @@ export const AdsCreative$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   asset_urls: z.array(z.string()).optional(),
+  body: z.string().optional(),
   campaign_id: z.string().optional(),
   created_at: z.string().datetime({ offset: true }).transform(v => new Date(v))
     .optional(),
   creative_type: CreativeType$inboundSchema.optional(),
+  cta: z.string().optional(),
   external_ad_reference: z.string().optional(),
   external_creative_reference: z.string().optional(),
   external_placement_reference: z.string().optional(),
@@ -125,15 +144,24 @@ export const AdsCreative$inboundSchema: z.ZodType<
   height: z.number().optional(),
   hosting_source: HostingSource$inboundSchema.optional(),
   id: z.string().optional(),
+  image_hash: z.string().optional(),
   item_id: z.string().optional(),
+  link_url: z.string().optional(),
+  metadata: z.array(AdsMetadata$inboundSchema).optional(),
   name: z.string().optional(),
   organization_id: z.string().optional(),
+  page_identifier: z.string().optional(),
+  path1: z.string().optional(),
+  path2: z.string().optional(),
   raw: z.record(z.any()).optional(),
   status: AdsCreativeStatus$inboundSchema.optional(),
   third_party_tag: z.string().optional(),
+  thumbnail_url: z.string().optional(),
+  title: z.string().optional(),
   updated_at: z.string().datetime({ offset: true }).transform(v => new Date(v))
     .optional(),
   vast_tag_url: z.string().optional(),
+  video_id: z.string().optional(),
   width: z.number().optional(),
 }).transform((v) => {
   return remap$(v, {
@@ -146,19 +174,26 @@ export const AdsCreative$inboundSchema: z.ZodType<
     "external_placement_reference": "externalPlacementReference",
     "group_id": "groupId",
     "hosting_source": "hostingSource",
+    "image_hash": "imageHash",
     "item_id": "itemId",
+    "link_url": "linkUrl",
     "organization_id": "organizationId",
+    "page_identifier": "pageIdentifier",
     "third_party_tag": "thirdPartyTag",
+    "thumbnail_url": "thumbnailUrl",
     "updated_at": "updatedAt",
     "vast_tag_url": "vastTagUrl",
+    "video_id": "videoId",
   });
 });
 /** @internal */
 export type AdsCreative$Outbound = {
   asset_urls?: Array<string> | undefined;
+  body?: string | undefined;
   campaign_id?: string | undefined;
   created_at?: string | undefined;
   creative_type?: string | undefined;
+  cta?: string | undefined;
   external_ad_reference?: string | undefined;
   external_creative_reference?: string | undefined;
   external_placement_reference?: string | undefined;
@@ -166,14 +201,23 @@ export type AdsCreative$Outbound = {
   height?: number | undefined;
   hosting_source?: string | undefined;
   id?: string | undefined;
+  image_hash?: string | undefined;
   item_id?: string | undefined;
+  link_url?: string | undefined;
+  metadata?: Array<AdsMetadata$Outbound> | undefined;
   name?: string | undefined;
   organization_id?: string | undefined;
+  page_identifier?: string | undefined;
+  path1?: string | undefined;
+  path2?: string | undefined;
   raw?: { [k: string]: any } | undefined;
   status?: string | undefined;
   third_party_tag?: string | undefined;
+  thumbnail_url?: string | undefined;
+  title?: string | undefined;
   updated_at?: string | undefined;
   vast_tag_url?: string | undefined;
+  video_id?: string | undefined;
   width?: number | undefined;
 };
 
@@ -184,9 +228,11 @@ export const AdsCreative$outboundSchema: z.ZodType<
   AdsCreative
 > = z.object({
   assetUrls: z.array(z.string()).optional(),
+  body: z.string().optional(),
   campaignId: z.string().optional(),
   createdAt: z.date().transform(v => v.toISOString()).optional(),
   creativeType: CreativeType$outboundSchema.optional(),
+  cta: z.string().optional(),
   externalAdReference: z.string().optional(),
   externalCreativeReference: z.string().optional(),
   externalPlacementReference: z.string().optional(),
@@ -194,14 +240,23 @@ export const AdsCreative$outboundSchema: z.ZodType<
   height: z.number().optional(),
   hostingSource: HostingSource$outboundSchema.optional(),
   id: z.string().optional(),
+  imageHash: z.string().optional(),
   itemId: z.string().optional(),
+  linkUrl: z.string().optional(),
+  metadata: z.array(AdsMetadata$outboundSchema).optional(),
   name: z.string().optional(),
   organizationId: z.string().optional(),
+  pageIdentifier: z.string().optional(),
+  path1: z.string().optional(),
+  path2: z.string().optional(),
   raw: z.record(z.any()).optional(),
   status: AdsCreativeStatus$outboundSchema.optional(),
   thirdPartyTag: z.string().optional(),
+  thumbnailUrl: z.string().optional(),
+  title: z.string().optional(),
   updatedAt: z.date().transform(v => v.toISOString()).optional(),
   vastTagUrl: z.string().optional(),
+  videoId: z.string().optional(),
   width: z.number().optional(),
 }).transform((v) => {
   return remap$(v, {
@@ -214,11 +269,16 @@ export const AdsCreative$outboundSchema: z.ZodType<
     externalPlacementReference: "external_placement_reference",
     groupId: "group_id",
     hostingSource: "hosting_source",
+    imageHash: "image_hash",
     itemId: "item_id",
+    linkUrl: "link_url",
     organizationId: "organization_id",
+    pageIdentifier: "page_identifier",
     thirdPartyTag: "third_party_tag",
+    thumbnailUrl: "thumbnail_url",
     updatedAt: "updated_at",
     vastTagUrl: "vast_tag_url",
+    videoId: "video_id",
   });
 });
 

package/src/sdk/models/shared/adsgroup.ts

@@ -9,6 +9,12 @@ import * as openEnums from "../../types/enums.js";
 import { OpenEnum } from "../../types/enums.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  AdsMetadata,
+  AdsMetadata$inboundSchema,
+  AdsMetadata$Outbound,
+  AdsMetadata$outboundSchema,
+} from "./adsmetadata.js";
 import {
   PropertyAdsGroupBidStrategy,
   PropertyAdsGroupBidStrategy$inboundSchema,
@@ -68,19 +74,30 @@ export const AdsGroupStatus = {
 export type AdsGroupStatus = OpenEnum<typeof AdsGroupStatus>;
 
 export const AdsGroupType = {
-  Display: "DISPLAY",
+  Text: "TEXT",
+  Image: "IMAGE",
   Video: "VIDEO",
+  Responsive: "RESPONSIVE",
+  Shopping: "SHOPPING",
+  App: "APP",
+  Call: "CALL",
+  Carousel: "CAROUSEL",
+  Social: "SOCIAL",
+  Display: "DISPLAY",
+  Search: "SEARCH",
   Audio: "AUDIO",
   Youtube: "YOUTUBE",
 } as const;
 export type AdsGroupType = OpenEnum<typeof AdsGroupType>;
 
 export type AdsGroup = {
+  adGroupType?: string | undefined;
   bidAmount?: number | undefined;
   /**
    * YOUTUBE_AND_PARTNERS
    */
   bidStrategy?: PropertyAdsGroupBidStrategy | undefined;
+  billingEvent?: string | undefined;
   budgetAllocationType?: BudgetAllocationType | undefined;
   budgetAmount?: number | undefined;
   budgetMaxAmount?: number | undefined;
@@ -90,13 +107,16 @@ export type AdsGroup = {
   createdAt?: Date | undefined;
   creativeIds?: Array<string> | undefined;
   currency?: string | undefined;
+  dailySpendCap?: number | undefined;
   endAt?: Date | undefined;
   frequencyCap?: PropertyAdsGroupFrequencyCap | undefined;
   hasEuPoliticalAds?: boolean | undefined;
   id?: string | undefined;
   insertionorderId?: string | undefined;
-  isActive?: boolean | undefined;
+  lifetimeSpendCap?: number | undefined;
+  metadata?: Array<AdsMetadata> | undefined;
   name?: string | undefined;
+  optimizationGoal?: string | undefined;
   organizationId?: string | undefined;
   pacing?: PropertyAdsGroupPacing | undefined;
   parentId?: string | undefined;
@@ -179,8 +199,10 @@ export const AdsGroup$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
+  ad_group_type: z.string().optional(),
   bid_amount: z.number().optional(),
   bid_strategy: PropertyAdsGroupBidStrategy$inboundSchema.optional(),
+  billing_event: z.string().optional(),
   budget_allocation_type: BudgetAllocationType$inboundSchema.optional(),
   budget_amount: z.number().optional(),
   budget_max_amount: z.number().optional(),
@@ -191,14 +213,17 @@ export const AdsGroup$inboundSchema: z.ZodType<
     .optional(),
   creative_ids: z.array(z.string()).optional(),
   currency: z.string().optional(),
+  daily_spend_cap: z.number().optional(),
   end_at: z.string().datetime({ offset: true }).transform(v => new Date(v))
     .optional(),
   frequency_cap: PropertyAdsGroupFrequencyCap$inboundSchema.optional(),
   has_eu_political_ads: z.boolean().optional(),
   id: z.string().optional(),
   insertionorder_id: z.string().optional(),
-  is_active: z.boolean().optional(),
+  lifetime_spend_cap: z.number().optional(),
+  metadata: z.array(AdsMetadata$inboundSchema).optional(),
   name: z.string().optional(),
+  optimization_goal: z.string().optional(),
   organization_id: z.string().optional(),
   pacing: PropertyAdsGroupPacing$inboundSchema.optional(),
   parent_id: z.string().optional(),
@@ -212,8 +237,10 @@ export const AdsGroup$inboundSchema: z.ZodType<
     .optional(),
 }).transform((v) => {
   return remap$(v, {
+    "ad_group_type": "adGroupType",
     "bid_amount": "bidAmount",
     "bid_strategy": "bidStrategy",
+    "billing_event": "billingEvent",
     "budget_allocation_type": "budgetAllocationType",
     "budget_amount": "budgetAmount",
     "budget_max_amount": "budgetMaxAmount",
@@ -222,11 +249,13 @@ export const AdsGroup$inboundSchema: z.ZodType<
     "campaign_id": "campaignId",
     "created_at": "createdAt",
     "creative_ids": "creativeIds",
+    "daily_spend_cap": "dailySpendCap",
     "end_at": "endAt",
     "frequency_cap": "frequencyCap",
     "has_eu_political_ads": "hasEuPoliticalAds",
     "insertionorder_id": "insertionorderId",
-    "is_active": "isActive",
+    "lifetime_spend_cap": "lifetimeSpendCap",
+    "optimization_goal": "optimizationGoal",
     "organization_id": "organizationId",
     "parent_id": "parentId",
     "start_at": "startAt",
@@ -235,8 +264,10 @@ export const AdsGroup$inboundSchema: z.ZodType<
 });
 /** @internal */
 export type AdsGroup$Outbound = {
+  ad_group_type?: string | undefined;
   bid_amount?: number | undefined;
   bid_strategy?: PropertyAdsGroupBidStrategy$Outbound | undefined;
+  billing_event?: string | undefined;
   budget_allocation_type?: string | undefined;
   budget_amount?: number | undefined;
   budget_max_amount?: number | undefined;
@@ -246,13 +277,16 @@ export type AdsGroup$Outbound = {
   created_at?: string | undefined;
   creative_ids?: Array<string> | undefined;
   currency?: string | undefined;
+  daily_spend_cap?: number | undefined;
   end_at?: string | undefined;
   frequency_cap?: PropertyAdsGroupFrequencyCap$Outbound | undefined;
   has_eu_political_ads?: boolean | undefined;
   id?: string | undefined;
   insertionorder_id?: string | undefined;
-  is_active?: boolean | undefined;
+  lifetime_spend_cap?: number | undefined;
+  metadata?: Array<AdsMetadata$Outbound> | undefined;
   name?: string | undefined;
+  optimization_goal?: string | undefined;
   organization_id?: string | undefined;
   pacing?: PropertyAdsGroupPacing$Outbound | undefined;
   parent_id?: string | undefined;
@@ -270,8 +304,10 @@ export const AdsGroup$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   AdsGroup
 > = z.object({
+  adGroupType: z.string().optional(),
   bidAmount: z.number().optional(),
   bidStrategy: PropertyAdsGroupBidStrategy$outboundSchema.optional(),
+  billingEvent: z.string().optional(),
   budgetAllocationType: BudgetAllocationType$outboundSchema.optional(),
   budgetAmount: z.number().optional(),
   budgetMaxAmount: z.number().optional(),
@@ -281,13 +317,16 @@ export const AdsGroup$outboundSchema: z.ZodType<
   createdAt: z.date().transform(v => v.toISOString()).optional(),
   creativeIds: z.array(z.string()).optional(),
   currency: z.string().optional(),
+  dailySpendCap: z.number().optional(),
   endAt: z.date().transform(v => v.toISOString()).optional(),
   frequencyCap: PropertyAdsGroupFrequencyCap$outboundSchema.optional(),
   hasEuPoliticalAds: z.boolean().optional(),
   id: z.string().optional(),
   insertionorderId: z.string().optional(),
-  isActive: z.boolean().optional(),
+  lifetimeSpendCap: z.number().optional(),
+  metadata: z.array(AdsMetadata$outboundSchema).optional(),
   name: z.string().optional(),
+  optimizationGoal: z.string().optional(),
   organizationId: z.string().optional(),
   pacing: PropertyAdsGroupPacing$outboundSchema.optional(),
   parentId: z.string().optional(),
@@ -299,8 +338,10 @@ export const AdsGroup$outboundSchema: z.ZodType<
   updatedAt: z.date().transform(v => v.toISOString()).optional(),
 }).transform((v) => {
   return remap$(v, {
+    adGroupType: "ad_group_type",
     bidAmount: "bid_amount",
     bidStrategy: "bid_strategy",
+    billingEvent: "billing_event",
     budgetAllocationType: "budget_allocation_type",
     budgetAmount: "budget_amount",
     budgetMaxAmount: "budget_max_amount",
@@ -309,11 +350,13 @@ export const AdsGroup$outboundSchema: z.ZodType<
     campaignId: "campaign_id",
     createdAt: "created_at",
     creativeIds: "creative_ids",
+    dailySpendCap: "daily_spend_cap",
     endAt: "end_at",
     frequencyCap: "frequency_cap",
     hasEuPoliticalAds: "has_eu_political_ads",
     insertionorderId: "insertionorder_id",
-    isActive: "is_active",
+    lifetimeSpendCap: "lifetime_spend_cap",
+    optimizationGoal: "optimization_goal",
     organizationId: "organization_id",
     parentId: "parent_id",
     startAt: "start_at",

package/src/sdk/models/shared/adsmetadata.ts

@@ -0,0 +1,217 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type One = {};
+
+export type Five = One | string | number | boolean;
+
+export type Value =
+  | { [k: string]: any }
+  | string
+  | number
+  | boolean
+  | Array<One | string | number | boolean>;
+
+export type AdsMetadata = {
+  id?: string | undefined;
+  slug?: string | undefined;
+  value?:
+    | { [k: string]: any }
+    | string
+    | number
+    | boolean
+    | Array<One | string | number | boolean>
+    | undefined;
+};
+
+/** @internal */
+export const One$inboundSchema: z.ZodType<One, z.ZodTypeDef, unknown> = z
+  .object({});
+/** @internal */
+export type One$Outbound = {};
+
+/** @internal */
+export const One$outboundSchema: z.ZodType<One$Outbound, z.ZodTypeDef, One> = z
+  .object({});
+
+export function oneToJSON(one: One): string {
+  return JSON.stringify(One$outboundSchema.parse(one));
+}
+export function oneFromJSON(
+  jsonString: string,
+): SafeParseResult<One, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => One$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'One' from JSON`,
+  );
+}
+
+/** @internal */
+export const Five$inboundSchema: z.ZodType<Five, z.ZodTypeDef, unknown> = z
+  .union([
+    z.lazy(() => One$inboundSchema),
+    z.string(),
+    z.number(),
+    z.boolean(),
+  ]);
+/** @internal */
+export type Five$Outbound = One$Outbound | string | number | boolean;
+
+/** @internal */
+export const Five$outboundSchema: z.ZodType<Five$Outbound, z.ZodTypeDef, Five> =
+  z.union([
+    z.lazy(() => One$outboundSchema),
+    z.string(),
+    z.number(),
+    z.boolean(),
+  ]);
+
+export function fiveToJSON(five: Five): string {
+  return JSON.stringify(Five$outboundSchema.parse(five));
+}
+export function fiveFromJSON(
+  jsonString: string,
+): SafeParseResult<Five, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Five$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Five' from JSON`,
+  );
+}
+
+/** @internal */
+export const Value$inboundSchema: z.ZodType<Value, z.ZodTypeDef, unknown> = z
+  .union([
+    z.record(z.any()),
+    z.string(),
+    z.number(),
+    z.boolean(),
+    z.array(
+      z.union([
+        z.lazy(() => One$inboundSchema),
+        z.string(),
+        z.number(),
+        z.boolean(),
+      ]),
+    ),
+  ]);
+/** @internal */
+export type Value$Outbound =
+  | { [k: string]: any }
+  | string
+  | number
+  | boolean
+  | Array<One$Outbound | string | number | boolean>;
+
+/** @internal */
+export const Value$outboundSchema: z.ZodType<
+  Value$Outbound,
+  z.ZodTypeDef,
+  Value
+> = z.union([
+  z.record(z.any()),
+  z.string(),
+  z.number(),
+  z.boolean(),
+  z.array(
+    z.union([
+      z.lazy(() => One$outboundSchema),
+      z.string(),
+      z.number(),
+      z.boolean(),
+    ]),
+  ),
+]);
+
+export function valueToJSON(value: Value): string {
+  return JSON.stringify(Value$outboundSchema.parse(value));
+}
+export function valueFromJSON(
+  jsonString: string,
+): SafeParseResult<Value, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Value$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Value' from JSON`,
+  );
+}
+
+/** @internal */
+export const AdsMetadata$inboundSchema: z.ZodType<
+  AdsMetadata,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: z.string().optional(),
+  slug: z.string().optional(),
+  value: z.union([
+    z.record(z.any()),
+    z.string(),
+    z.number(),
+    z.boolean(),
+    z.array(
+      z.union([
+        z.lazy(() => One$inboundSchema),
+        z.string(),
+        z.number(),
+        z.boolean(),
+      ]),
+    ),
+  ]).optional(),
+});
+/** @internal */
+export type AdsMetadata$Outbound = {
+  id?: string | undefined;
+  slug?: string | undefined;
+  value?:
+    | { [k: string]: any }
+    | string
+    | number
+    | boolean
+    | Array<One$Outbound | string | number | boolean>
+    | undefined;
+};
+
+/** @internal */
+export const AdsMetadata$outboundSchema: z.ZodType<
+  AdsMetadata$Outbound,
+  z.ZodTypeDef,
+  AdsMetadata
+> = z.object({
+  id: z.string().optional(),
+  slug: z.string().optional(),
+  value: z.union([
+    z.record(z.any()),
+    z.string(),
+    z.number(),
+    z.boolean(),
+    z.array(
+      z.union([
+        z.lazy(() => One$outboundSchema),
+        z.string(),
+        z.number(),
+        z.boolean(),
+      ]),
+    ),
+  ]).optional(),
+});
+
+export function adsMetadataToJSON(adsMetadata: AdsMetadata): string {
+  return JSON.stringify(AdsMetadata$outboundSchema.parse(adsMetadata));
+}
+export function adsMetadataFromJSON(
+  jsonString: string,
+): SafeParseResult<AdsMetadata, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AdsMetadata$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AdsMetadata' from JSON`,
+  );
+}