@documenso/sdk-typescript 0.1.1

package/src/sdk/directlink.ts

@@ -0,0 +1,63 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { templatesDirectLinkCreate } from "../funcs/templatesDirectLinkCreate.js";
+import { templatesDirectLinkDelete } from "../funcs/templatesDirectLinkDelete.js";
+import { templatesDirectLinkToggle } from "../funcs/templatesDirectLinkToggle.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export class DirectLink extends ClientSDK {
+  /**
+   * Create direct link
+   *
+   * @remarks
+   * Create a direct link for a template
+   */
+  async create(
+    request: operations.TemplateCreateTemplateDirectLinkRequestBody,
+    options?: RequestOptions,
+  ): Promise<operations.TemplateCreateTemplateDirectLinkResponseBody> {
+    return unwrapAsync(templatesDirectLinkCreate(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Delete direct link
+   *
+   * @remarks
+   * Delete a direct link for a template
+   */
+  async delete(
+    request: operations.TemplateDeleteTemplateDirectLinkRequestBody,
+    options?: RequestOptions,
+  ): Promise<any> {
+    return unwrapAsync(templatesDirectLinkDelete(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Toggle direct link
+   *
+   * @remarks
+   * Enable or disable a direct link for a template
+   */
+  async toggle(
+    request: operations.TemplateToggleTemplateDirectLinkRequestBody,
+    options?: RequestOptions,
+  ): Promise<operations.TemplateToggleTemplateDirectLinkResponseBody> {
+    return unwrapAsync(templatesDirectLinkToggle(
+      this,
+      request,
+      options,
+    ));
+  }
+}

package/src/sdk/documensofields.ts

@@ -0,0 +1,96 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { documentsFieldsCreate } from "../funcs/documentsFieldsCreate.js";
+import { documentsFieldsCreateMany } from "../funcs/documentsFieldsCreateMany.js";
+import { documentsFieldsDelete } from "../funcs/documentsFieldsDelete.js";
+import { documentsFieldsUpdate } from "../funcs/documentsFieldsUpdate.js";
+import { documentsFieldsUpdateMany } from "../funcs/documentsFieldsUpdateMany.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export class DocumensoFields extends ClientSDK {
+  /**
+   * Create document field
+   *
+   * @remarks
+   * Create a single field for a document.
+   */
+  async create(
+    request: operations.FieldCreateDocumentFieldRequestBody,
+    options?: RequestOptions,
+  ): Promise<operations.FieldCreateDocumentFieldResponseBody> {
+    return unwrapAsync(documentsFieldsCreate(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Create document fields
+   *
+   * @remarks
+   * Create multiple fields for a document.
+   */
+  async createMany(
+    request: operations.FieldCreateDocumentFieldsRequestBody,
+    options?: RequestOptions,
+  ): Promise<operations.FieldCreateDocumentFieldsResponseBody> {
+    return unwrapAsync(documentsFieldsCreateMany(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Update document field
+   *
+   * @remarks
+   * Update a single field for a document.
+   */
+  async update(
+    request: operations.FieldUpdateDocumentFieldRequestBody,
+    options?: RequestOptions,
+  ): Promise<operations.FieldUpdateDocumentFieldResponseBody> {
+    return unwrapAsync(documentsFieldsUpdate(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Update document fields
+   *
+   * @remarks
+   * Update multiple fields for a document.
+   */
+  async updateMany(
+    request: operations.FieldUpdateDocumentFieldsRequestBody,
+    options?: RequestOptions,
+  ): Promise<operations.FieldUpdateDocumentFieldsResponseBody> {
+    return unwrapAsync(documentsFieldsUpdateMany(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Delete document field
+   */
+  async delete(
+    request: operations.FieldDeleteDocumentFieldRequestBody,
+    options?: RequestOptions,
+  ): Promise<any> {
+    return unwrapAsync(documentsFieldsDelete(
+      this,
+      request,
+      options,
+    ));
+  }
+}

package/src/sdk/documensorecipients.ts

@@ -0,0 +1,96 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { documentsRecipientsCreate } from "../funcs/documentsRecipientsCreate.js";
+import { documentsRecipientsCreateMany } from "../funcs/documentsRecipientsCreateMany.js";
+import { documentsRecipientsDelete } from "../funcs/documentsRecipientsDelete.js";
+import { documentsRecipientsUpdate } from "../funcs/documentsRecipientsUpdate.js";
+import { documentsRecipientsUpdateMany } from "../funcs/documentsRecipientsUpdateMany.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export class DocumensoRecipients extends ClientSDK {
+  /**
+   * Create document recipient
+   *
+   * @remarks
+   * Create a single recipient for a document.
+   */
+  async create(
+    request: operations.RecipientCreateDocumentRecipientRequestBody,
+    options?: RequestOptions,
+  ): Promise<operations.RecipientCreateDocumentRecipientResponseBody> {
+    return unwrapAsync(documentsRecipientsCreate(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Create document recipients
+   *
+   * @remarks
+   * Create multiple recipients for a document.
+   */
+  async createMany(
+    request: operations.RecipientCreateDocumentRecipientsRequestBody,
+    options?: RequestOptions,
+  ): Promise<operations.RecipientCreateDocumentRecipientsResponseBody> {
+    return unwrapAsync(documentsRecipientsCreateMany(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Update document recipient
+   *
+   * @remarks
+   * Update a single recipient for a document.
+   */
+  async update(
+    request: operations.RecipientUpdateDocumentRecipientRequestBody,
+    options?: RequestOptions,
+  ): Promise<operations.RecipientUpdateDocumentRecipientResponseBody> {
+    return unwrapAsync(documentsRecipientsUpdate(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Update document recipients
+   *
+   * @remarks
+   * Update multiple recipients for a document.
+   */
+  async updateMany(
+    request: operations.RecipientUpdateDocumentRecipientsRequestBody,
+    options?: RequestOptions,
+  ): Promise<operations.RecipientUpdateDocumentRecipientsResponseBody> {
+    return unwrapAsync(documentsRecipientsUpdateMany(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Delete document recipient
+   */
+  async delete(
+    request: operations.RecipientDeleteDocumentRecipientRequestBody,
+    options?: RequestOptions,
+  ): Promise<any> {
+    return unwrapAsync(documentsRecipientsDelete(
+      this,
+      request,
+      options,
+    ));
+  }
+}

package/src/sdk/documensotemplatesfields.ts

@@ -0,0 +1,96 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { templatesFieldsCreate } from "../funcs/templatesFieldsCreate.js";
+import { templatesFieldsCreateMany } from "../funcs/templatesFieldsCreateMany.js";
+import { templatesFieldsDelete } from "../funcs/templatesFieldsDelete.js";
+import { templatesFieldsUpdate } from "../funcs/templatesFieldsUpdate.js";
+import { templatesFieldsUpdateMany } from "../funcs/templatesFieldsUpdateMany.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export class DocumensoTemplatesFields extends ClientSDK {
+  /**
+   * Create template field
+   *
+   * @remarks
+   * Create a single field for a template.
+   */
+  async create(
+    request: operations.FieldCreateTemplateFieldRequestBody,
+    options?: RequestOptions,
+  ): Promise<operations.FieldCreateTemplateFieldResponseBody> {
+    return unwrapAsync(templatesFieldsCreate(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Create template fields
+   *
+   * @remarks
+   * Create multiple fields for a template.
+   */
+  async createMany(
+    request: operations.FieldCreateTemplateFieldsRequestBody,
+    options?: RequestOptions,
+  ): Promise<operations.FieldCreateTemplateFieldsResponseBody> {
+    return unwrapAsync(templatesFieldsCreateMany(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Update template field
+   *
+   * @remarks
+   * Update a single field for a template.
+   */
+  async update(
+    request: operations.FieldUpdateTemplateFieldRequestBody,
+    options?: RequestOptions,
+  ): Promise<operations.FieldUpdateTemplateFieldResponseBody> {
+    return unwrapAsync(templatesFieldsUpdate(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Update template fields
+   *
+   * @remarks
+   * Update multiple fields for a template.
+   */
+  async updateMany(
+    request: operations.FieldUpdateTemplateFieldsRequestBody,
+    options?: RequestOptions,
+  ): Promise<operations.FieldUpdateTemplateFieldsResponseBody> {
+    return unwrapAsync(templatesFieldsUpdateMany(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Delete template field
+   */
+  async delete(
+    request: operations.FieldDeleteTemplateFieldRequestBody,
+    options?: RequestOptions,
+  ): Promise<any> {
+    return unwrapAsync(templatesFieldsDelete(
+      this,
+      request,
+      options,
+    ));
+  }
+}

package/src/sdk/documensotemplatesrecipients.ts

@@ -0,0 +1,96 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { templatesRecipientsCreate } from "../funcs/templatesRecipientsCreate.js";
+import { templatesRecipientsCreateMany } from "../funcs/templatesRecipientsCreateMany.js";
+import { templatesRecipientsDelete } from "../funcs/templatesRecipientsDelete.js";
+import { templatesRecipientsUpdate } from "../funcs/templatesRecipientsUpdate.js";
+import { templatesRecipientsUpdateMany } from "../funcs/templatesRecipientsUpdateMany.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export class DocumensoTemplatesRecipients extends ClientSDK {
+  /**
+   * Create template recipient
+   *
+   * @remarks
+   * Create a single recipient for a template.
+   */
+  async create(
+    request: operations.RecipientCreateTemplateRecipientRequestBody,
+    options?: RequestOptions,
+  ): Promise<operations.RecipientCreateTemplateRecipientResponseBody> {
+    return unwrapAsync(templatesRecipientsCreate(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Create template recipients
+   *
+   * @remarks
+   * Create multiple recipients for a template.
+   */
+  async createMany(
+    request: operations.RecipientCreateTemplateRecipientsRequestBody,
+    options?: RequestOptions,
+  ): Promise<operations.RecipientCreateTemplateRecipientsResponseBody> {
+    return unwrapAsync(templatesRecipientsCreateMany(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Update template recipient
+   *
+   * @remarks
+   * Update a single recipient for a template.
+   */
+  async update(
+    request: operations.RecipientUpdateTemplateRecipientRequestBody,
+    options?: RequestOptions,
+  ): Promise<operations.RecipientUpdateTemplateRecipientResponseBody> {
+    return unwrapAsync(templatesRecipientsUpdate(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Update template recipients
+   *
+   * @remarks
+   * Update multiple recipients for a template.
+   */
+  async updateMany(
+    request: operations.RecipientUpdateTemplateRecipientsRequestBody,
+    options?: RequestOptions,
+  ): Promise<operations.RecipientUpdateTemplateRecipientsResponseBody> {
+    return unwrapAsync(templatesRecipientsUpdateMany(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Delete template recipient
+   */
+  async delete(
+    request: operations.RecipientDeleteTemplateRecipientRequestBody,
+    options?: RequestOptions,
+  ): Promise<any> {
+    return unwrapAsync(templatesRecipientsDelete(
+      this,
+      request,
+      options,
+    ));
+  }
+}

package/src/sdk/documents.ts

@@ -0,0 +1,174 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { documentsCreateV0 } from "../funcs/documentsCreateV0.js";
+import { documentsDelete } from "../funcs/documentsDelete.js";
+import { documentsDistribute } from "../funcs/documentsDistribute.js";
+import { documentsDuplicate } from "../funcs/documentsDuplicate.js";
+import { documentsFind } from "../funcs/documentsFind.js";
+import { documentsGet } from "../funcs/documentsGet.js";
+import { documentsMoveToTeam } from "../funcs/documentsMoveToTeam.js";
+import { documentsRedistribute } from "../funcs/documentsRedistribute.js";
+import { documentsUpdate } from "../funcs/documentsUpdate.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+import { DocumensoFields } from "./documensofields.js";
+import { DocumensoRecipients } from "./documensorecipients.js";
+
+export class Documents extends ClientSDK {
+  private _fields?: DocumensoFields;
+  get fields(): DocumensoFields {
+    return (this._fields ??= new DocumensoFields(this._options));
+  }
+
+  private _recipients?: DocumensoRecipients;
+  get recipients(): DocumensoRecipients {
+    return (this._recipients ??= new DocumensoRecipients(this._options));
+  }
+
+  /**
+   * Find documents
+   *
+   * @remarks
+   * Find documents based on a search criteria
+   */
+  async find(
+    request: operations.DocumentFindDocumentsRequest,
+    options?: RequestOptions,
+  ): Promise<operations.DocumentFindDocumentsResponseBody> {
+    return unwrapAsync(documentsFind(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Get document
+   *
+   * @remarks
+   * Returns a document given an ID
+   */
+  async get(
+    request: operations.DocumentGetDocumentWithDetailsByIdRequest,
+    options?: RequestOptions,
+  ): Promise<operations.DocumentGetDocumentWithDetailsByIdResponseBody> {
+    return unwrapAsync(documentsGet(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Create document
+   *
+   * @remarks
+   * You will need to upload the PDF to the provided URL returned. Note: Once V2 API is released, this will be removed since we will allow direct uploads, instead of using an upload URL.
+   */
+  async createV0(
+    request: operations.DocumentCreateDocumentTemporaryRequestBody,
+    options?: RequestOptions,
+  ): Promise<operations.DocumentCreateDocumentTemporaryResponseBody> {
+    return unwrapAsync(documentsCreateV0(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Update document
+   */
+  async update(
+    request: operations.DocumentSetSettingsForDocumentRequestBody,
+    options?: RequestOptions,
+  ): Promise<operations.DocumentSetSettingsForDocumentResponseBody> {
+    return unwrapAsync(documentsUpdate(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Delete document
+   */
+  async delete(
+    request: operations.DocumentDeleteDocumentRequestBody,
+    options?: RequestOptions,
+  ): Promise<any> {
+    return unwrapAsync(documentsDelete(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Move document
+   *
+   * @remarks
+   * Move a document from your personal account to a team
+   */
+  async moveToTeam(
+    request: operations.DocumentMoveDocumentToTeamRequestBody,
+    options?: RequestOptions,
+  ): Promise<operations.DocumentMoveDocumentToTeamResponseBody> {
+    return unwrapAsync(documentsMoveToTeam(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Distribute document
+   *
+   * @remarks
+   * Send the document out to recipients based on your distribution method
+   */
+  async distribute(
+    request: operations.DocumentSendDocumentRequestBody,
+    options?: RequestOptions,
+  ): Promise<operations.DocumentSendDocumentResponseBody> {
+    return unwrapAsync(documentsDistribute(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Redistribute document
+   *
+   * @remarks
+   * Redistribute the document to the provided recipients who have not actioned the document. Will use the distribution method set in the document
+   */
+  async redistribute(
+    request: operations.DocumentResendDocumentRequestBody,
+    options?: RequestOptions,
+  ): Promise<any> {
+    return unwrapAsync(documentsRedistribute(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Duplicate document
+   */
+  async duplicate(
+    request: operations.DocumentDuplicateDocumentRequestBody,
+    options?: RequestOptions,
+  ): Promise<operations.DocumentDuplicateDocumentResponseBody> {
+    return unwrapAsync(documentsDuplicate(
+      this,
+      request,
+      options,
+    ));
+  }
+}

package/src/sdk/fields.ts

@@ -0,0 +1,27 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { fieldsGet } from "../funcs/fieldsGet.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export class Fields extends ClientSDK {
+  /**
+   * Get field
+   *
+   * @remarks
+   * Returns a single field. If you want to retrieve all the fields for a document or template, use the "Get Document" or "Get Template" request.
+   */
+  async get(
+    request: operations.FieldGetFieldRequest,
+    options?: RequestOptions,
+  ): Promise<operations.FieldGetFieldResponseBody> {
+    return unwrapAsync(fieldsGet(
+      this,
+      request,
+      options,
+    ));
+  }
+}

package/src/sdk/index.ts

@@ -0,0 +1,5 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+export * from "./sdk.js";

package/src/sdk/recipients.ts

@@ -0,0 +1,27 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { recipientsGet } from "../funcs/recipientsGet.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export class Recipients extends ClientSDK {
+  /**
+   * Get recipient
+   *
+   * @remarks
+   * Returns a single recipient. If you want to retrieve all the recipients for a document or template, use the "Get Document" or "Get Template" request.
+   */
+  async get(
+    request: operations.RecipientGetRecipientRequest,
+    options?: RequestOptions,
+  ): Promise<operations.RecipientGetRecipientResponseBody> {
+    return unwrapAsync(recipientsGet(
+      this,
+      request,
+      options,
+    ));
+  }
+}