@unified-api/typescript-sdk 2.83.36 → 2.83.37

package/src/sdk/models/operations/getsigningdocument.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 GetSigningDocumentQueryParamFields = {
+  Id: "id",
+  CreatedAt: "created_at",
+  UpdatedAt: "updated_at",
+  Name: "name",
+  Description: "description",
+  Status: "status",
+  SentAt: "sent_at",
+  CompletedAt: "completed_at",
+  ExpiresAt: "expires_at",
+  TemplateId: "template_id",
+  DownloadUrl: "download_url",
+  CreatorId: "creator_id",
+  Metadata: "metadata",
+  Raw: "raw",
+} as const;
+export type GetSigningDocumentQueryParamFields = ClosedEnum<
+  typeof GetSigningDocumentQueryParamFields
+>;
+
+export type GetSigningDocumentRequest = {
+  /**
+   * ID of the connection
+   */
+  connectionId: string;
+  /**
+   * Fields to return
+   */
+  fields?: Array<GetSigningDocumentQueryParamFields> | undefined;
+  /**
+   * ID of the Document
+   */
+  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 GetSigningDocumentQueryParamFields$outboundSchema: z.ZodNativeEnum<
+  typeof GetSigningDocumentQueryParamFields
+> = z.nativeEnum(GetSigningDocumentQueryParamFields);
+
+/** @internal */
+export type GetSigningDocumentRequest$Outbound = {
+  connection_id: string;
+  fields?: Array<string> | undefined;
+  id: string;
+  raw?: string | undefined;
+};
+
+/** @internal */
+export const GetSigningDocumentRequest$outboundSchema: z.ZodType<
+  GetSigningDocumentRequest$Outbound,
+  z.ZodTypeDef,
+  GetSigningDocumentRequest
+> = z.object({
+  connectionId: z.string(),
+  fields: z.array(GetSigningDocumentQueryParamFields$outboundSchema).optional(),
+  id: z.string(),
+  raw: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    connectionId: "connection_id",
+  });
+});
+
+export function getSigningDocumentRequestToJSON(
+  getSigningDocumentRequest: GetSigningDocumentRequest,
+): string {
+  return JSON.stringify(
+    GetSigningDocumentRequest$outboundSchema.parse(getSigningDocumentRequest),
+  );
+}

package/src/sdk/models/operations/getsigningsignatory.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 GetSigningSignatoryQueryParamFields = {
+  Id: "id",
+  CreatedAt: "created_at",
+  UpdatedAt: "updated_at",
+  DocumentId: "document_id",
+  Name: "name",
+  Email: "email",
+  Role: "role",
+  Status: "status",
+  Order: "order",
+  SignedAt: "signed_at",
+  DeclineReason: "decline_reason",
+  Raw: "raw",
+} as const;
+export type GetSigningSignatoryQueryParamFields = ClosedEnum<
+  typeof GetSigningSignatoryQueryParamFields
+>;
+
+export type GetSigningSignatoryRequest = {
+  /**
+   * ID of the connection
+   */
+  connectionId: string;
+  /**
+   * Fields to return
+   */
+  fields?: Array<GetSigningSignatoryQueryParamFields> | undefined;
+  /**
+   * ID of the Signatory
+   */
+  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 GetSigningSignatoryQueryParamFields$outboundSchema:
+  z.ZodNativeEnum<typeof GetSigningSignatoryQueryParamFields> = z.nativeEnum(
+    GetSigningSignatoryQueryParamFields,
+  );
+
+/** @internal */
+export type GetSigningSignatoryRequest$Outbound = {
+  connection_id: string;
+  fields?: Array<string> | undefined;
+  id: string;
+  raw?: string | undefined;
+};
+
+/** @internal */
+export const GetSigningSignatoryRequest$outboundSchema: z.ZodType<
+  GetSigningSignatoryRequest$Outbound,
+  z.ZodTypeDef,
+  GetSigningSignatoryRequest
+> = z.object({
+  connectionId: z.string(),
+  fields: z.array(GetSigningSignatoryQueryParamFields$outboundSchema)
+    .optional(),
+  id: z.string(),
+  raw: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    connectionId: "connection_id",
+  });
+});
+
+export function getSigningSignatoryRequestToJSON(
+  getSigningSignatoryRequest: GetSigningSignatoryRequest,
+): string {
+  return JSON.stringify(
+    GetSigningSignatoryRequest$outboundSchema.parse(getSigningSignatoryRequest),
+  );
+}

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

@@ -0,0 +1,77 @@
+/*
+ * 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 GetSigningTemplateQueryParamFields = {
+  Id: "id",
+  CreatedAt: "created_at",
+  UpdatedAt: "updated_at",
+  Name: "name",
+  Description: "description",
+  IsActive: "is_active",
+  CreatorId: "creator_id",
+  Raw: "raw",
+} as const;
+export type GetSigningTemplateQueryParamFields = ClosedEnum<
+  typeof GetSigningTemplateQueryParamFields
+>;
+
+export type GetSigningTemplateRequest = {
+  /**
+   * ID of the connection
+   */
+  connectionId: string;
+  /**
+   * Fields to return
+   */
+  fields?: Array<GetSigningTemplateQueryParamFields> | undefined;
+  /**
+   * ID of the Template
+   */
+  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 GetSigningTemplateQueryParamFields$outboundSchema: z.ZodNativeEnum<
+  typeof GetSigningTemplateQueryParamFields
+> = z.nativeEnum(GetSigningTemplateQueryParamFields);
+
+/** @internal */
+export type GetSigningTemplateRequest$Outbound = {
+  connection_id: string;
+  fields?: Array<string> | undefined;
+  id: string;
+  raw?: string | undefined;
+};
+
+/** @internal */
+export const GetSigningTemplateRequest$outboundSchema: z.ZodType<
+  GetSigningTemplateRequest$Outbound,
+  z.ZodTypeDef,
+  GetSigningTemplateRequest
+> = z.object({
+  connectionId: z.string(),
+  fields: z.array(GetSigningTemplateQueryParamFields$outboundSchema).optional(),
+  id: z.string(),
+  raw: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    connectionId: "connection_id",
+  });
+});
+
+export function getSigningTemplateRequestToJSON(
+  getSigningTemplateRequest: GetSigningTemplateRequest,
+): string {
+  return JSON.stringify(
+    GetSigningTemplateRequest$outboundSchema.parse(getSigningTemplateRequest),
+  );
+}

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

@@ -91,6 +91,8 @@ export * from "./createscimusers.js";
 export * from "./createshippinglabel.js";
 export * from "./createshippingrate.js";
 export * from "./createshippingshipment.js";
+export * from "./createsigningdocument.js";
+export * from "./createsigningsignatory.js";
 export * from "./createstoragefile.js";
 export * from "./createtaskcomment.js";
 export * from "./createtaskproject.js";
@@ -203,6 +205,9 @@ export * from "./getshippingcarrier.js";
 export * from "./getshippinglabel.js";
 export * from "./getshippingshipment.js";
 export * from "./getshippingtracking.js";
+export * from "./getsigningdocument.js";
+export * from "./getsigningsignatory.js";
+export * from "./getsigningtemplate.js";
 export * from "./getstoragefile.js";
 export * from "./gettaskchange.js";
 export * from "./gettaskcomment.js";
@@ -332,6 +337,9 @@ export * from "./listscimusers.js";
 export * from "./listshippingcarriers.js";
 export * from "./listshippinglabels.js";
 export * from "./listshippingshipments.js";
+export * from "./listsigningdocuments.js";
+export * from "./listsigningsignatories.js";
+export * from "./listsigningtemplates.js";
 export * from "./liststoragefiles.js";
 export * from "./listtaskchanges.js";
 export * from "./listtaskcomments.js";
@@ -441,6 +449,8 @@ export * from "./patchscimgroups.js";
 export * from "./patchscimusers.js";
 export * from "./patchshippinglabel.js";
 export * from "./patchshippingshipment.js";
+export * from "./patchsigningdocument.js";
+export * from "./patchsigningsignatory.js";
 export * from "./patchstoragefile.js";
 export * from "./patchtaskcomment.js";
 export * from "./patchtaskproject.js";
@@ -541,6 +551,8 @@ export * from "./removescimgroups.js";
 export * from "./removescimusers.js";
 export * from "./removeshippinglabel.js";
 export * from "./removeshippingshipment.js";
+export * from "./removesigningdocument.js";
+export * from "./removesigningsignatory.js";
 export * from "./removestoragefile.js";
 export * from "./removetaskcomment.js";
 export * from "./removetaskproject.js";
@@ -644,6 +656,8 @@ export * from "./updatescimgroups.js";
 export * from "./updatescimusers.js";
 export * from "./updateshippinglabel.js";
 export * from "./updateshippingshipment.js";
+export * from "./updatesigningdocument.js";
+export * from "./updatesigningsignatory.js";
 export * from "./updatestoragefile.js";
 export * from "./updatetaskcomment.js";
 export * from "./updatetaskproject.js";

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

@@ -0,0 +1,119 @@
+/*
+ * 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 ListSigningDocumentsQueryParamFields = {
+  Id: "id",
+  CreatedAt: "created_at",
+  UpdatedAt: "updated_at",
+  Name: "name",
+  Description: "description",
+  Status: "status",
+  SentAt: "sent_at",
+  CompletedAt: "completed_at",
+  ExpiresAt: "expires_at",
+  TemplateId: "template_id",
+  DownloadUrl: "download_url",
+  CreatorId: "creator_id",
+  Metadata: "metadata",
+  Raw: "raw",
+} as const;
+export type ListSigningDocumentsQueryParamFields = ClosedEnum<
+  typeof ListSigningDocumentsQueryParamFields
+>;
+
+export type ListSigningDocumentsRequest = {
+  /**
+   * ID of the connection
+   */
+  connectionId: string;
+  /**
+   * Fields to return
+   */
+  fields?: Array<ListSigningDocumentsQueryParamFields> | 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;
+  /**
+   * The status to filter by
+   */
+  status?: string | undefined;
+  /**
+   * The signing template ID to filter by
+   */
+  templateId?: 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 ListSigningDocumentsQueryParamFields$outboundSchema:
+  z.ZodNativeEnum<typeof ListSigningDocumentsQueryParamFields> = z.nativeEnum(
+    ListSigningDocumentsQueryParamFields,
+  );
+
+/** @internal */
+export type ListSigningDocumentsRequest$Outbound = {
+  connection_id: string;
+  fields?: Array<string> | undefined;
+  limit?: number | undefined;
+  offset?: number | undefined;
+  order?: string | undefined;
+  query?: string | undefined;
+  raw?: string | undefined;
+  sort?: string | undefined;
+  status?: string | undefined;
+  template_id?: string | undefined;
+  updated_gte?: string | undefined;
+};
+
+/** @internal */
+export const ListSigningDocumentsRequest$outboundSchema: z.ZodType<
+  ListSigningDocumentsRequest$Outbound,
+  z.ZodTypeDef,
+  ListSigningDocumentsRequest
+> = z.object({
+  connectionId: z.string(),
+  fields: z.array(ListSigningDocumentsQueryParamFields$outboundSchema)
+    .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(),
+  status: z.string().optional(),
+  templateId: z.string().optional(),
+  updatedGte: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    connectionId: "connection_id",
+    templateId: "template_id",
+    updatedGte: "updated_gte",
+  });
+});
+
+export function listSigningDocumentsRequestToJSON(
+  listSigningDocumentsRequest: ListSigningDocumentsRequest,
+): string {
+  return JSON.stringify(
+    ListSigningDocumentsRequest$outboundSchema.parse(
+      listSigningDocumentsRequest,
+    ),
+  );
+}

package/src/sdk/models/operations/listsigningsignatories.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 ListSigningSignatoriesQueryParamFields = {
+  Id: "id",
+  CreatedAt: "created_at",
+  UpdatedAt: "updated_at",
+  DocumentId: "document_id",
+  Name: "name",
+  Email: "email",
+  Role: "role",
+  Status: "status",
+  Order: "order",
+  SignedAt: "signed_at",
+  DeclineReason: "decline_reason",
+  Raw: "raw",
+} as const;
+export type ListSigningSignatoriesQueryParamFields = ClosedEnum<
+  typeof ListSigningSignatoriesQueryParamFields
+>;
+
+export type ListSigningSignatoriesRequest = {
+  /**
+   * ID of the connection
+   */
+  connectionId: string;
+  /**
+   * The document ID to filter by
+   */
+  documentId?: string | undefined;
+  /**
+   * Fields to return
+   */
+  fields?: Array<ListSigningSignatoriesQueryParamFields> | 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 (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
+   */
+  updatedGte?: string | undefined;
+};
+
+/** @internal */
+export const ListSigningSignatoriesQueryParamFields$outboundSchema:
+  z.ZodNativeEnum<typeof ListSigningSignatoriesQueryParamFields> = z.nativeEnum(
+    ListSigningSignatoriesQueryParamFields,
+  );
+
+/** @internal */
+export type ListSigningSignatoriesRequest$Outbound = {
+  connection_id: string;
+  document_id?: string | undefined;
+  fields?: Array<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 ListSigningSignatoriesRequest$outboundSchema: z.ZodType<
+  ListSigningSignatoriesRequest$Outbound,
+  z.ZodTypeDef,
+  ListSigningSignatoriesRequest
+> = z.object({
+  connectionId: z.string(),
+  documentId: z.string().optional(),
+  fields: z.array(ListSigningSignatoriesQueryParamFields$outboundSchema)
+    .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.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    connectionId: "connection_id",
+    documentId: "document_id",
+    updatedGte: "updated_gte",
+  });
+});
+
+export function listSigningSignatoriesRequestToJSON(
+  listSigningSignatoriesRequest: ListSigningSignatoriesRequest,
+): string {
+  return JSON.stringify(
+    ListSigningSignatoriesRequest$outboundSchema.parse(
+      listSigningSignatoriesRequest,
+    ),
+  );
+}

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

@@ -0,0 +1,100 @@
+/*
+ * 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 ListSigningTemplatesQueryParamFields = {
+  Id: "id",
+  CreatedAt: "created_at",
+  UpdatedAt: "updated_at",
+  Name: "name",
+  Description: "description",
+  IsActive: "is_active",
+  CreatorId: "creator_id",
+  Raw: "raw",
+} as const;
+export type ListSigningTemplatesQueryParamFields = ClosedEnum<
+  typeof ListSigningTemplatesQueryParamFields
+>;
+
+export type ListSigningTemplatesRequest = {
+  /**
+   * ID of the connection
+   */
+  connectionId: string;
+  /**
+   * Fields to return
+   */
+  fields?: Array<ListSigningTemplatesQueryParamFields> | 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 (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
+   */
+  updatedGte?: string | undefined;
+};
+
+/** @internal */
+export const ListSigningTemplatesQueryParamFields$outboundSchema:
+  z.ZodNativeEnum<typeof ListSigningTemplatesQueryParamFields> = z.nativeEnum(
+    ListSigningTemplatesQueryParamFields,
+  );
+
+/** @internal */
+export type ListSigningTemplatesRequest$Outbound = {
+  connection_id: string;
+  fields?: Array<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 ListSigningTemplatesRequest$outboundSchema: z.ZodType<
+  ListSigningTemplatesRequest$Outbound,
+  z.ZodTypeDef,
+  ListSigningTemplatesRequest
+> = z.object({
+  connectionId: z.string(),
+  fields: z.array(ListSigningTemplatesQueryParamFields$outboundSchema)
+    .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.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    connectionId: "connection_id",
+    updatedGte: "updated_gte",
+  });
+});
+
+export function listSigningTemplatesRequestToJSON(
+  listSigningTemplatesRequest: ListSigningTemplatesRequest,
+): string {
+  return JSON.stringify(
+    ListSigningTemplatesRequest$outboundSchema.parse(
+      listSigningTemplatesRequest,
+    ),
+  );
+}

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

@@ -34,6 +34,7 @@ export const Categories = {
   Forms: "forms",
   Shipping: "shipping",
   Assessment: "assessment",
+  Signing: "signing",
 } as const;
 export type Categories = ClosedEnum<typeof Categories>;
 

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

@@ -34,6 +34,7 @@ export const ListUnifiedIntegrationsQueryParamCategories = {
   Forms: "forms",
   Shipping: "shipping",
   Assessment: "assessment",
+  Signing: "signing",
 } as const;
 export type ListUnifiedIntegrationsQueryParamCategories = ClosedEnum<
   typeof ListUnifiedIntegrationsQueryParamCategories

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

@@ -34,6 +34,7 @@ export const QueryParamCategories = {
   Forms: "forms",
   Shipping: "shipping",
   Assessment: "assessment",
+  Signing: "signing",
 } as const;
 export type QueryParamCategories = ClosedEnum<typeof QueryParamCategories>;