@unified-api/typescript-sdk 2.83.35 → 2.83.37

package/src/funcs/signingRemoveSigningSignatory.ts

@@ -0,0 +1,180 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { UnifiedToCore } from "../core.js";
+import { encodeSimple } from "../lib/encodings.js";
+import * as M from "../lib/matchers.js";
+import { compactMap } from "../lib/primitives.js";
+import { safeParse } from "../lib/schemas.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
+import { pathToFunc } from "../lib/url.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../sdk/models/errors/httpclienterrors.js";
+import { ResponseValidationError } from "../sdk/models/errors/responsevalidationerror.js";
+import { SDKValidationError } from "../sdk/models/errors/sdkvalidationerror.js";
+import { UnifiedToError } from "../sdk/models/errors/unifiedtoerror.js";
+import * as operations from "../sdk/models/operations/index.js";
+import { APICall, APIPromise } from "../sdk/types/async.js";
+import { Result } from "../sdk/types/fp.js";
+
+/**
+ * Remove a signatory
+ */
+export function signingRemoveSigningSignatory(
+  client: UnifiedToCore,
+  request: operations.RemoveSigningSignatoryRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    operations.RemoveSigningSignatoryResponse | undefined,
+    | UnifiedToError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: UnifiedToCore,
+  request: operations.RemoveSigningSignatoryRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      operations.RemoveSigningSignatoryResponse | undefined,
+      | UnifiedToError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) =>
+      operations.RemoveSigningSignatoryRequest$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = null;
+
+  const pathParams = {
+    connection_id: encodeSimple("connection_id", payload.connection_id, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+    id: encodeSimple("id", payload.id, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+  };
+  const path = pathToFunc("/signing/{connection_id}/signatory/{id}")(
+    pathParams,
+  );
+
+  const headers = new Headers(compactMap({
+    Accept: "*/*",
+  }));
+
+  const securityInput = await extractSecurity(client._options.security);
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
+  const context = {
+    options: client._options,
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "removeSigningSignatory",
+    oAuth2Scopes: null,
+
+    resolvedSecurity: requestSecurity,
+
+    securitySource: client._options.security,
+    retryConfig: options?.retries
+      || client._options.retryConfig
+      || { strategy: "none" },
+    retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
+  };
+
+  const requestRes = client._createRequest(context, {
+    security: requestSecurity,
+    method: "DELETE",
+    baseURL: options?.serverURL,
+    path: path,
+    headers: headers,
+    body: body,
+    userAgent: client._options.userAgent,
+    timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
+  }, options);
+  if (!requestRes.ok) {
+    return [requestRes, { status: "invalid" }];
+  }
+  const req = requestRes.value;
+
+  const doResult = await client._do(req, {
+    context,
+    errorCodes: ["4XX", "5XX"],
+    retryConfig: context.retryConfig,
+    retryCodes: context.retryCodes,
+  });
+  if (!doResult.ok) {
+    return [doResult, { status: "request-error", request: req }];
+  }
+  const response = doResult.value;
+
+  const responseFields = {
+    HttpMeta: { Response: response, Request: req },
+  };
+
+  const [result] = await M.match<
+    operations.RemoveSigningSignatoryResponse | undefined,
+    | UnifiedToError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.nil(
+      200,
+      operations.RemoveSigningSignatoryResponse$inboundSchema.optional(),
+    ),
+    M.fail("4XX"),
+    M.fail("5XX"),
+    M.nil(
+      "default",
+      operations.RemoveSigningSignatoryResponse$inboundSchema.optional(),
+      { hdrs: true },
+    ),
+  )(response, req, { extraFields: responseFields });
+  if (!result.ok) {
+    return [result, { status: "complete", request: req, response }];
+  }
+
+  return [result, { status: "complete", request: req, response }];
+}

package/src/funcs/signingUpdateSigningSignatory.ts

@@ -0,0 +1,176 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { UnifiedToCore } from "../core.js";
+import { encodeFormQuery, encodeJSON, encodeSimple } from "../lib/encodings.js";
+import * as M from "../lib/matchers.js";
+import { compactMap } from "../lib/primitives.js";
+import { safeParse } from "../lib/schemas.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
+import { pathToFunc } from "../lib/url.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../sdk/models/errors/httpclienterrors.js";
+import { ResponseValidationError } from "../sdk/models/errors/responsevalidationerror.js";
+import { SDKValidationError } from "../sdk/models/errors/sdkvalidationerror.js";
+import { UnifiedToError } from "../sdk/models/errors/unifiedtoerror.js";
+import * as operations from "../sdk/models/operations/index.js";
+import * as shared from "../sdk/models/shared/index.js";
+import { APICall, APIPromise } from "../sdk/types/async.js";
+import { Result } from "../sdk/types/fp.js";
+
+/**
+ * Update a signatory
+ */
+export function signingUpdateSigningSignatory(
+  client: UnifiedToCore,
+  request: operations.UpdateSigningSignatoryRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    shared.SigningSignatory,
+    | UnifiedToError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: UnifiedToCore,
+  request: operations.UpdateSigningSignatoryRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      shared.SigningSignatory,
+      | UnifiedToError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) =>
+      operations.UpdateSigningSignatoryRequest$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = encodeJSON("body", payload.SigningSignatory, { explode: true });
+
+  const pathParams = {
+    connection_id: encodeSimple("connection_id", payload.connection_id, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+    id: encodeSimple("id", payload.id, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+  };
+  const path = pathToFunc("/signing/{connection_id}/signatory/{id}")(
+    pathParams,
+  );
+
+  const query = encodeFormQuery({
+    "fields": payload.fields,
+    "raw": payload.raw,
+  });
+
+  const headers = new Headers(compactMap({
+    "Content-Type": "application/json",
+    Accept: "application/json",
+  }));
+
+  const securityInput = await extractSecurity(client._options.security);
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
+  const context = {
+    options: client._options,
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "updateSigningSignatory",
+    oAuth2Scopes: null,
+
+    resolvedSecurity: requestSecurity,
+
+    securitySource: client._options.security,
+    retryConfig: options?.retries
+      || client._options.retryConfig
+      || { strategy: "none" },
+    retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
+  };
+
+  const requestRes = client._createRequest(context, {
+    security: requestSecurity,
+    method: "PUT",
+    baseURL: options?.serverURL,
+    path: path,
+    headers: headers,
+    query: query,
+    body: body,
+    userAgent: client._options.userAgent,
+    timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
+  }, options);
+  if (!requestRes.ok) {
+    return [requestRes, { status: "invalid" }];
+  }
+  const req = requestRes.value;
+
+  const doResult = await client._do(req, {
+    context,
+    errorCodes: ["4XX", "5XX"],
+    retryConfig: context.retryConfig,
+    retryCodes: context.retryCodes,
+  });
+  if (!doResult.ok) {
+    return [doResult, { status: "request-error", request: req }];
+  }
+  const response = doResult.value;
+
+  const [result] = await M.match<
+    shared.SigningSignatory,
+    | UnifiedToError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, shared.SigningSignatory$inboundSchema),
+    M.fail("4XX"),
+    M.fail("5XX"),
+  )(response, req);
+  if (!result.ok) {
+    return [result, { status: "complete", request: req, response }];
+  }
+
+  return [result, { status: "complete", request: req, response }];
+}

package/src/lib/config.ts

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

package/src/sdk/document.ts

@@ -8,6 +8,12 @@ import { atsListAtsDocuments } from "../funcs/atsListAtsDocuments.js";
 import { atsPatchAtsDocument } from "../funcs/atsPatchAtsDocument.js";
 import { atsRemoveAtsDocument } from "../funcs/atsRemoveAtsDocument.js";
 import { atsUpdateAtsDocument } from "../funcs/atsUpdateAtsDocument.js";
+import { documentCreateSigningDocument } from "../funcs/documentCreateSigningDocument.js";
+import { documentGetSigningDocument } from "../funcs/documentGetSigningDocument.js";
+import { documentListSigningDocuments } from "../funcs/documentListSigningDocuments.js";
+import { documentPatchSigningDocument } from "../funcs/documentPatchSigningDocument.js";
+import { documentRemoveSigningDocument } from "../funcs/documentRemoveSigningDocument.js";
+import { documentUpdateSigningDocument } from "../funcs/documentUpdateSigningDocument.js";
 import { ClientSDK, RequestOptions } from "../lib/sdks.js";
 import * as operations from "./models/operations/index.js";
 import * as shared from "./models/shared/index.js";
@@ -28,6 +34,20 @@ export class Document extends ClientSDK {
     ));
   }
 
+  /**
+   * Create a document
+   */
+  async createSigningDocument(
+    request: operations.CreateSigningDocumentRequest,
+    options?: RequestOptions,
+  ): Promise<shared.SigningDocument> {
+    return unwrapAsync(documentCreateSigningDocument(
+      this,
+      request,
+      options,
+    ));
+  }
+
   /**
    * Retrieve a document
    */
@@ -42,6 +62,20 @@ export class Document extends ClientSDK {
     ));
   }
 
+  /**
+   * Retrieve a document
+   */
+  async getSigningDocument(
+    request: operations.GetSigningDocumentRequest,
+    options?: RequestOptions,
+  ): Promise<shared.SigningDocument> {
+    return unwrapAsync(documentGetSigningDocument(
+      this,
+      request,
+      options,
+    ));
+  }
+
   /**
    * List all documents
    */
@@ -56,6 +90,20 @@ export class Document extends ClientSDK {
     ));
   }
 
+  /**
+   * List all documents
+   */
+  async listSigningDocuments(
+    request: operations.ListSigningDocumentsRequest,
+    options?: RequestOptions,
+  ): Promise<Array<shared.SigningDocument>> {
+    return unwrapAsync(documentListSigningDocuments(
+      this,
+      request,
+      options,
+    ));
+  }
+
   /**
    * Update a document
    */
@@ -70,6 +118,20 @@ export class Document extends ClientSDK {
     ));
   }
 
+  /**
+   * Update a document
+   */
+  async patchSigningDocument(
+    request: operations.PatchSigningDocumentRequest,
+    options?: RequestOptions,
+  ): Promise<shared.SigningDocument> {
+    return unwrapAsync(documentPatchSigningDocument(
+      this,
+      request,
+      options,
+    ));
+  }
+
   /**
    * Remove a document
    */
@@ -84,6 +146,20 @@ export class Document extends ClientSDK {
     ));
   }
 
+  /**
+   * Remove a document
+   */
+  async removeSigningDocument(
+    request: operations.RemoveSigningDocumentRequest,
+    options?: RequestOptions,
+  ): Promise<operations.RemoveSigningDocumentResponse | undefined> {
+    return unwrapAsync(documentRemoveSigningDocument(
+      this,
+      request,
+      options,
+    ));
+  }
+
   /**
    * Update a document
    */
@@ -97,4 +173,18 @@ export class Document extends ClientSDK {
       options,
     ));
   }
+
+  /**
+   * Update a document
+   */
+  async updateSigningDocument(
+    request: operations.UpdateSigningDocumentRequest,
+    options?: RequestOptions,
+  ): Promise<shared.SigningDocument> {
+    return unwrapAsync(documentUpdateSigningDocument(
+      this,
+      request,
+      options,
+    ));
+  }
 }

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

@@ -0,0 +1,86 @@
+/*
+ * 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";
+import * as shared from "../shared/index.js";
+
+export const CreateSigningDocumentQueryParamFields = {
+  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 CreateSigningDocumentQueryParamFields = ClosedEnum<
+  typeof CreateSigningDocumentQueryParamFields
+>;
+
+export type CreateSigningDocumentRequest = {
+  signingDocument: shared.SigningDocument;
+  /**
+   * ID of the connection
+   */
+  connectionId: string;
+  /**
+   * Fields to return
+   */
+  fields?: Array<CreateSigningDocumentQueryParamFields> | 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 CreateSigningDocumentQueryParamFields$outboundSchema:
+  z.ZodNativeEnum<typeof CreateSigningDocumentQueryParamFields> = z.nativeEnum(
+    CreateSigningDocumentQueryParamFields,
+  );
+
+/** @internal */
+export type CreateSigningDocumentRequest$Outbound = {
+  SigningDocument: shared.SigningDocument$Outbound;
+  connection_id: string;
+  fields?: Array<string> | undefined;
+  raw?: string | undefined;
+};
+
+/** @internal */
+export const CreateSigningDocumentRequest$outboundSchema: z.ZodType<
+  CreateSigningDocumentRequest$Outbound,
+  z.ZodTypeDef,
+  CreateSigningDocumentRequest
+> = z.object({
+  signingDocument: shared.SigningDocument$outboundSchema,
+  connectionId: z.string(),
+  fields: z.array(CreateSigningDocumentQueryParamFields$outboundSchema)
+    .optional(),
+  raw: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    signingDocument: "SigningDocument",
+    connectionId: "connection_id",
+  });
+});
+
+export function createSigningDocumentRequestToJSON(
+  createSigningDocumentRequest: CreateSigningDocumentRequest,
+): string {
+  return JSON.stringify(
+    CreateSigningDocumentRequest$outboundSchema.parse(
+      createSigningDocumentRequest,
+    ),
+  );
+}

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

@@ -0,0 +1,84 @@
+/*
+ * 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";
+import * as shared from "../shared/index.js";
+
+export const CreateSigningSignatoryQueryParamFields = {
+  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 CreateSigningSignatoryQueryParamFields = ClosedEnum<
+  typeof CreateSigningSignatoryQueryParamFields
+>;
+
+export type CreateSigningSignatoryRequest = {
+  signingSignatory: shared.SigningSignatory;
+  /**
+   * ID of the connection
+   */
+  connectionId: string;
+  /**
+   * Fields to return
+   */
+  fields?: Array<CreateSigningSignatoryQueryParamFields> | 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 CreateSigningSignatoryQueryParamFields$outboundSchema:
+  z.ZodNativeEnum<typeof CreateSigningSignatoryQueryParamFields> = z.nativeEnum(
+    CreateSigningSignatoryQueryParamFields,
+  );
+
+/** @internal */
+export type CreateSigningSignatoryRequest$Outbound = {
+  SigningSignatory: shared.SigningSignatory$Outbound;
+  connection_id: string;
+  fields?: Array<string> | undefined;
+  raw?: string | undefined;
+};
+
+/** @internal */
+export const CreateSigningSignatoryRequest$outboundSchema: z.ZodType<
+  CreateSigningSignatoryRequest$Outbound,
+  z.ZodTypeDef,
+  CreateSigningSignatoryRequest
+> = z.object({
+  signingSignatory: shared.SigningSignatory$outboundSchema,
+  connectionId: z.string(),
+  fields: z.array(CreateSigningSignatoryQueryParamFields$outboundSchema)
+    .optional(),
+  raw: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    signingSignatory: "SigningSignatory",
+    connectionId: "connection_id",
+  });
+});
+
+export function createSigningSignatoryRequestToJSON(
+  createSigningSignatoryRequest: CreateSigningSignatoryRequest,
+): string {
+  return JSON.stringify(
+    CreateSigningSignatoryRequest$outboundSchema.parse(
+      createSigningSignatoryRequest,
+    ),
+  );
+}