Class ContactClient

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

Inheritance

System.Object

ContactClient

Implements

IContactClient

IApiAccessor

Namespace: BoldSign.Api

Assembly: BoldSign.Api.dll

Syntax

public class ContactClient : object, IContactClient, IApiAccessor

Constructors

| Improve this Doc View Source

ContactClient()

Initializes a new instance of the ContactClient class.

Declaration

public ContactClient()

| Improve this Doc View Source

ContactClient(ApiClient)

Initializes a new instance of the ContactClient class using Configuration object.

Declaration

public ContactClient(ApiClient apiClient)

Parameters

Type	Name	Description
ApiClient	apiClient	An instance of ApiClient.

| Improve this Doc View Source

ContactClient(Configuration)

Initializes a new instance of the ContactClient class using Configuration object.

Declaration

public ContactClient(Configuration configuration = null)

Parameters

Type	Name	Description
Configuration	configuration	An instance of Configuration.

| Improve this Doc View Source

ContactClient(String)

Initializes a new instance of the ContactClient class.

Declaration

public ContactClient(string basePath)

Parameters

Type	Name	Description
System.String	basePath	A basePath.

Properties

| Improve this Doc View Source

Configuration

Gets or sets the configuration object.

Declaration

public Configuration Configuration { get; set; }

Property Value

Type	Description
Configuration	An instance of the Configuration.

| Improve this Doc View Source

ExceptionFactory

Gets or sets provides a factory method hook for the creation of exceptions.

Declaration

public ExceptionFactory ExceptionFactory { get; set; }

Property Value

Type	Description
ExceptionFactory

Methods

| Improve this Doc View Source

CreateContact(List<ContactDetails>)

Create Contact details.

Declaration

public CreatedContact CreateContact(List<ContactDetails> contactsDetailsList = null)

Parameters

Type	Name	Description
List<ContactDetails>	contactsDetailsList

Returns

Type	Description
CreatedContact	CreatedContact.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call.

| Improve this Doc View Source

CreateContactAsync(List<ContactDetails>)

Creates a new contact.

Declaration

public async Task<CreatedContact> CreateContactAsync(List<ContactDetails> contactDetailsList = null)

Parameters

Type	Name	Description
List<ContactDetails>	contactDetailsList	The contactDetailsList.

Returns

Type	Description
Task<CreatedContact>	A Task.

| Improve this Doc View Source

CreateContactAsyncWithHttpInfo(List<ContactDetails>)

Gets create the contact.

Declaration

public async Task<ApiResponse<CreatedContact>> CreateContactAsyncWithHttpInfo(List<ContactDetails> contactsDetailsList = null)

Parameters

Type	Name	Description
List<ContactDetails>	contactsDetailsList	The contactDetailsList.

Returns

Type	Description
Task<ApiResponse<CreatedContact>>	A Task of Response.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call.

| Improve this Doc View Source

CreateContactWithHttpInfo(List<ContactDetails>)

Creates a new contact.

Declaration

public ApiResponse<CreatedContact> CreateContactWithHttpInfo(List<ContactDetails> contactsDetailsList = null)

Parameters

Type	Name	Description
List<ContactDetails>	contactsDetailsList	The contactsDetailsList.

Returns

Type	Description
ApiResponse<CreatedContact>	A Task.

| Improve this Doc View Source

DeleteContact(String)

Delete the contact when a particular contact’s ID is given as input.

Declaration

public void DeleteContact(string id)

Parameters

Type	Name	Description
System.String	id	Contact Id.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call.

| Improve this Doc View Source

DeleteContactAsync(String)

Gets invite the user.

Declaration

public async Task DeleteContactAsync(string id)

Parameters

Type	Name	Description
System.String	id	The create user details.

Returns

Type	Description
Task	Task of void.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call.

| Improve this Doc View Source

DeleteContactAsyncWithHttpInfo(String)

Gets invite the user.

Declaration

public async Task<ApiResponse<object>> DeleteContactAsyncWithHttpInfo(string id)

Parameters

Type	Name	Description
System.String	id	The create user details.

Returns

Type	Description
Task<ApiResponse<System.Object>>	Task of ApiResponse.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call.

| Improve this Doc View Source

DeleteContactWithHttpInfo(String)

Delete the contact when a particular contact’s ID is given as input.

Declaration

public ApiResponse<object> DeleteContactWithHttpInfo(string id)

Parameters

Type	Name	Description
System.String	id	Contact Id.

Returns

Type	Description
ApiResponse<System.Object>	ApiResponse of Object(void).

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call.

| Improve this Doc View Source

GetBasePath()

Gets the base path of the API client.

Declaration

public string GetBasePath()

Returns

Type	Description
System.String	The base path.

| Improve this Doc View Source

GetContact(String)

Gets the contact.

Declaration

public ContactsDetails GetContact(string id)

Parameters

Type	Name	Description
System.String	id	The Contact ID.

Returns

Type	Description
ContactsDetails	A Contact Details.

| Improve this Doc View Source

GetContactAsync(String)

Gets the contact.

Declaration

public async Task<ContactsDetails> GetContactAsync(string id)

Parameters

Type	Name	Description
System.String	id	The Contact ID.

Returns

Type	Description
Task<ContactsDetails>	A Task.

| Improve this Doc View Source

GetContactAsyncWithHttpInfo(String)

Gets the contact.

Declaration

public async Task<ApiResponse<ContactsDetails>> GetContactAsyncWithHttpInfo(string id)

Parameters

Type	Name	Description
System.String	id	The Contact ID.

Returns

Type	Description
Task<ApiResponse<ContactsDetails>>	A Task.

| Improve this Doc View Source

GetContactWithHttpInfo(String)

Gets the contact.

Declaration

public ApiResponse<ContactsDetails> GetContactWithHttpInfo(string id)

Parameters

Type	Name	Description
System.String	id	The Contact ID.

Returns

Type	Description
ApiResponse<ContactsDetails>	A Task.

| Improve this Doc View Source

ListContacts(Int32, Nullable<Int32>, String, Nullable<ContactType>)

Gets the contact list.

Declaration

public ContactsList ListContacts(int page, int? pageSize = null, string searchKey = null, ContactType? contactType)

Parameters

Type	Name	Description
System.Int32	page	The page number.
System.Nullable<System.Int32>	pageSize	The page size.
System.String	searchKey	The search key.
System.Nullable<ContactType>	contactType	contactType.

Returns

Type	Description
ContactsList	A Task.

| Improve this Doc View Source

ListContactsAsync(Int32, Nullable<Int32>, String, Nullable<ContactType>)

Gets the contact list.

Declaration

public async Task<ContactsList> ListContactsAsync(int page, int? pageSize = null, string searchKey = null, ContactType? contactType)

Parameters

Type	Name	Description
System.Int32	page	The page number.
System.Nullable<System.Int32>	pageSize	The page size.
System.String	searchKey	The search key.
System.Nullable<ContactType>	contactType	contactType.

Returns

Type	Description
Task<ContactsList>	Task of ListContacts.

| Improve this Doc View Source

ListContactsAsyncWithHttpInfo(Int32, Nullable<Int32>, String, Nullable<ContactType>)

Gets the contact list.

Declaration

public async Task<ApiResponse<ContactsList>> ListContactsAsyncWithHttpInfo(int page, int? pageSize = null, string searchKey = null, ContactType? contactType)

Parameters

Type	Name	Description
System.Int32	page	The page number.
System.Nullable<System.Int32>	pageSize	The page size.
System.String	searchKey	The search key.
System.Nullable<ContactType>	contactType	contactType.

Returns

Type	Description
Task<ApiResponse<ContactsList>>	Task of ApiResponse (ListContacts).

| Improve this Doc View Source

ListContactsWithHttpInfo(Int32, Nullable<Int32>, String, Nullable<ContactType>)

Gets the contact list.

Declaration

public ApiResponse<ContactsList> ListContactsWithHttpInfo(int page, int? pageSize = null, string searchKey = null, ContactType? contactType)

Parameters

Type	Name	Description
System.Int32	page	The page number.
System.Nullable<System.Int32>	pageSize	The page size.
System.String	searchKey	The search key.
System.Nullable<ContactType>	contactType	contactType.

Returns

Type	Description
ApiResponse<ContactsList>	A Task.

| Improve this Doc View Source

UpdateContact(String, ContactDetails)

Creates a new contact.

Declaration

public void UpdateContact(string id, ContactDetails updateContact)

Parameters

Type	Name	Description
System.String	id	The Contact ID.
ContactDetails	updateContact	The Update Contact.

| Improve this Doc View Source

UpdateContactAsync(String, ContactDetails)

Creates a new contact.

Declaration

public async Task UpdateContactAsync(string id, ContactDetails updateContact)

Parameters

Type	Name	Description
System.String	id	The Contact ID.
ContactDetails	updateContact	The Update Contact.

Returns

Type	Description
Task	A Task.

| Improve this Doc View Source

UpdateContactAsyncWithHttpInfo(String, ContactDetails)

Creates a new contact.

Declaration

public async Task<ApiResponse<object>> UpdateContactAsyncWithHttpInfo(string id, ContactDetails updateContact)

Parameters

Type	Name	Description
System.String	id	The Contact ID.
ContactDetails	updateContact	The Update Contact.

Returns

Type	Description
Task<ApiResponse<System.Object>>	A Task.

| Improve this Doc View Source

UpdateContactWithHttpInfo(String, ContactDetails)

Creates a new contact.

Declaration

public ApiResponse<object> UpdateContactWithHttpInfo(string id, ContactDetails updateContact)

Parameters

Type	Name	Description
System.String	id	The Contact ID.
ContactDetails	updateContact	The Update Contact.

Returns

Type	Description
ApiResponse<System.Object>	A Task.

Implements

IContactClient

IApiAccessor