@unified-api/typescript-sdk 2.82.19 → 2.82.20

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

@@ -0,0 +1,112 @@
+/*
+ * 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 TimeUnit = {
+  Unspecified: "UNSPECIFIED",
+  Lifetime: "LIFETIME",
+  Months: "MONTHS",
+  Weeks: "WEEKS",
+  Days: "DAYS",
+  Hours: "HOURS",
+  Minutes: "MINUTES",
+} as const;
+export type TimeUnit = OpenEnum<typeof TimeUnit>;
+
+export type PropertyAdsCampaignFrequencyCap = {
+  isUnlimited?: boolean | undefined;
+  maxImpressions?: number | undefined;
+  maxViews?: number | undefined;
+  timeUnit?: TimeUnit | undefined;
+  timeUnitCount?: number | undefined;
+};
+
+/** @internal */
+export const TimeUnit$inboundSchema: z.ZodType<
+  TimeUnit,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(TimeUnit);
+/** @internal */
+export const TimeUnit$outboundSchema: z.ZodType<
+  string,
+  z.ZodTypeDef,
+  TimeUnit
+> = openEnums.outboundSchema(TimeUnit);
+
+/** @internal */
+export const PropertyAdsCampaignFrequencyCap$inboundSchema: z.ZodType<
+  PropertyAdsCampaignFrequencyCap,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  is_unlimited: z.boolean().optional(),
+  max_impressions: z.number().optional(),
+  max_views: z.number().optional(),
+  time_unit: TimeUnit$inboundSchema.optional(),
+  time_unit_count: z.number().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "is_unlimited": "isUnlimited",
+    "max_impressions": "maxImpressions",
+    "max_views": "maxViews",
+    "time_unit": "timeUnit",
+    "time_unit_count": "timeUnitCount",
+  });
+});
+/** @internal */
+export type PropertyAdsCampaignFrequencyCap$Outbound = {
+  is_unlimited?: boolean | undefined;
+  max_impressions?: number | undefined;
+  max_views?: number | undefined;
+  time_unit?: string | undefined;
+  time_unit_count?: number | undefined;
+};
+
+/** @internal */
+export const PropertyAdsCampaignFrequencyCap$outboundSchema: z.ZodType<
+  PropertyAdsCampaignFrequencyCap$Outbound,
+  z.ZodTypeDef,
+  PropertyAdsCampaignFrequencyCap
+> = z.object({
+  isUnlimited: z.boolean().optional(),
+  maxImpressions: z.number().optional(),
+  maxViews: z.number().optional(),
+  timeUnit: TimeUnit$outboundSchema.optional(),
+  timeUnitCount: z.number().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    isUnlimited: "is_unlimited",
+    maxImpressions: "max_impressions",
+    maxViews: "max_views",
+    timeUnit: "time_unit",
+    timeUnitCount: "time_unit_count",
+  });
+});
+
+export function propertyAdsCampaignFrequencyCapToJSON(
+  propertyAdsCampaignFrequencyCap: PropertyAdsCampaignFrequencyCap,
+): string {
+  return JSON.stringify(
+    PropertyAdsCampaignFrequencyCap$outboundSchema.parse(
+      propertyAdsCampaignFrequencyCap,
+    ),
+  );
+}
+export function propertyAdsCampaignFrequencyCapFromJSON(
+  jsonString: string,
+): SafeParseResult<PropertyAdsCampaignFrequencyCap, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PropertyAdsCampaignFrequencyCap$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PropertyAdsCampaignFrequencyCap' from JSON`,
+  );
+}

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

@@ -0,0 +1,190 @@
+/*
+ * 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 PerformanceGoalType = {
+  Unspecified: "UNSPECIFIED",
+  Cpa: "CPA",
+  Cpc: "CPC",
+  ViewableCpm: "VIEWABLE_CPM",
+  CustomAlgo: "CUSTOM_ALGO",
+  Civa: "CIVA",
+  IvoTen: "IVO_TEN",
+  AvViewed: "AV_VIEWED",
+  Reach: "REACH",
+} as const;
+export type PerformanceGoalType = OpenEnum<typeof PerformanceGoalType>;
+
+export const PropertyAdsGroupBidStrategyType = {
+  FixedBid: "FIXED_BID",
+  MaximizeSpend: "MAXIMIZE_SPEND",
+  PerformanceGoal: "PERFORMANCE_GOAL",
+  YoutubeAndPartners: "YOUTUBE_AND_PARTNERS",
+} as const;
+export type PropertyAdsGroupBidStrategyType = OpenEnum<
+  typeof PropertyAdsGroupBidStrategyType
+>;
+
+export const YoutubeAndPartnersType = {
+  Unspecified: "UNSPECIFIED",
+  ManualCpv: "MANUAL_CPV",
+  ManualCpm: "MANUAL_CPM",
+  TargetCpa: "TARGET_CPA",
+  TargetCpm: "TARGET_CPM",
+  ReserveCpm: "RESERVE_CPM",
+  MaximizeLift: "MAXIMIZE_LIFT",
+  MaximizeConversions: "MAXIMIZE_CONVERSIONS",
+  TargetCpv: "TARGET_CPV",
+  TargetRoas: "TARGET_ROAS",
+  MaximizeConversionValue: "MAXIMIZE_CONVERSION_VALUE",
+} as const;
+export type YoutubeAndPartnersType = OpenEnum<typeof YoutubeAndPartnersType>;
+
+/**
+ * YOUTUBE_AND_PARTNERS
+ */
+export type PropertyAdsGroupBidStrategy = {
+  customBiddingAlgorithmId?: string | undefined;
+  fixedBidAmount?: number | undefined;
+  maxAverageCpmBidAmount?: number | undefined;
+  performanceGoalAmount?: number | undefined;
+  performanceGoalType?: PerformanceGoalType | undefined;
+  raiseBidForDeals?: boolean | undefined;
+  type: PropertyAdsGroupBidStrategyType;
+  youtubeAndPartnersType?: YoutubeAndPartnersType | undefined;
+  youtubeAndPartnersValue?: string | undefined;
+};
+
+/** @internal */
+export const PerformanceGoalType$inboundSchema: z.ZodType<
+  PerformanceGoalType,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(PerformanceGoalType);
+/** @internal */
+export const PerformanceGoalType$outboundSchema: z.ZodType<
+  string,
+  z.ZodTypeDef,
+  PerformanceGoalType
+> = openEnums.outboundSchema(PerformanceGoalType);
+
+/** @internal */
+export const PropertyAdsGroupBidStrategyType$inboundSchema: z.ZodType<
+  PropertyAdsGroupBidStrategyType,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(PropertyAdsGroupBidStrategyType);
+/** @internal */
+export const PropertyAdsGroupBidStrategyType$outboundSchema: z.ZodType<
+  string,
+  z.ZodTypeDef,
+  PropertyAdsGroupBidStrategyType
+> = openEnums.outboundSchema(PropertyAdsGroupBidStrategyType);
+
+/** @internal */
+export const YoutubeAndPartnersType$inboundSchema: z.ZodType<
+  YoutubeAndPartnersType,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(YoutubeAndPartnersType);
+/** @internal */
+export const YoutubeAndPartnersType$outboundSchema: z.ZodType<
+  string,
+  z.ZodTypeDef,
+  YoutubeAndPartnersType
+> = openEnums.outboundSchema(YoutubeAndPartnersType);
+
+/** @internal */
+export const PropertyAdsGroupBidStrategy$inboundSchema: z.ZodType<
+  PropertyAdsGroupBidStrategy,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  custom_bidding_algorithm_id: z.string().optional(),
+  fixed_bid_amount: z.number().optional(),
+  max_average_cpm_bid_amount: z.number().optional(),
+  performance_goal_amount: z.number().optional(),
+  performance_goal_type: PerformanceGoalType$inboundSchema.optional(),
+  raise_bid_for_deals: z.boolean().optional(),
+  type: PropertyAdsGroupBidStrategyType$inboundSchema,
+  youtube_and_partners_type: YoutubeAndPartnersType$inboundSchema.optional(),
+  youtube_and_partners_value: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "custom_bidding_algorithm_id": "customBiddingAlgorithmId",
+    "fixed_bid_amount": "fixedBidAmount",
+    "max_average_cpm_bid_amount": "maxAverageCpmBidAmount",
+    "performance_goal_amount": "performanceGoalAmount",
+    "performance_goal_type": "performanceGoalType",
+    "raise_bid_for_deals": "raiseBidForDeals",
+    "youtube_and_partners_type": "youtubeAndPartnersType",
+    "youtube_and_partners_value": "youtubeAndPartnersValue",
+  });
+});
+/** @internal */
+export type PropertyAdsGroupBidStrategy$Outbound = {
+  custom_bidding_algorithm_id?: string | undefined;
+  fixed_bid_amount?: number | undefined;
+  max_average_cpm_bid_amount?: number | undefined;
+  performance_goal_amount?: number | undefined;
+  performance_goal_type?: string | undefined;
+  raise_bid_for_deals?: boolean | undefined;
+  type: string;
+  youtube_and_partners_type?: string | undefined;
+  youtube_and_partners_value?: string | undefined;
+};
+
+/** @internal */
+export const PropertyAdsGroupBidStrategy$outboundSchema: z.ZodType<
+  PropertyAdsGroupBidStrategy$Outbound,
+  z.ZodTypeDef,
+  PropertyAdsGroupBidStrategy
+> = z.object({
+  customBiddingAlgorithmId: z.string().optional(),
+  fixedBidAmount: z.number().optional(),
+  maxAverageCpmBidAmount: z.number().optional(),
+  performanceGoalAmount: z.number().optional(),
+  performanceGoalType: PerformanceGoalType$outboundSchema.optional(),
+  raiseBidForDeals: z.boolean().optional(),
+  type: PropertyAdsGroupBidStrategyType$outboundSchema,
+  youtubeAndPartnersType: YoutubeAndPartnersType$outboundSchema.optional(),
+  youtubeAndPartnersValue: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    customBiddingAlgorithmId: "custom_bidding_algorithm_id",
+    fixedBidAmount: "fixed_bid_amount",
+    maxAverageCpmBidAmount: "max_average_cpm_bid_amount",
+    performanceGoalAmount: "performance_goal_amount",
+    performanceGoalType: "performance_goal_type",
+    raiseBidForDeals: "raise_bid_for_deals",
+    youtubeAndPartnersType: "youtube_and_partners_type",
+    youtubeAndPartnersValue: "youtube_and_partners_value",
+  });
+});
+
+export function propertyAdsGroupBidStrategyToJSON(
+  propertyAdsGroupBidStrategy: PropertyAdsGroupBidStrategy,
+): string {
+  return JSON.stringify(
+    PropertyAdsGroupBidStrategy$outboundSchema.parse(
+      propertyAdsGroupBidStrategy,
+    ),
+  );
+}
+export function propertyAdsGroupBidStrategyFromJSON(
+  jsonString: string,
+): SafeParseResult<PropertyAdsGroupBidStrategy, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PropertyAdsGroupBidStrategy$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PropertyAdsGroupBidStrategy' from JSON`,
+  );
+}

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

@@ -0,0 +1,114 @@
+/*
+ * 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 PropertyAdsGroupFrequencyCapTimeUnit = {
+  Unspecified: "UNSPECIFIED",
+  Lifetime: "LIFETIME",
+  Months: "MONTHS",
+  Weeks: "WEEKS",
+  Days: "DAYS",
+  Hours: "HOURS",
+  Minutes: "MINUTES",
+} as const;
+export type PropertyAdsGroupFrequencyCapTimeUnit = OpenEnum<
+  typeof PropertyAdsGroupFrequencyCapTimeUnit
+>;
+
+export type PropertyAdsGroupFrequencyCap = {
+  isUnlimited?: boolean | undefined;
+  maxImpressions?: number | undefined;
+  maxViews?: number | undefined;
+  timeUnit?: PropertyAdsGroupFrequencyCapTimeUnit | undefined;
+  timeUnitCount?: number | undefined;
+};
+
+/** @internal */
+export const PropertyAdsGroupFrequencyCapTimeUnit$inboundSchema: z.ZodType<
+  PropertyAdsGroupFrequencyCapTimeUnit,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(PropertyAdsGroupFrequencyCapTimeUnit);
+/** @internal */
+export const PropertyAdsGroupFrequencyCapTimeUnit$outboundSchema: z.ZodType<
+  string,
+  z.ZodTypeDef,
+  PropertyAdsGroupFrequencyCapTimeUnit
+> = openEnums.outboundSchema(PropertyAdsGroupFrequencyCapTimeUnit);
+
+/** @internal */
+export const PropertyAdsGroupFrequencyCap$inboundSchema: z.ZodType<
+  PropertyAdsGroupFrequencyCap,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  is_unlimited: z.boolean().optional(),
+  max_impressions: z.number().optional(),
+  max_views: z.number().optional(),
+  time_unit: PropertyAdsGroupFrequencyCapTimeUnit$inboundSchema.optional(),
+  time_unit_count: z.number().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "is_unlimited": "isUnlimited",
+    "max_impressions": "maxImpressions",
+    "max_views": "maxViews",
+    "time_unit": "timeUnit",
+    "time_unit_count": "timeUnitCount",
+  });
+});
+/** @internal */
+export type PropertyAdsGroupFrequencyCap$Outbound = {
+  is_unlimited?: boolean | undefined;
+  max_impressions?: number | undefined;
+  max_views?: number | undefined;
+  time_unit?: string | undefined;
+  time_unit_count?: number | undefined;
+};
+
+/** @internal */
+export const PropertyAdsGroupFrequencyCap$outboundSchema: z.ZodType<
+  PropertyAdsGroupFrequencyCap$Outbound,
+  z.ZodTypeDef,
+  PropertyAdsGroupFrequencyCap
+> = z.object({
+  isUnlimited: z.boolean().optional(),
+  maxImpressions: z.number().optional(),
+  maxViews: z.number().optional(),
+  timeUnit: PropertyAdsGroupFrequencyCapTimeUnit$outboundSchema.optional(),
+  timeUnitCount: z.number().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    isUnlimited: "is_unlimited",
+    maxImpressions: "max_impressions",
+    maxViews: "max_views",
+    timeUnit: "time_unit",
+    timeUnitCount: "time_unit_count",
+  });
+});
+
+export function propertyAdsGroupFrequencyCapToJSON(
+  propertyAdsGroupFrequencyCap: PropertyAdsGroupFrequencyCap,
+): string {
+  return JSON.stringify(
+    PropertyAdsGroupFrequencyCap$outboundSchema.parse(
+      propertyAdsGroupFrequencyCap,
+    ),
+  );
+}
+export function propertyAdsGroupFrequencyCapFromJSON(
+  jsonString: string,
+): SafeParseResult<PropertyAdsGroupFrequencyCap, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PropertyAdsGroupFrequencyCap$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PropertyAdsGroupFrequencyCap' from JSON`,
+  );
+}

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

@@ -0,0 +1,90 @@
+/*
+ * 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 Period = {
+  Unspecified: "UNSPECIFIED",
+  Daily: "DAILY",
+  Flight: "FLIGHT",
+} as const;
+export type Period = OpenEnum<typeof Period>;
+
+export type PropertyAdsGroupPacing = {
+  dailyMaxAmount?: number | undefined;
+  dailyMaxImpressions?: number | undefined;
+  period?: Period | undefined;
+  type?: string | undefined;
+};
+
+/** @internal */
+export const Period$inboundSchema: z.ZodType<Period, z.ZodTypeDef, unknown> =
+  openEnums.inboundSchema(Period);
+/** @internal */
+export const Period$outboundSchema: z.ZodType<string, z.ZodTypeDef, Period> =
+  openEnums.outboundSchema(Period);
+
+/** @internal */
+export const PropertyAdsGroupPacing$inboundSchema: z.ZodType<
+  PropertyAdsGroupPacing,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  daily_max_amount: z.number().optional(),
+  daily_max_impressions: z.number().optional(),
+  period: Period$inboundSchema.optional(),
+  type: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "daily_max_amount": "dailyMaxAmount",
+    "daily_max_impressions": "dailyMaxImpressions",
+  });
+});
+/** @internal */
+export type PropertyAdsGroupPacing$Outbound = {
+  daily_max_amount?: number | undefined;
+  daily_max_impressions?: number | undefined;
+  period?: string | undefined;
+  type?: string | undefined;
+};
+
+/** @internal */
+export const PropertyAdsGroupPacing$outboundSchema: z.ZodType<
+  PropertyAdsGroupPacing$Outbound,
+  z.ZodTypeDef,
+  PropertyAdsGroupPacing
+> = z.object({
+  dailyMaxAmount: z.number().optional(),
+  dailyMaxImpressions: z.number().optional(),
+  period: Period$outboundSchema.optional(),
+  type: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    dailyMaxAmount: "daily_max_amount",
+    dailyMaxImpressions: "daily_max_impressions",
+  });
+});
+
+export function propertyAdsGroupPacingToJSON(
+  propertyAdsGroupPacing: PropertyAdsGroupPacing,
+): string {
+  return JSON.stringify(
+    PropertyAdsGroupPacing$outboundSchema.parse(propertyAdsGroupPacing),
+  );
+}
+export function propertyAdsGroupPacingFromJSON(
+  jsonString: string,
+): SafeParseResult<PropertyAdsGroupPacing, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PropertyAdsGroupPacing$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PropertyAdsGroupPacing' from JSON`,
+  );
+}