ghl-sdk 0.5.2

// @generated by xtask/generate_services.py — do not edit by hand.
//! `brand-boards` — typed methods for all 11 API v3 operations
//! in this module.
//!
//! Access via [`Ghl::v3`](crate::Ghl::v3)`().brand_boards()`. These endpoints send `Version: v3`.
//!
//! Request and response types come from [`ghl_models::v3::brand_boards`](https://docs.rs/ghl-models/latest/ghl_models/v3/brand_boards/); every endpoint is also documented in the
//! [`brand-boards` API reference](https://github.com/Shahroz/ghl-rs/blob/main/docs/api/brand-boards.md).
//!
//! Enable with `features = ["brand-boards"]`.

#![allow(clippy::too_many_arguments)]

use crate::client::Ghl;
use crate::error::Result;
use ghl_models::v3::brand_boards as models;

/// Typed access to the `brand-boards` API v3 surface (11 operations). Obtained via
/// [`Ghl::v3`](crate::Ghl::v3)`().brand_boards()`.
#[derive(Debug, Clone)]
pub struct BrandBoardsService {
    pub(crate) client: Ghl,
}

impl BrandBoardsService {
    pub(crate) fn new(client: Ghl) -> Self {
        Self { client }
    }
}

/// Query parameters for [`BrandBoardsService::list_brand_voices`].
#[derive(Debug, Clone, Default)]
pub struct ListBrandVoicesParams {
    /// Number of brand voices to return. Defaults to 10, minimum is 1, maximum is 20
    pub limit: Option<f64>,
    /// Number of brand voices to skip for pagination. Defaults to 0, minimum is 0
    pub offset: Option<f64>,
    /// Search text for brand voice name
    pub search: Option<String>,
    /// Whether to return deleted brand voices. Defaults to false
    pub deleted: Option<bool>,
}

impl ListBrandVoicesParams {
    /// Start from the parameters the API requires.
    pub fn new() -> Self {
        Self {
            ..Default::default()
        }
    }

    /// Number of brand voices to return. Defaults to 10, minimum is 1, maximum is 20
    pub fn limit(mut self, v: f64) -> Self {
        self.limit = Some(v);
        self
    }

    /// Number of brand voices to skip for pagination. Defaults to 0, minimum is 0
    pub fn offset(mut self, v: f64) -> Self {
        self.offset = Some(v);
        self
    }

    /// Search text for brand voice name
    pub fn search(mut self, v: impl Into<String>) -> Self {
        self.search = Some(v.into());
        self
    }

    /// Whether to return deleted brand voices. Defaults to false
    pub fn deleted(mut self, v: bool) -> Self {
        self.deleted = Some(v);
        self
    }

    fn to_query(&self) -> Vec<(String, String)> {
        let mut q: Vec<(String, String)> = Vec::new();
        if let Some(v) = &self.limit {
            q.push(("limit".into(), v.to_string()));
        }
        if let Some(v) = &self.offset {
            q.push(("offset".into(), v.to_string()));
        }
        if let Some(v) = &self.search {
            q.push(("search".into(), v.to_string()));
        }
        if let Some(v) = &self.deleted {
            q.push(("deleted".into(), v.to_string()));
        }
        q
    }
}

/// Query parameters for [`BrandBoardsService::get_brand_boards`].
#[derive(Debug, Clone, Default)]
pub struct GetBrandBoardsParams {
    /// Maximum number of brand boards to return
    pub limit: Option<f64>,
    /// Number of brand boards to skip for pagination
    pub offset: Option<f64>,
    /// Search term to filter brand boards by name
    pub search: Option<String>,
    /// Include deleted brand boards in results
    pub deleted: Option<bool>,
}

impl GetBrandBoardsParams {
    /// Start from the parameters the API requires.
    pub fn new() -> Self {
        Self {
            ..Default::default()
        }
    }

    /// Maximum number of brand boards to return
    pub fn limit(mut self, v: f64) -> Self {
        self.limit = Some(v);
        self
    }

    /// Number of brand boards to skip for pagination
    pub fn offset(mut self, v: f64) -> Self {
        self.offset = Some(v);
        self
    }

    /// Search term to filter brand boards by name
    pub fn search(mut self, v: impl Into<String>) -> Self {
        self.search = Some(v.into());
        self
    }

    /// Include deleted brand boards in results
    pub fn deleted(mut self, v: bool) -> Self {
        self.deleted = Some(v);
        self
    }

    fn to_query(&self) -> Vec<(String, String)> {
        let mut q: Vec<(String, String)> = Vec::new();
        if let Some(v) = &self.limit {
            q.push(("limit".into(), v.to_string()));
        }
        if let Some(v) = &self.offset {
            q.push(("offset".into(), v.to_string()));
        }
        if let Some(v) = &self.search {
            q.push(("search".into(), v.to_string()));
        }
        if let Some(v) = &self.deleted {
            q.push(("deleted".into(), v.to_string()));
        }
        q
    }
}

impl BrandBoardsService {
    /// Create a new brand board
    ///
    /// Creates a new brand board with logos, colors, and fonts
    ///
    /// `POST /brand-boards/`
    ///
    /// Requires scope: `brand-boards/design-kit.write`.
    pub async fn create_a_new_brand_board(
        &self,
        body: &models::CreateBrandBoardParam,
    ) -> Result<models::GetBrandBoardSuccessDTO> {
        let query = Vec::new();
        self.client
            .send_versioned(
                reqwest::Method::POST,
                "/brand-boards/",
                &query,
                Some(body),
                Some("v3"),
            )
            .await
    }

    /// List Brand Voices
    ///
    /// Get list of brand voices for a location
    ///
    /// `GET /brand-boards/locations/{locationId}/brand-voices`
    pub async fn list_brand_voices(
        &self,
        location_id: &str,
        params: &ListBrandVoicesParams,
    ) -> Result<models::ListBrandVoicesPublicV1ResponseDto> {
        let path = format!(
            "/brand-boards/locations/{}/brand-voices",
            crate::services::encode(location_id)
        );
        let query = params.to_query();
        self.client
            .send_versioned(reqwest::Method::GET, &path, &query, None::<&()>, Some("v3"))
            .await
    }

    /// Create Brand Voice
    ///
    /// Create a brand voice for a location
    ///
    /// `POST /brand-boards/locations/{locationId}/brand-voices`
    pub async fn create_brand_voice(
        &self,
        location_id: &str,
        body: &models::CreateBrandVoicePublicV1BodyDto,
    ) -> Result<models::CreateBrandVoicePublicV1ResponseDto> {
        let path = format!(
            "/brand-boards/locations/{}/brand-voices",
            crate::services::encode(location_id)
        );
        let query = Vec::new();
        self.client
            .send_versioned(reqwest::Method::POST, &path, &query, Some(body), Some("v3"))
            .await
    }

    /// Delete Brand Voice
    ///
    /// Delete a brand voice by ID
    ///
    /// `DELETE /brand-boards/locations/{locationId}/brand-voices/{brandVoiceId}`
    pub async fn delete_brand_voice(
        &self,
        location_id: &str,
        brand_voice_id: &str,
    ) -> Result<models::DeleteBrandVoicePublicV1ResponseDto> {
        let path = format!(
            "/brand-boards/locations/{}/brand-voices/{}",
            crate::services::encode(location_id),
            crate::services::encode(brand_voice_id)
        );
        let query = Vec::new();
        self.client
            .send_versioned(
                reqwest::Method::DELETE,
                &path,
                &query,
                None::<&()>,
                Some("v3"),
            )
            .await
    }

    /// Get Brand Voice
    ///
    /// Get a brand voice by ID
    ///
    /// `GET /brand-boards/locations/{locationId}/brand-voices/{brandVoiceId}`
    pub async fn get_brand_voice(
        &self,
        location_id: &str,
        brand_voice_id: &str,
    ) -> Result<models::GetBrandVoicePublicV1ResponseDto> {
        let path = format!(
            "/brand-boards/locations/{}/brand-voices/{}",
            crate::services::encode(location_id),
            crate::services::encode(brand_voice_id)
        );
        let query = Vec::new();
        self.client
            .send_versioned(reqwest::Method::GET, &path, &query, None::<&()>, Some("v3"))
            .await
    }

    /// Update Brand Voice
    ///
    /// Update a brand voice by ID
    ///
    /// `PATCH /brand-boards/locations/{locationId}/brand-voices/{brandVoiceId}`
    pub async fn update_brand_voice(
        &self,
        location_id: &str,
        brand_voice_id: &str,
        body: &models::UpdateBrandVoicePublicV1BodyDto,
    ) -> Result<models::UpdateBrandVoicePublicV1ResponseDto> {
        let path = format!(
            "/brand-boards/locations/{}/brand-voices/{}",
            crate::services::encode(location_id),
            crate::services::encode(brand_voice_id)
        );
        let query = Vec::new();
        self.client
            .send_versioned(
                reqwest::Method::PATCH,
                &path,
                &query,
                Some(body),
                Some("v3"),
            )
            .await
    }

    /// Set Default Brand Voice
    ///
    /// Set a brand voice as the default for a location. The previous default will be unset.
    ///
    /// `POST /brand-boards/locations/{locationId}/brand-voices/{brandVoiceId}/default`
    pub async fn set_default_brand_voice(
        &self,
        location_id: &str,
        brand_voice_id: &str,
    ) -> Result<models::SetDefaultBrandVoicePublicV1ResponseDto> {
        let path = format!(
            "/brand-boards/locations/{}/brand-voices/{}/default",
            crate::services::encode(location_id),
            crate::services::encode(brand_voice_id)
        );
        let query = Vec::new();
        self.client
            .send_versioned(
                reqwest::Method::POST,
                &path,
                &query,
                None::<&()>,
                Some("v3"),
            )
            .await
    }

    /// Get Brand Boards
    ///
    /// Retrieves all Brand Boards for a specific location
    ///
    /// `GET /brand-boards/{locationId}`
    ///
    /// Requires scope: `brand-boards/design-kit.readonly`.
    pub async fn get_brand_boards(
        &self,
        location_id: &str,
        params: &GetBrandBoardsParams,
    ) -> Result<models::GetBrandBoardsByLocationSuccessDTO> {
        let path = format!("/brand-boards/{}", crate::services::encode(location_id));
        let query = params.to_query();
        self.client
            .send_versioned(reqwest::Method::GET, &path, &query, None::<&()>, Some("v3"))
            .await
    }

    /// Delete a Brand Board
    ///
    /// Deletes a Brand Board
    ///
    /// `DELETE /brand-boards/{locationId}/{id}`
    ///
    /// Requires scope: `brand-boards/design-kit.write`.
    pub async fn delete_a_brand_board(
        &self,
        location_id: &str,
        id: &str,
    ) -> Result<models::GetBrandBoardSuccessDTO> {
        let path = format!(
            "/brand-boards/{}/{}",
            crate::services::encode(location_id),
            crate::services::encode(id)
        );
        let query = Vec::new();
        self.client
            .send_versioned(
                reqwest::Method::DELETE,
                &path,
                &query,
                None::<&()>,
                Some("v3"),
            )
            .await
    }

    /// Get Brand Board
    ///
    /// Retrieves a specific Brand Board by its ID
    ///
    /// `GET /brand-boards/{locationId}/{id}`
    ///
    /// Requires scope: `brand-boards/design-kit.readonly`.
    pub async fn get_brand_board(
        &self,
        location_id: &str,
        id: &str,
    ) -> Result<models::GetBrandBoardSuccessDTO> {
        let path = format!(
            "/brand-boards/{}/{}",
            crate::services::encode(location_id),
            crate::services::encode(id)
        );
        let query = Vec::new();
        self.client
            .send_versioned(reqwest::Method::GET, &path, &query, None::<&()>, Some("v3"))
            .await
    }

    /// Update a Brand Board
    ///
    /// Updates an existing Brand Board
    ///
    /// `PATCH /brand-boards/{locationId}/{id}`
    ///
    /// Requires scope: `brand-boards/design-kit.write`.
    pub async fn update_a_brand_board(
        &self,
        location_id: &str,
        id: &str,
        body: &models::UpdateBrandBoardBody,
    ) -> Result<models::GetBrandBoardSuccessDTO> {
        let path = format!(
            "/brand-boards/{}/{}",
            crate::services::encode(location_id),
            crate::services::encode(id)
        );
        let query = Vec::new();
        self.client
            .send_versioned(
                reqwest::Method::PATCH,
                &path,
                &query,
                Some(body),
                Some("v3"),
            )
            .await
    }
}