Table of Contents

Interface IContactClient

Namespace
BoldSign.Api
Assembly
BoldSign.Api.dll

Contact Client.

public interface IContactClient : IApiAccessor
Inherited Members

Methods

CreateContact(List<ContactDetails>)

Create Contact details.

CreatedContact CreateContact(List<ContactDetails> contactsDetails)

Parameters

contactsDetails List<ContactDetails>

Contact details.

Returns

CreatedContact

CreatedContact.

Exceptions

ApiException

Thrown when fails to make API call.

CreateContactAsync(List<ContactDetails>)

Creates a new contact.

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

Parameters

contactDetailsList List<ContactDetails>

The contactDetailsList.

Returns

Task<CreatedContact>

A Task.

CreateContactAsyncWithHttpInfo(List<ContactDetails>)

Gets create the contact.

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

Parameters

contactsDetailsList List<ContactDetails>

The contactDetailsList.

Returns

Task<ApiResponse<CreatedContact>>

A Task of Response.

Exceptions

ApiException

Thrown when fails to make API call.

CreateContactWithHttpInfo(List<ContactDetails>)

Creates a new contact.

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

Parameters

contactsDetailsList List<ContactDetails>

The contactsDetailsList.

Returns

ApiResponse<CreatedContact>

A Task.

DeleteContact(string)

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

void DeleteContact(string id)

Parameters

id string

Contact Id.

Exceptions

ApiException

Thrown when fails to make API call.

DeleteContactAsync(string)

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

Task DeleteContactAsync(string id)

Parameters

id string

Contact Id.

Returns

Task

Task of void.

Exceptions

ApiException

Thrown when fails to make API call.

DeleteContactAsyncWithHttpInfo(string)

Delete the brand.

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

Parameters

id string

Contact Id.

Returns

Task<ApiResponse<object>>

Task of ApiResponse.

Exceptions

ApiException

Thrown when fails to make API call.

DeleteContactWithHttpInfo(string)

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

ApiResponse<object> DeleteContactWithHttpInfo(string id)

Parameters

id string

Contact Id.

Returns

ApiResponse<object>

ApiResponse of Object(void).

Exceptions

ApiException

Thrown when fails to make API call.

GetContact(string)

Gets the contact.

ContactsDetails GetContact(string id)

Parameters

id string

The Contact ID.

Returns

ContactsDetails

A Contact Details.

GetContactAsync(string)

Gets the contact.

Task<ContactsDetails> GetContactAsync(string id)

Parameters

id string

The Contact ID.

Returns

Task<ContactsDetails>

A Task.

GetContactAsyncWithHttpInfo(string)

Gets the contact.

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

Parameters

id string

The Contact ID.

Returns

Task<ApiResponse<ContactsDetails>>

A Task.

GetContactWithHttpInfo(string)

Gets the contact.

ApiResponse<ContactsDetails> GetContactWithHttpInfo(string id)

Parameters

id string

The Contact ID.

Returns

ApiResponse<ContactsDetails>

A Task.

ListContacts(int, int?, string, ContactType?)

Gets the contact list.

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

Parameters

page int

The page number.

pageSize int?

The page size.

searchKey string

The search key.

contactType ContactType?

contactType.

Returns

ContactsList

A Task.

ListContactsAsync(int, int?, string, ContactType?)

Gets the contact list.

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

Parameters

page int

The page number.

pageSize int?

The page size.

searchKey string

The search key.

contactType ContactType?

contactType.

Returns

Task<ContactsList>

A Task.

ListContactsAsyncWithHttpInfo(int, int?, string, ContactType?)

Gets the contact list.

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

Parameters

page int

The page number.

pageSize int?

The page size.

searchKey string

The search key.

contactType ContactType?

contactType.

Returns

Task<ApiResponse<ContactsList>>

A Task.

ListContactsWithHttpInfo(int, int?, string, ContactType?)

Gets the contact list.

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

Parameters

page int

The page number.

pageSize int?

The page size.

searchKey string

The search key.

contactType ContactType?

contactType.

Returns

ApiResponse<ContactsList>

A Task.

UpdateContact(string, ContactDetails)

Creates a new contact.

void UpdateContact(string id, ContactDetails updateContact)

Parameters

id string

The Contact ID.

updateContact ContactDetails

The Update Contact.

UpdateContactAsync(string, ContactDetails)

Creates a new contact.

Task UpdateContactAsync(string id, ContactDetails updateContact)

Parameters

id string

The Contact ID.

updateContact ContactDetails

The Update Contact.

Returns

Task

A Task.

UpdateContactAsyncWithHttpInfo(string, ContactDetails)

Creates a new contact.

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

Parameters

id string

The Contact ID.

updateContact ContactDetails

The Update Contact.

Returns

Task<ApiResponse<object>>

A Task.

UpdateContactWithHttpInfo(string, ContactDetails)

Creates a new contact.

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

Parameters

id string

The Contact ID.

updateContact ContactDetails

The Update Contact.

Returns

ApiResponse<object>

A Task.