@unified-api/typescript-sdk 2.64.0 → 2.68.0

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

@@ -0,0 +1,106 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+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";
+import * as shared from "../shared/index.js";
+
+export type PatchCommerceReviewRequest = {
+  commerceReview: shared.CommerceReview;
+  /**
+   * ID of the connection
+   */
+  connectionId: string;
+  /**
+   * Comma-delimited fields to return
+   */
+  fields?: Array<string> | undefined;
+  /**
+   * ID of the Review
+   */
+  id: string;
+  /**
+   * 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;
+};
+
+/** @internal */
+export const PatchCommerceReviewRequest$inboundSchema: z.ZodType<
+  PatchCommerceReviewRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  CommerceReview: shared.CommerceReview$inboundSchema,
+  connection_id: z.string(),
+  fields: z.array(z.string()).optional(),
+  id: z.string(),
+  raw: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "CommerceReview": "commerceReview",
+    "connection_id": "connectionId",
+  });
+});
+
+/** @internal */
+export type PatchCommerceReviewRequest$Outbound = {
+  CommerceReview: shared.CommerceReview$Outbound;
+  connection_id: string;
+  fields?: Array<string> | undefined;
+  id: string;
+  raw?: string | undefined;
+};
+
+/** @internal */
+export const PatchCommerceReviewRequest$outboundSchema: z.ZodType<
+  PatchCommerceReviewRequest$Outbound,
+  z.ZodTypeDef,
+  PatchCommerceReviewRequest
+> = z.object({
+  commerceReview: shared.CommerceReview$outboundSchema,
+  connectionId: z.string(),
+  fields: z.array(z.string()).optional(),
+  id: z.string(),
+  raw: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    commerceReview: "CommerceReview",
+    connectionId: "connection_id",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace PatchCommerceReviewRequest$ {
+  /** @deprecated use `PatchCommerceReviewRequest$inboundSchema` instead. */
+  export const inboundSchema = PatchCommerceReviewRequest$inboundSchema;
+  /** @deprecated use `PatchCommerceReviewRequest$outboundSchema` instead. */
+  export const outboundSchema = PatchCommerceReviewRequest$outboundSchema;
+  /** @deprecated use `PatchCommerceReviewRequest$Outbound` instead. */
+  export type Outbound = PatchCommerceReviewRequest$Outbound;
+}
+
+export function patchCommerceReviewRequestToJSON(
+  patchCommerceReviewRequest: PatchCommerceReviewRequest,
+): string {
+  return JSON.stringify(
+    PatchCommerceReviewRequest$outboundSchema.parse(patchCommerceReviewRequest),
+  );
+}
+
+export function patchCommerceReviewRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<PatchCommerceReviewRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PatchCommerceReviewRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PatchCommerceReviewRequest' from JSON`,
+  );
+}

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

@@ -0,0 +1,155 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+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 RemoveCommerceReviewRequest = {
+  /**
+   * ID of the connection
+   */
+  connectionId: string;
+  /**
+   * ID of the Review
+   */
+  id: string;
+};
+
+export type RemoveCommerceReviewResponse = {
+  headers: { [k: string]: Array<string> };
+};
+
+/** @internal */
+export const RemoveCommerceReviewRequest$inboundSchema: z.ZodType<
+  RemoveCommerceReviewRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  connection_id: z.string(),
+  id: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "connection_id": "connectionId",
+  });
+});
+
+/** @internal */
+export type RemoveCommerceReviewRequest$Outbound = {
+  connection_id: string;
+  id: string;
+};
+
+/** @internal */
+export const RemoveCommerceReviewRequest$outboundSchema: z.ZodType<
+  RemoveCommerceReviewRequest$Outbound,
+  z.ZodTypeDef,
+  RemoveCommerceReviewRequest
+> = z.object({
+  connectionId: z.string(),
+  id: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    connectionId: "connection_id",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace RemoveCommerceReviewRequest$ {
+  /** @deprecated use `RemoveCommerceReviewRequest$inboundSchema` instead. */
+  export const inboundSchema = RemoveCommerceReviewRequest$inboundSchema;
+  /** @deprecated use `RemoveCommerceReviewRequest$outboundSchema` instead. */
+  export const outboundSchema = RemoveCommerceReviewRequest$outboundSchema;
+  /** @deprecated use `RemoveCommerceReviewRequest$Outbound` instead. */
+  export type Outbound = RemoveCommerceReviewRequest$Outbound;
+}
+
+export function removeCommerceReviewRequestToJSON(
+  removeCommerceReviewRequest: RemoveCommerceReviewRequest,
+): string {
+  return JSON.stringify(
+    RemoveCommerceReviewRequest$outboundSchema.parse(
+      removeCommerceReviewRequest,
+    ),
+  );
+}
+
+export function removeCommerceReviewRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<RemoveCommerceReviewRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => RemoveCommerceReviewRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'RemoveCommerceReviewRequest' from JSON`,
+  );
+}
+
+/** @internal */
+export const RemoveCommerceReviewResponse$inboundSchema: z.ZodType<
+  RemoveCommerceReviewResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  Headers: z.record(z.array(z.string())),
+}).transform((v) => {
+  return remap$(v, {
+    "Headers": "headers",
+  });
+});
+
+/** @internal */
+export type RemoveCommerceReviewResponse$Outbound = {
+  Headers: { [k: string]: Array<string> };
+};
+
+/** @internal */
+export const RemoveCommerceReviewResponse$outboundSchema: z.ZodType<
+  RemoveCommerceReviewResponse$Outbound,
+  z.ZodTypeDef,
+  RemoveCommerceReviewResponse
+> = z.object({
+  headers: z.record(z.array(z.string())),
+}).transform((v) => {
+  return remap$(v, {
+    headers: "Headers",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace RemoveCommerceReviewResponse$ {
+  /** @deprecated use `RemoveCommerceReviewResponse$inboundSchema` instead. */
+  export const inboundSchema = RemoveCommerceReviewResponse$inboundSchema;
+  /** @deprecated use `RemoveCommerceReviewResponse$outboundSchema` instead. */
+  export const outboundSchema = RemoveCommerceReviewResponse$outboundSchema;
+  /** @deprecated use `RemoveCommerceReviewResponse$Outbound` instead. */
+  export type Outbound = RemoveCommerceReviewResponse$Outbound;
+}
+
+export function removeCommerceReviewResponseToJSON(
+  removeCommerceReviewResponse: RemoveCommerceReviewResponse,
+): string {
+  return JSON.stringify(
+    RemoveCommerceReviewResponse$outboundSchema.parse(
+      removeCommerceReviewResponse,
+    ),
+  );
+}
+
+export function removeCommerceReviewResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<RemoveCommerceReviewResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => RemoveCommerceReviewResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'RemoveCommerceReviewResponse' from JSON`,
+  );
+}

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

@@ -0,0 +1,108 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+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";
+import * as shared from "../shared/index.js";
+
+export type UpdateCommerceReviewRequest = {
+  commerceReview: shared.CommerceReview;
+  /**
+   * ID of the connection
+   */
+  connectionId: string;
+  /**
+   * Comma-delimited fields to return
+   */
+  fields?: Array<string> | undefined;
+  /**
+   * ID of the Review
+   */
+  id: string;
+  /**
+   * 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;
+};
+
+/** @internal */
+export const UpdateCommerceReviewRequest$inboundSchema: z.ZodType<
+  UpdateCommerceReviewRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  CommerceReview: shared.CommerceReview$inboundSchema,
+  connection_id: z.string(),
+  fields: z.array(z.string()).optional(),
+  id: z.string(),
+  raw: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "CommerceReview": "commerceReview",
+    "connection_id": "connectionId",
+  });
+});
+
+/** @internal */
+export type UpdateCommerceReviewRequest$Outbound = {
+  CommerceReview: shared.CommerceReview$Outbound;
+  connection_id: string;
+  fields?: Array<string> | undefined;
+  id: string;
+  raw?: string | undefined;
+};
+
+/** @internal */
+export const UpdateCommerceReviewRequest$outboundSchema: z.ZodType<
+  UpdateCommerceReviewRequest$Outbound,
+  z.ZodTypeDef,
+  UpdateCommerceReviewRequest
+> = z.object({
+  commerceReview: shared.CommerceReview$outboundSchema,
+  connectionId: z.string(),
+  fields: z.array(z.string()).optional(),
+  id: z.string(),
+  raw: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    commerceReview: "CommerceReview",
+    connectionId: "connection_id",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace UpdateCommerceReviewRequest$ {
+  /** @deprecated use `UpdateCommerceReviewRequest$inboundSchema` instead. */
+  export const inboundSchema = UpdateCommerceReviewRequest$inboundSchema;
+  /** @deprecated use `UpdateCommerceReviewRequest$outboundSchema` instead. */
+  export const outboundSchema = UpdateCommerceReviewRequest$outboundSchema;
+  /** @deprecated use `UpdateCommerceReviewRequest$Outbound` instead. */
+  export type Outbound = UpdateCommerceReviewRequest$Outbound;
+}
+
+export function updateCommerceReviewRequestToJSON(
+  updateCommerceReviewRequest: UpdateCommerceReviewRequest,
+): string {
+  return JSON.stringify(
+    UpdateCommerceReviewRequest$outboundSchema.parse(
+      updateCommerceReviewRequest,
+    ),
+  );
+}
+
+export function updateCommerceReviewRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<UpdateCommerceReviewRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => UpdateCommerceReviewRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'UpdateCommerceReviewRequest' from JSON`,
+  );
+}

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

@@ -0,0 +1,238 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { remap as remap$ } from "../../../lib/primitives.js";
+import { safeParse } from "../../../lib/schemas.js";
+import { ClosedEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  CommerceItemMedia,
+  CommerceItemMedia$inboundSchema,
+  CommerceItemMedia$Outbound,
+  CommerceItemMedia$outboundSchema,
+} from "./commerceitemmedia.js";
+import {
+  CommerceMetadata,
+  CommerceMetadata$inboundSchema,
+  CommerceMetadata$Outbound,
+  CommerceMetadata$outboundSchema,
+} from "./commercemetadata.js";
+import {
+  CommerceReviewComment,
+  CommerceReviewComment$inboundSchema,
+  CommerceReviewComment$Outbound,
+  CommerceReviewComment$outboundSchema,
+} from "./commercereviewcomment.js";
+
+export const CommerceReviewStatus = {
+  Pending: "PENDING",
+  Approved: "APPROVED",
+  Rejected: "REJECTED",
+  Spam: "SPAM",
+} as const;
+export type CommerceReviewStatus = ClosedEnum<typeof CommerceReviewStatus>;
+
+export type CommerceReview = {
+  authorAvatarUrl?: string | undefined;
+  authorEmail?: string | undefined;
+  authorLocation?: string | undefined;
+  authorName?: string | undefined;
+  comments?: Array<CommerceReviewComment> | undefined;
+  content?: string | undefined;
+  createdAt?: Date | undefined;
+  helpfulVotes?: number | undefined;
+  id?: string | undefined;
+  isFeatured?: boolean | undefined;
+  isPublic?: boolean | undefined;
+  isVerified?: boolean | undefined;
+  itemId: string;
+  itemVariantId?: string | undefined;
+  /**
+   * Photosvideos attached to the review
+   */
+  media?: Array<CommerceItemMedia> | undefined;
+  metadata?: Array<CommerceMetadata> | undefined;
+  rating?: number | undefined;
+  raw?: { [k: string]: any } | undefined;
+  status?: CommerceReviewStatus | undefined;
+  title?: string | undefined;
+  unhelpfulVotes?: number | undefined;
+  updatedAt?: Date | undefined;
+  verifiedPurchase?: boolean | undefined;
+};
+
+/** @internal */
+export const CommerceReviewStatus$inboundSchema: z.ZodNativeEnum<
+  typeof CommerceReviewStatus
+> = z.nativeEnum(CommerceReviewStatus);
+
+/** @internal */
+export const CommerceReviewStatus$outboundSchema: z.ZodNativeEnum<
+  typeof CommerceReviewStatus
+> = CommerceReviewStatus$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace CommerceReviewStatus$ {
+  /** @deprecated use `CommerceReviewStatus$inboundSchema` instead. */
+  export const inboundSchema = CommerceReviewStatus$inboundSchema;
+  /** @deprecated use `CommerceReviewStatus$outboundSchema` instead. */
+  export const outboundSchema = CommerceReviewStatus$outboundSchema;
+}
+
+/** @internal */
+export const CommerceReview$inboundSchema: z.ZodType<
+  CommerceReview,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  author_avatar_url: z.string().optional(),
+  author_email: z.string().optional(),
+  author_location: z.string().optional(),
+  author_name: z.string().optional(),
+  comments: z.array(CommerceReviewComment$inboundSchema).optional(),
+  content: z.string().optional(),
+  created_at: z.string().datetime({ offset: true }).transform(v => new Date(v))
+    .optional(),
+  helpful_votes: z.number().optional(),
+  id: z.string().optional(),
+  is_featured: z.boolean().optional(),
+  is_public: z.boolean().optional(),
+  is_verified: z.boolean().optional(),
+  item_id: z.string(),
+  item_variant_id: z.string().optional(),
+  media: z.array(CommerceItemMedia$inboundSchema).optional(),
+  metadata: z.array(CommerceMetadata$inboundSchema).optional(),
+  rating: z.number().optional(),
+  raw: z.record(z.any()).optional(),
+  status: CommerceReviewStatus$inboundSchema.optional(),
+  title: z.string().optional(),
+  unhelpful_votes: z.number().optional(),
+  updated_at: z.string().datetime({ offset: true }).transform(v => new Date(v))
+    .optional(),
+  verified_purchase: z.boolean().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "author_avatar_url": "authorAvatarUrl",
+    "author_email": "authorEmail",
+    "author_location": "authorLocation",
+    "author_name": "authorName",
+    "created_at": "createdAt",
+    "helpful_votes": "helpfulVotes",
+    "is_featured": "isFeatured",
+    "is_public": "isPublic",
+    "is_verified": "isVerified",
+    "item_id": "itemId",
+    "item_variant_id": "itemVariantId",
+    "unhelpful_votes": "unhelpfulVotes",
+    "updated_at": "updatedAt",
+    "verified_purchase": "verifiedPurchase",
+  });
+});
+
+/** @internal */
+export type CommerceReview$Outbound = {
+  author_avatar_url?: string | undefined;
+  author_email?: string | undefined;
+  author_location?: string | undefined;
+  author_name?: string | undefined;
+  comments?: Array<CommerceReviewComment$Outbound> | undefined;
+  content?: string | undefined;
+  created_at?: string | undefined;
+  helpful_votes?: number | undefined;
+  id?: string | undefined;
+  is_featured?: boolean | undefined;
+  is_public?: boolean | undefined;
+  is_verified?: boolean | undefined;
+  item_id: string;
+  item_variant_id?: string | undefined;
+  media?: Array<CommerceItemMedia$Outbound> | undefined;
+  metadata?: Array<CommerceMetadata$Outbound> | undefined;
+  rating?: number | undefined;
+  raw?: { [k: string]: any } | undefined;
+  status?: string | undefined;
+  title?: string | undefined;
+  unhelpful_votes?: number | undefined;
+  updated_at?: string | undefined;
+  verified_purchase?: boolean | undefined;
+};
+
+/** @internal */
+export const CommerceReview$outboundSchema: z.ZodType<
+  CommerceReview$Outbound,
+  z.ZodTypeDef,
+  CommerceReview
+> = z.object({
+  authorAvatarUrl: z.string().optional(),
+  authorEmail: z.string().optional(),
+  authorLocation: z.string().optional(),
+  authorName: z.string().optional(),
+  comments: z.array(CommerceReviewComment$outboundSchema).optional(),
+  content: z.string().optional(),
+  createdAt: z.date().transform(v => v.toISOString()).optional(),
+  helpfulVotes: z.number().optional(),
+  id: z.string().optional(),
+  isFeatured: z.boolean().optional(),
+  isPublic: z.boolean().optional(),
+  isVerified: z.boolean().optional(),
+  itemId: z.string(),
+  itemVariantId: z.string().optional(),
+  media: z.array(CommerceItemMedia$outboundSchema).optional(),
+  metadata: z.array(CommerceMetadata$outboundSchema).optional(),
+  rating: z.number().optional(),
+  raw: z.record(z.any()).optional(),
+  status: CommerceReviewStatus$outboundSchema.optional(),
+  title: z.string().optional(),
+  unhelpfulVotes: z.number().optional(),
+  updatedAt: z.date().transform(v => v.toISOString()).optional(),
+  verifiedPurchase: z.boolean().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    authorAvatarUrl: "author_avatar_url",
+    authorEmail: "author_email",
+    authorLocation: "author_location",
+    authorName: "author_name",
+    createdAt: "created_at",
+    helpfulVotes: "helpful_votes",
+    isFeatured: "is_featured",
+    isPublic: "is_public",
+    isVerified: "is_verified",
+    itemId: "item_id",
+    itemVariantId: "item_variant_id",
+    unhelpfulVotes: "unhelpful_votes",
+    updatedAt: "updated_at",
+    verifiedPurchase: "verified_purchase",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace CommerceReview$ {
+  /** @deprecated use `CommerceReview$inboundSchema` instead. */
+  export const inboundSchema = CommerceReview$inboundSchema;
+  /** @deprecated use `CommerceReview$outboundSchema` instead. */
+  export const outboundSchema = CommerceReview$outboundSchema;
+  /** @deprecated use `CommerceReview$Outbound` instead. */
+  export type Outbound = CommerceReview$Outbound;
+}
+
+export function commerceReviewToJSON(commerceReview: CommerceReview): string {
+  return JSON.stringify(CommerceReview$outboundSchema.parse(commerceReview));
+}
+
+export function commerceReviewFromJSON(
+  jsonString: string,
+): SafeParseResult<CommerceReview, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CommerceReview$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CommerceReview' from JSON`,
+  );
+}