sendgrid-api 0.3.1

A fully generated & opinionated API client for the SendGrid API.
Documentation
use anyhow::Result;

use crate::Client;

pub struct ContactsApiCustomFields {
    pub client: Client,
}

impl ContactsApiCustomFields {
    #[doc(hidden)]
    pub fn new(client: Client) -> Self {
        ContactsApiCustomFields { client }
    }

    /**
     * Retrieve all custom fields.
     *
     * This function performs a `GET` to the `/contactdb/custom_fields` endpoint.
     *
     * **This endpoint allows you to retrieve all custom fields.**
     *
     * **Parameters:**
     *
     * * `on_behalf_of: &str` -- The license key provided with your New Relic account.
     */
    pub async fn get_contactdb_custom_fields(
        &self,
    ) -> Result<crate::types::ListAllCustomFieldsResponse> {
        let url = "/contactdb/custom_fields".to_string();
        self.client.get(&url, None).await
    }

    /**
     * Create a Custom Field.
     *
     * This function performs a `POST` to the `/contactdb/custom_fields` endpoint.
     *
     * **This endpoint allows you to create a custom field.**
     *
     * **You can create up to 120 custom fields.**
     *
     * **Parameters:**
     *
     * * `on_behalf_of: &str` -- The license key provided with your New Relic account.
     */
    pub async fn post_contactdb_custom_field(
        &self,
        body: &crate::types::PostContactdbCustomFieldsRequest,
    ) -> Result<crate::types::ContactdbCustomFieldWithAllOf> {
        let url = "/contactdb/custom_fields".to_string();
        self.client
            .post(&url, Some(reqwest::Body::from(serde_json::to_vec(body)?)))
            .await
    }

    /**
     * Retrieve a Custom Field.
     *
     * This function performs a `GET` to the `/contactdb/custom_fields/{custom_field_id}` endpoint.
     *
     * **This endpoint allows you to retrieve a custom field by ID.**
     *
     * **Parameters:**
     *
     * * `on_behalf_of: &str` -- The license key provided with your New Relic account.
     */
    pub async fn get_contactdb_custom_fields_field(
        &self,
        custom_field_id: i64,
    ) -> Result<crate::types::ContactdbCustomFieldWithAllOf> {
        let url = format!(
            "/contactdb/custom_fields/{}",
            crate::progenitor_support::encode_path(&custom_field_id.to_string()),
        );

        self.client.get(&url, None).await
    }

    /**
     * Delete a Custom Field.
     *
     * This function performs a `DELETE` to the `/contactdb/custom_fields/{custom_field_id}` endpoint.
     *
     * **This endpoint allows you to delete a custom field by ID.**
     *
     * **Parameters:**
     *
     * * `on_behalf_of: &str` -- The license key provided with your New Relic account.
     */
    pub async fn delete_contactdb_custom_fields_field(
        &self,
        custom_field_id: i64,
    ) -> Result<crate::types::GlobalErrorResponseSchema> {
        let url = format!(
            "/contactdb/custom_fields/{}",
            crate::progenitor_support::encode_path(&custom_field_id.to_string()),
        );

        self.client.delete(&url, None).await
    }

    /**
     * Retrieve reserved fields.
     *
     * This function performs a `GET` to the `/contactdb/reserved_fields` endpoint.
     *
     * **This endpoint allows you to list all fields that are reserved and can't be used for custom field names.**
     *
     * **Parameters:**
     *
     * * `on_behalf_of: &str` -- The license key provided with your New Relic account.
     */
    pub async fn get_contactdb_reserved_fields(
        &self,
    ) -> Result<crate::types::GetContactdbReservedFieldsResponse> {
        let url = "/contactdb/reserved_fields".to_string();
        self.client.get(&url, None).await
    }
}