Struct UpdateWebhookEndpoint

pub struct UpdateWebhookEndpoint { /* private fields */ }

Updates the webhook endpoint. You may edit the url, the list of enabled_events, and the status of your endpoint.

Implementations

impl UpdateWebhookEndpoint

pub fn new(webhook_endpoint: impl Into<WebhookEndpointId>) -> Self

Construct a new UpdateWebhookEndpoint.

pub fn description(self, description: impl Into<String>) -> Self

An optional description of what the webhook is used for.

pub fn disabled(self, disabled: impl Into<bool>) -> Self

Disable the webhook endpoint if set to true.

pub fn enabled_events( self, enabled_events: impl Into<Vec<UpdateWebhookEndpointEnabledEvents>>, ) -> Self

The list of events to enable for this endpoint. You may specify ['*'] to enable all events, except those that require explicit selection.

pub fn expand(self, expand: impl Into<Vec<String>>) -> Self

Specifies which fields in the response should be expanded.

pub fn metadata(self, metadata: impl Into<HashMap<String, String>>) -> Self

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.

pub fn url(self, url: impl Into<String>) -> Self

The URL of the webhook endpoint.

impl UpdateWebhookEndpoint

pub async fn send<C: StripeClient>( &self, client: &C, ) -> Result<<Self as StripeRequest>::Output, C::Err>

Send the request and return the deserialized response.

pub fn send_blocking<C: StripeBlockingClient>( &self, client: &C, ) -> Result<<Self as StripeRequest>::Output, C::Err>

Send the request and return the deserialized response, blocking until completion.

Trait Implementations

impl Clone for UpdateWebhookEndpoint

fn clone(&self) -> UpdateWebhookEndpoint

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for UpdateWebhookEndpoint

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Serialize for UpdateWebhookEndpoint

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StripeRequest for UpdateWebhookEndpoint

type Output = WebhookEndpoint

The data returned from the eventual API call.

fn build(&self) -> RequestBuilder

Convert the struct into library-agnostic data that can be used by compatible clients to make API calls.

fn customize(&self) -> CustomizableStripeRequest<Self::Output>

Convert to a builder allowing per-request customization.