@unified-api/typescript-sdk 2.83.19 → 2.83.20

package/src/sdk/models/operations/patchadscreative.ts

@@ -31,7 +31,7 @@ export const PatchAdsCreativeQueryParamFields = {
   ExternalCreativeReference: "external_creative_reference",
   ExternalPlacementReference: "external_placement_reference",
   ExternalAdReference: "external_ad_reference",
-  Metadata: "metadata",
+  Promoted: "promoted",
   Path1: "path1",
   Path2: "path2",
   Raw: "raw",

package/src/sdk/models/operations/patchadsgroup.ts

@@ -35,7 +35,7 @@ export const PatchAdsGroupQueryParamFields = {
   OptimizationGoal: "optimization_goal",
   BillingEvent: "billing_event",
   Currency: "currency",
-  Metadata: "metadata",
+  Promoted: "promoted",
   Raw: "raw",
 } as const;
 export type PatchAdsGroupQueryParamFields = ClosedEnum<

package/src/sdk/models/operations/updateadsad.ts

@@ -27,7 +27,7 @@ export const UpdateAdsAdQueryParamFields = {
   DisplayUrl: "display_url",
   Path1: "path1",
   Path2: "path2",
-  Metadata: "metadata",
+  Promoted: "promoted",
   Raw: "raw",
 } as const;
 export type UpdateAdsAdQueryParamFields = ClosedEnum<

package/src/sdk/models/operations/updateadscreative.ts

@@ -31,7 +31,7 @@ export const UpdateAdsCreativeQueryParamFields = {
   ExternalCreativeReference: "external_creative_reference",
   ExternalPlacementReference: "external_placement_reference",
   ExternalAdReference: "external_ad_reference",
-  Metadata: "metadata",
+  Promoted: "promoted",
   Path1: "path1",
   Path2: "path2",
   Raw: "raw",

package/src/sdk/models/operations/updateadsgroup.ts

@@ -35,7 +35,7 @@ export const UpdateAdsGroupQueryParamFields = {
   OptimizationGoal: "optimization_goal",
   BillingEvent: "billing_event",
   Currency: "currency",
-  Metadata: "metadata",
+  Promoted: "promoted",
   Raw: "raw",
 } as const;
 export type UpdateAdsGroupQueryParamFields = ClosedEnum<

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

@@ -10,11 +10,11 @@ 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";
+  AdsPromoted,
+  AdsPromoted$inboundSchema,
+  AdsPromoted$Outbound,
+  AdsPromoted$outboundSchema,
+} from "./adspromoted.js";
 
 export const AdType = {
   Text: "TEXT",
@@ -57,11 +57,11 @@ export type AdsAd = {
   groupId?: string | undefined;
   headline?: string | undefined;
   id?: string | undefined;
-  metadata?: Array<AdsMetadata> | undefined;
   name?: string | undefined;
   organizationId?: string | undefined;
   path1?: string | undefined;
   path2?: string | undefined;
+  promoted?: Array<AdsPromoted> | undefined;
   raw?: { [k: string]: any } | undefined;
   status?: AdsAdStatus | undefined;
   updatedAt?: Date | undefined;
@@ -105,11 +105,11 @@ export const AdsAd$inboundSchema: z.ZodType<AdsAd, z.ZodTypeDef, unknown> = z
     group_id: z.string().optional(),
     headline: z.string().optional(),
     id: z.string().optional(),
-    metadata: z.array(AdsMetadata$inboundSchema).optional(),
     name: z.string().optional(),
     organization_id: z.string().optional(),
     path1: z.string().optional(),
     path2: z.string().optional(),
+    promoted: z.array(AdsPromoted$inboundSchema).optional(),
     raw: z.record(z.any()).optional(),
     status: AdsAdStatus$inboundSchema.optional(),
     updated_at: z.string().datetime({ offset: true }).transform(v =>
@@ -145,11 +145,11 @@ export type AdsAd$Outbound = {
   group_id?: string | undefined;
   headline?: string | undefined;
   id?: string | undefined;
-  metadata?: Array<AdsMetadata$Outbound> | undefined;
   name?: string | undefined;
   organization_id?: string | undefined;
   path1?: string | undefined;
   path2?: string | undefined;
+  promoted?: Array<AdsPromoted$Outbound> | undefined;
   raw?: { [k: string]: any } | undefined;
   status?: string | undefined;
   updated_at?: string | undefined;
@@ -174,11 +174,11 @@ export const AdsAd$outboundSchema: z.ZodType<
   groupId: z.string().optional(),
   headline: z.string().optional(),
   id: z.string().optional(),
-  metadata: z.array(AdsMetadata$outboundSchema).optional(),
   name: z.string().optional(),
   organizationId: z.string().optional(),
   path1: z.string().optional(),
   path2: z.string().optional(),
+  promoted: z.array(AdsPromoted$outboundSchema).optional(),
   raw: z.record(z.any()).optional(),
   status: AdsAdStatus$outboundSchema.optional(),
   updatedAt: z.date().transform(v => v.toISOString()).optional(),

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

@@ -10,11 +10,11 @@ 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";
+  AdsPromoted,
+  AdsPromoted$inboundSchema,
+  AdsPromoted$Outbound,
+  AdsPromoted$outboundSchema,
+} from "./adspromoted.js";
 
 export const CreativeType = {
   Unspecified: "UNSPECIFIED",
@@ -67,11 +67,11 @@ export type AdsCreative = {
   id?: string | undefined;
   itemId?: string | undefined;
   linkUrl?: string | undefined;
-  metadata?: Array<AdsMetadata> | undefined;
   name?: string | undefined;
   organizationId?: string | undefined;
   path1?: string | undefined;
   path2?: string | undefined;
+  promoted?: Array<AdsPromoted> | undefined;
   raw?: { [k: string]: any } | undefined;
   status?: AdsCreativeStatus | undefined;
   thirdPartyTag?: string | undefined;
@@ -142,11 +142,11 @@ export const AdsCreative$inboundSchema: z.ZodType<
   id: 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(),
   path1: z.string().optional(),
   path2: z.string().optional(),
+  promoted: z.array(AdsPromoted$inboundSchema).optional(),
   raw: z.record(z.any()).optional(),
   status: AdsCreativeStatus$inboundSchema.optional(),
   third_party_tag: z.string().optional(),
@@ -191,11 +191,11 @@ export type AdsCreative$Outbound = {
   id?: string | undefined;
   item_id?: string | undefined;
   link_url?: string | undefined;
-  metadata?: Array<AdsMetadata$Outbound> | undefined;
   name?: string | undefined;
   organization_id?: string | undefined;
   path1?: string | undefined;
   path2?: string | undefined;
+  promoted?: Array<AdsPromoted$Outbound> | undefined;
   raw?: { [k: string]: any } | undefined;
   status?: string | undefined;
   third_party_tag?: string | undefined;
@@ -226,11 +226,11 @@ export const AdsCreative$outboundSchema: z.ZodType<
   id: 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(),
   path1: z.string().optional(),
   path2: z.string().optional(),
+  promoted: z.array(AdsPromoted$outboundSchema).optional(),
   raw: z.record(z.any()).optional(),
   status: AdsCreativeStatus$outboundSchema.optional(),
   thirdPartyTag: z.string().optional(),

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

@@ -10,11 +10,11 @@ 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";
+  AdsPromoted,
+  AdsPromoted$inboundSchema,
+  AdsPromoted$Outbound,
+  AdsPromoted$outboundSchema,
+} from "./adspromoted.js";
 import {
   PropertyAdsGroupBidStrategy,
   PropertyAdsGroupBidStrategy$inboundSchema,
@@ -141,12 +141,12 @@ export type AdsGroup = {
   hasEuPoliticalAds?: boolean | undefined;
   id?: string | undefined;
   insertionorderId?: string | undefined;
-  metadata?: Array<AdsMetadata> | undefined;
   name?: string | undefined;
   optimizationGoal?: OptimizationGoal | undefined;
   organizationId?: string | undefined;
   pacing?: PropertyAdsGroupPacing | undefined;
   parentId?: string | undefined;
+  promoted?: Array<AdsPromoted> | undefined;
   raw?: { [k: string]: any } | undefined;
   startAt?: Date | undefined;
   status?: AdsGroupStatus | undefined;
@@ -271,12 +271,12 @@ export const AdsGroup$inboundSchema: z.ZodType<
   has_eu_political_ads: z.boolean().optional(),
   id: z.string().optional(),
   insertionorder_id: z.string().optional(),
-  metadata: z.array(AdsMetadata$inboundSchema).optional(),
   name: z.string().optional(),
   optimization_goal: OptimizationGoal$inboundSchema.optional(),
   organization_id: z.string().optional(),
   pacing: PropertyAdsGroupPacing$inboundSchema.optional(),
   parent_id: z.string().optional(),
+  promoted: z.array(AdsPromoted$inboundSchema).optional(),
   raw: z.record(z.any()).optional(),
   start_at: z.string().datetime({ offset: true }).transform(v => new Date(v))
     .optional(),
@@ -328,12 +328,12 @@ export type AdsGroup$Outbound = {
   has_eu_political_ads?: boolean | undefined;
   id?: string | undefined;
   insertionorder_id?: string | 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;
+  promoted?: Array<AdsPromoted$Outbound> | undefined;
   raw?: { [k: string]: any } | undefined;
   start_at?: string | undefined;
   status?: string | undefined;
@@ -365,12 +365,12 @@ export const AdsGroup$outboundSchema: z.ZodType<
   hasEuPoliticalAds: z.boolean().optional(),
   id: z.string().optional(),
   insertionorderId: z.string().optional(),
-  metadata: z.array(AdsMetadata$outboundSchema).optional(),
   name: z.string().optional(),
   optimizationGoal: OptimizationGoal$outboundSchema.optional(),
   organizationId: z.string().optional(),
   pacing: PropertyAdsGroupPacing$outboundSchema.optional(),
   parentId: z.string().optional(),
+  promoted: z.array(AdsPromoted$outboundSchema).optional(),
   raw: z.record(z.any()).optional(),
   startAt: z.date().transform(v => v.toISOString()).optional(),
   status: AdsGroupStatus$outboundSchema.optional(),

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

@@ -0,0 +1,92 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../../lib/schemas.js";
+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";
+
+export const AdsPromotedType = {
+  PageId: "PAGE_ID",
+  AppId: "APP_ID",
+  StoreUrl: "STORE_URL",
+  PixelId: "PIXEL_ID",
+  CustomConversionId: "CUSTOM_CONVERSION_ID",
+  CatalogId: "CATALOG_ID",
+  ProductSetId: "PRODUCT_SET_ID",
+  PrioritizedSetId: "PRIORITIZED_SET_ID",
+  EventId: "EVENT_ID",
+  OfferId: "OFFER_ID",
+  LeadFormId: "LEAD_FORM_ID",
+  MessagingChannelId: "MESSAGING_CHANNEL_ID",
+  ProductId: "PRODUCT_ID",
+  TweetId: "TWEET_ID",
+  AdGroupType: "AD_GROUP_TYPE",
+} as const;
+export type AdsPromotedType = OpenEnum<typeof AdsPromotedType>;
+
+/**
+ * Promoted entity (e.g. page, app, product, tweet) for ads create
+ */
+export type AdsPromoted = {
+  id: string;
+  name?: string | undefined;
+  type: AdsPromotedType;
+};
+
+/** @internal */
+export const AdsPromotedType$inboundSchema: z.ZodType<
+  AdsPromotedType,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(AdsPromotedType);
+/** @internal */
+export const AdsPromotedType$outboundSchema: z.ZodType<
+  string,
+  z.ZodTypeDef,
+  AdsPromotedType
+> = openEnums.outboundSchema(AdsPromotedType);
+
+/** @internal */
+export const AdsPromoted$inboundSchema: z.ZodType<
+  AdsPromoted,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: z.string(),
+  name: z.string().optional(),
+  type: AdsPromotedType$inboundSchema,
+});
+/** @internal */
+export type AdsPromoted$Outbound = {
+  id: string;
+  name?: string | undefined;
+  type: string;
+};
+
+/** @internal */
+export const AdsPromoted$outboundSchema: z.ZodType<
+  AdsPromoted$Outbound,
+  z.ZodTypeDef,
+  AdsPromoted
+> = z.object({
+  id: z.string(),
+  name: z.string().optional(),
+  type: AdsPromotedType$outboundSchema,
+});
+
+export function adsPromotedToJSON(adsPromoted: AdsPromoted): string {
+  return JSON.stringify(AdsPromoted$outboundSchema.parse(adsPromoted));
+}
+export function adsPromotedFromJSON(
+  jsonString: string,
+): SafeParseResult<AdsPromoted, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AdsPromoted$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AdsPromoted' from JSON`,
+  );
+}