sendgrid-api 0.3.1

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

use crate::Client;

pub struct IpWarmup {
    pub client: Client,
}

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

    /**
     * Retrieve all IPs currently in warmup.
     *
     * This function performs a `GET` to the `/ips/warmup` endpoint.
     *
     * **This endpoint allows you to retrieve all of your IP addresses that are currently warming up.**
     */
    pub async fn get_ips_warmup(&self) -> Result<Vec<crate::types::IpWarmupResponse>> {
        let url = "/ips/warmup".to_string();
        self.client.get(&url, None).await
    }

    /**
     * Retrieve all IPs currently in warmup.
     *
     * This function performs a `GET` to the `/ips/warmup` endpoint.
     *
     * As opposed to `get_ips_warmup`, this function returns all the pages of the request at once.
     *
     * **This endpoint allows you to retrieve all of your IP addresses that are currently warming up.**
     */
    pub async fn get_all_ips_warmup(&self) -> Result<Vec<crate::types::IpWarmupResponse>> {
        let url = "/ips/warmup".to_string();
        self.client.get_all_pages(&url, None).await
    }

    /**
     * Start warming up an IP address.
     *
     * This function performs a `POST` to the `/ips/warmup` endpoint.
     *
     * **This endpoint allows you to put an IP address into warmup mode.**
     */
    pub async fn post_ips_warmup(
        &self,
        body: &crate::types::PostIpsWarmupRequest,
    ) -> Result<Vec<crate::types::IpWarmupResponse>> {
        let url = "/ips/warmup".to_string();
        self.client
            .post(&url, Some(reqwest::Body::from(serde_json::to_vec(body)?)))
            .await
    }

    /**
     * Retrieve the warmup status for a specific IP address.
     *
     * This function performs a `GET` to the `/ips/warmup/{ip_address}` endpoint.
     *
     * **This endpoint allows you to retrieve the warmup status for a specific IP address.**
     *
     * You can retrieve all of your warming IPs using the "Retrieve all IPs currently in warmup" endpoint.
     */
    pub async fn get_ips_warmup_ip_address(
        &self,
        ip_address: &str,
    ) -> Result<Vec<crate::types::IpWarmupResponse>> {
        let url = format!(
            "/ips/warmup/{}",
            crate::progenitor_support::encode_path(ip_address),
        );

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

    /**
     * Retrieve the warmup status for a specific IP address.
     *
     * This function performs a `GET` to the `/ips/warmup/{ip_address}` endpoint.
     *
     * As opposed to `get_ips_warmup_ip_address`, this function returns all the pages of the request at once.
     *
     * **This endpoint allows you to retrieve the warmup status for a specific IP address.**
     *
     * You can retrieve all of your warming IPs using the "Retrieve all IPs currently in warmup" endpoint.
     */
    pub async fn get_all_ips_warmup_ip_address(
        &self,
        ip_address: &str,
    ) -> Result<Vec<crate::types::IpWarmupResponse>> {
        let url = format!(
            "/ips/warmup/{}",
            crate::progenitor_support::encode_path(ip_address),
        );

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

    /**
     * Stop warming up an IP address.
     *
     * This function performs a `DELETE` to the `/ips/warmup/{ip_address}` endpoint.
     *
     * **This endpoint allows you to remove an IP address from warmup mode.**
     *
     * Your request will return a 204 status code if the specified IP was successfully removed from warmup mode. To retrieve details of the IP’s warmup status *before* removing it from warmup mode, call the  "Retrieve the warmpup status for a specific IP address" endpoint.
     */
    pub async fn delete_ips_warmup_ip_address(
        &self,
        ip_address: &str,
    ) -> Result<crate::types::Help> {
        let url = format!(
            "/ips/warmup/{}",
            crate::progenitor_support::encode_path(ip_address),
        );

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