Interface ISenderIdentityClient

Namespace

BoldSign.Api

Assembly

BoldSign.Api.dll

Represents a function to interact with the API endpoints. The function perform action such as invite the sender identity and so on.

public interface ISenderIdentityClient : IApiAccessor

Inherited Members

IApiAccessor.Configuration

IApiAccessor.ExceptionFactory

IApiAccessor.GetBasePath()

Methods

CreateSenderIdentity(SenderIdentityRequest)

Creates the sender identity.

SenderIdentityCreated CreateSenderIdentity(SenderIdentityRequest createSenderIdentityRequest = null)

Parameters

createSenderIdentityRequest SenderIdentityRequest

The create sender identity details.

Returns

SenderIdentityCreated

Create sender identity response.

Exceptions

ApiException

Thrown when fails to make API call.

CreateSenderIdentityAsync(SenderIdentityRequest)

Creates the sender identity.

Task<SenderIdentityCreated> CreateSenderIdentityAsync(SenderIdentityRequest createSenderIdentityRequest = null)

Parameters

createSenderIdentityRequest SenderIdentityRequest

The create sender identity details.

Returns

Task<SenderIdentityCreated>

Task.

Exceptions

ApiException

Thrown when fails to make API call.

CreateSenderIdentityAsyncWithHttpInfo(SenderIdentityRequest)

Creates the sender identity.

Task<ApiResponse<SenderIdentityCreated>> CreateSenderIdentityAsyncWithHttpInfo(SenderIdentityRequest createSenderIdentityRequest = null)

Parameters

createSenderIdentityRequest SenderIdentityRequest

The create sender identity details.

Returns

Task<ApiResponse<SenderIdentityCreated>>

ApiResponse of object create sender identity response.

Exceptions

ApiException

Thrown when fails to make API call.

CreateSenderIdentityWithHttpInfo(SenderIdentityRequest)

Creates the sender identity.

ApiResponse<SenderIdentityCreated> CreateSenderIdentityWithHttpInfo(SenderIdentityRequest createSenderIdentityRequest = null)

Parameters

createSenderIdentityRequest SenderIdentityRequest

The create sender identity details.

Returns

ApiResponse<SenderIdentityCreated>

ApiResponse of object create sender identity response.

Exceptions

ApiException

Thrown when fails to make API call.

DeleteSenderIdentity(string)

Delete sender identity.

void DeleteSenderIdentity(string email)

Parameters

email string

The sender identity email.

Exceptions

ApiException

Thrown when fails to make API call.

DeleteSenderIdentityAsync(string)

Delete sender identity.

Task DeleteSenderIdentityAsync(string email)

Parameters

email string

The email address.

Returns

Task

CancelInvite.

Exceptions

ApiException

Thrown when fails to make API call.

DeleteSenderIdentityAsyncWithHttpInfo(string)

Delete sender identity.

Task<ApiResponse<object>> DeleteSenderIdentityAsyncWithHttpInfo(string email)

Parameters

email string

The email address.

Returns

Task<ApiResponse<object>>

ApiResponse of Object(CancelInvite).

Exceptions

ApiException

Thrown when fails to make API call.

DeleteSenderIdentityWithHttpInfo(string)

Delete sender identity.

ApiResponse<object> DeleteSenderIdentityWithHttpInfo(string email)

Parameters

email string

The email address.

Returns

ApiResponse<object>

ApiResponse of Object(void).

Exceptions

ApiException

Thrown when fails to make API call.

ListSenderIdentities(int, int?, string, List<string>)

Gets the sender identity list.

SenderIdentityList ListSenderIdentities(int page, int? pageSize = null, string search = null, List<string> brandIds = null)

Parameters

page int

The page number.

pageSize int?

The page size.

search string

The search key.

brandIds List<string>

The list of brand IDs to filter associated with the sender identity.

Returns

SenderIdentityList

A Task.

ListSenderIdentitiesAsync(int, int?, string, List<string>)

Gets the sender identity list.

Task<SenderIdentityList> ListSenderIdentitiesAsync(int page, int? pageSize = null, string search = null, List<string> brandIds = null)

Parameters

page int

The page number.

pageSize int?

The page size.

search string

The search key.

brandIds List<string>

The list of brand IDs to filter associated with the sender identity.

Returns

Task<SenderIdentityList>

A Task.

ListSenderIdentitiesAsyncWithHttpInfo(int, int?, string, List<string>)

Gets the sender identity list.

Task<ApiResponse<SenderIdentityList>> ListSenderIdentitiesAsyncWithHttpInfo(int page, int? pageSize = null, string search = null, List<string> brandIds = null)

Parameters

page int

The page number.

pageSize int?

The page size.

search string

The search key.

brandIds List<string>

The list of brand IDs to filter associated with the sender identity.

Returns

Task<ApiResponse<SenderIdentityList>>

A Task.

ListSenderIdentitiesWithHttpInfo(int, int?, string, List<string>)

Gets the sender identity list.

ApiResponse<SenderIdentityList> ListSenderIdentitiesWithHttpInfo(int page, int? pageSize = null, string search = null, List<string> brandIds = null)

Parameters

page int

The page number.

pageSize int?

The page size.

search string

The search key.

brandIds List<string>

The list of brand IDs to filter associated with the sender identity.

Returns

ApiResponse<SenderIdentityList>

A Task.

RerequestSenderIdentity(string)

Rerequests the sender identity.

void RerequestSenderIdentity(string email)

Parameters

email string

The sender identity email.

Exceptions

ApiException

Thrown when fails to make API call.

RerequestSenderIdentityAsync(string)

Rerequests the sender identity.

Task RerequestSenderIdentityAsync(string email)

Parameters

email string

The sender identity email.

Returns

Task

Rerequest response.

Exceptions

ApiException

Thrown when fails to make API call.

RerequestSenderIdentityAsyncWithHttpInfo(string)

Rerequests the sender identity.

Task<ApiResponse<object>> RerequestSenderIdentityAsyncWithHttpInfo(string email)

Parameters

email string

The sender identity email.

Returns

Task<ApiResponse<object>>

ApiResponse of Object(Rerequest).

Exceptions

ApiException

Thrown when fails to make API call.

RerequestSenderIdentityWithHttpInfo(string)

Rerequests the sender identity.

ApiResponse<object> RerequestSenderIdentityWithHttpInfo(string email)

Parameters

email string

The sender identity email.

Returns

ApiResponse<object>

ApiResponse of Object(void).

Exceptions

ApiException

Thrown when fails to make API call.

ResendInvitation(string)

Resend sender identity invitation.

void ResendInvitation(string email)

Parameters

email string

The sender identity email.

Exceptions

ApiException

Thrown when fails to make API call.

ResendInvitationAsync(string)

Resend sender identity invitation.

Task ResendInvitationAsync(string email)

Parameters

email string

The sender identity email.

Returns

Task

ResendInvite.

Exceptions

ApiException

Thrown when fails to make API call.

ResendInvitationAsyncWithHttpInfo(string)

Resend sender identity invitation.

Task<ApiResponse<object>> ResendInvitationAsyncWithHttpInfo(string email)

Parameters

email string

The sender identity email.

Returns

Task<ApiResponse<object>>

ApiResponse of Object(ResendInvite).

Exceptions

ApiException

Thrown when fails to make API call.

ResendInvitationWithHttpInfo(string)

Resend sender identity invitation.

ApiResponse<object> ResendInvitationWithHttpInfo(string email)

Parameters

email string

The sender identity email.

Returns

ApiResponse<object>

ApiResponse of Object(void).

Exceptions

ApiException

Thrown when fails to make API call.

UpdateSenderIdentity(SenderIdentityRequest)

Updates sender identity name.

void UpdateSenderIdentity(SenderIdentityRequest editSenderIdentityRequest)

Parameters

editSenderIdentityRequest SenderIdentityRequest

Edit sender identity request.

Exceptions

ApiException

Thrown when fails to make API call.

UpdateSenderIdentityAsync(SenderIdentityRequest)

Updates sender identity name.

Task UpdateSenderIdentityAsync(SenderIdentityRequest editSenderIdentityRequest)

Parameters

editSenderIdentityRequest SenderIdentityRequest

Edit sender identity request.

Returns

Task

Edit sender identity response.

Exceptions

ApiException

Thrown when fails to make API call.

UpdateSenderIdentityAsyncWithHttpInfo(SenderIdentityRequest)

Updates sender identity name.

Task<ApiResponse<object>> UpdateSenderIdentityAsyncWithHttpInfo(SenderIdentityRequest editSenderIdentityRequest)

Parameters

editSenderIdentityRequest SenderIdentityRequest

Edit sender identity request.

Returns

Task<ApiResponse<object>>

ApiResponse of object update sender identity response.

Exceptions

ApiException

Thrown when fails to make API call.

UpdateSenderIdentityWithHttpInfo(SenderIdentityRequest)

Updates sender identity name.

ApiResponse<object> UpdateSenderIdentityWithHttpInfo(SenderIdentityRequest editSenderIdentityRequest)

Parameters

editSenderIdentityRequest SenderIdentityRequest

Edit sender identity request.

Returns

ApiResponse<object>

ApiResponse of Object(void).

Exceptions

ApiException

Thrown when fails to make API call.