ghl-sdk 0.5.1

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

#![allow(clippy::too_many_arguments)]

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

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

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

/// Query parameters for
/// [`AssociationsService::get_all_associations_for_a_sub_account_location`].
#[derive(Debug, Clone, Default)]
pub struct GetAllAssociationsForASubAccountLocationParams {
    /// `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,
}

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

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

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

impl GetAssociationKeyByKeyNameParams {
    /// 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 [`AssociationsService::get_association_by_object_keys`].
#[derive(Debug, Clone, Default)]
pub struct GetAssociationByObjectKeysParams {
    /// `locationId` query parameter.
    pub location_id: Option<String>,
}

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

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

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

/// Query parameters for [`AssociationsService::get_all_relations_by_record_id`].
#[derive(Debug, Clone, Default)]
pub struct GetAllRelationsByRecordIdParams {
    /// Your Sub Account's ID
    /// 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,
    /// Association Ids
    pub association_ids: Option<String>,
}

impl GetAllRelationsByRecordIdParams {
    /// 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()
        }
    }

    /// Association Ids
    pub fn association_ids(mut self, v: impl Into<String>) -> Self {
        self.association_ids = 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.association_ids {
            q.push(("associationIds".into(), v.to_string()));
        }
        q
    }
}

/// Query parameters for [`AssociationsService::delete_relation`].
#[derive(Debug, Clone, Default)]
pub struct DeleteRelationParams {
    /// Your Sub Account's ID
    /// Required by the API.
    pub location_id: String,
}

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

impl AssociationsService {
    /// Get all associations for a sub-account / location
    ///
    /// Get all Associations
    ///
    /// `GET /associations/`
    ///
    /// Requires scope: `associations.readonly`.
    pub async fn get_all_associations_for_a_sub_account_location(
        &self,
        params: &GetAllAssociationsForASubAccountLocationParams,
    ) -> Result<models::GetPostSuccessfulResponseDto> {
        let query = params.to_query();
        self.client
            .send_versioned(
                reqwest::Method::GET,
                "/associations/",
                &query,
                None::<&()>,
                Some("2021-07-28"),
            )
            .await
    }

    /// Create Association
    ///
    /// Allow you to create contact - contact , contact - custom objects associations, will
    /// add more in the future.Documentation Link -
    /// <https://doc.clickup.com/8631005/d/h/87cpx-293776/cd0f4122abc04d3>
    ///
    /// `POST /associations/`
    ///
    /// Requires scope: `associations.write`.
    pub async fn create_association(
        &self,
        body: &models::CreateAssociationReqDto,
    ) -> Result<models::GetPostSuccessfulResponseDto> {
        let query = Vec::new();
        self.client
            .send_versioned(
                reqwest::Method::POST,
                "/associations/",
                &query,
                Some(body),
                Some("2021-07-28"),
            )
            .await
    }

    /// Get association key by key name
    ///
    /// Using this api you can get standard / user defined association by key
    ///
    /// `GET /associations/key/{key_name}`
    ///
    /// Requires scope: `associations.readonly`.
    pub async fn get_association_key_by_key_name(
        &self,
        key_name: &str,
        params: &GetAssociationKeyByKeyNameParams,
    ) -> Result<models::GetPostSuccessfulResponseDto> {
        let path = format!("/associations/key/{}", crate::services::encode(key_name));
        let query = params.to_query();
        self.client
            .send_versioned(
                reqwest::Method::GET,
                &path,
                &query,
                None::<&()>,
                Some("2021-07-28"),
            )
            .await
    }

    /// Get association by object keys
    ///
    /// Get association by object keys like contacts, custom objects and opportunities.
    /// Documentation Link -
    /// <https://doc.clickup.com/8631005/d/h/87cpx-293776/cd0f4122abc04d3>
    ///
    /// `GET /associations/objectKey/{objectKey}`
    ///
    /// Requires scope: `associations.readonly`.
    pub async fn get_association_by_object_keys(
        &self,
        object_key: &str,
        params: &GetAssociationByObjectKeysParams,
    ) -> Result<models::GetPostSuccessfulResponseDto> {
        let path = format!(
            "/associations/objectKey/{}",
            crate::services::encode(object_key)
        );
        let query = params.to_query();
        self.client
            .send_versioned(
                reqwest::Method::GET,
                &path,
                &query,
                None::<&()>,
                Some("2021-07-28"),
            )
            .await
    }

    /// Create Relation for you associated entities.
    ///
    /// Create Relation.Documentation Link -
    /// <https://doc.clickup.com/8631005/d/h/87cpx-293776/cd0f4122abc04d3>
    ///
    /// `POST /associations/relations`
    ///
    /// Requires scope: `associations/relation.write`.
    pub async fn create_relation_for_you_associated_entities(
        &self,
        body: &models::CreateRelationReqDto,
    ) -> Result<models::GetPostSuccessfulResponseDto> {
        let query = Vec::new();
        self.client
            .send_versioned(
                reqwest::Method::POST,
                "/associations/relations",
                &query,
                Some(body),
                Some("2021-07-28"),
            )
            .await
    }

    /// Get all relations By record Id
    ///
    /// Get all relations by record Id
    ///
    /// `GET /associations/relations/{recordId}`
    ///
    /// Requires scope: `associations/relation.readonly`.
    pub async fn get_all_relations_by_record_id(
        &self,
        record_id: &str,
        params: &GetAllRelationsByRecordIdParams,
    ) -> Result<models::GetPostSuccessfulResponseDto> {
        let path = format!(
            "/associations/relations/{}",
            crate::services::encode(record_id)
        );
        let query = params.to_query();
        self.client
            .send_versioned(
                reqwest::Method::GET,
                &path,
                &query,
                None::<&()>,
                Some("2021-07-28"),
            )
            .await
    }

    /// Delete Relation
    ///
    /// `DELETE /associations/relations/{relationId}`
    ///
    /// Requires scope: `associations/relation.write`.
    pub async fn delete_relation(
        &self,
        relation_id: &str,
        params: &DeleteRelationParams,
    ) -> Result<models::GetPostSuccessfulResponseDto> {
        let path = format!(
            "/associations/relations/{}",
            crate::services::encode(relation_id)
        );
        let query = params.to_query();
        self.client
            .send_versioned(
                reqwest::Method::DELETE,
                &path,
                &query,
                None::<&()>,
                Some("2021-07-28"),
            )
            .await
    }

    /// Delete Association
    ///
    /// Delete USER_DEFINED Association By Id, deleting an association will also all the
    /// relations for that association
    ///
    /// `DELETE /associations/{associationId}`
    ///
    /// Requires scope: `associations.write`.
    pub async fn delete_association(
        &self,
        association_id: &str,
    ) -> Result<models::DeleteAssociationsResponseDTO> {
        let path = format!("/associations/{}", crate::services::encode(association_id));
        let query = Vec::new();
        self.client
            .send_versioned(
                reqwest::Method::DELETE,
                &path,
                &query,
                None::<&()>,
                Some("2021-07-28"),
            )
            .await
    }

    /// Get association by ID
    ///
    /// Using this api you can get SYSTEM_DEFINED / USER_DEFINED association by id
    ///
    /// `GET /associations/{associationId}`
    ///
    /// Requires scope: `associations.readonly`.
    pub async fn get_association_by_id(
        &self,
        association_id: &str,
    ) -> Result<models::GetPostSuccessfulResponseDto> {
        let path = format!("/associations/{}", crate::services::encode(association_id));
        let query = Vec::new();
        self.client
            .send_versioned(
                reqwest::Method::GET,
                &path,
                &query,
                None::<&()>,
                Some("2021-07-28"),
            )
            .await
    }

    /// Update Association By Id
    ///
    /// Update Association , Allows you to update labels of an associations. Documentation
    /// Link - <https://doc.clickup.com/8631005/d/h/87cpx-293776/cd0f4122abc04d3>
    ///
    /// `PUT /associations/{associationId}`
    ///
    /// Requires scope: `associations.write`.
    pub async fn update_association_by_id(
        &self,
        association_id: &str,
        body: &models::UpdateAssociationReqDto,
    ) -> Result<models::GetPostSuccessfulResponseDto> {
        let path = format!("/associations/{}", crate::services::encode(association_id));
        let query = Vec::new();
        self.client
            .send_versioned(
                reqwest::Method::PUT,
                &path,
                &query,
                Some(body),
                Some("2021-07-28"),
            )
            .await
    }
}