square.rb 6.4.0.20200923 → 9.0.0.20210226

data/lib/square/api/customers_api.rb

@@ -10,7 +10,7 @@ module Square
     # profiles become available
     # for the listing operation in well under 30 seconds. Occasionally,
     # propagation of the new or updated
-    # profiles can take closer to one minute or longer, espeically during
+    # profiles can take closer to one minute or longer, especially during
     # network incidents and outages.
     # @param [String] cursor Optional parameter: A pagination cursor returned by
     # a previous call to this endpoint. Provide this to retrieve the next set of
@@ -53,7 +53,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 new customer for a business, which can have associated cards on
@@ -94,11 +96,13 @@ 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
 
-    # Searches the customer profiles associated with a Square account using
-    # one or more supported query filters.
+    # Searches the customer profiles associated with a Square account using a
+    # supported query filter.
     # Calling `SearchCustomers` without any explicit query filter returns all
     # customer profiles ordered alphabetically based on `given_name` and
     # `family_name`.
@@ -106,7 +110,7 @@ module Square
     # profiles become available
     # for the search operation in well under 30 seconds. Occasionally,
     # propagation of the new or updated
-    # profiles can take closer to one minute or longer, espeically during
+    # profiles can take closer to one minute or longer, especially during
     # network incidents and outages.
     # @param [SearchCustomersRequest] body Required parameter: An object
     # containing the fields to POST for the request.  See the corresponding
@@ -136,7 +140,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
 
     # Deletes a customer from a business, along with any linked cards on file.
@@ -153,7 +159,7 @@ module Square
       _query_builder << '/v2/customers/{customer_id}'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'customer_id' => customer_id
+        'customer_id' => { 'value' => customer_id, 'encode' => true }
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -173,7 +179,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 for a single customer.
@@ -186,7 +194,7 @@ module Square
       _query_builder << '/v2/customers/{customer_id}'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'customer_id' => customer_id
+        'customer_id' => { 'value' => customer_id, 'encode' => true }
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -206,7 +214,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
 
     # Updates the details of an existing customer. When two profiles are merged
@@ -216,9 +226,9 @@ module Square
     # You cannot edit a customer's cards on file with this endpoint. To make
     # changes
     # to a card on file, you must delete the existing card on file with the
-    # [DeleteCustomerCard](#endpoint-deletecustomercard) endpoint, then create a
-    # new one with the
-    # [CreateCustomerCard](#endpoint-createcustomercard) endpoint.
+    # [DeleteCustomerCard](#endpoint-Customers-deletecustomercard) endpoint,
+    # then create a new one with the
+    # [CreateCustomerCard](#endpoint-Customers-createcustomercard) endpoint.
     # @param [String] customer_id Required parameter: The ID of the customer to
     # update.
     # @param [UpdateCustomerRequest] body Required parameter: An object
@@ -232,7 +242,7 @@ module Square
       _query_builder << '/v2/customers/{customer_id}'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'customer_id' => customer_id
+        'customer_id' => { 'value' => customer_id, 'encode' => true }
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -254,7 +264,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
 
     # Adds a card on file to an existing customer.
@@ -275,7 +287,7 @@ module Square
       _query_builder << '/v2/customers/{customer_id}/cards'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'customer_id' => customer_id
+        'customer_id' => { 'value' => customer_id, 'encode' => true }
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -297,7 +309,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 a card on file from a customer.
@@ -313,8 +327,8 @@ module Square
       _query_builder << '/v2/customers/{customer_id}/cards/{card_id}'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'customer_id' => customer_id,
-        'card_id' => card_id
+        'customer_id' => { 'value' => customer_id, 'encode' => true },
+        'card_id' => { 'value' => card_id, 'encode' => true }
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -334,7 +348,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 a group membership from a customer.
@@ -352,8 +368,8 @@ module Square
       _query_builder << '/v2/customers/{customer_id}/groups/{group_id}'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'customer_id' => customer_id,
-        'group_id' => group_id
+        'customer_id' => { 'value' => customer_id, 'encode' => true },
+        'group_id' => { 'value' => group_id, 'encode' => true }
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -373,7 +389,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
 
     # Adds a group membership to a customer.
@@ -391,8 +409,8 @@ module Square
       _query_builder << '/v2/customers/{customer_id}/groups/{group_id}'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'customer_id' => customer_id,
-        'group_id' => group_id
+        'customer_id' => { 'value' => customer_id, 'encode' => true },
+        'group_id' => { 'value' => group_id, 'encode' => true }
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -412,7 +430,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/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,17 +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.
-    # @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.
@@ -101,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
 
@@ -121,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.
@@ -133,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
 
@@ -153,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).
@@ -174,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
 
@@ -195,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
@@ -214,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
 
@@ -235,17 +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.
-    # @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:,
@@ -256,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
 
@@ -298,7 +309,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
 
     # Uploads text to use as evidence for a dispute challenge.
@@ -315,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
 
@@ -337,21 +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.
-    # @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.
@@ -359,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
 
@@ -379,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