Table of Contents

Class SenderIdentityClient

Namespace
BoldSign.Api
Assembly
BoldSign.Api.dll

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

public class SenderIdentityClient : ISenderIdentityClient, IApiAccessor
Inheritance
SenderIdentityClient
Implements
Inherited Members

Constructors

SenderIdentityClient()

Initializes a new instance of the SenderIdentityClient class.

public SenderIdentityClient()

SenderIdentityClient(ApiClient)

Initializes a new instance of the SenderIdentityClient class Using configuration object.

public SenderIdentityClient(ApiClient apiClient)

Parameters

apiClient ApiClient

An instance of api client.

SenderIdentityClient(Configuration)

Initializes a new instance of the SenderIdentityClient class Using configuration object.

public SenderIdentityClient(Configuration configuration = null)

Parameters

configuration Configuration

An instance of configuration.

SenderIdentityClient(string)

Initializes a new instance of the SenderIdentityClient class.

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

CreateSenderIdentity(SenderIdentityRequest)

Creates the sender identity.

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

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

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

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

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

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

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

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

GetBasePath()

Gets the base path of the api client.

public string GetBasePath()

Returns

string

The base path.

IsValidEmail(string)

Validate Email.

public static bool IsValidEmail(string email)

Parameters

email string

Email Id.

Returns

bool

True if the email is valid.

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

Gets the sender identity list.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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