ghl-sdk 0.5.2

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

#![allow(clippy::too_many_arguments)]

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

/// Typed access to the `funnels` API v3 surface (7 operations). Obtained via
/// [`Ghl::v3`](crate::Ghl::v3)`().funnels()`.
#[derive(Debug, Clone)]
pub struct FunnelsService {
    pub(crate) client: Ghl,
}

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

/// Query parameters for [`FunnelsService::fetch_list_of_funnels`].
#[derive(Debug, Clone, Default)]
pub struct FetchListOfFunnelsParams {
    /// `locationId` query parameter.
    /// Required by the API.
    pub location_id: String,
    /// `type` query parameter.
    pub type_: Option<String>,
    /// `category` query parameter.
    pub category: Option<String>,
    /// `offset` query parameter.
    pub offset: Option<String>,
    /// `limit` query parameter.
    pub limit: Option<String>,
    /// `parentId` query parameter.
    pub parent_id: Option<String>,
    /// `name` query parameter.
    pub name: Option<String>,
}

impl FetchListOfFunnelsParams {
    /// Start from the parameters the API requires.
    pub fn new(location_id: impl Into<String>) -> Self {
        Self {
            location_id: location_id.into(),
            ..Default::default()
        }
    }

    /// Set the `type` query parameter.
    pub fn type_(mut self, v: impl Into<String>) -> Self {
        self.type_ = Some(v.into());
        self
    }

    /// Set the `category` query parameter.
    pub fn category(mut self, v: impl Into<String>) -> Self {
        self.category = Some(v.into());
        self
    }

    /// Set the `offset` query parameter.
    pub fn offset(mut self, v: impl Into<String>) -> Self {
        self.offset = Some(v.into());
        self
    }

    /// Set the `limit` query parameter.
    pub fn limit(mut self, v: impl Into<String>) -> Self {
        self.limit = Some(v.into());
        self
    }

    /// Set the `parentId` query parameter.
    pub fn parent_id(mut self, v: impl Into<String>) -> Self {
        self.parent_id = Some(v.into());
        self
    }

    /// Set the `name` query parameter.
    pub fn name(mut self, v: impl Into<String>) -> Self {
        self.name = Some(v.into());
        self
    }

    fn to_query(&self) -> Vec<(String, String)> {
        let mut q: Vec<(String, String)> = vec![("locationId".into(), self.location_id.clone())];
        if let Some(v) = &self.type_ {
            q.push(("type".into(), v.to_string()));
        }
        if let Some(v) = &self.category {
            q.push(("category".into(), v.to_string()));
        }
        if let Some(v) = &self.offset {
            q.push(("offset".into(), v.to_string()));
        }
        if let Some(v) = &self.limit {
            q.push(("limit".into(), v.to_string()));
        }
        if let Some(v) = &self.parent_id {
            q.push(("parentId".into(), v.to_string()));
        }
        if let Some(v) = &self.name {
            q.push(("name".into(), v.to_string()));
        }
        q
    }
}

/// Query parameters for [`FunnelsService::fetch_list_of_redirects`].
#[derive(Debug, Clone, Default)]
pub struct FetchListOfRedirectsParams {
    /// `locationId` query parameter.
    /// Required by the API.
    pub location_id: String,
    /// `limit` query parameter.
    /// Required by the API.
    pub limit: f64,
    /// `offset` query parameter.
    /// Required by the API.
    pub offset: f64,
    /// `search` query parameter.
    pub search: Option<String>,
}

impl FetchListOfRedirectsParams {
    /// Start from the parameters the API requires.
    pub fn new(location_id: impl Into<String>, limit: f64, offset: f64) -> Self {
        Self {
            location_id: location_id.into(),
            limit,
            offset,
            ..Default::default()
        }
    }

    /// Set the `search` query parameter.
    pub fn search(mut self, v: impl Into<String>) -> Self {
        self.search = Some(v.into());
        self
    }

    fn to_query(&self) -> Vec<(String, String)> {
        let mut q: Vec<(String, String)> = vec![
            ("locationId".into(), self.location_id.clone()),
            ("limit".into(), self.limit.to_string()),
            ("offset".into(), self.offset.to_string()),
        ];
        if let Some(v) = &self.search {
            q.push(("search".into(), v.to_string()));
        }
        q
    }
}

/// Query parameters for [`FunnelsService::delete_redirect_by_id`].
#[derive(Debug, Clone, Default)]
pub struct DeleteRedirectByIdParams {
    /// `locationId` query parameter.
    /// Required by the API.
    pub location_id: String,
}

impl DeleteRedirectByIdParams {
    /// Start from the parameters the API requires.
    pub fn new(location_id: impl Into<String>) -> Self {
        Self {
            location_id: location_id.into(),
        }
    }

    fn to_query(&self) -> Vec<(String, String)> {
        let q: Vec<(String, String)> = vec![("locationId".into(), self.location_id.clone())];
        q
    }
}

/// Query parameters for [`FunnelsService::fetch_list_of_funnel_pages`].
#[derive(Debug, Clone, Default)]
pub struct FetchListOfFunnelPagesParams {
    /// `locationId` query parameter.
    /// Required by the API.
    pub location_id: String,
    /// `funnelId` query parameter.
    /// Required by the API.
    pub funnel_id: String,
    /// `name` query parameter.
    pub name: Option<String>,
    /// `limit` query parameter.
    /// Required by the API.
    pub limit: f64,
    /// `offset` query parameter.
    /// Required by the API.
    pub offset: f64,
}

impl FetchListOfFunnelPagesParams {
    /// Start from the parameters the API requires.
    pub fn new(
        location_id: impl Into<String>,
        funnel_id: impl Into<String>,
        limit: f64,
        offset: f64,
    ) -> Self {
        Self {
            location_id: location_id.into(),
            funnel_id: funnel_id.into(),
            limit,
            offset,
            ..Default::default()
        }
    }

    /// Set the `name` query parameter.
    pub fn name(mut self, v: impl Into<String>) -> Self {
        self.name = Some(v.into());
        self
    }

    fn to_query(&self) -> Vec<(String, String)> {
        let mut q: Vec<(String, String)> = vec![
            ("locationId".into(), self.location_id.clone()),
            ("funnelId".into(), self.funnel_id.clone()),
            ("limit".into(), self.limit.to_string()),
            ("offset".into(), self.offset.to_string()),
        ];
        if let Some(v) = &self.name {
            q.push(("name".into(), v.to_string()));
        }
        q
    }
}

/// Query parameters for [`FunnelsService::fetch_count_of_funnel_pages`].
#[derive(Debug, Clone, Default)]
pub struct FetchCountOfFunnelPagesParams {
    /// `locationId` query parameter.
    /// Required by the API.
    pub location_id: String,
    /// `funnelId` query parameter.
    /// Required by the API.
    pub funnel_id: String,
    /// `name` query parameter.
    pub name: Option<String>,
}

impl FetchCountOfFunnelPagesParams {
    /// Start from the parameters the API requires.
    pub fn new(location_id: impl Into<String>, funnel_id: impl Into<String>) -> Self {
        Self {
            location_id: location_id.into(),
            funnel_id: funnel_id.into(),
            ..Default::default()
        }
    }

    /// Set the `name` query parameter.
    pub fn name(mut self, v: impl Into<String>) -> Self {
        self.name = Some(v.into());
        self
    }

    fn to_query(&self) -> Vec<(String, String)> {
        let mut q: Vec<(String, String)> = vec![
            ("locationId".into(), self.location_id.clone()),
            ("funnelId".into(), self.funnel_id.clone()),
        ];
        if let Some(v) = &self.name {
            q.push(("name".into(), v.to_string()));
        }
        q
    }
}

impl FunnelsService {
    /// Fetch List of Funnels
    ///
    /// Retrieves a list of all funnels based on the given query parameters.
    ///
    /// `GET /funnels/funnel/list`
    pub async fn fetch_list_of_funnels(
        &self,
        params: &FetchListOfFunnelsParams,
    ) -> Result<models::FunnelListResponseDTO> {
        let query = params.to_query();
        self.client
            .send_versioned(
                reqwest::Method::GET,
                "/funnels/funnel/list",
                &query,
                None::<&()>,
                Some("v3"),
            )
            .await
    }

    /// Create Redirect
    ///
    /// The "Create Redirect" API Allows adding a new url redirect to the system. Use this
    /// endpoint to create a url redirect with the specified details. Ensure that the
    /// required information is provided in the request payload.
    ///
    /// `POST /funnels/lookup/redirect`
    ///
    /// Requires scope: `funnels/redirect.write`.
    pub async fn create_redirect(
        &self,
        body: &models::CreateRedirectParams,
    ) -> Result<models::CreateRedirectResponseDTO> {
        let query = Vec::new();
        self.client
            .send_versioned(
                reqwest::Method::POST,
                "/funnels/lookup/redirect",
                &query,
                Some(body),
                Some("v3"),
            )
            .await
    }

    /// Fetch List of Redirects
    ///
    /// Retrieves a list of all URL redirects based on the given query parameters.
    ///
    /// `GET /funnels/lookup/redirect/list`
    ///
    /// Requires scope: `funnels/redirect.readonly`.
    pub async fn fetch_list_of_redirects(
        &self,
        params: &FetchListOfRedirectsParams,
    ) -> Result<models::RedirectListResponseDTO> {
        let query = params.to_query();
        self.client
            .send_versioned(
                reqwest::Method::GET,
                "/funnels/lookup/redirect/list",
                &query,
                None::<&()>,
                Some("v3"),
            )
            .await
    }

    /// Delete Redirect By Id
    ///
    /// The "Delete Redirect By Id" API Allows deletion of a URL redirect from the system
    /// using its unique identifier. Use this endpoint to delete a URL redirect with the
    /// specified ID using details provided in the request payload.
    ///
    /// `DELETE /funnels/lookup/redirect/{id}`
    ///
    /// Requires scope: `funnels/redirect.write`.
    pub async fn delete_redirect_by_id(
        &self,
        id: &str,
        params: &DeleteRedirectByIdParams,
    ) -> Result<models::DeleteRedirectResponseDTO> {
        let path = format!("/funnels/lookup/redirect/{}", crate::services::encode(id));
        let query = params.to_query();
        self.client
            .send_versioned(
                reqwest::Method::DELETE,
                &path,
                &query,
                None::<&()>,
                Some("v3"),
            )
            .await
    }

    /// Update Redirect By Id
    ///
    /// The "Update Redirect By Id" API Allows updating an existing URL redirect in the
    /// system. Use this endpoint to modify a URL redirect with the specified ID using
    /// details provided in the request payload.
    ///
    /// `PATCH /funnels/lookup/redirect/{id}`
    ///
    /// Requires scope: `funnels/redirect.write`.
    pub async fn update_redirect_by_id(
        &self,
        id: &str,
        body: &models::UpdateRedirectParams,
    ) -> Result<models::UpdateRedirectResponseDTO> {
        let path = format!("/funnels/lookup/redirect/{}", crate::services::encode(id));
        let query = Vec::new();
        self.client
            .send_versioned(
                reqwest::Method::PATCH,
                &path,
                &query,
                Some(body),
                Some("v3"),
            )
            .await
    }

    /// Fetch list of funnel pages
    ///
    /// Retrieves a list of all funnel pages based on the given query parameters.
    ///
    /// `GET /funnels/page`
    pub async fn fetch_list_of_funnel_pages(
        &self,
        params: &FetchListOfFunnelPagesParams,
    ) -> Result<models::FunnelPageResponseDTO> {
        let query = params.to_query();
        self.client
            .send_versioned(
                reqwest::Method::GET,
                "/funnels/page",
                &query,
                None::<&()>,
                Some("v3"),
            )
            .await
    }

    /// Fetch count of funnel pages
    ///
    /// Retrieves count of all funnel pages based on the given query parameters.
    ///
    /// `GET /funnels/page/count`
    pub async fn fetch_count_of_funnel_pages(
        &self,
        params: &FetchCountOfFunnelPagesParams,
    ) -> Result<models::FunnelPageCountResponseDTO> {
        let query = params.to_query();
        self.client
            .send_versioned(
                reqwest::Method::GET,
                "/funnels/page/count",
                &query,
                None::<&()>,
                Some("v3"),
            )
            .await
    }
}