@breadstone/archipel-mcp 0.0.1 → 0.0.3

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

@@ -0,0 +1,143 @@
+---
+title: 'Interface: ISigningField'
+generated: true
+editUrl: false
+---
+
+# Interface: ISigningField
+
+Defined in: [models/ISigningField.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/ISigningField.ts#L12)
+
+Normalized representation of a signing field placed on a document.
+
+## Properties
+
+### documentId
+
+```ts
+readonly documentId: string;
+```
+
+Defined in: [models/ISigningField.ts:23](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/ISigningField.ts#L23)
+
+Identifier of the document this field is placed on.
+
+---
+
+### fieldId
+
+```ts
+readonly fieldId: string;
+```
+
+Defined in: [models/ISigningField.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/ISigningField.ts#L14)
+
+Provider-specific field identifier.
+
+---
+
+### height
+
+```ts
+readonly height: number;
+```
+
+Defined in: [models/ISigningField.ts:38](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/ISigningField.ts#L38)
+
+Height of the field in points.
+
+---
+
+### pageNumber
+
+```ts
+readonly pageNumber: number;
+```
+
+Defined in: [models/ISigningField.ts:26](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/ISigningField.ts#L26)
+
+Page number where the field is placed (1-based).
+
+---
+
+### positionX
+
+```ts
+readonly positionX: number;
+```
+
+Defined in: [models/ISigningField.ts:29](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/ISigningField.ts#L29)
+
+X-coordinate position (points from left).
+
+---
+
+### positionY
+
+```ts
+readonly positionY: number;
+```
+
+Defined in: [models/ISigningField.ts:32](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/ISigningField.ts#L32)
+
+Y-coordinate position (points from top).
+
+---
+
+### required
+
+```ts
+readonly required: boolean;
+```
+
+Defined in: [models/ISigningField.ts:41](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/ISigningField.ts#L41)
+
+Whether the field is required.
+
+---
+
+### signerId
+
+```ts
+readonly signerId: string;
+```
+
+Defined in: [models/ISigningField.ts:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/ISigningField.ts#L20)
+
+Identifier of the signer associated with this field.
+
+---
+
+### type
+
+```ts
+readonly type: SigningFieldType;
+```
+
+Defined in: [models/ISigningField.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/ISigningField.ts#L17)
+
+Type of the field.
+
+---
+
+### value?
+
+```ts
+readonly optional value?: string;
+```
+
+Defined in: [models/ISigningField.ts:44](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/ISigningField.ts#L44)
+
+Current value of the field, if filled.
+
+---
+
+### width
+
+```ts
+readonly width: number;
+```
+
+Defined in: [models/ISigningField.ts:35](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/ISigningField.ts#L35)
+
+Width of the field in points.

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

@@ -0,0 +1,143 @@
+---
+title: 'Interface: ISigningRequest'
+generated: true
+editUrl: false
+---
+
+# Interface: ISigningRequest
+
+Defined in: [models/ISigningRequest.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/ISigningRequest.ts#L15)
+
+Normalized representation of a signing request (envelope/agreement).
+
+## Properties
+
+### createdAt
+
+```ts
+readonly createdAt: Date;
+```
+
+Defined in: [models/ISigningRequest.ts:38](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/ISigningRequest.ts#L38)
+
+Timestamp when the signing request was created.
+
+---
+
+### documents
+
+```ts
+readonly documents: readonly ISigningDocument[];
+```
+
+Defined in: [models/ISigningRequest.ts:32](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/ISigningRequest.ts#L32)
+
+Documents included in this request.
+
+---
+
+### expiresAt?
+
+```ts
+readonly optional expiresAt?: Date;
+```
+
+Defined in: [models/ISigningRequest.ts:44](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/ISigningRequest.ts#L44)
+
+Timestamp when the signing request expires, if applicable.
+
+---
+
+### fields
+
+```ts
+readonly fields: readonly ISigningField[];
+```
+
+Defined in: [models/ISigningRequest.ts:35](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/ISigningRequest.ts#L35)
+
+Fields placed across the documents.
+
+---
+
+### message?
+
+```ts
+readonly optional message?: string;
+```
+
+Defined in: [models/ISigningRequest.ts:26](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/ISigningRequest.ts#L26)
+
+Optional message included with the signing request.
+
+---
+
+### providerMetadata?
+
+```ts
+readonly optional providerMetadata?: Record<string, unknown>;
+```
+
+Defined in: [models/ISigningRequest.ts:47](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/ISigningRequest.ts#L47)
+
+Provider-specific raw metadata.
+
+---
+
+### signers
+
+```ts
+readonly signers: readonly ISigner[];
+```
+
+Defined in: [models/ISigningRequest.ts:29](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/ISigningRequest.ts#L29)
+
+Signers participating in this request.
+
+---
+
+### signingRequestId
+
+```ts
+readonly signingRequestId: string;
+```
+
+Defined in: [models/ISigningRequest.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/ISigningRequest.ts#L17)
+
+Provider-specific signing request identifier.
+
+---
+
+### status
+
+```ts
+readonly status: SigningRequestStatus;
+```
+
+Defined in: [models/ISigningRequest.ts:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/ISigningRequest.ts#L20)
+
+Current status of the signing request.
+
+---
+
+### subject
+
+```ts
+readonly subject: string;
+```
+
+Defined in: [models/ISigningRequest.ts:23](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/ISigningRequest.ts#L23)
+
+Subject or title of the signing request.
+
+---
+
+### updatedAt
+
+```ts
+readonly updatedAt: Date;
+```
+
+Defined in: [models/ISigningRequest.ts:41](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/ISigningRequest.ts#L41)
+
+Timestamp when the signing request was last updated.

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

@@ -0,0 +1,71 @@
+---
+title: 'Interface: ISigningSession'
+generated: true
+editUrl: false
+---
+
+# Interface: ISigningSession
+
+Defined in: [models/ISigningSession.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/ISigningSession.ts#L6)
+
+Normalized representation of a signing session or signing link.
+
+## Properties
+
+### expiresAt
+
+```ts
+readonly expiresAt: Date;
+```
+
+Defined in: [models/ISigningSession.ts:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/ISigningSession.ts#L20)
+
+Timestamp when the session expires.
+
+---
+
+### sessionId
+
+```ts
+readonly sessionId: string;
+```
+
+Defined in: [models/ISigningSession.ts:8](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/ISigningSession.ts#L8)
+
+Provider-specific session identifier.
+
+---
+
+### signerId
+
+```ts
+readonly signerId: string;
+```
+
+Defined in: [models/ISigningSession.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/ISigningSession.ts#L14)
+
+Signer this session was created for.
+
+---
+
+### signingRequestId
+
+```ts
+readonly signingRequestId: string;
+```
+
+Defined in: [models/ISigningSession.ts:11](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/ISigningSession.ts#L11)
+
+Signing request this session belongs to.
+
+---
+
+### signingUrl
+
+```ts
+readonly signingUrl: string;
+```
+
+Defined in: [models/ISigningSession.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/ISigningSession.ts#L17)
+
+URL the signer should be directed to for signing.

package/data/packages/platform-esigning/api/TypeAlias.SignerRole.md

@@ -0,0 +1,15 @@
+---
+title: 'Type Alias: SignerRole'
+generated: true
+editUrl: false
+---
+
+# Type Alias: SignerRole
+
+```ts
+type SignerRole = (typeof SignerRoles)[keyof typeof SignerRoles];
+```
+
+Defined in: [models/SignerRole.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/SignerRole.ts#L19)
+
+Union type derived from [SignerRoles](Variable.SignerRoles).

package/data/packages/platform-esigning/api/TypeAlias.SignerStatus.md

@@ -0,0 +1,15 @@
+---
+title: 'Type Alias: SignerStatus'
+generated: true
+editUrl: false
+---
+
+# Type Alias: SignerStatus
+
+```ts
+type SignerStatus = (typeof SignerStatuses)[keyof typeof SignerStatuses];
+```
+
+Defined in: [models/SignerStatus.ts:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/SignerStatus.ts#L20)
+
+Union type derived from [SignerStatuses](Variable.SignerStatuses).

package/data/packages/platform-esigning/api/TypeAlias.SigningFieldType.md

@@ -0,0 +1,15 @@
+---
+title: 'Type Alias: SigningFieldType'
+generated: true
+editUrl: false
+---
+
+# Type Alias: SigningFieldType
+
+```ts
+type SigningFieldType = (typeof SigningFieldTypes)[keyof typeof SigningFieldTypes];
+```
+
+Defined in: [models/SigningFieldType.ts:23](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/SigningFieldType.ts#L23)
+
+Union type derived from [SigningFieldTypes](Variable.SigningFieldTypes).

package/data/packages/platform-esigning/api/TypeAlias.SigningRequestStatus.md

@@ -0,0 +1,15 @@
+---
+title: 'Type Alias: SigningRequestStatus'
+generated: true
+editUrl: false
+---
+
+# Type Alias: SigningRequestStatus
+
+```ts
+type SigningRequestStatus = (typeof SigningRequestStatuses)[keyof typeof SigningRequestStatuses];
+```
+
+Defined in: [models/SigningRequestStatus.ts:22](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/SigningRequestStatus.ts#L22)
+
+Union type derived from [SigningRequestStatuses](Variable.SigningRequestStatuses).

package/data/packages/platform-esigning/api/TypeAlias.WebhookEventType.md

@@ -0,0 +1,15 @@
+---
+title: 'Type Alias: WebhookEventType'
+generated: true
+editUrl: false
+---
+
+# Type Alias: WebhookEventType
+
+```ts
+type WebhookEventType = (typeof WebhookEventTypes)[keyof typeof WebhookEventTypes];
+```
+
+Defined in: [models/WebhookEventType.ts:23](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/WebhookEventType.ts#L23)
+
+Union type derived from [WebhookEventTypes](Variable.WebhookEventTypes).

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

@@ -0,0 +1,15 @@
+---
+title: 'Variable: ADOBE\_SIGN\_BASE\_URL'
+generated: true
+editUrl: false
+---
+
+# Variable: ADOBE_SIGN_BASE_URL
+
+```ts
+const ADOBE_SIGN_BASE_URL: IConfigKey<string>;
+```
+
+Defined in: [adobe-sign/env.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/adobe-sign/env.ts#L18)
+
+Adobe Sign base URL.

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

@@ -0,0 +1,15 @@
+---
+title: 'Variable: ADOBE\_SIGN\_CLIENT\_SECRET'
+generated: true
+editUrl: false
+---
+
+# Variable: ADOBE_SIGN_CLIENT_SECRET
+
+```ts
+const ADOBE_SIGN_CLIENT_SECRET: IConfigKey<string>;
+```
+
+Defined in: [adobe-sign/env.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/adobe-sign/env.ts#L15)
+
+Adobe Sign client secret.

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

@@ -0,0 +1,15 @@
+---
+title: 'Variable: ADOBE\_SIGN\_CONFIG\_ENTRIES'
+generated: true
+editUrl: false
+---
+
+# Variable: ADOBE_SIGN_CONFIG_ENTRIES
+
+```ts
+const ADOBE_SIGN_CONFIG_ENTRIES: ReadonlyArray<Omit<IConfigRegistryEntry, 'module'>>;
+```
+
+Defined in: [adobe-sign/env.ts:28](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/adobe-sign/env.ts#L28)
+
+Configuration entries required by the Adobe Sign e-signing provider.

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

@@ -0,0 +1,15 @@
+---
+title: 'Variable: ADOBE\_SIGN\_INTEGRATION\_KEY'
+generated: true
+editUrl: false
+---
+
+# Variable: ADOBE_SIGN_INTEGRATION_KEY
+
+```ts
+const ADOBE_SIGN_INTEGRATION_KEY: IConfigKey<string>;
+```
+
+Defined in: [adobe-sign/env.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/adobe-sign/env.ts#L12)
+
+Adobe Sign integration key.

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

@@ -0,0 +1,15 @@
+---
+title: 'Variable: ADOBE\_SIGN\_WEBHOOK\_CLIENT\_ID'
+generated: true
+editUrl: false
+---
+
+# Variable: ADOBE_SIGN_WEBHOOK_CLIENT_ID
+
+```ts
+const ADOBE_SIGN_WEBHOOK_CLIENT_ID: IConfigKey<string>;
+```
+
+Defined in: [adobe-sign/env.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/adobe-sign/env.ts#L21)
+
+Adobe Sign webhook client ID for verification.

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

@@ -0,0 +1,15 @@
+---
+title: 'Variable: DOCUSIGN\_ACCOUNT\_ID'
+generated: true
+editUrl: false
+---
+
+# Variable: DOCUSIGN_ACCOUNT_ID
+
+```ts
+const DOCUSIGN_ACCOUNT_ID: IConfigKey<string>;
+```
+
+Defined in: [docusign/env.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/docusign/env.ts#L18)
+
+DocuSign account ID.

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

@@ -0,0 +1,15 @@
+---
+title: 'Variable: DOCUSIGN\_BASE\_URL'
+generated: true
+editUrl: false
+---
+
+# Variable: DOCUSIGN_BASE_URL
+
+```ts
+const DOCUSIGN_BASE_URL: IConfigKey<string>;
+```
+
+Defined in: [docusign/env.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/docusign/env.ts#L21)
+
+DocuSign base URL (e.g. https://demo.docusign.net for sandbox).

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

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

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

@@ -0,0 +1,15 @@
+---
+title: 'Variable: DOCUSIGN\_INTEGRATION\_KEY'
+generated: true
+editUrl: false
+---
+
+# Variable: DOCUSIGN_INTEGRATION_KEY
+
+```ts
+const DOCUSIGN_INTEGRATION_KEY: IConfigKey<string>;
+```
+
+Defined in: [docusign/env.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/docusign/env.ts#L12)
+
+DocuSign integration key (client ID).

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

@@ -0,0 +1,15 @@
+---
+title: 'Variable: DOCUSIGN\_SECRET\_KEY'
+generated: true
+editUrl: false
+---
+
+# Variable: DOCUSIGN_SECRET_KEY
+
+```ts
+const DOCUSIGN_SECRET_KEY: IConfigKey<string>;
+```
+
+Defined in: [docusign/env.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/docusign/env.ts#L15)
+
+DocuSign secret key (client secret).

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

@@ -0,0 +1,15 @@
+---
+title: 'Variable: DOCUSIGN\_WEBHOOK\_HMAC\_KEY'
+generated: true
+editUrl: false
+---
+
+# Variable: DOCUSIGN_WEBHOOK_HMAC_KEY
+
+```ts
+const DOCUSIGN_WEBHOOK_HMAC_KEY: IConfigKey<string>;
+```
+
+Defined in: [docusign/env.ts:24](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/docusign/env.ts#L24)
+
+DocuSign webhook HMAC key.

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

@@ -0,0 +1,15 @@
+---
+title: 'Variable: DROPBOX\_SIGN\_API\_KEY'
+generated: true
+editUrl: false
+---
+
+# Variable: DROPBOX_SIGN_API_KEY
+
+```ts
+const DROPBOX_SIGN_API_KEY: IConfigKey<string>;
+```
+
+Defined in: [dropbox-sign/env.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/dropbox-sign/env.ts#L12)
+
+Dropbox Sign API key.

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

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

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

@@ -0,0 +1,15 @@
+---
+title: 'Variable: DROPBOX\_SIGN\_CONFIG\_ENTRIES'
+generated: true
+editUrl: false
+---
+
+# Variable: DROPBOX_SIGN_CONFIG_ENTRIES
+
+```ts
+const DROPBOX_SIGN_CONFIG_ENTRIES: ReadonlyArray<Omit<IConfigRegistryEntry, 'module'>>;
+```
+
+Defined in: [dropbox-sign/env.ts:25](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/dropbox-sign/env.ts#L25)
+
+Configuration entries required by the Dropbox Sign e-signing provider.

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

@@ -0,0 +1,15 @@
+---
+title: 'Variable: DROPBOX\_SIGN\_WEBHOOK\_SECRET'
+generated: true
+editUrl: false
+---
+
+# Variable: DROPBOX_SIGN_WEBHOOK_SECRET
+
+```ts
+const DROPBOX_SIGN_WEBHOOK_SECRET: IConfigKey<string>;
+```
+
+Defined in: [dropbox-sign/env.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/dropbox-sign/env.ts#L18)
+
+Dropbox Sign webhook secret.