Search Results for

    Show / Hide Table of Contents

    Class WebhookControllerApi

    Represents a collection of functions to interact with the API endpoints

    Inheritance
    object
    WebhookControllerApi
    Implements
    IWebhookControllerApi
    IWebhookControllerApiSync
    IWebhookControllerApiAsync
    IApiAccessor
    Inherited Members
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: mailslurp.Api
    Assembly: mailslurp.dll
    Syntax
    public class WebhookControllerApi : IWebhookControllerApi, IWebhookControllerApiSync, IWebhookControllerApiAsync, IApiAccessor

    Constructors

    View Source

    WebhookControllerApi()

    Initializes a new instance of the WebhookControllerApi class.

    Declaration
    public WebhookControllerApi()
    View Source

    WebhookControllerApi(Configuration)

    Initializes a new instance of the WebhookControllerApi class using Configuration object

    Declaration
    public WebhookControllerApi(Configuration configuration)
    Parameters
    Type Name Description
    Configuration configuration

    An instance of Configuration

    View Source

    WebhookControllerApi(ISynchronousClient, IAsynchronousClient, IReadableConfiguration)

    Initializes a new instance of the WebhookControllerApi class using a Configuration object and client instance.

    Declaration
    public WebhookControllerApi(ISynchronousClient client, IAsynchronousClient asyncClient, IReadableConfiguration configuration)
    Parameters
    Type Name Description
    ISynchronousClient client

    The client interface for synchronous API access.

    IAsynchronousClient asyncClient

    The client interface for asynchronous API access.

    IReadableConfiguration configuration

    The configuration object.

    View Source

    WebhookControllerApi(string)

    Initializes a new instance of the WebhookControllerApi class.

    Declaration
    public WebhookControllerApi(string basePath)
    Parameters
    Type Name Description
    string basePath

    Properties

    View Source

    AsynchronousClient

    The client for accessing this underlying API asynchronously.

    Declaration
    public IAsynchronousClient AsynchronousClient { get; set; }
    Property Value
    Type Description
    IAsynchronousClient
    View Source

    Client

    The client for accessing this underlying API synchronously.

    Declaration
    public ISynchronousClient Client { get; set; }
    Property Value
    Type Description
    ISynchronousClient
    View Source

    Configuration

    Gets or sets the configuration object

    Declaration
    public IReadableConfiguration Configuration { get; set; }
    Property Value
    Type Description
    IReadableConfiguration

    An instance of the Configuration

    View Source

    ExceptionFactory

    Provides a factory method hook for the creation of exceptions.

    Declaration
    public ExceptionFactory ExceptionFactory { get; set; }
    Property Value
    Type Description
    ExceptionFactory

    Methods

    View Source

    CreateAccountWebhook(CreateWebhookOptions, int)

    Attach a WebHook URL to an inbox Get notified of account level events such as bounce and bounce recipient.

    Declaration
    public WebhookDto CreateAccountWebhook(CreateWebhookOptions createWebhookOptions, int operationIndex = 0)
    Parameters
    Type Name Description
    CreateWebhookOptions createWebhookOptions
    int operationIndex

    Index associated with the operation.

    Returns
    Type Description
    WebhookDto

    WebhookDto

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    CreateAccountWebhookAsync(CreateWebhookOptions, int, CancellationToken)

    Attach a WebHook URL to an inbox Get notified of account level events such as bounce and bounce recipient.

    Declaration
    public Task<WebhookDto> CreateAccountWebhookAsync(CreateWebhookOptions createWebhookOptions, int operationIndex = 0, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    CreateWebhookOptions createWebhookOptions
    int operationIndex

    Index associated with the operation.

    CancellationToken cancellationToken

    Cancellation Token to cancel the request.

    Returns
    Type Description
    Task<WebhookDto>

    Task of WebhookDto

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    CreateAccountWebhookWithHttpInfo(CreateWebhookOptions, int)

    Attach a WebHook URL to an inbox Get notified of account level events such as bounce and bounce recipient.

    Declaration
    public ApiResponse<WebhookDto> CreateAccountWebhookWithHttpInfo(CreateWebhookOptions createWebhookOptions, int operationIndex = 0)
    Parameters
    Type Name Description
    CreateWebhookOptions createWebhookOptions
    int operationIndex

    Index associated with the operation.

    Returns
    Type Description
    ApiResponse<WebhookDto>

    ApiResponse of WebhookDto

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    CreateAccountWebhookWithHttpInfoAsync(CreateWebhookOptions, int, CancellationToken)

    Attach a WebHook URL to an inbox Get notified of account level events such as bounce and bounce recipient.

    Declaration
    public Task<ApiResponse<WebhookDto>> CreateAccountWebhookWithHttpInfoAsync(CreateWebhookOptions createWebhookOptions, int operationIndex = 0, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    CreateWebhookOptions createWebhookOptions
    int operationIndex

    Index associated with the operation.

    CancellationToken cancellationToken

    Cancellation Token to cancel the request.

    Returns
    Type Description
    Task<ApiResponse<WebhookDto>>

    Task of ApiResponse (WebhookDto)

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    CreateWebhook(Guid, CreateWebhookOptions, int)

    Attach a WebHook URL to an inbox Get notified whenever an inbox receives an email via a WebHook URL. An emailID will be posted to this URL every time an email is received for this inbox. The URL must be publicly reachable by the MailSlurp server. You can provide basicAuth values if you wish to secure this endpoint.

    Declaration
    public WebhookDto CreateWebhook(Guid inboxId, CreateWebhookOptions createWebhookOptions, int operationIndex = 0)
    Parameters
    Type Name Description
    System.Guid inboxId
    CreateWebhookOptions createWebhookOptions
    int operationIndex

    Index associated with the operation.

    Returns
    Type Description
    WebhookDto

    WebhookDto

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    CreateWebhookAsync(Guid, CreateWebhookOptions, int, CancellationToken)

    Attach a WebHook URL to an inbox Get notified whenever an inbox receives an email via a WebHook URL. An emailID will be posted to this URL every time an email is received for this inbox. The URL must be publicly reachable by the MailSlurp server. You can provide basicAuth values if you wish to secure this endpoint.

    Declaration
    public Task<WebhookDto> CreateWebhookAsync(Guid inboxId, CreateWebhookOptions createWebhookOptions, int operationIndex = 0, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    System.Guid inboxId
    CreateWebhookOptions createWebhookOptions
    int operationIndex

    Index associated with the operation.

    CancellationToken cancellationToken

    Cancellation Token to cancel the request.

    Returns
    Type Description
    Task<WebhookDto>

    Task of WebhookDto

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    CreateWebhookForPhoneNumber(Guid, CreateWebhookOptions, int)

    Attach a WebHook URL to a phone number Get notified whenever a phone number receives an SMS via a WebHook URL.

    Declaration
    public WebhookDto CreateWebhookForPhoneNumber(Guid phoneNumberId, CreateWebhookOptions createWebhookOptions, int operationIndex = 0)
    Parameters
    Type Name Description
    System.Guid phoneNumberId
    CreateWebhookOptions createWebhookOptions
    int operationIndex

    Index associated with the operation.

    Returns
    Type Description
    WebhookDto

    WebhookDto

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    CreateWebhookForPhoneNumberAsync(Guid, CreateWebhookOptions, int, CancellationToken)

    Attach a WebHook URL to a phone number Get notified whenever a phone number receives an SMS via a WebHook URL.

    Declaration
    public Task<WebhookDto> CreateWebhookForPhoneNumberAsync(Guid phoneNumberId, CreateWebhookOptions createWebhookOptions, int operationIndex = 0, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    System.Guid phoneNumberId
    CreateWebhookOptions createWebhookOptions
    int operationIndex

    Index associated with the operation.

    CancellationToken cancellationToken

    Cancellation Token to cancel the request.

    Returns
    Type Description
    Task<WebhookDto>

    Task of WebhookDto

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    CreateWebhookForPhoneNumberWithHttpInfo(Guid, CreateWebhookOptions, int)

    Attach a WebHook URL to a phone number Get notified whenever a phone number receives an SMS via a WebHook URL.

    Declaration
    public ApiResponse<WebhookDto> CreateWebhookForPhoneNumberWithHttpInfo(Guid phoneNumberId, CreateWebhookOptions createWebhookOptions, int operationIndex = 0)
    Parameters
    Type Name Description
    System.Guid phoneNumberId
    CreateWebhookOptions createWebhookOptions
    int operationIndex

    Index associated with the operation.

    Returns
    Type Description
    ApiResponse<WebhookDto>

    ApiResponse of WebhookDto

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    CreateWebhookForPhoneNumberWithHttpInfoAsync(Guid, CreateWebhookOptions, int, CancellationToken)

    Attach a WebHook URL to a phone number Get notified whenever a phone number receives an SMS via a WebHook URL.

    Declaration
    public Task<ApiResponse<WebhookDto>> CreateWebhookForPhoneNumberWithHttpInfoAsync(Guid phoneNumberId, CreateWebhookOptions createWebhookOptions, int operationIndex = 0, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    System.Guid phoneNumberId
    CreateWebhookOptions createWebhookOptions
    int operationIndex

    Index associated with the operation.

    CancellationToken cancellationToken

    Cancellation Token to cancel the request.

    Returns
    Type Description
    Task<ApiResponse<WebhookDto>>

    Task of ApiResponse (WebhookDto)

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    CreateWebhookWithHttpInfo(Guid, CreateWebhookOptions, int)

    Attach a WebHook URL to an inbox Get notified whenever an inbox receives an email via a WebHook URL. An emailID will be posted to this URL every time an email is received for this inbox. The URL must be publicly reachable by the MailSlurp server. You can provide basicAuth values if you wish to secure this endpoint.

    Declaration
    public ApiResponse<WebhookDto> CreateWebhookWithHttpInfo(Guid inboxId, CreateWebhookOptions createWebhookOptions, int operationIndex = 0)
    Parameters
    Type Name Description
    System.Guid inboxId
    CreateWebhookOptions createWebhookOptions
    int operationIndex

    Index associated with the operation.

    Returns
    Type Description
    ApiResponse<WebhookDto>

    ApiResponse of WebhookDto

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    CreateWebhookWithHttpInfoAsync(Guid, CreateWebhookOptions, int, CancellationToken)

    Attach a WebHook URL to an inbox Get notified whenever an inbox receives an email via a WebHook URL. An emailID will be posted to this URL every time an email is received for this inbox. The URL must be publicly reachable by the MailSlurp server. You can provide basicAuth values if you wish to secure this endpoint.

    Declaration
    public Task<ApiResponse<WebhookDto>> CreateWebhookWithHttpInfoAsync(Guid inboxId, CreateWebhookOptions createWebhookOptions, int operationIndex = 0, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    System.Guid inboxId
    CreateWebhookOptions createWebhookOptions
    int operationIndex

    Index associated with the operation.

    CancellationToken cancellationToken

    Cancellation Token to cancel the request.

    Returns
    Type Description
    Task<ApiResponse<WebhookDto>>

    Task of ApiResponse (WebhookDto)

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    DeleteAllWebhooks(DateTime?, int)

    Delete all webhooks

    Declaration
    public void DeleteAllWebhooks(DateTime? before = null, int operationIndex = 0)
    Parameters
    Type Name Description
    DateTime? before

    before (optional)

    int operationIndex

    Index associated with the operation.

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    DeleteAllWebhooksAsync(DateTime?, int, CancellationToken)

    Delete all webhooks

    Declaration
    public Task DeleteAllWebhooksAsync(DateTime? before = null, int operationIndex = 0, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    DateTime? before

    before (optional)

    int operationIndex

    Index associated with the operation.

    CancellationToken cancellationToken

    Cancellation Token to cancel the request.

    Returns
    Type Description
    Task

    Task of void

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    DeleteAllWebhooksWithHttpInfo(DateTime?, int)

    Delete all webhooks

    Declaration
    public ApiResponse<object> DeleteAllWebhooksWithHttpInfo(DateTime? before = null, int operationIndex = 0)
    Parameters
    Type Name Description
    DateTime? before

    before (optional)

    int operationIndex

    Index associated with the operation.

    Returns
    Type Description
    ApiResponse<object>

    ApiResponse of Object(void)

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    DeleteAllWebhooksWithHttpInfoAsync(DateTime?, int, CancellationToken)

    Delete all webhooks

    Declaration
    public Task<ApiResponse<object>> DeleteAllWebhooksWithHttpInfoAsync(DateTime? before = null, int operationIndex = 0, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    DateTime? before

    before (optional)

    int operationIndex

    Index associated with the operation.

    CancellationToken cancellationToken

    Cancellation Token to cancel the request.

    Returns
    Type Description
    Task<ApiResponse<object>>

    Task of ApiResponse

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    DeleteWebhook(Guid, Guid, int)

    Delete and disable a Webhook for an Inbox

    Declaration
    public void DeleteWebhook(Guid inboxId, Guid webhookId, int operationIndex = 0)
    Parameters
    Type Name Description
    System.Guid inboxId
    System.Guid webhookId
    int operationIndex

    Index associated with the operation.

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    DeleteWebhookAsync(Guid, Guid, int, CancellationToken)

    Delete and disable a Webhook for an Inbox

    Declaration
    public Task DeleteWebhookAsync(Guid inboxId, Guid webhookId, int operationIndex = 0, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    System.Guid inboxId
    System.Guid webhookId
    int operationIndex

    Index associated with the operation.

    CancellationToken cancellationToken

    Cancellation Token to cancel the request.

    Returns
    Type Description
    Task

    Task of void

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    DeleteWebhookById(Guid, int)

    Delete a webhook

    Declaration
    public void DeleteWebhookById(Guid webhookId, int operationIndex = 0)
    Parameters
    Type Name Description
    System.Guid webhookId
    int operationIndex

    Index associated with the operation.

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    DeleteWebhookByIdAsync(Guid, int, CancellationToken)

    Delete a webhook

    Declaration
    public Task DeleteWebhookByIdAsync(Guid webhookId, int operationIndex = 0, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    System.Guid webhookId
    int operationIndex

    Index associated with the operation.

    CancellationToken cancellationToken

    Cancellation Token to cancel the request.

    Returns
    Type Description
    Task

    Task of void

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    DeleteWebhookByIdWithHttpInfo(Guid, int)

    Delete a webhook

    Declaration
    public ApiResponse<object> DeleteWebhookByIdWithHttpInfo(Guid webhookId, int operationIndex = 0)
    Parameters
    Type Name Description
    System.Guid webhookId
    int operationIndex

    Index associated with the operation.

    Returns
    Type Description
    ApiResponse<object>

    ApiResponse of Object(void)

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    DeleteWebhookByIdWithHttpInfoAsync(Guid, int, CancellationToken)

    Delete a webhook

    Declaration
    public Task<ApiResponse<object>> DeleteWebhookByIdWithHttpInfoAsync(Guid webhookId, int operationIndex = 0, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    System.Guid webhookId
    int operationIndex

    Index associated with the operation.

    CancellationToken cancellationToken

    Cancellation Token to cancel the request.

    Returns
    Type Description
    Task<ApiResponse<object>>

    Task of ApiResponse

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    DeleteWebhookWithHttpInfo(Guid, Guid, int)

    Delete and disable a Webhook for an Inbox

    Declaration
    public ApiResponse<object> DeleteWebhookWithHttpInfo(Guid inboxId, Guid webhookId, int operationIndex = 0)
    Parameters
    Type Name Description
    System.Guid inboxId
    System.Guid webhookId
    int operationIndex

    Index associated with the operation.

    Returns
    Type Description
    ApiResponse<object>

    ApiResponse of Object(void)

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    DeleteWebhookWithHttpInfoAsync(Guid, Guid, int, CancellationToken)

    Delete and disable a Webhook for an Inbox

    Declaration
    public Task<ApiResponse<object>> DeleteWebhookWithHttpInfoAsync(Guid inboxId, Guid webhookId, int operationIndex = 0, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    System.Guid inboxId
    System.Guid webhookId
    int operationIndex

    Index associated with the operation.

    CancellationToken cancellationToken

    Cancellation Token to cancel the request.

    Returns
    Type Description
    Task<ApiResponse<object>>

    Task of ApiResponse

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    GetAllAccountWebhooks(int?, int?, string, string, DateTime?, DateTime?, int)

    List account webhooks Paginated List account webhooks in paginated form. Allows for page index, page size, and sort direction.

    Declaration
    public PageWebhookProjection GetAllAccountWebhooks(int? page = null, int? size = null, string sort = null, string eventType = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0)
    Parameters
    Type Name Description
    int? page

    Optional page index in list pagination (optional, default to 0)

    int? size

    Optional page size for paginated result list. (optional, default to 20)

    string sort

    Optional createdAt sort direction ASC or DESC (optional, default to DESC)

    string eventType

    Optional event type (optional)

    DateTime? since

    Filter by created at after the given timestamp (optional)

    DateTime? before

    Filter by created at before the given timestamp (optional)

    int operationIndex

    Index associated with the operation.

    Returns
    Type Description
    PageWebhookProjection

    PageWebhookProjection

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    GetAllAccountWebhooksAsync(int?, int?, string, string, DateTime?, DateTime?, int, CancellationToken)

    List account webhooks Paginated List account webhooks in paginated form. Allows for page index, page size, and sort direction.

    Declaration
    public Task<PageWebhookProjection> GetAllAccountWebhooksAsync(int? page = null, int? size = null, string sort = null, string eventType = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    int? page

    Optional page index in list pagination (optional, default to 0)

    int? size

    Optional page size for paginated result list. (optional, default to 20)

    string sort

    Optional createdAt sort direction ASC or DESC (optional, default to DESC)

    string eventType

    Optional event type (optional)

    DateTime? since

    Filter by created at after the given timestamp (optional)

    DateTime? before

    Filter by created at before the given timestamp (optional)

    int operationIndex

    Index associated with the operation.

    CancellationToken cancellationToken

    Cancellation Token to cancel the request.

    Returns
    Type Description
    Task<PageWebhookProjection>

    Task of PageWebhookProjection

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    GetAllAccountWebhooksWithHttpInfo(int?, int?, string, string, DateTime?, DateTime?, int)

    List account webhooks Paginated List account webhooks in paginated form. Allows for page index, page size, and sort direction.

    Declaration
    public ApiResponse<PageWebhookProjection> GetAllAccountWebhooksWithHttpInfo(int? page = null, int? size = null, string sort = null, string eventType = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0)
    Parameters
    Type Name Description
    int? page

    Optional page index in list pagination (optional, default to 0)

    int? size

    Optional page size for paginated result list. (optional, default to 20)

    string sort

    Optional createdAt sort direction ASC or DESC (optional, default to DESC)

    string eventType

    Optional event type (optional)

    DateTime? since

    Filter by created at after the given timestamp (optional)

    DateTime? before

    Filter by created at before the given timestamp (optional)

    int operationIndex

    Index associated with the operation.

    Returns
    Type Description
    ApiResponse<PageWebhookProjection>

    ApiResponse of PageWebhookProjection

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    GetAllAccountWebhooksWithHttpInfoAsync(int?, int?, string, string, DateTime?, DateTime?, int, CancellationToken)

    List account webhooks Paginated List account webhooks in paginated form. Allows for page index, page size, and sort direction.

    Declaration
    public Task<ApiResponse<PageWebhookProjection>> GetAllAccountWebhooksWithHttpInfoAsync(int? page = null, int? size = null, string sort = null, string eventType = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    int? page

    Optional page index in list pagination (optional, default to 0)

    int? size

    Optional page size for paginated result list. (optional, default to 20)

    string sort

    Optional createdAt sort direction ASC or DESC (optional, default to DESC)

    string eventType

    Optional event type (optional)

    DateTime? since

    Filter by created at after the given timestamp (optional)

    DateTime? before

    Filter by created at before the given timestamp (optional)

    int operationIndex

    Index associated with the operation.

    CancellationToken cancellationToken

    Cancellation Token to cancel the request.

    Returns
    Type Description
    Task<ApiResponse<PageWebhookProjection>>

    Task of ApiResponse (PageWebhookProjection)

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    GetAllWebhookResults(int?, int?, string, string, DateTime?, DateTime?, bool?, string, string, int?, int?, Guid?, Guid?, Guid?, Guid?, Guid?, int)

    Get results for all webhooks

    Declaration
    public PageWebhookResult GetAllWebhookResults(int? page = null, int? size = null, string sort = null, string searchFilter = null, DateTime? since = null, DateTime? before = null, bool? unseenOnly = null, string resultType = null, string eventName = null, int? minStatusCode = null, int? maxStatusCode = null, Guid? inboxId = null, Guid? smsId = null, Guid? attachmentId = null, Guid? emailId = null, Guid? phoneId = null, int operationIndex = 0)
    Parameters
    Type Name Description
    int? page

    Optional page index in list pagination (optional, default to 0)

    int? size

    Optional page size in list pagination (optional, default to 20)

    string sort

    Optional createdAt sort direction ASC or DESC (optional, default to ASC)

    string searchFilter

    Optional search filter (optional)

    DateTime? since

    Filter by created at after the given timestamp (optional)

    DateTime? before

    Filter by created at before the given timestamp (optional)

    bool? unseenOnly

    Filter for unseen exceptions only (optional)

    string resultType

    Filter by result type (optional)

    string eventName

    Filter by event name (optional)

    int? minStatusCode

    Minimum response status (optional)

    int? maxStatusCode

    Maximum response status (optional)

    System.Guid? inboxId

    Inbox ID (optional)

    System.Guid? smsId

    Sms ID (optional)

    System.Guid? attachmentId

    Attachment ID (optional)

    System.Guid? emailId

    Email ID (optional)

    System.Guid? phoneId

    Phone ID (optional)

    int operationIndex

    Index associated with the operation.

    Returns
    Type Description
    PageWebhookResult

    PageWebhookResult

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    GetAllWebhookResultsAsync(int?, int?, string, string, DateTime?, DateTime?, bool?, string, string, int?, int?, Guid?, Guid?, Guid?, Guid?, Guid?, int, CancellationToken)

    Get results for all webhooks

    Declaration
    public Task<PageWebhookResult> GetAllWebhookResultsAsync(int? page = null, int? size = null, string sort = null, string searchFilter = null, DateTime? since = null, DateTime? before = null, bool? unseenOnly = null, string resultType = null, string eventName = null, int? minStatusCode = null, int? maxStatusCode = null, Guid? inboxId = null, Guid? smsId = null, Guid? attachmentId = null, Guid? emailId = null, Guid? phoneId = null, int operationIndex = 0, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    int? page

    Optional page index in list pagination (optional, default to 0)

    int? size

    Optional page size in list pagination (optional, default to 20)

    string sort

    Optional createdAt sort direction ASC or DESC (optional, default to ASC)

    string searchFilter

    Optional search filter (optional)

    DateTime? since

    Filter by created at after the given timestamp (optional)

    DateTime? before

    Filter by created at before the given timestamp (optional)

    bool? unseenOnly

    Filter for unseen exceptions only (optional)

    string resultType

    Filter by result type (optional)

    string eventName

    Filter by event name (optional)

    int? minStatusCode

    Minimum response status (optional)

    int? maxStatusCode

    Maximum response status (optional)

    System.Guid? inboxId

    Inbox ID (optional)

    System.Guid? smsId

    Sms ID (optional)

    System.Guid? attachmentId

    Attachment ID (optional)

    System.Guid? emailId

    Email ID (optional)

    System.Guid? phoneId

    Phone ID (optional)

    int operationIndex

    Index associated with the operation.

    CancellationToken cancellationToken

    Cancellation Token to cancel the request.

    Returns
    Type Description
    Task<PageWebhookResult>

    Task of PageWebhookResult

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    GetAllWebhookResultsWithHttpInfo(int?, int?, string, string, DateTime?, DateTime?, bool?, string, string, int?, int?, Guid?, Guid?, Guid?, Guid?, Guid?, int)

    Get results for all webhooks

    Declaration
    public ApiResponse<PageWebhookResult> GetAllWebhookResultsWithHttpInfo(int? page = null, int? size = null, string sort = null, string searchFilter = null, DateTime? since = null, DateTime? before = null, bool? unseenOnly = null, string resultType = null, string eventName = null, int? minStatusCode = null, int? maxStatusCode = null, Guid? inboxId = null, Guid? smsId = null, Guid? attachmentId = null, Guid? emailId = null, Guid? phoneId = null, int operationIndex = 0)
    Parameters
    Type Name Description
    int? page

    Optional page index in list pagination (optional, default to 0)

    int? size

    Optional page size in list pagination (optional, default to 20)

    string sort

    Optional createdAt sort direction ASC or DESC (optional, default to ASC)

    string searchFilter

    Optional search filter (optional)

    DateTime? since

    Filter by created at after the given timestamp (optional)

    DateTime? before

    Filter by created at before the given timestamp (optional)

    bool? unseenOnly

    Filter for unseen exceptions only (optional)

    string resultType

    Filter by result type (optional)

    string eventName

    Filter by event name (optional)

    int? minStatusCode

    Minimum response status (optional)

    int? maxStatusCode

    Maximum response status (optional)

    System.Guid? inboxId

    Inbox ID (optional)

    System.Guid? smsId

    Sms ID (optional)

    System.Guid? attachmentId

    Attachment ID (optional)

    System.Guid? emailId

    Email ID (optional)

    System.Guid? phoneId

    Phone ID (optional)

    int operationIndex

    Index associated with the operation.

    Returns
    Type Description
    ApiResponse<PageWebhookResult>

    ApiResponse of PageWebhookResult

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    GetAllWebhookResultsWithHttpInfoAsync(int?, int?, string, string, DateTime?, DateTime?, bool?, string, string, int?, int?, Guid?, Guid?, Guid?, Guid?, Guid?, int, CancellationToken)

    Get results for all webhooks

    Declaration
    public Task<ApiResponse<PageWebhookResult>> GetAllWebhookResultsWithHttpInfoAsync(int? page = null, int? size = null, string sort = null, string searchFilter = null, DateTime? since = null, DateTime? before = null, bool? unseenOnly = null, string resultType = null, string eventName = null, int? minStatusCode = null, int? maxStatusCode = null, Guid? inboxId = null, Guid? smsId = null, Guid? attachmentId = null, Guid? emailId = null, Guid? phoneId = null, int operationIndex = 0, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    int? page

    Optional page index in list pagination (optional, default to 0)

    int? size

    Optional page size in list pagination (optional, default to 20)

    string sort

    Optional createdAt sort direction ASC or DESC (optional, default to ASC)

    string searchFilter

    Optional search filter (optional)

    DateTime? since

    Filter by created at after the given timestamp (optional)

    DateTime? before

    Filter by created at before the given timestamp (optional)

    bool? unseenOnly

    Filter for unseen exceptions only (optional)

    string resultType

    Filter by result type (optional)

    string eventName

    Filter by event name (optional)

    int? minStatusCode

    Minimum response status (optional)

    int? maxStatusCode

    Maximum response status (optional)

    System.Guid? inboxId

    Inbox ID (optional)

    System.Guid? smsId

    Sms ID (optional)

    System.Guid? attachmentId

    Attachment ID (optional)

    System.Guid? emailId

    Email ID (optional)

    System.Guid? phoneId

    Phone ID (optional)

    int operationIndex

    Index associated with the operation.

    CancellationToken cancellationToken

    Cancellation Token to cancel the request.

    Returns
    Type Description
    Task<ApiResponse<PageWebhookResult>>

    Task of ApiResponse (PageWebhookResult)

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    GetAllWebhooks(int?, int?, string, string, DateTime?, Guid?, Guid?, DateTime?, int)

    List Webhooks Paginated List webhooks in paginated form. Allows for page index, page size, and sort direction.

    Declaration
    public PageWebhookProjection GetAllWebhooks(int? page = null, int? size = null, string sort = null, string searchFilter = null, DateTime? since = null, Guid? inboxId = null, Guid? phoneId = null, DateTime? before = null, int operationIndex = 0)
    Parameters
    Type Name Description
    int? page

    Optional page index in list pagination (optional, default to 0)

    int? size

    Optional page size for paginated result list. (optional, default to 20)

    string sort

    Optional createdAt sort direction ASC or DESC (optional, default to DESC)

    string searchFilter

    Optional search filter (optional)

    DateTime? since

    Filter by created at after the given timestamp (optional)

    System.Guid? inboxId

    Filter by inboxId (optional)

    System.Guid? phoneId

    Filter by phoneId (optional)

    DateTime? before

    Filter by created at before the given timestamp (optional)

    int operationIndex

    Index associated with the operation.

    Returns
    Type Description
    PageWebhookProjection

    PageWebhookProjection

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    GetAllWebhooksAsync(int?, int?, string, string, DateTime?, Guid?, Guid?, DateTime?, int, CancellationToken)

    List Webhooks Paginated List webhooks in paginated form. Allows for page index, page size, and sort direction.

    Declaration
    public Task<PageWebhookProjection> GetAllWebhooksAsync(int? page = null, int? size = null, string sort = null, string searchFilter = null, DateTime? since = null, Guid? inboxId = null, Guid? phoneId = null, DateTime? before = null, int operationIndex = 0, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    int? page

    Optional page index in list pagination (optional, default to 0)

    int? size

    Optional page size for paginated result list. (optional, default to 20)

    string sort

    Optional createdAt sort direction ASC or DESC (optional, default to DESC)

    string searchFilter

    Optional search filter (optional)

    DateTime? since

    Filter by created at after the given timestamp (optional)

    System.Guid? inboxId

    Filter by inboxId (optional)

    System.Guid? phoneId

    Filter by phoneId (optional)

    DateTime? before

    Filter by created at before the given timestamp (optional)

    int operationIndex

    Index associated with the operation.

    CancellationToken cancellationToken

    Cancellation Token to cancel the request.

    Returns
    Type Description
    Task<PageWebhookProjection>

    Task of PageWebhookProjection

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    GetAllWebhooksWithHttpInfo(int?, int?, string, string, DateTime?, Guid?, Guid?, DateTime?, int)

    List Webhooks Paginated List webhooks in paginated form. Allows for page index, page size, and sort direction.

    Declaration
    public ApiResponse<PageWebhookProjection> GetAllWebhooksWithHttpInfo(int? page = null, int? size = null, string sort = null, string searchFilter = null, DateTime? since = null, Guid? inboxId = null, Guid? phoneId = null, DateTime? before = null, int operationIndex = 0)
    Parameters
    Type Name Description
    int? page

    Optional page index in list pagination (optional, default to 0)

    int? size

    Optional page size for paginated result list. (optional, default to 20)

    string sort

    Optional createdAt sort direction ASC or DESC (optional, default to DESC)

    string searchFilter

    Optional search filter (optional)

    DateTime? since

    Filter by created at after the given timestamp (optional)

    System.Guid? inboxId

    Filter by inboxId (optional)

    System.Guid? phoneId

    Filter by phoneId (optional)

    DateTime? before

    Filter by created at before the given timestamp (optional)

    int operationIndex

    Index associated with the operation.

    Returns
    Type Description
    ApiResponse<PageWebhookProjection>

    ApiResponse of PageWebhookProjection

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    GetAllWebhooksWithHttpInfoAsync(int?, int?, string, string, DateTime?, Guid?, Guid?, DateTime?, int, CancellationToken)

    List Webhooks Paginated List webhooks in paginated form. Allows for page index, page size, and sort direction.

    Declaration
    public Task<ApiResponse<PageWebhookProjection>> GetAllWebhooksWithHttpInfoAsync(int? page = null, int? size = null, string sort = null, string searchFilter = null, DateTime? since = null, Guid? inboxId = null, Guid? phoneId = null, DateTime? before = null, int operationIndex = 0, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    int? page

    Optional page index in list pagination (optional, default to 0)

    int? size

    Optional page size for paginated result list. (optional, default to 20)

    string sort

    Optional createdAt sort direction ASC or DESC (optional, default to DESC)

    string searchFilter

    Optional search filter (optional)

    DateTime? since

    Filter by created at after the given timestamp (optional)

    System.Guid? inboxId

    Filter by inboxId (optional)

    System.Guid? phoneId

    Filter by phoneId (optional)

    DateTime? before

    Filter by created at before the given timestamp (optional)

    int operationIndex

    Index associated with the operation.

    CancellationToken cancellationToken

    Cancellation Token to cancel the request.

    Returns
    Type Description
    Task<ApiResponse<PageWebhookProjection>>

    Task of ApiResponse (PageWebhookProjection)

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    GetBasePath()

    Gets the base path of the API client.

    Declaration
    public string GetBasePath()
    Returns
    Type Description
    string

    The base path

    View Source

    GetInboxWebhooksPaginated(Guid, int?, int?, string, string, DateTime?, DateTime?, int)

    Get paginated webhooks for an Inbox

    Declaration
    public PageWebhookProjection GetInboxWebhooksPaginated(Guid inboxId, int? page = null, int? size = null, string sort = null, string searchFilter = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0)
    Parameters
    Type Name Description
    System.Guid inboxId
    int? page

    Optional page index in list pagination (optional, default to 0)

    int? size

    Optional page size in list pagination (optional, default to 20)

    string sort

    Optional createdAt sort direction ASC or DESC (optional, default to ASC)

    string searchFilter

    Optional search filter (optional)

    DateTime? since

    Filter by created at after the given timestamp (optional)

    DateTime? before

    Filter by created at before the given timestamp (optional)

    int operationIndex

    Index associated with the operation.

    Returns
    Type Description
    PageWebhookProjection

    PageWebhookProjection

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    GetInboxWebhooksPaginatedAsync(Guid, int?, int?, string, string, DateTime?, DateTime?, int, CancellationToken)

    Get paginated webhooks for an Inbox

    Declaration
    public Task<PageWebhookProjection> GetInboxWebhooksPaginatedAsync(Guid inboxId, int? page = null, int? size = null, string sort = null, string searchFilter = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    System.Guid inboxId
    int? page

    Optional page index in list pagination (optional, default to 0)

    int? size

    Optional page size in list pagination (optional, default to 20)

    string sort

    Optional createdAt sort direction ASC or DESC (optional, default to ASC)

    string searchFilter

    Optional search filter (optional)

    DateTime? since

    Filter by created at after the given timestamp (optional)

    DateTime? before

    Filter by created at before the given timestamp (optional)

    int operationIndex

    Index associated with the operation.

    CancellationToken cancellationToken

    Cancellation Token to cancel the request.

    Returns
    Type Description
    Task<PageWebhookProjection>

    Task of PageWebhookProjection

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    GetInboxWebhooksPaginatedWithHttpInfo(Guid, int?, int?, string, string, DateTime?, DateTime?, int)

    Get paginated webhooks for an Inbox

    Declaration
    public ApiResponse<PageWebhookProjection> GetInboxWebhooksPaginatedWithHttpInfo(Guid inboxId, int? page = null, int? size = null, string sort = null, string searchFilter = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0)
    Parameters
    Type Name Description
    System.Guid inboxId
    int? page

    Optional page index in list pagination (optional, default to 0)

    int? size

    Optional page size in list pagination (optional, default to 20)

    string sort

    Optional createdAt sort direction ASC or DESC (optional, default to ASC)

    string searchFilter

    Optional search filter (optional)

    DateTime? since

    Filter by created at after the given timestamp (optional)

    DateTime? before

    Filter by created at before the given timestamp (optional)

    int operationIndex

    Index associated with the operation.

    Returns
    Type Description
    ApiResponse<PageWebhookProjection>

    ApiResponse of PageWebhookProjection

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    GetInboxWebhooksPaginatedWithHttpInfoAsync(Guid, int?, int?, string, string, DateTime?, DateTime?, int, CancellationToken)

    Get paginated webhooks for an Inbox

    Declaration
    public Task<ApiResponse<PageWebhookProjection>> GetInboxWebhooksPaginatedWithHttpInfoAsync(Guid inboxId, int? page = null, int? size = null, string sort = null, string searchFilter = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    System.Guid inboxId
    int? page

    Optional page index in list pagination (optional, default to 0)

    int? size

    Optional page size in list pagination (optional, default to 20)

    string sort

    Optional createdAt sort direction ASC or DESC (optional, default to ASC)

    string searchFilter

    Optional search filter (optional)

    DateTime? since

    Filter by created at after the given timestamp (optional)

    DateTime? before

    Filter by created at before the given timestamp (optional)

    int operationIndex

    Index associated with the operation.

    CancellationToken cancellationToken

    Cancellation Token to cancel the request.

    Returns
    Type Description
    Task<ApiResponse<PageWebhookProjection>>

    Task of ApiResponse (PageWebhookProjection)

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    GetJsonSchemaForWebhookEvent(string, int)

    Get JSON Schema definition for webhook payload by event

    Declaration
    public JSONSchemaDto GetJsonSchemaForWebhookEvent(string _event, int operationIndex = 0)
    Parameters
    Type Name Description
    string _event
    int operationIndex

    Index associated with the operation.

    Returns
    Type Description
    JSONSchemaDto

    JSONSchemaDto

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    GetJsonSchemaForWebhookEventAsync(string, int, CancellationToken)

    Get JSON Schema definition for webhook payload by event

    Declaration
    public Task<JSONSchemaDto> GetJsonSchemaForWebhookEventAsync(string _event, int operationIndex = 0, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string _event
    int operationIndex

    Index associated with the operation.

    CancellationToken cancellationToken

    Cancellation Token to cancel the request.

    Returns
    Type Description
    Task<JSONSchemaDto>

    Task of JSONSchemaDto

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    GetJsonSchemaForWebhookEventWithHttpInfo(string, int)

    Get JSON Schema definition for webhook payload by event

    Declaration
    public ApiResponse<JSONSchemaDto> GetJsonSchemaForWebhookEventWithHttpInfo(string _event, int operationIndex = 0)
    Parameters
    Type Name Description
    string _event
    int operationIndex

    Index associated with the operation.

    Returns
    Type Description
    ApiResponse<JSONSchemaDto>

    ApiResponse of JSONSchemaDto

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    GetJsonSchemaForWebhookEventWithHttpInfoAsync(string, int, CancellationToken)

    Get JSON Schema definition for webhook payload by event

    Declaration
    public Task<ApiResponse<JSONSchemaDto>> GetJsonSchemaForWebhookEventWithHttpInfoAsync(string _event, int operationIndex = 0, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string _event
    int operationIndex

    Index associated with the operation.

    CancellationToken cancellationToken

    Cancellation Token to cancel the request.

    Returns
    Type Description
    Task<ApiResponse<JSONSchemaDto>>

    Task of ApiResponse (JSONSchemaDto)

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    GetJsonSchemaForWebhookPayload(Guid, int)

    Get JSON Schema definition for webhook payload

    Declaration
    public JSONSchemaDto GetJsonSchemaForWebhookPayload(Guid webhookId, int operationIndex = 0)
    Parameters
    Type Name Description
    System.Guid webhookId
    int operationIndex

    Index associated with the operation.

    Returns
    Type Description
    JSONSchemaDto

    JSONSchemaDto

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    GetJsonSchemaForWebhookPayloadAsync(Guid, int, CancellationToken)

    Get JSON Schema definition for webhook payload

    Declaration
    public Task<JSONSchemaDto> GetJsonSchemaForWebhookPayloadAsync(Guid webhookId, int operationIndex = 0, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    System.Guid webhookId
    int operationIndex

    Index associated with the operation.

    CancellationToken cancellationToken

    Cancellation Token to cancel the request.

    Returns
    Type Description
    Task<JSONSchemaDto>

    Task of JSONSchemaDto

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    GetJsonSchemaForWebhookPayloadWithHttpInfo(Guid, int)

    Get JSON Schema definition for webhook payload

    Declaration
    public ApiResponse<JSONSchemaDto> GetJsonSchemaForWebhookPayloadWithHttpInfo(Guid webhookId, int operationIndex = 0)
    Parameters
    Type Name Description
    System.Guid webhookId
    int operationIndex

    Index associated with the operation.

    Returns
    Type Description
    ApiResponse<JSONSchemaDto>

    ApiResponse of JSONSchemaDto

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    GetJsonSchemaForWebhookPayloadWithHttpInfoAsync(Guid, int, CancellationToken)

    Get JSON Schema definition for webhook payload

    Declaration
    public Task<ApiResponse<JSONSchemaDto>> GetJsonSchemaForWebhookPayloadWithHttpInfoAsync(Guid webhookId, int operationIndex = 0, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    System.Guid webhookId
    int operationIndex

    Index associated with the operation.

    CancellationToken cancellationToken

    Cancellation Token to cancel the request.

    Returns
    Type Description
    Task<ApiResponse<JSONSchemaDto>>

    Task of ApiResponse (JSONSchemaDto)

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    GetPhoneNumberWebhooksPaginated(Guid, int?, int?, string, DateTime?, DateTime?, int)

    Get paginated webhooks for a phone number

    Declaration
    public PageWebhookProjection GetPhoneNumberWebhooksPaginated(Guid phoneId, int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0)
    Parameters
    Type Name Description
    System.Guid phoneId
    int? page

    Optional page index in list pagination (optional, default to 0)

    int? size

    Optional page size in list pagination (optional, default to 20)

    string sort

    Optional createdAt sort direction ASC or DESC (optional, default to ASC)

    DateTime? since

    Filter by created at after the given timestamp (optional)

    DateTime? before

    Filter by created at before the given timestamp (optional)

    int operationIndex

    Index associated with the operation.

    Returns
    Type Description
    PageWebhookProjection

    PageWebhookProjection

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    GetPhoneNumberWebhooksPaginatedAsync(Guid, int?, int?, string, DateTime?, DateTime?, int, CancellationToken)

    Get paginated webhooks for a phone number

    Declaration
    public Task<PageWebhookProjection> GetPhoneNumberWebhooksPaginatedAsync(Guid phoneId, int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    System.Guid phoneId
    int? page

    Optional page index in list pagination (optional, default to 0)

    int? size

    Optional page size in list pagination (optional, default to 20)

    string sort

    Optional createdAt sort direction ASC or DESC (optional, default to ASC)

    DateTime? since

    Filter by created at after the given timestamp (optional)

    DateTime? before

    Filter by created at before the given timestamp (optional)

    int operationIndex

    Index associated with the operation.

    CancellationToken cancellationToken

    Cancellation Token to cancel the request.

    Returns
    Type Description
    Task<PageWebhookProjection>

    Task of PageWebhookProjection

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    GetPhoneNumberWebhooksPaginatedWithHttpInfo(Guid, int?, int?, string, DateTime?, DateTime?, int)

    Get paginated webhooks for a phone number

    Declaration
    public ApiResponse<PageWebhookProjection> GetPhoneNumberWebhooksPaginatedWithHttpInfo(Guid phoneId, int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0)
    Parameters
    Type Name Description
    System.Guid phoneId
    int? page

    Optional page index in list pagination (optional, default to 0)

    int? size

    Optional page size in list pagination (optional, default to 20)

    string sort

    Optional createdAt sort direction ASC or DESC (optional, default to ASC)

    DateTime? since

    Filter by created at after the given timestamp (optional)

    DateTime? before

    Filter by created at before the given timestamp (optional)

    int operationIndex

    Index associated with the operation.

    Returns
    Type Description
    ApiResponse<PageWebhookProjection>

    ApiResponse of PageWebhookProjection

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    GetPhoneNumberWebhooksPaginatedWithHttpInfoAsync(Guid, int?, int?, string, DateTime?, DateTime?, int, CancellationToken)

    Get paginated webhooks for a phone number

    Declaration
    public Task<ApiResponse<PageWebhookProjection>> GetPhoneNumberWebhooksPaginatedWithHttpInfoAsync(Guid phoneId, int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    System.Guid phoneId
    int? page

    Optional page index in list pagination (optional, default to 0)

    int? size

    Optional page size in list pagination (optional, default to 20)

    string sort

    Optional createdAt sort direction ASC or DESC (optional, default to ASC)

    DateTime? since

    Filter by created at after the given timestamp (optional)

    DateTime? before

    Filter by created at before the given timestamp (optional)

    int operationIndex

    Index associated with the operation.

    CancellationToken cancellationToken

    Cancellation Token to cancel the request.

    Returns
    Type Description
    Task<ApiResponse<PageWebhookProjection>>

    Task of ApiResponse (PageWebhookProjection)

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    GetTestWebhookPayload(string, int)

    Get test webhook payload example. Response content depends on eventName passed. Uses EMAIL_RECEIVED as default.

    Declaration
    public AbstractWebhookPayload GetTestWebhookPayload(string eventName = null, int operationIndex = 0)
    Parameters
    Type Name Description
    string eventName

    (optional)

    int operationIndex

    Index associated with the operation.

    Returns
    Type Description
    AbstractWebhookPayload

    AbstractWebhookPayload

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    GetTestWebhookPayloadAsync(string, int, CancellationToken)

    Get test webhook payload example. Response content depends on eventName passed. Uses EMAIL_RECEIVED as default.

    Declaration
    public Task<AbstractWebhookPayload> GetTestWebhookPayloadAsync(string eventName = null, int operationIndex = 0, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string eventName

    (optional)

    int operationIndex

    Index associated with the operation.

    CancellationToken cancellationToken

    Cancellation Token to cancel the request.

    Returns
    Type Description
    Task<AbstractWebhookPayload>

    Task of AbstractWebhookPayload

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    GetTestWebhookPayloadBounce(int)

    Get webhook test payload for bounce

    Declaration
    public WebhookBouncePayload GetTestWebhookPayloadBounce(int operationIndex = 0)
    Parameters
    Type Name Description
    int operationIndex

    Index associated with the operation.

    Returns
    Type Description
    WebhookBouncePayload

    WebhookBouncePayload

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    GetTestWebhookPayloadBounceAsync(int, CancellationToken)

    Get webhook test payload for bounce

    Declaration
    public Task<WebhookBouncePayload> GetTestWebhookPayloadBounceAsync(int operationIndex = 0, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    int operationIndex

    Index associated with the operation.

    CancellationToken cancellationToken

    Cancellation Token to cancel the request.

    Returns
    Type Description
    Task<WebhookBouncePayload>

    Task of WebhookBouncePayload

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    GetTestWebhookPayloadBounceRecipient(int)

    Get webhook test payload for bounce recipient

    Declaration
    public WebhookBounceRecipientPayload GetTestWebhookPayloadBounceRecipient(int operationIndex = 0)
    Parameters
    Type Name Description
    int operationIndex

    Index associated with the operation.

    Returns
    Type Description
    WebhookBounceRecipientPayload

    WebhookBounceRecipientPayload

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    GetTestWebhookPayloadBounceRecipientAsync(int, CancellationToken)

    Get webhook test payload for bounce recipient

    Declaration
    public Task<WebhookBounceRecipientPayload> GetTestWebhookPayloadBounceRecipientAsync(int operationIndex = 0, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    int operationIndex

    Index associated with the operation.

    CancellationToken cancellationToken

    Cancellation Token to cancel the request.

    Returns
    Type Description
    Task<WebhookBounceRecipientPayload>

    Task of WebhookBounceRecipientPayload

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    GetTestWebhookPayloadBounceRecipientWithHttpInfo(int)

    Get webhook test payload for bounce recipient

    Declaration
    public ApiResponse<WebhookBounceRecipientPayload> GetTestWebhookPayloadBounceRecipientWithHttpInfo(int operationIndex = 0)
    Parameters
    Type Name Description
    int operationIndex

    Index associated with the operation.

    Returns
    Type Description
    ApiResponse<WebhookBounceRecipientPayload>

    ApiResponse of WebhookBounceRecipientPayload

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    GetTestWebhookPayloadBounceRecipientWithHttpInfoAsync(int, CancellationToken)

    Get webhook test payload for bounce recipient

    Declaration
    public Task<ApiResponse<WebhookBounceRecipientPayload>> GetTestWebhookPayloadBounceRecipientWithHttpInfoAsync(int operationIndex = 0, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    int operationIndex

    Index associated with the operation.

    CancellationToken cancellationToken

    Cancellation Token to cancel the request.

    Returns
    Type Description
    Task<ApiResponse<WebhookBounceRecipientPayload>>

    Task of ApiResponse (WebhookBounceRecipientPayload)

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    GetTestWebhookPayloadBounceWithHttpInfo(int)

    Get webhook test payload for bounce

    Declaration
    public ApiResponse<WebhookBouncePayload> GetTestWebhookPayloadBounceWithHttpInfo(int operationIndex = 0)
    Parameters
    Type Name Description
    int operationIndex

    Index associated with the operation.

    Returns
    Type Description
    ApiResponse<WebhookBouncePayload>

    ApiResponse of WebhookBouncePayload

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    GetTestWebhookPayloadBounceWithHttpInfoAsync(int, CancellationToken)

    Get webhook test payload for bounce

    Declaration
    public Task<ApiResponse<WebhookBouncePayload>> GetTestWebhookPayloadBounceWithHttpInfoAsync(int operationIndex = 0, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    int operationIndex

    Index associated with the operation.

    CancellationToken cancellationToken

    Cancellation Token to cancel the request.

    Returns
    Type Description
    Task<ApiResponse<WebhookBouncePayload>>

    Task of ApiResponse (WebhookBouncePayload)

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    GetTestWebhookPayloadDeliveryStatus(int)

    Get webhook test payload for delivery status event

    Declaration
    public WebhookDeliveryStatusPayload GetTestWebhookPayloadDeliveryStatus(int operationIndex = 0)
    Parameters
    Type Name Description
    int operationIndex

    Index associated with the operation.

    Returns
    Type Description
    WebhookDeliveryStatusPayload

    WebhookDeliveryStatusPayload

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    GetTestWebhookPayloadDeliveryStatusAsync(int, CancellationToken)

    Get webhook test payload for delivery status event

    Declaration
    public Task<WebhookDeliveryStatusPayload> GetTestWebhookPayloadDeliveryStatusAsync(int operationIndex = 0, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    int operationIndex

    Index associated with the operation.

    CancellationToken cancellationToken

    Cancellation Token to cancel the request.

    Returns
    Type Description
    Task<WebhookDeliveryStatusPayload>

    Task of WebhookDeliveryStatusPayload

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    GetTestWebhookPayloadDeliveryStatusWithHttpInfo(int)

    Get webhook test payload for delivery status event

    Declaration
    public ApiResponse<WebhookDeliveryStatusPayload> GetTestWebhookPayloadDeliveryStatusWithHttpInfo(int operationIndex = 0)
    Parameters
    Type Name Description
    int operationIndex

    Index associated with the operation.

    Returns
    Type Description
    ApiResponse<WebhookDeliveryStatusPayload>

    ApiResponse of WebhookDeliveryStatusPayload

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    GetTestWebhookPayloadDeliveryStatusWithHttpInfoAsync(int, CancellationToken)

    Get webhook test payload for delivery status event

    Declaration
    public Task<ApiResponse<WebhookDeliveryStatusPayload>> GetTestWebhookPayloadDeliveryStatusWithHttpInfoAsync(int operationIndex = 0, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    int operationIndex

    Index associated with the operation.

    CancellationToken cancellationToken

    Cancellation Token to cancel the request.

    Returns
    Type Description
    Task<ApiResponse<WebhookDeliveryStatusPayload>>

    Task of ApiResponse (WebhookDeliveryStatusPayload)

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    GetTestWebhookPayloadEmailOpened(int)

    Get webhook test payload for email opened event

    Declaration
    public WebhookEmailOpenedPayload GetTestWebhookPayloadEmailOpened(int operationIndex = 0)
    Parameters
    Type Name Description
    int operationIndex

    Index associated with the operation.

    Returns
    Type Description
    WebhookEmailOpenedPayload

    WebhookEmailOpenedPayload

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    GetTestWebhookPayloadEmailOpenedAsync(int, CancellationToken)

    Get webhook test payload for email opened event

    Declaration
    public Task<WebhookEmailOpenedPayload> GetTestWebhookPayloadEmailOpenedAsync(int operationIndex = 0, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    int operationIndex

    Index associated with the operation.

    CancellationToken cancellationToken

    Cancellation Token to cancel the request.

    Returns
    Type Description
    Task<WebhookEmailOpenedPayload>

    Task of WebhookEmailOpenedPayload

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    GetTestWebhookPayloadEmailOpenedWithHttpInfo(int)

    Get webhook test payload for email opened event

    Declaration
    public ApiResponse<WebhookEmailOpenedPayload> GetTestWebhookPayloadEmailOpenedWithHttpInfo(int operationIndex = 0)
    Parameters
    Type Name Description
    int operationIndex

    Index associated with the operation.

    Returns
    Type Description
    ApiResponse<WebhookEmailOpenedPayload>

    ApiResponse of WebhookEmailOpenedPayload

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    GetTestWebhookPayloadEmailOpenedWithHttpInfoAsync(int, CancellationToken)

    Get webhook test payload for email opened event

    Declaration
    public Task<ApiResponse<WebhookEmailOpenedPayload>> GetTestWebhookPayloadEmailOpenedWithHttpInfoAsync(int operationIndex = 0, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    int operationIndex

    Index associated with the operation.

    CancellationToken cancellationToken

    Cancellation Token to cancel the request.

    Returns
    Type Description
    Task<ApiResponse<WebhookEmailOpenedPayload>>

    Task of ApiResponse (WebhookEmailOpenedPayload)

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    GetTestWebhookPayloadEmailRead(int)

    Get webhook test payload for email opened event

    Declaration
    public WebhookEmailReadPayload GetTestWebhookPayloadEmailRead(int operationIndex = 0)
    Parameters
    Type Name Description
    int operationIndex

    Index associated with the operation.

    Returns
    Type Description
    WebhookEmailReadPayload

    WebhookEmailReadPayload

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    GetTestWebhookPayloadEmailReadAsync(int, CancellationToken)

    Get webhook test payload for email opened event

    Declaration
    public Task<WebhookEmailReadPayload> GetTestWebhookPayloadEmailReadAsync(int operationIndex = 0, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    int operationIndex

    Index associated with the operation.

    CancellationToken cancellationToken

    Cancellation Token to cancel the request.

    Returns
    Type Description
    Task<WebhookEmailReadPayload>

    Task of WebhookEmailReadPayload

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    GetTestWebhookPayloadEmailReadWithHttpInfo(int)

    Get webhook test payload for email opened event

    Declaration
    public ApiResponse<WebhookEmailReadPayload> GetTestWebhookPayloadEmailReadWithHttpInfo(int operationIndex = 0)
    Parameters
    Type Name Description
    int operationIndex

    Index associated with the operation.

    Returns
    Type Description
    ApiResponse<WebhookEmailReadPayload>

    ApiResponse of WebhookEmailReadPayload

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    GetTestWebhookPayloadEmailReadWithHttpInfoAsync(int, CancellationToken)

    Get webhook test payload for email opened event

    Declaration
    public Task<ApiResponse<WebhookEmailReadPayload>> GetTestWebhookPayloadEmailReadWithHttpInfoAsync(int operationIndex = 0, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    int operationIndex

    Index associated with the operation.

    CancellationToken cancellationToken

    Cancellation Token to cancel the request.

    Returns
    Type Description
    Task<ApiResponse<WebhookEmailReadPayload>>

    Task of ApiResponse (WebhookEmailReadPayload)

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    GetTestWebhookPayloadForWebhook(Guid, int)

    Get example payload for webhook

    Declaration
    public AbstractWebhookPayload GetTestWebhookPayloadForWebhook(Guid webhookId, int operationIndex = 0)
    Parameters
    Type Name Description
    System.Guid webhookId
    int operationIndex

    Index associated with the operation.

    Returns
    Type Description
    AbstractWebhookPayload

    AbstractWebhookPayload

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    GetTestWebhookPayloadForWebhookAsync(Guid, int, CancellationToken)

    Get example payload for webhook

    Declaration
    public Task<AbstractWebhookPayload> GetTestWebhookPayloadForWebhookAsync(Guid webhookId, int operationIndex = 0, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    System.Guid webhookId
    int operationIndex

    Index associated with the operation.

    CancellationToken cancellationToken

    Cancellation Token to cancel the request.

    Returns
    Type Description
    Task<AbstractWebhookPayload>

    Task of AbstractWebhookPayload

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    GetTestWebhookPayloadForWebhookWithHttpInfo(Guid, int)

    Get example payload for webhook

    Declaration
    public ApiResponse<AbstractWebhookPayload> GetTestWebhookPayloadForWebhookWithHttpInfo(Guid webhookId, int operationIndex = 0)
    Parameters
    Type Name Description
    System.Guid webhookId
    int operationIndex

    Index associated with the operation.

    Returns
    Type Description
    ApiResponse<AbstractWebhookPayload>

    ApiResponse of AbstractWebhookPayload

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    GetTestWebhookPayloadForWebhookWithHttpInfoAsync(Guid, int, CancellationToken)

    Get example payload for webhook

    Declaration
    public Task<ApiResponse<AbstractWebhookPayload>> GetTestWebhookPayloadForWebhookWithHttpInfoAsync(Guid webhookId, int operationIndex = 0, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    System.Guid webhookId
    int operationIndex

    Index associated with the operation.

    CancellationToken cancellationToken

    Cancellation Token to cancel the request.

    Returns
    Type Description
    Task<ApiResponse<AbstractWebhookPayload>>

    Task of ApiResponse (AbstractWebhookPayload)

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    GetTestWebhookPayloadNewAttachment(int)

    Get webhook test payload for new attachment event

    Declaration
    public WebhookNewAttachmentPayload GetTestWebhookPayloadNewAttachment(int operationIndex = 0)
    Parameters
    Type Name Description
    int operationIndex

    Index associated with the operation.

    Returns
    Type Description
    WebhookNewAttachmentPayload

    WebhookNewAttachmentPayload

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    GetTestWebhookPayloadNewAttachmentAsync(int, CancellationToken)

    Get webhook test payload for new attachment event

    Declaration
    public Task<WebhookNewAttachmentPayload> GetTestWebhookPayloadNewAttachmentAsync(int operationIndex = 0, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    int operationIndex

    Index associated with the operation.

    CancellationToken cancellationToken

    Cancellation Token to cancel the request.

    Returns
    Type Description
    Task<WebhookNewAttachmentPayload>

    Task of WebhookNewAttachmentPayload

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    GetTestWebhookPayloadNewAttachmentWithHttpInfo(int)

    Get webhook test payload for new attachment event

    Declaration
    public ApiResponse<WebhookNewAttachmentPayload> GetTestWebhookPayloadNewAttachmentWithHttpInfo(int operationIndex = 0)
    Parameters
    Type Name Description
    int operationIndex

    Index associated with the operation.

    Returns
    Type Description
    ApiResponse<WebhookNewAttachmentPayload>

    ApiResponse of WebhookNewAttachmentPayload

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    GetTestWebhookPayloadNewAttachmentWithHttpInfoAsync(int, CancellationToken)

    Get webhook test payload for new attachment event

    Declaration
    public Task<ApiResponse<WebhookNewAttachmentPayload>> GetTestWebhookPayloadNewAttachmentWithHttpInfoAsync(int operationIndex = 0, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    int operationIndex

    Index associated with the operation.

    CancellationToken cancellationToken

    Cancellation Token to cancel the request.

    Returns
    Type Description
    Task<ApiResponse<WebhookNewAttachmentPayload>>

    Task of ApiResponse (WebhookNewAttachmentPayload)

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    GetTestWebhookPayloadNewContact(int)

    Get webhook test payload for new contact event

    Declaration
    public WebhookNewContactPayload GetTestWebhookPayloadNewContact(int operationIndex = 0)
    Parameters
    Type Name Description
    int operationIndex

    Index associated with the operation.

    Returns
    Type Description
    WebhookNewContactPayload

    WebhookNewContactPayload

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    GetTestWebhookPayloadNewContactAsync(int, CancellationToken)

    Get webhook test payload for new contact event

    Declaration
    public Task<WebhookNewContactPayload> GetTestWebhookPayloadNewContactAsync(int operationIndex = 0, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    int operationIndex

    Index associated with the operation.

    CancellationToken cancellationToken

    Cancellation Token to cancel the request.

    Returns
    Type Description
    Task<WebhookNewContactPayload>

    Task of WebhookNewContactPayload

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    GetTestWebhookPayloadNewContactWithHttpInfo(int)

    Get webhook test payload for new contact event

    Declaration
    public ApiResponse<WebhookNewContactPayload> GetTestWebhookPayloadNewContactWithHttpInfo(int operationIndex = 0)
    Parameters
    Type Name Description
    int operationIndex

    Index associated with the operation.

    Returns
    Type Description
    ApiResponse<WebhookNewContactPayload>

    ApiResponse of WebhookNewContactPayload

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    GetTestWebhookPayloadNewContactWithHttpInfoAsync(int, CancellationToken)

    Get webhook test payload for new contact event

    Declaration
    public Task<ApiResponse<WebhookNewContactPayload>> GetTestWebhookPayloadNewContactWithHttpInfoAsync(int operationIndex = 0, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    int operationIndex

    Index associated with the operation.

    CancellationToken cancellationToken

    Cancellation Token to cancel the request.

    Returns
    Type Description
    Task<ApiResponse<WebhookNewContactPayload>>

    Task of ApiResponse (WebhookNewContactPayload)

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    GetTestWebhookPayloadNewEmail(int)

    Get webhook test payload for new email event

    Declaration
    public WebhookNewEmailPayload GetTestWebhookPayloadNewEmail(int operationIndex = 0)
    Parameters
    Type Name Description
    int operationIndex

    Index associated with the operation.

    Returns
    Type Description
    WebhookNewEmailPayload

    WebhookNewEmailPayload

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    GetTestWebhookPayloadNewEmailAsync(int, CancellationToken)

    Get webhook test payload for new email event

    Declaration
    public Task<WebhookNewEmailPayload> GetTestWebhookPayloadNewEmailAsync(int operationIndex = 0, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    int operationIndex

    Index associated with the operation.

    CancellationToken cancellationToken

    Cancellation Token to cancel the request.

    Returns
    Type Description
    Task<WebhookNewEmailPayload>

    Task of WebhookNewEmailPayload

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    GetTestWebhookPayloadNewEmailWithHttpInfo(int)

    Get webhook test payload for new email event

    Declaration
    public ApiResponse<WebhookNewEmailPayload> GetTestWebhookPayloadNewEmailWithHttpInfo(int operationIndex = 0)
    Parameters
    Type Name Description
    int operationIndex

    Index associated with the operation.

    Returns
    Type Description
    ApiResponse<WebhookNewEmailPayload>

    ApiResponse of WebhookNewEmailPayload

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    GetTestWebhookPayloadNewEmailWithHttpInfoAsync(int, CancellationToken)

    Get webhook test payload for new email event

    Declaration
    public Task<ApiResponse<WebhookNewEmailPayload>> GetTestWebhookPayloadNewEmailWithHttpInfoAsync(int operationIndex = 0, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    int operationIndex

    Index associated with the operation.

    CancellationToken cancellationToken

    Cancellation Token to cancel the request.

    Returns
    Type Description
    Task<ApiResponse<WebhookNewEmailPayload>>

    Task of ApiResponse (WebhookNewEmailPayload)

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    GetTestWebhookPayloadNewSms(int)

    Get webhook test payload for new sms event

    Declaration
    public WebhookNewSmsPayload GetTestWebhookPayloadNewSms(int operationIndex = 0)
    Parameters
    Type Name Description
    int operationIndex

    Index associated with the operation.

    Returns
    Type Description
    WebhookNewSmsPayload

    WebhookNewSmsPayload

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    GetTestWebhookPayloadNewSmsAsync(int, CancellationToken)

    Get webhook test payload for new sms event

    Declaration
    public Task<WebhookNewSmsPayload> GetTestWebhookPayloadNewSmsAsync(int operationIndex = 0, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    int operationIndex

    Index associated with the operation.

    CancellationToken cancellationToken

    Cancellation Token to cancel the request.

    Returns
    Type Description
    Task<WebhookNewSmsPayload>

    Task of WebhookNewSmsPayload

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    GetTestWebhookPayloadNewSmsWithHttpInfo(int)

    Get webhook test payload for new sms event

    Declaration
    public ApiResponse<WebhookNewSmsPayload> GetTestWebhookPayloadNewSmsWithHttpInfo(int operationIndex = 0)
    Parameters
    Type Name Description
    int operationIndex

    Index associated with the operation.

    Returns
    Type Description
    ApiResponse<WebhookNewSmsPayload>

    ApiResponse of WebhookNewSmsPayload

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    GetTestWebhookPayloadNewSmsWithHttpInfoAsync(int, CancellationToken)

    Get webhook test payload for new sms event

    Declaration
    public Task<ApiResponse<WebhookNewSmsPayload>> GetTestWebhookPayloadNewSmsWithHttpInfoAsync(int operationIndex = 0, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    int operationIndex

    Index associated with the operation.

    CancellationToken cancellationToken

    Cancellation Token to cancel the request.

    Returns
    Type Description
    Task<ApiResponse<WebhookNewSmsPayload>>

    Task of ApiResponse (WebhookNewSmsPayload)

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    GetTestWebhookPayloadWithHttpInfo(string, int)

    Get test webhook payload example. Response content depends on eventName passed. Uses EMAIL_RECEIVED as default.

    Declaration
    public ApiResponse<AbstractWebhookPayload> GetTestWebhookPayloadWithHttpInfo(string eventName = null, int operationIndex = 0)
    Parameters
    Type Name Description
    string eventName

    (optional)

    int operationIndex

    Index associated with the operation.

    Returns
    Type Description
    ApiResponse<AbstractWebhookPayload>

    ApiResponse of AbstractWebhookPayload

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    GetTestWebhookPayloadWithHttpInfoAsync(string, int, CancellationToken)

    Get test webhook payload example. Response content depends on eventName passed. Uses EMAIL_RECEIVED as default.

    Declaration
    public Task<ApiResponse<AbstractWebhookPayload>> GetTestWebhookPayloadWithHttpInfoAsync(string eventName = null, int operationIndex = 0, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string eventName

    (optional)

    int operationIndex

    Index associated with the operation.

    CancellationToken cancellationToken

    Cancellation Token to cancel the request.

    Returns
    Type Description
    Task<ApiResponse<AbstractWebhookPayload>>

    Task of ApiResponse (AbstractWebhookPayload)

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    GetWebhook(Guid, int)

    Get a webhook

    Declaration
    public WebhookDto GetWebhook(Guid webhookId, int operationIndex = 0)
    Parameters
    Type Name Description
    System.Guid webhookId
    int operationIndex

    Index associated with the operation.

    Returns
    Type Description
    WebhookDto

    WebhookDto

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    GetWebhookAsync(Guid, int, CancellationToken)

    Get a webhook

    Declaration
    public Task<WebhookDto> GetWebhookAsync(Guid webhookId, int operationIndex = 0, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    System.Guid webhookId
    int operationIndex

    Index associated with the operation.

    CancellationToken cancellationToken

    Cancellation Token to cancel the request.

    Returns
    Type Description
    Task<WebhookDto>

    Task of WebhookDto

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    GetWebhookResult(Guid, int)

    Get a webhook result for a webhook

    Declaration
    public WebhookResultDto GetWebhookResult(Guid webhookResultId, int operationIndex = 0)
    Parameters
    Type Name Description
    System.Guid webhookResultId

    Webhook Result ID

    int operationIndex

    Index associated with the operation.

    Returns
    Type Description
    WebhookResultDto

    WebhookResultDto

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    GetWebhookResultAsync(Guid, int, CancellationToken)

    Get a webhook result for a webhook

    Declaration
    public Task<WebhookResultDto> GetWebhookResultAsync(Guid webhookResultId, int operationIndex = 0, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    System.Guid webhookResultId

    Webhook Result ID

    int operationIndex

    Index associated with the operation.

    CancellationToken cancellationToken

    Cancellation Token to cancel the request.

    Returns
    Type Description
    Task<WebhookResultDto>

    Task of WebhookResultDto

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    GetWebhookResults(Guid, int?, int?, string, string, DateTime?, DateTime?, bool?, string, string, int?, int?, Guid?, Guid?, Guid?, Guid?, Guid?, int)

    Get a webhook results for a webhook

    Declaration
    public PageWebhookResult GetWebhookResults(Guid webhookId, int? page = null, int? size = null, string sort = null, string searchFilter = null, DateTime? since = null, DateTime? before = null, bool? unseenOnly = null, string resultType = null, string eventName = null, int? minStatusCode = null, int? maxStatusCode = null, Guid? inboxId = null, Guid? smsId = null, Guid? attachmentId = null, Guid? emailId = null, Guid? phoneId = null, int operationIndex = 0)
    Parameters
    Type Name Description
    System.Guid webhookId

    ID of webhook to get results for

    int? page

    Optional page index in list pagination (optional, default to 0)

    int? size

    Optional page size in list pagination (optional, default to 20)

    string sort

    Optional createdAt sort direction ASC or DESC (optional, default to ASC)

    string searchFilter

    Optional search filter (optional)

    DateTime? since

    Filter by created at after the given timestamp (optional)

    DateTime? before

    Filter by created at before the given timestamp (optional)

    bool? unseenOnly

    Filter for unseen exceptions only (optional)

    string resultType

    Filter by result type (optional)

    string eventName

    Filter by event name (optional)

    int? minStatusCode

    Minimum response status (optional)

    int? maxStatusCode

    Maximum response status (optional)

    System.Guid? inboxId

    Inbox ID (optional)

    System.Guid? smsId

    Sms ID (optional)

    System.Guid? attachmentId

    Attachment ID (optional)

    System.Guid? emailId

    Email ID (optional)

    System.Guid? phoneId

    Phone ID (optional)

    int operationIndex

    Index associated with the operation.

    Returns
    Type Description
    PageWebhookResult

    PageWebhookResult

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    GetWebhookResultsAsync(Guid, int?, int?, string, string, DateTime?, DateTime?, bool?, string, string, int?, int?, Guid?, Guid?, Guid?, Guid?, Guid?, int, CancellationToken)

    Get a webhook results for a webhook

    Declaration
    public Task<PageWebhookResult> GetWebhookResultsAsync(Guid webhookId, int? page = null, int? size = null, string sort = null, string searchFilter = null, DateTime? since = null, DateTime? before = null, bool? unseenOnly = null, string resultType = null, string eventName = null, int? minStatusCode = null, int? maxStatusCode = null, Guid? inboxId = null, Guid? smsId = null, Guid? attachmentId = null, Guid? emailId = null, Guid? phoneId = null, int operationIndex = 0, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    System.Guid webhookId

    ID of webhook to get results for

    int? page

    Optional page index in list pagination (optional, default to 0)

    int? size

    Optional page size in list pagination (optional, default to 20)

    string sort

    Optional createdAt sort direction ASC or DESC (optional, default to ASC)

    string searchFilter

    Optional search filter (optional)

    DateTime? since

    Filter by created at after the given timestamp (optional)

    DateTime? before

    Filter by created at before the given timestamp (optional)

    bool? unseenOnly

    Filter for unseen exceptions only (optional)

    string resultType

    Filter by result type (optional)

    string eventName

    Filter by event name (optional)

    int? minStatusCode

    Minimum response status (optional)

    int? maxStatusCode

    Maximum response status (optional)

    System.Guid? inboxId

    Inbox ID (optional)

    System.Guid? smsId

    Sms ID (optional)

    System.Guid? attachmentId

    Attachment ID (optional)

    System.Guid? emailId

    Email ID (optional)

    System.Guid? phoneId

    Phone ID (optional)

    int operationIndex

    Index associated with the operation.

    CancellationToken cancellationToken

    Cancellation Token to cancel the request.

    Returns
    Type Description
    Task<PageWebhookResult>

    Task of PageWebhookResult

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    GetWebhookResultsCount(Guid, int)

    Get a webhook results count for a webhook

    Declaration
    public CountDto GetWebhookResultsCount(Guid webhookId, int operationIndex = 0)
    Parameters
    Type Name Description
    System.Guid webhookId

    ID of webhook to get results for

    int operationIndex

    Index associated with the operation.

    Returns
    Type Description
    CountDto

    CountDto

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    GetWebhookResultsCountAsync(Guid, int, CancellationToken)

    Get a webhook results count for a webhook

    Declaration
    public Task<CountDto> GetWebhookResultsCountAsync(Guid webhookId, int operationIndex = 0, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    System.Guid webhookId

    ID of webhook to get results for

    int operationIndex

    Index associated with the operation.

    CancellationToken cancellationToken

    Cancellation Token to cancel the request.

    Returns
    Type Description
    Task<CountDto>

    Task of CountDto

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    GetWebhookResultsCountWithHttpInfo(Guid, int)

    Get a webhook results count for a webhook

    Declaration
    public ApiResponse<CountDto> GetWebhookResultsCountWithHttpInfo(Guid webhookId, int operationIndex = 0)
    Parameters
    Type Name Description
    System.Guid webhookId

    ID of webhook to get results for

    int operationIndex

    Index associated with the operation.

    Returns
    Type Description
    ApiResponse<CountDto>

    ApiResponse of CountDto

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    GetWebhookResultsCountWithHttpInfoAsync(Guid, int, CancellationToken)

    Get a webhook results count for a webhook

    Declaration
    public Task<ApiResponse<CountDto>> GetWebhookResultsCountWithHttpInfoAsync(Guid webhookId, int operationIndex = 0, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    System.Guid webhookId

    ID of webhook to get results for

    int operationIndex

    Index associated with the operation.

    CancellationToken cancellationToken

    Cancellation Token to cancel the request.

    Returns
    Type Description
    Task<ApiResponse<CountDto>>

    Task of ApiResponse (CountDto)

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    GetWebhookResultsUnseenErrorCount(int)

    Get count of unseen webhook results with error status

    Declaration
    public UnseenErrorCountDto GetWebhookResultsUnseenErrorCount(int operationIndex = 0)
    Parameters
    Type Name Description
    int operationIndex

    Index associated with the operation.

    Returns
    Type Description
    UnseenErrorCountDto

    UnseenErrorCountDto

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    GetWebhookResultsUnseenErrorCountAsync(int, CancellationToken)

    Get count of unseen webhook results with error status

    Declaration
    public Task<UnseenErrorCountDto> GetWebhookResultsUnseenErrorCountAsync(int operationIndex = 0, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    int operationIndex

    Index associated with the operation.

    CancellationToken cancellationToken

    Cancellation Token to cancel the request.

    Returns
    Type Description
    Task<UnseenErrorCountDto>

    Task of UnseenErrorCountDto

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    GetWebhookResultsUnseenErrorCountWithHttpInfo(int)

    Get count of unseen webhook results with error status

    Declaration
    public ApiResponse<UnseenErrorCountDto> GetWebhookResultsUnseenErrorCountWithHttpInfo(int operationIndex = 0)
    Parameters
    Type Name Description
    int operationIndex

    Index associated with the operation.

    Returns
    Type Description
    ApiResponse<UnseenErrorCountDto>

    ApiResponse of UnseenErrorCountDto

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    GetWebhookResultsUnseenErrorCountWithHttpInfoAsync(int, CancellationToken)

    Get count of unseen webhook results with error status

    Declaration
    public Task<ApiResponse<UnseenErrorCountDto>> GetWebhookResultsUnseenErrorCountWithHttpInfoAsync(int operationIndex = 0, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    int operationIndex

    Index associated with the operation.

    CancellationToken cancellationToken

    Cancellation Token to cancel the request.

    Returns
    Type Description
    Task<ApiResponse<UnseenErrorCountDto>>

    Task of ApiResponse (UnseenErrorCountDto)

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    GetWebhookResultsWithHttpInfo(Guid, int?, int?, string, string, DateTime?, DateTime?, bool?, string, string, int?, int?, Guid?, Guid?, Guid?, Guid?, Guid?, int)

    Get a webhook results for a webhook

    Declaration
    public ApiResponse<PageWebhookResult> GetWebhookResultsWithHttpInfo(Guid webhookId, int? page = null, int? size = null, string sort = null, string searchFilter = null, DateTime? since = null, DateTime? before = null, bool? unseenOnly = null, string resultType = null, string eventName = null, int? minStatusCode = null, int? maxStatusCode = null, Guid? inboxId = null, Guid? smsId = null, Guid? attachmentId = null, Guid? emailId = null, Guid? phoneId = null, int operationIndex = 0)
    Parameters
    Type Name Description
    System.Guid webhookId

    ID of webhook to get results for

    int? page

    Optional page index in list pagination (optional, default to 0)

    int? size

    Optional page size in list pagination (optional, default to 20)

    string sort

    Optional createdAt sort direction ASC or DESC (optional, default to ASC)

    string searchFilter

    Optional search filter (optional)

    DateTime? since

    Filter by created at after the given timestamp (optional)

    DateTime? before

    Filter by created at before the given timestamp (optional)

    bool? unseenOnly

    Filter for unseen exceptions only (optional)

    string resultType

    Filter by result type (optional)

    string eventName

    Filter by event name (optional)

    int? minStatusCode

    Minimum response status (optional)

    int? maxStatusCode

    Maximum response status (optional)

    System.Guid? inboxId

    Inbox ID (optional)

    System.Guid? smsId

    Sms ID (optional)

    System.Guid? attachmentId

    Attachment ID (optional)

    System.Guid? emailId

    Email ID (optional)

    System.Guid? phoneId

    Phone ID (optional)

    int operationIndex

    Index associated with the operation.

    Returns
    Type Description
    ApiResponse<PageWebhookResult>

    ApiResponse of PageWebhookResult

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    GetWebhookResultsWithHttpInfoAsync(Guid, int?, int?, string, string, DateTime?, DateTime?, bool?, string, string, int?, int?, Guid?, Guid?, Guid?, Guid?, Guid?, int, CancellationToken)

    Get a webhook results for a webhook

    Declaration
    public Task<ApiResponse<PageWebhookResult>> GetWebhookResultsWithHttpInfoAsync(Guid webhookId, int? page = null, int? size = null, string sort = null, string searchFilter = null, DateTime? since = null, DateTime? before = null, bool? unseenOnly = null, string resultType = null, string eventName = null, int? minStatusCode = null, int? maxStatusCode = null, Guid? inboxId = null, Guid? smsId = null, Guid? attachmentId = null, Guid? emailId = null, Guid? phoneId = null, int operationIndex = 0, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    System.Guid webhookId

    ID of webhook to get results for

    int? page

    Optional page index in list pagination (optional, default to 0)

    int? size

    Optional page size in list pagination (optional, default to 20)

    string sort

    Optional createdAt sort direction ASC or DESC (optional, default to ASC)

    string searchFilter

    Optional search filter (optional)

    DateTime? since

    Filter by created at after the given timestamp (optional)

    DateTime? before

    Filter by created at before the given timestamp (optional)

    bool? unseenOnly

    Filter for unseen exceptions only (optional)

    string resultType

    Filter by result type (optional)

    string eventName

    Filter by event name (optional)

    int? minStatusCode

    Minimum response status (optional)

    int? maxStatusCode

    Maximum response status (optional)

    System.Guid? inboxId

    Inbox ID (optional)

    System.Guid? smsId

    Sms ID (optional)

    System.Guid? attachmentId

    Attachment ID (optional)

    System.Guid? emailId

    Email ID (optional)

    System.Guid? phoneId

    Phone ID (optional)

    int operationIndex

    Index associated with the operation.

    CancellationToken cancellationToken

    Cancellation Token to cancel the request.

    Returns
    Type Description
    Task<ApiResponse<PageWebhookResult>>

    Task of ApiResponse (PageWebhookResult)

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    GetWebhookResultWithHttpInfo(Guid, int)

    Get a webhook result for a webhook

    Declaration
    public ApiResponse<WebhookResultDto> GetWebhookResultWithHttpInfo(Guid webhookResultId, int operationIndex = 0)
    Parameters
    Type Name Description
    System.Guid webhookResultId

    Webhook Result ID

    int operationIndex

    Index associated with the operation.

    Returns
    Type Description
    ApiResponse<WebhookResultDto>

    ApiResponse of WebhookResultDto

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    GetWebhookResultWithHttpInfoAsync(Guid, int, CancellationToken)

    Get a webhook result for a webhook

    Declaration
    public Task<ApiResponse<WebhookResultDto>> GetWebhookResultWithHttpInfoAsync(Guid webhookResultId, int operationIndex = 0, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    System.Guid webhookResultId

    Webhook Result ID

    int operationIndex

    Index associated with the operation.

    CancellationToken cancellationToken

    Cancellation Token to cancel the request.

    Returns
    Type Description
    Task<ApiResponse<WebhookResultDto>>

    Task of ApiResponse (WebhookResultDto)

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    GetWebhooks(Guid, int)

    Get all webhooks for an Inbox

    Declaration
    [Obsolete]
    public List<WebhookDto> GetWebhooks(Guid inboxId, int operationIndex = 0)
    Parameters
    Type Name Description
    System.Guid inboxId
    int operationIndex

    Index associated with the operation.

    Returns
    Type Description
    System.Collections.Generic.List<T><WebhookDto>

    List<WebhookDto>

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    GetWebhooksAsync(Guid, int, CancellationToken)

    Get all webhooks for an Inbox

    Declaration
    [Obsolete]
    public Task<List<WebhookDto>> GetWebhooksAsync(Guid inboxId, int operationIndex = 0, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    System.Guid inboxId
    int operationIndex

    Index associated with the operation.

    CancellationToken cancellationToken

    Cancellation Token to cancel the request.

    Returns
    Type Description
    Task<System.Collections.Generic.List<T><WebhookDto>>

    Task of List<WebhookDto>

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    GetWebhooksWithHttpInfo(Guid, int)

    Get all webhooks for an Inbox

    Declaration
    [Obsolete]
    public ApiResponse<List<WebhookDto>> GetWebhooksWithHttpInfo(Guid inboxId, int operationIndex = 0)
    Parameters
    Type Name Description
    System.Guid inboxId
    int operationIndex

    Index associated with the operation.

    Returns
    Type Description
    ApiResponse<System.Collections.Generic.List<T><WebhookDto>>

    ApiResponse of List<WebhookDto>

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    GetWebhooksWithHttpInfoAsync(Guid, int, CancellationToken)

    Get all webhooks for an Inbox

    Declaration
    [Obsolete]
    public Task<ApiResponse<List<WebhookDto>>> GetWebhooksWithHttpInfoAsync(Guid inboxId, int operationIndex = 0, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    System.Guid inboxId
    int operationIndex

    Index associated with the operation.

    CancellationToken cancellationToken

    Cancellation Token to cancel the request.

    Returns
    Type Description
    Task<ApiResponse<System.Collections.Generic.List<T><WebhookDto>>>

    Task of ApiResponse (List<WebhookDto>)

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    GetWebhookWithHttpInfo(Guid, int)

    Get a webhook

    Declaration
    public ApiResponse<WebhookDto> GetWebhookWithHttpInfo(Guid webhookId, int operationIndex = 0)
    Parameters
    Type Name Description
    System.Guid webhookId
    int operationIndex

    Index associated with the operation.

    Returns
    Type Description
    ApiResponse<WebhookDto>

    ApiResponse of WebhookDto

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    GetWebhookWithHttpInfoAsync(Guid, int, CancellationToken)

    Get a webhook

    Declaration
    public Task<ApiResponse<WebhookDto>> GetWebhookWithHttpInfoAsync(Guid webhookId, int operationIndex = 0, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    System.Guid webhookId
    int operationIndex

    Index associated with the operation.

    CancellationToken cancellationToken

    Cancellation Token to cancel the request.

    Returns
    Type Description
    Task<ApiResponse<WebhookDto>>

    Task of ApiResponse (WebhookDto)

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    RedriveAllWebhookResults(int)

    Redrive all webhook results that have failed status Allows you to resend webhook payloads for any recorded webhook result that failed to deliver the payload.

    Declaration
    public WebhookRedriveAllResult RedriveAllWebhookResults(int operationIndex = 0)
    Parameters
    Type Name Description
    int operationIndex

    Index associated with the operation.

    Returns
    Type Description
    WebhookRedriveAllResult

    WebhookRedriveAllResult

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    RedriveAllWebhookResultsAsync(int, CancellationToken)

    Redrive all webhook results that have failed status Allows you to resend webhook payloads for any recorded webhook result that failed to deliver the payload.

    Declaration
    public Task<WebhookRedriveAllResult> RedriveAllWebhookResultsAsync(int operationIndex = 0, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    int operationIndex

    Index associated with the operation.

    CancellationToken cancellationToken

    Cancellation Token to cancel the request.

    Returns
    Type Description
    Task<WebhookRedriveAllResult>

    Task of WebhookRedriveAllResult

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    RedriveAllWebhookResultsWithHttpInfo(int)

    Redrive all webhook results that have failed status Allows you to resend webhook payloads for any recorded webhook result that failed to deliver the payload.

    Declaration
    public ApiResponse<WebhookRedriveAllResult> RedriveAllWebhookResultsWithHttpInfo(int operationIndex = 0)
    Parameters
    Type Name Description
    int operationIndex

    Index associated with the operation.

    Returns
    Type Description
    ApiResponse<WebhookRedriveAllResult>

    ApiResponse of WebhookRedriveAllResult

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    RedriveAllWebhookResultsWithHttpInfoAsync(int, CancellationToken)

    Redrive all webhook results that have failed status Allows you to resend webhook payloads for any recorded webhook result that failed to deliver the payload.

    Declaration
    public Task<ApiResponse<WebhookRedriveAllResult>> RedriveAllWebhookResultsWithHttpInfoAsync(int operationIndex = 0, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    int operationIndex

    Index associated with the operation.

    CancellationToken cancellationToken

    Cancellation Token to cancel the request.

    Returns
    Type Description
    Task<ApiResponse<WebhookRedriveAllResult>>

    Task of ApiResponse (WebhookRedriveAllResult)

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    RedriveWebhookResult(Guid, int)

    Get a webhook result and try to resend the original webhook payload Allows you to resend a webhook payload that was already sent. Webhooks that fail are retried automatically for 24 hours and then put in a dead letter queue. You can retry results manually using this method.

    Declaration
    public WebhookRedriveResult RedriveWebhookResult(Guid webhookResultId, int operationIndex = 0)
    Parameters
    Type Name Description
    System.Guid webhookResultId

    Webhook Result ID

    int operationIndex

    Index associated with the operation.

    Returns
    Type Description
    WebhookRedriveResult

    WebhookRedriveResult

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    RedriveWebhookResultAsync(Guid, int, CancellationToken)

    Get a webhook result and try to resend the original webhook payload Allows you to resend a webhook payload that was already sent. Webhooks that fail are retried automatically for 24 hours and then put in a dead letter queue. You can retry results manually using this method.

    Declaration
    public Task<WebhookRedriveResult> RedriveWebhookResultAsync(Guid webhookResultId, int operationIndex = 0, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    System.Guid webhookResultId

    Webhook Result ID

    int operationIndex

    Index associated with the operation.

    CancellationToken cancellationToken

    Cancellation Token to cancel the request.

    Returns
    Type Description
    Task<WebhookRedriveResult>

    Task of WebhookRedriveResult

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    RedriveWebhookResultWithHttpInfo(Guid, int)

    Get a webhook result and try to resend the original webhook payload Allows you to resend a webhook payload that was already sent. Webhooks that fail are retried automatically for 24 hours and then put in a dead letter queue. You can retry results manually using this method.

    Declaration
    public ApiResponse<WebhookRedriveResult> RedriveWebhookResultWithHttpInfo(Guid webhookResultId, int operationIndex = 0)
    Parameters
    Type Name Description
    System.Guid webhookResultId

    Webhook Result ID

    int operationIndex

    Index associated with the operation.

    Returns
    Type Description
    ApiResponse<WebhookRedriveResult>

    ApiResponse of WebhookRedriveResult

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    RedriveWebhookResultWithHttpInfoAsync(Guid, int, CancellationToken)

    Get a webhook result and try to resend the original webhook payload Allows you to resend a webhook payload that was already sent. Webhooks that fail are retried automatically for 24 hours and then put in a dead letter queue. You can retry results manually using this method.

    Declaration
    public Task<ApiResponse<WebhookRedriveResult>> RedriveWebhookResultWithHttpInfoAsync(Guid webhookResultId, int operationIndex = 0, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    System.Guid webhookResultId

    Webhook Result ID

    int operationIndex

    Index associated with the operation.

    CancellationToken cancellationToken

    Cancellation Token to cancel the request.

    Returns
    Type Description
    Task<ApiResponse<WebhookRedriveResult>>

    Task of ApiResponse (WebhookRedriveResult)

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    SendTestData(Guid, int)

    Send webhook test data

    Declaration
    public WebhookTestResult SendTestData(Guid webhookId, int operationIndex = 0)
    Parameters
    Type Name Description
    System.Guid webhookId
    int operationIndex

    Index associated with the operation.

    Returns
    Type Description
    WebhookTestResult

    WebhookTestResult

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    SendTestDataAsync(Guid, int, CancellationToken)

    Send webhook test data

    Declaration
    public Task<WebhookTestResult> SendTestDataAsync(Guid webhookId, int operationIndex = 0, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    System.Guid webhookId
    int operationIndex

    Index associated with the operation.

    CancellationToken cancellationToken

    Cancellation Token to cancel the request.

    Returns
    Type Description
    Task<WebhookTestResult>

    Task of WebhookTestResult

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    SendTestDataWithHttpInfo(Guid, int)

    Send webhook test data

    Declaration
    public ApiResponse<WebhookTestResult> SendTestDataWithHttpInfo(Guid webhookId, int operationIndex = 0)
    Parameters
    Type Name Description
    System.Guid webhookId
    int operationIndex

    Index associated with the operation.

    Returns
    Type Description
    ApiResponse<WebhookTestResult>

    ApiResponse of WebhookTestResult

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    SendTestDataWithHttpInfoAsync(Guid, int, CancellationToken)

    Send webhook test data

    Declaration
    public Task<ApiResponse<WebhookTestResult>> SendTestDataWithHttpInfoAsync(Guid webhookId, int operationIndex = 0, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    System.Guid webhookId
    int operationIndex

    Index associated with the operation.

    CancellationToken cancellationToken

    Cancellation Token to cancel the request.

    Returns
    Type Description
    Task<ApiResponse<WebhookTestResult>>

    Task of ApiResponse (WebhookTestResult)

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    UpdateWebhookHeaders(Guid, WebhookHeaders, int)

    Update a webhook request headers

    Declaration
    public WebhookDto UpdateWebhookHeaders(Guid webhookId, WebhookHeaders webhookHeaders, int operationIndex = 0)
    Parameters
    Type Name Description
    System.Guid webhookId
    WebhookHeaders webhookHeaders
    int operationIndex

    Index associated with the operation.

    Returns
    Type Description
    WebhookDto

    WebhookDto

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    UpdateWebhookHeadersAsync(Guid, WebhookHeaders, int, CancellationToken)

    Update a webhook request headers

    Declaration
    public Task<WebhookDto> UpdateWebhookHeadersAsync(Guid webhookId, WebhookHeaders webhookHeaders, int operationIndex = 0, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    System.Guid webhookId
    WebhookHeaders webhookHeaders
    int operationIndex

    Index associated with the operation.

    CancellationToken cancellationToken

    Cancellation Token to cancel the request.

    Returns
    Type Description
    Task<WebhookDto>

    Task of WebhookDto

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    UpdateWebhookHeadersWithHttpInfo(Guid, WebhookHeaders, int)

    Update a webhook request headers

    Declaration
    public ApiResponse<WebhookDto> UpdateWebhookHeadersWithHttpInfo(Guid webhookId, WebhookHeaders webhookHeaders, int operationIndex = 0)
    Parameters
    Type Name Description
    System.Guid webhookId
    WebhookHeaders webhookHeaders
    int operationIndex

    Index associated with the operation.

    Returns
    Type Description
    ApiResponse<WebhookDto>

    ApiResponse of WebhookDto

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    UpdateWebhookHeadersWithHttpInfoAsync(Guid, WebhookHeaders, int, CancellationToken)

    Update a webhook request headers

    Declaration
    public Task<ApiResponse<WebhookDto>> UpdateWebhookHeadersWithHttpInfoAsync(Guid webhookId, WebhookHeaders webhookHeaders, int operationIndex = 0, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    System.Guid webhookId
    WebhookHeaders webhookHeaders
    int operationIndex

    Index associated with the operation.

    CancellationToken cancellationToken

    Cancellation Token to cancel the request.

    Returns
    Type Description
    Task<ApiResponse<WebhookDto>>

    Task of ApiResponse (WebhookDto)

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    VerifyWebhookSignature(VerifyWebhookSignatureOptions, int)

    Verify a webhook payload signature Verify a webhook payload using the messageId and signature. This allows you to be sure that MailSlurp sent the payload and not another server.

    Declaration
    public VerifyWebhookSignatureResults VerifyWebhookSignature(VerifyWebhookSignatureOptions verifyWebhookSignatureOptions, int operationIndex = 0)
    Parameters
    Type Name Description
    VerifyWebhookSignatureOptions verifyWebhookSignatureOptions
    int operationIndex

    Index associated with the operation.

    Returns
    Type Description
    VerifyWebhookSignatureResults

    VerifyWebhookSignatureResults

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    VerifyWebhookSignatureAsync(VerifyWebhookSignatureOptions, int, CancellationToken)

    Verify a webhook payload signature Verify a webhook payload using the messageId and signature. This allows you to be sure that MailSlurp sent the payload and not another server.

    Declaration
    public Task<VerifyWebhookSignatureResults> VerifyWebhookSignatureAsync(VerifyWebhookSignatureOptions verifyWebhookSignatureOptions, int operationIndex = 0, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    VerifyWebhookSignatureOptions verifyWebhookSignatureOptions
    int operationIndex

    Index associated with the operation.

    CancellationToken cancellationToken

    Cancellation Token to cancel the request.

    Returns
    Type Description
    Task<VerifyWebhookSignatureResults>

    Task of VerifyWebhookSignatureResults

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    VerifyWebhookSignatureWithHttpInfo(VerifyWebhookSignatureOptions, int)

    Verify a webhook payload signature Verify a webhook payload using the messageId and signature. This allows you to be sure that MailSlurp sent the payload and not another server.

    Declaration
    public ApiResponse<VerifyWebhookSignatureResults> VerifyWebhookSignatureWithHttpInfo(VerifyWebhookSignatureOptions verifyWebhookSignatureOptions, int operationIndex = 0)
    Parameters
    Type Name Description
    VerifyWebhookSignatureOptions verifyWebhookSignatureOptions
    int operationIndex

    Index associated with the operation.

    Returns
    Type Description
    ApiResponse<VerifyWebhookSignatureResults>

    ApiResponse of VerifyWebhookSignatureResults

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    VerifyWebhookSignatureWithHttpInfoAsync(VerifyWebhookSignatureOptions, int, CancellationToken)

    Verify a webhook payload signature Verify a webhook payload using the messageId and signature. This allows you to be sure that MailSlurp sent the payload and not another server.

    Declaration
    public Task<ApiResponse<VerifyWebhookSignatureResults>> VerifyWebhookSignatureWithHttpInfoAsync(VerifyWebhookSignatureOptions verifyWebhookSignatureOptions, int operationIndex = 0, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    VerifyWebhookSignatureOptions verifyWebhookSignatureOptions
    int operationIndex

    Index associated with the operation.

    CancellationToken cancellationToken

    Cancellation Token to cancel the request.

    Returns
    Type Description
    Task<ApiResponse<VerifyWebhookSignatureResults>>

    Task of ApiResponse (VerifyWebhookSignatureResults)

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    WaitForWebhookResults(Guid, int, int, int)

    Wait for webhook results for a webhook

    Declaration
    public List<WebhookResultDto> WaitForWebhookResults(Guid webhookId, int expectedCount, int timeout, int operationIndex = 0)
    Parameters
    Type Name Description
    System.Guid webhookId

    ID of webhook to get results for

    int expectedCount

    Expected result count

    int timeout

    Max time to wait in milliseconds

    int operationIndex

    Index associated with the operation.

    Returns
    Type Description
    System.Collections.Generic.List<T><WebhookResultDto>

    List<WebhookResultDto>

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    WaitForWebhookResultsAsync(Guid, int, int, int, CancellationToken)

    Wait for webhook results for a webhook

    Declaration
    public Task<List<WebhookResultDto>> WaitForWebhookResultsAsync(Guid webhookId, int expectedCount, int timeout, int operationIndex = 0, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    System.Guid webhookId

    ID of webhook to get results for

    int expectedCount

    Expected result count

    int timeout

    Max time to wait in milliseconds

    int operationIndex

    Index associated with the operation.

    CancellationToken cancellationToken

    Cancellation Token to cancel the request.

    Returns
    Type Description
    Task<System.Collections.Generic.List<T><WebhookResultDto>>

    Task of List<WebhookResultDto>

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    WaitForWebhookResultsWithHttpInfo(Guid, int, int, int)

    Wait for webhook results for a webhook

    Declaration
    public ApiResponse<List<WebhookResultDto>> WaitForWebhookResultsWithHttpInfo(Guid webhookId, int expectedCount, int timeout, int operationIndex = 0)
    Parameters
    Type Name Description
    System.Guid webhookId

    ID of webhook to get results for

    int expectedCount

    Expected result count

    int timeout

    Max time to wait in milliseconds

    int operationIndex

    Index associated with the operation.

    Returns
    Type Description
    ApiResponse<System.Collections.Generic.List<T><WebhookResultDto>>

    ApiResponse of List<WebhookResultDto>

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    WaitForWebhookResultsWithHttpInfoAsync(Guid, int, int, int, CancellationToken)

    Wait for webhook results for a webhook

    Declaration
    public Task<ApiResponse<List<WebhookResultDto>>> WaitForWebhookResultsWithHttpInfoAsync(Guid webhookId, int expectedCount, int timeout, int operationIndex = 0, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    System.Guid webhookId

    ID of webhook to get results for

    int expectedCount

    Expected result count

    int timeout

    Max time to wait in milliseconds

    int operationIndex

    Index associated with the operation.

    CancellationToken cancellationToken

    Cancellation Token to cancel the request.

    Returns
    Type Description
    Task<ApiResponse<System.Collections.Generic.List<T><WebhookResultDto>>>

    Task of ApiResponse (List<WebhookResultDto>)

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    Implements

    IWebhookControllerApi
    IWebhookControllerApiSync
    IWebhookControllerApiAsync
    IApiAccessor
    • View Source
    In This Article
    Back to top See MailSlurp website for more information.