square.rb 6.3.0.20200826 → 17.1.0.20220120

data/lib/square/api/inventory_api.rb

@@ -5,18 +5,58 @@ module Square
       super(config, http_call_back: http_call_back)
     end
 
-    # Returns the [InventoryAdjustment](#type-inventoryadjustment) object
+    # Deprecated version of
+    # [RetrieveInventoryAdjustment]($e/Inventory/RetrieveInventoryAdjustment)
+    # after the endpoint URL
+    # is updated to conform to the standard convention.
+    # @param [String] adjustment_id Required parameter: ID of the
+    # [InventoryAdjustment]($m/InventoryAdjustment) to retrieve.
+    # @return [RetrieveInventoryAdjustmentResponse Hash] response from the API call
+    def deprecated_retrieve_inventory_adjustment(adjustment_id:)
+      warn 'Endpoint deprecated_retrieve_inventory_adjustment in InventoryApi '\
+           'is deprecated'
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/inventory/adjustment/{adjustment_id}'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'adjustment_id' => { 'value' => adjustment_id, 'encode' => true }
+      )
+      _query_url = APIHelper.clean_url _query_builder
+
+      # Prepare headers.
+      _headers = {
+        'accept' => 'application/json'
+      }
+
+      # Prepare and execute HttpRequest.
+      _request = config.http_client.get(
+        _query_url,
+        headers: _headers
+      )
+      OAuth2.apply(config, _request)
+      _response = execute_request(_request)
+
+      # Return appropriate response type.
+      decoded = APIHelper.json_deserialize(_response.raw_body)
+      _errors = APIHelper.map_response(decoded, ['errors'])
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
+    end
+
+    # Returns the [InventoryAdjustment]($m/InventoryAdjustment) object
     # with the provided `adjustment_id`.
     # @param [String] adjustment_id Required parameter: ID of the
-    # [InventoryAdjustment](#type-inventoryadjustment) to retrieve.
+    # [InventoryAdjustment]($m/InventoryAdjustment) to retrieve.
     # @return [RetrieveInventoryAdjustmentResponse Hash] response from the API call
     def retrieve_inventory_adjustment(adjustment_id:)
       # Prepare query url.
       _query_builder = config.get_base_uri
-      _query_builder << '/v2/inventory/adjustment/{adjustment_id}'
+      _query_builder << '/v2/inventory/adjustments/{adjustment_id}'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'adjustment_id' => adjustment_id
+        'adjustment_id' => { 'value' => adjustment_id, 'encode' => true }
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -36,7 +76,126 @@ module Square
       # Return appropriate response type.
       decoded = APIHelper.json_deserialize(_response.raw_body)
       _errors = APIHelper.map_response(decoded, ['errors'])
-      ApiResponse.new(_response, data: decoded, errors: _errors)
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
+    end
+
+    # Deprecated version of
+    # [BatchChangeInventory]($e/Inventory/BatchChangeInventory) after the
+    # endpoint URL
+    # is updated to conform to the standard convention.
+    # @param [BatchChangeInventoryRequest] body Required parameter: An object
+    # containing the fields to POST for the request.  See the corresponding
+    # object definition for field details.
+    # @return [BatchChangeInventoryResponse Hash] response from the API call
+    def deprecated_batch_change_inventory(body:)
+      warn 'Endpoint deprecated_batch_change_inventory in InventoryApi is depr'\
+           'ecated'
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/inventory/batch-change'
+      _query_url = APIHelper.clean_url _query_builder
+
+      # Prepare headers.
+      _headers = {
+        'accept' => 'application/json',
+        'Content-Type' => 'application/json'
+      }
+
+      # Prepare and execute HttpRequest.
+      _request = config.http_client.post(
+        _query_url,
+        headers: _headers,
+        parameters: body.to_json
+      )
+      OAuth2.apply(config, _request)
+      _response = execute_request(_request)
+
+      # Return appropriate response type.
+      decoded = APIHelper.json_deserialize(_response.raw_body)
+      _errors = APIHelper.map_response(decoded, ['errors'])
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
+    end
+
+    # Deprecated version of
+    # [BatchRetrieveInventoryChanges]($e/Inventory/BatchRetrieveInventoryChanges
+    # ) after the endpoint URL
+    # is updated to conform to the standard convention.
+    # @param [BatchRetrieveInventoryChangesRequest] body Required parameter: An
+    # object containing the fields to POST for the request.  See the
+    # corresponding object definition for field details.
+    # @return [BatchRetrieveInventoryChangesResponse Hash] response from the API call
+    def deprecated_batch_retrieve_inventory_changes(body:)
+      warn 'Endpoint deprecated_batch_retrieve_inventory_changes in InventoryA'\
+           'pi is deprecated'
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/inventory/batch-retrieve-changes'
+      _query_url = APIHelper.clean_url _query_builder
+
+      # Prepare headers.
+      _headers = {
+        'accept' => 'application/json',
+        'Content-Type' => 'application/json'
+      }
+
+      # Prepare and execute HttpRequest.
+      _request = config.http_client.post(
+        _query_url,
+        headers: _headers,
+        parameters: body.to_json
+      )
+      OAuth2.apply(config, _request)
+      _response = execute_request(_request)
+
+      # Return appropriate response type.
+      decoded = APIHelper.json_deserialize(_response.raw_body)
+      _errors = APIHelper.map_response(decoded, ['errors'])
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
+    end
+
+    # Deprecated version of
+    # [BatchRetrieveInventoryCounts]($e/Inventory/BatchRetrieveInventoryCounts)
+    # after the endpoint URL
+    # is updated to conform to the standard convention.
+    # @param [BatchRetrieveInventoryCountsRequest] body Required parameter: An
+    # object containing the fields to POST for the request.  See the
+    # corresponding object definition for field details.
+    # @return [BatchRetrieveInventoryCountsResponse Hash] response from the API call
+    def deprecated_batch_retrieve_inventory_counts(body:)
+      warn 'Endpoint deprecated_batch_retrieve_inventory_counts in InventoryAp'\
+           'i is deprecated'
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/inventory/batch-retrieve-counts'
+      _query_url = APIHelper.clean_url _query_builder
+
+      # Prepare headers.
+      _headers = {
+        'accept' => 'application/json',
+        'Content-Type' => 'application/json'
+      }
+
+      # Prepare and execute HttpRequest.
+      _request = config.http_client.post(
+        _query_url,
+        headers: _headers,
+        parameters: body.to_json
+      )
+      OAuth2.apply(config, _request)
+      _response = execute_request(_request)
+
+      # Return appropriate response type.
+      decoded = APIHelper.json_deserialize(_response.raw_body)
+      _errors = APIHelper.map_response(decoded, ['errors'])
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
     end
 
     # Applies adjustments and counts to the provided item quantities.
@@ -50,13 +209,13 @@ module Square
     def batch_change_inventory(body:)
       # Prepare query url.
       _query_builder = config.get_base_uri
-      _query_builder << '/v2/inventory/batch-change'
+      _query_builder << '/v2/inventory/changes/batch-create'
       _query_url = APIHelper.clean_url _query_builder
 
       # Prepare headers.
       _headers = {
         'accept' => 'application/json',
-        'content-type' => 'application/json; charset=utf-8'
+        'Content-Type' => 'application/json'
       }
 
       # Prepare and execute HttpRequest.
@@ -71,7 +230,9 @@ module Square
       # Return appropriate response type.
       decoded = APIHelper.json_deserialize(_response.raw_body)
       _errors = APIHelper.map_response(decoded, ['errors'])
-      ApiResponse.new(_response, data: decoded, errors: _errors)
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
     end
 
     # Returns historical physical counts and adjustments based on the
@@ -87,13 +248,13 @@ module Square
     def batch_retrieve_inventory_changes(body:)
       # Prepare query url.
       _query_builder = config.get_base_uri
-      _query_builder << '/v2/inventory/batch-retrieve-changes'
+      _query_builder << '/v2/inventory/changes/batch-retrieve'
       _query_url = APIHelper.clean_url _query_builder
 
       # Prepare headers.
       _headers = {
         'accept' => 'application/json',
-        'content-type' => 'application/json; charset=utf-8'
+        'Content-Type' => 'application/json'
       }
 
       # Prepare and execute HttpRequest.
@@ -108,12 +269,14 @@ module Square
       # Return appropriate response type.
       decoded = APIHelper.json_deserialize(_response.raw_body)
       _errors = APIHelper.map_response(decoded, ['errors'])
-      ApiResponse.new(_response, data: decoded, errors: _errors)
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
     end
 
     # Returns current counts for the provided
-    # [CatalogObject](#type-catalogobject)s at the requested
-    # [Location](#type-location)s.
+    # [CatalogObject]($m/CatalogObject)s at the requested
+    # [Location]($m/Location)s.
     # Results are paginated and sorted in descending order according to their
     # `calculated_at` timestamp (newest first).
     # When `updated_after` is specified, only counts that have changed since
@@ -128,13 +291,13 @@ module Square
     def batch_retrieve_inventory_counts(body:)
       # Prepare query url.
       _query_builder = config.get_base_uri
-      _query_builder << '/v2/inventory/batch-retrieve-counts'
+      _query_builder << '/v2/inventory/counts/batch-retrieve'
       _query_url = APIHelper.clean_url _query_builder
 
       # Prepare headers.
       _headers = {
         'accept' => 'application/json',
-        'content-type' => 'application/json; charset=utf-8'
+        'Content-Type' => 'application/json'
       }
 
       # Prepare and execute HttpRequest.
@@ -149,21 +312,99 @@ module Square
       # Return appropriate response type.
       decoded = APIHelper.json_deserialize(_response.raw_body)
       _errors = APIHelper.map_response(decoded, ['errors'])
-      ApiResponse.new(_response, data: decoded, errors: _errors)
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
+    end
+
+    # Deprecated version of
+    # [RetrieveInventoryPhysicalCount]($e/Inventory/RetrieveInventoryPhysicalCou
+    # nt) after the endpoint URL
+    # is updated to conform to the standard convention.
+    # @param [String] physical_count_id Required parameter: ID of the
+    # [InventoryPhysicalCount]($m/InventoryPhysicalCount) to retrieve.
+    # @return [RetrieveInventoryPhysicalCountResponse Hash] response from the API call
+    def deprecated_retrieve_inventory_physical_count(physical_count_id:)
+      warn 'Endpoint deprecated_retrieve_inventory_physical_count in Inventory'\
+           'Api is deprecated'
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/inventory/physical-count/{physical_count_id}'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'physical_count_id' => { 'value' => physical_count_id, 'encode' => true }
+      )
+      _query_url = APIHelper.clean_url _query_builder
+
+      # Prepare headers.
+      _headers = {
+        'accept' => 'application/json'
+      }
+
+      # Prepare and execute HttpRequest.
+      _request = config.http_client.get(
+        _query_url,
+        headers: _headers
+      )
+      OAuth2.apply(config, _request)
+      _response = execute_request(_request)
+
+      # Return appropriate response type.
+      decoded = APIHelper.json_deserialize(_response.raw_body)
+      _errors = APIHelper.map_response(decoded, ['errors'])
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
     end
 
-    # Returns the [InventoryPhysicalCount](#type-inventoryphysicalcount)
+    # Returns the [InventoryPhysicalCount]($m/InventoryPhysicalCount)
     # object with the provided `physical_count_id`.
     # @param [String] physical_count_id Required parameter: ID of the
-    # [InventoryPhysicalCount](#type-inventoryphysicalcount) to retrieve.
+    # [InventoryPhysicalCount]($m/InventoryPhysicalCount) to retrieve.
     # @return [RetrieveInventoryPhysicalCountResponse Hash] response from the API call
     def retrieve_inventory_physical_count(physical_count_id:)
       # Prepare query url.
       _query_builder = config.get_base_uri
-      _query_builder << '/v2/inventory/physical-count/{physical_count_id}'
+      _query_builder << '/v2/inventory/physical-counts/{physical_count_id}'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'physical_count_id' => { 'value' => physical_count_id, 'encode' => true }
+      )
+      _query_url = APIHelper.clean_url _query_builder
+
+      # Prepare headers.
+      _headers = {
+        'accept' => 'application/json'
+      }
+
+      # Prepare and execute HttpRequest.
+      _request = config.http_client.get(
+        _query_url,
+        headers: _headers
+      )
+      OAuth2.apply(config, _request)
+      _response = execute_request(_request)
+
+      # Return appropriate response type.
+      decoded = APIHelper.json_deserialize(_response.raw_body)
+      _errors = APIHelper.map_response(decoded, ['errors'])
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
+    end
+
+    # Returns the [InventoryTransfer]($m/InventoryTransfer) object
+    # with the provided `transfer_id`.
+    # @param [String] transfer_id Required parameter: ID of the
+    # [InventoryTransfer]($m/InventoryTransfer) to retrieve.
+    # @return [RetrieveInventoryTransferResponse Hash] response from the API call
+    def retrieve_inventory_transfer(transfer_id:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/inventory/transfers/{transfer_id}'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'physical_count_id' => physical_count_id
+        'transfer_id' => { 'value' => transfer_id, 'encode' => true }
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -183,23 +424,25 @@ module Square
       # Return appropriate response type.
       decoded = APIHelper.json_deserialize(_response.raw_body)
       _errors = APIHelper.map_response(decoded, ['errors'])
-      ApiResponse.new(_response, data: decoded, errors: _errors)
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
     end
 
     # Retrieves the current calculated stock count for a given
-    # [CatalogObject](#type-catalogobject) at a given set of
-    # [Location](#type-location)s. Responses are paginated and unsorted.
+    # [CatalogObject]($m/CatalogObject) at a given set of
+    # [Location]($m/Location)s. Responses are paginated and unsorted.
     # For more sophisticated queries, use a batch endpoint.
     # @param [String] catalog_object_id Required parameter: ID of the
-    # [CatalogObject](#type-catalogobject) to retrieve.
+    # [CatalogObject]($m/CatalogObject) to retrieve.
     # @param [String] location_ids Optional parameter: The
-    # [Location](#type-location) IDs to look up as a comma-separated list. An
-    # empty list queries all locations.
+    # [Location]($m/Location) IDs to look up as a comma-separated list. An empty
+    # list queries all locations.
     # @param [String] cursor Optional parameter: A pagination cursor returned by
     # a previous call to this endpoint. Provide this to retrieve the next set of
     # results for the original query.  See the
-    # [Pagination](https://developer.squareup.com/docs/docs/working-with-apis/pa
-    # gination) guide for more information.
+    # [Pagination](https://developer.squareup.com/docs/working-with-apis/paginat
+    # ion) guide for more information.
     # @return [RetrieveInventoryCountResponse Hash] response from the API call
     def retrieve_inventory_count(catalog_object_id:,
                                  location_ids: nil,
@@ -209,7 +452,7 @@ module Square
       _query_builder << '/v2/inventory/{catalog_object_id}'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'catalog_object_id' => catalog_object_id
+        'catalog_object_id' => { 'value' => catalog_object_id, 'encode' => true }
       )
       _query_builder = APIHelper.append_url_with_query_parameters(
         _query_builder,
@@ -234,12 +477,19 @@ module Square
       # Return appropriate response type.
       decoded = APIHelper.json_deserialize(_response.raw_body)
       _errors = APIHelper.map_response(decoded, ['errors'])
-      ApiResponse.new(_response, data: decoded, errors: _errors)
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
     end
 
     # Returns a set of physical counts and inventory adjustments for the
-    # provided [CatalogObject](#type-catalogobject) at the requested
-    # [Location](#type-location)s.
+    # provided [CatalogObject]($m/CatalogObject) at the requested
+    # [Location]($m/Location)s.
+    # You can achieve the same result by calling
+    # [BatchRetrieveInventoryChanges]($e/Inventory/BatchRetrieveInventoryChanges
+    # )
+    # and having the `catalog_object_ids` list contain a single element of the
+    # `CatalogObject` ID.
     # Results are paginated and sorted in descending order according to their
     # `occurred_at` timestamp (newest first).
     # There are no limits on how far back the caller can page. This endpoint can
@@ -247,10 +497,10 @@ module Square
     # used to display recent changes for a specific item. For more
     # sophisticated queries, use a batch endpoint.
     # @param [String] catalog_object_id Required parameter: ID of the
-    # [CatalogObject](#type-catalogobject) to retrieve.
+    # [CatalogObject]($m/CatalogObject) to retrieve.
     # @param [String] location_ids Optional parameter: The
-    # [Location](#type-location) IDs to look up as a comma-separated list. An
-    # empty list queries all locations.
+    # [Location]($m/Location) IDs to look up as a comma-separated list. An empty
+    # list queries all locations.
     # @param [String] cursor Optional parameter: A pagination cursor returned by
     # a previous call to this endpoint. Provide this to retrieve the next set of
     # results for the original query.  See the
@@ -260,12 +510,13 @@ module Square
     def retrieve_inventory_changes(catalog_object_id:,
                                    location_ids: nil,
                                    cursor: nil)
+      warn 'Endpoint retrieve_inventory_changes in InventoryApi is deprecated'
       # Prepare query url.
       _query_builder = config.get_base_uri
       _query_builder << '/v2/inventory/{catalog_object_id}/changes'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'catalog_object_id' => catalog_object_id
+        'catalog_object_id' => { 'value' => catalog_object_id, 'encode' => true }
       )
       _query_builder = APIHelper.append_url_with_query_parameters(
         _query_builder,
@@ -290,7 +541,9 @@ module Square
       # Return appropriate response type.
       decoded = APIHelper.json_deserialize(_response.raw_body)
       _errors = APIHelper.map_response(decoded, ['errors'])
-      ApiResponse.new(_response, data: decoded, errors: _errors)
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
     end
   end
 end