@unified-api/typescript-sdk 2.64.0 → 2.68.0

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

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

@@ -9,11 +9,17 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type ListCalendarEventsRequest = {
+  /**
+   * 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 ListCalendarEventsRequest = {
    */
   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

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

@@ -13,7 +13,13 @@ export type ListCalendarRecordingsRequest = {
    * ID of the connection
    */
   connectionId: string;
+  /**
+   * The end date to filter by
+   */
   endLe?: string | undefined;
+  /**
+   * The event ID to filter by
+   */
   eventId?: string | undefined;
   /**
    * Comma-delimited fields to return
@@ -31,6 +37,9 @@ export type ListCalendarRecordingsRequest = {
    */
   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

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

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

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

@@ -17,8 +17,14 @@ export type ListCommerceInventoriesRequest = {
    * Comma-delimited fields to return
    */
   fields?: Array<string> | undefined;
+  /**
+   * The item variant ID to filter by
+   */
   itemVariantId?: string | undefined;
   limit?: number | undefined;
+  /**
+   * The location ID to filter by
+   */
   locationId?: string | undefined;
   offset?: number | undefined;
   order?: string | undefined;

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

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

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

@@ -0,0 +1,143 @@
+/*
+ * 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 ListCommerceReviewsRequest = {
+  /**
+   * ID of the connection
+   */
+  connectionId: string;
+  /**
+   * The contact ID to filter by
+   */
+  contactId?: string | undefined;
+  /**
+   * Comma-delimited fields to return
+   */
+  fields?: Array<string> | undefined;
+  /**
+   * The item ID to filter by
+   */
+  itemId?: string | undefined;
+  limit?: number | undefined;
+  offset?: number | undefined;
+  order?: 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
+   */
+  updatedGte?: Date | undefined;
+};
+
+/** @internal */
+export const ListCommerceReviewsRequest$inboundSchema: z.ZodType<
+  ListCommerceReviewsRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  connection_id: z.string(),
+  contact_id: z.string().optional(),
+  fields: z.array(z.string()).optional(),
+  item_id: z.string().optional(),
+  limit: z.number().optional(),
+  offset: z.number().optional(),
+  order: z.string().optional(),
+  query: z.string().optional(),
+  raw: z.string().optional(),
+  sort: z.string().optional(),
+  updated_gte: z.string().datetime({ offset: true }).transform(v => new Date(v))
+    .optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "connection_id": "connectionId",
+    "contact_id": "contactId",
+    "item_id": "itemId",
+    "updated_gte": "updatedGte",
+  });
+});
+
+/** @internal */
+export type ListCommerceReviewsRequest$Outbound = {
+  connection_id: string;
+  contact_id?: string | undefined;
+  fields?: Array<string> | undefined;
+  item_id?: string | undefined;
+  limit?: number | undefined;
+  offset?: number | undefined;
+  order?: string | undefined;
+  query?: string | undefined;
+  raw?: string | undefined;
+  sort?: string | undefined;
+  updated_gte?: string | undefined;
+};
+
+/** @internal */
+export const ListCommerceReviewsRequest$outboundSchema: z.ZodType<
+  ListCommerceReviewsRequest$Outbound,
+  z.ZodTypeDef,
+  ListCommerceReviewsRequest
+> = z.object({
+  connectionId: z.string(),
+  contactId: z.string().optional(),
+  fields: z.array(z.string()).optional(),
+  itemId: z.string().optional(),
+  limit: z.number().optional(),
+  offset: z.number().optional(),
+  order: z.string().optional(),
+  query: z.string().optional(),
+  raw: z.string().optional(),
+  sort: z.string().optional(),
+  updatedGte: z.date().transform(v => v.toISOString()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    connectionId: "connection_id",
+    contactId: "contact_id",
+    itemId: "item_id",
+    updatedGte: "updated_gte",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ListCommerceReviewsRequest$ {
+  /** @deprecated use `ListCommerceReviewsRequest$inboundSchema` instead. */
+  export const inboundSchema = ListCommerceReviewsRequest$inboundSchema;
+  /** @deprecated use `ListCommerceReviewsRequest$outboundSchema` instead. */
+  export const outboundSchema = ListCommerceReviewsRequest$outboundSchema;
+  /** @deprecated use `ListCommerceReviewsRequest$Outbound` instead. */
+  export type Outbound = ListCommerceReviewsRequest$Outbound;
+}
+
+export function listCommerceReviewsRequestToJSON(
+  listCommerceReviewsRequest: ListCommerceReviewsRequest,
+): string {
+  return JSON.stringify(
+    ListCommerceReviewsRequest$outboundSchema.parse(listCommerceReviewsRequest),
+  );
+}
+
+export function listCommerceReviewsRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<ListCommerceReviewsRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListCommerceReviewsRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListCommerceReviewsRequest' from JSON`,
+  );
+}

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

@@ -13,7 +13,13 @@ export type ListCrmCompaniesRequest = {
    * ID of the connection
    */
   connectionId: string;
+  /**
+   * The contact ID to filter by
+   */
   contactId?: string | undefined;
+  /**
+   * The deal ID to filter by
+   */
   dealId?: string | undefined;
   /**
    * Comma-delimited fields to return
@@ -35,6 +41,9 @@ export type ListCrmCompaniesRequest = {
    * 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/listcrmcontacts.ts

@@ -9,11 +9,17 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type ListCrmContactsRequest = {
+  /**
+   * The company ID to filter by
+   */
   companyId?: string | undefined;
   /**
    * ID of the connection
    */
   connectionId: string;
+  /**
+   * The deal ID to filter by
+   */
   dealId?: string | undefined;
   /**
    * Comma-delimited fields to return
@@ -35,6 +41,9 @@ export type ListCrmContactsRequest = {
    * 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/listcrmdeals.ts

@@ -9,11 +9,17 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type ListCrmDealsRequest = {
+  /**
+   * The company ID to filter by
+   */
   companyId?: string | undefined;
   /**
    * ID of the connection
    */
   connectionId: string;
+  /**
+   * The contact ID to filter by
+   */
   contactId?: string | undefined;
   /**
    * Comma-delimited fields to return
@@ -35,6 +41,9 @@ export type ListCrmDealsRequest = {
    * 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/listcrmevents.ts

@@ -9,17 +9,29 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type ListCrmEventsRequest = {
+  /**
+   * The company ID to filter by
+   */
   companyId?: string | undefined;
   /**
    * ID of the connection
    */
   connectionId: string;
+  /**
+   * The contact ID to filter by
+   */
   contactId?: string | undefined;
+  /**
+   * The deal ID to filter by
+   */
   dealId?: string | undefined;
   /**
    * Comma-delimited fields to return
    */
   fields?: Array<string> | undefined;
+  /**
+   * The CRM lead ID to filter by
+   */
   leadId?: string | undefined;
   limit?: number | undefined;
   offset?: number | undefined;
@@ -38,6 +50,9 @@ export type ListCrmEventsRequest = {
    * 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/listcrmleads.ts

@@ -9,11 +9,17 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type ListCrmLeadsRequest = {
+  /**
+   * The company ID to filter by
+   */
   companyId?: string | undefined;
   /**
    * ID of the connection
    */
   connectionId: string;
+  /**
+   * The contact ID to filter by
+   */
   contactId?: string | undefined;
   /**
    * Comma-delimited fields to return
@@ -35,6 +41,9 @@ export type ListCrmLeadsRequest = {
    * 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/listhrisdevices.ts

@@ -33,6 +33,9 @@ export type ListHrisDevicesRequest = {
    * 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/listhrisemployees.ts

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

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

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

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

@@ -9,6 +9,9 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type ListHrisPayslipsRequest = {
+  /**
+   * The company ID to filter by
+   */
   companyId?: string | undefined;
   /**
    * ID of the connection
@@ -34,6 +37,9 @@ export type ListHrisPayslipsRequest = {
    * 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/listhristimeoffs.ts

@@ -9,6 +9,9 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type ListHrisTimeoffsRequest = {
+  /**
+   * The company ID to filter by
+   */
   companyId?: string | undefined;
   /**
    * ID of the connection
@@ -34,6 +37,9 @@ export type ListHrisTimeoffsRequest = {
    * 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/listkmscomments.ts

@@ -20,7 +20,13 @@ export type ListKmsCommentsRequest = {
   limit?: number | undefined;
   offset?: number | undefined;
   order?: string | undefined;
+  /**
+   * The page ID to filter by
+   */
   pageId?: string | undefined;
+  /**
+   * The parent ID to filter by
+   */
   parentId?: string | undefined;
   /**
    * Query string to search. eg. email address or name
@@ -31,6 +37,9 @@ export type ListKmsCommentsRequest = {
    */
   raw?: string | undefined;
   sort?: string | undefined;
+  /**
+   * The type to filter by
+   */
   type?: string | undefined;
   /**
    * Return only results whose updated date is equal or greater to this value

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

@@ -20,6 +20,9 @@ export type ListKmsPagesRequest = {
   limit?: number | undefined;
   offset?: number | undefined;
   order?: string | undefined;
+  /**
+   * The parent ID to filter by
+   */
   parentId?: string | undefined;
   /**
    * Query string to search. eg. email address or name
@@ -30,6 +33,9 @@ export type ListKmsPagesRequest = {
    */
   raw?: string | undefined;
   sort?: string | undefined;
+  /**
+   * The space ID to filter by
+   */
   spaceId?: string | undefined;
   /**
    * Return only results whose updated date is equal or greater to this value