@unified-api/typescript-sdk 2.85.37 → 2.85.39

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

@@ -13,6 +13,10 @@ import {
   PropertyAdsReportMetricsCampaignFrequencyCap,
   PropertyAdsReportMetricsCampaignFrequencyCap$inboundSchema,
 } from "./propertyadsreportmetricscampaignfrequencycap.js";
+import {
+  PropertyAdsReportMetricsCampaignKpi,
+  PropertyAdsReportMetricsCampaignKpi$inboundSchema,
+} from "./propertyadsreportmetricscampaignkpi.js";
 import {
   PropertyAdsReportMetricsCampaignTargeting,
   PropertyAdsReportMetricsCampaignTargeting$inboundSchema,
@@ -121,6 +125,7 @@ export type PropertyAdsReportMetricsCampaign = {
   goal?: PropertyAdsReportMetricsCampaignGoal | undefined;
   hasEuPoliticalAds?: boolean | undefined;
   id?: string | undefined;
+  kpi?: PropertyAdsReportMetricsCampaignKpi | undefined;
   labels?: Array<string> | undefined;
   name?: string | undefined;
   organizationId?: string | undefined;
@@ -206,6 +211,7 @@ export const PropertyAdsReportMetricsCampaign$inboundSchema: z.ZodType<
   goal: PropertyAdsReportMetricsCampaignGoal$inboundSchema.optional(),
   has_eu_political_ads: z.boolean().optional(),
   id: z.string().optional(),
+  kpi: PropertyAdsReportMetricsCampaignKpi$inboundSchema.optional(),
   labels: z.array(z.string()).optional(),
   name: z.string().optional(),
   organization_id: z.string().optional(),

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

@@ -0,0 +1,82 @@
+/*
+ * 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 PropertyAdsReportMetricsCampaignKpiType = {
+  Unspecified: "UNSPECIFIED",
+  Cpm: "CPM",
+  Cpc: "CPC",
+  Cpa: "CPA",
+  Ctr: "CTR",
+  Viewability: "VIEWABILITY",
+  Cpiavc: "CPIAVC",
+  Cpe: "CPE",
+  Cpv: "CPV",
+  ClickCvr: "CLICK_CVR",
+  ImpressionCvr: "IMPRESSION_CVR",
+  Vcpm: "VCPM",
+  Vtr: "VTR",
+  AudioCompletionRate: "AUDIO_COMPLETION_RATE",
+  VideoCompletionRate: "VIDEO_COMPLETION_RATE",
+  Cpcl: "CPCL",
+  Cpcv: "CPCV",
+  Tos10: "TOS10",
+  MaximizePacing: "MAXIMIZE_PACING",
+  CustomImpressionValueOverCost: "CUSTOM_IMPRESSION_VALUE_OVER_COST",
+  Other: "OTHER",
+} as const;
+export type PropertyAdsReportMetricsCampaignKpiType = OpenEnum<
+  typeof PropertyAdsReportMetricsCampaignKpiType
+>;
+
+export type PropertyAdsReportMetricsCampaignKpi = {
+  algorithmId?: string | undefined;
+  amount?: number | undefined;
+  percentage?: number | undefined;
+  stringValue?: string | undefined;
+  type?: PropertyAdsReportMetricsCampaignKpiType | undefined;
+};
+
+/** @internal */
+export const PropertyAdsReportMetricsCampaignKpiType$inboundSchema: z.ZodType<
+  PropertyAdsReportMetricsCampaignKpiType,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(PropertyAdsReportMetricsCampaignKpiType);
+
+/** @internal */
+export const PropertyAdsReportMetricsCampaignKpi$inboundSchema: z.ZodType<
+  PropertyAdsReportMetricsCampaignKpi,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  algorithm_id: z.string().optional(),
+  amount: z.number().optional(),
+  percentage: z.number().optional(),
+  string_value: z.string().optional(),
+  type: PropertyAdsReportMetricsCampaignKpiType$inboundSchema.optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "algorithm_id": "algorithmId",
+    "string_value": "stringValue",
+  });
+});
+
+export function propertyAdsReportMetricsCampaignKpiFromJSON(
+  jsonString: string,
+): SafeParseResult<PropertyAdsReportMetricsCampaignKpi, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      PropertyAdsReportMetricsCampaignKpi$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PropertyAdsReportMetricsCampaignKpi' from JSON`,
+  );
+}

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

@@ -21,8 +21,8 @@ export const PropertyAdsReportMetricsCreativeCreativeType = {
   PublisherHosted: "PUBLISHER_HOSTED",
   AssetBased: "ASSET_BASED",
   Image: "IMAGE",
-  Share: "SHARE",
   Document: "DOCUMENT",
+  Share: "SHARE",
 } as const;
 export type PropertyAdsReportMetricsCreativeCreativeType = OpenEnum<
   typeof PropertyAdsReportMetricsCreativeCreativeType

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

@@ -41,6 +41,7 @@ export const PropertyConnectionCategories = {
   Datastore: "datastore",
   Cdp: "cdp",
   Performance: "performance",
+  Social: "social",
 } as const;
 export type PropertyConnectionCategories = OpenEnum<
   typeof PropertyConnectionCategories

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

@@ -27,6 +27,8 @@ export const PropertyConnectionPermissions = {
   AccountingExpenseWrite: "accounting_expense_write",
   AccountingTaxrateRead: "accounting_taxrate_read",
   AccountingTaxrateWrite: "accounting_taxrate_write",
+  AccountingPaymenttermRead: "accounting_paymentterm_read",
+  AccountingPaymenttermWrite: "accounting_paymentterm_write",
   AccountingOrganizationRead: "accounting_organization_read",
   AccountingOrderRead: "accounting_order_read",
   AccountingOrderWrite: "accounting_order_write",
@@ -317,6 +319,14 @@ export const PropertyConnectionPermissions = {
   PerformanceGoalWrite: "performance_goal_write",
   PerformanceFeedbackRead: "performance_feedback_read",
   PerformanceFeedbackWrite: "performance_feedback_write",
+  SocialPostRead: "social_post_read",
+  SocialPostWrite: "social_post_write",
+  SocialProfileRead: "social_profile_read",
+  SocialProfileWrite: "social_profile_write",
+  SocialReviewRead: "social_review_read",
+  SocialReviewWrite: "social_review_write",
+  SocialInsightRead: "social_insight_read",
+  SocialInsightWrite: "social_insight_write",
 } as const;
 export type PropertyConnectionPermissions = OpenEnum<
   typeof PropertyConnectionPermissions

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

@@ -41,6 +41,7 @@ export const PropertyIntegrationCategories = {
   Datastore: "datastore",
   Cdp: "cdp",
   Performance: "performance",
+  Social: "social",
 } as const;
 export type PropertyIntegrationCategories = OpenEnum<
   typeof PropertyIntegrationCategories

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

@@ -0,0 +1,88 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+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 PropertySocialPostCallToActionType = {
+  Book: "BOOK",
+  Order: "ORDER",
+  Shop: "SHOP",
+  LearnMore: "LEARN_MORE",
+  SignUp: "SIGN_UP",
+  Call: "CALL",
+  Other: "OTHER",
+} as const;
+export type PropertySocialPostCallToActionType = OpenEnum<
+  typeof PropertySocialPostCallToActionType
+>;
+
+/**
+ * Call-to-action button on the post
+ */
+export type PropertySocialPostCallToAction = {
+  type?: PropertySocialPostCallToActionType | undefined;
+  url?: string | undefined;
+};
+
+/** @internal */
+export const PropertySocialPostCallToActionType$inboundSchema: z.ZodType<
+  PropertySocialPostCallToActionType,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(PropertySocialPostCallToActionType);
+/** @internal */
+export const PropertySocialPostCallToActionType$outboundSchema: z.ZodType<
+  string,
+  z.ZodTypeDef,
+  PropertySocialPostCallToActionType
+> = openEnums.outboundSchema(PropertySocialPostCallToActionType);
+
+/** @internal */
+export const PropertySocialPostCallToAction$inboundSchema: z.ZodType<
+  PropertySocialPostCallToAction,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  type: PropertySocialPostCallToActionType$inboundSchema.optional(),
+  url: z.string().optional(),
+});
+/** @internal */
+export type PropertySocialPostCallToAction$Outbound = {
+  type?: string | undefined;
+  url?: string | undefined;
+};
+
+/** @internal */
+export const PropertySocialPostCallToAction$outboundSchema: z.ZodType<
+  PropertySocialPostCallToAction$Outbound,
+  z.ZodTypeDef,
+  PropertySocialPostCallToAction
+> = z.object({
+  type: PropertySocialPostCallToActionType$outboundSchema.optional(),
+  url: z.string().optional(),
+});
+
+export function propertySocialPostCallToActionToJSON(
+  propertySocialPostCallToAction: PropertySocialPostCallToAction,
+): string {
+  return JSON.stringify(
+    PropertySocialPostCallToAction$outboundSchema.parse(
+      propertySocialPostCallToAction,
+    ),
+  );
+}
+export function propertySocialPostCallToActionFromJSON(
+  jsonString: string,
+): SafeParseResult<PropertySocialPostCallToAction, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PropertySocialPostCallToAction$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PropertySocialPostCallToAction' from JSON`,
+  );
+}

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

@@ -0,0 +1,93 @@
+/*
+ * 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";
+
+/**
+ * Engagement metrics for the post
+ */
+export type PropertySocialPostMetrics = {
+  bookmarkCount?: number | undefined;
+  commentCount?: number | undefined;
+  likeCount?: number | undefined;
+  quoteCount?: number | undefined;
+  shareCount?: number | undefined;
+  viewCount?: number | undefined;
+};
+
+/** @internal */
+export const PropertySocialPostMetrics$inboundSchema: z.ZodType<
+  PropertySocialPostMetrics,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  bookmark_count: z.number().optional(),
+  comment_count: z.number().optional(),
+  like_count: z.number().optional(),
+  quote_count: z.number().optional(),
+  share_count: z.number().optional(),
+  view_count: z.number().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "bookmark_count": "bookmarkCount",
+    "comment_count": "commentCount",
+    "like_count": "likeCount",
+    "quote_count": "quoteCount",
+    "share_count": "shareCount",
+    "view_count": "viewCount",
+  });
+});
+/** @internal */
+export type PropertySocialPostMetrics$Outbound = {
+  bookmark_count?: number | undefined;
+  comment_count?: number | undefined;
+  like_count?: number | undefined;
+  quote_count?: number | undefined;
+  share_count?: number | undefined;
+  view_count?: number | undefined;
+};
+
+/** @internal */
+export const PropertySocialPostMetrics$outboundSchema: z.ZodType<
+  PropertySocialPostMetrics$Outbound,
+  z.ZodTypeDef,
+  PropertySocialPostMetrics
+> = z.object({
+  bookmarkCount: z.number().optional(),
+  commentCount: z.number().optional(),
+  likeCount: z.number().optional(),
+  quoteCount: z.number().optional(),
+  shareCount: z.number().optional(),
+  viewCount: z.number().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    bookmarkCount: "bookmark_count",
+    commentCount: "comment_count",
+    likeCount: "like_count",
+    quoteCount: "quote_count",
+    shareCount: "share_count",
+    viewCount: "view_count",
+  });
+});
+
+export function propertySocialPostMetricsToJSON(
+  propertySocialPostMetrics: PropertySocialPostMetrics,
+): string {
+  return JSON.stringify(
+    PropertySocialPostMetrics$outboundSchema.parse(propertySocialPostMetrics),
+  );
+}
+export function propertySocialPostMetricsFromJSON(
+  jsonString: string,
+): SafeParseResult<PropertySocialPostMetrics, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PropertySocialPostMetrics$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PropertySocialPostMetrics' from JSON`,
+  );
+}

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

@@ -0,0 +1,49 @@
+/*
+ * 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";
+
+/**
+ * Structured postal address
+ */
+export type PropertySocialProfileAddress = {
+  address1?: string | undefined;
+  address2?: string | undefined;
+  city?: string | undefined;
+  country?: string | undefined;
+  postalCode?: string | undefined;
+  region?: string | undefined;
+};
+
+/** @internal */
+export const PropertySocialProfileAddress$inboundSchema: z.ZodType<
+  PropertySocialProfileAddress,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  address1: z.string().optional(),
+  address2: z.string().optional(),
+  city: z.string().optional(),
+  country: z.string().optional(),
+  postal_code: z.string().optional(),
+  region: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "postal_code": "postalCode",
+  });
+});
+
+export function propertySocialProfileAddressFromJSON(
+  jsonString: string,
+): SafeParseResult<PropertySocialProfileAddress, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PropertySocialProfileAddress$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PropertySocialProfileAddress' from JSON`,
+  );
+}

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

@@ -0,0 +1,45 @@
+/*
+ * 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";
+
+/**
+ * Audience metrics for the profile
+ */
+export type PropertySocialProfileMetrics = {
+  followerCount?: number | undefined;
+  followingCount?: number | undefined;
+  postCount?: number | undefined;
+};
+
+/** @internal */
+export const PropertySocialProfileMetrics$inboundSchema: z.ZodType<
+  PropertySocialProfileMetrics,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  follower_count: z.number().optional(),
+  following_count: z.number().optional(),
+  post_count: z.number().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "follower_count": "followerCount",
+    "following_count": "followingCount",
+    "post_count": "postCount",
+  });
+});
+
+export function propertySocialProfileMetricsFromJSON(
+  jsonString: string,
+): SafeParseResult<PropertySocialProfileMetrics, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PropertySocialProfileMetrics$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PropertySocialProfileMetrics' from JSON`,
+  );
+}

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

@@ -0,0 +1,75 @@
+/*
+ * 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";
+
+/**
+ * The business's reply to the review
+ */
+export type PropertySocialReviewReply = {
+  content?: string | undefined;
+  createdAt?: Date | undefined;
+  updatedAt?: Date | undefined;
+};
+
+/** @internal */
+export const PropertySocialReviewReply$inboundSchema: z.ZodType<
+  PropertySocialReviewReply,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  content: z.string().optional(),
+  created_at: z.string().datetime({ offset: true }).transform(v => new Date(v))
+    .optional(),
+  updated_at: z.string().datetime({ offset: true }).transform(v => new Date(v))
+    .optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "created_at": "createdAt",
+    "updated_at": "updatedAt",
+  });
+});
+/** @internal */
+export type PropertySocialReviewReply$Outbound = {
+  content?: string | undefined;
+  created_at?: string | undefined;
+  updated_at?: string | undefined;
+};
+
+/** @internal */
+export const PropertySocialReviewReply$outboundSchema: z.ZodType<
+  PropertySocialReviewReply$Outbound,
+  z.ZodTypeDef,
+  PropertySocialReviewReply
+> = z.object({
+  content: z.string().optional(),
+  createdAt: z.date().transform(v => v.toISOString()).optional(),
+  updatedAt: z.date().transform(v => v.toISOString()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    createdAt: "created_at",
+    updatedAt: "updated_at",
+  });
+});
+
+export function propertySocialReviewReplyToJSON(
+  propertySocialReviewReply: PropertySocialReviewReply,
+): string {
+  return JSON.stringify(
+    PropertySocialReviewReply$outboundSchema.parse(propertySocialReviewReply),
+  );
+}
+export function propertySocialReviewReplyFromJSON(
+  jsonString: string,
+): SafeParseResult<PropertySocialReviewReply, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PropertySocialReviewReply$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PropertySocialReviewReply' from JSON`,
+  );
+}

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

@@ -0,0 +1,94 @@
+/*
+ * 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 Metric = {
+  Followers: "FOLLOWERS",
+  Following: "FOLLOWING",
+  Posts: "POSTS",
+  Impressions: "IMPRESSIONS",
+  Reach: "REACH",
+  Engagement: "ENGAGEMENT",
+  ProfileViews: "PROFILE_VIEWS",
+  Clicks: "CLICKS",
+  VideoViews: "VIDEO_VIEWS",
+  Likes: "LIKES",
+  Comments: "COMMENTS",
+  Shares: "SHARES",
+  Saves: "SAVES",
+  Other: "OTHER",
+} as const;
+export type Metric = OpenEnum<typeof Metric>;
+
+export const Period = {
+  Day: "DAY",
+  Week: "WEEK",
+  Month: "MONTH",
+  Lifetime: "LIFETIME",
+  Total: "TOTAL",
+  Other: "OTHER",
+} as const;
+export type Period = OpenEnum<typeof Period>;
+
+export type SocialInsight = {
+  createdAt?: Date | undefined;
+  date?: Date | undefined;
+  id?: string | undefined;
+  metric?: Metric | undefined;
+  period?: Period | undefined;
+  postId?: string | undefined;
+  profileId?: string | undefined;
+  raw?: { [k: string]: any } | undefined;
+  value?: number | undefined;
+};
+
+/** @internal */
+export const Metric$inboundSchema: z.ZodType<Metric, z.ZodTypeDef, unknown> =
+  openEnums.inboundSchema(Metric);
+
+/** @internal */
+export const Period$inboundSchema: z.ZodType<Period, z.ZodTypeDef, unknown> =
+  openEnums.inboundSchema(Period);
+
+/** @internal */
+export const SocialInsight$inboundSchema: z.ZodType<
+  SocialInsight,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  created_at: z.string().datetime({ offset: true }).transform(v => new Date(v))
+    .optional(),
+  date: z.string().datetime({ offset: true }).transform(v => new Date(v))
+    .optional(),
+  id: z.string().optional(),
+  metric: Metric$inboundSchema.optional(),
+  period: Period$inboundSchema.optional(),
+  post_id: z.string().optional(),
+  profile_id: z.string().optional(),
+  raw: z.record(z.any()).optional(),
+  value: z.number().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "created_at": "createdAt",
+    "post_id": "postId",
+    "profile_id": "profileId",
+  });
+});
+
+export function socialInsightFromJSON(
+  jsonString: string,
+): SafeParseResult<SocialInsight, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SocialInsight$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SocialInsight' from JSON`,
+  );
+}