@breadstone/archipel-mcp 0.0.1 → 0.0.3

package/data/packages/platform-esigning/api/Variable.ESIGNING_API_BASE_URL.md

@@ -0,0 +1,15 @@
+---
+title: 'Variable: ESIGNING\_API\_BASE\_URL'
+generated: true
+editUrl: false
+---
+
+# Variable: ESIGNING_API_BASE_URL
+
+```ts
+const ESIGNING_API_BASE_URL: IConfigKey<string>;
+```
+
+Defined in: [env.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/env.ts#L18)
+
+Active e-signing provider base URL.

package/data/packages/platform-esigning/api/Variable.ESIGNING_API_KEY.md

@@ -0,0 +1,15 @@
+---
+title: 'Variable: ESIGNING\_API\_KEY'
+generated: true
+editUrl: false
+---
+
+# Variable: ESIGNING_API_KEY
+
+```ts
+const ESIGNING_API_KEY: IConfigKey<string>;
+```
+
+Defined in: [env.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/env.ts#L12)
+
+Active e-signing provider API key.

package/data/packages/platform-esigning/api/Variable.ESIGNING_PROVIDER.md

@@ -0,0 +1,13 @@
+---
+title: 'Variable: ESIGNING\_PROVIDER'
+generated: true
+editUrl: false
+---
+
+# Variable: ESIGNING_PROVIDER
+
+```ts
+const ESIGNING_PROVIDER: typeof ESIGNING_PROVIDER;
+```
+
+Defined in: [tokens.ts:3](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/tokens.ts#L3)

package/data/packages/platform-esigning/api/Variable.ESIGNING_PROVIDER_OPTIONS.md

@@ -0,0 +1,13 @@
+---
+title: 'Variable: ESIGNING\_PROVIDER\_OPTIONS'
+generated: true
+editUrl: false
+---
+
+# Variable: ESIGNING_PROVIDER_OPTIONS
+
+```ts
+const ESIGNING_PROVIDER_OPTIONS: typeof ESIGNING_PROVIDER_OPTIONS;
+```
+
+Defined in: [tokens.ts:4](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/tokens.ts#L4)

package/data/packages/platform-esigning/api/Variable.ESIGNING_WEBHOOK_SECRET.md

@@ -0,0 +1,15 @@
+---
+title: 'Variable: ESIGNING\_WEBHOOK\_SECRET'
+generated: true
+editUrl: false
+---
+
+# Variable: ESIGNING_WEBHOOK_SECRET
+
+```ts
+const ESIGNING_WEBHOOK_SECRET: IConfigKey<string>;
+```
+
+Defined in: [env.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/env.ts#L15)
+
+Active e-signing provider webhook signing secret.

package/data/packages/platform-esigning/api/Variable.PLATFORM_ESIGNING_CONFIG_ENTRIES.md

@@ -0,0 +1,15 @@
+---
+title: 'Variable: PLATFORM\_ESIGNING\_CONFIG\_ENTRIES'
+generated: true
+editUrl: false
+---
+
+# Variable: PLATFORM_ESIGNING_CONFIG_ENTRIES
+
+```ts
+const PLATFORM_ESIGNING_CONFIG_ENTRIES: ReadonlyArray<Omit<IConfigRegistryEntry, 'module'>>;
+```
+
+Defined in: [env.ts:25](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/env.ts#L25)
+
+All configuration entries required by `platform-esigning`.

package/data/packages/platform-esigning/api/Variable.SIGNNOW_API_KEY.md

@@ -0,0 +1,15 @@
+---
+title: 'Variable: SIGNNOW\_API\_KEY'
+generated: true
+editUrl: false
+---
+
+# Variable: SIGNNOW_API_KEY
+
+```ts
+const SIGNNOW_API_KEY: IConfigKey<string>;
+```
+
+Defined in: [signnow/env.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/signnow/env.ts#L12)
+
+signNow API key (basic token).

package/data/packages/platform-esigning/api/Variable.SIGNNOW_BASE_URL.md

@@ -0,0 +1,15 @@
+---
+title: 'Variable: SIGNNOW\_BASE\_URL'
+generated: true
+editUrl: false
+---
+
+# Variable: SIGNNOW_BASE_URL
+
+```ts
+const SIGNNOW_BASE_URL: IConfigKey<string>;
+```
+
+Defined in: [signnow/env.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/signnow/env.ts#L21)
+
+signNow base URL.

package/data/packages/platform-esigning/api/Variable.SIGNNOW_CLIENT_ID.md

@@ -0,0 +1,15 @@
+---
+title: 'Variable: SIGNNOW\_CLIENT\_ID'
+generated: true
+editUrl: false
+---
+
+# Variable: SIGNNOW_CLIENT_ID
+
+```ts
+const SIGNNOW_CLIENT_ID: IConfigKey<string>;
+```
+
+Defined in: [signnow/env.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/signnow/env.ts#L15)
+
+signNow client ID.

package/data/packages/platform-esigning/api/Variable.SIGNNOW_CLIENT_SECRET.md

@@ -0,0 +1,15 @@
+---
+title: 'Variable: SIGNNOW\_CLIENT\_SECRET'
+generated: true
+editUrl: false
+---
+
+# Variable: SIGNNOW_CLIENT_SECRET
+
+```ts
+const SIGNNOW_CLIENT_SECRET: IConfigKey<string>;
+```
+
+Defined in: [signnow/env.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/signnow/env.ts#L18)
+
+signNow client secret.

package/data/packages/platform-esigning/api/Variable.SIGNNOW_CONFIG_ENTRIES.md

@@ -0,0 +1,15 @@
+---
+title: 'Variable: SIGNNOW\_CONFIG\_ENTRIES'
+generated: true
+editUrl: false
+---
+
+# Variable: SIGNNOW_CONFIG_ENTRIES
+
+```ts
+const SIGNNOW_CONFIG_ENTRIES: ReadonlyArray<Omit<IConfigRegistryEntry, 'module'>>;
+```
+
+Defined in: [signnow/env.ts:31](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/signnow/env.ts#L31)
+
+Configuration entries required by the signNow e-signing provider.

package/data/packages/platform-esigning/api/Variable.SIGNNOW_WEBHOOK_SECRET.md

@@ -0,0 +1,15 @@
+---
+title: 'Variable: SIGNNOW\_WEBHOOK\_SECRET'
+generated: true
+editUrl: false
+---
+
+# Variable: SIGNNOW_WEBHOOK_SECRET
+
+```ts
+const SIGNNOW_WEBHOOK_SECRET: IConfigKey<string>;
+```
+
+Defined in: [signnow/env.ts:24](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/signnow/env.ts#L24)
+
+signNow webhook callback secret.

package/data/packages/platform-esigning/api/Variable.SignerRoles.md

@@ -0,0 +1,31 @@
+---
+title: 'Variable: SignerRoles'
+generated: true
+editUrl: false
+---
+
+# Variable: SignerRoles
+
+```ts
+const SignerRoles: {
+  Approver: 'approver';
+  CarbonCopy: 'carbon-copy';
+  InPersonSigner: 'in-person-signer';
+  Signer: 'signer';
+  Witness: 'witness';
+};
+```
+
+Defined in: [models/SignerRole.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/SignerRole.ts#L6)
+
+Represents the role of a signer in a signing request.
+
+## Type Declaration
+
+| Name                                                  | Type                 | Default value        | Defined in                                                                                                                       |
+| ----------------------------------------------------- | -------------------- | -------------------- | -------------------------------------------------------------------------------------------------------------------------------- |
+| <a id="property-approver"></a> `Approver`             | `"approver"`         | `'approver'`         | [models/SignerRole.ts:10](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/SignerRole.ts#L10) |
+| <a id="property-carboncopy"></a> `CarbonCopy`         | `"carbon-copy"`      | `'carbon-copy'`      | [models/SignerRole.ts:8](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/SignerRole.ts#L8)   |
+| <a id="property-inpersonsigner"></a> `InPersonSigner` | `"in-person-signer"` | `'in-person-signer'` | [models/SignerRole.ts:9](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/SignerRole.ts#L9)   |
+| <a id="property-signer"></a> `Signer`                 | `"signer"`           | `'signer'`           | [models/SignerRole.ts:7](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/SignerRole.ts#L7)   |
+| <a id="property-witness"></a> `Witness`               | `"witness"`          | `'witness'`          | [models/SignerRole.ts:11](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/SignerRole.ts#L11) |

package/data/packages/platform-esigning/api/Variable.SignerStatuses.md

@@ -0,0 +1,33 @@
+---
+title: 'Variable: SignerStatuses'
+generated: true
+editUrl: false
+---
+
+# Variable: SignerStatuses
+
+```ts
+const SignerStatuses: {
+  Declined: 'declined';
+  Delivered: 'delivered';
+  Expired: 'expired';
+  Pending: 'pending';
+  Sent: 'sent';
+  Signed: 'signed';
+};
+```
+
+Defined in: [models/SignerStatus.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/SignerStatus.ts#L6)
+
+Represents the status of an individual signer within a signing request.
+
+## Type Declaration
+
+| Name                                        | Type          | Default value | Defined in                                                                                                                           |
+| ------------------------------------------- | ------------- | ------------- | ------------------------------------------------------------------------------------------------------------------------------------ |
+| <a id="property-declined"></a> `Declined`   | `"declined"`  | `'declined'`  | [models/SignerStatus.ts:11](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/SignerStatus.ts#L11) |
+| <a id="property-delivered"></a> `Delivered` | `"delivered"` | `'delivered'` | [models/SignerStatus.ts:9](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/SignerStatus.ts#L9)   |
+| <a id="property-expired"></a> `Expired`     | `"expired"`   | `'expired'`   | [models/SignerStatus.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/SignerStatus.ts#L12) |
+| <a id="property-pending"></a> `Pending`     | `"pending"`   | `'pending'`   | [models/SignerStatus.ts:7](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/SignerStatus.ts#L7)   |
+| <a id="property-sent"></a> `Sent`           | `"sent"`      | `'sent'`      | [models/SignerStatus.ts:8](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/SignerStatus.ts#L8)   |
+| <a id="property-signed"></a> `Signed`       | `"signed"`    | `'signed'`    | [models/SignerStatus.ts:10](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/SignerStatus.ts#L10) |

package/data/packages/platform-esigning/api/Variable.SigningFieldTypes.md

@@ -0,0 +1,39 @@
+---
+title: 'Variable: SigningFieldTypes'
+generated: true
+editUrl: false
+---
+
+# Variable: SigningFieldTypes
+
+```ts
+const SigningFieldTypes: {
+  Checkbox: 'checkbox';
+  Company: 'company';
+  DateSigned: 'date-signed';
+  Email: 'email';
+  Initials: 'initials';
+  Name: 'name';
+  Signature: 'signature';
+  Text: 'text';
+  Title: 'title';
+};
+```
+
+Defined in: [models/SigningFieldType.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/SigningFieldType.ts#L6)
+
+Represents the type of a signing field placed on a document.
+
+## Type Declaration
+
+| Name                                          | Type            | Default value   | Defined in                                                                                                                                   |
+| --------------------------------------------- | --------------- | --------------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
+| <a id="property-checkbox"></a> `Checkbox`     | `"checkbox"`    | `'checkbox'`    | [models/SigningFieldType.ts:11](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/SigningFieldType.ts#L11) |
+| <a id="property-company"></a> `Company`       | `"company"`     | `'company'`     | [models/SigningFieldType.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/SigningFieldType.ts#L14) |
+| <a id="property-datesigned"></a> `DateSigned` | `"date-signed"` | `'date-signed'` | [models/SigningFieldType.ts:9](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/SigningFieldType.ts#L9)   |
+| <a id="property-email"></a> `Email`           | `"email"`       | `'email'`       | [models/SigningFieldType.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/SigningFieldType.ts#L13) |
+| <a id="property-initials"></a> `Initials`     | `"initials"`    | `'initials'`    | [models/SigningFieldType.ts:8](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/SigningFieldType.ts#L8)   |
+| <a id="property-name"></a> `Name`             | `"name"`        | `'name'`        | [models/SigningFieldType.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/SigningFieldType.ts#L12) |
+| <a id="property-signature"></a> `Signature`   | `"signature"`   | `'signature'`   | [models/SigningFieldType.ts:7](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/SigningFieldType.ts#L7)   |
+| <a id="property-text"></a> `Text`             | `"text"`        | `'text'`        | [models/SigningFieldType.ts:10](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/SigningFieldType.ts#L10) |
+| <a id="property-title"></a> `Title`           | `"title"`       | `'title'`       | [models/SigningFieldType.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/SigningFieldType.ts#L15) |

package/data/packages/platform-esigning/api/Variable.SigningRequestStatuses.md

@@ -0,0 +1,37 @@
+---
+title: 'Variable: SigningRequestStatuses'
+generated: true
+editUrl: false
+---
+
+# Variable: SigningRequestStatuses
+
+```ts
+const SigningRequestStatuses: {
+  Cancelled: 'cancelled';
+  Completed: 'completed';
+  Declined: 'declined';
+  Draft: 'draft';
+  Expired: 'expired';
+  InProgress: 'in-progress';
+  Sent: 'sent';
+  Voided: 'voided';
+};
+```
+
+Defined in: [models/SigningRequestStatus.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/SigningRequestStatus.ts#L6)
+
+Represents the lifecycle status of a signing request.
+
+## Type Declaration
+
+| Name                                          | Type            | Default value   | Defined in                                                                                                                                           |
+| --------------------------------------------- | --------------- | --------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- |
+| <a id="property-cancelled"></a> `Cancelled`   | `"cancelled"`   | `'cancelled'`   | [models/SigningRequestStatus.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/SigningRequestStatus.ts#L12) |
+| <a id="property-completed"></a> `Completed`   | `"completed"`   | `'completed'`   | [models/SigningRequestStatus.ts:10](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/SigningRequestStatus.ts#L10) |
+| <a id="property-declined"></a> `Declined`     | `"declined"`    | `'declined'`    | [models/SigningRequestStatus.ts:11](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/SigningRequestStatus.ts#L11) |
+| <a id="property-draft"></a> `Draft`           | `"draft"`       | `'draft'`       | [models/SigningRequestStatus.ts:7](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/SigningRequestStatus.ts#L7)   |
+| <a id="property-expired"></a> `Expired`       | `"expired"`     | `'expired'`     | [models/SigningRequestStatus.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/SigningRequestStatus.ts#L13) |
+| <a id="property-inprogress"></a> `InProgress` | `"in-progress"` | `'in-progress'` | [models/SigningRequestStatus.ts:9](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/SigningRequestStatus.ts#L9)   |
+| <a id="property-sent"></a> `Sent`             | `"sent"`        | `'sent'`        | [models/SigningRequestStatus.ts:8](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/SigningRequestStatus.ts#L8)   |
+| <a id="property-voided"></a> `Voided`         | `"voided"`      | `'voided'`      | [models/SigningRequestStatus.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/SigningRequestStatus.ts#L14) |

package/data/packages/platform-esigning/api/Variable.WebhookEventTypes.md

@@ -0,0 +1,39 @@
+---
+title: 'Variable: WebhookEventTypes'
+generated: true
+editUrl: false
+---
+
+# Variable: WebhookEventTypes
+
+```ts
+const WebhookEventTypes: {
+  SignerCompleted: 'signer.completed';
+  SignerDeclined: 'signer.declined';
+  SignerDelivered: 'signer.delivered';
+  SignerSent: 'signer.sent';
+  SigningRequestCompleted: 'signing-request.completed';
+  SigningRequestDeclined: 'signing-request.declined';
+  SigningRequestExpired: 'signing-request.expired';
+  SigningRequestSent: 'signing-request.sent';
+  SigningRequestVoided: 'signing-request.voided';
+};
+```
+
+Defined in: [models/WebhookEventType.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/WebhookEventType.ts#L6)
+
+Represents the type of webhook event emitted by a signing provider.
+
+## Type Declaration
+
+| Name                                                                    | Type                          | Default value                 | Defined in                                                                                                                                   |
+| ----------------------------------------------------------------------- | ----------------------------- | ----------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
+| <a id="property-signercompleted"></a> `SignerCompleted`                 | `"signer.completed"`          | `'signer.completed'`          | [models/WebhookEventType.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/WebhookEventType.ts#L12) |
+| <a id="property-signerdeclined"></a> `SignerDeclined`                   | `"signer.declined"`           | `'signer.declined'`           | [models/WebhookEventType.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/WebhookEventType.ts#L13) |
+| <a id="property-signerdelivered"></a> `SignerDelivered`                 | `"signer.delivered"`          | `'signer.delivered'`          | [models/WebhookEventType.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/WebhookEventType.ts#L15) |
+| <a id="property-signersent"></a> `SignerSent`                           | `"signer.sent"`               | `'signer.sent'`               | [models/WebhookEventType.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/WebhookEventType.ts#L14) |
+| <a id="property-signingrequestcompleted"></a> `SigningRequestCompleted` | `"signing-request.completed"` | `'signing-request.completed'` | [models/WebhookEventType.ts:7](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/WebhookEventType.ts#L7)   |
+| <a id="property-signingrequestdeclined"></a> `SigningRequestDeclined`   | `"signing-request.declined"`  | `'signing-request.declined'`  | [models/WebhookEventType.ts:8](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/WebhookEventType.ts#L8)   |
+| <a id="property-signingrequestexpired"></a> `SigningRequestExpired`     | `"signing-request.expired"`   | `'signing-request.expired'`   | [models/WebhookEventType.ts:10](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/WebhookEventType.ts#L10) |
+| <a id="property-signingrequestsent"></a> `SigningRequestSent`           | `"signing-request.sent"`      | `'signing-request.sent'`      | [models/WebhookEventType.ts:11](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/WebhookEventType.ts#L11) |
+| <a id="property-signingrequestvoided"></a> `SigningRequestVoided`       | `"signing-request.voided"`    | `'signing-request.voided'`    | [models/WebhookEventType.ts:9](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/WebhookEventType.ts#L9)   |

package/data/packages/platform-esigning/api/index.md

@@ -0,0 +1,85 @@
+---
+title: '@breadstone/archipel-platform-esigning'
+generated: true
+editUrl: false
+---
+
+# @breadstone/archipel-platform-esigning
+
+## Classes
+
+| Class                                                            | Description                                                                                                                                                                                                                              |
+| ---------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| [EsigningClientPort](Class.EsigningClientPort)                   | Abstract port for e-signing provider clients. Each provider (DocuSign, Adobe Sign, Dropbox Sign, signNow, Internal) must implement this contract so that the consuming application can switch providers without changing business logic. |
+| [EsigningError](Class.EsigningError)                             | Base error for all e-signing related failures.                                                                                                                                                                                           |
+| [EsigningModule](Class.EsigningModule)                           | NestJS module providing generic e-signing infrastructure. Exposes a configurable signing client and optional persistence tracking. The specific e-signing provider is selected via the options.                                          |
+| [EsigningPersistencePort](Class.EsigningPersistencePort)         | Abstract port for persisting signing request state. Implement this port in the consuming application to track signing requests in a database.                                                                                            |
+| [EsigningService](Class.EsigningService)                         | Application-level service for e-signing operations. Delegates to the configured [EsigningClientPort](Class.EsigningClientPort) and optionally invokes the [EsigningPersistencePort](Class.EsigningPersistencePort) for state tracking.   |
+| [InternalEsigningProvider](Class.InternalEsigningProvider)       | Built-in e-signing provider that manages signing requests in-memory. This provider fulfills the same contract as external providers and can be used for development, testing, or simple self-managed signing workflows.                  |
+| [SigningProviderError](Class.SigningProviderError)               | Thrown when a provider-level operation fails.                                                                                                                                                                                            |
+| [SigningRequestNotFoundError](Class.SigningRequestNotFoundError) | Thrown when a signing request cannot be found by the provider.                                                                                                                                                                           |
+| [WebhookVerificationError](Class.WebhookVerificationError)       | Thrown when a webhook signature verification fails.                                                                                                                                                                                      |
+
+## Interfaces
+
+| Interface                                                                | Description                                                                |
+| ------------------------------------------------------------------------ | -------------------------------------------------------------------------- |
+| [ICreateSigningRequest](Interface.ICreateSigningRequest)                 | Input for creating a new signing request.                                  |
+| [ICreateSigningRequestDocument](Interface.ICreateSigningRequestDocument) | A document to include when creating a signing request.                     |
+| [ICreateSigningRequestSigner](Interface.ICreateSigningRequestSigner)     | A signer to include when creating a signing request.                       |
+| [ICreateSigningSessionRequest](Interface.ICreateSigningSessionRequest)   | Input for creating a signing session (signing link) for a specific signer. |
+| [IEsigningModuleOptions](Interface.IEsigningModuleOptions)               | Configuration options for the [EsigningModule](Class.EsigningModule).      |
+| [IEsigningWebhookEvent](Interface.IEsigningWebhookEvent)                 | Normalized representation of a webhook event from an e-signing provider.   |
+| [ISignedDocument](Interface.ISignedDocument)                             | Normalized representation of a signed (completed) document.                |
+| [ISigner](Interface.ISigner)                                             | Normalized representation of a signer participating in a signing request.  |
+| [ISigningDocument](Interface.ISigningDocument)                           | Normalized representation of a document within a signing request.          |
+| [ISigningField](Interface.ISigningField)                                 | Normalized representation of a signing field placed on a document.         |
+| [ISigningRequest](Interface.ISigningRequest)                             | Normalized representation of a signing request (envelope/agreement).       |
+| [ISigningSession](Interface.ISigningSession)                             | Normalized representation of a signing session or signing link.            |
+
+## Type Aliases
+
+| Type Alias                                             | Description                                                                        |
+| ------------------------------------------------------ | ---------------------------------------------------------------------------------- |
+| [SignerRole](TypeAlias.SignerRole)                     | Union type derived from [SignerRoles](Variable.SignerRoles).                       |
+| [SignerStatus](TypeAlias.SignerStatus)                 | Union type derived from [SignerStatuses](Variable.SignerStatuses).                 |
+| [SigningFieldType](TypeAlias.SigningFieldType)         | Union type derived from [SigningFieldTypes](Variable.SigningFieldTypes).           |
+| [SigningRequestStatus](TypeAlias.SigningRequestStatus) | Union type derived from [SigningRequestStatuses](Variable.SigningRequestStatuses). |
+| [WebhookEventType](TypeAlias.WebhookEventType)         | Union type derived from [WebhookEventTypes](Variable.WebhookEventTypes).           |
+
+## Variables
+
+| Variable                                                                      | Description                                                             |
+| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------- |
+| [ADOBE_SIGN_BASE_URL](Variable.ADOBE_SIGN_BASE_URL)                           | Adobe Sign base URL.                                                    |
+| [ADOBE_SIGN_CLIENT_SECRET](Variable.ADOBE_SIGN_CLIENT_SECRET)                 | Adobe Sign client secret.                                               |
+| [ADOBE_SIGN_CONFIG_ENTRIES](Variable.ADOBE_SIGN_CONFIG_ENTRIES)               | Configuration entries required by the Adobe Sign e-signing provider.    |
+| [ADOBE_SIGN_INTEGRATION_KEY](Variable.ADOBE_SIGN_INTEGRATION_KEY)             | Adobe Sign integration key.                                             |
+| [ADOBE_SIGN_WEBHOOK_CLIENT_ID](Variable.ADOBE_SIGN_WEBHOOK_CLIENT_ID)         | Adobe Sign webhook client ID for verification.                          |
+| [DOCUSIGN_ACCOUNT_ID](Variable.DOCUSIGN_ACCOUNT_ID)                           | DocuSign account ID.                                                    |
+| [DOCUSIGN_BASE_URL](Variable.DOCUSIGN_BASE_URL)                               | DocuSign base URL (e.g. https://demo.docusign.net for sandbox).         |
+| [DOCUSIGN_CONFIG_ENTRIES](Variable.DOCUSIGN_CONFIG_ENTRIES)                   | Configuration entries required by the DocuSign e-signing provider.      |
+| [DOCUSIGN_INTEGRATION_KEY](Variable.DOCUSIGN_INTEGRATION_KEY)                 | DocuSign integration key (client ID).                                   |
+| [DOCUSIGN_SECRET_KEY](Variable.DOCUSIGN_SECRET_KEY)                           | DocuSign secret key (client secret).                                    |
+| [DOCUSIGN_WEBHOOK_HMAC_KEY](Variable.DOCUSIGN_WEBHOOK_HMAC_KEY)               | DocuSign webhook HMAC key.                                              |
+| [DROPBOX_SIGN_API_KEY](Variable.DROPBOX_SIGN_API_KEY)                         | Dropbox Sign API key.                                                   |
+| [DROPBOX_SIGN_CLIENT_ID](Variable.DROPBOX_SIGN_CLIENT_ID)                     | Dropbox Sign client ID.                                                 |
+| [DROPBOX_SIGN_CONFIG_ENTRIES](Variable.DROPBOX_SIGN_CONFIG_ENTRIES)           | Configuration entries required by the Dropbox Sign e-signing provider.  |
+| [DROPBOX_SIGN_WEBHOOK_SECRET](Variable.DROPBOX_SIGN_WEBHOOK_SECRET)           | Dropbox Sign webhook secret.                                            |
+| [ESIGNING_API_BASE_URL](Variable.ESIGNING_API_BASE_URL)                       | Active e-signing provider base URL.                                     |
+| [ESIGNING_API_KEY](Variable.ESIGNING_API_KEY)                                 | Active e-signing provider API key.                                      |
+| [ESIGNING_PROVIDER](Variable.ESIGNING_PROVIDER)                               | -                                                                       |
+| [ESIGNING_PROVIDER_OPTIONS](Variable.ESIGNING_PROVIDER_OPTIONS)               | -                                                                       |
+| [ESIGNING_WEBHOOK_SECRET](Variable.ESIGNING_WEBHOOK_SECRET)                   | Active e-signing provider webhook signing secret.                       |
+| [PLATFORM_ESIGNING_CONFIG_ENTRIES](Variable.PLATFORM_ESIGNING_CONFIG_ENTRIES) | All configuration entries required by `platform-esigning`.              |
+| [SignerRoles](Variable.SignerRoles)                                           | Represents the role of a signer in a signing request.                   |
+| [SignerStatuses](Variable.SignerStatuses)                                     | Represents the status of an individual signer within a signing request. |
+| [SigningFieldTypes](Variable.SigningFieldTypes)                               | Represents the type of a signing field placed on a document.            |
+| [SigningRequestStatuses](Variable.SigningRequestStatuses)                     | Represents the lifecycle status of a signing request.                   |
+| [SIGNNOW_API_KEY](Variable.SIGNNOW_API_KEY)                                   | signNow API key (basic token).                                          |
+| [SIGNNOW_BASE_URL](Variable.SIGNNOW_BASE_URL)                                 | signNow base URL.                                                       |
+| [SIGNNOW_CLIENT_ID](Variable.SIGNNOW_CLIENT_ID)                               | signNow client ID.                                                      |
+| [SIGNNOW_CLIENT_SECRET](Variable.SIGNNOW_CLIENT_SECRET)                       | signNow client secret.                                                  |
+| [SIGNNOW_CONFIG_ENTRIES](Variable.SIGNNOW_CONFIG_ENTRIES)                     | Configuration entries required by the signNow e-signing provider.       |
+| [SIGNNOW_WEBHOOK_SECRET](Variable.SIGNNOW_WEBHOOK_SECRET)                     | signNow webhook callback secret.                                        |
+| [WebhookEventTypes](Variable.WebhookEventTypes)                               | Represents the type of webhook event emitted by a signing provider.     |