square.rb 6.1.0.20200722 → 7.0.0.20201118

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

@@ -50,7 +50,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 details of a specific dispute.
@@ -63,7 +65,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,7 +85,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
 
     # Accepts loss on a dispute. Square returns
@@ -92,9 +96,6 @@ module Square
     # 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.
     # @return [AcceptDisputeResponse Hash] response from the API call
@@ -104,7 +105,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 +125,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 +139,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,7 +159,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
 
     # Removes specified evidence from a dispute.
@@ -177,8 +182,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,7 +203,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 specific evidence metadata associated with a specific dispute.
@@ -217,8 +224,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,16 +245,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
 
     # 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.
     # @param [CreateDisputeEvidenceFileRequest] request Optional parameter:
@@ -262,7 +268,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 +310,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 +329,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,7 +351,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
 
     # Submits evidence to the cardholder's bank.
@@ -359,10 +365,7 @@ module Square
     # [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).
+    # available.
     # @param [String] dispute_id Required parameter: The ID of the dispute you
     # want to submit evidence for.
     # @return [SubmitEvidenceResponse Hash] response from the API call
@@ -372,7 +375,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 +395,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

@@ -6,8 +6,7 @@ module Square
     end
 
     # ListEmployees
-    # @param [String] location_id Optional parameter: Filter employees returned
-    # to only those that are associated with the specified location.
+    # @param [String] location_id Optional parameter: Example:
     # @param [EmployeeStatus] status Optional parameter: Specifies the
     # EmployeeStatus to filter the employee by.
     # @param [Integer] limit Optional parameter: The number of employees to be
@@ -19,6 +18,7 @@ module Square
                        status: nil,
                        limit: nil,
                        cursor: nil)
+      warn 'Endpoint list_employees in EmployeesApi is deprecated'
       # Prepare query url.
       _query_builder = config.get_base_uri
       _query_builder << '/v2/employees'
@@ -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
@@ -55,12 +57,13 @@ module Square
     # requested.
     # @return [RetrieveEmployeeResponse Hash] response from the API call
     def retrieve_employee(id:)
+      warn 'Endpoint retrieve_employee in EmployeesApi is deprecated'
       # Prepare query url.
       _query_builder = config.get_base_uri
       _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
 
@@ -80,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
@@ -242,8 +254,9 @@ module Square
     # [Location](#type-location)s.
     # 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 is
-    # useful when displaying recent changes for a specific item. For more
+    # There are no limits on how far back the caller can page. This endpoint can
+    # be
+    # 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.
@@ -264,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,
@@ -289,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