@breadstone/archipel-mcp 0.0.1 → 0.0.2

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

@@ -0,0 +1,84 @@
+---
+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. |