@unified-api/typescript-sdk 2.85.38 → 2.85.40

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`,
+  );
+}

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

@@ -0,0 +1,94 @@
+/*
+ * 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 SocialMediaType = {
+  Photo: "PHOTO",
+  Video: "VIDEO",
+  Gif: "GIF",
+  Other: "OTHER",
+} as const;
+export type SocialMediaType = OpenEnum<typeof SocialMediaType>;
+
+export type SocialMedia = {
+  alt?: string | undefined;
+  height?: number | undefined;
+  id?: string | undefined;
+  position?: number | undefined;
+  type?: SocialMediaType | undefined;
+  url: string;
+  width?: number | undefined;
+};
+
+/** @internal */
+export const SocialMediaType$inboundSchema: z.ZodType<
+  SocialMediaType,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(SocialMediaType);
+/** @internal */
+export const SocialMediaType$outboundSchema: z.ZodType<
+  string,
+  z.ZodTypeDef,
+  SocialMediaType
+> = openEnums.outboundSchema(SocialMediaType);
+
+/** @internal */
+export const SocialMedia$inboundSchema: z.ZodType<
+  SocialMedia,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  alt: z.string().optional(),
+  height: z.number().optional(),
+  id: z.string().optional(),
+  position: z.number().optional(),
+  type: SocialMediaType$inboundSchema.optional(),
+  url: z.string(),
+  width: z.number().optional(),
+});
+/** @internal */
+export type SocialMedia$Outbound = {
+  alt?: string | undefined;
+  height?: number | undefined;
+  id?: string | undefined;
+  position?: number | undefined;
+  type?: string | undefined;
+  url: string;
+  width?: number | undefined;
+};
+
+/** @internal */
+export const SocialMedia$outboundSchema: z.ZodType<
+  SocialMedia$Outbound,
+  z.ZodTypeDef,
+  SocialMedia
+> = z.object({
+  alt: z.string().optional(),
+  height: z.number().optional(),
+  id: z.string().optional(),
+  position: z.number().optional(),
+  type: SocialMediaType$outboundSchema.optional(),
+  url: z.string(),
+  width: z.number().optional(),
+});
+
+export function socialMediaToJSON(socialMedia: SocialMedia): string {
+  return JSON.stringify(SocialMedia$outboundSchema.parse(socialMedia));
+}
+export function socialMediaFromJSON(
+  jsonString: string,
+): SafeParseResult<SocialMedia, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SocialMedia$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SocialMedia' from JSON`,
+  );
+}

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

@@ -0,0 +1,209 @@
+/*
+ * 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 {
+  PropertySocialPostCallToAction,
+  PropertySocialPostCallToAction$inboundSchema,
+  PropertySocialPostCallToAction$Outbound,
+  PropertySocialPostCallToAction$outboundSchema,
+} from "./propertysocialpostcalltoaction.js";
+import {
+  PropertySocialPostMetrics,
+  PropertySocialPostMetrics$inboundSchema,
+  PropertySocialPostMetrics$Outbound,
+  PropertySocialPostMetrics$outboundSchema,
+} from "./propertysocialpostmetrics.js";
+import {
+  SocialMedia,
+  SocialMedia$inboundSchema,
+  SocialMedia$Outbound,
+  SocialMedia$outboundSchema,
+} from "./socialmedia.js";
+
+export const SocialPostStatus = {
+  Draft: "DRAFT",
+  Scheduled: "SCHEDULED",
+  Published: "PUBLISHED",
+  Rejected: "REJECTED",
+  Processing: "PROCESSING",
+  Deleted: "DELETED",
+  Other: "OTHER",
+} as const;
+export type SocialPostStatus = OpenEnum<typeof SocialPostStatus>;
+
+export const SocialPostType = {
+  Post: "POST",
+  Reply: "REPLY",
+  Repost: "REPOST",
+  Quote: "QUOTE",
+  Event: "EVENT",
+  Offer: "OFFER",
+  Alert: "ALERT",
+  Story: "STORY",
+  Other: "OTHER",
+} as const;
+export type SocialPostType = OpenEnum<typeof SocialPostType>;
+
+export type SocialPost = {
+  body?: string | undefined;
+  /**
+   * Call-to-action button on the post
+   */
+  callToAction?: PropertySocialPostCallToAction | undefined;
+  createdAt?: Date | undefined;
+  id?: string | undefined;
+  language?: string | undefined;
+  /**
+   * Media assets attached to the post
+   */
+  media?: Array<SocialMedia> | undefined;
+  /**
+   * Engagement metrics for the post
+   */
+  metrics?: PropertySocialPostMetrics | undefined;
+  parentPostId?: string | undefined;
+  profileId?: string | undefined;
+  raw?: { [k: string]: any } | undefined;
+  scheduledAt?: Date | undefined;
+  status?: SocialPostStatus | undefined;
+  title?: string | undefined;
+  type?: SocialPostType | undefined;
+  updatedAt?: Date | undefined;
+  url?: string | undefined;
+};
+
+/** @internal */
+export const SocialPostStatus$inboundSchema: z.ZodType<
+  SocialPostStatus,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(SocialPostStatus);
+/** @internal */
+export const SocialPostStatus$outboundSchema: z.ZodType<
+  string,
+  z.ZodTypeDef,
+  SocialPostStatus
+> = openEnums.outboundSchema(SocialPostStatus);
+
+/** @internal */
+export const SocialPostType$inboundSchema: z.ZodType<
+  SocialPostType,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(SocialPostType);
+/** @internal */
+export const SocialPostType$outboundSchema: z.ZodType<
+  string,
+  z.ZodTypeDef,
+  SocialPostType
+> = openEnums.outboundSchema(SocialPostType);
+
+/** @internal */
+export const SocialPost$inboundSchema: z.ZodType<
+  SocialPost,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  body: z.string().optional(),
+  call_to_action: PropertySocialPostCallToAction$inboundSchema.optional(),
+  created_at: z.string().datetime({ offset: true }).transform(v => new Date(v))
+    .optional(),
+  id: z.string().optional(),
+  language: z.string().optional(),
+  media: z.array(SocialMedia$inboundSchema).optional(),
+  metrics: PropertySocialPostMetrics$inboundSchema.optional(),
+  parent_post_id: z.string().optional(),
+  profile_id: z.string().optional(),
+  raw: z.record(z.any()).optional(),
+  scheduled_at: z.string().datetime({ offset: true }).transform(v =>
+    new Date(v)
+  ).optional(),
+  status: SocialPostStatus$inboundSchema.optional(),
+  title: z.string().optional(),
+  type: SocialPostType$inboundSchema.optional(),
+  updated_at: z.string().datetime({ offset: true }).transform(v => new Date(v))
+    .optional(),
+  url: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "call_to_action": "callToAction",
+    "created_at": "createdAt",
+    "parent_post_id": "parentPostId",
+    "profile_id": "profileId",
+    "scheduled_at": "scheduledAt",
+    "updated_at": "updatedAt",
+  });
+});
+/** @internal */
+export type SocialPost$Outbound = {
+  body?: string | undefined;
+  call_to_action?: PropertySocialPostCallToAction$Outbound | undefined;
+  created_at?: string | undefined;
+  id?: string | undefined;
+  language?: string | undefined;
+  media?: Array<SocialMedia$Outbound> | undefined;
+  metrics?: PropertySocialPostMetrics$Outbound | undefined;
+  parent_post_id?: string | undefined;
+  profile_id?: string | undefined;
+  raw?: { [k: string]: any } | undefined;
+  scheduled_at?: string | undefined;
+  status?: string | undefined;
+  title?: string | undefined;
+  type?: string | undefined;
+  updated_at?: string | undefined;
+  url?: string | undefined;
+};
+
+/** @internal */
+export const SocialPost$outboundSchema: z.ZodType<
+  SocialPost$Outbound,
+  z.ZodTypeDef,
+  SocialPost
+> = z.object({
+  body: z.string().optional(),
+  callToAction: PropertySocialPostCallToAction$outboundSchema.optional(),
+  createdAt: z.date().transform(v => v.toISOString()).optional(),
+  id: z.string().optional(),
+  language: z.string().optional(),
+  media: z.array(SocialMedia$outboundSchema).optional(),
+  metrics: PropertySocialPostMetrics$outboundSchema.optional(),
+  parentPostId: z.string().optional(),
+  profileId: z.string().optional(),
+  raw: z.record(z.any()).optional(),
+  scheduledAt: z.date().transform(v => v.toISOString()).optional(),
+  status: SocialPostStatus$outboundSchema.optional(),
+  title: z.string().optional(),
+  type: SocialPostType$outboundSchema.optional(),
+  updatedAt: z.date().transform(v => v.toISOString()).optional(),
+  url: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    callToAction: "call_to_action",
+    createdAt: "created_at",
+    parentPostId: "parent_post_id",
+    profileId: "profile_id",
+    scheduledAt: "scheduled_at",
+    updatedAt: "updated_at",
+  });
+});
+
+export function socialPostToJSON(socialPost: SocialPost): string {
+  return JSON.stringify(SocialPost$outboundSchema.parse(socialPost));
+}
+export function socialPostFromJSON(
+  jsonString: string,
+): SafeParseResult<SocialPost, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SocialPost$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SocialPost' from JSON`,
+  );
+}