squareup 2.13.0

//!The Inventory API exposes a set of objects to represent inventory adjustments
//! and physical counts for quantities of products (as item variations) and
//! transitions of stocked products to the relevant inventory state.
//!
//! these include the following key data types for the Inventory API:

//! InventoryCount - computed quantity of an item variation at a specific location.
//! InventoryAdjustment - quantity of an item variation transitioning from one state to another.
//! InventoryPhysicalCount - verified quantity of an item variation at a specific location.
//! SourceApplication - application that makes an inventory change and helps trace sources of inventory changes.

use crate::{
    SquareClient,
    config::Configuration,
    http::client::HttpClient,
    models::{
        BatchChangeInventoryRequest, BatchChangeInventoryResponse,
        BatchRetrieveInventoryChangesRequest, BatchRetrieveInventoryChangesResponse,
        BatchRetrieveInventoryCountsRequest, BatchRetrieveInventoryCountsResponse,
        RetrieveInventoryAdjustmentResponse, RetrieveInventoryCountParams,
        RetrieveInventoryCountResponse, RetrieveInventoryPhysicalCountResponse,
        RetrieveInventoryTransferResponse, errors::SquareApiError,
    },
};

const DEFAULT_URI: &str = "/inventory";

pub struct InventoryApi {
    /// App config information
    config: Configuration,
    /// HTTP Client for requests to the Inventory API endpoints
    http_client: HttpClient,
}

impl InventoryApi {
    /// Instantiates a new `InventoryApi`
    pub fn new(square_client: SquareClient) -> InventoryApi {
        InventoryApi {
            config: square_client.config,
            http_client: square_client.http_client,
        }
    }

    /// Returns the InventoryAdjustment object with the provided adjustment id.
    pub async fn retrieve_inventory_adjustment(
        &self,
        adjustment_id: impl AsRef<str>,
    ) -> Result<RetrieveInventoryAdjustmentResponse, SquareApiError> {
        let url = format!("{}/{}", &self.url(), adjustment_id.as_ref());
        let response = self.http_client.get(&url).await?;

        response.deserialize().await
    }

    /// Applies adjustments and counts to the provided item quantities.
    /// On success: returns the current calculated counts for all objects referenced in the request.
    /// On failure: returns a list of related errors.
    pub async fn batch_change_inventory(
        &self,
        body: &BatchChangeInventoryRequest,
    ) -> Result<BatchChangeInventoryResponse, SquareApiError> {
        let url = format!("{}/changes/batch-create", &self.url());
        let response = self.http_client.post(&url, body).await?;

        response.deserialize().await
    }

    /// Returns historical physical counts and adjustments based on the provided filter criteria.
    /// Results are paginated and sorted in ascending order according their occurred_at timestamp.
    pub async fn batch_retrieve_inventory_changes(
        &self,
        body: &BatchRetrieveInventoryChangesRequest,
    ) -> Result<BatchRetrieveInventoryChangesResponse, SquareApiError> {
        let url = format!("{}/changes/batch-retrieve", &self.url());
        let response = self.http_client.post(&url, body).await?;

        response.deserialize().await
    }

    /// Returns current counts for the provided CatalogObjects at the requested Locations.
    /// Results are paginated and sorted in descending order according to their calculated_at timestamp.
    pub async fn batch_retrieve_inventory_counts(
        &self,
        body: &BatchRetrieveInventoryCountsRequest,
    ) -> Result<BatchRetrieveInventoryCountsResponse, SquareApiError> {
        let url = format!("{}/counts/batch-retrieve", &self.url());
        let response = self.http_client.post(&url, body).await?;

        response.deserialize().await
    }

    /// Returns the InventoryPhysicalCount object with the provided physical_count_id.
    pub async fn retrieve_inventory_physical_count(
        &self,
        physical_count_id: impl AsRef<str>,
    ) -> Result<RetrieveInventoryPhysicalCountResponse, SquareApiError> {
        let url = format!(
            "{}/physical-counts/{}",
            &self.url(),
            physical_count_id.as_ref()
        );
        let response = self.http_client.get(&url).await?;

        response.deserialize().await
    }

    /// Returns the InventoryTransfer object with the provided transfer_id.
    pub async fn retrieve_inventory_transfer(
        &self,
        transfer_id: impl AsRef<str>,
    ) -> Result<RetrieveInventoryTransferResponse, SquareApiError> {
        let url = format!("{}/transfers/{}", &self.url(), transfer_id.as_ref());
        let response = self.http_client.get(&url).await?;

        response.deserialize().await
    }

    /// Retrieves the current calculated stock count for a given CatalogObject at a given set of Locations.
    pub async fn retrieve_inventory_count(
        &self,
        catalog_object_id: impl AsRef<str>,
        params: RetrieveInventoryCountParams,
    ) -> Result<RetrieveInventoryCountResponse, SquareApiError> {
        let url = format!(
            "{}/{}{}",
            &self.url(),
            catalog_object_id.as_ref(),
            params.to_query_string()
        );
        let response = self.http_client.get(&url).await?;

        response.deserialize().await
    }

    fn url(&self) -> String {
        format!("{}{}", &self.config.get_base_url(), DEFAULT_URI)
    }
}