workos 1.0.0

Official Rust SDK for the WorkOS API
Documentation
// Code generated by oagen. DO NOT EDIT.

use crate::client::Client;
#[allow(unused_imports)]
use crate::enums::*;
use crate::error::Error;
#[allow(unused_imports)]
use crate::models::*;
use serde::Serialize;

pub struct WebhooksApi<'a> {
    pub(crate) client: &'a Client,
}

#[derive(Debug, Clone, Default, Serialize)]
pub struct ListWebhookEndpointsParams {
    /// An object ID that defines your place in the list. When the ID is not present, you are at the end of the list. For example, if you make a list request and receive 100 objects, ending with `"obj_123"`, your subsequent call can include `before="obj_123"` to fetch a new batch of objects before `"obj_123"`.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub before: Option<String>,
    /// An object ID that defines your place in the list. When the ID is not present, you are at the end of the list. For example, if you make a list request and receive 100 objects, ending with `"obj_123"`, your subsequent call can include `after="obj_123"` to fetch a new batch of objects after `"obj_123"`.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub after: Option<String>,
    /// Upper limit on the number of objects to return, between `1` and `100`.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub limit: Option<i64>,
    /// Order the results by the creation time. Supported values are `"asc"` (ascending), `"desc"` (descending), and `"normal"` (descending with reversed cursor semantics where `before` fetches older records and `after` fetches newer records). Defaults to descending.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub order: Option<PaginationOrder>,
}

#[derive(Debug, Clone, Serialize)]
pub struct CreateWebhookEndpointParams {
    /// Request body sent with this call.
    ///
    /// Required.
    #[serde(skip)]
    pub body: CreateWebhookEndpoint,
}

impl CreateWebhookEndpointParams {
    /// Construct a new `CreateWebhookEndpointParams` with the required fields set.
    #[allow(deprecated)]
    pub fn new(body: CreateWebhookEndpoint) -> Self {
        Self { body }
    }
}

#[derive(Debug, Clone, Serialize)]
pub struct UpdateWebhookEndpointParams {
    /// Request body sent with this call.
    ///
    /// Required.
    #[serde(skip)]
    pub body: UpdateWebhookEndpoint,
}

impl UpdateWebhookEndpointParams {
    /// Construct a new `UpdateWebhookEndpointParams` with the required fields set.
    #[allow(deprecated)]
    pub fn new(body: UpdateWebhookEndpoint) -> Self {
        Self { body }
    }
}

impl<'a> WebhooksApi<'a> {
    /// List Webhook Endpoints
    ///
    /// Get a list of all of your existing webhook endpoints.
    pub async fn list_webhook_endpoints(
        &self,
        params: ListWebhookEndpointsParams,
    ) -> Result<WebhookEndpointList, Error> {
        self.list_webhook_endpoints_with_options(params, None).await
    }

    /// Variant of [`Self::list_webhook_endpoints`] that accepts per-request [`crate::RequestOptions`].
    pub async fn list_webhook_endpoints_with_options(
        &self,
        params: ListWebhookEndpointsParams,
        options: Option<&crate::RequestOptions>,
    ) -> Result<WebhookEndpointList, Error> {
        let path = "/webhook_endpoints".to_string();
        let method = http::Method::GET;
        self.client
            .request_with_query_opts(method, &path, &params, options)
            .await
    }

    /// Returns an async [`futures_util::Stream`] that yields every `WebhookEndpointJson`
    /// across all pages, advancing the `after` cursor under the hood.
    ///
    /// ```ignore
    /// use futures_util::TryStreamExt;
    /// let all: Vec<WebhookEndpointJson> = self
    ///     .list_webhook_endpoints_auto_paging(params)
    ///     .try_collect()
    ///     .await?;
    /// ```
    pub fn list_webhook_endpoints_auto_paging(
        &self,
        params: ListWebhookEndpointsParams,
    ) -> impl futures_util::Stream<Item = Result<WebhookEndpointJson, Error>> + '_ {
        crate::pagination::auto_paginate_pages(move |after| {
            let mut params = params.clone();
            params.after = after;
            async move {
                let page = self.list_webhook_endpoints(params).await?;
                Ok((page.data, page.list_metadata.after))
            }
        })
    }

    /// Create a Webhook Endpoint
    ///
    /// Create a new webhook endpoint to receive event notifications.
    pub async fn create_webhook_endpoint(
        &self,
        params: CreateWebhookEndpointParams,
    ) -> Result<WebhookEndpointJson, Error> {
        self.create_webhook_endpoint_with_options(params, None)
            .await
    }

    /// Variant of [`Self::create_webhook_endpoint`] that accepts per-request [`crate::RequestOptions`].
    pub async fn create_webhook_endpoint_with_options(
        &self,
        params: CreateWebhookEndpointParams,
        options: Option<&crate::RequestOptions>,
    ) -> Result<WebhookEndpointJson, Error> {
        let path = "/webhook_endpoints".to_string();
        let method = http::Method::POST;
        self.client
            .request_with_body_opts(method, &path, &params, Some(&params.body), options)
            .await
    }

    /// Update a Webhook Endpoint
    ///
    /// Update the properties of an existing webhook endpoint.
    pub async fn update_webhook_endpoint(
        &self,
        id: &str,
        params: UpdateWebhookEndpointParams,
    ) -> Result<WebhookEndpointJson, Error> {
        self.update_webhook_endpoint_with_options(id, params, None)
            .await
    }

    /// Variant of [`Self::update_webhook_endpoint`] that accepts per-request [`crate::RequestOptions`].
    pub async fn update_webhook_endpoint_with_options(
        &self,
        id: &str,
        params: UpdateWebhookEndpointParams,
        options: Option<&crate::RequestOptions>,
    ) -> Result<WebhookEndpointJson, Error> {
        let id = crate::client::path_segment(id);
        let path = format!("/webhook_endpoints/{id}");
        let method = http::Method::PATCH;
        self.client
            .request_with_body_opts(method, &path, &params, Some(&params.body), options)
            .await
    }

    /// Delete a Webhook Endpoint
    ///
    /// Delete an existing webhook endpoint.
    pub async fn delete_webhook_endpoint(&self, id: &str) -> Result<(), Error> {
        self.delete_webhook_endpoint_with_options(id, None).await
    }

    /// Variant of [`Self::delete_webhook_endpoint`] that accepts per-request [`crate::RequestOptions`].
    pub async fn delete_webhook_endpoint_with_options(
        &self,
        id: &str,
        options: Option<&crate::RequestOptions>,
    ) -> Result<(), Error> {
        let id = crate::client::path_segment(id);
        let path = format!("/webhook_endpoints/{id}");
        let method = http::Method::DELETE;
        self.client
            .request_with_query_opts_empty(method, &path, &(), options)
            .await
    }
}