Class GroupContactClient

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 GroupContactClient : IGroupContactClient

Inheritance

object

GroupContactClient

Implements

IGroupContactClient

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

GroupContactClient()

Initializes a new instance of the GroupContactClient class.

public GroupContactClient()

GroupContactClient(ApiClient)

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

public GroupContactClient(ApiClient apiClient)

Parameters

apiClient ApiClient

An instance of ApiClient.

GroupContactClient(Configuration)

Initializes a new instance of the GroupContactClient class.

public GroupContactClient(Configuration configuration = null)

Parameters

configuration Configuration

configuration.

GroupContactClient(string)

Initializes a new instance of the GroupContactClient class.

public GroupContactClient(string basePath)

Parameters

basePath string

A base path.

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

CreateGroupContact(GroupContactDetails)

Creates a new group contact.

public CreateGroupContactResponse CreateGroupContact(GroupContactDetails groupContact = null)

Parameters

groupContact GroupContactDetails

The group contact details.

Returns

CreateGroupContactResponse

A Task of CreateGroupContactResponse.

CreateGroupContactAsync(GroupContactDetails)

Creates a new group contact.

public Task<CreateGroupContactResponse> CreateGroupContactAsync(GroupContactDetails groupContact)

Parameters

groupContact GroupContactDetails

The group contact details.

Returns

Task<CreateGroupContactResponse>

A Task of CreateGroupContactResponse.

CreateGroupContactAsyncWithHttpInfo(GroupContactDetails)

Creates a new group contact.

public Task<ApiResponse<CreateGroupContactResponse>> CreateGroupContactAsyncWithHttpInfo(GroupContactDetails groupContact)

Parameters

groupContact GroupContactDetails

The group contact details.

Returns

Task<ApiResponse<CreateGroupContactResponse>>

A Task of CreateGroupContactResponse.

CreateGroupContactWithHttpInfo(GroupContactDetails)

Creates a new group contact.

public ApiResponse<CreateGroupContactResponse> CreateGroupContactWithHttpInfo(GroupContactDetails groupContact)

Parameters

groupContact GroupContactDetails

The group contact details.

Returns

ApiResponse<CreateGroupContactResponse>

A Task of CreateGroupContactResponse.

DeleteGroupContact(string)

Deletes a group contact when a particular group's ID is given as input.

public void DeleteGroupContact(string groupId)

Parameters

groupId string

The ID of the group contact to delete.

Exceptions

ApiException

Thrown when fails to make API call.

DeleteGroupContactAsync(string)

Deletes a group contact when a particular group's ID is given as input.

public Task DeleteGroupContactAsync(string groupId)

Parameters

groupId string

The ID of the group contact to delete.

Returns

Task

A Task of void.

Exceptions

ApiException

Thrown when fails to make API call.

DeleteGroupContactAsyncWithHttpInfo(string)

Deletes a group contact when a particular group's ID is given as input.

public Task<ApiResponse<object>> DeleteGroupContactAsyncWithHttpInfo(string groupId)

Parameters

groupId string

The ID of the group contact to delete.

Returns

Task<ApiResponse<object>>

ApiResponse of Object(void).

Exceptions

ApiException

Thrown when fails to make API call.

DeleteGroupContactWithHttpInfo(string)

Deletes a group contact when a particular group's ID is given as input.

public ApiResponse<object> DeleteGroupContactWithHttpInfo(string groupId)

Parameters

groupId string

The ID of the group contact to delete.

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.

GetGroupContact(string)

Gets details of a specific group contact.

public GetGroupContactDetails GetGroupContact(string groupId)

Parameters

groupId string

The ID of the group contact.

Returns

GetGroupContactDetails

A Task of GetGroupContactDetails.

GetGroupContactAsync(string)

Gets details of a specific group contact.

public Task<GetGroupContactDetails> GetGroupContactAsync(string groupId)

Parameters

groupId string

The ID of the group contact.

Returns

Task<GetGroupContactDetails>

A Task of GetGroupContactDetails.

GetGroupContactAsyncWithHttpInfo(string)

Gets details of a specific group contact.

public Task<ApiResponse<GetGroupContactDetails>> GetGroupContactAsyncWithHttpInfo(string groupId)

Parameters

groupId string

The ID of the group contact.

Returns

Task<ApiResponse<GetGroupContactDetails>>

A Task of GetGroupContactDetails.

GetGroupContactWithHttpInfo(string)

Gets details of a specific group contact.

public ApiResponse<GetGroupContactDetails> GetGroupContactWithHttpInfo(string groupId)

Parameters

groupId string

The ID of the group contact.

Returns

ApiResponse<GetGroupContactDetails>

A Task of GetGroupContactDetails.

ListGroupContacts(int, int?, string, ContactType?, List<string>)

Gets a list of group contacts.

public GroupContactsList ListGroupContacts(int page, int? pageSize = null, string searchKey = null, ContactType? contactType = ContactType.AllContacts, List<string> directories = null)

Parameters

page int

The page number.

pageSize int?

The page size.

searchKey string

The search key.

contactType ContactType?

contact type.

directories List<string>

The directories.

Returns

GroupContactsList

A Task of GroupContactsList.

ListGroupContactsAsync(int, int?, string, ContactType?, List<string>)

Gets a list of group contacts.

public Task<GroupContactsList> ListGroupContactsAsync(int page, int? pageSize = null, string searchKey = null, ContactType? contactType = ContactType.AllContacts, List<string> directories = null)

Parameters

page int

The page number.

pageSize int?

The page size.

searchKey string

The search key.

contactType ContactType?

contact type.

directories List<string>

The list of directory identifiers to filter contacts.

Returns

Task<GroupContactsList>

A Task of GroupContactsList.

ListGroupContactsAsyncWithHttpInfo(int, int?, string, ContactType?, List<string>)

Gets the group contact list.

public Task<ApiResponse<GroupContactsList>> ListGroupContactsAsyncWithHttpInfo(int page, int? pageSize = null, string searchKey = null, ContactType? contactType = ContactType.AllContacts, List<string> directories = null)

Parameters

page int

The page number.

pageSize int?

The page size.

searchKey string

The search key.

contactType ContactType?

contact type.

directories List<string>

The list of directory identifiers to filter contacts.

Returns

Task<ApiResponse<GroupContactsList>>

A Task of ApiResponse containing GroupContactsList.

ListGroupContactsWithHttpInfo(int, int?, string, ContactType?, List<string>)

Gets the group contact list.

public ApiResponse<GroupContactsList> ListGroupContactsWithHttpInfo(int page, int? pageSize = null, string searchKey = null, ContactType? contactType = ContactType.AllContacts, List<string> directories = null)

Parameters

page int

The page number.

pageSize int?

The page size.

searchKey string

The search key.

contactType ContactType?

contact type.

directories List<string>

The list of directory identifiers to filter contacts.

Returns

ApiResponse<GroupContactsList>

A Task of ApiResponse containing GroupContactsList.

UpdateGroupContact(string, GroupContact)

Update group contact.

public void UpdateGroupContact(string groupId, GroupContact updateGroupContact)

Parameters

groupId string

group id.

updateGroupContact GroupContact

update group contact.

UpdateGroupContactAsync(string, GroupContact)

Updates a group contact.

public Task UpdateGroupContactAsync(string groupId, GroupContact updateGroupContact)

Parameters

groupId string

The ID of the group contact to update.

updateGroupContact GroupContact

updated group contact details.

Returns

Task

A Task of void.

UpdateGroupContactAsyncWithHttpInfo(string, GroupContact)

Update group contact.

public Task<ApiResponse<object>> UpdateGroupContactAsyncWithHttpInfo(string groupId, GroupContact updateGroupContact)

Parameters

groupId string

group id.

updateGroupContact GroupContact

update group contact.

Returns

Task<ApiResponse<object>>

A Task.

UpdateGroupContactWithHttpInfo(string, GroupContact)

Update group contact.

public ApiResponse<object> UpdateGroupContactWithHttpInfo(string groupId, GroupContact updateGroupContact)

Parameters

groupId string

group id.

updateGroupContact GroupContact

update group contact.

Returns

ApiResponse<object>

A Task.