@unified-api/typescript-sdk 2.83.17 → 2.83.19

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

@@ -0,0 +1,53 @@
+/*
+ * 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";
+
+/**
+ * Demographic targeting (Meta: age_min, age_max, genders)
+ */
+export type PropertyAdsReportMetricsGroupTargetingDemographic = {
+  ageMax?: number | undefined;
+  ageMin?: number | undefined;
+  female?: boolean | undefined;
+  male?: boolean | undefined;
+};
+
+/** @internal */
+export const PropertyAdsReportMetricsGroupTargetingDemographic$inboundSchema:
+  z.ZodType<
+    PropertyAdsReportMetricsGroupTargetingDemographic,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    age_max: z.number().optional(),
+    age_min: z.number().optional(),
+    female: z.boolean().optional(),
+    male: z.boolean().optional(),
+  }).transform((v) => {
+    return remap$(v, {
+      "age_max": "ageMax",
+      "age_min": "ageMin",
+    });
+  });
+
+export function propertyAdsReportMetricsGroupTargetingDemographicFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  PropertyAdsReportMetricsGroupTargetingDemographic,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      PropertyAdsReportMetricsGroupTargetingDemographic$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'PropertyAdsReportMetricsGroupTargetingDemographic' from JSON`,
+  );
+}

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

@@ -0,0 +1,50 @@
+/*
+ * 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 PropertyAdsReportMetricsGroupTargetingDevice = {
+  carriers?: Array<string> | undefined;
+  types?: Array<string> | undefined;
+  userDevice?: Array<string> | undefined;
+  userOs?: Array<string> | undefined;
+};
+
+/** @internal */
+export const PropertyAdsReportMetricsGroupTargetingDevice$inboundSchema:
+  z.ZodType<
+    PropertyAdsReportMetricsGroupTargetingDevice,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    carriers: z.array(z.string()).optional(),
+    types: z.array(z.string()).optional(),
+    user_device: z.array(z.string()).optional(),
+    user_os: z.array(z.string()).optional(),
+  }).transform((v) => {
+    return remap$(v, {
+      "user_device": "userDevice",
+      "user_os": "userOs",
+    });
+  });
+
+export function propertyAdsReportMetricsGroupTargetingDeviceFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  PropertyAdsReportMetricsGroupTargetingDevice,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      PropertyAdsReportMetricsGroupTargetingDevice$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'PropertyAdsReportMetricsGroupTargetingDevice' from JSON`,
+  );
+}

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

@@ -0,0 +1,106 @@
+/*
+ * 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 } from "./citytarget.js";
+import {
+  PropertyAdsReportMetricsGroupTargetingGeographicLocationTypes,
+  PropertyAdsReportMetricsGroupTargetingGeographicLocationTypes$inboundSchema,
+} from "./propertyadsreportmetricsgrouptargetinggeographiclocationtypes.js";
+import { RegionTarget, RegionTarget$inboundSchema } from "./regiontarget.js";
+
+export const PropertyAdsReportMetricsGroupTargetingGeographicPresenceType = {
+  Presence: "PRESENCE",
+  PresenceOrInterest: "PRESENCE_OR_INTEREST",
+} as const;
+export type PropertyAdsReportMetricsGroupTargetingGeographicPresenceType =
+  OpenEnum<typeof PropertyAdsReportMetricsGroupTargetingGeographicPresenceType>;
+
+export type PropertyAdsReportMetricsGroupTargetingGeographic = {
+  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<PropertyAdsReportMetricsGroupTargetingGeographicLocationTypes>
+    | undefined;
+  postalCodes?: Array<string> | undefined;
+  presenceType?:
+    | PropertyAdsReportMetricsGroupTargetingGeographicPresenceType
+    | undefined;
+  regions?: Array<RegionTarget> | undefined;
+  usDmas?: Array<string> | undefined;
+};
+
+/** @internal */
+export const PropertyAdsReportMetricsGroupTargetingGeographicPresenceType$inboundSchema:
+  z.ZodType<
+    PropertyAdsReportMetricsGroupTargetingGeographicPresenceType,
+    z.ZodTypeDef,
+    unknown
+  > = openEnums.inboundSchema(
+    PropertyAdsReportMetricsGroupTargetingGeographicPresenceType,
+  );
+
+/** @internal */
+export const PropertyAdsReportMetricsGroupTargetingGeographic$inboundSchema:
+  z.ZodType<
+    PropertyAdsReportMetricsGroupTargetingGeographic,
+    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(
+      PropertyAdsReportMetricsGroupTargetingGeographicLocationTypes$inboundSchema,
+    ).optional(),
+    postal_codes: z.array(z.string()).optional(),
+    presence_type:
+      PropertyAdsReportMetricsGroupTargetingGeographicPresenceType$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",
+    });
+  });
+
+export function propertyAdsReportMetricsGroupTargetingGeographicFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  PropertyAdsReportMetricsGroupTargetingGeographic,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      PropertyAdsReportMetricsGroupTargetingGeographic$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'PropertyAdsReportMetricsGroupTargetingGeographic' from JSON`,
+  );
+}

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

@@ -0,0 +1,27 @@
+/*
+ * 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 PropertyAdsReportMetricsGroupTargetingGeographicLocationTypes = {
+  Home: "HOME",
+  Recent: "RECENT",
+  Travel: "TRAVEL",
+} as const;
+export type PropertyAdsReportMetricsGroupTargetingGeographicLocationTypes =
+  OpenEnum<
+    typeof PropertyAdsReportMetricsGroupTargetingGeographicLocationTypes
+  >;
+
+/** @internal */
+export const PropertyAdsReportMetricsGroupTargetingGeographicLocationTypes$inboundSchema:
+  z.ZodType<
+    PropertyAdsReportMetricsGroupTargetingGeographicLocationTypes,
+    z.ZodTypeDef,
+    unknown
+  > = openEnums.inboundSchema(
+    PropertyAdsReportMetricsGroupTargetingGeographicLocationTypes,
+  );

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

@@ -0,0 +1,48 @@
+/*
+ * 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 PropertyAdsReportMetricsGroupTargetingLanguage = {
+  codes?: Array<string> | undefined;
+  localeIds?: Array<number> | undefined;
+};
+
+/** @internal */
+export const PropertyAdsReportMetricsGroupTargetingLanguage$inboundSchema:
+  z.ZodType<
+    PropertyAdsReportMetricsGroupTargetingLanguage,
+    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",
+    });
+  });
+
+export function propertyAdsReportMetricsGroupTargetingLanguageFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  PropertyAdsReportMetricsGroupTargetingLanguage,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      PropertyAdsReportMetricsGroupTargetingLanguage$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'PropertyAdsReportMetricsGroupTargetingLanguage' from JSON`,
+  );
+}

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

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

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

@@ -0,0 +1,54 @@
+/*
+ * 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 PropertyAdsReportMetricsGroupTargetingPlacement = {
+  audienceNetworkPositions?: Array<string> | undefined;
+  facebookPositions?: Array<string> | undefined;
+  instagramPositions?: Array<string> | undefined;
+  messengerPositions?: Array<string> | undefined;
+  platforms?: Array<string> | undefined;
+};
+
+/** @internal */
+export const PropertyAdsReportMetricsGroupTargetingPlacement$inboundSchema:
+  z.ZodType<
+    PropertyAdsReportMetricsGroupTargetingPlacement,
+    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",
+    });
+  });
+
+export function propertyAdsReportMetricsGroupTargetingPlacementFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  PropertyAdsReportMetricsGroupTargetingPlacement,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      PropertyAdsReportMetricsGroupTargetingPlacement$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'PropertyAdsReportMetricsGroupTargetingPlacement' from JSON`,
+  );
+}

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

@@ -227,6 +227,7 @@ export const PropertyConnectionPermissions = {
   AdsCreativeWrite: "ads_creative_write",
   AdsInsertionorderRead: "ads_insertionorder_read",
   AdsInsertionorderWrite: "ads_insertionorder_write",
+  AdsTargetRead: "ads_target_read",
   FormsFormRead: "forms_form_read",
   FormsFormWrite: "forms_form_write",
   FormsSubmissionRead: "forms_submission_read",

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

@@ -0,0 +1,54 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+/**
+ * states, provinces, regions
+ */
+export type RegionTarget = {
+  id: string;
+  name?: string | undefined;
+};
+
+/** @internal */
+export const RegionTarget$inboundSchema: z.ZodType<
+  RegionTarget,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: z.string(),
+  name: z.string().optional(),
+});
+/** @internal */
+export type RegionTarget$Outbound = {
+  id: string;
+  name?: string | undefined;
+};
+
+/** @internal */
+export const RegionTarget$outboundSchema: z.ZodType<
+  RegionTarget$Outbound,
+  z.ZodTypeDef,
+  RegionTarget
+> = z.object({
+  id: z.string(),
+  name: z.string().optional(),
+});
+
+export function regionTargetToJSON(regionTarget: RegionTarget): string {
+  return JSON.stringify(RegionTarget$outboundSchema.parse(regionTarget));
+}
+export function regionTargetFromJSON(
+  jsonString: string,
+): SafeParseResult<RegionTarget, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => RegionTarget$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'RegionTarget' from JSON`,
+  );
+}

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

@@ -146,6 +146,7 @@ export const ObjectType = {
   AdsGroup: "ads_group",
   AdsCreative: "ads_creative",
   AdsInsertionorder: "ads_insertionorder",
+  AdsTarget: "ads_target",
   FormsForm: "forms_form",
   FormsSubmission: "forms_submission",
   ShippingCarrier: "shipping_carrier",

package/src/sdk/sdk.ts

@@ -119,6 +119,7 @@ import { Storage } from "./storage.js";
 import { Student } from "./student.js";
 import { Submission } from "./submission.js";
 import { Subscription } from "./subscription.js";
+import { Target } from "./target.js";
 import { Task } from "./task.js";
 import { Taxrate } from "./taxrate.js";
 import { Ticket } from "./ticket.js";
@@ -266,6 +267,11 @@ export class UnifiedTo extends ClientSDK {
     return (this._insertionorder ??= new Insertionorder(this._options));
   }
 
+  private _target?: Target;
+  get target(): Target {
+    return (this._target ??= new Target(this._options));
+  }
+
   private _assessment?: Assessment;
   get assessment(): Assessment {
     return (this._assessment ??= new Assessment(this._options));

package/src/sdk/target.ts

@@ -0,0 +1,25 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { adsListAdsTargets } from "../funcs/adsListAdsTargets.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as operations from "./models/operations/index.js";
+import * as shared from "./models/shared/index.js";
+import { unwrapAsync } from "./types/fp.js";
+
+export class Target extends ClientSDK {
+  /**
+   * List all targets
+   */
+  async listAdsTargets(
+    request: operations.ListAdsTargetsRequest,
+    options?: RequestOptions,
+  ): Promise<Array<shared.AdsTarget>> {
+    return unwrapAsync(adsListAdsTargets(
+      this,
+      request,
+      options,
+    ));
+  }
+}