Class SenderIdentityClient
Represents a function to interact with the API endpoints. The function perform action such as creating sender identity and so on.
Inheritance
Namespace: BoldSign.Api
Assembly: BoldSign.Api.dll
Syntax
public class SenderIdentityClient : object, ISenderIdentityClient, IApiAccessor
Constructors
| Improve this Doc View SourceSenderIdentityClient()
Initializes a new instance of the SenderIdentityClient class.
Declaration
public SenderIdentityClient()
SenderIdentityClient(ApiClient)
Initializes a new instance of the SenderIdentityClient class Using configuration object.
Declaration
public SenderIdentityClient(ApiClient apiClient)
Parameters
Type | Name | Description |
---|---|---|
ApiClient | apiClient | An instance of api client. |
SenderIdentityClient(Configuration)
Initializes a new instance of the SenderIdentityClient class Using configuration object.
Declaration
public SenderIdentityClient(Configuration configuration = null)
Parameters
Type | Name | Description |
---|---|---|
Configuration | configuration | An instance of configuration. |
SenderIdentityClient(String)
Initializes a new instance of the SenderIdentityClient class.
Declaration
public SenderIdentityClient(string basePath)
Parameters
Type | Name | Description |
---|---|---|
System.String | basePath | A base path. |
Properties
| Improve this Doc View SourceConfiguration
Gets or sets the configuration object.
Declaration
public Configuration Configuration { get; set; }
Property Value
Type | Description |
---|---|
Configuration | An instance of the Configuration. |
ExceptionFactory
Gets or sets provides a factory method hook for the creation of exceptions.
Declaration
public ExceptionFactory ExceptionFactory { get; set; }
Property Value
Type | Description |
---|---|
ExceptionFactory |
Methods
| Improve this Doc View SourceCreateSenderIdentity(SenderIdentityRequest)
Creates the sender identity.
Declaration
public SenderIdentityCreated CreateSenderIdentity(SenderIdentityRequest createSenderIdentityRequest = null)
Parameters
Type | Name | Description |
---|---|---|
SenderIdentityRequest | createSenderIdentityRequest | The create sender identity details. |
Returns
Type | Description |
---|---|
SenderIdentityCreated | Create sender identity response. |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call. |
CreateSenderIdentityAsync(SenderIdentityRequest)
Creates the sender identity.
Declaration
public async Task<SenderIdentityCreated> CreateSenderIdentityAsync(SenderIdentityRequest createSenderIdentityRequest = null)
Parameters
Type | Name | Description |
---|---|---|
SenderIdentityRequest | createSenderIdentityRequest | The create sender identity details. |
Returns
Type | Description |
---|---|
Task<SenderIdentityCreated> | Task. |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call. |
CreateSenderIdentityAsyncWithHttpInfo(SenderIdentityRequest)
Creates the sender identity.
Declaration
public async Task<ApiResponse<SenderIdentityCreated>> CreateSenderIdentityAsyncWithHttpInfo(SenderIdentityRequest createSenderIdentityRequest = null)
Parameters
Type | Name | Description |
---|---|---|
SenderIdentityRequest | createSenderIdentityRequest | The create sender identity details. |
Returns
Type | Description |
---|---|
Task<ApiResponse<SenderIdentityCreated>> | ApiResponse of object create sender identity response. |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call. |
CreateSenderIdentityWithHttpInfo(SenderIdentityRequest)
Creates the sender identity.
Declaration
public ApiResponse<SenderIdentityCreated> CreateSenderIdentityWithHttpInfo(SenderIdentityRequest createSenderIdentityRequest = null)
Parameters
Type | Name | Description |
---|---|---|
SenderIdentityRequest | createSenderIdentityRequest | The create sender identity details. |
Returns
Type | Description |
---|---|
ApiResponse<SenderIdentityCreated> | ApiResponse of object create sender identity response. |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call. |
DeleteSenderIdentity(String)
Delete sender identity.
Declaration
public void DeleteSenderIdentity(string email)
Parameters
Type | Name | Description |
---|---|---|
System.String | The sender identity email. |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call. |
DeleteSenderIdentityAsync(String)
Delete sender identity.
Declaration
public async Task DeleteSenderIdentityAsync(string email)
Parameters
Type | Name | Description |
---|---|---|
System.String | The email address. |
Returns
Type | Description |
---|---|
Task | CancelInvite. |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call. |
DeleteSenderIdentityAsyncWithHttpInfo(String)
Delete sender identity.
Declaration
public async Task<ApiResponse<object>> DeleteSenderIdentityAsyncWithHttpInfo(string email)
Parameters
Type | Name | Description |
---|---|---|
System.String | The email address. |
Returns
Type | Description |
---|---|
Task<ApiResponse<System.Object>> | ApiResponse of Object(CancelInvite). |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call. |
DeleteSenderIdentityWithHttpInfo(String)
Delete sender identity.
Declaration
public ApiResponse<object> DeleteSenderIdentityWithHttpInfo(string email)
Parameters
Type | Name | Description |
---|---|---|
System.String | The email address. |
Returns
Type | Description |
---|---|
ApiResponse<System.Object> | ApiResponse of Object(void). |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call. |
GetBasePath()
Gets the base path of the api client.
Declaration
public string GetBasePath()
Returns
Type | Description |
---|---|
System.String | The base path. |
IsValidEmail(String)
Validate Email.
Declaration
public static bool IsValidEmail(string email)
Parameters
Type | Name | Description |
---|---|---|
System.String | Email Id. |
Returns
Type | Description |
---|---|
System.Boolean | True if the email is valid. |
ListSenderIdentities(Int32, Nullable<Int32>, String)
Gets the sender identity list.
Declaration
public SenderIdentityList ListSenderIdentities(int page, int? pageSize = null, string search = null)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | page | The page number. |
System.Nullable<System.Int32> | pageSize | The page size. |
System.String | search | The search key. |
Returns
Type | Description |
---|---|
SenderIdentityList | A Task. |
ListSenderIdentitiesAsync(Int32, Nullable<Int32>, String)
Gets the sender identity list.
Declaration
public async Task<SenderIdentityList> ListSenderIdentitiesAsync(int page, int? pageSize = null, string search = null)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | page | The page number. |
System.Nullable<System.Int32> | pageSize | The page size. |
System.String | search | The search key. |
Returns
Type | Description |
---|---|
Task<SenderIdentityList> | A Task. |
ListSenderIdentitiesAsyncWithHttpInfo(Int32, Nullable<Int32>, String)
Gets the sender identity list.
Declaration
public async Task<ApiResponse<SenderIdentityList>> ListSenderIdentitiesAsyncWithHttpInfo(int page, int? pageSize = null, string search = null)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | page | The page number. |
System.Nullable<System.Int32> | pageSize | The page size. |
System.String | search | The search key. |
Returns
Type | Description |
---|---|
Task<ApiResponse<SenderIdentityList>> | A Task. |
ListSenderIdentitiesWithHttpInfo(Int32, Nullable<Int32>, String)
Gets the sender identity list.
Declaration
public ApiResponse<SenderIdentityList> ListSenderIdentitiesWithHttpInfo(int page, int? pageSize = null, string search = null)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | page | The page number. |
System.Nullable<System.Int32> | pageSize | The page size. |
System.String | search | The search key. |
Returns
Type | Description |
---|---|
ApiResponse<SenderIdentityList> | A Task. |
RerequestSenderIdentity(String)
Rerequests the sender identity.
Declaration
public void RerequestSenderIdentity(string email)
Parameters
Type | Name | Description |
---|---|---|
System.String | The sender identity email. |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call. |
RerequestSenderIdentityAsync(String)
Rerequests the sender identity.
Declaration
public async Task RerequestSenderIdentityAsync(string email)
Parameters
Type | Name | Description |
---|---|---|
System.String | The sender identity email. |
Returns
Type | Description |
---|---|
Task | Rerequest response. |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call. |
RerequestSenderIdentityAsyncWithHttpInfo(String)
Rerequests the sender identity.
Declaration
public async Task<ApiResponse<object>> RerequestSenderIdentityAsyncWithHttpInfo(string email)
Parameters
Type | Name | Description |
---|---|---|
System.String | The sender identity email. |
Returns
Type | Description |
---|---|
Task<ApiResponse<System.Object>> | ApiResponse of Object(Rerequest). |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call. |
RerequestSenderIdentityWithHttpInfo(String)
Rerequests the sender identity.
Declaration
public ApiResponse<object> RerequestSenderIdentityWithHttpInfo(string email)
Parameters
Type | Name | Description |
---|---|---|
System.String | The sender identity email. |
Returns
Type | Description |
---|---|
ApiResponse<System.Object> | ApiResponse of Object(void). |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call. |
ResendInvitation(String)
Resend sender identity invitation.
Declaration
public void ResendInvitation(string email)
Parameters
Type | Name | Description |
---|---|---|
System.String | The sender identity email. |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call. |
ResendInvitationAsync(String)
Resend sender identity invitation.
Declaration
public async Task ResendInvitationAsync(string email)
Parameters
Type | Name | Description |
---|---|---|
System.String | The sender identity email. |
Returns
Type | Description |
---|---|
Task | ResendInvite. |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call. |
ResendInvitationAsyncWithHttpInfo(String)
Resend sender identity invitation.
Declaration
public async Task<ApiResponse<object>> ResendInvitationAsyncWithHttpInfo(string email)
Parameters
Type | Name | Description |
---|---|---|
System.String | The sender identity email. |
Returns
Type | Description |
---|---|
Task<ApiResponse<System.Object>> | ApiResponse of Object(ResendInvite). |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call. |
ResendInvitationWithHttpInfo(String)
Resend sender identity invitation.
Declaration
public ApiResponse<object> ResendInvitationWithHttpInfo(string email)
Parameters
Type | Name | Description |
---|---|---|
System.String | The sender identity email. |
Returns
Type | Description |
---|---|
ApiResponse<System.Object> | ApiResponse of Object(void). |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call. |
UpdateSenderIdentity(SenderIdentityRequest)
Updates sender identity name.
Declaration
public void UpdateSenderIdentity(SenderIdentityRequest editSenderIdentityRequest)
Parameters
Type | Name | Description |
---|---|---|
SenderIdentityRequest | editSenderIdentityRequest | Edit sender identity request. |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call. |
UpdateSenderIdentityAsync(SenderIdentityRequest)
Updates sender identity name.
Declaration
public async Task UpdateSenderIdentityAsync(SenderIdentityRequest editSenderIdentityRequest)
Parameters
Type | Name | Description |
---|---|---|
SenderIdentityRequest | editSenderIdentityRequest | Edit sender identity request. |
Returns
Type | Description |
---|---|
Task | Edit sender identity response. |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call. |
UpdateSenderIdentityAsyncWithHttpInfo(SenderIdentityRequest)
Updates sender identity name.
Declaration
public async Task<ApiResponse<object>> UpdateSenderIdentityAsyncWithHttpInfo(SenderIdentityRequest editSenderIdentityRequest)
Parameters
Type | Name | Description |
---|---|---|
SenderIdentityRequest | editSenderIdentityRequest | Edit sender identity request. |
Returns
Type | Description |
---|---|
Task<ApiResponse<System.Object>> | ApiResponse of object update sender identity response. |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call. |
UpdateSenderIdentityWithHttpInfo(SenderIdentityRequest)
Updates sender identity name.
Declaration
public ApiResponse<object> UpdateSenderIdentityWithHttpInfo(SenderIdentityRequest editSenderIdentityRequest)
Parameters
Type | Name | Description |
---|---|---|
SenderIdentityRequest | editSenderIdentityRequest | Edit sender identity request. |
Returns
Type | Description |
---|---|
ApiResponse<System.Object> | ApiResponse of Object(void). |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call. |