@unified-api/typescript-sdk 2.64.0 → 2.66.0

package/src/lib/config.ts

@@ -69,8 +69,8 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
 export const SDK_METADATA = {
   language: "typescript",
   openapiDocVersion: "1.0",
-  sdkVersion: "2.64.0",
+  sdkVersion: "2.66.0",
   genVersion: "2.522.1",
   userAgent:
-    "speakeasy-sdk/typescript 2.64.0 2.522.1 1.0 @unified-api/typescript-sdk",
+    "speakeasy-sdk/typescript 2.66.0 2.522.1 1.0 @unified-api/typescript-sdk",
 } as const;

package/src/sdk/commerce.ts

@@ -6,26 +6,32 @@ import { commerceCreateCommerceCollection } from "../funcs/commerceCreateCommerc
 import { commerceCreateCommerceInventory } from "../funcs/commerceCreateCommerceInventory.js";
 import { commerceCreateCommerceItem } from "../funcs/commerceCreateCommerceItem.js";
 import { commerceCreateCommerceLocation } from "../funcs/commerceCreateCommerceLocation.js";
+import { commerceCreateCommerceReview } from "../funcs/commerceCreateCommerceReview.js";
 import { commerceGetCommerceCollection } from "../funcs/commerceGetCommerceCollection.js";
 import { commerceGetCommerceInventory } from "../funcs/commerceGetCommerceInventory.js";
 import { commerceGetCommerceItem } from "../funcs/commerceGetCommerceItem.js";
 import { commerceGetCommerceLocation } from "../funcs/commerceGetCommerceLocation.js";
+import { commerceGetCommerceReview } from "../funcs/commerceGetCommerceReview.js";
 import { commerceListCommerceCollections } from "../funcs/commerceListCommerceCollections.js";
 import { commerceListCommerceInventories } from "../funcs/commerceListCommerceInventories.js";
 import { commerceListCommerceItems } from "../funcs/commerceListCommerceItems.js";
 import { commerceListCommerceLocations } from "../funcs/commerceListCommerceLocations.js";
+import { commerceListCommerceReviews } from "../funcs/commerceListCommerceReviews.js";
 import { commercePatchCommerceCollection } from "../funcs/commercePatchCommerceCollection.js";
 import { commercePatchCommerceInventory } from "../funcs/commercePatchCommerceInventory.js";
 import { commercePatchCommerceItem } from "../funcs/commercePatchCommerceItem.js";
 import { commercePatchCommerceLocation } from "../funcs/commercePatchCommerceLocation.js";
+import { commercePatchCommerceReview } from "../funcs/commercePatchCommerceReview.js";
 import { commerceRemoveCommerceCollection } from "../funcs/commerceRemoveCommerceCollection.js";
 import { commerceRemoveCommerceInventory } from "../funcs/commerceRemoveCommerceInventory.js";
 import { commerceRemoveCommerceItem } from "../funcs/commerceRemoveCommerceItem.js";
 import { commerceRemoveCommerceLocation } from "../funcs/commerceRemoveCommerceLocation.js";
+import { commerceRemoveCommerceReview } from "../funcs/commerceRemoveCommerceReview.js";
 import { commerceUpdateCommerceCollection } from "../funcs/commerceUpdateCommerceCollection.js";
 import { commerceUpdateCommerceInventory } from "../funcs/commerceUpdateCommerceInventory.js";
 import { commerceUpdateCommerceItem } from "../funcs/commerceUpdateCommerceItem.js";
 import { commerceUpdateCommerceLocation } from "../funcs/commerceUpdateCommerceLocation.js";
+import { commerceUpdateCommerceReview } from "../funcs/commerceUpdateCommerceReview.js";
 import { ClientSDK, RequestOptions } from "../lib/sdks.js";
 import * as operations from "./models/operations/index.js";
 import * as shared from "./models/shared/index.js";
@@ -88,6 +94,20 @@ export class Commerce extends ClientSDK {
     ));
   }
 
+  /**
+   * Create a review
+   */
+  async createCommerceReview(
+    request: operations.CreateCommerceReviewRequest,
+    options?: RequestOptions,
+  ): Promise<shared.CommerceReview> {
+    return unwrapAsync(commerceCreateCommerceReview(
+      this,
+      request,
+      options,
+    ));
+  }
+
   /**
    * Retrieve a collection
    */
@@ -144,6 +164,20 @@ export class Commerce extends ClientSDK {
     ));
   }
 
+  /**
+   * Retrieve a review
+   */
+  async getCommerceReview(
+    request: operations.GetCommerceReviewRequest,
+    options?: RequestOptions,
+  ): Promise<shared.CommerceReview> {
+    return unwrapAsync(commerceGetCommerceReview(
+      this,
+      request,
+      options,
+    ));
+  }
+
   /**
    * List all collections
    */
@@ -200,6 +234,20 @@ export class Commerce extends ClientSDK {
     ));
   }
 
+  /**
+   * List all reviews
+   */
+  async listCommerceReviews(
+    request: operations.ListCommerceReviewsRequest,
+    options?: RequestOptions,
+  ): Promise<Array<shared.CommerceReview>> {
+    return unwrapAsync(commerceListCommerceReviews(
+      this,
+      request,
+      options,
+    ));
+  }
+
   /**
    * Update a collection
    */
@@ -256,6 +304,20 @@ export class Commerce extends ClientSDK {
     ));
   }
 
+  /**
+   * Update a review
+   */
+  async patchCommerceReview(
+    request: operations.PatchCommerceReviewRequest,
+    options?: RequestOptions,
+  ): Promise<shared.CommerceReview> {
+    return unwrapAsync(commercePatchCommerceReview(
+      this,
+      request,
+      options,
+    ));
+  }
+
   /**
    * Remove a collection
    */
@@ -312,6 +374,20 @@ export class Commerce extends ClientSDK {
     ));
   }
 
+  /**
+   * Remove a review
+   */
+  async removeCommerceReview(
+    request: operations.RemoveCommerceReviewRequest,
+    options?: RequestOptions,
+  ): Promise<operations.RemoveCommerceReviewResponse | undefined> {
+    return unwrapAsync(commerceRemoveCommerceReview(
+      this,
+      request,
+      options,
+    ));
+  }
+
   /**
    * Update a collection
    */
@@ -367,4 +443,18 @@ export class Commerce extends ClientSDK {
       options,
     ));
   }
+
+  /**
+   * Update a review
+   */
+  async updateCommerceReview(
+    request: operations.UpdateCommerceReviewRequest,
+    options?: RequestOptions,
+  ): Promise<shared.CommerceReview> {
+    return unwrapAsync(commerceUpdateCommerceReview(
+      this,
+      request,
+      options,
+    ));
+  }
 }

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

@@ -0,0 +1,101 @@
+/*
+ * 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 CreateCommerceReviewRequest = {
+  commerceReview: shared.CommerceReview;
+  /**
+   * ID of the connection
+   */
+  connectionId: string;
+  /**
+   * Comma-delimited fields to return
+   */
+  fields?: Array<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;
+};
+
+/** @internal */
+export const CreateCommerceReviewRequest$inboundSchema: z.ZodType<
+  CreateCommerceReviewRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  CommerceReview: shared.CommerceReview$inboundSchema,
+  connection_id: z.string(),
+  fields: z.array(z.string()).optional(),
+  raw: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "CommerceReview": "commerceReview",
+    "connection_id": "connectionId",
+  });
+});
+
+/** @internal */
+export type CreateCommerceReviewRequest$Outbound = {
+  CommerceReview: shared.CommerceReview$Outbound;
+  connection_id: string;
+  fields?: Array<string> | undefined;
+  raw?: string | undefined;
+};
+
+/** @internal */
+export const CreateCommerceReviewRequest$outboundSchema: z.ZodType<
+  CreateCommerceReviewRequest$Outbound,
+  z.ZodTypeDef,
+  CreateCommerceReviewRequest
+> = z.object({
+  commerceReview: shared.CommerceReview$outboundSchema,
+  connectionId: z.string(),
+  fields: z.array(z.string()).optional(),
+  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 CreateCommerceReviewRequest$ {
+  /** @deprecated use `CreateCommerceReviewRequest$inboundSchema` instead. */
+  export const inboundSchema = CreateCommerceReviewRequest$inboundSchema;
+  /** @deprecated use `CreateCommerceReviewRequest$outboundSchema` instead. */
+  export const outboundSchema = CreateCommerceReviewRequest$outboundSchema;
+  /** @deprecated use `CreateCommerceReviewRequest$Outbound` instead. */
+  export type Outbound = CreateCommerceReviewRequest$Outbound;
+}
+
+export function createCommerceReviewRequestToJSON(
+  createCommerceReviewRequest: CreateCommerceReviewRequest,
+): string {
+  return JSON.stringify(
+    CreateCommerceReviewRequest$outboundSchema.parse(
+      createCommerceReviewRequest,
+    ),
+  );
+}
+
+export function createCommerceReviewRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<CreateCommerceReviewRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CreateCommerceReviewRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CreateCommerceReviewRequest' from JSON`,
+  );
+}

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

@@ -0,0 +1,99 @@
+/*
+ * 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 GetCommerceReviewRequest = {
+  /**
+   * 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 GetCommerceReviewRequest$inboundSchema: z.ZodType<
+  GetCommerceReviewRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  connection_id: z.string(),
+  fields: z.array(z.string()).optional(),
+  id: z.string(),
+  raw: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "connection_id": "connectionId",
+  });
+});
+
+/** @internal */
+export type GetCommerceReviewRequest$Outbound = {
+  connection_id: string;
+  fields?: Array<string> | undefined;
+  id: string;
+  raw?: string | undefined;
+};
+
+/** @internal */
+export const GetCommerceReviewRequest$outboundSchema: z.ZodType<
+  GetCommerceReviewRequest$Outbound,
+  z.ZodTypeDef,
+  GetCommerceReviewRequest
+> = z.object({
+  connectionId: z.string(),
+  fields: z.array(z.string()).optional(),
+  id: z.string(),
+  raw: z.string().optional(),
+}).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 GetCommerceReviewRequest$ {
+  /** @deprecated use `GetCommerceReviewRequest$inboundSchema` instead. */
+  export const inboundSchema = GetCommerceReviewRequest$inboundSchema;
+  /** @deprecated use `GetCommerceReviewRequest$outboundSchema` instead. */
+  export const outboundSchema = GetCommerceReviewRequest$outboundSchema;
+  /** @deprecated use `GetCommerceReviewRequest$Outbound` instead. */
+  export type Outbound = GetCommerceReviewRequest$Outbound;
+}
+
+export function getCommerceReviewRequestToJSON(
+  getCommerceReviewRequest: GetCommerceReviewRequest,
+): string {
+  return JSON.stringify(
+    GetCommerceReviewRequest$outboundSchema.parse(getCommerceReviewRequest),
+  );
+}
+
+export function getCommerceReviewRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<GetCommerceReviewRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetCommerceReviewRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetCommerceReviewRequest' from JSON`,
+  );
+}

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

@@ -23,6 +23,7 @@ export * from "./createcommercecollection.js";
 export * from "./createcommerceinventory.js";
 export * from "./createcommerceitem.js";
 export * from "./createcommercelocation.js";
+export * from "./createcommercereview.js";
 export * from "./createcrmcompany.js";
 export * from "./createcrmcontact.js";
 export * from "./createcrmdeal.js";
@@ -94,6 +95,7 @@ export * from "./getcommercecollection.js";
 export * from "./getcommerceinventory.js";
 export * from "./getcommerceitem.js";
 export * from "./getcommercelocation.js";
+export * from "./getcommercereview.js";
 export * from "./getcrmcompany.js";
 export * from "./getcrmcontact.js";
 export * from "./getcrmdeal.js";
@@ -173,6 +175,7 @@ export * from "./listcommercecollections.js";
 export * from "./listcommerceinventories.js";
 export * from "./listcommerceitems.js";
 export * from "./listcommercelocations.js";
+export * from "./listcommercereviews.js";
 export * from "./listcrmcompanies.js";
 export * from "./listcrmcontacts.js";
 export * from "./listcrmdeals.js";
@@ -252,6 +255,7 @@ export * from "./patchcommercecollection.js";
 export * from "./patchcommerceinventory.js";
 export * from "./patchcommerceitem.js";
 export * from "./patchcommercelocation.js";
+export * from "./patchcommercereview.js";
 export * from "./patchcrmcompany.js";
 export * from "./patchcrmcontact.js";
 export * from "./patchcrmdeal.js";
@@ -320,6 +324,7 @@ export * from "./removecommercecollection.js";
 export * from "./removecommerceinventory.js";
 export * from "./removecommerceitem.js";
 export * from "./removecommercelocation.js";
+export * from "./removecommercereview.js";
 export * from "./removecrmcompany.js";
 export * from "./removecrmcontact.js";
 export * from "./removecrmdeal.js";
@@ -386,6 +391,7 @@ export * from "./updatecommercecollection.js";
 export * from "./updatecommerceinventory.js";
 export * from "./updatecommerceitem.js";
 export * from "./updatecommercelocation.js";
+export * from "./updatecommercereview.js";
 export * from "./updatecrmcompany.js";
 export * from "./updatecrmcontact.js";
 export * from "./updatecrmdeal.js";

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

@@ -20,6 +20,9 @@ export type ListAccountingAccountsRequest = {
   limit?: number | undefined;
   offset?: number | undefined;
   order?: string | undefined;
+  /**
+   * The org ID to filter by
+   */
   orgId?: string | undefined;
   /**
    * Query string to search. eg. email address or name

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

@@ -20,6 +20,10 @@ export type ListAccountingContactsRequest = {
   limit?: number | undefined;
   offset?: number | undefined;
   order?: string | undefined;
+  /**
+   * The org ID to filter by
+   */
+  orgId?: string | undefined;
   /**
    * Query string to search. eg. email address or name
    */
@@ -47,6 +51,7 @@ export const ListAccountingContactsRequest$inboundSchema: z.ZodType<
   limit: z.number().optional(),
   offset: z.number().optional(),
   order: z.string().optional(),
+  org_id: z.string().optional(),
   query: z.string().optional(),
   raw: z.string().optional(),
   sort: z.string().optional(),
@@ -56,6 +61,7 @@ export const ListAccountingContactsRequest$inboundSchema: z.ZodType<
 }).transform((v) => {
   return remap$(v, {
     "connection_id": "connectionId",
+    "org_id": "orgId",
     "updated_gte": "updatedGte",
   });
 });
@@ -67,6 +73,7 @@ export type ListAccountingContactsRequest$Outbound = {
   limit?: number | undefined;
   offset?: number | undefined;
   order?: string | undefined;
+  org_id?: string | undefined;
   query?: string | undefined;
   raw?: string | undefined;
   sort?: string | undefined;
@@ -85,6 +92,7 @@ export const ListAccountingContactsRequest$outboundSchema: z.ZodType<
   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(),
@@ -93,6 +101,7 @@ export const ListAccountingContactsRequest$outboundSchema: z.ZodType<
 }).transform((v) => {
   return remap$(v, {
     connectionId: "connection_id",
+    orgId: "org_id",
     updatedGte: "updated_gte",
   });
 });

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

@@ -13,6 +13,9 @@ export type ListAccountingInvoicesRequest = {
    * ID of the connection
    */
   connectionId: string;
+  /**
+   * The contact ID to filter by
+   */
   contactId?: string | undefined;
   /**
    * Comma-delimited fields to return

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

@@ -13,6 +13,9 @@ export type ListAccountingReportsRequest = {
    * ID of the connection
    */
   connectionId: string;
+  /**
+   * The end date to filter by
+   */
   endLe?: string | undefined;
   /**
    * Comma-delimited fields to return
@@ -30,6 +33,9 @@ export type ListAccountingReportsRequest = {
    */
   raw?: string | undefined;
   sort?: string | undefined;
+  /**
+   * The start date to filter by
+   */
   startGte?: string | undefined;
   type?: string | undefined;
   /**

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

@@ -13,6 +13,9 @@ export type ListAccountingTransactionsRequest = {
    * ID of the connection
    */
   connectionId: string;
+  /**
+   * The contact ID to filter by
+   */
   contactId?: string | undefined;
   /**
    * Comma-delimited fields to return

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

@@ -9,18 +9,33 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type ListAtsActivitiesRequest = {
+  /**
+   * The application ID to filter by
+   */
   applicationId?: string | undefined;
+  /**
+   * The candidate ID to filter by
+   */
   candidateId?: string | undefined;
   /**
    * ID of the connection
    */
   connectionId: string;
+  /**
+   * The document ID to filter by
+   */
   documentId?: string | undefined;
   /**
    * Comma-delimited fields to return
    */
   fields?: Array<string> | undefined;
+  /**
+   * The interview ID to filter by
+   */
   interviewId?: string | undefined;
+  /**
+   * The job ID to filter by
+   */
   jobId?: string | undefined;
   limit?: number | undefined;
   offset?: number | undefined;
@@ -38,6 +53,9 @@ export type ListAtsActivitiesRequest = {
    * Return only results whose updated date is equal or greater to this value
    */
   updatedGte?: Date | undefined;
+  /**
+   * The user/employee ID to filter by
+   */
   userId?: string | undefined;
 };
 

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

@@ -9,6 +9,9 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type ListAtsApplicationsRequest = {
+  /**
+   * The candidate ID to filter by
+   */
   candidateId?: string | undefined;
   /**
    * ID of the connection
@@ -18,6 +21,9 @@ export type ListAtsApplicationsRequest = {
    * Comma-delimited fields to return
    */
   fields?: Array<string> | undefined;
+  /**
+   * The job ID to filter by
+   */
   jobId?: string | undefined;
   limit?: number | undefined;
   offset?: number | undefined;

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

@@ -9,7 +9,13 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type ListAtsDocumentsRequest = {
+  /**
+   * The application ID to filter by
+   */
   applicationId?: string | undefined;
+  /**
+   * The candidate ID to filter by
+   */
   candidateId?: string | undefined;
   /**
    * ID of the connection
@@ -19,6 +25,9 @@ export type ListAtsDocumentsRequest = {
    * Comma-delimited fields to return
    */
   fields?: Array<string> | undefined;
+  /**
+   * The job ID to filter by
+   */
   jobId?: string | undefined;
   limit?: number | undefined;
   offset?: number | undefined;

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

@@ -9,6 +9,9 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type ListAtsInterviewsRequest = {
+  /**
+   * The application ID to filter by
+   */
   applicationId?: string | undefined;
   /**
    * ID of the connection

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

@@ -33,6 +33,9 @@ export type ListAtsJobsRequest = {
    * Return only results whose updated date is equal or greater to this value
    */
   updatedGte?: Date | undefined;
+  /**
+   * The user/employee ID to filter by
+   */
   userId?: string | undefined;
 };
 

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

@@ -9,7 +9,13 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type ListAtsScorecardsRequest = {
+  /**
+   * The application ID to filter by
+   */
   applicationId?: string | undefined;
+  /**
+   * The candidate ID to filter by
+   */
   candidateId?: string | undefined;
   /**
    * ID of the connection
@@ -19,7 +25,13 @@ export type ListAtsScorecardsRequest = {
    * Comma-delimited fields to return
    */
   fields?: Array<string> | undefined;
+  /**
+   * The interview ID to filter by
+   */
   interviewId?: string | undefined;
+  /**
+   * The job ID to filter by
+   */
   jobId?: string | undefined;
   limit?: number | undefined;
   offset?: number | undefined;

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

@@ -9,11 +9,17 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type ListCalendarBusiesRequest = {
+  /**
+   * The calendar ID to filter by
+   */
   calendarId?: string | undefined;
   /**
    * ID of the connection
    */
   connectionId: string;
+  /**
+   * The end date to filter by
+   */
   endLe?: string | undefined;
   /**
    * Comma-delimited fields to return
@@ -31,6 +37,9 @@ export type ListCalendarBusiesRequest = {
    */
   raw?: string | undefined;
   sort?: string | undefined;
+  /**
+   * The start date to filter by
+   */
   startGte?: string | undefined;
   /**
    * Return only results whose updated date is equal or greater to this value