WebhooksV2Api

Trait WebhooksV2Api 

Source
pub trait WebhooksV2Api: Send + Sync {
    // Required methods
    fn create_webhook<'life0, 'async_trait>(
        &'life0 self,
        params: CreateWebhookParams,
    ) -> Pin<Box<dyn Future<Output = Result<Webhook, Error<CreateWebhookError>>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
    fn delete_webhook<'life0, 'async_trait>(
        &'life0 self,
        params: DeleteWebhookParams,
    ) -> Pin<Box<dyn Future<Output = Result<Webhook, Error<DeleteWebhookError>>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
    fn get_notification<'life0, 'async_trait>(
        &'life0 self,
        params: GetNotificationParams,
    ) -> Pin<Box<dyn Future<Output = Result<NotificationWithData, Error<GetNotificationError>>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
    fn get_notification_attempts<'life0, 'async_trait>(
        &'life0 self,
        params: GetNotificationAttemptsParams,
    ) -> Pin<Box<dyn Future<Output = Result<NotificationAttemptsPaginatedResponse, Error<GetNotificationAttemptsError>>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
    fn get_notifications<'life0, 'async_trait>(
        &'life0 self,
        params: GetNotificationsParams,
    ) -> Pin<Box<dyn Future<Output = Result<NotificationPaginatedResponse, Error<GetNotificationsError>>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
    fn get_resend_job_status<'life0, 'async_trait>(
        &'life0 self,
        params: GetResendJobStatusParams,
    ) -> Pin<Box<dyn Future<Output = Result<ResendFailedNotificationsJobStatusResponse, Error<GetResendJobStatusError>>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
    fn get_webhook<'life0, 'async_trait>(
        &'life0 self,
        params: GetWebhookParams,
    ) -> Pin<Box<dyn Future<Output = Result<Webhook, Error<GetWebhookError>>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
    fn get_webhooks<'life0, 'async_trait>(
        &'life0 self,
        params: GetWebhooksParams,
    ) -> Pin<Box<dyn Future<Output = Result<WebhookPaginatedResponse, Error<GetWebhooksError>>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
    fn resend_failed_notifications<'life0, 'async_trait>(
        &'life0 self,
        params: ResendFailedNotificationsParams,
    ) -> Pin<Box<dyn Future<Output = Result<ResendFailedNotificationsResponse, Error<ResendFailedNotificationsError>>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
    fn resend_notification_by_id<'life0, 'async_trait>(
        &'life0 self,
        params: ResendNotificationByIdParams,
    ) -> Pin<Box<dyn Future<Output = Result<(), Error<ResendNotificationByIdError>>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
    fn resend_notifications_by_resource_id<'life0, 'async_trait>(
        &'life0 self,
        params: ResendNotificationsByResourceIdParams,
    ) -> Pin<Box<dyn Future<Output = Result<(), Error<ResendNotificationsByResourceIdError>>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
    fn update_webhook<'life0, 'async_trait>(
        &'life0 self,
        params: UpdateWebhookParams,
    ) -> Pin<Box<dyn Future<Output = Result<Webhook, Error<UpdateWebhookError>>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
}

Required Methods§

Source

fn create_webhook<'life0, 'async_trait>( &'life0 self, params: CreateWebhookParams, ) -> Pin<Box<dyn Future<Output = Result<Webhook, Error<CreateWebhookError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

POST /webhooks

Creates a new webhook, which will be triggered on the specified events Endpoint Permissions: Owner, Admin, Non-Signing Admin.

Source

fn delete_webhook<'life0, 'async_trait>( &'life0 self, params: DeleteWebhookParams, ) -> Pin<Box<dyn Future<Output = Result<Webhook, Error<DeleteWebhookError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

DELETE /webhooks/{webhookId}

Delete a webhook by its ID. Endpoint Permissions: Owner, Admin, Non-Signing Admin.

Source

fn get_notification<'life0, 'async_trait>( &'life0 self, params: GetNotificationParams, ) -> Pin<Box<dyn Future<Output = Result<NotificationWithData, Error<GetNotificationError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

GET /webhooks/{webhookId}/notifications/{notificationId}

Get a notification by its notification ID. Endpoint Permissions: Owner, Admin, Non-Signing Admin.

Source

fn get_notification_attempts<'life0, 'async_trait>( &'life0 self, params: GetNotificationAttemptsParams, ) -> Pin<Box<dyn Future<Output = Result<NotificationAttemptsPaginatedResponse, Error<GetNotificationAttemptsError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

GET /webhooks/{webhookId}/notifications/{notificationId}/attempts

Get notification attempts by notification ID.

Source

fn get_notifications<'life0, 'async_trait>( &'life0 self, params: GetNotificationsParams, ) -> Pin<Box<dyn Future<Output = Result<NotificationPaginatedResponse, Error<GetNotificationsError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

GET /webhooks/{webhookId}/notifications

Get all notifications by webhook ID (paginated). Endpoint Permissions: Owner, Admin, Non-Signing Admin.

Source

fn get_resend_job_status<'life0, 'async_trait>( &'life0 self, params: GetResendJobStatusParams, ) -> Pin<Box<dyn Future<Output = Result<ResendFailedNotificationsJobStatusResponse, Error<GetResendJobStatusError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

GET /webhooks/{webhookId}/notifications/resend_failed/jobs/{jobId}

Get the status of a resend job.

Source

fn get_webhook<'life0, 'async_trait>( &'life0 self, params: GetWebhookParams, ) -> Pin<Box<dyn Future<Output = Result<Webhook, Error<GetWebhookError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

GET /webhooks/{webhookId}

Retrieve a webhook by its ID. Endpoint Permissions: Owner, Admin, Non-Signing Admin.

Source

fn get_webhooks<'life0, 'async_trait>( &'life0 self, params: GetWebhooksParams, ) -> Pin<Box<dyn Future<Output = Result<WebhookPaginatedResponse, Error<GetWebhooksError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

GET /webhooks

Get all webhooks (paginated). Endpoint Permissions: Owner, Admin, Non-Signing Admin.

Source

fn resend_failed_notifications<'life0, 'async_trait>( &'life0 self, params: ResendFailedNotificationsParams, ) -> Pin<Box<dyn Future<Output = Result<ResendFailedNotificationsResponse, Error<ResendFailedNotificationsError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

POST /webhooks/{webhookId}/notifications/resend_failed

Resend all failed notifications for a webhook in the last 24 hours. Endpoint Permission: Owner, Admin, Non-Signing Admin, Signer, Editor.

Source

fn resend_notification_by_id<'life0, 'async_trait>( &'life0 self, params: ResendNotificationByIdParams, ) -> Pin<Box<dyn Future<Output = Result<(), Error<ResendNotificationByIdError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

POST /webhooks/{webhookId}/notifications/{notificationId}/resend

Resend a notification by its ID. Endpoint Permissions: Owner, Admin, Non-Signing Admin, Signer, Editor.

Source

fn resend_notifications_by_resource_id<'life0, 'async_trait>( &'life0 self, params: ResendNotificationsByResourceIdParams, ) -> Pin<Box<dyn Future<Output = Result<(), Error<ResendNotificationsByResourceIdError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

POST /webhooks/{webhookId}/notifications/resend_by_resource

Resend notifications by their resource ID. Endpoint Permissions: Owner, Admin, Non-Signing Admin, Signer, Editor.

Source

fn update_webhook<'life0, 'async_trait>( &'life0 self, params: UpdateWebhookParams, ) -> Pin<Box<dyn Future<Output = Result<Webhook, Error<UpdateWebhookError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

PATCH /webhooks/{webhookId}

Update a webhook by its ID. Endpoint Permissions: Owner, Admin, Non-Signing Admin.

Implementors§