@unified-api/typescript-sdk 2.83.36 → 2.83.37

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

@@ -244,6 +244,11 @@ export const PropertyConnectionPermissions = {
   ShippingTrackingRead: "shipping_tracking_read",
   ShippingRateRead: "shipping_rate_read",
   ShippingCarrierRead: "shipping_carrier_read",
+  SigningDocumentRead: "signing_document_read",
+  SigningDocumentWrite: "signing_document_write",
+  SigningSignatoryRead: "signing_signatory_read",
+  SigningSignatoryWrite: "signing_signatory_write",
+  SigningTemplateRead: "signing_template_read",
 } as const;
 export type PropertyConnectionPermissions = OpenEnum<
   typeof PropertyConnectionPermissions

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

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

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

@@ -0,0 +1,160 @@
+/*
+ * 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";
+
+export const SigningDocumentStatus = {
+  Draft: "DRAFT",
+  Sent: "SENT",
+  Delivered: "DELIVERED",
+  InProgress: "IN_PROGRESS",
+  Completed: "COMPLETED",
+  Declined: "DECLINED",
+  Voided: "VOIDED",
+  Expired: "EXPIRED",
+} as const;
+export type SigningDocumentStatus = OpenEnum<typeof SigningDocumentStatus>;
+
+export type SigningDocument = {
+  completedAt?: Date | undefined;
+  createdAt?: Date | undefined;
+  creatorId?: string | undefined;
+  description?: string | undefined;
+  downloadUrl?: string | undefined;
+  expiresAt?: Date | undefined;
+  id?: string | undefined;
+  /**
+   * Custom key-value pairs
+   */
+  metadata?: { [k: string]: string } | undefined;
+  name?: string | undefined;
+  raw?: { [k: string]: any } | undefined;
+  sentAt?: Date | undefined;
+  status?: SigningDocumentStatus | undefined;
+  templateId?: string | undefined;
+  updatedAt?: Date | undefined;
+};
+
+/** @internal */
+export const SigningDocumentStatus$inboundSchema: z.ZodType<
+  SigningDocumentStatus,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(SigningDocumentStatus);
+/** @internal */
+export const SigningDocumentStatus$outboundSchema: z.ZodType<
+  string,
+  z.ZodTypeDef,
+  SigningDocumentStatus
+> = openEnums.outboundSchema(SigningDocumentStatus);
+
+/** @internal */
+export const SigningDocument$inboundSchema: z.ZodType<
+  SigningDocument,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  completed_at: z.string().datetime({ offset: true }).transform(v =>
+    new Date(v)
+  ).optional(),
+  created_at: z.string().datetime({ offset: true }).transform(v => new Date(v))
+    .optional(),
+  creator_id: z.string().optional(),
+  description: z.string().optional(),
+  download_url: z.string().optional(),
+  expires_at: z.string().datetime({ offset: true }).transform(v => new Date(v))
+    .optional(),
+  id: z.string().optional(),
+  metadata: z.record(z.string()).optional(),
+  name: z.string().optional(),
+  raw: z.record(z.any()).optional(),
+  sent_at: z.string().datetime({ offset: true }).transform(v => new Date(v))
+    .optional(),
+  status: SigningDocumentStatus$inboundSchema.optional(),
+  template_id: z.string().optional(),
+  updated_at: z.string().datetime({ offset: true }).transform(v => new Date(v))
+    .optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "completed_at": "completedAt",
+    "created_at": "createdAt",
+    "creator_id": "creatorId",
+    "download_url": "downloadUrl",
+    "expires_at": "expiresAt",
+    "sent_at": "sentAt",
+    "template_id": "templateId",
+    "updated_at": "updatedAt",
+  });
+});
+/** @internal */
+export type SigningDocument$Outbound = {
+  completed_at?: string | undefined;
+  created_at?: string | undefined;
+  creator_id?: string | undefined;
+  description?: string | undefined;
+  download_url?: string | undefined;
+  expires_at?: string | undefined;
+  id?: string | undefined;
+  metadata?: { [k: string]: string } | undefined;
+  name?: string | undefined;
+  raw?: { [k: string]: any } | undefined;
+  sent_at?: string | undefined;
+  status?: string | undefined;
+  template_id?: string | undefined;
+  updated_at?: string | undefined;
+};
+
+/** @internal */
+export const SigningDocument$outboundSchema: z.ZodType<
+  SigningDocument$Outbound,
+  z.ZodTypeDef,
+  SigningDocument
+> = z.object({
+  completedAt: z.date().transform(v => v.toISOString()).optional(),
+  createdAt: z.date().transform(v => v.toISOString()).optional(),
+  creatorId: z.string().optional(),
+  description: z.string().optional(),
+  downloadUrl: z.string().optional(),
+  expiresAt: z.date().transform(v => v.toISOString()).optional(),
+  id: z.string().optional(),
+  metadata: z.record(z.string()).optional(),
+  name: z.string().optional(),
+  raw: z.record(z.any()).optional(),
+  sentAt: z.date().transform(v => v.toISOString()).optional(),
+  status: SigningDocumentStatus$outboundSchema.optional(),
+  templateId: z.string().optional(),
+  updatedAt: z.date().transform(v => v.toISOString()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    completedAt: "completed_at",
+    createdAt: "created_at",
+    creatorId: "creator_id",
+    downloadUrl: "download_url",
+    expiresAt: "expires_at",
+    sentAt: "sent_at",
+    templateId: "template_id",
+    updatedAt: "updated_at",
+  });
+});
+
+export function signingDocumentToJSON(
+  signingDocument: SigningDocument,
+): string {
+  return JSON.stringify(SigningDocument$outboundSchema.parse(signingDocument));
+}
+export function signingDocumentFromJSON(
+  jsonString: string,
+): SafeParseResult<SigningDocument, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SigningDocument$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SigningDocument' from JSON`,
+  );
+}

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

@@ -0,0 +1,162 @@
+/*
+ * 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";
+
+export const SigningSignatoryRole = {
+  Signer: "SIGNER",
+  Cc: "CC",
+  Approver: "APPROVER",
+  InPersonSigner: "IN_PERSON_SIGNER",
+  Viewer: "VIEWER",
+} as const;
+export type SigningSignatoryRole = OpenEnum<typeof SigningSignatoryRole>;
+
+export const SigningSignatoryStatus = {
+  Pending: "PENDING",
+  Sent: "SENT",
+  Delivered: "DELIVERED",
+  Signed: "SIGNED",
+  Declined: "DECLINED",
+  Error: "ERROR",
+} as const;
+export type SigningSignatoryStatus = OpenEnum<typeof SigningSignatoryStatus>;
+
+export type SigningSignatory = {
+  createdAt?: Date | undefined;
+  declineReason?: string | undefined;
+  documentId?: string | undefined;
+  email?: string | undefined;
+  id?: string | undefined;
+  name?: string | undefined;
+  order?: number | undefined;
+  raw?: { [k: string]: any } | undefined;
+  role?: SigningSignatoryRole | undefined;
+  signedAt?: Date | undefined;
+  status?: SigningSignatoryStatus | undefined;
+  updatedAt?: Date | undefined;
+};
+
+/** @internal */
+export const SigningSignatoryRole$inboundSchema: z.ZodType<
+  SigningSignatoryRole,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(SigningSignatoryRole);
+/** @internal */
+export const SigningSignatoryRole$outboundSchema: z.ZodType<
+  string,
+  z.ZodTypeDef,
+  SigningSignatoryRole
+> = openEnums.outboundSchema(SigningSignatoryRole);
+
+/** @internal */
+export const SigningSignatoryStatus$inboundSchema: z.ZodType<
+  SigningSignatoryStatus,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(SigningSignatoryStatus);
+/** @internal */
+export const SigningSignatoryStatus$outboundSchema: z.ZodType<
+  string,
+  z.ZodTypeDef,
+  SigningSignatoryStatus
+> = openEnums.outboundSchema(SigningSignatoryStatus);
+
+/** @internal */
+export const SigningSignatory$inboundSchema: z.ZodType<
+  SigningSignatory,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  created_at: z.string().datetime({ offset: true }).transform(v => new Date(v))
+    .optional(),
+  decline_reason: z.string().optional(),
+  document_id: z.string().optional(),
+  email: z.string().optional(),
+  id: z.string().optional(),
+  name: z.string().optional(),
+  order: z.number().optional(),
+  raw: z.record(z.any()).optional(),
+  role: SigningSignatoryRole$inboundSchema.optional(),
+  signed_at: z.string().datetime({ offset: true }).transform(v => new Date(v))
+    .optional(),
+  status: SigningSignatoryStatus$inboundSchema.optional(),
+  updated_at: z.string().datetime({ offset: true }).transform(v => new Date(v))
+    .optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "created_at": "createdAt",
+    "decline_reason": "declineReason",
+    "document_id": "documentId",
+    "signed_at": "signedAt",
+    "updated_at": "updatedAt",
+  });
+});
+/** @internal */
+export type SigningSignatory$Outbound = {
+  created_at?: string | undefined;
+  decline_reason?: string | undefined;
+  document_id?: string | undefined;
+  email?: string | undefined;
+  id?: string | undefined;
+  name?: string | undefined;
+  order?: number | undefined;
+  raw?: { [k: string]: any } | undefined;
+  role?: string | undefined;
+  signed_at?: string | undefined;
+  status?: string | undefined;
+  updated_at?: string | undefined;
+};
+
+/** @internal */
+export const SigningSignatory$outboundSchema: z.ZodType<
+  SigningSignatory$Outbound,
+  z.ZodTypeDef,
+  SigningSignatory
+> = z.object({
+  createdAt: z.date().transform(v => v.toISOString()).optional(),
+  declineReason: z.string().optional(),
+  documentId: z.string().optional(),
+  email: z.string().optional(),
+  id: z.string().optional(),
+  name: z.string().optional(),
+  order: z.number().optional(),
+  raw: z.record(z.any()).optional(),
+  role: SigningSignatoryRole$outboundSchema.optional(),
+  signedAt: z.date().transform(v => v.toISOString()).optional(),
+  status: SigningSignatoryStatus$outboundSchema.optional(),
+  updatedAt: z.date().transform(v => v.toISOString()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    createdAt: "created_at",
+    declineReason: "decline_reason",
+    documentId: "document_id",
+    signedAt: "signed_at",
+    updatedAt: "updated_at",
+  });
+});
+
+export function signingSignatoryToJSON(
+  signingSignatory: SigningSignatory,
+): string {
+  return JSON.stringify(
+    SigningSignatory$outboundSchema.parse(signingSignatory),
+  );
+}
+export function signingSignatoryFromJSON(
+  jsonString: string,
+): SafeParseResult<SigningSignatory, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SigningSignatory$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SigningSignatory' from JSON`,
+  );
+}

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

@@ -0,0 +1,55 @@
+/*
+ * 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 SigningTemplate = {
+  createdAt?: Date | undefined;
+  creatorId?: string | undefined;
+  description?: string | undefined;
+  id?: string | undefined;
+  isActive?: boolean | undefined;
+  name?: string | undefined;
+  raw?: { [k: string]: any } | undefined;
+  updatedAt?: Date | undefined;
+};
+
+/** @internal */
+export const SigningTemplate$inboundSchema: z.ZodType<
+  SigningTemplate,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  created_at: z.string().datetime({ offset: true }).transform(v => new Date(v))
+    .optional(),
+  creator_id: z.string().optional(),
+  description: z.string().optional(),
+  id: z.string().optional(),
+  is_active: z.boolean().optional(),
+  name: z.string().optional(),
+  raw: z.record(z.any()).optional(),
+  updated_at: z.string().datetime({ offset: true }).transform(v => new Date(v))
+    .optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "created_at": "createdAt",
+    "creator_id": "creatorId",
+    "is_active": "isActive",
+    "updated_at": "updatedAt",
+  });
+});
+
+export function signingTemplateFromJSON(
+  jsonString: string,
+): SafeParseResult<SigningTemplate, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SigningTemplate$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SigningTemplate' from JSON`,
+  );
+}

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

@@ -157,6 +157,9 @@ export const ObjectType = {
   ShippingShipment: "shipping_shipment",
   ShippingLabel: "shipping_label",
   ShippingTracking: "shipping_tracking",
+  SigningDocument: "signing_document",
+  SigningSignatory: "signing_signatory",
+  SigningTemplate: "signing_template",
 } as const;
 export type ObjectType = OpenEnum<typeof ObjectType>;
 

package/src/sdk/sdk.ts

@@ -117,6 +117,8 @@ import { Scim } from "./scim.js";
 import { Scorecard } from "./scorecard.js";
 import { Shipment } from "./shipment.js";
 import { Shipping } from "./shipping.js";
+import { Signatory } from "./signatory.js";
+import { Signing } from "./signing.js";
 import { Space } from "./space.js";
 import { Storage } from "./storage.js";
 import { Student } from "./student.js";
@@ -125,6 +127,7 @@ import { Subscription } from "./subscription.js";
 import { Target } from "./target.js";
 import { Task } from "./task.js";
 import { Taxrate } from "./taxrate.js";
+import { Template } from "./template.js";
 import { Ticket } from "./ticket.js";
 import { Ticketing } from "./ticketing.js";
 import { Timeoff } from "./timeoff.js";
@@ -705,6 +708,21 @@ export class UnifiedTo extends ClientSDK {
     return (this._tracking ??= new Tracking(this._options));
   }
 
+  private _signing?: Signing;
+  get signing(): Signing {
+    return (this._signing ??= new Signing(this._options));
+  }
+
+  private _signatory?: Signatory;
+  get signatory(): Signatory {
+    return (this._signatory ??= new Signatory(this._options));
+  }
+
+  private _template?: Template;
+  get template(): Template {
+    return (this._template ??= new Template(this._options));
+  }
+
   private _storage?: Storage;
   get storage(): Storage {
     return (this._storage ??= new Storage(this._options));

package/src/sdk/signatory.ts

@@ -0,0 +1,100 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { signingCreateSigningSignatory } from "../funcs/signingCreateSigningSignatory.js";
+import { signingGetSigningSignatory } from "../funcs/signingGetSigningSignatory.js";
+import { signingListSigningSignatories } from "../funcs/signingListSigningSignatories.js";
+import { signingPatchSigningSignatory } from "../funcs/signingPatchSigningSignatory.js";
+import { signingRemoveSigningSignatory } from "../funcs/signingRemoveSigningSignatory.js";
+import { signingUpdateSigningSignatory } from "../funcs/signingUpdateSigningSignatory.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 Signatory extends ClientSDK {
+  /**
+   * Create a signatory
+   */
+  async createSigningSignatory(
+    request: operations.CreateSigningSignatoryRequest,
+    options?: RequestOptions,
+  ): Promise<shared.SigningSignatory> {
+    return unwrapAsync(signingCreateSigningSignatory(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Retrieve a signatory
+   */
+  async getSigningSignatory(
+    request: operations.GetSigningSignatoryRequest,
+    options?: RequestOptions,
+  ): Promise<shared.SigningSignatory> {
+    return unwrapAsync(signingGetSigningSignatory(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * List all signatories
+   */
+  async listSigningSignatories(
+    request: operations.ListSigningSignatoriesRequest,
+    options?: RequestOptions,
+  ): Promise<Array<shared.SigningSignatory>> {
+    return unwrapAsync(signingListSigningSignatories(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Update a signatory
+   */
+  async patchSigningSignatory(
+    request: operations.PatchSigningSignatoryRequest,
+    options?: RequestOptions,
+  ): Promise<shared.SigningSignatory> {
+    return unwrapAsync(signingPatchSigningSignatory(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Remove a signatory
+   */
+  async removeSigningSignatory(
+    request: operations.RemoveSigningSignatoryRequest,
+    options?: RequestOptions,
+  ): Promise<operations.RemoveSigningSignatoryResponse | undefined> {
+    return unwrapAsync(signingRemoveSigningSignatory(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Update a signatory
+   */
+  async updateSigningSignatory(
+    request: operations.UpdateSigningSignatoryRequest,
+    options?: RequestOptions,
+  ): Promise<shared.SigningSignatory> {
+    return unwrapAsync(signingUpdateSigningSignatory(
+      this,
+      request,
+      options,
+    ));
+  }
+}