npm - @breadstone/archipel-mcp - Versions diffs - 0.0.2 → 0.0.4 - Mend

@breadstone/archipel-mcp 0.0.2 → 0.0.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (548) hide show

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

@@ -3,19 +3,20 @@ 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";
+  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';
 };
 ```
@@ -25,14 +26,14 @@ 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) |
+| 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 CHANGED Viewed

@@ -3,82 +3,83 @@ 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. |
+| 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. |
+| 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). |
+| 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). |
+| [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. |
+| 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.     |

package/data/packages/platform-logging/api/Class.LoggerModule.md CHANGED Viewed

@@ -3,6 +3,7 @@ title: 'Class: LoggerModule'
 generated: true
 editUrl: false
 ---
 # Class: LoggerModule
 Defined in: [LoggerModule.ts:26](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-logging/src/LoggerModule.ts#L26)

package/data/packages/platform-logging/api/Variable.APP_LOG_LEVEL.md CHANGED Viewed

@@ -3,7 +3,8 @@ title: 'Variable: APP\_LOG\_LEVEL'
 generated: true
 editUrl: false
 ---
-# Variable: APP\_LOG\_LEVEL
+# Variable: APP_LOG_LEVEL
 ```ts
 const APP_LOG_LEVEL: IConfigKey<string>;

package/data/packages/platform-logging/api/Variable.PLATFORM_LOGGING_CONFIG_ENTRIES.md CHANGED Viewed

@@ -3,10 +3,11 @@ title: 'Variable: PLATFORM\_LOGGING\_CONFIG\_ENTRIES'
 generated: true
 editUrl: false
 ---
-# Variable: PLATFORM\_LOGGING\_CONFIG\_ENTRIES
+# Variable: PLATFORM_LOGGING_CONFIG_ENTRIES
 ```ts
-const PLATFORM_LOGGING_CONFIG_ENTRIES: ReadonlyArray<Omit<IConfigRegistryEntry, "module">>;
+const PLATFORM_LOGGING_CONFIG_ENTRIES: ReadonlyArray<Omit<IConfigRegistryEntry, 'module'>>;
 ```
 Defined in: [env.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-logging/src/env.ts#L19)

package/data/packages/platform-logging/api/index.md CHANGED Viewed

@@ -3,17 +3,18 @@ title: '@breadstone/archipel-platform-logging'
 generated: true
 editUrl: false
 ---
 # @breadstone/archipel-platform-logging
 ## Classes
-| Class | Description |
-| ------ | ------ |
-| [LoggerModule](Class.LoggerModule) | - |
+| Class                              | Description |
+| ---------------------------------- | ----------- |
+| [LoggerModule](Class.LoggerModule) | -           |
 ## Variables
-| Variable | Description |
-| ------ | ------ |
-| [APP\_LOG\_LEVEL](Variable.APP_LOG_LEVEL) | Application log level (e.g. `'debug'`, `'info'`, `'warn'`, `'error'`). |
-| [PLATFORM\_LOGGING\_CONFIG\_ENTRIES](Variable.PLATFORM_LOGGING_CONFIG_ENTRIES) | All configuration entries required by `platform-logging`. |
+| Variable                                                                    | Description                                                            |
+| --------------------------------------------------------------------------- | ---------------------------------------------------------------------- |
+| [APP_LOG_LEVEL](Variable.APP_LOG_LEVEL)                                     | Application log level (e.g. `'debug'`, `'info'`, `'warn'`, `'error'`). |
+| [PLATFORM_LOGGING_CONFIG_ENTRIES](Variable.PLATFORM_LOGGING_CONFIG_ENTRIES) | All configuration entries required by `platform-logging`.              |

package/data/packages/platform-mailing/api/Class.BlobTemplateFetchStrategy.md CHANGED Viewed

@@ -3,6 +3,7 @@ title: 'Class: BlobTemplateFetchStrategy'
 generated: true
 editUrl: false
 ---
 # Class: BlobTemplateFetchStrategy
 Defined in: [platform-mailing/src/templating/strategies/BlobTemplateFetchStrategy.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/templating/strategies/BlobTemplateFetchStrategy.ts#L16)
@@ -27,8 +28,8 @@ Constructs a new instance of the `BlobTemplateFetchStrategy` class.
 #### Parameters
-| Parameter | Type |
-| ------ | ------ |
+| Parameter     | Type          |
+| ------------- | ------------- |
 | `blobService` | `BlobService` |
 #### Returns

package/data/packages/platform-mailing/api/Class.DeliveryStrategyBase.md CHANGED Viewed

@@ -3,6 +3,7 @@ title: 'Abstract Class: DeliveryStrategyBase'
 generated: true
 editUrl: false
 ---
 # Abstract Class: DeliveryStrategyBase
 Defined in: [platform-mailing/src/services/strategies/abstracts/DeliveryStrategyBase.ts:7](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/services/strategies/abstracts/DeliveryStrategyBase.ts#L7)
@@ -40,10 +41,10 @@ Initializes a new instance of the `DeliveryStrategyBase` class.
 ```ts
 abstract send(
-   from,
-   to,
-   subject,
-   content,
+   from,
+   to,
+   subject,
+   content,
 isHtml): Promise<void>;
 ```
@@ -53,13 +54,13 @@ Sends an email with either plain text or HTML content.
 #### Parameters
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `from` | `string` | Sender's email address (optional, defaults to config) |
-| `to` | `string` | Recipient's email address |
-| `subject` | `string` | Subject of the email |
-| `content` | `string` | Email body content (plain text or HTML) |
-| `isHtml` | `boolean` | Flag to indicate whether the email is HTML (true) or plain text (false) |
+| Parameter | Type      | Description                                                             |
+| --------- | --------- | ----------------------------------------------------------------------- |
+| `from`    | `string`  | Sender's email address (optional, defaults to config)                   |
+| `to`      | `string`  | Recipient's email address                                               |
+| `subject` | `string`  | Subject of the email                                                    |
+| `content` | `string`  | Email body content (plain text or HTML)                                 |
+| `isHtml`  | `boolean` | Flag to indicate whether the email is HTML (true) or plain text (false) |
 #### Returns

package/data/packages/platform-mailing/api/Class.FileTemplateFetchStrategy.md CHANGED Viewed

@@ -3,6 +3,7 @@ title: 'Class: FileTemplateFetchStrategy'
 generated: true
 editUrl: false
 ---
 # Class: FileTemplateFetchStrategy
 Defined in: [platform-mailing/src/templating/strategies/FileTemplateFetchStrategy.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/templating/strategies/FileTemplateFetchStrategy.ts#L16)
@@ -25,8 +26,8 @@ Defined in: [platform-mailing/src/templating/strategies/FileTemplateFetchStrateg
 #### Parameters
-| Parameter | Type |
-| ------ | ------ |
+| Parameter         | Type              |
+| ----------------- | ----------------- |
 | `resourceManager` | `ResourceManager` |
 #### Returns

package/data/packages/platform-mailing/api/Class.LogDeliveryStrategy.md CHANGED Viewed

@@ -3,6 +3,7 @@ title: 'Class: LogDeliveryStrategy'
 generated: true
 editUrl: false
 ---
 # Class: LogDeliveryStrategy
 Defined in: [platform-mailing/src/services/strategies/LogDeliveryStrategy.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/services/strategies/LogDeliveryStrategy.ts#L14)
@@ -27,8 +28,8 @@ Constructs a new instance of the `LogDelivery` class.
 #### Parameters
-| Parameter | Type |
-| ------ | ------ |
+| Parameter       | Type            |
+| --------------- | --------------- |
 | `configService` | `ConfigService` |
 #### Returns
@@ -45,10 +46,10 @@ Constructs a new instance of the `LogDelivery` class.
 ```ts
 abstract send(
-   from,
-   to,
-   subject,
-   content,
+   from,
+   to,
+   subject,
+   content,
 isHtml): Promise<void>;
 ```
@@ -58,13 +59,13 @@ Sends an email with either plain text or HTML content.
 #### Parameters
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `from` | `string` | Sender's email address (optional, defaults to config) |
-| `to` | `string` | Recipient's email address |
-| `subject` | `string` | Subject of the email |
-| `content` | `string` | Email body content (plain text or HTML) |
-| `isHtml` | `boolean` | Flag to indicate whether the email is HTML (true) or plain text (false) |
+| Parameter | Type      | Description                                                             |
+| --------- | --------- | ----------------------------------------------------------------------- |
+| `from`    | `string`  | Sender's email address (optional, defaults to config)                   |
+| `to`      | `string`  | Recipient's email address                                               |
+| `subject` | `string`  | Subject of the email                                                    |
+| `content` | `string`  | Email body content (plain text or HTML)                                 |
+| `isHtml`  | `boolean` | Flag to indicate whether the email is HTML (true) or plain text (false) |
 #### Returns

package/data/packages/platform-mailing/api/Class.MailHealthIndicator.md CHANGED Viewed

@@ -3,6 +3,7 @@ title: 'Class: MailHealthIndicator'
 generated: true
 editUrl: false
 ---
 # Class: MailHealthIndicator
 Defined in: [platform-mailing/src/terminus/MailHealthIndicator.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/terminus/MailHealthIndicator.ts#L16)
@@ -27,8 +28,8 @@ Constructs a new instance of the `MailHealthIndicator` class.
 #### Parameters
-| Parameter | Type |
-| ------ | ------ |
+| Parameter       | Type            |
+| --------------- | --------------- |
 | `configService` | `ConfigService` |
 #### Returns
@@ -50,7 +51,7 @@ Unique key identifying the indicator
 #### Implementation of
 ```ts
-IHealthIndicator.key
+IHealthIndicator.key;
 ```
 ## Methods
@@ -74,5 +75,5 @@ The health indicator result.
 #### Implementation of
 ```ts
-IHealthIndicator.check
+IHealthIndicator.check;
 ```

package/data/packages/platform-mailing/api/Class.MailModule.md CHANGED Viewed

@@ -3,6 +3,7 @@ title: 'Class: MailModule'
 generated: true
 editUrl: false
 ---
 # Class: MailModule
 Defined in: [platform-mailing/src/MailModule.ts:113](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/MailModule.ts#L113)

package/data/packages/platform-mailing/api/Class.MailService.md CHANGED Viewed

@@ -3,6 +3,7 @@ title: 'Class: MailService'
 generated: true
 editUrl: false
 ---
 # Class: MailService
 Defined in: [platform-mailing/src/services/MailService.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/services/MailService.ts#L17)
@@ -15,8 +16,8 @@ Represents the `MailService` class.
 ```ts
 new MailService(
-   configService,
-   mailTemplateEngine,
+   configService,
+   mailTemplateEngine,
    deliveryStrategy): MailService;
 ```
@@ -26,11 +27,11 @@ Constructs a new instance of the `MailService` class.
 #### Parameters
-| Parameter | Type |
-| ------ | ------ |
-| `configService` | `ConfigService` |
-| `mailTemplateEngine` | [`MailTemplateEngine`](Class.MailTemplateEngine) |
-| `deliveryStrategy` | [`DeliveryStrategyBase`](Class.DeliveryStrategyBase) |
+| Parameter            | Type                                                 |
+| -------------------- | ---------------------------------------------------- |
+| `configService`      | `ConfigService`                                      |
+| `mailTemplateEngine` | [`MailTemplateEngine`](Class.MailTemplateEngine)     |
+| `deliveryStrategy`   | [`DeliveryStrategyBase`](Class.DeliveryStrategyBase) |
 #### Returns
@@ -42,8 +43,8 @@ Constructs a new instance of the `MailService` class.
 ```ts
 send(
-   mailOptions,
-   content,
+   mailOptions,
+   content,
 isHtml): Promise<void>;
 ```
@@ -53,20 +54,20 @@ Sends an email with either plain text or HTML content.
 #### Parameters
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `mailOptions` | \{ `from?`: `string`; `subject`: `string`; `to`: `string`; \} | - |
-| `mailOptions.from?` | `string` | Sender's email address (optional, defaults to config) |
-| `mailOptions.subject` | `string` | Subject of the email |
-| `mailOptions.to` | `string` | Recipient's email address |
-| `content` | `string` | Email body content (plain text or HTML) |
-| `isHtml` | `boolean` | Flag to indicate whether the email is HTML (true) or plain text (false) |
+| Parameter             | Type                                                          | Description                                                             |
+| --------------------- | ------------------------------------------------------------- | ----------------------------------------------------------------------- |
+| `mailOptions`         | \{ `from?`: `string`; `subject`: `string`; `to`: `string`; \} | -                                                                       |
+| `mailOptions.from?`   | `string`                                                      | Sender's email address (optional, defaults to config)                   |
+| `mailOptions.subject` | `string`                                                      | Subject of the email                                                    |
+| `mailOptions.to`      | `string`                                                      | Recipient's email address                                               |
+| `content`             | `string`                                                      | Email body content (plain text or HTML)                                 |
+| `isHtml`              | `boolean`                                                     | Flag to indicate whether the email is HTML (true) or plain text (false) |
 #### Returns
 `Promise`\<`void`\>
-***
+---
 ### sendTemplate()
@@ -81,15 +82,15 @@ Automatically uses the template format (either 'html' or 'txt') based on the env
 #### Parameters
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `mailOptions` | \{ `from?`: `string`; `subject`: `string`; `to`: `string`; \} | - |
-| `mailOptions.from?` | `string` | Sender's email address (optional, defaults to config) |
-| `mailOptions.subject` | `string` | Subject of the email |
-| `mailOptions.to` | `string` | Recipient's email address |
-| `templateOptions` | \{ `templateName`: `string`; `templateParams`: `Record`\<`string`, `string` \| `number` \| `boolean` \| `Date` \| `undefined` \| `null`\>; \} | - |
-| `templateOptions.templateName` | `string` | Name of the template to be used |
-| `templateOptions.templateParams` | `Record`\<`string`, `string` \| `number` \| `boolean` \| `Date` \| `undefined` \| `null`\> | - |
+| Parameter                        | Type                                                                                                                                          | Description                                           |
+| -------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------- |
+| `mailOptions`                    | \{ `from?`: `string`; `subject`: `string`; `to`: `string`; \}                                                                                 | -                                                     |
+| `mailOptions.from?`              | `string`                                                                                                                                      | Sender's email address (optional, defaults to config) |
+| `mailOptions.subject`            | `string`                                                                                                                                      | Subject of the email                                  |
+| `mailOptions.to`                 | `string`                                                                                                                                      | Recipient's email address                             |
+| `templateOptions`                | \{ `templateName`: `string`; `templateParams`: `Record`\<`string`, `string` \| `number` \| `boolean` \| `Date` \| `undefined` \| `null`\>; \} | -                                                     |
+| `templateOptions.templateName`   | `string`                                                                                                                                      | Name of the template to be used                       |
+| `templateOptions.templateParams` | `Record`\<`string`, `string` \| `number` \| `boolean` \| `Date` \| `undefined` \| `null`\>                                                    | -                                                     |
 #### Returns