square.rb 10.0.0.202104217 → 13.1.0.20210818

data/lib/square/api/inventory_api.rb

@@ -5,6 +5,46 @@ module Square
       super(config, http_call_back: http_call_back)
     end
 
+    # 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
@@ -13,7 +53,7 @@ module Square
     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' => { 'value' => adjustment_id, 'encode' => true }
@@ -41,6 +81,123 @@ module Square
       )
     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; charset=utf-8'
+      }
+
+      # 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; charset=utf-8'
+      }
+
+      # 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; charset=utf-8'
+      }
+
+      # 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.
     # On success: returns the current calculated counts for all objects
     # referenced in the request.
@@ -52,7 +209,7 @@ 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.
@@ -91,7 +248,7 @@ 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.
@@ -134,7 +291,7 @@ 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.
@@ -160,6 +317,46 @@ module Square
       )
     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]($m/InventoryPhysicalCount)
     # object with the provided `physical_count_id`.
     # @param [String] physical_count_id Required parameter: ID of the
@@ -168,7 +365,7 @@ module Square
     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 }
@@ -196,6 +393,42 @@ module Square
       )
     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,
+        'transfer_id' => { 'value' => transfer_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
+
     # Retrieves the current calculated stock count for a given
     # [CatalogObject]($m/CatalogObject) at a given set of
     # [Location]($m/Location)s. Responses are paginated and unsorted.
@@ -252,6 +485,11 @@ module Square
     # Returns a set of physical counts and inventory adjustments for the
     # 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
@@ -272,6 +510,7 @@ 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'

data/lib/square/api/labor_api.rb

@@ -6,13 +6,14 @@ module Square
     end
 
     # Returns a paginated list of `BreakType` instances for a business.
-    # @param [String] location_id Optional parameter: Filter Break Types
-    # returned to only those that are associated with the specified location.
-    # @param [Integer] limit Optional parameter: Maximum number of Break Types
-    # to return per page. Can range between 1 and 200. The default is the
-    # maximum at 200.
-    # @param [String] cursor Optional parameter: Pointer to the next page of
-    # Break Type results to fetch.
+    # @param [String] location_id Optional parameter: Filter the returned
+    # `BreakType` results to only those that are associated with the specified
+    # location.
+    # @param [Integer] limit Optional parameter: The maximum number of
+    # `BreakType` results to return per page. The number can range between 1 and
+    # 200. The default is 200.
+    # @param [String] cursor Optional parameter: A pointer to the next page of
+    # `BreakType` results to fetch.
     # @return [ListBreakTypesResponse Hash] response from the API call
     def list_break_types(location_id: nil,
                          limit: nil,
@@ -57,8 +58,8 @@ module Square
     # - `break_name`
     # - `expected_duration`
     # - `is_paid`
-    # You can only have 3 `BreakType` instances per location. If you attempt to
-    # add a 4th
+    # You can only have three `BreakType` instances per location. If you attempt
+    # to add a fourth
     # `BreakType` for a location, an `INVALID_REQUEST_ERROR` "Exceeded limit of
     # 3 breaks per location."
     # is returned.
@@ -97,7 +98,7 @@ module Square
 
     # Deletes an existing `BreakType`.
     # A `BreakType` can be deleted even if it is referenced from a `Shift`.
-    # @param [String] id Required parameter: UUID for the `BreakType` being
+    # @param [String] id Required parameter: The UUID for the `BreakType` being
     # deleted.
     # @return [DeleteBreakTypeResponse Hash] response from the API call
     def delete_break_type(id:)
@@ -131,8 +132,8 @@ module Square
       )
     end
 
-    # Returns a single `BreakType` specified by id.
-    # @param [String] id Required parameter: UUID for the `BreakType` being
+    # Returns a single `BreakType` specified by `id`.
+    # @param [String] id Required parameter: The UUID for the `BreakType` being
     # retrieved.
     # @return [GetBreakTypeResponse Hash] response from the API call
     def get_break_type(id:)
@@ -167,7 +168,7 @@ module Square
     end
 
     # Updates an existing `BreakType`.
-    # @param [String] id Required parameter: UUID for the `BreakType` being
+    # @param [String] id Required parameter: The UUID for the `BreakType` being
     # updated.
     # @param [UpdateBreakTypeRequest] body Required parameter: An object
     # containing the fields to POST for the request.  See the corresponding
@@ -208,13 +209,13 @@ module Square
     end
 
     # Returns a paginated list of `EmployeeWage` instances for a business.
-    # @param [String] employee_id Optional parameter: Filter wages returned to
-    # only those that are associated with the specified employee.
-    # @param [Integer] limit Optional parameter: Maximum number of Employee
-    # Wages to return per page. Can range between 1 and 200. The default is the
-    # maximum at 200.
-    # @param [String] cursor Optional parameter: Pointer to the next page of
-    # Employee Wage results to fetch.
+    # @param [String] employee_id Optional parameter: Filter the returned wages
+    # to only those that are associated with the specified employee.
+    # @param [Integer] limit Optional parameter: The maximum number of
+    # `EmployeeWage` results to return per page. The number can range between 1
+    # and 200. The default is 200.
+    # @param [String] cursor Optional parameter: A pointer to the next page of
+    # `EmployeeWage` results to fetch.
     # @return [ListEmployeeWagesResponse Hash] response from the API call
     def list_employee_wages(employee_id: nil,
                             limit: nil,
@@ -252,9 +253,9 @@ module Square
       )
     end
 
-    # Returns a single `EmployeeWage` specified by id.
-    # @param [String] id Required parameter: UUID for the `EmployeeWage` being
-    # retrieved.
+    # Returns a single `EmployeeWage` specified by `id`.
+    # @param [String] id Required parameter: The UUID for the `EmployeeWage`
+    # being retrieved.
     # @return [GetEmployeeWageResponse Hash] response from the API call
     def get_employee_wage(id:)
       warn 'Endpoint get_employee_wage in LaborApi is deprecated'
@@ -289,7 +290,7 @@ module Square
     end
 
     # Creates a new `Shift`.
-    # A `Shift` represents a complete work day for a single employee.
+    # A `Shift` represents a complete workday for a single employee.
     # You must provide the following values in your request to this
     # endpoint:
     # - `location_id`
@@ -299,12 +300,12 @@ module Square
     # when:
     # - The `status` of the new `Shift` is `OPEN` and the employee has another
     # shift with an `OPEN` status.
-    # - The `start_at` date is in the future
-    # - the `start_at` or `end_at` overlaps another shift for the same employee
-    # - If `Break`s are set in the request, a break `start_at`
-    # must not be before the `Shift.start_at`. A break `end_at` must not be
-    # after
-    # the `Shift.end_at`
+    # - The `start_at` date is in the future.
+    # - The `start_at` or `end_at` date overlaps another shift for the same
+    # employee.
+    # - The `Break` instances are set in the request and a break `start_at`
+    # is before the `Shift.start_at`, a break `end_at` is after
+    # the `Shift.end_at`, or both.
     # @param [CreateShiftRequest] body Required parameter: An object containing
     # the fields to POST for the request.  See the corresponding object
     # definition for field details.
@@ -340,17 +341,17 @@ module Square
 
     # Returns a paginated list of `Shift` records for a business.
     # The list to be returned can be filtered by:
-    # - Location IDs **and**
-    # - employee IDs **and**
-    # - shift status (`OPEN`, `CLOSED`) **and**
-    # - shift start **and**
-    # - shift end **and**
-    # - work day details
+    # - Location IDs.
+    # - Employee IDs.
+    # - Shift status (`OPEN` and `CLOSED`).
+    # - Shift start.
+    # - Shift end.
+    # - Workday details.
     # The list can be sorted by:
-    # - `start_at`
-    # - `end_at`
-    # - `created_at`
-    # - `updated_at`
+    # - `start_at`.
+    # - `end_at`.
+    # - `created_at`.
+    # - `updated_at`.
     # @param [SearchShiftsRequest] body Required parameter: An object containing
     # the fields to POST for the request.  See the corresponding object
     # definition for field details.
@@ -385,7 +386,7 @@ module Square
     end
 
     # Deletes a `Shift`.
-    # @param [String] id Required parameter: UUID for the `Shift` being
+    # @param [String] id Required parameter: The UUID for the `Shift` being
     # deleted.
     # @return [DeleteShiftResponse Hash] response from the API call
     def delete_shift(id:)
@@ -419,8 +420,8 @@ module Square
       )
     end
 
-    # Returns a single `Shift` specified by id.
-    # @param [String] id Required parameter: UUID for the `Shift` being
+    # Returns a single `Shift` specified by `id`.
+    # @param [String] id Required parameter: The UUID for the `Shift` being
     # retrieved.
     # @return [GetShiftResponse Hash] response from the API call
     def get_shift(id:)
@@ -455,13 +456,14 @@ module Square
     end
 
     # Updates an existing `Shift`.
-    # When adding a `Break` to a `Shift`, any earlier `Breaks` in the `Shift`
-    # have
+    # When adding a `Break` to a `Shift`, any earlier `Break` instances in the
+    # `Shift` have
     # the `end_at` property set to a valid RFC-3339 datetime string.
-    # When closing a `Shift`, all `Break` instances in the shift must be
+    # When closing a `Shift`, all `Break` instances in the `Shift` must be
     # complete with `end_at`
     # set on each `Break`.
-    # @param [String] id Required parameter: ID of the object being updated.
+    # @param [String] id Required parameter: The ID of the object being
+    # updated.
     # @param [UpdateShiftRequest] body Required parameter: An object containing
     # the fields to POST for the request.  See the corresponding object
     # definition for field details.
@@ -501,13 +503,13 @@ module Square
     end
 
     # Returns a paginated list of `TeamMemberWage` instances for a business.
-    # @param [String] team_member_id Optional parameter: Filter wages returned
-    # to only those that are associated with the specified team member.
-    # @param [Integer] limit Optional parameter: Maximum number of Team Member
-    # Wages to return per page. Can range between 1 and 200. The default is the
-    # maximum at 200.
-    # @param [String] cursor Optional parameter: Pointer to the next page of
-    # Employee Wage results to fetch.
+    # @param [String] team_member_id Optional parameter: Filter the returned
+    # wages to only those that are associated with the specified team member.
+    # @param [Integer] limit Optional parameter: The maximum number of
+    # `TeamMemberWage` results to return per page. The number can range between
+    # 1 and 200. The default is 200.
+    # @param [String] cursor Optional parameter: A pointer to the next page of
+    # `EmployeeWage` results to fetch.
     # @return [ListTeamMemberWagesResponse Hash] response from the API call
     def list_team_member_wages(team_member_id: nil,
                                limit: nil,
@@ -544,9 +546,9 @@ module Square
       )
     end
 
-    # Returns a single `TeamMemberWage` specified by id.
-    # @param [String] id Required parameter: UUID for the `TeamMemberWage` being
-    # retrieved.
+    # Returns a single `TeamMemberWage` specified by `id `.
+    # @param [String] id Required parameter: The UUID for the `TeamMemberWage`
+    # being retrieved.
     # @return [GetTeamMemberWageResponse Hash] response from the API call
     def get_team_member_wage(id:)
       # Prepare query url.
@@ -580,10 +582,10 @@ module Square
     end
 
     # Returns a list of `WorkweekConfig` instances for a business.
-    # @param [Integer] limit Optional parameter: Maximum number of Workweek
-    # Configs to return per page.
-    # @param [String] cursor Optional parameter: Pointer to the next page of
-    # Workweek Config results to fetch.
+    # @param [Integer] limit Optional parameter: The maximum number of
+    # `WorkweekConfigs` results to return per page.
+    # @param [String] cursor Optional parameter: A pointer to the next page of
+    # `WorkweekConfig` results to fetch.
     # @return [ListWorkweekConfigsResponse Hash] response from the API call
     def list_workweek_configs(limit: nil,
                               cursor: nil)
@@ -619,7 +621,7 @@ module Square
     end
 
     # Updates a `WorkweekConfig`.
-    # @param [String] id Required parameter: UUID for the `WorkweekConfig`
+    # @param [String] id Required parameter: The UUID for the `WorkweekConfig`
     # object being updated.
     # @param [UpdateWorkweekConfigRequest] body Required parameter: An object
     # containing the fields to POST for the request.  See the corresponding