@unified-api/typescript-sdk 2.64.0 → 2.66.0

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

@@ -9,17 +9,26 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type ListLmsStudentsRequest = {
+  /**
+   * The class ID to filter by
+   */
   classId?: string | undefined;
   /**
    * ID of the connection
    */
   connectionId: string;
+  /**
+   * The course ID to filter by
+   */
   courseId?: string | undefined;
   /**
    * Comma-delimited fields to return
    */
   fields?: Array<string> | undefined;
   limit?: number | undefined;
+  /**
+   * The location ID to filter by
+   */
   locationId?: string | undefined;
   offset?: number | undefined;
   order?: string | undefined;
@@ -31,7 +40,6 @@ export type ListLmsStudentsRequest = {
    * 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;
-  sessionId?: string | undefined;
   sort?: string | undefined;
   /**
    * Return only results whose updated date is equal or greater to this value
@@ -55,7 +63,6 @@ export const ListLmsStudentsRequest$inboundSchema: z.ZodType<
   order: z.string().optional(),
   query: z.string().optional(),
   raw: z.string().optional(),
-  session_id: z.string().optional(),
   sort: z.string().optional(),
   updated_gte: z.string().datetime({ offset: true }).transform(v => new Date(v))
     .optional(),
@@ -65,7 +72,6 @@ export const ListLmsStudentsRequest$inboundSchema: z.ZodType<
     "connection_id": "connectionId",
     "course_id": "courseId",
     "location_id": "locationId",
-    "session_id": "sessionId",
     "updated_gte": "updatedGte",
   });
 });
@@ -82,7 +88,6 @@ export type ListLmsStudentsRequest$Outbound = {
   order?: string | undefined;
   query?: string | undefined;
   raw?: string | undefined;
-  session_id?: string | undefined;
   sort?: string | undefined;
   updated_gte?: string | undefined;
 };
@@ -103,7 +108,6 @@ export const ListLmsStudentsRequest$outboundSchema: z.ZodType<
   order: z.string().optional(),
   query: z.string().optional(),
   raw: z.string().optional(),
-  sessionId: z.string().optional(),
   sort: z.string().optional(),
   updatedGte: z.date().transform(v => v.toISOString()).optional(),
 }).transform((v) => {
@@ -112,7 +116,6 @@ export const ListLmsStudentsRequest$outboundSchema: z.ZodType<
     connectionId: "connection_id",
     courseId: "course_id",
     locationId: "location_id",
-    sessionId: "session_id",
     updatedGte: "updated_gte",
   });
 });

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

@@ -18,6 +18,9 @@ export type ListMartechMembersRequest = {
    */
   fields?: Array<string> | undefined;
   limit?: number | undefined;
+  /**
+   * The list ID to filter by
+   */
   listId?: string | undefined;
   offset?: number | undefined;
   order?: string | undefined;

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

@@ -20,6 +20,9 @@ export type ListMessagingChannelsRequest = {
   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/listmessagingmessages.ts

@@ -9,11 +9,17 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type ListMessagingMessagesRequest = {
+  /**
+   * The channel ID to filter by
+   */
   channelId?: string | undefined;
   /**
    * ID of the connection
    */
   connectionId: string;
+  /**
+   * The end date to filter by
+   */
   endLe?: string | undefined;
   /**
    * Comma-delimited fields to return
@@ -22,6 +28,9 @@ export type ListMessagingMessagesRequest = {
   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
@@ -32,6 +41,9 @@ export type ListMessagingMessagesRequest = {
    */
   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/listmetadatametadatas.ts

@@ -29,6 +29,9 @@ export type ListMetadataMetadatasRequest = {
    */
   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/listpaymentlinks.ts

@@ -13,6 +13,9 @@ export type ListPaymentLinksRequest = {
    * ID of the connection
    */
   connectionId: string;
+  /**
+   * The contact ID to filter by
+   */
   contactId?: string | undefined;
   /**
    * Comma-delimited fields to return
@@ -21,6 +24,9 @@ export type ListPaymentLinksRequest = {
   limit?: number | undefined;
   offset?: number | undefined;
   order?: string | undefined;
+  /**
+   * The payment ID to filter by
+   */
   paymentId?: string | undefined;
   /**
    * Query string to search. eg. email address or name

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

@@ -13,11 +13,17 @@ export type ListPaymentPaymentsRequest = {
    * 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 invoice ID to filter by
+   */
   invoiceId?: string | undefined;
   limit?: number | undefined;
   offset?: number | undefined;

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

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

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

@@ -13,6 +13,9 @@ export type ListPaymentSubscriptionsRequest = {
    * 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/listrepobranches.ts

@@ -28,6 +28,9 @@ export type ListRepoBranchesRequest = {
    * 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;
+  /**
+   * The repo ID to filter by
+   */
   repoId?: string | undefined;
   sort?: string | undefined;
   /**

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

@@ -9,6 +9,9 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type ListRepoCommitsRequest = {
+  /**
+   * The repo branch ID to filter by
+   */
   branchId?: string | undefined;
   /**
    * ID of the connection
@@ -29,6 +32,9 @@ export type ListRepoCommitsRequest = {
    * 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;
+  /**
+   * The repo ID to filter by
+   */
   repoId?: string | undefined;
   sort?: string | undefined;
   /**

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

@@ -28,6 +28,9 @@ export type ListRepoPullrequestsRequest = {
    * 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;
+  /**
+   * The repo ID to filter by
+   */
   repoId?: string | undefined;
   sort?: string | undefined;
   /**

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

@@ -20,6 +20,9 @@ export type ListRepoRepositoriesRequest = {
   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/liststoragefiles.ts

@@ -20,6 +20,9 @@ export type ListStorageFilesRequest = {
   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 ListStorageFilesRequest = {
    */
   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/listtaskcomments.ts

@@ -29,6 +29,9 @@ export type ListTaskCommentsRequest = {
    */
   raw?: string | undefined;
   sort?: string | undefined;
+  /**
+   * The task ID to filter by
+   */
   taskId?: string | undefined;
   /**
    * Return only results whose updated date is equal or greater to this value

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

@@ -20,6 +20,9 @@ export type ListTaskProjectsRequest = {
   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/listtasktasks.ts

@@ -20,7 +20,13 @@ export type ListTaskTasksRequest = {
   limit?: number | undefined;
   offset?: number | undefined;
   order?: string | undefined;
+  /**
+   * The parent ID to filter by
+   */
   parentId?: string | undefined;
+  /**
+   * The project ID to filter by
+   */
   projectId?: string | undefined;
   /**
    * Query string to search. eg. email address or name
@@ -35,6 +41,9 @@ export type ListTaskTasksRequest = {
    * 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/listticketingnotes.ts

@@ -13,6 +13,9 @@ export type ListTicketingNotesRequest = {
    * ID of the connection
    */
   connectionId: string;
+  /**
+   * The customer ID to filter by
+   */
   customerId?: string | undefined;
   /**
    * Comma-delimited fields to return
@@ -30,6 +33,9 @@ export type ListTicketingNotesRequest = {
    */
   raw?: string | undefined;
   sort?: string | undefined;
+  /**
+   * The ticket ID to filter by
+   */
   ticketId?: string | undefined;
   /**
    * Return only results whose updated date is equal or greater to this value

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

@@ -13,6 +13,9 @@ export type ListTicketingTicketsRequest = {
    * ID of the connection
    */
   connectionId: string;
+  /**
+   * The customer ID to filter by
+   */
   customerId?: string | undefined;
   /**
    * Comma-delimited fields to return
@@ -34,6 +37,9 @@ export type ListTicketingTicketsRequest = {
    * 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/listuccalls.ts

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

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

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

@@ -9,11 +9,21 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type ListUcRecordingsRequest = {
+  /**
+   * The call ID to filter by
+   */
   callId?: string | undefined;
   /**
    * ID of the connection
    */
   connectionId: string;
+  /**
+   * The contact ID to filter by
+   */
+  contactId?: string | undefined;
+  /**
+   * The end date to filter by
+   */
   endLe?: string | undefined;
   /**
    * Comma-delimited fields to return
@@ -31,11 +41,17 @@ export type ListUcRecordingsRequest = {
    */
   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
    */
   updatedGte?: Date | undefined;
+  /**
+   * The user/employee ID to filter by
+   */
   userId?: string | undefined;
 };
 
@@ -47,6 +63,7 @@ export const ListUcRecordingsRequest$inboundSchema: z.ZodType<
 > = z.object({
   call_id: z.string().optional(),
   connection_id: z.string(),
+  contact_id: z.string().optional(),
   end_le: z.string().optional(),
   fields: z.array(z.string()).optional(),
   limit: z.number().optional(),
@@ -63,6 +80,7 @@ export const ListUcRecordingsRequest$inboundSchema: z.ZodType<
   return remap$(v, {
     "call_id": "callId",
     "connection_id": "connectionId",
+    "contact_id": "contactId",
     "end_le": "endLe",
     "start_gte": "startGte",
     "updated_gte": "updatedGte",
@@ -74,6 +92,7 @@ export const ListUcRecordingsRequest$inboundSchema: z.ZodType<
 export type ListUcRecordingsRequest$Outbound = {
   call_id?: string | undefined;
   connection_id: string;
+  contact_id?: string | undefined;
   end_le?: string | undefined;
   fields?: Array<string> | undefined;
   limit?: number | undefined;
@@ -95,6 +114,7 @@ export const ListUcRecordingsRequest$outboundSchema: z.ZodType<
 > = z.object({
   callId: z.string().optional(),
   connectionId: z.string(),
+  contactId: z.string().optional(),
   endLe: z.string().optional(),
   fields: z.array(z.string()).optional(),
   limit: z.number().optional(),
@@ -110,6 +130,7 @@ export const ListUcRecordingsRequest$outboundSchema: z.ZodType<
   return remap$(v, {
     callId: "call_id",
     connectionId: "connection_id",
+    contactId: "contact_id",
     endLe: "end_le",
     startGte: "start_gte",
     updatedGte: "updated_gte",

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