@unified-api/typescript-sdk 2.83.18 → 2.83.20

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,
@@ -40,6 +40,20 @@ import {
   PropertyAdsGroupTargeting$outboundSchema,
 } from "./propertyadsgrouptargeting.js";
 
+export const BillingEvent = {
+  Impressions: "IMPRESSIONS",
+  LinkClicks: "LINK_CLICKS",
+  VideoViews: "VIDEO_VIEWS",
+  AppInstalls: "APP_INSTALLS",
+  Engagement: "ENGAGEMENT",
+  PageLikes: "PAGE_LIKES",
+  Messages: "MESSAGES",
+  PostEngagement: "POST_ENGAGEMENT",
+  Purchase: "PURCHASE",
+  None: "NONE",
+} as const;
+export type BillingEvent = OpenEnum<typeof BillingEvent>;
+
 export const BudgetAllocationType = {
   Unspecified: "UNSPECIFIED",
   Automatic: "AUTOMATIC",
@@ -63,6 +77,22 @@ export const BudgetUnit = {
 } as const;
 export type BudgetUnit = OpenEnum<typeof BudgetUnit>;
 
+export const OptimizationGoal = {
+  Reach: "REACH",
+  Impressions: "IMPRESSIONS",
+  LinkClicks: "LINK_CLICKS",
+  LandingPageViews: "LANDING_PAGE_VIEWS",
+  Conversions: "CONVERSIONS",
+  LeadGeneration: "LEAD_GENERATION",
+  AppInstalls: "APP_INSTALLS",
+  AppEngagement: "APP_ENGAGEMENT",
+  VideoViews: "VIDEO_VIEWS",
+  Engagement: "ENGAGEMENT",
+  PageLikes: "PAGE_LIKES",
+  Messages: "MESSAGES",
+} as const;
+export type OptimizationGoal = OpenEnum<typeof OptimizationGoal>;
+
 export const AdsGroupStatus = {
   Unspecified: "UNSPECIFIED",
   Active: "ACTIVE",
@@ -96,7 +126,7 @@ export type AdsGroup = {
    * YOUTUBE_AND_PARTNERS
    */
   bidStrategy?: PropertyAdsGroupBidStrategy | undefined;
-  billingEvent?: string | undefined;
+  billingEvent?: BillingEvent | undefined;
   budgetAllocationType?: BudgetAllocationType | undefined;
   budgetAmount?: number | undefined;
   budgetMaxAmount?: number | undefined;
@@ -111,12 +141,12 @@ export type AdsGroup = {
   hasEuPoliticalAds?: boolean | undefined;
   id?: string | undefined;
   insertionorderId?: string | undefined;
-  metadata?: Array<AdsMetadata> | undefined;
   name?: string | undefined;
-  optimizationGoal?: 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;
@@ -125,6 +155,19 @@ export type AdsGroup = {
   updatedAt?: Date | undefined;
 };
 
+/** @internal */
+export const BillingEvent$inboundSchema: z.ZodType<
+  BillingEvent,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(BillingEvent);
+/** @internal */
+export const BillingEvent$outboundSchema: z.ZodType<
+  string,
+  z.ZodTypeDef,
+  BillingEvent
+> = openEnums.outboundSchema(BillingEvent);
+
 /** @internal */
 export const BudgetAllocationType$inboundSchema: z.ZodType<
   BudgetAllocationType,
@@ -164,6 +207,19 @@ export const BudgetUnit$outboundSchema: z.ZodType<
   BudgetUnit
 > = openEnums.outboundSchema(BudgetUnit);
 
+/** @internal */
+export const OptimizationGoal$inboundSchema: z.ZodType<
+  OptimizationGoal,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(OptimizationGoal);
+/** @internal */
+export const OptimizationGoal$outboundSchema: z.ZodType<
+  string,
+  z.ZodTypeDef,
+  OptimizationGoal
+> = openEnums.outboundSchema(OptimizationGoal);
+
 /** @internal */
 export const AdsGroupStatus$inboundSchema: z.ZodType<
   AdsGroupStatus,
@@ -198,7 +254,7 @@ export const AdsGroup$inboundSchema: z.ZodType<
 > = z.object({
   bid_amount: z.number().optional(),
   bid_strategy: PropertyAdsGroupBidStrategy$inboundSchema.optional(),
-  billing_event: z.string().optional(),
+  billing_event: BillingEvent$inboundSchema.optional(),
   budget_allocation_type: BudgetAllocationType$inboundSchema.optional(),
   budget_amount: z.number().optional(),
   budget_max_amount: z.number().optional(),
@@ -215,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: 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(),
@@ -272,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;
@@ -294,7 +350,7 @@ export const AdsGroup$outboundSchema: z.ZodType<
 > = z.object({
   bidAmount: z.number().optional(),
   bidStrategy: PropertyAdsGroupBidStrategy$outboundSchema.optional(),
-  billingEvent: z.string().optional(),
+  billingEvent: BillingEvent$outboundSchema.optional(),
   budgetAllocationType: BudgetAllocationType$outboundSchema.optional(),
   budgetAmount: z.number().optional(),
   budgetMaxAmount: z.number().optional(),
@@ -309,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: 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/adskeyword.ts

@@ -0,0 +1,85 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../../lib/primitives.js";
+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 MatchType = {
+  Broad: "BROAD",
+  Phrase: "PHRASE",
+  Exact: "EXACT",
+} as const;
+export type MatchType = OpenEnum<typeof MatchType>;
+
+/**
+ * Content targeting (keywords, topics, placements, video)
+ */
+export type AdsKeyword = {
+  matchType?: MatchType | undefined;
+  text: string;
+};
+
+/** @internal */
+export const MatchType$inboundSchema: z.ZodType<
+  MatchType,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(MatchType);
+/** @internal */
+export const MatchType$outboundSchema: z.ZodType<
+  string,
+  z.ZodTypeDef,
+  MatchType
+> = openEnums.outboundSchema(MatchType);
+
+/** @internal */
+export const AdsKeyword$inboundSchema: z.ZodType<
+  AdsKeyword,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  match_type: MatchType$inboundSchema.optional(),
+  text: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "match_type": "matchType",
+  });
+});
+/** @internal */
+export type AdsKeyword$Outbound = {
+  match_type?: string | undefined;
+  text: string;
+};
+
+/** @internal */
+export const AdsKeyword$outboundSchema: z.ZodType<
+  AdsKeyword$Outbound,
+  z.ZodTypeDef,
+  AdsKeyword
+> = z.object({
+  matchType: MatchType$outboundSchema.optional(),
+  text: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    matchType: "match_type",
+  });
+});
+
+export function adsKeywordToJSON(adsKeyword: AdsKeyword): string {
+  return JSON.stringify(AdsKeyword$outboundSchema.parse(adsKeyword));
+}
+export function adsKeywordFromJSON(
+  jsonString: string,
+): SafeParseResult<AdsKeyword, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AdsKeyword$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AdsKeyword' from JSON`,
+  );
+}

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`,
+  );
+}

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

@@ -0,0 +1,65 @@
+/*
+ * 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 AdsTargetType = {
+  Interests: "interests",
+  Behaviors: "behaviors",
+  Locales: "locales",
+  Countries: "countries",
+  Regions: "regions",
+  Cities: "cities",
+  Zips: "zips",
+  UsDmas: "us_dmas",
+  Topics: "topics",
+  UserLists: "user_lists",
+  AgeRanges: "age_ranges",
+  Genders: "genders",
+} as const;
+export type AdsTargetType = OpenEnum<typeof AdsTargetType>;
+
+/**
+ * Targeting search result (for ads_target list endpoint)
+ */
+export type AdsTarget = {
+  id: string;
+  name?: string | undefined;
+  type?: AdsTargetType | undefined;
+  value: string;
+};
+
+/** @internal */
+export const AdsTargetType$inboundSchema: z.ZodType<
+  AdsTargetType,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(AdsTargetType);
+
+/** @internal */
+export const AdsTarget$inboundSchema: z.ZodType<
+  AdsTarget,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: z.string(),
+  name: z.string().optional(),
+  type: AdsTargetType$inboundSchema.optional(),
+  value: z.string(),
+});
+
+export function adsTargetFromJSON(
+  jsonString: string,
+): SafeParseResult<AdsTarget, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AdsTarget$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AdsTarget' from JSON`,
+  );
+}