whop_sdk 1.0.13

The official Rust SDK for the Whop API.
use crate::api::*;
use crate::{ApiError, ClientConfig, HttpClient, QueryBuilder, RequestOptions};
use reqwest::Method;

pub struct SupportChannelsClient {
    pub http_client: HttpClient,
}

impl SupportChannelsClient {
    pub fn new(config: ClientConfig) -> Result<Self, ApiError> {
        Ok(Self {
            http_client: HttpClient::new(config.clone())?,
        })
    }

    /// Returns a paginated list of support channels for a specific company, with optional filtering by resolution status and custom sorting.
    ///
    /// Required permissions:
    /// - `support_chat:read`
    ///
    /// # Arguments
    ///
    /// * `after` - Returns the elements in the list that come after the specified cursor.
    /// * `before` - Returns the elements in the list that come before the specified cursor.
    /// * `first` - Returns the first _n_ elements from the list.
    /// * `last` - Returns the last _n_ elements from the list.
    /// * `company_id` - The unique identifier of the company to list support channels for. Includes channels of child companies. When omitted, returns support channels across all companies the user has access to.
    /// * `open` - Whether to filter by open or resolved support channels. Set to true to only return channels awaiting a response, or false for resolved channels.
    /// * `options` - Additional request options such as headers, timeout, etc.
    ///
    /// # Returns
    ///
    /// JSON response from the API
    ///
    /// # Examples
    ///
    /// ```no_run
    /// use whop_sdk::prelude::*;
    ///
    /// #[tokio::main]
    /// async fn main() {
    ///     let config = ClientConfig {
    ///         token: Some("<token>".to_string()),
    ///         ..Default::default()
    ///     };
    ///     let client = Whop::new(config).expect("Failed to build client");
    ///     client
    ///         .support_channels
    ///         .list(
    ///             &SupportChannelsListQueryRequest {
    ///                 first: Some(42),
    ///                 last: Some(42),
    ///                 company_id: Some("biz_xxxxxxxxxxxxxx".to_string()),
    ///                 ..Default::default()
    ///             },
    ///             None,
    ///         )
    ///         .await;
    /// }
    /// ```
    pub async fn list(
        &self,
        request: &SupportChannelsListQueryRequest,
        options: Option<RequestOptions>,
    ) -> Result<ListSupportChannelsResponse, ApiError> {
        self.http_client
            .execute_request(
                Method::GET,
                "support_channels",
                None,
                QueryBuilder::new()
                    .string("after", request.after.clone())
                    .string("before", request.before.clone())
                    .int("first", request.first.clone())
                    .int("last", request.last.clone())
                    .string("company_id", request.company_id.clone())
                    .serialize("view", request.view.clone())
                    .bool("open", request.open.clone())
                    .serialize("direction", request.direction.clone())
                    .serialize("order", request.order.clone())
                    .build(),
                options,
            )
            .await
    }

    /// Open a new support channel between a company team member and a customer. Returns the existing channel if one already exists for that user.
    ///
    /// Required permissions:
    /// - `support_chat:create`
    ///
    /// # Arguments
    ///
    /// * `options` - Additional request options such as headers, timeout, etc.
    ///
    /// # Returns
    ///
    /// JSON response from the API
    ///
    /// # Examples
    ///
    /// ```no_run
    /// use whop_sdk::prelude::*;
    ///
    /// #[tokio::main]
    /// async fn main() {
    ///     let config = ClientConfig {
    ///         token: Some("<token>".to_string()),
    ///         ..Default::default()
    ///     };
    ///     let client = Whop::new(config).expect("Failed to build client");
    ///     client
    ///         .support_channels
    ///         .create(
    ///             &CreateSupportChannelsRequest {
    ///                 company_id: "biz_xxxxxxxxxxxxxx".to_string(),
    ///                 user_id: "user_xxxxxxxxxxxxx".to_string(),
    ///                 custom_name: None,
    ///                 notifications_enabled: None,
    ///             },
    ///             None,
    ///         )
    ///         .await;
    /// }
    /// ```
    pub async fn create(
        &self,
        request: &CreateSupportChannelsRequest,
        options: Option<RequestOptions>,
    ) -> Result<SupportChannel, ApiError> {
        self.http_client
            .execute_request(
                Method::POST,
                "support_channels",
                Some(serde_json::to_value(request).map_err(ApiError::Serialization)?),
                None,
                options,
            )
            .await
    }

    /// Retrieves the details of an existing support channel.
    ///
    /// Required permissions:
    /// - `support_chat:read`
    ///
    /// # Arguments
    ///
    /// * `id` - The unique identifier of the support channel to retrieve.
    /// * `options` - Additional request options such as headers, timeout, etc.
    ///
    /// # Returns
    ///
    /// JSON response from the API
    ///
    /// # Examples
    ///
    /// ```no_run
    /// use whop_sdk::prelude::*;
    ///
    /// #[tokio::main]
    /// async fn main() {
    ///     let config = ClientConfig {
    ///         token: Some("<token>".to_string()),
    ///         ..Default::default()
    ///     };
    ///     let client = Whop::new(config).expect("Failed to build client");
    ///     client
    ///         .support_channels
    ///         .retrieve(&"id".to_string(), None)
    ///         .await;
    /// }
    /// ```
    pub async fn retrieve(
        &self,
        id: &str,
        options: Option<RequestOptions>,
    ) -> Result<SupportChannel, ApiError> {
        self.http_client
            .execute_request(
                Method::GET,
                &format!("support_channels/{}", id),
                None,
                None,
                options,
            )
            .await
    }
}