@breadstone/archipel-mcp 0.0.13 → 0.0.15

package/data/packages/platform-esigning/api/Class.InternalEsigningProvider.md

@@ -1,249 +0,0 @@
----
-title: 'Class: InternalEsigningProvider'
-generated: true
-editUrl: false
----
-# Class: InternalEsigningProvider
-
-Defined in: [providers/internal/InternalEsigningProvider.ts:42](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/providers/internal/InternalEsigningProvider.ts#L42)
-
-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.
-
-## Extends
-
-- [`EsigningClientPort`](Class.EsigningClientPort)
-
-## Constructors
-
-### Constructor
-
-```ts
-new InternalEsigningProvider(): InternalEsigningProvider;
-```
-
-#### Returns
-
-`InternalEsigningProvider`
-
-#### Inherited from
-
-[`EsigningClientPort`](Class.EsigningClientPort).[`constructor`](Class.EsigningClientPort#constructor)
-
-## Accessors
-
-### providerId
-
-#### Get Signature
-
-```ts
-get providerId(): string;
-```
-
-Defined in: [providers/internal/InternalEsigningProvider.ts:51](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/providers/internal/InternalEsigningProvider.ts#L51)
-
-Unique identifier of the provider implementation.
-
-##### Returns
-
-`string`
-
-Unique identifier of the provider implementation.
-
-#### Overrides
-
-[`EsigningClientPort`](Class.EsigningClientPort).[`providerId`](Class.EsigningClientPort#providerid)
-
-## Methods
-
-### cancelSigningRequest()
-
-```ts
-cancelSigningRequest(signingRequestId, _reason?): Promise<void>;
-```
-
-Defined in: [providers/internal/InternalEsigningProvider.ts:181](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/providers/internal/InternalEsigningProvider.ts#L181)
-
-Cancel an in-progress signing request.
-
-#### Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `signingRequestId` | `string` | The provider-specific signing request identifier. |
-| `_reason?` | `string` | - |
-
-#### Returns
-
-`Promise`\<`void`\>
-
-#### Overrides
-
-[`EsigningClientPort`](Class.EsigningClientPort).[`cancelSigningRequest`](Class.EsigningClientPort#cancelsigningrequest)
-
-***
-
-### completeSigner()
-
-```ts
-completeSigner(signingRequestId, signerId): Promise<void>;
-```
-
-Defined in: [providers/internal/InternalEsigningProvider.ts:204](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/providers/internal/InternalEsigningProvider.ts#L204)
-
-Marks a signer as having completed their signing.
-This is specific to the internal provider and allows the consuming
-application to programmatically complete a signer's step.
-
-#### Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `signingRequestId` | `string` | The signing request identifier. |
-| `signerId` | `string` | The signer identifier. |
-
-#### Returns
-
-`Promise`\<`void`\>
-
-***
-
-### createSigningRequest()
-
-```ts
-createSigningRequest(request): Promise<ISigningRequest>;
-```
-
-Defined in: [providers/internal/InternalEsigningProvider.ts:59](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/providers/internal/InternalEsigningProvider.ts#L59)
-
-Create a new signing request (envelope/agreement).
-
-#### Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `request` | [`ICreateSigningRequest`](Interface.ICreateSigningRequest) | The signing request creation input. |
-
-#### Returns
-
-`Promise`\<[`ISigningRequest`](Interface.ISigningRequest)\>
-
-The created signing request with provider-assigned identifiers.
-
-#### Overrides
-
-[`EsigningClientPort`](Class.EsigningClientPort).[`createSigningRequest`](Class.EsigningClientPort#createsigningrequest)
-
-***
-
-### createSigningSession()
-
-```ts
-createSigningSession(request): Promise<ISigningSession>;
-```
-
-Defined in: [providers/internal/InternalEsigningProvider.ts:121](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/providers/internal/InternalEsigningProvider.ts#L121)
-
-Generate a signing session (signing link/URL) for a specific signer.
-
-#### Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `request` | [`ICreateSigningSessionRequest`](Interface.ICreateSigningSessionRequest) | The session creation input. |
-
-#### Returns
-
-`Promise`\<[`ISigningSession`](Interface.ISigningSession)\>
-
-The signing session with the signing URL.
-
-#### Overrides
-
-[`EsigningClientPort`](Class.EsigningClientPort).[`createSigningSession`](Class.EsigningClientPort#createsigningsession)
-
-***
-
-### getSignedDocuments()
-
-```ts
-getSignedDocuments(signingRequestId): Promise<ISignedDocument[]>;
-```
-
-Defined in: [providers/internal/InternalEsigningProvider.ts:164](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/providers/internal/InternalEsigningProvider.ts#L164)
-
-Retrieve the final signed documents for a completed signing request.
-
-#### Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `signingRequestId` | `string` | The provider-specific signing request identifier. |
-
-#### Returns
-
-`Promise`\<[`ISignedDocument`](Interface.ISignedDocument)[]\>
-
-Array of signed documents with their content.
-
-#### Overrides
-
-[`EsigningClientPort`](Class.EsigningClientPort).[`getSignedDocuments`](Class.EsigningClientPort#getsigneddocuments)
-
-***
-
-### getSigningRequest()
-
-```ts
-getSigningRequest(signingRequestId): Promise<ISigningRequest>;
-```
-
-Defined in: [providers/internal/InternalEsigningProvider.ts:150](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/providers/internal/InternalEsigningProvider.ts#L150)
-
-Retrieve the current status and details of a signing request.
-
-#### Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `signingRequestId` | `string` | The provider-specific signing request identifier. |
-
-#### Returns
-
-`Promise`\<[`ISigningRequest`](Interface.ISigningRequest)\>
-
-The signing request with current status.
-
-#### Overrides
-
-[`EsigningClientPort`](Class.EsigningClientPort).[`getSigningRequest`](Class.EsigningClientPort#getsigningrequest)
-
-***
-
-### verifyWebhook()
-
-```ts
-verifyWebhook(_payload, _signature): Promise<IEsigningWebhookEvent>;
-```
-
-Defined in: [providers/internal/InternalEsigningProvider.ts:191](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/providers/internal/InternalEsigningProvider.ts#L191)
-
-Verify a webhook payload signature and return a normalized event.
-
-#### Parameters
-
-| Parameter | Type |
-| ------ | ------ |
-| `_payload` | `string` \| `Buffer`\<`ArrayBufferLike`\> |
-| `_signature` | `string` |
-
-#### Returns
-
-`Promise`\<[`IEsigningWebhookEvent`](Interface.IEsigningWebhookEvent)\>
-
-Normalized webhook event.
-
-#### Overrides
-
-[`EsigningClientPort`](Class.EsigningClientPort).[`verifyWebhook`](Class.EsigningClientPort#verifywebhook)

package/data/packages/platform-esigning/api/Class.SigningProviderError.md

@@ -1,101 +0,0 @@
----
-title: 'Class: SigningProviderError'
-generated: true
-editUrl: false
----
-# Class: SigningProviderError
-
-Defined in: [errors/SigningProviderError.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/errors/SigningProviderError.ts#L12)
-
-Thrown when a provider-level operation fails.
-
-## Extends
-
-- [`EsigningError`](Class.EsigningError)
-
-## Constructors
-
-### Constructor
-
-```ts
-new SigningProviderError(
-   providerId, 
-   message, 
-   cause?): SigningProviderError;
-```
-
-Defined in: [errors/SigningProviderError.ts:22](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/errors/SigningProviderError.ts#L22)
-
-#### Parameters
-
-| Parameter | Type |
-| ------ | ------ |
-| `providerId` | `string` |
-| `message` | `string` |
-| `cause?` | `unknown` |
-
-#### Returns
-
-`SigningProviderError`
-
-#### Overrides
-
-[`EsigningError`](Class.EsigningError).[`constructor`](Class.EsigningError#constructor)
-
-## Accessors
-
-### code
-
-#### Get Signature
-
-```ts
-get code(): string;
-```
-
-Defined in: [errors/EsigningError.ts:26](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/errors/EsigningError.ts#L26)
-
-Machine-readable error code.
-
-##### Returns
-
-`string`
-
-#### Inherited from
-
-[`EsigningError`](Class.EsigningError).[`code`](Class.EsigningError#code)
-
-***
-
-### providerId
-
-#### Get Signature
-
-```ts
-get providerId(): string;
-```
-
-Defined in: [errors/SigningProviderError.ts:34](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/errors/SigningProviderError.ts#L34)
-
-Identifier of the provider that failed.
-
-##### Returns
-
-`string`
-
-***
-
-### rootCause
-
-#### Get Signature
-
-```ts
-get rootCause(): unknown;
-```
-
-Defined in: [errors/SigningProviderError.ts:39](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/errors/SigningProviderError.ts#L39)
-
-Original error or cause, if available.
-
-##### Returns
-
-`unknown`

package/data/packages/platform-esigning/api/Class.SigningRequestNotFoundError.md

@@ -1,78 +0,0 @@
----
-title: 'Class: SigningRequestNotFoundError'
-generated: true
-editUrl: false
----
-# Class: SigningRequestNotFoundError
-
-Defined in: [errors/SigningRequestNotFoundError.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/errors/SigningRequestNotFoundError.ts#L12)
-
-Thrown when a signing request cannot be found by the provider.
-
-## Extends
-
-- [`EsigningError`](Class.EsigningError)
-
-## Constructors
-
-### Constructor
-
-```ts
-new SigningRequestNotFoundError(signingRequestId): SigningRequestNotFoundError;
-```
-
-Defined in: [errors/SigningRequestNotFoundError.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/errors/SigningRequestNotFoundError.ts#L21)
-
-#### Parameters
-
-| Parameter | Type |
-| ------ | ------ |
-| `signingRequestId` | `string` |
-
-#### Returns
-
-`SigningRequestNotFoundError`
-
-#### Overrides
-
-[`EsigningError`](Class.EsigningError).[`constructor`](Class.EsigningError#constructor)
-
-## Accessors
-
-### code
-
-#### Get Signature
-
-```ts
-get code(): string;
-```
-
-Defined in: [errors/EsigningError.ts:26](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/errors/EsigningError.ts#L26)
-
-Machine-readable error code.
-
-##### Returns
-
-`string`
-
-#### Inherited from
-
-[`EsigningError`](Class.EsigningError).[`code`](Class.EsigningError#code)
-
-***
-
-### signingRequestId
-
-#### Get Signature
-
-```ts
-get signingRequestId(): string;
-```
-
-Defined in: [errors/SigningRequestNotFoundError.ts:32](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/errors/SigningRequestNotFoundError.ts#L32)
-
-The identifier of the signing request that was not found.
-
-##### Returns
-
-`string`

package/data/packages/platform-esigning/api/Class.WebhookVerificationError.md

@@ -1,60 +0,0 @@
----
-title: 'Class: WebhookVerificationError'
-generated: true
-editUrl: false
----
-# Class: WebhookVerificationError
-
-Defined in: [errors/WebhookVerificationError.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/errors/WebhookVerificationError.ts#L12)
-
-Thrown when a webhook signature verification fails.
-
-## Extends
-
-- [`EsigningError`](Class.EsigningError)
-
-## Constructors
-
-### Constructor
-
-```ts
-new WebhookVerificationError(message?): WebhookVerificationError;
-```
-
-Defined in: [errors/WebhookVerificationError.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/errors/WebhookVerificationError.ts#L15)
-
-#### Parameters
-
-| Parameter | Type |
-| ------ | ------ |
-| `message?` | `string` |
-
-#### Returns
-
-`WebhookVerificationError`
-
-#### Overrides
-
-[`EsigningError`](Class.EsigningError).[`constructor`](Class.EsigningError#constructor)
-
-## Accessors
-
-### code
-
-#### Get Signature
-
-```ts
-get code(): string;
-```
-
-Defined in: [errors/EsigningError.ts:26](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/errors/EsigningError.ts#L26)
-
-Machine-readable error code.
-
-##### Returns
-
-`string`
-
-#### Inherited from
-
-[`EsigningError`](Class.EsigningError).[`code`](Class.EsigningError#code)

package/data/packages/platform-esigning/api/Interface.ICreateSigningRequest.md

@@ -1,94 +0,0 @@
----
-title: 'Interface: ICreateSigningRequest'
-generated: true
-editUrl: false
----
-# Interface: ICreateSigningRequest
-
-Defined in: [models/ICreateSigningRequest.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/ICreateSigningRequest.ts#L13)
-
-Input for creating a new signing request.
-
-## Properties
-
-### documents
-
-```ts
-readonly documents: readonly ICreateSigningRequestDocument[];
-```
-
-Defined in: [models/ICreateSigningRequest.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/ICreateSigningRequest.ts#L21)
-
-Documents to include in the signing request.
-
-***
-
-### expiresInHours?
-
-```ts
-readonly optional expiresInHours?: number;
-```
-
-Defined in: [models/ICreateSigningRequest.ts:30](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/ICreateSigningRequest.ts#L30)
-
-Expiration duration in hours, if applicable.
-
-***
-
-### fields?
-
-```ts
-readonly optional fields?: readonly Omit<ISigningField, "fieldId" | "value">[];
-```
-
-Defined in: [models/ICreateSigningRequest.ts:27](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/ICreateSigningRequest.ts#L27)
-
-Fields to place on the documents.
-
-***
-
-### message?
-
-```ts
-readonly optional message?: string;
-```
-
-Defined in: [models/ICreateSigningRequest.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/ICreateSigningRequest.ts#L18)
-
-Optional message for the signers.
-
-***
-
-### providerOptions?
-
-```ts
-readonly optional providerOptions?: Record<string, unknown>;
-```
-
-Defined in: [models/ICreateSigningRequest.ts:33](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/ICreateSigningRequest.ts#L33)
-
-Provider-specific extra options.
-
-***
-
-### signers
-
-```ts
-readonly signers: readonly ICreateSigningRequestSigner[];
-```
-
-Defined in: [models/ICreateSigningRequest.ts:24](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/ICreateSigningRequest.ts#L24)
-
-Signers to participate in the signing request.
-
-***
-
-### subject
-
-```ts
-readonly subject: string;
-```
-
-Defined in: [models/ICreateSigningRequest.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/ICreateSigningRequest.ts#L15)
-
-Subject or title of the signing request.

package/data/packages/platform-esigning/api/Interface.ICreateSigningRequestDocument.md

@@ -1,58 +0,0 @@
----
-title: 'Interface: ICreateSigningRequestDocument'
-generated: true
-editUrl: false
----
-# Interface: ICreateSigningRequestDocument
-
-Defined in: [models/ICreateSigningRequest.ts:41](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/ICreateSigningRequest.ts#L41)
-
-A document to include when creating a signing request.
-
-## Properties
-
-### content
-
-```ts
-readonly content: Buffer;
-```
-
-Defined in: [models/ICreateSigningRequest.ts:49](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/ICreateSigningRequest.ts#L49)
-
-Document content as a buffer.
-
-***
-
-### contentType
-
-```ts
-readonly contentType: string;
-```
-
-Defined in: [models/ICreateSigningRequest.ts:46](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/ICreateSigningRequest.ts#L46)
-
-MIME type of the document content.
-
-***
-
-### name
-
-```ts
-readonly name: string;
-```
-
-Defined in: [models/ICreateSigningRequest.ts:43](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/ICreateSigningRequest.ts#L43)
-
-Display name of the document.
-
-***
-
-### order
-
-```ts
-readonly order: number;
-```
-
-Defined in: [models/ICreateSigningRequest.ts:52](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/ICreateSigningRequest.ts#L52)
-
-Order of the document within the request.

package/data/packages/platform-esigning/api/Interface.ICreateSigningRequestSigner.md

@@ -1,58 +0,0 @@
----
-title: 'Interface: ICreateSigningRequestSigner'
-generated: true
-editUrl: false
----
-# Interface: ICreateSigningRequestSigner
-
-Defined in: [models/ICreateSigningRequest.ts:60](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/ICreateSigningRequest.ts#L60)
-
-A signer to include when creating a signing request.
-
-## Properties
-
-### email
-
-```ts
-readonly email: string;
-```
-
-Defined in: [models/ICreateSigningRequest.ts:62](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/ICreateSigningRequest.ts#L62)
-
-Email address of the signer.
-
-***
-
-### name
-
-```ts
-readonly name: string;
-```
-
-Defined in: [models/ICreateSigningRequest.ts:65](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/ICreateSigningRequest.ts#L65)
-
-Display name of the signer.
-
-***
-
-### order
-
-```ts
-readonly order: number;
-```
-
-Defined in: [models/ICreateSigningRequest.ts:71](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/ICreateSigningRequest.ts#L71)
-
-Routing order determining the signing sequence.
-
-***
-
-### role
-
-```ts
-readonly role: SignerRole;
-```
-
-Defined in: [models/ICreateSigningRequest.ts:68](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/ICreateSigningRequest.ts#L68)
-
-Role of the signer.