@unified-api/typescript-sdk 2.83.18 → 2.83.19

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

@@ -0,0 +1,168 @@
+/*
+ * 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";
+import {
+  CityTarget,
+  CityTarget$inboundSchema,
+  CityTarget$Outbound,
+  CityTarget$outboundSchema,
+} from "./citytarget.js";
+import {
+  PropertyAdsCampaignTargetingGeographicLocationTypes,
+  PropertyAdsCampaignTargetingGeographicLocationTypes$inboundSchema,
+  PropertyAdsCampaignTargetingGeographicLocationTypes$outboundSchema,
+} from "./propertyadscampaigntargetinggeographiclocationtypes.js";
+import {
+  RegionTarget,
+  RegionTarget$inboundSchema,
+  RegionTarget$Outbound,
+  RegionTarget$outboundSchema,
+} from "./regiontarget.js";
+
+export const PresenceType = {
+  Presence: "PRESENCE",
+  PresenceOrInterest: "PRESENCE_OR_INTEREST",
+} as const;
+export type PresenceType = OpenEnum<typeof PresenceType>;
+
+export type PropertyAdsCampaignTargetingGeographic = {
+  cities?: Array<CityTarget> | undefined;
+  countries?: Array<string> | undefined;
+  excludedCities?: Array<CityTarget> | undefined;
+  excludedCountries?: Array<string> | undefined;
+  excludedPostalCodes?: Array<string> | undefined;
+  excludedRegions?: Array<RegionTarget> | undefined;
+  excludedUsDmas?: Array<string> | undefined;
+  locationTypes?:
+    | Array<PropertyAdsCampaignTargetingGeographicLocationTypes>
+    | undefined;
+  postalCodes?: Array<string> | undefined;
+  presenceType?: PresenceType | undefined;
+  regions?: Array<RegionTarget> | undefined;
+  usDmas?: Array<string> | undefined;
+};
+
+/** @internal */
+export const PresenceType$inboundSchema: z.ZodType<
+  PresenceType,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(PresenceType);
+/** @internal */
+export const PresenceType$outboundSchema: z.ZodType<
+  string,
+  z.ZodTypeDef,
+  PresenceType
+> = openEnums.outboundSchema(PresenceType);
+
+/** @internal */
+export const PropertyAdsCampaignTargetingGeographic$inboundSchema: z.ZodType<
+  PropertyAdsCampaignTargetingGeographic,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  cities: z.array(CityTarget$inboundSchema).optional(),
+  countries: z.array(z.string()).optional(),
+  excluded_cities: z.array(CityTarget$inboundSchema).optional(),
+  excluded_countries: z.array(z.string()).optional(),
+  excluded_postal_codes: z.array(z.string()).optional(),
+  excluded_regions: z.array(RegionTarget$inboundSchema).optional(),
+  excluded_us_dmas: z.array(z.string()).optional(),
+  location_types: z.array(
+    PropertyAdsCampaignTargetingGeographicLocationTypes$inboundSchema,
+  ).optional(),
+  postal_codes: z.array(z.string()).optional(),
+  presence_type: PresenceType$inboundSchema.optional(),
+  regions: z.array(RegionTarget$inboundSchema).optional(),
+  us_dmas: z.array(z.string()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "excluded_cities": "excludedCities",
+    "excluded_countries": "excludedCountries",
+    "excluded_postal_codes": "excludedPostalCodes",
+    "excluded_regions": "excludedRegions",
+    "excluded_us_dmas": "excludedUsDmas",
+    "location_types": "locationTypes",
+    "postal_codes": "postalCodes",
+    "presence_type": "presenceType",
+    "us_dmas": "usDmas",
+  });
+});
+/** @internal */
+export type PropertyAdsCampaignTargetingGeographic$Outbound = {
+  cities?: Array<CityTarget$Outbound> | undefined;
+  countries?: Array<string> | undefined;
+  excluded_cities?: Array<CityTarget$Outbound> | undefined;
+  excluded_countries?: Array<string> | undefined;
+  excluded_postal_codes?: Array<string> | undefined;
+  excluded_regions?: Array<RegionTarget$Outbound> | undefined;
+  excluded_us_dmas?: Array<string> | undefined;
+  location_types?: Array<string> | undefined;
+  postal_codes?: Array<string> | undefined;
+  presence_type?: string | undefined;
+  regions?: Array<RegionTarget$Outbound> | undefined;
+  us_dmas?: Array<string> | undefined;
+};
+
+/** @internal */
+export const PropertyAdsCampaignTargetingGeographic$outboundSchema: z.ZodType<
+  PropertyAdsCampaignTargetingGeographic$Outbound,
+  z.ZodTypeDef,
+  PropertyAdsCampaignTargetingGeographic
+> = z.object({
+  cities: z.array(CityTarget$outboundSchema).optional(),
+  countries: z.array(z.string()).optional(),
+  excludedCities: z.array(CityTarget$outboundSchema).optional(),
+  excludedCountries: z.array(z.string()).optional(),
+  excludedPostalCodes: z.array(z.string()).optional(),
+  excludedRegions: z.array(RegionTarget$outboundSchema).optional(),
+  excludedUsDmas: z.array(z.string()).optional(),
+  locationTypes: z.array(
+    PropertyAdsCampaignTargetingGeographicLocationTypes$outboundSchema,
+  ).optional(),
+  postalCodes: z.array(z.string()).optional(),
+  presenceType: PresenceType$outboundSchema.optional(),
+  regions: z.array(RegionTarget$outboundSchema).optional(),
+  usDmas: z.array(z.string()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    excludedCities: "excluded_cities",
+    excludedCountries: "excluded_countries",
+    excludedPostalCodes: "excluded_postal_codes",
+    excludedRegions: "excluded_regions",
+    excludedUsDmas: "excluded_us_dmas",
+    locationTypes: "location_types",
+    postalCodes: "postal_codes",
+    presenceType: "presence_type",
+    usDmas: "us_dmas",
+  });
+});
+
+export function propertyAdsCampaignTargetingGeographicToJSON(
+  propertyAdsCampaignTargetingGeographic:
+    PropertyAdsCampaignTargetingGeographic,
+): string {
+  return JSON.stringify(
+    PropertyAdsCampaignTargetingGeographic$outboundSchema.parse(
+      propertyAdsCampaignTargetingGeographic,
+    ),
+  );
+}
+export function propertyAdsCampaignTargetingGeographicFromJSON(
+  jsonString: string,
+): SafeParseResult<PropertyAdsCampaignTargetingGeographic, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      PropertyAdsCampaignTargetingGeographic$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PropertyAdsCampaignTargetingGeographic' from JSON`,
+  );
+}

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

@@ -0,0 +1,35 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import * as openEnums from "../../types/enums.js";
+import { OpenEnum } from "../../types/enums.js";
+
+export const PropertyAdsCampaignTargetingGeographicLocationTypes = {
+  Home: "HOME",
+  Recent: "RECENT",
+  Travel: "TRAVEL",
+} as const;
+export type PropertyAdsCampaignTargetingGeographicLocationTypes = OpenEnum<
+  typeof PropertyAdsCampaignTargetingGeographicLocationTypes
+>;
+
+/** @internal */
+export const PropertyAdsCampaignTargetingGeographicLocationTypes$inboundSchema:
+  z.ZodType<
+    PropertyAdsCampaignTargetingGeographicLocationTypes,
+    z.ZodTypeDef,
+    unknown
+  > = openEnums.inboundSchema(
+    PropertyAdsCampaignTargetingGeographicLocationTypes,
+  );
+/** @internal */
+export const PropertyAdsCampaignTargetingGeographicLocationTypes$outboundSchema:
+  z.ZodType<
+    string,
+    z.ZodTypeDef,
+    PropertyAdsCampaignTargetingGeographicLocationTypes
+  > = openEnums.outboundSchema(
+    PropertyAdsCampaignTargetingGeographicLocationTypes,
+  );

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

@@ -0,0 +1,70 @@
+/*
+ * 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 { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+/**
+ * Language targeting (Meta
+ */
+export type PropertyAdsCampaignTargetingLanguage = {
+  codes?: Array<string> | undefined;
+  localeIds?: Array<number> | undefined;
+};
+
+/** @internal */
+export const PropertyAdsCampaignTargetingLanguage$inboundSchema: z.ZodType<
+  PropertyAdsCampaignTargetingLanguage,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  codes: z.array(z.string()).optional(),
+  locale_ids: z.array(z.number()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "locale_ids": "localeIds",
+  });
+});
+/** @internal */
+export type PropertyAdsCampaignTargetingLanguage$Outbound = {
+  codes?: Array<string> | undefined;
+  locale_ids?: Array<number> | undefined;
+};
+
+/** @internal */
+export const PropertyAdsCampaignTargetingLanguage$outboundSchema: z.ZodType<
+  PropertyAdsCampaignTargetingLanguage$Outbound,
+  z.ZodTypeDef,
+  PropertyAdsCampaignTargetingLanguage
+> = z.object({
+  codes: z.array(z.string()).optional(),
+  localeIds: z.array(z.number()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    localeIds: "locale_ids",
+  });
+});
+
+export function propertyAdsCampaignTargetingLanguageToJSON(
+  propertyAdsCampaignTargetingLanguage: PropertyAdsCampaignTargetingLanguage,
+): string {
+  return JSON.stringify(
+    PropertyAdsCampaignTargetingLanguage$outboundSchema.parse(
+      propertyAdsCampaignTargetingLanguage,
+    ),
+  );
+}
+export function propertyAdsCampaignTargetingLanguageFromJSON(
+  jsonString: string,
+): SafeParseResult<PropertyAdsCampaignTargetingLanguage, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      PropertyAdsCampaignTargetingLanguage$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PropertyAdsCampaignTargetingLanguage' from JSON`,
+  );
+}

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

@@ -0,0 +1,103 @@
+/*
+ * 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 Mode = {
+  Targeting: "TARGETING",
+  Observation: "OBSERVATION",
+} as const;
+export type Mode = OpenEnum<typeof Mode>;
+
+/**
+ * Optimization (Meta: targeting_automation; Google: observation vs targeting mode)
+ */
+export type PropertyAdsCampaignTargetingOptimization = {
+  advantageAudience?: boolean | undefined;
+  advantagePlacements?: boolean | undefined;
+  mode?: Mode | undefined;
+  targetingOptimizationExpansionAll?: boolean | undefined;
+};
+
+/** @internal */
+export const Mode$inboundSchema: z.ZodType<Mode, z.ZodTypeDef, unknown> =
+  openEnums.inboundSchema(Mode);
+/** @internal */
+export const Mode$outboundSchema: z.ZodType<string, z.ZodTypeDef, Mode> =
+  openEnums.outboundSchema(Mode);
+
+/** @internal */
+export const PropertyAdsCampaignTargetingOptimization$inboundSchema: z.ZodType<
+  PropertyAdsCampaignTargetingOptimization,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  advantage_audience: z.boolean().optional(),
+  advantage_placements: z.boolean().optional(),
+  mode: Mode$inboundSchema.optional(),
+  targeting_optimization_expansion_all: z.boolean().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "advantage_audience": "advantageAudience",
+    "advantage_placements": "advantagePlacements",
+    "targeting_optimization_expansion_all": "targetingOptimizationExpansionAll",
+  });
+});
+/** @internal */
+export type PropertyAdsCampaignTargetingOptimization$Outbound = {
+  advantage_audience?: boolean | undefined;
+  advantage_placements?: boolean | undefined;
+  mode?: string | undefined;
+  targeting_optimization_expansion_all?: boolean | undefined;
+};
+
+/** @internal */
+export const PropertyAdsCampaignTargetingOptimization$outboundSchema: z.ZodType<
+  PropertyAdsCampaignTargetingOptimization$Outbound,
+  z.ZodTypeDef,
+  PropertyAdsCampaignTargetingOptimization
+> = z.object({
+  advantageAudience: z.boolean().optional(),
+  advantagePlacements: z.boolean().optional(),
+  mode: Mode$outboundSchema.optional(),
+  targetingOptimizationExpansionAll: z.boolean().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    advantageAudience: "advantage_audience",
+    advantagePlacements: "advantage_placements",
+    targetingOptimizationExpansionAll: "targeting_optimization_expansion_all",
+  });
+});
+
+export function propertyAdsCampaignTargetingOptimizationToJSON(
+  propertyAdsCampaignTargetingOptimization:
+    PropertyAdsCampaignTargetingOptimization,
+): string {
+  return JSON.stringify(
+    PropertyAdsCampaignTargetingOptimization$outboundSchema.parse(
+      propertyAdsCampaignTargetingOptimization,
+    ),
+  );
+}
+export function propertyAdsCampaignTargetingOptimizationFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  PropertyAdsCampaignTargetingOptimization,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      PropertyAdsCampaignTargetingOptimization$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'PropertyAdsCampaignTargetingOptimization' from JSON`,
+  );
+}

package/src/sdk/models/shared/propertyadscampaigntargetingplacement.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 { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type PropertyAdsCampaignTargetingPlacement = {
+  audienceNetworkPositions?: Array<string> | undefined;
+  facebookPositions?: Array<string> | undefined;
+  instagramPositions?: Array<string> | undefined;
+  messengerPositions?: Array<string> | undefined;
+  platforms?: Array<string> | undefined;
+};
+
+/** @internal */
+export const PropertyAdsCampaignTargetingPlacement$inboundSchema: z.ZodType<
+  PropertyAdsCampaignTargetingPlacement,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  audience_network_positions: z.array(z.string()).optional(),
+  facebook_positions: z.array(z.string()).optional(),
+  instagram_positions: z.array(z.string()).optional(),
+  messenger_positions: z.array(z.string()).optional(),
+  platforms: z.array(z.string()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "audience_network_positions": "audienceNetworkPositions",
+    "facebook_positions": "facebookPositions",
+    "instagram_positions": "instagramPositions",
+    "messenger_positions": "messengerPositions",
+  });
+});
+/** @internal */
+export type PropertyAdsCampaignTargetingPlacement$Outbound = {
+  audience_network_positions?: Array<string> | undefined;
+  facebook_positions?: Array<string> | undefined;
+  instagram_positions?: Array<string> | undefined;
+  messenger_positions?: Array<string> | undefined;
+  platforms?: Array<string> | undefined;
+};
+
+/** @internal */
+export const PropertyAdsCampaignTargetingPlacement$outboundSchema: z.ZodType<
+  PropertyAdsCampaignTargetingPlacement$Outbound,
+  z.ZodTypeDef,
+  PropertyAdsCampaignTargetingPlacement
+> = z.object({
+  audienceNetworkPositions: z.array(z.string()).optional(),
+  facebookPositions: z.array(z.string()).optional(),
+  instagramPositions: z.array(z.string()).optional(),
+  messengerPositions: z.array(z.string()).optional(),
+  platforms: z.array(z.string()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    audienceNetworkPositions: "audience_network_positions",
+    facebookPositions: "facebook_positions",
+    instagramPositions: "instagram_positions",
+    messengerPositions: "messenger_positions",
+  });
+});
+
+export function propertyAdsCampaignTargetingPlacementToJSON(
+  propertyAdsCampaignTargetingPlacement: PropertyAdsCampaignTargetingPlacement,
+): string {
+  return JSON.stringify(
+    PropertyAdsCampaignTargetingPlacement$outboundSchema.parse(
+      propertyAdsCampaignTargetingPlacement,
+    ),
+  );
+}
+export function propertyAdsCampaignTargetingPlacementFromJSON(
+  jsonString: string,
+): SafeParseResult<PropertyAdsCampaignTargetingPlacement, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      PropertyAdsCampaignTargetingPlacement$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PropertyAdsCampaignTargetingPlacement' from JSON`,
+  );
+}