1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128

//!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.
//!
//! hese 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::{
    config::Configuration,
    http::client::HttpClient,
    models::{
        errors::ApiError, BatchChangeInventoryRequest, BatchChangeInventoryResponse,
        BatchRetrieveInventoryChangesRequest, BatchRetrieveInventoryChangesResponse,
        BatchRetrieveInventoryCountsRequest, BatchRetrieveInventoryCountsResponse,
        RetrieveInventoryAdjustmentResponse, RetrieveInventoryCountParams,
        RetrieveInventoryCountResponse, RetrieveInventoryPhysicalCount,
        RetrieveInventoryTransferResponse,
    },
};

const DEFAULT_URI: &str = "/inventory";

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

impl InventoryApi {
    pub fn new(config: Configuration, client: HttpClient) -> Self {
        Self { config, client }
    }
    /// 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: &str,
        params: RetrieveInventoryCountParams,
    ) -> Result<RetrieveInventoryCountResponse, ApiError> {
        let url = format!(
            "{}/{}{}",
            &self.url(),
            catalog_object_id,
            params.to_query_string()
        );
        let response = self.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: &str,
    ) -> Result<RetrieveInventoryTransferResponse, ApiError> {
        let url = format!("{}/{}", &self.url(), transfer_id);
        let response = self.client.get(&url).await?;

        response.deserialize().await
    }

    /// Returns the InventoryAdjustment object with the provided adjustment id.
    pub async fn retrieve_inventory_adjustment(
        &self,
        adjustment_id: &str,
    ) -> Result<RetrieveInventoryAdjustmentResponse, ApiError> {
        let url = format!("{}/{}", &self.url(), adjustment_id);
        let response = self.client.get(&url).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: &str,
    ) -> Result<RetrieveInventoryPhysicalCount, ApiError> {
        let url = format!("{}/{}", &self.url(), physical_count_id);
        let response = self.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(
        &self,
        body: &BatchChangeInventoryRequest,
    ) -> Result<BatchChangeInventoryResponse, ApiError> {
        let url = format!("{}/changes/batch-create", &self.url());
        let response = self.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_count(
        &self,
        body: &BatchRetrieveInventoryCountsRequest,
    ) -> Result<BatchRetrieveInventoryCountsResponse, ApiError> {
        let url = format!("{}/counts/batch-retrieve", &self.url());
        let response = self.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_changes(
        &self,
        body: &BatchRetrieveInventoryChangesRequest,
    ) -> Result<BatchRetrieveInventoryChangesResponse, ApiError> {
        let url = format!("{}/changes/batch-retrieve", &self.url());
        let response = self.client.post(&url, body).await?;

        response.deserialize().await
    }

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