@unified-api/typescript-sdk 2.83.18 → 2.83.20

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

@@ -246,7 +246,9 @@ export * from "./listadscreatives.js";
 export * from "./listadsgroups.js";
 export * from "./listadsinsertionorders.js";
 export * from "./listadsorganizations.js";
+export * from "./listadspromoteds.js";
 export * from "./listadsreports.js";
+export * from "./listadstargets.js";
 export * from "./listassessmentpackages.js";
 export * from "./listatsactivities.js";
 export * from "./listatsapplications.js";

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

@@ -26,7 +26,7 @@ export const ListAdsAdsQueryParamFields = {
   DisplayUrl: "display_url",
   Path1: "path1",
   Path2: "path2",
-  Metadata: "metadata",
+  Promoted: "promoted",
   Raw: "raw",
 } as const;
 export type ListAdsAdsQueryParamFields = ClosedEnum<

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

@@ -25,6 +25,7 @@ export const ListAdsCampaignsQueryParamFields = {
   AdvertisingChannelType: "advertising_channel_type",
   CampaignBudgetIdentifier: "campaign_budget_identifier",
   Currency: "currency",
+  Category: "category",
   Raw: "raw",
 } as const;
 export type ListAdsCampaignsQueryParamFields = ClosedEnum<

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

@@ -30,7 +30,7 @@ export const ListAdsCreativesQueryParamFields = {
   ExternalCreativeReference: "external_creative_reference",
   ExternalPlacementReference: "external_placement_reference",
   ExternalAdReference: "external_ad_reference",
-  Metadata: "metadata",
+  Promoted: "promoted",
   Path1: "path1",
   Path2: "path2",
   Raw: "raw",

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

@@ -34,7 +34,7 @@ export const ListAdsGroupsQueryParamFields = {
   OptimizationGoal: "optimization_goal",
   BillingEvent: "billing_event",
   Currency: "currency",
-  Metadata: "metadata",
+  Promoted: "promoted",
   Raw: "raw",
 } as const;
 export type ListAdsGroupsQueryParamFields = ClosedEnum<

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

@@ -0,0 +1,101 @@
+/*
+ * 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 { ClosedEnum } from "../../types/enums.js";
+
+export const ListAdsPromotedsQueryParamFields = {
+  Id: "id",
+  Name: "name",
+  Type: "type",
+} as const;
+export type ListAdsPromotedsQueryParamFields = ClosedEnum<
+  typeof ListAdsPromotedsQueryParamFields
+>;
+
+export type ListAdsPromotedsRequest = {
+  /**
+   * ID of the connection
+   */
+  connectionId: string;
+  /**
+   * Fields to return
+   */
+  fields?: Array<ListAdsPromotedsQueryParamFields> | undefined;
+  limit?: number | undefined;
+  offset?: number | undefined;
+  order?: string | undefined;
+  /**
+   * The org ID to filter by (reference to AdsOrganization)
+   */
+  orgId?: string | undefined;
+  /**
+   * Query string to search. eg. email address or name
+   */
+  query?: string | undefined;
+  /**
+   * Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar
+   */
+  raw?: string | undefined;
+  sort?: string | undefined;
+  type?: string | undefined;
+  /**
+   * Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
+   */
+  updatedGte?: string | undefined;
+};
+
+/** @internal */
+export const ListAdsPromotedsQueryParamFields$outboundSchema: z.ZodNativeEnum<
+  typeof ListAdsPromotedsQueryParamFields
+> = z.nativeEnum(ListAdsPromotedsQueryParamFields);
+
+/** @internal */
+export type ListAdsPromotedsRequest$Outbound = {
+  connection_id: string;
+  fields?: Array<string> | undefined;
+  limit?: number | undefined;
+  offset?: number | undefined;
+  order?: string | undefined;
+  org_id?: string | undefined;
+  query?: string | undefined;
+  raw?: string | undefined;
+  sort?: string | undefined;
+  type?: string | undefined;
+  updated_gte?: string | undefined;
+};
+
+/** @internal */
+export const ListAdsPromotedsRequest$outboundSchema: z.ZodType<
+  ListAdsPromotedsRequest$Outbound,
+  z.ZodTypeDef,
+  ListAdsPromotedsRequest
+> = z.object({
+  connectionId: z.string(),
+  fields: z.array(ListAdsPromotedsQueryParamFields$outboundSchema).optional(),
+  limit: z.number().optional(),
+  offset: z.number().optional(),
+  order: z.string().optional(),
+  orgId: z.string().optional(),
+  query: z.string().optional(),
+  raw: z.string().optional(),
+  sort: z.string().optional(),
+  type: z.string().optional(),
+  updatedGte: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    connectionId: "connection_id",
+    orgId: "org_id",
+    updatedGte: "updated_gte",
+  });
+});
+
+export function listAdsPromotedsRequestToJSON(
+  listAdsPromotedsRequest: ListAdsPromotedsRequest,
+): string {
+  return JSON.stringify(
+    ListAdsPromotedsRequest$outboundSchema.parse(listAdsPromotedsRequest),
+  );
+}

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

@@ -0,0 +1,102 @@
+/*
+ * 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 { ClosedEnum } from "../../types/enums.js";
+
+export const ListAdsTargetsQueryParamFields = {
+  Id: "id",
+  Name: "name",
+  Value: "value",
+  Type: "type",
+} as const;
+export type ListAdsTargetsQueryParamFields = ClosedEnum<
+  typeof ListAdsTargetsQueryParamFields
+>;
+
+export type ListAdsTargetsRequest = {
+  /**
+   * ID of the connection
+   */
+  connectionId: string;
+  /**
+   * Fields to return
+   */
+  fields?: Array<ListAdsTargetsQueryParamFields> | undefined;
+  limit?: number | undefined;
+  offset?: number | undefined;
+  order?: string | undefined;
+  /**
+   * The org ID to filter by (reference to AdsOrganization)
+   */
+  orgId?: string | undefined;
+  /**
+   * Query string to search. eg. email address or name
+   */
+  query?: string | undefined;
+  /**
+   * Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar
+   */
+  raw?: string | undefined;
+  sort?: string | undefined;
+  type?: string | undefined;
+  /**
+   * Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
+   */
+  updatedGte?: string | undefined;
+};
+
+/** @internal */
+export const ListAdsTargetsQueryParamFields$outboundSchema: z.ZodNativeEnum<
+  typeof ListAdsTargetsQueryParamFields
+> = z.nativeEnum(ListAdsTargetsQueryParamFields);
+
+/** @internal */
+export type ListAdsTargetsRequest$Outbound = {
+  connection_id: string;
+  fields?: Array<string> | undefined;
+  limit?: number | undefined;
+  offset?: number | undefined;
+  order?: string | undefined;
+  org_id?: string | undefined;
+  query?: string | undefined;
+  raw?: string | undefined;
+  sort?: string | undefined;
+  type?: string | undefined;
+  updated_gte?: string | undefined;
+};
+
+/** @internal */
+export const ListAdsTargetsRequest$outboundSchema: z.ZodType<
+  ListAdsTargetsRequest$Outbound,
+  z.ZodTypeDef,
+  ListAdsTargetsRequest
+> = z.object({
+  connectionId: z.string(),
+  fields: z.array(ListAdsTargetsQueryParamFields$outboundSchema).optional(),
+  limit: z.number().optional(),
+  offset: z.number().optional(),
+  order: z.string().optional(),
+  orgId: z.string().optional(),
+  query: z.string().optional(),
+  raw: z.string().optional(),
+  sort: z.string().optional(),
+  type: z.string().optional(),
+  updatedGte: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    connectionId: "connection_id",
+    orgId: "org_id",
+    updatedGte: "updated_gte",
+  });
+});
+
+export function listAdsTargetsRequestToJSON(
+  listAdsTargetsRequest: ListAdsTargetsRequest,
+): string {
+  return JSON.stringify(
+    ListAdsTargetsRequest$outboundSchema.parse(listAdsTargetsRequest),
+  );
+}

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

@@ -42,6 +42,9 @@ export type ListStorageFilesRequest = {
    * Fields to return
    */
   fields?: Array<ListStorageFilesQueryParamFields> | undefined;
+  /**
+   * The fulltext to filter by
+   */
   fulltext?: string | undefined;
   limit?: number | undefined;
   offset?: number | undefined;

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

@@ -27,7 +27,7 @@ export const PatchAdsAdQueryParamFields = {
   DisplayUrl: "display_url",
   Path1: "path1",
   Path2: "path2",
-  Metadata: "metadata",
+  Promoted: "promoted",
   Raw: "raw",
 } as const;
 export type PatchAdsAdQueryParamFields = ClosedEnum<

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

@@ -26,6 +26,7 @@ export const PatchAdsCampaignQueryParamFields = {
   AdvertisingChannelType: "advertising_channel_type",
   CampaignBudgetIdentifier: "campaign_budget_identifier",
   Currency: "currency",
+  Category: "category",
   Raw: "raw",
 } as const;
 export type PatchAdsCampaignQueryParamFields = ClosedEnum<

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

@@ -31,7 +31,7 @@ export const PatchAdsCreativeQueryParamFields = {
   ExternalCreativeReference: "external_creative_reference",
   ExternalPlacementReference: "external_placement_reference",
   ExternalAdReference: "external_ad_reference",
-  Metadata: "metadata",
+  Promoted: "promoted",
   Path1: "path1",
   Path2: "path2",
   Raw: "raw",

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

@@ -35,7 +35,7 @@ export const PatchAdsGroupQueryParamFields = {
   OptimizationGoal: "optimization_goal",
   BillingEvent: "billing_event",
   Currency: "currency",
-  Metadata: "metadata",
+  Promoted: "promoted",
   Raw: "raw",
 } as const;
 export type PatchAdsGroupQueryParamFields = ClosedEnum<

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

@@ -27,7 +27,7 @@ export const UpdateAdsAdQueryParamFields = {
   DisplayUrl: "display_url",
   Path1: "path1",
   Path2: "path2",
-  Metadata: "metadata",
+  Promoted: "promoted",
   Raw: "raw",
 } as const;
 export type UpdateAdsAdQueryParamFields = ClosedEnum<

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

@@ -26,6 +26,7 @@ export const UpdateAdsCampaignQueryParamFields = {
   AdvertisingChannelType: "advertising_channel_type",
   CampaignBudgetIdentifier: "campaign_budget_identifier",
   Currency: "currency",
+  Category: "category",
   Raw: "raw",
 } as const;
 export type UpdateAdsCampaignQueryParamFields = ClosedEnum<

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

@@ -31,7 +31,7 @@ export const UpdateAdsCreativeQueryParamFields = {
   ExternalCreativeReference: "external_creative_reference",
   ExternalPlacementReference: "external_placement_reference",
   ExternalAdReference: "external_ad_reference",
-  Metadata: "metadata",
+  Promoted: "promoted",
   Path1: "path1",
   Path2: "path2",
   Raw: "raw",

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

@@ -35,7 +35,7 @@ export const UpdateAdsGroupQueryParamFields = {
   OptimizationGoal: "optimization_goal",
   BillingEvent: "billing_event",
   Currency: "currency",
-  Metadata: "metadata",
+  Promoted: "promoted",
   Raw: "raw",
 } as const;
 export type UpdateAdsGroupQueryParamFields = ClosedEnum<

package/src/sdk/models/shared/adsad.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";
 
 export const AdType = {
   Text: "TEXT",
@@ -57,11 +57,11 @@ export type AdsAd = {
   groupId?: string | undefined;
   headline?: string | undefined;
   id?: string | undefined;
-  metadata?: Array<AdsMetadata> | undefined;
   name?: string | undefined;
   organizationId?: string | undefined;
   path1?: string | undefined;
   path2?: string | undefined;
+  promoted?: Array<AdsPromoted> | undefined;
   raw?: { [k: string]: any } | undefined;
   status?: AdsAdStatus | undefined;
   updatedAt?: Date | undefined;
@@ -105,11 +105,11 @@ export const AdsAd$inboundSchema: z.ZodType<AdsAd, z.ZodTypeDef, unknown> = z
     group_id: z.string().optional(),
     headline: z.string().optional(),
     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(),
+    promoted: z.array(AdsPromoted$inboundSchema).optional(),
     raw: z.record(z.any()).optional(),
     status: AdsAdStatus$inboundSchema.optional(),
     updated_at: z.string().datetime({ offset: true }).transform(v =>
@@ -145,11 +145,11 @@ export type AdsAd$Outbound = {
   group_id?: string | undefined;
   headline?: string | undefined;
   id?: string | undefined;
-  metadata?: Array<AdsMetadata$Outbound> | undefined;
   name?: string | undefined;
   organization_id?: string | undefined;
   path1?: string | undefined;
   path2?: string | undefined;
+  promoted?: Array<AdsPromoted$Outbound> | undefined;
   raw?: { [k: string]: any } | undefined;
   status?: string | undefined;
   updated_at?: string | undefined;
@@ -174,11 +174,11 @@ export const AdsAd$outboundSchema: z.ZodType<
   groupId: z.string().optional(),
   headline: z.string().optional(),
   id: 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(),
+  promoted: z.array(AdsPromoted$outboundSchema).optional(),
   raw: z.record(z.any()).optional(),
   status: AdsAdStatus$outboundSchema.optional(),
   updatedAt: z.date().transform(v => v.toISOString()).optional(),

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

@@ -73,6 +73,7 @@ export type AdsCampaign = {
   budgetAmount?: number | undefined;
   budgetPeriod?: BudgetPeriod | undefined;
   campaignBudgetIdentifier?: string | undefined;
+  category?: string | undefined;
   createdAt?: Date | undefined;
   currency?: string | undefined;
   endAt?: Date | undefined;
@@ -146,6 +147,7 @@ export const AdsCampaign$inboundSchema: z.ZodType<
   budget_amount: z.number().optional(),
   budget_period: BudgetPeriod$inboundSchema.optional(),
   campaign_budget_identifier: z.string().optional(),
+  category: z.string().optional(),
   created_at: z.string().datetime({ offset: true }).transform(v => new Date(v))
     .optional(),
   currency: z.string().optional(),
@@ -187,6 +189,7 @@ export type AdsCampaign$Outbound = {
   budget_amount?: number | undefined;
   budget_period?: string | undefined;
   campaign_budget_identifier?: string | undefined;
+  category?: string | undefined;
   created_at?: string | undefined;
   currency?: string | undefined;
   end_at?: string | undefined;
@@ -214,6 +217,7 @@ export const AdsCampaign$outboundSchema: z.ZodType<
   budgetAmount: z.number().optional(),
   budgetPeriod: BudgetPeriod$outboundSchema.optional(),
   campaignBudgetIdentifier: z.string().optional(),
+  category: z.string().optional(),
   createdAt: z.date().transform(v => v.toISOString()).optional(),
   currency: z.string().optional(),
   endAt: z.date().transform(v => v.toISOString()).optional(),

package/src/sdk/models/shared/adschedule.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 DayOfWeek = {
+  Monday: "MONDAY",
+  Tuesday: "TUESDAY",
+  Wednesday: "WEDNESDAY",
+  Thursday: "THURSDAY",
+  Friday: "FRIDAY",
+  Saturday: "SATURDAY",
+  Sunday: "SUNDAY",
+} as const;
+export type DayOfWeek = OpenEnum<typeof DayOfWeek>;
+
+export type AdSchedule = {
+  bidModifier?: number | undefined;
+  dayOfWeek: DayOfWeek;
+  endHour: number;
+  endMinute?: number | undefined;
+  startHour: number;
+  startMinute?: number | undefined;
+};
+
+/** @internal */
+export const DayOfWeek$inboundSchema: z.ZodType<
+  DayOfWeek,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(DayOfWeek);
+/** @internal */
+export const DayOfWeek$outboundSchema: z.ZodType<
+  string,
+  z.ZodTypeDef,
+  DayOfWeek
+> = openEnums.outboundSchema(DayOfWeek);
+
+/** @internal */
+export const AdSchedule$inboundSchema: z.ZodType<
+  AdSchedule,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  bid_modifier: z.number().optional(),
+  day_of_week: DayOfWeek$inboundSchema,
+  end_hour: z.number(),
+  end_minute: z.number().optional(),
+  start_hour: z.number(),
+  start_minute: z.number().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "bid_modifier": "bidModifier",
+    "day_of_week": "dayOfWeek",
+    "end_hour": "endHour",
+    "end_minute": "endMinute",
+    "start_hour": "startHour",
+    "start_minute": "startMinute",
+  });
+});
+/** @internal */
+export type AdSchedule$Outbound = {
+  bid_modifier?: number | undefined;
+  day_of_week: string;
+  end_hour: number;
+  end_minute?: number | undefined;
+  start_hour: number;
+  start_minute?: number | undefined;
+};
+
+/** @internal */
+export const AdSchedule$outboundSchema: z.ZodType<
+  AdSchedule$Outbound,
+  z.ZodTypeDef,
+  AdSchedule
+> = z.object({
+  bidModifier: z.number().optional(),
+  dayOfWeek: DayOfWeek$outboundSchema,
+  endHour: z.number(),
+  endMinute: z.number().optional(),
+  startHour: z.number(),
+  startMinute: z.number().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    bidModifier: "bid_modifier",
+    dayOfWeek: "day_of_week",
+    endHour: "end_hour",
+    endMinute: "end_minute",
+    startHour: "start_hour",
+    startMinute: "start_minute",
+  });
+});
+
+export function adScheduleToJSON(adSchedule: AdSchedule): string {
+  return JSON.stringify(AdSchedule$outboundSchema.parse(adSchedule));
+}
+export function adScheduleFromJSON(
+  jsonString: string,
+): SafeParseResult<AdSchedule, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AdSchedule$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AdSchedule' from JSON`,
+  );
+}

package/src/sdk/models/shared/adscreative.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";
 
 export const CreativeType = {
   Unspecified: "UNSPECIFIED",
@@ -67,11 +67,11 @@ export type AdsCreative = {
   id?: string | undefined;
   itemId?: string | undefined;
   linkUrl?: string | undefined;
-  metadata?: Array<AdsMetadata> | undefined;
   name?: string | undefined;
   organizationId?: string | undefined;
   path1?: string | undefined;
   path2?: string | undefined;
+  promoted?: Array<AdsPromoted> | undefined;
   raw?: { [k: string]: any } | undefined;
   status?: AdsCreativeStatus | undefined;
   thirdPartyTag?: string | undefined;
@@ -142,11 +142,11 @@ export const AdsCreative$inboundSchema: z.ZodType<
   id: z.string().optional(),
   item_id: z.string().optional(),
   link_url: 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(),
+  promoted: z.array(AdsPromoted$inboundSchema).optional(),
   raw: z.record(z.any()).optional(),
   status: AdsCreativeStatus$inboundSchema.optional(),
   third_party_tag: z.string().optional(),
@@ -191,11 +191,11 @@ export type AdsCreative$Outbound = {
   id?: string | undefined;
   item_id?: string | undefined;
   link_url?: string | undefined;
-  metadata?: Array<AdsMetadata$Outbound> | undefined;
   name?: string | undefined;
   organization_id?: string | undefined;
   path1?: string | undefined;
   path2?: string | undefined;
+  promoted?: Array<AdsPromoted$Outbound> | undefined;
   raw?: { [k: string]: any } | undefined;
   status?: string | undefined;
   third_party_tag?: string | undefined;
@@ -226,11 +226,11 @@ export const AdsCreative$outboundSchema: z.ZodType<
   id: z.string().optional(),
   itemId: z.string().optional(),
   linkUrl: 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(),
+  promoted: z.array(AdsPromoted$outboundSchema).optional(),
   raw: z.record(z.any()).optional(),
   status: AdsCreativeStatus$outboundSchema.optional(),
   thirdPartyTag: z.string().optional(),