square.rb 6.3.0.20200826 → 8.1.0.20210121

data/lib/square/api/devices_api.rb

@@ -16,10 +16,14 @@ module Square
     # @param [ProductType] product_type Optional parameter: If specified, only
     # returns DeviceCodes targeting the specified product type. Returns
     # DeviceCodes of all product types if empty.
+    # @param [DeviceCodeStatus] status Optional parameter: If specified, returns
+    # DeviceCodes with the specified statuses. Returns DeviceCodes of status
+    # `PAIRED` and `UNPAIRED` if empty.
     # @return [ListDeviceCodesResponse Hash] response from the API call
     def list_device_codes(cursor: nil,
                           location_id: nil,
-                          product_type: nil)
+                          product_type: nil,
+                          status: nil)
       # Prepare query url.
       _query_builder = config.get_base_uri
       _query_builder << '/v2/devices/codes'
@@ -27,7 +31,8 @@ module Square
         _query_builder,
         'cursor' => cursor,
         'location_id' => location_id,
-        'product_type' => product_type
+        'product_type' => product_type,
+        'status' => status
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -47,7 +52,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
 
     # Creates a DeviceCode that can be used to login to a Square Terminal device
@@ -81,7 +88,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
 
     # Retrieves DeviceCode with the associated ID.
@@ -94,7 +103,7 @@ module Square
       _query_builder << '/v2/devices/codes/{id}'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'id' => id
+        'id' => { 'value' => id, 'encode' => true }
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -114,7 +123,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

data/lib/square/api/disputes_api.rb

@@ -5,20 +5,19 @@ module Square
       super(config, http_call_back: http_call_back)
     end
 
-    # Returns a list of disputes associated
-    # with a particular account.
+    # Returns a list of disputes associated with a particular account.
     # @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. For more information, see
-    # [Paginating](https://developer.squareup.com/docs/basics/api101/pagination)
+    # a previous call to this endpoint. Provide this cursor to retrieve the next
+    # set of results for the original query. For more information, see
+    # [Pagination](https://developer.squareup.com/docs/basics/api101/pagination)
     # .
     # @param [DisputeState] states Optional parameter: The dispute states to
     # filter the result. If not specified, the endpoint returns all open
-    # disputes (dispute status is not `INQUIRY_CLOSED`, `WON`, or `LOST`).
+    # disputes (the dispute status is not `INQUIRY_CLOSED`, `WON`, or `LOST`).
     # @param [String] location_id Optional parameter: The ID of the location for
-    # which to return  a list of disputes. If not specified, the endpoint
-    # returns all open disputes (dispute status is not `INQUIRY_CLOSED`, `WON`,
-    # or  `LOST`) associated with all locations.
+    # which to return a list of disputes. If not specified, the endpoint returns
+    # all open disputes (the dispute status is not `INQUIRY_CLOSED`, `WON`, or
+    # `LOST`) associated with all locations.
     # @return [ListDisputesResponse Hash] response from the API call
     def list_disputes(cursor: nil,
                       states: nil,
@@ -50,10 +49,12 @@ 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 details of a specific dispute.
+    # Returns details about a specific dispute.
     # @param [String] dispute_id Required parameter: The ID of the dispute you
     # want more details about.
     # @return [RetrieveDisputeResponse Hash] response from the API call
@@ -63,7 +64,7 @@ module Square
       _query_builder << '/v2/disputes/{dispute_id}'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'dispute_id' => dispute_id
+        'dispute_id' => { 'value' => dispute_id, 'encode' => true }
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -83,20 +84,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
 
-    # Accepts loss on a dispute. Square returns
-    # the disputed amount to the cardholder and updates the
-    # dispute state to ACCEPTED.
-    # Square debits the disputed amount from the seller’s Square
-    # account. If the Square account balance does not have
-    # sufficient funds, Square debits the associated bank account.
-    # For an overview of the Disputes API, see
-    # [Overview](https://developer.squareup.com/docs/docs/disputes-api/overview)
-    # .
-    # @param [String] dispute_id Required parameter: ID of the dispute you want
-    # to accept.
+    # Accepts the loss on a dispute. Square returns the disputed amount to the
+    # cardholder and
+    # updates the dispute state to ACCEPTED.
+    # Square debits the disputed amount from the seller’s Square account. If the
+    # Square account
+    # does not have sufficient funds, Square debits the associated bank account.
+    # @param [String] dispute_id Required parameter: The ID of the dispute you
+    # want to accept.
     # @return [AcceptDisputeResponse Hash] response from the API call
     def accept_dispute(dispute_id:)
       # Prepare query url.
@@ -104,7 +104,7 @@ module Square
       _query_builder << '/v2/disputes/{dispute_id}/accept'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'dispute_id' => dispute_id
+        'dispute_id' => { 'value' => dispute_id, 'encode' => true }
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -124,7 +124,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 a list of evidence associated with a dispute.
@@ -136,7 +138,7 @@ module Square
       _query_builder << '/v2/disputes/{dispute_id}/evidence'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'dispute_id' => dispute_id
+        'dispute_id' => { 'value' => dispute_id, 'encode' => true }
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -156,12 +158,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
 
     # Removes specified evidence from a dispute.
-    # Square does not send the bank any evidence that
-    # is removed. Also, you cannot remove evidence after
+    # Square does not send the bank any evidence that is removed. Also, you
+    # cannot remove evidence after
     # submitting it to the bank using
     # [SubmitEvidence](https://developer.squareup.com/docs/reference/square/disp
     # utes-api/submit-evidence).
@@ -177,8 +181,8 @@ module Square
       _query_builder << '/v2/disputes/{dispute_id}/evidence/{evidence_id}'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'dispute_id' => dispute_id,
-        'evidence_id' => evidence_id
+        'dispute_id' => { 'value' => dispute_id, 'encode' => true },
+        'evidence_id' => { 'value' => evidence_id, 'encode' => true }
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -198,13 +202,15 @@ 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 the specific evidence metadata associated with a specific dispute.
     # You must maintain a copy of the evidence you upload if you want to
-    # reference it later. You cannot download the evidence
-    # after you upload it.
+    # reference it later. You cannot
+    # download the evidence after you upload it.
     # @param [String] dispute_id Required parameter: The ID of the dispute that
     # you want to retrieve evidence from.
     # @param [String] evidence_id Required parameter: The ID of the evidence to
@@ -217,8 +223,8 @@ module Square
       _query_builder << '/v2/disputes/{dispute_id}/evidence/{evidence_id}'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'dispute_id' => dispute_id,
-        'evidence_id' => evidence_id
+        'dispute_id' => { 'value' => dispute_id, 'encode' => true },
+        'evidence_id' => { 'value' => evidence_id, 'encode' => true }
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -238,20 +244,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
 
     # Uploads a file to use as evidence in a dispute challenge. The endpoint
-    # accepts
-    # HTTP multipart/form-data file uploads in HEIC, HEIF, JPEG, PDF, PNG,
-    # and TIFF formats.
-    # For more information, see [Challenge a
-    # Dispute](https://developer.squareup.com/docs/docs/disputes-api/process-dis
-    # putes#challenge-a-dispute).
-    # @param [String] dispute_id Required parameter: ID of the dispute you want
-    # to upload evidence for.
+    # accepts HTTP
+    # multipart/form-data file uploads in HEIC, HEIF, JPEG, PDF, PNG, and TIFF
+    # formats.
+    # @param [String] dispute_id Required parameter: The ID of the dispute you
+    # want to upload evidence for.
     # @param [CreateDisputeEvidenceFileRequest] request Optional parameter:
-    # Defines parameters for a CreateDisputeEvidenceFile request.
+    # Defines the parameters for a `CreateDisputeEvidenceFile` request.
     # @param [File | UploadIO] image_file Optional parameter: Example:
     # @return [CreateDisputeEvidenceFileResponse Hash] response from the API call
     def create_dispute_evidence_file(dispute_id:,
@@ -262,7 +267,7 @@ module Square
       _query_builder << '/v2/disputes/{dispute_id}/evidence_file'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'dispute_id' => dispute_id
+        'dispute_id' => { 'value' => dispute_id, 'encode' => true }
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -304,14 +309,12 @@ 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
 
-    # Uploads text to use as evidence for a dispute challenge. For more
-    # information, see
-    # [Challenge a
-    # Dispute](https://developer.squareup.com/docs/docs/disputes-api/process-dis
-    # putes#challenge-a-dispute).
+    # Uploads text to use as evidence for a dispute challenge.
     # @param [String] dispute_id Required parameter: The ID of the dispute you
     # want to upload evidence for.
     # @param [CreateDisputeEvidenceTextRequest] body Required parameter: An
@@ -325,7 +328,7 @@ module Square
       _query_builder << '/v2/disputes/{dispute_id}/evidence_text'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'dispute_id' => dispute_id
+        'dispute_id' => { 'value' => dispute_id, 'encode' => true }
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -347,24 +350,22 @@ 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
 
     # Submits evidence to the cardholder's bank.
     # Before submitting evidence, Square compiles all available evidence. This
-    # includes
-    # evidence uploaded using the
+    # includes evidence uploaded
+    # using the
     # [CreateDisputeEvidenceFile](https://developer.squareup.com/docs/reference/
     # square/disputes-api/create-dispute-evidence-file) and
     # [CreateDisputeEvidenceText](https://developer.squareup.com/docs/reference/
-    # square/disputes-api/create-dispute-evidence-text) endpoints,
-    # and evidence automatically provided by Square, when
-    # available. For more information, see
-    # [Challenge a
-    # Dispute](https://developer.squareup.com/docs/docs/disputes-api/process-dis
-    # putes#challenge-a-dispute).
-    # @param [String] dispute_id Required parameter: The ID of the dispute you
-    # want to submit evidence for.
+    # square/disputes-api/create-dispute-evidence-text) endpoints and
+    # evidence automatically provided by Square, when available.
+    # @param [String] dispute_id Required parameter: The ID of the dispute that
+    # you want to submit evidence for.
     # @return [SubmitEvidenceResponse Hash] response from the API call
     def submit_evidence(dispute_id:)
       # Prepare query url.
@@ -372,7 +373,7 @@ module Square
       _query_builder << '/v2/disputes/{dispute_id}/submit-evidence'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'dispute_id' => dispute_id
+        'dispute_id' => { 'value' => dispute_id, 'encode' => true }
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -392,7 +393,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

data/lib/square/api/employees_api.rb

@@ -47,7 +47,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
 
     # RetrieveEmployee
@@ -61,7 +63,7 @@ module Square
       _query_builder << '/v2/employees/{id}'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'id' => id
+        'id' => { 'value' => id, 'encode' => true }
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -81,7 +83,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

data/lib/square/api/inventory_api.rb

@@ -16,7 +16,7 @@ module Square
       _query_builder << '/v2/inventory/adjustment/{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 +36,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
 
     # Applies adjustments and counts to the provided item quantities.
@@ -71,7 +73,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
@@ -108,7 +112,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 current counts for the provided
@@ -149,7 +155,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 the [InventoryPhysicalCount](#type-inventoryphysicalcount)
@@ -163,7 +171,7 @@ module Square
       _query_builder << '/v2/inventory/physical-count/{physical_count_id}'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'physical_count_id' => physical_count_id
+        'physical_count_id' => { 'value' => physical_count_id, 'encode' => true }
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -183,7 +191,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
 
     # Retrieves the current calculated stock count for a given
@@ -198,8 +208,8 @@ module Square
     # @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 +219,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,7 +244,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 a set of physical counts and inventory adjustments for the
@@ -265,7 +277,7 @@ module Square
       _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 +302,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