@unified-api/typescript-sdk 2.86.8 → 2.86.9

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

@@ -0,0 +1,83 @@
+/*
+ * 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 GetCommerceReturnQueryParamFields = {
+  Id: "id",
+  CreatedAt: "created_at",
+  UpdatedAt: "updated_at",
+  OrderId: "order_id",
+  Status: "status",
+  Type: "type",
+  Currency: "currency",
+  TotalRefundAmount: "total_refund_amount",
+  CustomerEmail: "customer_email",
+  CustomerName: "customer_name",
+  ReturnByAt: "return_by_at",
+  Lineitems: "lineitems",
+  Metadata: "metadata",
+  Raw: "raw",
+} as const;
+export type GetCommerceReturnQueryParamFields = ClosedEnum<
+  typeof GetCommerceReturnQueryParamFields
+>;
+
+export type GetCommerceReturnRequest = {
+  /**
+   * ID of the connection
+   */
+  connectionId: string;
+  /**
+   * Fields to return
+   */
+  fields?: Array<GetCommerceReturnQueryParamFields> | undefined;
+  /**
+   * ID of the Return
+   */
+  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 GetCommerceReturnQueryParamFields$outboundSchema: z.ZodNativeEnum<
+  typeof GetCommerceReturnQueryParamFields
+> = z.nativeEnum(GetCommerceReturnQueryParamFields);
+
+/** @internal */
+export type GetCommerceReturnRequest$Outbound = {
+  connection_id: string;
+  fields?: Array<string> | undefined;
+  id: string;
+  raw?: string | undefined;
+};
+
+/** @internal */
+export const GetCommerceReturnRequest$outboundSchema: z.ZodType<
+  GetCommerceReturnRequest$Outbound,
+  z.ZodTypeDef,
+  GetCommerceReturnRequest
+> = z.object({
+  connectionId: z.string(),
+  fields: z.array(GetCommerceReturnQueryParamFields$outboundSchema).optional(),
+  id: z.string(),
+  raw: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    connectionId: "connection_id",
+  });
+});
+
+export function getCommerceReturnRequestToJSON(
+  getCommerceReturnRequest: GetCommerceReturnRequest,
+): string {
+  return JSON.stringify(
+    GetCommerceReturnRequest$outboundSchema.parse(getCommerceReturnRequest),
+  );
+}

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

@@ -242,6 +242,7 @@ export * from "./getcommerceitem.js";
 export * from "./getcommerceitemvariant.js";
 export * from "./getcommercelocation.js";
 export * from "./getcommercereservation.js";
+export * from "./getcommercereturn.js";
 export * from "./getcommercereview.js";
 export * from "./getcommercesaleschannel.js";
 export * from "./getcomputedeployment.js";
@@ -465,6 +466,7 @@ export * from "./listcommerceitems.js";
 export * from "./listcommerceitemvariants.js";
 export * from "./listcommercelocations.js";
 export * from "./listcommercereservations.js";
+export * from "./listcommercereturns.js";
 export * from "./listcommercereviews.js";
 export * from "./listcommercesaleschannels.js";
 export * from "./listcomputedeployments.js";

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

@@ -0,0 +1,111 @@
+/*
+ * 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 ListCommerceReturnsQueryParamFields = {
+  Id: "id",
+  CreatedAt: "created_at",
+  UpdatedAt: "updated_at",
+  OrderId: "order_id",
+  Status: "status",
+  Type: "type",
+  Currency: "currency",
+  TotalRefundAmount: "total_refund_amount",
+  CustomerEmail: "customer_email",
+  CustomerName: "customer_name",
+  ReturnByAt: "return_by_at",
+  Lineitems: "lineitems",
+  Metadata: "metadata",
+  Raw: "raw",
+} as const;
+export type ListCommerceReturnsQueryParamFields = ClosedEnum<
+  typeof ListCommerceReturnsQueryParamFields
+>;
+
+export type ListCommerceReturnsRequest = {
+  /**
+   * ID of the connection
+   */
+  connectionId: string;
+  /**
+   * Fields to return
+   */
+  fields?: Array<ListCommerceReturnsQueryParamFields> | undefined;
+  limit?: number | undefined;
+  offset?: number | undefined;
+  order?: string | undefined;
+  /**
+   * The AccountingOrder ID to filter by
+   */
+  orderId?: 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;
+  /**
+   * 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 ListCommerceReturnsQueryParamFields$outboundSchema:
+  z.ZodNativeEnum<typeof ListCommerceReturnsQueryParamFields> = z.nativeEnum(
+    ListCommerceReturnsQueryParamFields,
+  );
+
+/** @internal */
+export type ListCommerceReturnsRequest$Outbound = {
+  connection_id: string;
+  fields?: Array<string> | undefined;
+  limit?: number | undefined;
+  offset?: number | undefined;
+  order?: string | undefined;
+  order_id?: string | undefined;
+  query?: string | undefined;
+  raw?: string | undefined;
+  sort?: string | undefined;
+  updated_gte?: string | undefined;
+};
+
+/** @internal */
+export const ListCommerceReturnsRequest$outboundSchema: z.ZodType<
+  ListCommerceReturnsRequest$Outbound,
+  z.ZodTypeDef,
+  ListCommerceReturnsRequest
+> = z.object({
+  connectionId: z.string(),
+  fields: z.array(ListCommerceReturnsQueryParamFields$outboundSchema)
+    .optional(),
+  limit: z.number().optional(),
+  offset: z.number().optional(),
+  order: z.string().optional(),
+  orderId: z.string().optional(),
+  query: z.string().optional(),
+  raw: z.string().optional(),
+  sort: z.string().optional(),
+  updatedGte: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    connectionId: "connection_id",
+    orderId: "order_id",
+    updatedGte: "updated_gte",
+  });
+});
+
+export function listCommerceReturnsRequestToJSON(
+  listCommerceReturnsRequest: ListCommerceReturnsRequest,
+): string {
+  return JSON.stringify(
+    ListCommerceReturnsRequest$outboundSchema.parse(listCommerceReturnsRequest),
+  );
+}

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

@@ -45,6 +45,9 @@ export type CommerceCollection = {
   itemMetadata?: Array<CommerceMetadata> | undefined;
   media?: Array<CommerceItemMedia> | undefined;
   metadata?: Array<CommerceMetadata> | undefined;
+  /**
+   * The collection's name
+   */
   name: string;
   parentId?: string | undefined;
   publicDescription?: string | undefined;

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

@@ -73,6 +73,9 @@ export type CommerceItem = {
   locationId?: string | undefined;
   media?: Array<CommerceItemMedia> | undefined;
   metadata?: Array<CommerceMetadata> | undefined;
+  /**
+   * The item's (product's) name
+   */
   name?: string | undefined;
   prices?: Array<CommerceItemPrice> | undefined;
   publicDescription?: string | undefined;

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

@@ -0,0 +1,109 @@
+/*
+ * 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 {
+  CommerceMetadata,
+  CommerceMetadata$inboundSchema,
+} from "./commercemetadata.js";
+import {
+  CommerceReturnLineitem,
+  CommerceReturnLineitem$inboundSchema,
+} from "./commercereturnlineitem.js";
+
+export const CommerceReturnStatus = {
+  Requested: "REQUESTED",
+  Open: "OPEN",
+  Approved: "APPROVED",
+  Rejected: "REJECTED",
+  Closed: "CLOSED",
+  Cancelled: "CANCELLED",
+  Other: "OTHER",
+} as const;
+export type CommerceReturnStatus = OpenEnum<typeof CommerceReturnStatus>;
+
+export type CommerceReturn = {
+  /**
+   * (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
+   */
+  createdAt?: Date | undefined;
+  currency?: string | undefined;
+  customerEmail?: string | undefined;
+  customerName?: string | undefined;
+  id?: string | undefined;
+  lineitems?: Array<CommerceReturnLineitem> | undefined;
+  metadata?: Array<CommerceMetadata> | undefined;
+  orderId?: string | undefined;
+  raw?: { [k: string]: any } | undefined;
+  /**
+   * (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
+   */
+  returnByAt?: Date | undefined;
+  status?: CommerceReturnStatus | undefined;
+  totalRefundAmount?: number | undefined;
+  type?: string | undefined;
+  /**
+   * (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
+   */
+  updatedAt?: Date | undefined;
+};
+
+/** @internal */
+export const CommerceReturnStatus$inboundSchema: z.ZodType<
+  CommerceReturnStatus,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(CommerceReturnStatus);
+
+/** @internal */
+export const CommerceReturn$inboundSchema: z.ZodType<
+  CommerceReturn,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  created_at: z.string().datetime({ offset: true }).transform(v => new Date(v))
+    .optional(),
+  currency: z.string().optional(),
+  customer_email: z.string().optional(),
+  customer_name: z.string().optional(),
+  id: z.string().optional(),
+  lineitems: z.array(CommerceReturnLineitem$inboundSchema).optional(),
+  metadata: z.array(CommerceMetadata$inboundSchema).optional(),
+  order_id: z.string().optional(),
+  raw: z.record(z.any()).optional(),
+  return_by_at: z.string().datetime({ offset: true }).transform(v =>
+    new Date(v)
+  ).optional(),
+  status: CommerceReturnStatus$inboundSchema.optional(),
+  total_refund_amount: z.number().optional(),
+  type: z.string().optional(),
+  updated_at: z.string().datetime({ offset: true }).transform(v => new Date(v))
+    .optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "created_at": "createdAt",
+    "customer_email": "customerEmail",
+    "customer_name": "customerName",
+    "order_id": "orderId",
+    "return_by_at": "returnByAt",
+    "total_refund_amount": "totalRefundAmount",
+    "updated_at": "updatedAt",
+  });
+});
+
+export function commerceReturnFromJSON(
+  jsonString: string,
+): SafeParseResult<CommerceReturn, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CommerceReturn$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CommerceReturn' from JSON`,
+  );
+}

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

@@ -0,0 +1,59 @@
+/*
+ * 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 CommerceReturnLineitem = {
+  id?: string | undefined;
+  /**
+   * (reference to CommerceItem)
+   */
+  itemId?: string | undefined;
+  name?: string | undefined;
+  orderLineId?: string | undefined;
+  quantity?: number | undefined;
+  raw?: { [k: string]: any } | undefined;
+  reason?: string | undefined;
+  refundAmount?: number | undefined;
+  sku?: string | undefined;
+  status?: string | undefined;
+};
+
+/** @internal */
+export const CommerceReturnLineitem$inboundSchema: z.ZodType<
+  CommerceReturnLineitem,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: z.string().optional(),
+  item_id: z.string().optional(),
+  name: z.string().optional(),
+  order_line_id: z.string().optional(),
+  quantity: z.number().optional(),
+  raw: z.record(z.any()).optional(),
+  reason: z.string().optional(),
+  refund_amount: z.number().optional(),
+  sku: z.string().optional(),
+  status: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "item_id": "itemId",
+    "order_line_id": "orderLineId",
+    "refund_amount": "refundAmount",
+  });
+});
+
+export function commerceReturnLineitemFromJSON(
+  jsonString: string,
+): SafeParseResult<CommerceReturnLineitem, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CommerceReturnLineitem$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CommerceReturnLineitem' from JSON`,
+  );
+}

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

@@ -162,6 +162,8 @@ export * from "./commercelocation.js";
 export * from "./commercemetadata.js";
 export * from "./commercereference.js";
 export * from "./commercereservation.js";
+export * from "./commercereturn.js";
+export * from "./commercereturnlineitem.js";
 export * from "./commercereview.js";
 export * from "./commercereviewcomment.js";
 export * from "./commercesaleschannel.js";

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

@@ -86,6 +86,8 @@ export const PropertyConnectionPermissions = {
   CommerceItemvariantWrite: "commerce_itemvariant_write",
   CommerceReservationRead: "commerce_reservation_read",
   CommerceReservationWrite: "commerce_reservation_write",
+  CommerceReturnRead: "commerce_return_read",
+  CommerceReturnWrite: "commerce_return_write",
   CommerceAvailabilityRead: "commerce_availability_read",
   CommerceAvailabilityWrite: "commerce_availability_write",
   VerificationPackageRead: "verification_package_read",

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

@@ -80,6 +80,7 @@ export const WebhookObjectType = {
   CommerceSaleschannel: "commerce_saleschannel",
   CommerceItemvariant: "commerce_itemvariant",
   CommerceReservation: "commerce_reservation",
+  CommerceReturn: "commerce_return",
   CommerceAvailability: "commerce_availability",
   VerificationPackage: "verification_package",
   VerificationRequest: "verification_request",

package/src/sdk/return.ts

@@ -0,0 +1,46 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { commerceGetCommerceReturn } from "../funcs/commerceGetCommerceReturn.js";
+import { commerceListCommerceReturns } from "../funcs/commerceListCommerceReturns.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 Return extends ClientSDK {
+  /**
+   * Retrieve a return
+   *
+   * @remarks
+   * Retrieves a single CommerceReturn by its `id`. Obtain `id` values from the corresponding list endpoint. Use `fields` to return only the fields you need.
+   */
+  async getCommerceReturn(
+    request: operations.GetCommerceReturnRequest,
+    options?: RequestOptions,
+  ): Promise<shared.CommerceReturn> {
+    return unwrapAsync(commerceGetCommerceReturn(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * List all returns
+   *
+   * @remarks
+   * Returns a list of CommerceReturns. Narrow the results with the query parameters before paging, then page through them with `limit` and `offset` (the default and maximum page size depend on the integration). Use `fields` to return only the fields you need and reduce the response size. When the integration supports a total count, it is returned in the `X-Total-Count` response header. Use each item's `id` to retrieve, update, or delete it where those operations are supported.
+   */
+  async listCommerceReturns(
+    request: operations.ListCommerceReturnsRequest,
+    options?: RequestOptions,
+  ): Promise<Array<shared.CommerceReturn>> {
+    return unwrapAsync(commerceListCommerceReturns(
+      this,
+      request,
+      options,
+    ));
+  }
+}

package/src/sdk/sdk.ts

@@ -170,6 +170,7 @@ import { Report } from "./report.js";
 import { Repository } from "./repository.js";
 import { RequestT } from "./request.js";
 import { Reservation } from "./reservation.js";
+import { Return } from "./return.js";
 import { Review } from "./review.js";
 import { Room } from "./room.js";
 import { Saleschannel } from "./saleschannel.js";
@@ -621,6 +622,11 @@ export class UnifiedTo extends ClientSDK {
     return (this._reservation ??= new Reservation(this._options));
   }
 
+  private _return?: Return;
+  get return(): Return {
+    return (this._return ??= new Return(this._options));
+  }
+
   private _review?: Review;
   get review(): Review {
     return (this._review ??= new Review(this._options));