{"_id":"@alohi/signplus-typescript","_rev":"7-2deed1eaf599b49db7c9343bf79bae52","name":"@alohi/signplus-typescript","dist-tags":{"latest":"2.4.0"},"versions":{"2.0.0":{"name":"@alohi/signplus-typescript","version":"2.0.0","keywords":["typescript","sdk","api","client"],"author":{"name":"Sign.Plus"},"license":"MIT","_id":"@alohi/signplus-typescript@2.0.0","maintainers":[{"name":"m.dietrich","email":"m.dietrich@alohi.com"},{"name":"ali.ghasemzadeh","email":"ali@alohi.com"},{"name":"p.belyaev","email":"p.belyaev@alohi.com"}],"dist":{"shasum":"6a4f15e57a46730f4a3b0b91b76b786165b8572e","tarball":"https://registry.npmjs.org/@alohi/signplus-typescript/-/signplus-typescript-2.0.0.tgz","fileCount":1035,"integrity":"sha512-tSA4g12sJPB/VoZotOob0iNB+lfNDhC7GCkRJhS+68kRJ1tU8wyyq/xYCbJ/40jWF7A6j8Q+oieVJiRH08yaEw==","signatures":[{"sig":"MEYCIQCv8JfA7ETKD5lLXxIkf4S3PByix7t8+BVR7AnzReJX0wIhAIByZ0SJkZYyqgjuh075gYmjZWYX1bREfeyqz9odhahz","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":3095504},"main":"./dist/commonjs/index.js","types":"./dist/commonjs/index.d.ts","unpkg":"./dist/index.umd.js","module":"./dist/esm/index.js","source":"./src/index.ts","browser":"./dist/index.umd.js","exports":{".":{"types":"./dist/index.d.ts","import":"./dist/index.js","require":"./dist/index.js"}},"gitHead":"1355d5d4677fc52626e192531c4734e57ef7bcce","scripts":{"build":"npm run build:all","build:all":"npm run build:cjs && npm run build:esm && npm run build:umd","build:cjs":"tsc --module commonjs --outDir dist/commonjs","build:esm":"tsc --module esnext --outDir dist/esm","build:umd":"tsc --module umd --outDir dist/umd","prepublishOnly":"npm run build"},"_npmUser":{"name":"p.belyaev","email":"p.belyaev@alohi.com"},"_npmVersion":"10.8.1","description":"Integrate legally-binding electronic signature to your workflow","directories":{},"_nodeVersion":"20.16.0","dependencies":{"zod":"3.22.0"},"_hasShrinkwrap":false,"devDependencies":{"typescript":"5.3.3"},"_npmOperationalInternal":{"tmp":"tmp/signplus-typescript_2.0.0_1724258435995_0.20292820803108325","host":"s3://npm-registry-packages"}},"1.1.0":{"name":"@alohi/signplus-typescript","version":"1.1.0","keywords":["typescript","sdk","api","client"],"author":{"name":"Sign.Plus"},"license":"MIT","_id":"@alohi/signplus-typescript@1.1.0","maintainers":[{"name":"ali.ghasemzadeh","email":"ali@alohi.com"},{"name":"p.belyaev","email":"p.belyaev@alohi.com"},{"name":"m.dietrich","email":"m.dietrich@alohi.com"}],"dist":{"shasum":"5e582d2a23b1ba8d7fce1938f74d6c62d215c39b","tarball":"https://registry.npmjs.org/@alohi/signplus-typescript/-/signplus-typescript-1.1.0.tgz","fileCount":355,"integrity":"sha512-JdteEx1BMK5gNtcd/lRrtIgujthdcPkhfi5AskbDczatmFiY4k8zPJoFcKgvUEsu2tXQtjj8mZYrdOeqBwmp9A==","signatures":[{"sig":"MEUCIQD6/qE63HUYgUwkitLCceT/oG2WSWAQLBtFEyIuQjYazAIgdF1G46eMcyGm2pLS909wKsnCDzUKJ3MFqpMLlj0upa4=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":1080842},"main":"./dist/index.js","types":"./dist/index.d.ts","unpkg":"./dist/index.js","module":"./dist/index.mjs","source":"./src/index.ts","browser":"./dist/index.js","exports":{".":{"types":"./dist/index.d.ts","import":"./dist/index.js","require":"./dist/index.js"}},"gitHead":"59b6e97845f0c93e5a2612f7d66105cdd6aa1a12","scripts":{"test":"tsc --noEmit","build":"tsc --outDir dist","prepublishOnly":"npm run build"},"_npmUser":{"name":"p.belyaev","email":"p.belyaev@alohi.com"},"_npmVersion":"10.8.2","description":"Integrate legally-binding electronic signature to your workflow","directories":{},"_nodeVersion":"20.18.1","dependencies":{"zod":"3.22.0","axios":"^1.7.4"},"_hasShrinkwrap":false,"devDependencies":{"typescript":"5.3.3"},"_npmOperationalInternal":{"tmp":"tmp/signplus-typescript_1.1.0_1736948753355_0.19046807706069346","host":"s3://npm-registry-packages-npm-production"}},"2.1.0":{"name":"@alohi/signplus-typescript","version":"2.1.0","keywords":["typescript","sdk","api","client"],"author":{"name":"Sign.Plus"},"license":"MIT","_id":"@alohi/signplus-typescript@2.1.0","maintainers":[{"name":"ali.ghasemzadeh","email":"ali@alohi.com"},{"name":"p.belyaev","email":"p.belyaev@alohi.com"},{"name":"m.dietrich","email":"m.dietrich@alohi.com"}],"dist":{"shasum":"c54eec7c947416ad92360ff4214f82afe716bec8","tarball":"https://registry.npmjs.org/@alohi/signplus-typescript/-/signplus-typescript-2.1.0.tgz","fileCount":355,"integrity":"sha512-Ij+ja9lnWu9o98hW/NCOpDSPgOLvGcsaA/Gpav1wNIUcQsOl+gKR3mPRImQHvUNA2vWsYqcN6pIU02F4tTdAJg==","signatures":[{"sig":"MEYCIQDEWPFrwjZ+SEcJaepALyZN3kEdUcfOUeaK7Js9v2k8ogIhAMlSAKBX3QibS4eBRweEOnPm+BwMKWt4RixN0I0mz5Ub","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":1080842},"main":"./dist/index.js","types":"./dist/index.d.ts","unpkg":"./dist/index.js","module":"./dist/index.mjs","source":"./src/index.ts","browser":"./dist/index.js","exports":{".":{"types":"./dist/index.d.ts","import":"./dist/index.js","require":"./dist/index.js"}},"gitHead":"4dfb0b9dfaa070e419b89b56eb2fa77310cc2cdc","scripts":{"test":"tsc --noEmit","build":"tsc --outDir dist","prepublishOnly":"npm run build"},"_npmUser":{"name":"p.belyaev","email":"p.belyaev@alohi.com"},"_npmVersion":"10.8.2","description":"Integrate legally-binding electronic signature to your workflow","directories":{},"_nodeVersion":"20.18.1","dependencies":{"zod":"3.22.0","axios":"^1.7.4"},"_hasShrinkwrap":false,"devDependencies":{"typescript":"5.3.3"},"_npmOperationalInternal":{"tmp":"tmp/signplus-typescript_2.1.0_1736949523218_0.17161352907015326","host":"s3://npm-registry-packages-npm-production"}},"2.2.0":{"name":"@alohi/signplus-typescript","version":"2.2.0","keywords":["typescript","sdk","api","client"],"author":{"name":"Sign.Plus"},"license":"MIT","_id":"@alohi/signplus-typescript@2.2.0","maintainers":[{"name":"ali.ghasemzadeh","email":"ali@alohi.com"},{"name":"p.belyaev","email":"p.belyaev@alohi.com"},{"name":"m.dietrich","email":"m.dietrich@alohi.com"}],"dist":{"shasum":"83cd8a11eda64f3a6b3ef78e1d18f84f9e5edde8","tarball":"https://registry.npmjs.org/@alohi/signplus-typescript/-/signplus-typescript-2.2.0.tgz","fileCount":355,"integrity":"sha512-U1MrEDRWRfIbkuk2EXbyw3XjOYjJcROT7urv0+G5Dnn8DHaUw+iudJNdmkneyW3nEjBPzVvwW5hoX4DAkxe6Ag==","signatures":[{"sig":"MEQCICPJV0tIbOYanVv+B/rrl0QQUQeoWS4mxD29hexglBP9AiBRFdexzvPoFArK8C186CAlklBTVSHJqgvEFFN8/FqcUA==","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":1080998},"main":"./dist/index.js","types":"./dist/index.d.ts","unpkg":"./dist/index.js","module":"./dist/index.mjs","source":"./src/index.ts","browser":"./dist/index.js","exports":{".":{"types":"./dist/index.d.ts","import":"./dist/index.js","require":"./dist/index.js"}},"gitHead":"6da34273a1b8254bc1cd6d69c5b5da0ec25ec52e","scripts":{"test":"tsc --noEmit","build":"tsc --outDir dist","prepublishOnly":"npm run build"},"_npmUser":{"name":"p.belyaev","email":"p.belyaev@alohi.com"},"_npmVersion":"10.8.2","description":"Integrate legally-binding electronic signature to your workflow","directories":{},"_nodeVersion":"20.18.2","dependencies":{"zod":"3.22.0","axios":"^1.7.4"},"_hasShrinkwrap":false,"devDependencies":{"typescript":"5.3.3"},"_npmOperationalInternal":{"tmp":"tmp/signplus-typescript_2.2.0_1738159205216_0.9401927667055152","host":"s3://npm-registry-packages-npm-production"}},"2.3.0":{"name":"@alohi/signplus-typescript","version":"2.3.0","keywords":["typescript","sdk","api","client"],"author":{"name":"Sign.Plus"},"license":"MIT","_id":"@alohi/signplus-typescript@2.3.0","maintainers":[{"name":"ali.ghasemzadeh","email":"ali@alohi.com"},{"name":"p.belyaev","email":"p.belyaev@alohi.com"},{"name":"m.dietrich","email":"m.dietrich@alohi.com"}],"dist":{"shasum":"6a2a3189262a8e2df10495ed86a3cc7f0e371736","tarball":"https://registry.npmjs.org/@alohi/signplus-typescript/-/signplus-typescript-2.3.0.tgz","fileCount":371,"integrity":"sha512-f5ldhMev01dj98SHutgIEMZpUnA4GUAKrVwnyrE5xhUXM9hrAH9HDQobZdF8RVzGiu+eo1xCgqgxaf4Emf6L1w==","signatures":[{"sig":"MEQCIFiPZMZez5Owa2bQg8wVCVEcUeREk3w/wMe5Ck6gl9fXAiAPKuvLdlDvUmXGAP0LLF5Pa1wd5aybi4jC9jjXE5fKWg==","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":1094023},"main":"./dist/index.js","types":"./dist/index.d.ts","unpkg":"./dist/index.js","module":"./dist/index.mjs","source":"./src/index.ts","browser":"./dist/index.js","exports":{".":{"types":"./dist/index.d.ts","import":"./dist/index.js","require":"./dist/index.js"}},"gitHead":"5355022439516a8b52637e44db0b4d00e79f4954","scripts":{"test":"tsc --noEmit","build":"tsc --outDir dist","prepublishOnly":"npm run build"},"_npmUser":{"name":"p.belyaev","email":"p.belyaev@alohi.com"},"_npmVersion":"10.8.2","description":"Integrate legally-binding electronic signature to your workflow","directories":{},"_nodeVersion":"20.19.3","dependencies":{"zod":"3.22.0","axios":"^1.7.4"},"_hasShrinkwrap":false,"devDependencies":{"typescript":"5.3.3","@types/node":"^22.13.9"},"_npmOperationalInternal":{"tmp":"tmp/signplus-typescript_2.3.0_1752571451224_0.8898769010824727","host":"s3://npm-registry-packages-npm-production"}},"2.4.0":{"name":"@alohi/signplus-typescript","version":"2.4.0","keywords":["typescript","sdk","api","client"],"author":{"name":"Sign.Plus"},"license":"MIT","_id":"@alohi/signplus-typescript@2.4.0","maintainers":[{"name":"ali.ghasemzadeh","email":"ali@alohi.com"},{"name":"p.belyaev","email":"p.belyaev@alohi.com"},{"name":"m.dietrich","email":"m.dietrich@alohi.com"}],"dist":{"shasum":"ea534e4d795169947eaa02868be64c87546dc6c4","tarball":"https://registry.npmjs.org/@alohi/signplus-typescript/-/signplus-typescript-2.4.0.tgz","fileCount":403,"integrity":"sha512-Z09e6Rgqw/TqNnKSKEvENLkOTstHt5fBTnK/7Y6jbU9y0qaHhO8SsBP32D/0Tt/4TpKTf8W+7Rsi0+1tJEIVNQ==","signatures":[{"sig":"MEQCIAdt5sofTiURlFgJNGXN5ZRQjzsIkJUytfZJD10TwrfYAiAsLHzmdAkNAHTkKx0KxVwom8L7uryi4iAmDTUYeCPrUA==","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":1388875},"main":"./dist/index.js","types":"./dist/index.d.ts","unpkg":"./dist/index.js","module":"./dist/index.mjs","source":"./src/index.ts","browser":"./dist/index.js","exports":{".":{"types":"./dist/index.d.ts","import":"./dist/index.js","require":"./dist/index.js"}},"gitHead":"be765a856e7e7c915760b239e775d2a7fb9a4470","scripts":{"test":"tsc --noEmit","build":"tsc --outDir dist","prepublishOnly":"npm run build"},"_npmUser":{"name":"p.belyaev","email":"p.belyaev@alohi.com"},"_npmVersion":"10.8.2","description":"Integrate legally-binding electronic signature to your workflow","directories":{},"_nodeVersion":"20.19.5","dependencies":{"zod":"3.22.0","axios":"^1.7.4"},"_hasShrinkwrap":false,"devDependencies":{"typescript":"5.3.3","@types/node":"^22.13.9"},"_npmOperationalInternal":{"tmp":"tmp/signplus-typescript_2.4.0_1758112074599_0.5654501781401546","host":"s3://npm-registry-packages-npm-production"}}},"time":{"created":"2024-08-21T16:40:35.909Z","modified":"2026-01-28T18:05:37.146Z","2.0.0":"2024-08-21T16:40:36.347Z","1.1.0":"2025-01-15T13:45:53.508Z","2.1.0":"2025-01-15T13:58:43.392Z","2.2.0":"2025-01-29T14:00:05.718Z","2.3.0":"2025-07-15T09:24:11.476Z","2.4.0":"2025-09-17T12:27:54.782Z"},"author":{"name":"Sign.Plus"},"license":"MIT","keywords":["typescript","sdk","api","client"],"description":"Integrate legally-binding electronic signature to your workflow","maintainers":[{"email":"ali@alohi.com","name":"ali.ghasemzadeh"},{"email":"p.belyaev@alohi.com","name":"p.belyaev"}],"readme":"# Signplus TypeScript SDK 2.4.0\n\nWelcome to the Signplus SDK documentation. This guide will help you get started with integrating and using the Signplus SDK in your project.\n\n[![This SDK was generated by liblab](https://raw.githubusercontent.com/liblaber/liblab-assets/main/assets/built-by-liblab-icon.svg)](https://liblab.com/?utm_source=readme)\n\n## Versions\n\n- API version: `2.5.0`\n- SDK version: `2.4.0`\n\n## About the API\n\nIntegrate legally-binding electronic signature to your workflow\n\n## Table of Contents\n\n- [Setup & Configuration](#setup--configuration)\n  - [Supported Language Versions](#supported-language-versions)\n  - [Installation](#installation)\n- [Authentication](#authentication)\n  - [Access Token Authentication](#access-token-authentication)\n- [Setting a Custom Timeout](#setting-a-custom-timeout)\n- [Sample Usage](#sample-usage)\n- [Services](#services)\n- [Models](#models)\n- [License](#license)\n\n# Setup & Configuration\n\n## Supported Language Versions\n\nThis SDK is compatible with the following versions: `TypeScript >= 4.8.4`\n\n## Installation\n\nTo get started with the SDK, we recommend installing using `npm`:\n\n```bash\nnpm install @alohi/signplus-typescript\n```\n\n## Authentication\n\n### Access Token Authentication\n\nThe Signplus API uses an Access Token for authentication.\n\nThis token must be provided to authenticate your requests to the API.\n\n#### Setting the Access Token\n\nWhen you initialize the SDK, you can set the access token as follows:\n\n```ts\nconst sdk = new Signplus({ token: 'YOUR_TOKEN' });\n```\n\nIf you need to set or update the access token after initializing the SDK, you can use:\n\n```ts\nconst sdk = new Signplus();\nsdk.token = 'YOUR_TOKEN';\n```\n\n## Setting a Custom Timeout\n\nYou can set a custom timeout for the SDK's HTTP requests as follows:\n\n```ts\nconst signplus = new Signplus({ timeout: 10000 });\n```\n\n# Sample Usage\n\nBelow is a comprehensive example demonstrating how to authenticate and call a simple endpoint:\n\n```ts\nimport { Signplus } from '@alohi/signplus-typescript';\n\n(async () => {\n  const signplus = new Signplus({\n    token: 'YOUR_TOKEN',\n  });\n\n  const { data } = await signplus.signplus.getEnvelope('envelope_id');\n\n  console.log(data);\n})();\n```\n\n## Services\n\nThe SDK provides various services to interact with the API.\n\n<details>\n<summary>Below is a list of all available services with links to their detailed documentation:</summary>\n\n| Name                                                         |\n| :----------------------------------------------------------- |\n| [SignplusService](documentation/services/SignplusService.md) |\n\n</details>\n\n## Models\n\nThe SDK includes several models that represent the data structures used in API requests and responses. These models help in organizing and managing the data efficiently.\n\n<details>\n<summary>Below is a list of all available models with links to their detailed documentation:</summary>\n\n| Name                                                                                                           | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |\n| :------------------------------------------------------------------------------------------------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [CreateEnvelopeRequest](documentation/models/CreateEnvelopeRequest.md)                                         |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |\n| [EnvelopeLegalityLevel](documentation/models/EnvelopeLegalityLevel.md)                                         | Legal level of the envelope (SES is Simple Electronic Signature, QES_EIDAS is Qualified Electronic Signature, QES_ZERTES is Qualified Electronic Signature with Zertes)                                                                                                                                                                                                                                                                                                                   |\n| [Envelope](documentation/models/Envelope.md)                                                                   |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |\n| [EnvelopeFlowType](documentation/models/EnvelopeFlowType.md)                                                   | Flow type of the envelope (REQUEST_SIGNATURE is a request for signature, SIGN_MYSELF is a self-signing flow)                                                                                                                                                                                                                                                                                                                                                                              |\n| [EnvelopeStatus](documentation/models/EnvelopeStatus.md)                                                       | Status of the envelope                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |\n| [SigningStep](documentation/models/SigningStep.md)                                                             |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |\n| [Recipient](documentation/models/Recipient.md)                                                                 |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |\n| [RecipientRole](documentation/models/RecipientRole.md)                                                         | Role of the recipient (SIGNER signs the document, RECEIVES_COPY receives a copy of the document, IN_PERSON_SIGNER signs the document in person, SENDER sends the document)                                                                                                                                                                                                                                                                                                                |\n| [RecipientVerification](documentation/models/RecipientVerification.md)                                         |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |\n| [RecipientVerificationType](documentation/models/RecipientVerificationType.md)                                 | Type of verification the recipient must complete before accessing the envelope. - `PASSCODE`: requires a code to be entered. - `SMS`: sends a code via SMS. - `ID_VERIFICATION`: prompts the recipient to complete an automated ID and selfie check.                                                                                                                                                                                                                                      |\n| [Document](documentation/models/Document.md)                                                                   |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |\n| [Page](documentation/models/Page.md)                                                                           |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |\n| [EnvelopeNotification](documentation/models/EnvelopeNotification.md)                                           |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |\n| [EnvelopeAttachments](documentation/models/EnvelopeAttachments.md)                                             |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |\n| [AttachmentSettings](documentation/models/AttachmentSettings.md)                                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |\n| [AttachmentPlaceholdersPerRecipient](documentation/models/AttachmentPlaceholdersPerRecipient.md)               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |\n| [AttachmentPlaceholder](documentation/models/AttachmentPlaceholder.md)                                         |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |\n| [AttachmentPlaceholderFile](documentation/models/AttachmentPlaceholderFile.md)                                 |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |\n| [CreateEnvelopeFromTemplateRequest](documentation/models/CreateEnvelopeFromTemplateRequest.md)                 |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |\n| [ListEnvelopesRequest](documentation/models/ListEnvelopesRequest.md)                                           |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |\n| [EnvelopeOrderField](documentation/models/EnvelopeOrderField.md)                                               | Field to order envelopes by                                                                                                                                                                                                                                                                                                                                                                                                                                                               |\n| [ListEnvelopesResponse](documentation/models/ListEnvelopesResponse.md)                                         |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |\n| [ListEnvelopeDocumentsResponse](documentation/models/ListEnvelopeDocumentsResponse.md)                         |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |\n| [AddEnvelopeDocumentRequest](documentation/models/AddEnvelopeDocumentRequest.md)                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |\n| [SetEnvelopeDynamicFieldsRequest](documentation/models/SetEnvelopeDynamicFieldsRequest.md)                     |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |\n| [DynamicField](documentation/models/DynamicField.md)                                                           |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |\n| [AddEnvelopeSigningStepsRequest](documentation/models/AddEnvelopeSigningStepsRequest.md)                       |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |\n| [SetEnvelopeAttachmentsSettingsRequest](documentation/models/SetEnvelopeAttachmentsSettingsRequest.md)         |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |\n| [SetEnvelopeAttachmentsPlaceholdersRequest](documentation/models/SetEnvelopeAttachmentsPlaceholdersRequest.md) |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |\n| [AttachmentPlaceholderRequest1](documentation/models/AttachmentPlaceholderRequest1.md)                         |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |\n| [RenameEnvelopeRequest](documentation/models/RenameEnvelopeRequest.md)                                         |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |\n| [SetEnvelopeCommentRequest](documentation/models/SetEnvelopeCommentRequest.md)                                 |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |\n| [SetEnvelopeExpirationRequest](documentation/models/SetEnvelopeExpirationRequest.md)                           |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |\n| [SetEnvelopeLegalityLevelRequest](documentation/models/SetEnvelopeLegalityLevelRequest.md)                     |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |\n| [Annotation](documentation/models/Annotation.md)                                                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |\n| [AnnotationType](documentation/models/AnnotationType.md)                                                       | Type of the annotation                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |\n| [AnnotationSignature](documentation/models/AnnotationSignature.md)                                             | Signature annotation (null if annotation is not a signature)                                                                                                                                                                                                                                                                                                                                                                                                                              |\n| [AnnotationInitials](documentation/models/AnnotationInitials.md)                                               | Initials annotation (null if annotation is not initials)                                                                                                                                                                                                                                                                                                                                                                                                                                  |\n| [AnnotationText](documentation/models/AnnotationText.md)                                                       | Text annotation (null if annotation is not a text)                                                                                                                                                                                                                                                                                                                                                                                                                                        |\n| [AnnotationFont](documentation/models/AnnotationFont.md)                                                       |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |\n| [AnnotationFontFamily](documentation/models/AnnotationFontFamily.md)                                           | Font family of the text                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |\n| [AnnotationDateTime](documentation/models/AnnotationDateTime.md)                                               | Date annotation (null if annotation is not a date)                                                                                                                                                                                                                                                                                                                                                                                                                                        |\n| [AnnotationDateTimeFormat](documentation/models/AnnotationDateTimeFormat.md)                                   | Format of the date time (DMY_NUMERIC_SLASH is day/month/year with slashes, MDY_NUMERIC_SLASH is month/day/year with slashes, YMD_NUMERIC_SLASH is year/month/day with slashes, DMY_NUMERIC_DASH_SHORT is day/month/year with dashes, DMY_NUMERIC_DASH is day/month/year with dashes, YMD_NUMERIC_DASH is year/month/day with dashes, MDY_TEXT_DASH_SHORT is month/day/year with dashes, MDY_TEXT_SPACE_SHORT is month/day/year with spaces, MDY_TEXT_SPACE is month/day/year with spaces) |\n| [AnnotationCheckbox](documentation/models/AnnotationCheckbox.md)                                               | Checkbox annotation (null if annotation is not a checkbox)                                                                                                                                                                                                                                                                                                                                                                                                                                |\n| [AnnotationCheckboxStyle](documentation/models/AnnotationCheckboxStyle.md)                                     | Style of the checkbox                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |\n| [ListEnvelopeDocumentAnnotationsResponse](documentation/models/ListEnvelopeDocumentAnnotationsResponse.md)     |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |\n| [AddAnnotationRequest](documentation/models/AddAnnotationRequest.md)                                           |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |\n| [CreateTemplateRequest](documentation/models/CreateTemplateRequest.md)                                         |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |\n| [Template](documentation/models/Template.md)                                                                   |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |\n| [TemplateSigningStep](documentation/models/TemplateSigningStep.md)                                             |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |\n| [TemplateRecipient](documentation/models/TemplateRecipient.md)                                                 |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |\n| [TemplateRecipientRole](documentation/models/TemplateRecipientRole.md)                                         | Role of the recipient (SIGNER signs the document, RECEIVES_COPY receives a copy of the document, IN_PERSON_SIGNER signs the document in person, SENDER sends the document)                                                                                                                                                                                                                                                                                                                |\n| [ListTemplatesRequest](documentation/models/ListTemplatesRequest.md)                                           |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |\n| [TemplateOrderField](documentation/models/TemplateOrderField.md)                                               | Field to order templates by                                                                                                                                                                                                                                                                                                                                                                                                                                                               |\n| [ListTemplatesResponse](documentation/models/ListTemplatesResponse.md)                                         |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |\n| [AddTemplateDocumentRequest](documentation/models/AddTemplateDocumentRequest.md)                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |\n| [ListTemplateDocumentsResponse](documentation/models/ListTemplateDocumentsResponse.md)                         |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |\n| [AddTemplateSigningStepsRequest](documentation/models/AddTemplateSigningStepsRequest.md)                       |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |\n| [RenameTemplateRequest](documentation/models/RenameTemplateRequest.md)                                         |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |\n| [SetTemplateCommentRequest](documentation/models/SetTemplateCommentRequest.md)                                 |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |\n| [ListTemplateAnnotationsResponse](documentation/models/ListTemplateAnnotationsResponse.md)                     |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |\n| [ListTemplateDocumentAnnotationsResponse](documentation/models/ListTemplateDocumentAnnotationsResponse.md)     |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |\n| [CreateWebhookRequest](documentation/models/CreateWebhookRequest.md)                                           |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |\n| [WebhookEvent](documentation/models/WebhookEvent.md)                                                           | Event of the webhook                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |\n| [Webhook](documentation/models/Webhook.md)                                                                     |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |\n| [ListWebhooksRequest](documentation/models/ListWebhooksRequest.md)                                             |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |\n| [ListWebhooksResponse](documentation/models/ListWebhooksResponse.md)                                           |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |\n\n</details>\n\n## License\n\nThis SDK is licensed under the MIT License.\n\nSee the [LICENSE](LICENSE) file for more details.\n","readmeFilename":"README.md"}