Namespace BoldSign.Api

Classes

ApiClient

API client is mainly responsible for making the HTTP call to the API backend.

ApiException

API Exception

ApiResponse<T>

API Response

BoldSignSignatureException

The signature verification exception message.

BrandingClient

Represents a collection of functions to interact with the API endpoints. The functions perform actions such as creating brand, deleting brand, listing the brand and so on.

Configuration

Represents a set of configuration settings.

ContactClient

Represents a function to interact with the API endpoints. The function perform action such as getting the Api credit details and so on.

CustomFieldClient

Represents a collection of functions to interact with the API endpoints. The functions perform actions such as creating custom field, deleting custom field, editing custom field and so on.

DocumentClient

Represents a collection of functions to interact with the API endpoints. The functions perform actions such as sending document to sign, getting document list, deleting a document, downloading audit log, downloading a document, changing access code of the desired signer and so on.

DocumentHelper

The Document helper.

GlobalConfiguration

GlobalConfiguration provides a compile-time extension point for globally configuring API Clients.

PlanClient

Represents a function to interact with the API endpoints. The function perform action such as getting the Api credit details and so on.

SenderIdentityClient

Represents a function to interact with the API endpoints. The function perform action such as creating sender identity and so on.

TeamClient

Represents a collection of functions to interact with the API endpoints. The functions perform actions such as create a new team, update team name, get team details with its group members, and get list of teams in an organization.

TemplateClient

Represents a collection of functions to interact with the API endpoints. The functions perform actions such as sending document sign request from template, deleting a template, listing the templates and so on.

UserClient

Represents a function to interact with the API endpoints. The function perform action such as getting the Api credit details and so on.

Interfaces

IApiAccessor

Represents configuration aspects required to interact with the API endpoints.

IBrandingClient

Represents a collection of functions to interact with the API endpoints. The functions perform actions such as creating brand, deleting brand, listing the brand and so on.

IContactClient

Contact Client.

ICustomFieldClient

Represents a collection of functions to interact with the API endpoints. The functions perform actions such as creating custom field, deleting custom field, editing custom field and so on.

IDocumentClient

Represents a collection of functions to interact with the API endpoints. The functions perform actions such as sending document to sign, getting document list, deleting a document, downloading audit log, downloading a document, changing access code of the desired signer and so on.

IPlanClient

Represents a function to interact with the API endpoints. The function perform action such as getting the Api credit details and so on.

IReadableConfiguration

Represents a readable-only configuration contract.

ISenderIdentityClient

Represents a function to interact with the API endpoints. The function perform action such as invite the sender identity and so on.

ITeamClient

Represents a collection of functions to interact with the API endpoints. The functions perform actions such as create a new team, update team name, get team details with its group members, and get list of teams in an organization.

ITemplateClient

Represents a collection of functions to interact with the API endpoints. The functions perform actions such as sending document sign request from template, deleting a template, listing the templates and so on.

IUserClient

Represents a function to interact with the API endpoints. The function perform action such as invite the user and so on.

Delegates

ExceptionFactory

A delegate to ExceptionFactory method