ghl-sdk 0.5.1

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

#![allow(clippy::too_many_arguments)]

use crate::client::Ghl;
use crate::error::Result;
use ghl_models::v2::emails as models;

/// Typed access to the `emails` API v2 surface (5 operations). Obtained via
/// [`Ghl::emails`](crate::Ghl::emails).
#[derive(Debug, Clone)]
pub struct EmailsService {
    pub(crate) client: Ghl,
}

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

/// Query parameters for [`EmailsService::fetch_email_templates`].
#[derive(Debug, Clone, Default)]
pub struct FetchEmailTemplatesParams {
    /// `locationId` query parameter.
    /// Required by the API.
    pub location_id: String,
    /// `limit` query parameter.
    pub limit: Option<String>,
    /// `offset` query parameter.
    pub offset: Option<String>,
    /// `search` query parameter.
    pub search: Option<String>,
    /// `sortByDate` query parameter.
    pub sort_by_date: Option<String>,
    /// `archived` query parameter.
    pub archived: Option<String>,
    /// `builderVersion` query parameter.
    /// Allowed values: `1`, `2`.
    pub builder_version: Option<String>,
    /// `name` query parameter.
    pub name: Option<String>,
    /// `parentId` query parameter.
    pub parent_id: Option<String>,
    /// `originId` query parameter.
    pub origin_id: Option<String>,
    /// `templatesOnly` query parameter.
    pub templates_only: Option<String>,
}

impl FetchEmailTemplatesParams {
    /// 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 `limit` query parameter.
    pub fn limit(mut self, v: impl Into<String>) -> Self {
        self.limit = 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 `search` query parameter.
    pub fn search(mut self, v: impl Into<String>) -> Self {
        self.search = Some(v.into());
        self
    }

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

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

    /// Set the `builderVersion` query parameter.
    pub fn builder_version(mut self, v: impl Into<String>) -> Self {
        self.builder_version = 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
    }

    /// 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 `originId` query parameter.
    pub fn origin_id(mut self, v: impl Into<String>) -> Self {
        self.origin_id = Some(v.into());
        self
    }

    /// Set the `templatesOnly` query parameter.
    pub fn templates_only(mut self, v: impl Into<String>) -> Self {
        self.templates_only = 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.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.sort_by_date {
            q.push(("sortByDate".into(), v.to_string()));
        }
        if let Some(v) = &self.archived {
            q.push(("archived".into(), v.to_string()));
        }
        if let Some(v) = &self.builder_version {
            q.push(("builderVersion".into(), v.to_string()));
        }
        if let Some(v) = &self.name {
            q.push(("name".into(), v.to_string()));
        }
        if let Some(v) = &self.parent_id {
            q.push(("parentId".into(), v.to_string()));
        }
        if let Some(v) = &self.origin_id {
            q.push(("originId".into(), v.to_string()));
        }
        if let Some(v) = &self.templates_only {
            q.push(("templatesOnly".into(), v.to_string()));
        }
        q
    }
}

/// Query parameters for [`EmailsService::get_campaigns`].
#[derive(Debug, Clone, Default)]
pub struct GetCampaignsParams {
    /// Location ID to fetch campaigns from
    /// Required by the API.
    pub location_id: String,
    /// Maximum number of campaigns to return. Defaults to 10, maximum is 100
    pub limit: Option<f64>,
    /// Number of campaigns to skip for pagination
    pub offset: Option<f64>,
    /// Filter by schedule status
    /// Allowed values: `active`, `pause`, `complete`, `cancelled`, `retry`, `draft`,
    /// `resend-scheduled`.
    pub status: Option<String>,
    /// Filter by email delivery status
    /// Allowed values: `all`, `not-started`, `paused`, `cancelled`, `processing`,
    /// `resumed`, `next-drip`, `complete`, `success`, `error`.
    pub email_status: Option<String>,
    /// Filter campaigns by name
    pub name: Option<String>,
    /// Filter campaigns by parent folder ID
    pub parent_id: Option<String>,
    /// When true, returns only essential campaign fields like id, templateDataDownloadUrl,
    /// updatedAt, type, templateType, templateId, downloadUrl and isPlainText. When false,
    /// returns complete campaign data including meta information, bulkRequestStatusInfo,
    /// ABTestInfo, resendScheduleInfo and all other campaign properties
    pub limited_fields: Option<bool>,
    /// Filter archived campaigns
    pub archived: Option<bool>,
    /// Return only campaigns, excluding folders
    pub campaigns_only: Option<bool>,
    /// When true, returns campaign statistics including delivered count, opened count,
    /// clicked count and revenue if available for the campaign. When false, returns
    /// campaign data without statistics.
    pub show_stats: Option<bool>,
}

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

    /// Maximum number of campaigns to return. Defaults to 10, maximum is 100
    pub fn limit(mut self, v: f64) -> Self {
        self.limit = Some(v);
        self
    }

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

    /// Filter by schedule status
    pub fn status(mut self, v: impl Into<String>) -> Self {
        self.status = Some(v.into());
        self
    }

    /// Filter by email delivery status
    pub fn email_status(mut self, v: impl Into<String>) -> Self {
        self.email_status = Some(v.into());
        self
    }

    /// Filter campaigns by name
    pub fn name(mut self, v: impl Into<String>) -> Self {
        self.name = Some(v.into());
        self
    }

    /// Filter campaigns by parent folder ID
    pub fn parent_id(mut self, v: impl Into<String>) -> Self {
        self.parent_id = Some(v.into());
        self
    }

    /// When true, returns only essential campaign fields like id, templateDataDownloadUrl,
    /// updatedAt, type, templateType, templateId, downloadUrl and isPlainText. When false,
    /// returns complete campaign data including meta information, bulkRequestStatusInfo,
    /// ABTestInfo, resendScheduleInfo and all other campaign properties
    pub fn limited_fields(mut self, v: bool) -> Self {
        self.limited_fields = Some(v);
        self
    }

    /// Filter archived campaigns
    pub fn archived(mut self, v: bool) -> Self {
        self.archived = Some(v);
        self
    }

    /// Return only campaigns, excluding folders
    pub fn campaigns_only(mut self, v: bool) -> Self {
        self.campaigns_only = Some(v);
        self
    }

    /// When true, returns campaign statistics including delivered count, opened count,
    /// clicked count and revenue if available for the campaign. When false, returns
    /// campaign data without statistics.
    pub fn show_stats(mut self, v: bool) -> Self {
        self.show_stats = Some(v);
        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.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.status {
            q.push(("status".into(), v.to_string()));
        }
        if let Some(v) = &self.email_status {
            q.push(("emailStatus".into(), v.to_string()));
        }
        if let Some(v) = &self.name {
            q.push(("name".into(), v.to_string()));
        }
        if let Some(v) = &self.parent_id {
            q.push(("parentId".into(), v.to_string()));
        }
        if let Some(v) = &self.limited_fields {
            q.push(("limitedFields".into(), v.to_string()));
        }
        if let Some(v) = &self.archived {
            q.push(("archived".into(), v.to_string()));
        }
        if let Some(v) = &self.campaigns_only {
            q.push(("campaignsOnly".into(), v.to_string()));
        }
        if let Some(v) = &self.show_stats {
            q.push(("showStats".into(), v.to_string()));
        }
        q
    }
}

impl EmailsService {
    /// Fetch email templates
    ///
    /// Fetch email templates by location id
    ///
    /// `GET /emails/builder`
    ///
    /// Requires scope: `emails/builder.readonly`.
    pub async fn fetch_email_templates(
        &self,
        params: &FetchEmailTemplatesParams,
    ) -> Result<models::FetchBuilderSuccesfulResponseDto> {
        let query = params.to_query();
        self.client
            .send_versioned(
                reqwest::Method::GET,
                "/emails/builder",
                &query,
                None::<&()>,
                Some("2021-07-28"),
            )
            .await
    }

    /// Create a new template
    ///
    /// `POST /emails/builder`
    ///
    /// Requires scope: `emails/builder.write`.
    pub async fn create_a_new_template(
        &self,
        body: &models::CreateBuilderDto,
    ) -> Result<models::CreateBuilderSuccesfulResponseDto> {
        let query = Vec::new();
        self.client
            .send_versioned(
                reqwest::Method::POST,
                "/emails/builder",
                &query,
                Some(body),
                Some("2021-07-28"),
            )
            .await
    }

    /// Update a template
    ///
    /// `POST /emails/builder/data`
    ///
    /// Requires scope: `emails/builder.write`.
    pub async fn update_a_template(
        &self,
        body: &models::SaveBuilderDataDto,
    ) -> Result<models::BuilderUpdateSuccessfulDTO> {
        let query = Vec::new();
        self.client
            .send_versioned(
                reqwest::Method::POST,
                "/emails/builder/data",
                &query,
                Some(body),
                Some("2021-07-28"),
            )
            .await
    }

    /// Delete a template
    ///
    /// `DELETE /emails/builder/{locationId}/{templateId}`
    pub async fn delete_a_template(
        &self,
        location_id: &str,
        template_id: &str,
    ) -> Result<models::DeleteBuilderSuccesfulResponseDto> {
        let path = format!(
            "/emails/builder/{}/{}",
            crate::services::encode(location_id),
            crate::services::encode(template_id)
        );
        let query = Vec::new();
        self.client
            .send_versioned(
                reqwest::Method::DELETE,
                &path,
                &query,
                None::<&()>,
                Some("2021-07-28"),
            )
            .await
    }

    /// Get Campaigns
    ///
    /// `GET /emails/schedule`
    ///
    /// Requires scope: `emails/schedule.readonly`.
    pub async fn get_campaigns(
        &self,
        params: &GetCampaignsParams,
    ) -> Result<models::ScheduleFetchSuccessfulDTO> {
        let query = params.to_query();
        self.client
            .send_versioned(
                reqwest::Method::GET,
                "/emails/schedule",
                &query,
                None::<&()>,
                Some("2021-07-28"),
            )
            .await
    }
}