Interface IGroupContactClient

Namespace

BoldSign.Api

Assembly

BoldSign.Api.dll

Interface for GroupContactClient.

public interface IGroupContactClient

Methods

CreateGroupContact(GroupContactDetails)

Creates a new group contact.

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.

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.

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.

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.

void DeleteGroupContact(string groupId)

Parameters

groupId string

The ID of the group contact to delete.

DeleteGroupContactAsync(string)

Deletes a group contact.

Task DeleteGroupContactAsync(string groupId)

Parameters

groupId string

The ID of the group contact to delete.

Returns

Task

A Task of void.

DeleteGroupContactAsyncWithHttpInfo(string)

Deletes a group contact.

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

Parameters

groupId string

The ID of the group contact to delete.

Returns

Task<ApiResponse<object>>

A Task of void.

DeleteGroupContactWithHttpInfo(string)

Deletes a group contact.

ApiResponse<object> DeleteGroupContactWithHttpInfo(string groupId)

Parameters

groupId string

The ID of the group contact to delete.

Returns

ApiResponse<object>

A Task of void.

GetGroupContact(string)

Gets details of a specific group contact.

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.

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.

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.

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.

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.

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

Returns

Task<GroupContactsList>

A Task of GroupContactsList.

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

Gets a list of group contacts.

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

Returns

Task<ApiResponse<GroupContactsList>>

A Task of GroupContactsList.

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

Gets a list of group contacts.

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

Returns

ApiResponse<GroupContactsList>

A Task of GroupContactsList.

UpdateGroupContact(string, GroupContact)

Update group contact.

void UpdateGroupContact(string groupId, GroupContact updateGroupContact)

Parameters

groupId string

group id.

updateGroupContact GroupContact

update group contact.

UpdateGroupContactAsync(string, GroupContact)

Update group contact.

Task UpdateGroupContactAsync(string groupId, GroupContact updateGroupContact)

Parameters

groupId string

group id.

updateGroupContact GroupContact

update group contact.

Returns

Task

A Task.

UpdateGroupContactAsyncWithHttpInfo(string, GroupContact)

Update group contact.

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.

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

Parameters

groupId string

group id.

updateGroupContact GroupContact

update group contact.

Returns

ApiResponse<object>

A Task.