ghl-sdk 0.5.2

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

#![allow(clippy::too_many_arguments)]

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

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

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

/// Query parameters for [`BlogsService::get_all_authors`].
#[derive(Debug, Clone, Default)]
pub struct GetAllAuthorsParams {
    /// Location Id
    /// Required by the API.
    pub location_id: String,
    /// Number of authors to show in the listing
    /// Required by the API.
    pub limit: f64,
    /// Number of authors to skip in listing
    /// Required by the API.
    pub offset: f64,
}

impl GetAllAuthorsParams {
    /// 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,
        }
    }

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

/// Query parameters for [`BlogsService::get_all_categories`].
#[derive(Debug, Clone, Default)]
pub struct GetAllCategoriesParams {
    /// `locationId` query parameter.
    /// Required by the API.
    pub location_id: String,
    /// Number of categories to show in the listing
    /// Required by the API.
    pub limit: f64,
    /// Number of categories to skip in listing
    /// Required by the API.
    pub offset: f64,
}

impl GetAllCategoriesParams {
    /// 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,
        }
    }

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

/// Query parameters for [`BlogsService::get_blog_posts_by_blog_id`].
#[derive(Debug, Clone, Default)]
pub struct GetBlogPostsByBlogIdParams {
    /// `locationId` query parameter.
    /// Required by the API.
    pub location_id: String,
    /// `blogId` query parameter.
    /// Required by the API.
    pub blog_id: String,
    /// `limit` query parameter.
    /// Required by the API.
    pub limit: f64,
    /// `offset` query parameter.
    /// Required by the API.
    pub offset: f64,
    /// search for any post by name
    pub search_term: Option<String>,
    /// `status` query parameter.
    /// Allowed values: `ALL`, `PUBLISHED`, `SCHEDULED`, `ARCHIVED`, `DRAFT`.
    pub status: Option<String>,
}

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

    /// search for any post by name
    pub fn search_term(mut self, v: impl Into<String>) -> Self {
        self.search_term = Some(v.into());
        self
    }

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

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

/// Query parameters for [`BlogsService::check_url_slug`].
#[derive(Debug, Clone, Default)]
pub struct CheckUrlSlugParams {
    /// `urlSlug` query parameter.
    /// Required by the API.
    pub url_slug: String,
    /// `locationId` query parameter.
    /// Required by the API.
    pub location_id: String,
    /// `postId` query parameter.
    pub post_id: Option<String>,
}

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

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

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

/// Query parameters for [`BlogsService::get_blogs_by_location_id`].
#[derive(Debug, Clone, Default)]
pub struct GetBlogsByLocationIdParams {
    /// `locationId` query parameter.
    /// Required by the API.
    pub location_id: String,
    /// `skip` query parameter.
    /// Required by the API.
    pub skip: f64,
    /// `limit` query parameter.
    /// Required by the API.
    pub limit: f64,
    /// search for any post by name
    pub search_term: Option<String>,
}

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

    /// search for any post by name
    pub fn search_term(mut self, v: impl Into<String>) -> Self {
        self.search_term = Some(v.into());
        self
    }

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

impl BlogsService {
    /// Get all authors
    ///
    /// The "Get all authors" Api return the blog authors for a given location ID. Please
    /// use "blogs/author.readonly"
    ///
    /// `GET /blogs/authors`
    ///
    /// Requires scope: `blogs/author.readonly`.
    pub async fn get_all_authors(
        &self,
        params: &GetAllAuthorsParams,
    ) -> Result<models::AuthorsResponseDTO> {
        let query = params.to_query();
        self.client
            .send_versioned(
                reqwest::Method::GET,
                "/blogs/authors",
                &query,
                None::<&()>,
                Some("v3"),
            )
            .await
    }

    /// Get all categories
    ///
    /// The "Get all categories" Api return the blog categoies for a given location ID.
    /// Please use "blogs/category.readonly"
    ///
    /// `GET /blogs/categories`
    ///
    /// Requires scope: `blogs/category.readonly`.
    pub async fn get_all_categories(
        &self,
        params: &GetAllCategoriesParams,
    ) -> Result<models::CategoriesResponseDTO> {
        let query = params.to_query();
        self.client
            .send_versioned(
                reqwest::Method::GET,
                "/blogs/categories",
                &query,
                None::<&()>,
                Some("v3"),
            )
            .await
    }

    /// Create Blog Post
    ///
    /// The "Create Blog Post" API allows you create blog post for any given blog site.
    /// Please use blogs/post.write
    ///
    /// `POST /blogs/posts`
    ///
    /// Requires scope: `blogs/post.write`.
    pub async fn create_blog_post(
        &self,
        body: &models::CreateBlogPostParams,
    ) -> Result<models::BlogPostCreateResponseWrapperDTO> {
        let query = Vec::new();
        self.client
            .send_versioned(
                reqwest::Method::POST,
                "/blogs/posts",
                &query,
                Some(body),
                Some("v3"),
            )
            .await
    }

    /// Get Blog posts by Blog ID
    ///
    /// The "Get Blog posts by Blog ID" API allows you get blog posts for any given blog
    /// site using blog ID.Please use blogs/posts.readonly
    ///
    /// `GET /blogs/posts/all`
    ///
    /// Requires scope: `blogs/posts.readonly`.
    pub async fn get_blog_posts_by_blog_id(
        &self,
        params: &GetBlogPostsByBlogIdParams,
    ) -> Result<models::BlogPostGetResponseWrapperDTO> {
        let query = params.to_query();
        self.client
            .send_versioned(
                reqwest::Method::GET,
                "/blogs/posts/all",
                &query,
                None::<&()>,
                Some("v3"),
            )
            .await
    }

    /// Check url slug
    ///
    /// The "Check url slug" API allows check the blog slug validation which is needed
    /// before publishing any blog post. Please use blogs/check-slug.readonly. you can find
    /// the POST ID from the post edit url.
    ///
    /// `GET /blogs/posts/url-slug-exists`
    ///
    /// Requires scope: `blogs/check-slug.readonly`.
    pub async fn check_url_slug(
        &self,
        params: &CheckUrlSlugParams,
    ) -> Result<models::UrlSlugCheckResponseDTO> {
        let query = params.to_query();
        self.client
            .send_versioned(
                reqwest::Method::GET,
                "/blogs/posts/url-slug-exists",
                &query,
                None::<&()>,
                Some("v3"),
            )
            .await
    }

    /// Update Blog Post
    ///
    /// The "Update Blog Post" API allows you update blog post for any given blog site.
    /// Please use blogs/post-update.write
    ///
    /// `PUT /blogs/posts/{postId}`
    ///
    /// Requires scope: `blogs/post-update.write`.
    pub async fn update_blog_post(
        &self,
        post_id: &str,
        body: &models::UpdateBlogPostParams,
    ) -> Result<models::BlogPostUpdateResponseWrapperDTO> {
        let path = format!("/blogs/posts/{}", crate::services::encode(post_id));
        let query = Vec::new();
        self.client
            .send_versioned(reqwest::Method::PUT, &path, &query, Some(body), Some("v3"))
            .await
    }

    /// Get Blogs by Location ID
    ///
    /// The "Get Blogs by Location ID" API allows you get blogs using Location ID.Please use
    /// blogs/list.readonly
    ///
    /// `GET /blogs/site/all`
    ///
    /// Requires scope: `blogs/list.readonly`.
    pub async fn get_blogs_by_location_id(
        &self,
        params: &GetBlogsByLocationIdParams,
    ) -> Result<models::BlogGetResponseWrapperDTO> {
        let query = params.to_query();
        self.client
            .send_versioned(
                reqwest::Method::GET,
                "/blogs/site/all",
                &query,
                None::<&()>,
                Some("v3"),
            )
            .await
    }
}