@breadstone/archipel-mcp 0.0.1 → 0.0.3

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

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

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

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

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

@@ -0,0 +1,47 @@
+---
+title: 'Interface: ICreateSigningSessionRequest'
+generated: true
+editUrl: false
+---
+
+# Interface: ICreateSigningSessionRequest
+
+Defined in: [models/ICreateSigningSessionRequest.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/ICreateSigningSessionRequest.ts#L6)
+
+Input for creating a signing session (signing link) for a specific signer.
+
+## Properties
+
+### returnUrl?
+
+```ts
+readonly optional returnUrl?: string;
+```
+
+Defined in: [models/ICreateSigningSessionRequest.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/ICreateSigningSessionRequest.ts#L14)
+
+URL to redirect the signer to after completing the signing.
+
+---
+
+### signerId
+
+```ts
+readonly signerId: string;
+```
+
+Defined in: [models/ICreateSigningSessionRequest.ts:11](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/ICreateSigningSessionRequest.ts#L11)
+
+Identifier of the signer to generate the session for.
+
+---
+
+### signingRequestId
+
+```ts
+readonly signingRequestId: string;
+```
+
+Defined in: [models/ICreateSigningSessionRequest.ts:8](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/ICreateSigningSessionRequest.ts#L8)
+
+Identifier of the signing request.

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

@@ -0,0 +1,61 @@
+---
+title: 'Interface: IEsigningModuleOptions'
+generated: true
+editUrl: false
+---
+
+# Interface: IEsigningModuleOptions
+
+Defined in: [EsigningModule.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/EsigningModule.ts#L18)
+
+Configuration options for the [EsigningModule](Class.EsigningModule).
+
+## Properties
+
+### configEntries?
+
+```ts
+optional configEntries?: readonly Omit<IConfigRegistryEntry<unknown>, "module">[];
+```
+
+Defined in: [EsigningModule.ts:28](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/EsigningModule.ts#L28)
+
+Provider-specific configuration entries to register with the config module.
+
+---
+
+### isGlobal?
+
+```ts
+optional isGlobal?: boolean;
+```
+
+Defined in: [EsigningModule.ts:39](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/EsigningModule.ts#L39)
+
+When `true` the module is registered globally.
+
+---
+
+### persistence?
+
+```ts
+optional persistence?: Type<EsigningPersistencePort>;
+```
+
+Defined in: [EsigningModule.ts:34](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/EsigningModule.ts#L34)
+
+Concrete implementation of the [EsigningPersistencePort](Class.EsigningPersistencePort).
+Required when the application needs to persist signing request state.
+
+---
+
+### provider
+
+```ts
+provider: Type<EsigningClientPort>;
+```
+
+Defined in: [EsigningModule.ts:23](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/EsigningModule.ts#L23)
+
+Concrete implementation of the [EsigningClientPort](Class.EsigningClientPort).
+For example, `InternalEsigningProvider`, `DocuSignClient`, `AdobeSignClient`, etc.

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

@@ -0,0 +1,83 @@
+---
+title: 'Interface: IEsigningWebhookEvent'
+generated: true
+editUrl: false
+---
+
+# Interface: IEsigningWebhookEvent
+
+Defined in: [models/IEsigningWebhookEvent.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/IEsigningWebhookEvent.ts#L12)
+
+Normalized representation of a webhook event from an e-signing provider.
+
+## Properties
+
+### eventId
+
+```ts
+readonly eventId: string;
+```
+
+Defined in: [models/IEsigningWebhookEvent.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/IEsigningWebhookEvent.ts#L14)
+
+Provider-specific event identifier.
+
+---
+
+### eventType
+
+```ts
+readonly eventType: WebhookEventType;
+```
+
+Defined in: [models/IEsigningWebhookEvent.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/IEsigningWebhookEvent.ts#L17)
+
+Normalized event type.
+
+---
+
+### occurredAt
+
+```ts
+readonly occurredAt: Date;
+```
+
+Defined in: [models/IEsigningWebhookEvent.ts:26](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/IEsigningWebhookEvent.ts#L26)
+
+Timestamp when the event occurred.
+
+---
+
+### rawPayload
+
+```ts
+readonly rawPayload: unknown;
+```
+
+Defined in: [models/IEsigningWebhookEvent.ts:29](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/IEsigningWebhookEvent.ts#L29)
+
+Provider-specific raw event payload.
+
+---
+
+### signerId?
+
+```ts
+readonly optional signerId?: string;
+```
+
+Defined in: [models/IEsigningWebhookEvent.ts:23](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/IEsigningWebhookEvent.ts#L23)
+
+Signer the event relates to, if applicable.
+
+---
+
+### signingRequestId
+
+```ts
+readonly signingRequestId: string;
+```
+
+Defined in: [models/IEsigningWebhookEvent.ts:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/IEsigningWebhookEvent.ts#L20)
+
+Signing request the event relates to.

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

@@ -0,0 +1,83 @@
+---
+title: 'Interface: ISignedDocument'
+generated: true
+editUrl: false
+---
+
+# Interface: ISignedDocument
+
+Defined in: [models/ISignedDocument.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/ISignedDocument.ts#L6)
+
+Normalized representation of a signed (completed) document.
+
+## Properties
+
+### content
+
+```ts
+readonly content: Buffer;
+```
+
+Defined in: [models/ISignedDocument.ts:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/ISignedDocument.ts#L20)
+
+The signed document content as a buffer.
+
+---
+
+### contentType
+
+```ts
+readonly contentType: string;
+```
+
+Defined in: [models/ISignedDocument.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/ISignedDocument.ts#L17)
+
+MIME type of the signed document.
+
+---
+
+### documentId
+
+```ts
+readonly documentId: string;
+```
+
+Defined in: [models/ISignedDocument.ts:8](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/ISignedDocument.ts#L8)
+
+Provider-specific document identifier.
+
+---
+
+### name
+
+```ts
+readonly name: string;
+```
+
+Defined in: [models/ISignedDocument.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/ISignedDocument.ts#L14)
+
+Display name of the signed document.
+
+---
+
+### signingRequestId
+
+```ts
+readonly signingRequestId: string;
+```
+
+Defined in: [models/ISignedDocument.ts:11](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/ISignedDocument.ts#L11)
+
+Signing request this document belongs to.
+
+---
+
+### sizeInBytes
+
+```ts
+readonly sizeInBytes: number;
+```
+
+Defined in: [models/ISignedDocument.ts:23](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/ISignedDocument.ts#L23)
+
+Size of the signed document in bytes.

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

@@ -0,0 +1,83 @@
+---
+title: 'Interface: ISigner'
+generated: true
+editUrl: false
+---
+
+# Interface: ISigner
+
+Defined in: [models/ISigner.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/ISigner.ts#L13)
+
+Normalized representation of a signer participating in a signing request.
+
+## Properties
+
+### email
+
+```ts
+readonly email: string;
+```
+
+Defined in: [models/ISigner.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/ISigner.ts#L18)
+
+Email address of the signer.
+
+---
+
+### name
+
+```ts
+readonly name: string;
+```
+
+Defined in: [models/ISigner.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/ISigner.ts#L21)
+
+Display name of the signer.
+
+---
+
+### order
+
+```ts
+readonly order: number;
+```
+
+Defined in: [models/ISigner.ts:30](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/ISigner.ts#L30)
+
+Routing order determining the signing sequence.
+
+---
+
+### role
+
+```ts
+readonly role: SignerRole;
+```
+
+Defined in: [models/ISigner.ts:24](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/ISigner.ts#L24)
+
+Role of the signer in the signing process.
+
+---
+
+### signerId
+
+```ts
+readonly signerId: string;
+```
+
+Defined in: [models/ISigner.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/ISigner.ts#L15)
+
+Provider-specific signer identifier.
+
+---
+
+### status
+
+```ts
+readonly status: SignerStatus;
+```
+
+Defined in: [models/ISigner.ts:27](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/ISigner.ts#L27)
+
+Current status of this signer.

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

@@ -0,0 +1,83 @@
+---
+title: 'Interface: ISigningDocument'
+generated: true
+editUrl: false
+---
+
+# Interface: ISigningDocument
+
+Defined in: [models/ISigningDocument.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/ISigningDocument.ts#L6)
+
+Normalized representation of a document within a signing request.
+
+## Properties
+
+### contentType
+
+```ts
+readonly contentType: string;
+```
+
+Defined in: [models/ISigningDocument.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/ISigningDocument.ts#L14)
+
+MIME type of the document.
+
+---
+
+### documentId
+
+```ts
+readonly documentId: string;
+```
+
+Defined in: [models/ISigningDocument.ts:8](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/ISigningDocument.ts#L8)
+
+Provider-specific document identifier.
+
+---
+
+### name
+
+```ts
+readonly name: string;
+```
+
+Defined in: [models/ISigningDocument.ts:11](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/ISigningDocument.ts#L11)
+
+Display name of the document.
+
+---
+
+### order
+
+```ts
+readonly order: number;
+```
+
+Defined in: [models/ISigningDocument.ts:23](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/ISigningDocument.ts#L23)
+
+Order of the document within the signing request.
+
+---
+
+### pageCount?
+
+```ts
+readonly optional pageCount?: number;
+```
+
+Defined in: [models/ISigningDocument.ts:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/ISigningDocument.ts#L20)
+
+Number of pages in the document, if known.
+
+---
+
+### sizeInBytes?
+
+```ts
+readonly optional sizeInBytes?: number;
+```
+
+Defined in: [models/ISigningDocument.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/ISigningDocument.ts#L17)
+
+Size of the document in bytes, if known.