Class ContactClient

Namespace

BoldSign.Api

Assembly

BoldSign.Api.dll

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

public class ContactClient : IContactClient, IApiAccessor

Inheritance

object

ContactClient

Implements

IContactClient

IApiAccessor

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

ContactClient()

Initializes a new instance of the ContactClient class.

public ContactClient()

ContactClient(ApiClient)

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

public ContactClient(ApiClient apiClient)

Parameters

apiClient ApiClient

An instance of ApiClient.

ContactClient(Configuration)

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

public ContactClient(Configuration configuration = null)

Parameters

configuration Configuration

An instance of Configuration.

ContactClient(string)

Initializes a new instance of the ContactClient class.

public ContactClient(string basePath)

Parameters

basePath string

A basePath.

Properties

Configuration

Gets or sets the configuration object.

public Configuration Configuration { get; set; }

Property Value

Configuration

An instance of the Configuration.

ExceptionFactory

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

public ExceptionFactory ExceptionFactory { get; set; }

Property Value

ExceptionFactory

Methods

CreateContact(List<ContactDetails>)

Create Contact details.

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

Parameters

contactsDetailsList List<ContactDetails>

Returns

CreatedContact

CreatedContact.

Exceptions

ApiException

Thrown when fails to make API call.

CreateContactAsync(List<ContactDetails>)

Creates a new contact.

public 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.

public 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.

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

Parameters

contactsDetailsList List<ContactDetails>

The contactsDetailsList.

Returns

ApiResponse<CreatedContact>

A Task.

DeleteContact(string)

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

public void DeleteContact(string id)

Parameters

id string

Contact Id.

Exceptions

ApiException

Thrown when fails to make API call.

DeleteContactAsync(string)

Gets invite the user.

public Task DeleteContactAsync(string id)

Parameters

id string

The create user details.

Returns

Task

Task of void.

Exceptions

ApiException

Thrown when fails to make API call.

DeleteContactAsyncWithHttpInfo(string)

Gets invite the user.

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

Parameters

id string

The create user details.

Returns

Task<ApiResponse<object>>

Task of ApiResponse.

Exceptions

ApiException

Thrown when fails to make API call.

DeleteContactWithHttpInfo(string)

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

public 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.

GetBasePath()

Gets the base path of the API client.

public string GetBasePath()

Returns

string

The base path.

GetContact(string)

Gets the contact.

public ContactsDetails GetContact(string id)

Parameters

id string

The Contact ID.

Returns

ContactsDetails

A Contact Details.

GetContactAsync(string)

Gets the contact.

public Task<ContactsDetails> GetContactAsync(string id)

Parameters

id string

The Contact ID.

Returns

Task<ContactsDetails>

A Task.

GetContactAsyncWithHttpInfo(string)

Gets the contact.

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

Parameters

id string

The Contact ID.

Returns

Task<ApiResponse<ContactsDetails>>

A Task.

GetContactWithHttpInfo(string)

Gets the contact.

public 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.

public 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.

public 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>

Task of ListContacts.

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

Gets the contact list.

public 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>>

Task of ApiResponse (ListContacts).

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

Gets the contact list.

public 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.

public void UpdateContact(string id, ContactDetails updateContact)

Parameters

id string

The Contact ID.

updateContact ContactDetails

The Update Contact.

UpdateContactAsync(string, ContactDetails)

Creates a new contact.

public 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.

public 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.

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

Parameters

id string

The Contact ID.

updateContact ContactDetails

The Update Contact.

Returns

ApiResponse<object>

A Task.