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 CompaniesClient {
    pub http_client: HttpClient,
}

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

    /// Returns a paginated list of companies. When parent_company_id is provided, lists connected accounts under that platform. When omitted, lists companies the current user has access to.
    ///
    /// Required permissions:
    /// - `company:basic: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.
    /// * `parent_company_id` - The unique identifier of the parent platform company. When provided, lists connected accounts under that platform. Omit to list the current user's own companies.
    /// * `created_before` - Only return companies created before this timestamp.
    /// * `created_after` - Only return companies created after this timestamp.
    /// * `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
    ///         .companies
    ///         .list(
    ///             &CompaniesListQueryRequest {
    ///                 first: Some(42),
    ///                 last: Some(42),
    ///                 created_before: Some(DateTime::parse_from_rfc3339("2023-12-01T05:00:00Z").unwrap()),
    ///                 created_after: Some(DateTime::parse_from_rfc3339("2023-12-01T05:00:00Z").unwrap()),
    ///                 ..Default::default()
    ///             },
    ///             None,
    ///         )
    ///         .await;
    /// }
    /// ```
    pub async fn list(
        &self,
        request: &CompaniesListQueryRequest,
        options: Option<RequestOptions>,
    ) -> Result<ListCompaniesResponse, ApiError> {
        self.http_client
            .execute_request(
                Method::GET,
                "companies",
                None,
                QueryBuilder::new()
                    .string("after", request.after.clone())
                    .string("before", request.before.clone())
                    .int("first", request.first.clone())
                    .int("last", request.last.clone())
                    .string("parent_company_id", request.parent_company_id.clone())
                    .serialize("direction", request.direction.clone())
                    .datetime("created_before", request.created_before.clone())
                    .datetime("created_after", request.created_after.clone())
                    .build(),
                options,
            )
            .await
    }

    /// Create a new company. Pass parent_company_id to create a connected account under a platform, or omit it to create a company for the current user.
    ///
    /// Required permissions:
    /// - `company:create`
    /// - `company:basic:read`
    ///
    /// # 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
    ///         .companies
    ///         .create(
    ///             &CreateCompaniesRequest {
    ///                 title: "title".to_string(),
    ///                 country: None,
    ///                 description: None,
    ///                 email: None,
    ///                 logo: None,
    ///                 metadata: None,
    ///                 parent_company_id: None,
    ///                 send_customer_emails: None,
    ///             },
    ///             None,
    ///         )
    ///         .await;
    /// }
    /// ```
    pub async fn create(
        &self,
        request: &CreateCompaniesRequest,
        options: Option<RequestOptions>,
    ) -> Result<Company, ApiError> {
        self.http_client
            .execute_request(
                Method::POST,
                "companies",
                Some(serde_json::to_value(request).map_err(ApiError::Serialization)?),
                None,
                options,
            )
            .await
    }

    /// Retrieves the details of an existing company.
    ///
    /// Required permissions:
    /// - `company:basic:read`
    ///
    /// # Arguments
    ///
    /// * `id` - The unique identifier or route slug of the company.
    /// * `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
    ///         .companies
    ///         .retrieve(&"biz_xxxxxxxxxxxxxx".to_string(), None)
    ///         .await;
    /// }
    /// ```
    pub async fn retrieve(
        &self,
        id: &str,
        options: Option<RequestOptions>,
    ) -> Result<Company, ApiError> {
        self.http_client
            .execute_request(
                Method::GET,
                &format!("companies/{}", id),
                None,
                None,
                options,
            )
            .await
    }

    /// Update a company's title, description, logo, and other settings.
    ///
    /// Required permissions:
    /// - `company:update`
    /// - `company:basic:read`
    ///
    /// # Arguments
    ///
    /// * `id` - The unique identifier of the company to update.
    /// * `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
    ///         .companies
    ///         .update(
    ///             &"biz_xxxxxxxxxxxxxx".to_string(),
    ///             &UpdateCompaniesRequest {
    ///                 ..Default::default()
    ///             },
    ///             None,
    ///         )
    ///         .await;
    /// }
    /// ```
    pub async fn update(
        &self,
        id: &str,
        request: &UpdateCompaniesRequest,
        options: Option<RequestOptions>,
    ) -> Result<Company, ApiError> {
        self.http_client
            .execute_request(
                Method::PATCH,
                &format!("companies/{}", id),
                Some(serde_json::to_value(request).map_err(ApiError::Serialization)?),
                None,
                options,
            )
            .await
    }

    /// Create an API key for a connected account (child company) owned by a parent company.
    ///
    /// # Arguments
    ///
    /// * `parent_company_id` - The unique identifier of the parent platform company (e.g. 'biz_xxx').
    /// * `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
    ///         .companies
    ///         .create_api_key(
    ///             &"parent_company_id".to_string(),
    ///             &CreateAPIKeyCompaniesRequest {
    ///                 child_company_id: "child_company_id".to_string(),
    ///                 name: None,
    ///                 permissions: None,
    ///                 role: None,
    ///             },
    ///             None,
    ///         )
    ///         .await;
    /// }
    /// ```
    pub async fn create_api_key(
        &self,
        parent_company_id: &str,
        request: &CreateApiKeyCompaniesRequest,
        options: Option<RequestOptions>,
    ) -> Result<CreateApiKeyCompaniesResponse, ApiError> {
        self.http_client
            .execute_request(
                Method::POST,
                &format!("companies/{}/api_keys", parent_company_id),
                Some(serde_json::to_value(request).map_err(ApiError::Serialization)?),
                None,
                options,
            )
            .await
    }
}