@unified-api/typescript-sdk 2.83.11 → 2.83.13

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

@@ -22,11 +22,22 @@ export const PatchAdsCreativeQueryParamFields = {
   Width: "width",
   Height: "height",
   AssetUrls: "asset_urls",
+  PageIdentifier: "page_identifier",
+  LinkUrl: "link_url",
+  Body: "body",
+  Title: "title",
+  Cta: "cta",
+  ThumbnailUrl: "thumbnail_url",
+  ImageHash: "image_hash",
+  VideoId: "video_id",
   ThirdPartyTag: "third_party_tag",
   VastTagUrl: "vast_tag_url",
   ExternalCreativeReference: "external_creative_reference",
   ExternalPlacementReference: "external_placement_reference",
   ExternalAdReference: "external_ad_reference",
+  Metadata: "metadata",
+  Path1: "path1",
+  Path2: "path2",
   Raw: "raw",
 } as const;
 export type PatchAdsCreativeQueryParamFields = ClosedEnum<

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

@@ -19,7 +19,6 @@ export const PatchAdsGroupQueryParamFields = {
   Status: "status",
   Targeting: "targeting",
   BidAmount: "bid_amount",
-  Currency: "currency",
   BidStrategy: "bid_strategy",
   BudgetAmount: "budget_amount",
   BudgetPeriod: "budget_period",
@@ -33,7 +32,13 @@ export const PatchAdsGroupQueryParamFields = {
   Pacing: "pacing",
   FrequencyCap: "frequency_cap",
   CreativeIds: "creative_ids",
-  IsActive: "is_active",
+  OptimizationGoal: "optimization_goal",
+  BillingEvent: "billing_event",
+  DailySpendCap: "daily_spend_cap",
+  LifetimeSpendCap: "lifetime_spend_cap",
+  AdGroupType: "ad_group_type",
+  Currency: "currency",
+  Metadata: "metadata",
   Raw: "raw",
 } as const;
 export type PatchAdsGroupQueryParamFields = ClosedEnum<

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

@@ -18,6 +18,7 @@ export const PatchMetadataMetadataQueryParamFields = {
   Options: "options",
   ObjectType: "object_type",
   Objects: "objects",
+  IsRequired: "is_required",
   Raw: "raw",
 } as const;
 export type PatchMetadataMetadataQueryParamFields = ClosedEnum<

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

@@ -13,10 +13,12 @@ export const PatchPaymentPaymentQueryParamFields = {
   UpdatedAt: "updated_at",
   TotalAmount: "total_amount",
   ContactId: "contact_id",
+  Type: "type",
   PaymentMethod: "payment_method",
   Currency: "currency",
   Notes: "notes",
   InvoiceId: "invoice_id",
+  BillId: "bill_id",
   AccountId: "account_id",
   Reference: "reference",
   Raw: "raw",

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

@@ -27,6 +27,12 @@ export const UpdateAdsAdQueryParamFields = {
   FinalUrl: "final_url",
   Targeting: "targeting",
   IsActive: "is_active",
+  EndAt: "end_at",
+  StartAt: "start_at",
+  DisplayUrl: "display_url",
+  Path1: "path1",
+  Path2: "path2",
+  Metadata: "metadata",
   Raw: "raw",
 } as const;
 export type UpdateAdsAdQueryParamFields = ClosedEnum<

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

@@ -18,14 +18,17 @@ export const UpdateAdsCampaignQueryParamFields = {
   EndAt: "end_at",
   BudgetAmount: "budget_amount",
   BudgetPeriod: "budget_period",
-  Currency: "currency",
   TotalSpendAmount: "total_spend_amount",
   Targeting: "targeting",
-  Raw: "raw",
   Goal: "goal",
   PlannedSpendAmount: "planned_spend_amount",
   FrequencyCap: "frequency_cap",
-  IsActive: "is_active",
+  BidStrategy: "bid_strategy",
+  SpecialAdCategories: "special_ad_categories",
+  AdvertisingChannelType: "advertising_channel_type",
+  CampaignBudgetIdentifier: "campaign_budget_identifier",
+  Currency: "currency",
+  Raw: "raw",
 } as const;
 export type UpdateAdsCampaignQueryParamFields = ClosedEnum<
   typeof UpdateAdsCampaignQueryParamFields

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

@@ -22,11 +22,22 @@ export const UpdateAdsCreativeQueryParamFields = {
   Width: "width",
   Height: "height",
   AssetUrls: "asset_urls",
+  PageIdentifier: "page_identifier",
+  LinkUrl: "link_url",
+  Body: "body",
+  Title: "title",
+  Cta: "cta",
+  ThumbnailUrl: "thumbnail_url",
+  ImageHash: "image_hash",
+  VideoId: "video_id",
   ThirdPartyTag: "third_party_tag",
   VastTagUrl: "vast_tag_url",
   ExternalCreativeReference: "external_creative_reference",
   ExternalPlacementReference: "external_placement_reference",
   ExternalAdReference: "external_ad_reference",
+  Metadata: "metadata",
+  Path1: "path1",
+  Path2: "path2",
   Raw: "raw",
 } as const;
 export type UpdateAdsCreativeQueryParamFields = ClosedEnum<

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

@@ -19,7 +19,6 @@ export const UpdateAdsGroupQueryParamFields = {
   Status: "status",
   Targeting: "targeting",
   BidAmount: "bid_amount",
-  Currency: "currency",
   BidStrategy: "bid_strategy",
   BudgetAmount: "budget_amount",
   BudgetPeriod: "budget_period",
@@ -33,7 +32,13 @@ export const UpdateAdsGroupQueryParamFields = {
   Pacing: "pacing",
   FrequencyCap: "frequency_cap",
   CreativeIds: "creative_ids",
-  IsActive: "is_active",
+  OptimizationGoal: "optimization_goal",
+  BillingEvent: "billing_event",
+  DailySpendCap: "daily_spend_cap",
+  LifetimeSpendCap: "lifetime_spend_cap",
+  AdGroupType: "ad_group_type",
+  Currency: "currency",
+  Metadata: "metadata",
   Raw: "raw",
 } as const;
 export type UpdateAdsGroupQueryParamFields = ClosedEnum<

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

@@ -18,6 +18,7 @@ export const UpdateMetadataMetadataQueryParamFields = {
   Options: "options",
   ObjectType: "object_type",
   Objects: "objects",
+  IsRequired: "is_required",
   Raw: "raw",
 } as const;
 export type UpdateMetadataMetadataQueryParamFields = ClosedEnum<

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

@@ -13,10 +13,12 @@ export const UpdatePaymentPaymentQueryParamFields = {
   UpdatedAt: "updated_at",
   TotalAmount: "total_amount",
   ContactId: "contact_id",
+  Type: "type",
   PaymentMethod: "payment_method",
   Currency: "currency",
   Notes: "notes",
   InvoiceId: "invoice_id",
+  BillId: "bill_id",
   AccountId: "account_id",
   Reference: "reference",
   Raw: "raw",

package/src/sdk/models/shared/adsad.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 {
   PropertyAdsAdTargeting,
   PropertyAdsAdTargeting$inboundSchema,
@@ -26,6 +32,10 @@ export const AdType = {
   Call: "CALL",
   Carousel: "CAROUSEL",
   Social: "SOCIAL",
+  Display: "DISPLAY",
+  Search: "SEARCH",
+  Audio: "AUDIO",
+  Youtube: "YOUTUBE",
 } as const;
 export type AdType = OpenEnum<typeof AdType>;
 
@@ -48,15 +58,21 @@ export type AdsAd = {
   creativeIds?: Array<string> | undefined;
   cta?: string | undefined;
   description?: string | undefined;
+  displayUrl?: string | undefined;
+  endAt?: Date | undefined;
   finalUrl?: string | undefined;
   groupId?: string | undefined;
   headline?: string | undefined;
   id?: string | undefined;
   isActive?: boolean | undefined;
   itemId?: string | undefined;
+  metadata?: Array<AdsMetadata> | undefined;
   name?: string | undefined;
   organizationId?: string | undefined;
+  path1?: string | undefined;
+  path2?: string | undefined;
   raw?: { [k: string]: any } | undefined;
+  startAt?: Date | undefined;
   status?: AdsAdStatus | undefined;
   targeting?: PropertyAdsAdTargeting | undefined;
   updatedAt?: Date | undefined;
@@ -95,15 +111,23 @@ export const AdsAd$inboundSchema: z.ZodType<AdsAd, z.ZodTypeDef, unknown> = z
     creative_ids: z.array(z.string()).optional(),
     cta: z.string().optional(),
     description: z.string().optional(),
+    display_url: z.string().optional(),
+    end_at: z.string().datetime({ offset: true }).transform(v => new Date(v))
+      .optional(),
     final_url: z.string().optional(),
     group_id: z.string().optional(),
     headline: z.string().optional(),
     id: z.string().optional(),
     is_active: z.boolean().optional(),
     item_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(),
     raw: z.record(z.any()).optional(),
+    start_at: z.string().datetime({ offset: true }).transform(v => new Date(v))
+      .optional(),
     status: AdsAdStatus$inboundSchema.optional(),
     targeting: PropertyAdsAdTargeting$inboundSchema.optional(),
     updated_at: z.string().datetime({ offset: true }).transform(v =>
@@ -117,11 +141,14 @@ export const AdsAd$inboundSchema: z.ZodType<AdsAd, z.ZodTypeDef, unknown> = z
       "created_at": "createdAt",
       "creative_asset_url": "creativeAssetUrl",
       "creative_ids": "creativeIds",
+      "display_url": "displayUrl",
+      "end_at": "endAt",
       "final_url": "finalUrl",
       "group_id": "groupId",
       "is_active": "isActive",
       "item_id": "itemId",
       "organization_id": "organizationId",
+      "start_at": "startAt",
       "updated_at": "updatedAt",
     });
   });
@@ -135,15 +162,21 @@ export type AdsAd$Outbound = {
   creative_ids?: Array<string> | undefined;
   cta?: string | undefined;
   description?: string | undefined;
+  display_url?: string | undefined;
+  end_at?: string | undefined;
   final_url?: string | undefined;
   group_id?: string | undefined;
   headline?: string | undefined;
   id?: string | undefined;
   is_active?: boolean | undefined;
   item_id?: string | undefined;
+  metadata?: Array<AdsMetadata$Outbound> | undefined;
   name?: string | undefined;
   organization_id?: string | undefined;
+  path1?: string | undefined;
+  path2?: string | undefined;
   raw?: { [k: string]: any } | undefined;
+  start_at?: string | undefined;
   status?: string | undefined;
   targeting?: PropertyAdsAdTargeting$Outbound | undefined;
   updated_at?: string | undefined;
@@ -163,15 +196,21 @@ export const AdsAd$outboundSchema: z.ZodType<
   creativeIds: z.array(z.string()).optional(),
   cta: z.string().optional(),
   description: z.string().optional(),
+  displayUrl: z.string().optional(),
+  endAt: z.date().transform(v => v.toISOString()).optional(),
   finalUrl: z.string().optional(),
   groupId: z.string().optional(),
   headline: z.string().optional(),
   id: z.string().optional(),
   isActive: z.boolean().optional(),
   itemId: 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(),
   raw: z.record(z.any()).optional(),
+  startAt: z.date().transform(v => v.toISOString()).optional(),
   status: AdsAdStatus$outboundSchema.optional(),
   targeting: PropertyAdsAdTargeting$outboundSchema.optional(),
   updatedAt: z.date().transform(v => v.toISOString()).optional(),
@@ -183,11 +222,14 @@ export const AdsAd$outboundSchema: z.ZodType<
     createdAt: "created_at",
     creativeAssetUrl: "creative_asset_url",
     creativeIds: "creative_ids",
+    displayUrl: "display_url",
+    endAt: "end_at",
     finalUrl: "final_url",
     groupId: "group_id",
     isActive: "is_active",
     itemId: "item_id",
     organizationId: "organization_id",
+    startAt: "start_at",
     updatedAt: "updated_at",
   });
 });

package/src/sdk/models/shared/adscampaign.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 {
+  PropertyAdsCampaignBidStrategy,
+  PropertyAdsCampaignBidStrategy$inboundSchema,
+  PropertyAdsCampaignBidStrategy$Outbound,
+  PropertyAdsCampaignBidStrategy$outboundSchema,
+} from "./propertyadscampaignbidstrategy.js";
 import {
   PropertyAdsCampaignFrequencyCap,
   PropertyAdsCampaignFrequencyCap$inboundSchema,
@@ -22,6 +28,23 @@ import {
   PropertyAdsCampaignTargeting$outboundSchema,
 } from "./propertyadscampaigntargeting.js";
 
+export const AdvertisingChannelType = {
+  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 AdvertisingChannelType = OpenEnum<typeof AdvertisingChannelType>;
+
 export const BudgetPeriod = {
   Daily: "DAILY",
   Monthly: "MONTHLY",
@@ -52,19 +75,25 @@ export const AdsCampaignStatus = {
 export type AdsCampaignStatus = OpenEnum<typeof AdsCampaignStatus>;
 
 export type AdsCampaign = {
+  advertisingChannelType?: AdvertisingChannelType | undefined;
+  /**
+   * YOUTUBE_AND_PARTNERS
+   */
+  bidStrategy?: PropertyAdsCampaignBidStrategy | undefined;
   budgetAmount?: number | undefined;
   budgetPeriod?: BudgetPeriod | undefined;
+  campaignBudgetIdentifier?: string | undefined;
   createdAt?: Date | undefined;
   currency?: string | undefined;
   endAt?: Date | undefined;
   frequencyCap?: PropertyAdsCampaignFrequencyCap | undefined;
   goal?: Goal | undefined;
   id?: string | undefined;
-  isActive?: boolean | undefined;
   name?: string | undefined;
   organizationId?: string | undefined;
   plannedSpendAmount?: number | undefined;
   raw?: { [k: string]: any } | undefined;
+  specialAdCategories?: Array<string> | undefined;
   startAt?: Date | undefined;
   status?: AdsCampaignStatus | undefined;
   targeting?: PropertyAdsCampaignTargeting | undefined;
@@ -72,6 +101,19 @@ export type AdsCampaign = {
   updatedAt?: Date | undefined;
 };
 
+/** @internal */
+export const AdvertisingChannelType$inboundSchema: z.ZodType<
+  AdvertisingChannelType,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(AdvertisingChannelType);
+/** @internal */
+export const AdvertisingChannelType$outboundSchema: z.ZodType<
+  string,
+  z.ZodTypeDef,
+  AdvertisingChannelType
+> = openEnums.outboundSchema(AdvertisingChannelType);
+
 /** @internal */
 export const BudgetPeriod$inboundSchema: z.ZodType<
   BudgetPeriod,
@@ -111,8 +153,11 @@ export const AdsCampaign$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
+  advertising_channel_type: AdvertisingChannelType$inboundSchema.optional(),
+  bid_strategy: PropertyAdsCampaignBidStrategy$inboundSchema.optional(),
   budget_amount: z.number().optional(),
   budget_period: BudgetPeriod$inboundSchema.optional(),
+  campaign_budget_identifier: z.string().optional(),
   created_at: z.string().datetime({ offset: true }).transform(v => new Date(v))
     .optional(),
   currency: z.string().optional(),
@@ -121,11 +166,11 @@ export const AdsCampaign$inboundSchema: z.ZodType<
   frequency_cap: PropertyAdsCampaignFrequencyCap$inboundSchema.optional(),
   goal: Goal$inboundSchema.optional(),
   id: z.string().optional(),
-  is_active: z.boolean().optional(),
   name: z.string().optional(),
   organization_id: z.string().optional(),
   planned_spend_amount: z.number().optional(),
   raw: z.record(z.any()).optional(),
+  special_ad_categories: z.array(z.string()).optional(),
   start_at: z.string().datetime({ offset: true }).transform(v => new Date(v))
     .optional(),
   status: AdsCampaignStatus$inboundSchema.optional(),
@@ -135,14 +180,17 @@ export const AdsCampaign$inboundSchema: z.ZodType<
     .optional(),
 }).transform((v) => {
   return remap$(v, {
+    "advertising_channel_type": "advertisingChannelType",
+    "bid_strategy": "bidStrategy",
     "budget_amount": "budgetAmount",
     "budget_period": "budgetPeriod",
+    "campaign_budget_identifier": "campaignBudgetIdentifier",
     "created_at": "createdAt",
     "end_at": "endAt",
     "frequency_cap": "frequencyCap",
-    "is_active": "isActive",
     "organization_id": "organizationId",
     "planned_spend_amount": "plannedSpendAmount",
+    "special_ad_categories": "specialAdCategories",
     "start_at": "startAt",
     "total_spend_amount": "totalSpendAmount",
     "updated_at": "updatedAt",
@@ -150,19 +198,22 @@ export const AdsCampaign$inboundSchema: z.ZodType<
 });
 /** @internal */
 export type AdsCampaign$Outbound = {
+  advertising_channel_type?: string | undefined;
+  bid_strategy?: PropertyAdsCampaignBidStrategy$Outbound | undefined;
   budget_amount?: number | undefined;
   budget_period?: string | undefined;
+  campaign_budget_identifier?: string | undefined;
   created_at?: string | undefined;
   currency?: string | undefined;
   end_at?: string | undefined;
   frequency_cap?: PropertyAdsCampaignFrequencyCap$Outbound | undefined;
   goal?: string | undefined;
   id?: string | undefined;
-  is_active?: boolean | undefined;
   name?: string | undefined;
   organization_id?: string | undefined;
   planned_spend_amount?: number | undefined;
   raw?: { [k: string]: any } | undefined;
+  special_ad_categories?: Array<string> | undefined;
   start_at?: string | undefined;
   status?: string | undefined;
   targeting?: PropertyAdsCampaignTargeting$Outbound | undefined;
@@ -176,19 +227,22 @@ export const AdsCampaign$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   AdsCampaign
 > = z.object({
+  advertisingChannelType: AdvertisingChannelType$outboundSchema.optional(),
+  bidStrategy: PropertyAdsCampaignBidStrategy$outboundSchema.optional(),
   budgetAmount: z.number().optional(),
   budgetPeriod: BudgetPeriod$outboundSchema.optional(),
+  campaignBudgetIdentifier: z.string().optional(),
   createdAt: z.date().transform(v => v.toISOString()).optional(),
   currency: z.string().optional(),
   endAt: z.date().transform(v => v.toISOString()).optional(),
   frequencyCap: PropertyAdsCampaignFrequencyCap$outboundSchema.optional(),
   goal: Goal$outboundSchema.optional(),
   id: z.string().optional(),
-  isActive: z.boolean().optional(),
   name: z.string().optional(),
   organizationId: z.string().optional(),
   plannedSpendAmount: z.number().optional(),
   raw: z.record(z.any()).optional(),
+  specialAdCategories: z.array(z.string()).optional(),
   startAt: z.date().transform(v => v.toISOString()).optional(),
   status: AdsCampaignStatus$outboundSchema.optional(),
   targeting: PropertyAdsCampaignTargeting$outboundSchema.optional(),
@@ -196,14 +250,17 @@ export const AdsCampaign$outboundSchema: z.ZodType<
   updatedAt: z.date().transform(v => v.toISOString()).optional(),
 }).transform((v) => {
   return remap$(v, {
+    advertisingChannelType: "advertising_channel_type",
+    bidStrategy: "bid_strategy",
     budgetAmount: "budget_amount",
     budgetPeriod: "budget_period",
+    campaignBudgetIdentifier: "campaign_budget_identifier",
     createdAt: "created_at",
     endAt: "end_at",
     frequencyCap: "frequency_cap",
-    isActive: "is_active",
     organizationId: "organization_id",
     plannedSpendAmount: "planned_spend_amount",
+    specialAdCategories: "special_ad_categories",
     startAt: "start_at",
     totalSpendAmount: "total_spend_amount",
     updatedAt: "updated_at",