docsign-ts-client

This is a TypeScript client for the Inleed Docsign API.

Example:

import { getDocuments } from 'docsign-ts-client';

const documents = await getDocuments(process.env.INLEED_API_KEY, 'pending');

Documentation

getDocuments(apiKey: string, status: string, limit?: number, offset?: number): Promise<Document[]>

Get documents with a specific status.

Parameters

| Name | Type | Description | | ------- | ---------------------- | ------------------------------------------------------------ | | apiKey | string | The API key to use for authentication. | | status | "pending", "completed" | The status of the documents to get. | | baseUrl | string | The base URL of the API. Defaults to https://docsign.se/api/ |

Returns

A promise that resolves to an array of documents.

getParties(apiKey: string, baseUrl: string = "https://docsign.se/api/"): Promise<Party[]>

Get parties

Parameters

| Name | Type | Description | | ------- | ------ | ------------------------------------------------------------ | | apiKey | string | The API key to use for authentication. | | baseUrl | string | The base URL of the API. Defaults to https://docsign.se/api/ |

Returns

A promise that resolves to an array of parties.

postDocument(apiKey: string, document: CreateDocumentRequest, baseUrl: string = "https://docsign.se/api/"): Promise

Creates a document

Parameters

| Name | Type | Description | | ------- | ------ | ------------------------------------------------------------ | | apiKey | string | The API key to use for authentication. | | baseUrl | string | The base URL of the API. Defaults to https://docsign.se/api/ |

Returns

A promise that resolves to the created response status (PostDocumentResponse)

postParty(apiKey: string, party: Party, baseUrl: string = "https://docsign.se/api/"): Promise

Creates a party

Parameters

| Name | Type | Description | | ------- | ------ | ------------------------------------------------------------ | | apiKey | string | The API key to use for authentication. | | baseUrl | string | The base URL of the API. Defaults to https://docsign.se/api/ |

Returns

A promise that resolves to the created response status (PostPartyResponse)

Debugging

Both document and party creation support a debug flag on the party-object that can be used during development.

const party = {
  name: 'Test Party',
  email: '[email protected]',
  debug: true,
};