square.rb 8.0.0.20201216 → 26.1.0.20230119

data/lib/square/api/customers_api.rb

@@ -13,17 +13,26 @@ module Square
     # 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
-    # results for your original query.  See the [Pagination
-    # guide](https://developer.squareup.com/docs/working-with-apis/pagination)
-    # for more information.
+    # a previous call to this endpoint. Provide this cursor to retrieve the next
+    # set of results for your original query.  For more information, see
+    # [Pagination](https://developer.squareup.com/docs/build-basics/common-api-p
+    # atterns/pagination).
+    # @param [Integer] limit Optional parameter: The maximum number of results
+    # to return in a single page. This limit is advisory. The response might
+    # contain more or fewer results. If the specified limit is less than 1 or
+    # greater than 100, Square returns a `400 VALUE_TOO_LOW` or `400
+    # VALUE_TOO_HIGH` error. The default value is 100.  For more information,
+    # see
+    # [Pagination](https://developer.squareup.com/docs/build-basics/common-api-p
+    # atterns/pagination).
     # @param [CustomerSortField] sort_field Optional parameter: Indicates how
-    # Customers should be sorted.  Default: `DEFAULT`.
+    # customers should be sorted.  The default value is `DEFAULT`.
     # @param [SortOrder] sort_order Optional parameter: Indicates whether
-    # Customers should be sorted in ascending (`ASC`) or descending (`DESC`)
-    # order.  Default: `ASC`.
+    # customers should be sorted in ascending (`ASC`) or descending (`DESC`)
+    # order.  The default value is `ASC`.
     # @return [ListCustomersResponse Hash] response from the API call
     def list_customers(cursor: nil,
+                       limit: nil,
                        sort_field: nil,
                        sort_order: nil)
       # Prepare query url.
@@ -32,6 +41,7 @@ module Square
       _query_builder = APIHelper.append_url_with_query_parameters(
         _query_builder,
         'cursor' => cursor,
+        'limit' => limit,
         'sort_field' => sort_field,
         'sort_order' => sort_order
       )
@@ -58,10 +68,9 @@ module Square
       )
     end
 
-    # Creates a new customer for a business, which can have associated cards on
-    # file.
-    # You must provide __at least one__ of the following values in your request
-    # to this
+    # Creates a new customer for a business.
+    # You must provide at least one of the following values in your request to
+    # this
     # endpoint:
     # - `given_name`
     # - `family_name`
@@ -81,7 +90,7 @@ module Square
       # Prepare headers.
       _headers = {
         'accept' => 'application/json',
-        'content-type' => 'application/json; charset=utf-8'
+        'Content-Type' => 'application/json'
       }
 
       # Prepare and execute HttpRequest.
@@ -101,8 +110,8 @@ module Square
       )
     end
 
-    # Searches the customer profiles associated with a Square account using a
-    # supported query filter.
+    # Searches the customer profiles associated with a Square account using one
+    # or more supported query filters.
     # Calling `SearchCustomers` without any explicit query filter returns all
     # customer profiles ordered alphabetically based on `given_name` and
     # `family_name`.
@@ -125,7 +134,7 @@ module Square
       # Prepare headers.
       _headers = {
         'accept' => 'application/json',
-        'content-type' => 'application/json; charset=utf-8'
+        'Content-Type' => 'application/json'
       }
 
       # Prepare and execute HttpRequest.
@@ -145,15 +154,29 @@ module Square
       )
     end
 
-    # Deletes a customer from a business, along with any linked cards on file.
-    # When two profiles
-    # are merged into a single profile, that profile is assigned a new
-    # `customer_id`. You must use the
-    # new `customer_id` to delete merged profiles.
+    # Deletes a customer profile from a business. This operation also unlinks
+    # any associated cards on file.
+    # As a best practice, include the `version` field in the request to enable
+    # [optimistic
+    # concurrency](https://developer.squareup.com/docs/build-basics/common-api-p
+    # atterns/optimistic-concurrency) control.
+    # If included, the value must be set to the current version of the customer
+    # profile.
+    # To delete a customer profile that was created by merging existing
+    # profiles, you must use the ID of the newly created profile.
     # @param [String] customer_id Required parameter: The ID of the customer to
     # delete.
+    # @param [Integer] version Optional parameter: The current version of the
+    # customer profile.  As a best practice, you should include this parameter
+    # to enable [optimistic
+    # concurrency](https://developer.squareup.com/docs/build-basics/common-api-p
+    # atterns/optimistic-concurrency) control.  For more information, see
+    # [Delete a customer
+    # profile](https://developer.squareup.com/docs/customers-api/use-the-api/kee
+    # p-records#delete-customer-profile).
     # @return [DeleteCustomerResponse Hash] response from the API call
-    def delete_customer(customer_id:)
+    def delete_customer(customer_id:,
+                        version: nil)
       # Prepare query url.
       _query_builder = config.get_base_uri
       _query_builder << '/v2/customers/{customer_id}'
@@ -161,6 +184,10 @@ module Square
         _query_builder,
         'customer_id' => { 'value' => customer_id, 'encode' => true }
       )
+      _query_builder = APIHelper.append_url_with_query_parameters(
+        _query_builder,
+        'version' => version
+      )
       _query_url = APIHelper.clean_url _query_builder
 
       # Prepare headers.
@@ -219,16 +246,21 @@ module Square
       )
     end
 
-    # Updates the details of an existing customer. When two profiles are merged
-    # into a single profile, that profile is assigned a new `customer_id`. You
-    # must use
-    # the new `customer_id` to update merged profiles.
-    # 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-Customers-deletecustomercard) endpoint,
-    # then create a new one with the
-    # [CreateCustomerCard](#endpoint-Customers-createcustomercard) endpoint.
+    # Updates a customer profile. This endpoint supports sparse updates, so only
+    # new or changed fields are required in the request.
+    # To add or update a field, specify the new value. To remove a field,
+    # specify `null` and include the `X-Clear-Null` header set to `true`
+    # (recommended) or specify an empty string (string fields only).
+    # As a best practice, include the `version` field in the request to enable
+    # [optimistic
+    # concurrency](https://developer.squareup.com/docs/build-basics/common-api-p
+    # atterns/optimistic-concurrency) control.
+    # If included, the value must be set to the current version of the customer
+    # profile.
+    # To update a customer profile that was created by merging existing
+    # profiles, you must use the ID of the newly created profile.
+    # You cannot use this endpoint to change cards on file. To make changes, use
+    # the [Cards API]($e/Cards) or [Gift Cards API]($e/GiftCards).
     # @param [String] customer_id Required parameter: The ID of the customer to
     # update.
     # @param [UpdateCustomerRequest] body Required parameter: An object
@@ -249,7 +281,7 @@ module Square
       # Prepare headers.
       _headers = {
         'accept' => 'application/json',
-        'content-type' => 'application/json; charset=utf-8'
+        'Content-Type' => 'application/json'
       }
 
       # Prepare and execute HttpRequest.
@@ -282,6 +314,7 @@ module Square
     # @return [CreateCustomerCardResponse Hash] response from the API call
     def create_customer_card(customer_id:,
                              body:)
+      warn 'Endpoint create_customer_card in CustomersApi is deprecated'
       # Prepare query url.
       _query_builder = config.get_base_uri
       _query_builder << '/v2/customers/{customer_id}/cards'
@@ -294,7 +327,7 @@ module Square
       # Prepare headers.
       _headers = {
         'accept' => 'application/json',
-        'content-type' => 'application/json; charset=utf-8'
+        'Content-Type' => 'application/json'
       }
 
       # Prepare and execute HttpRequest.
@@ -322,6 +355,7 @@ module Square
     # @return [DeleteCustomerCardResponse Hash] response from the API call
     def delete_customer_card(customer_id:,
                              card_id:)
+      warn 'Endpoint delete_customer_card in CustomersApi is deprecated'
       # Prepare query url.
       _query_builder = config.get_base_uri
       _query_builder << '/v2/customers/{customer_id}/cards/{card_id}'

data/lib/square/api/devices_api.rb

@@ -9,7 +9,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 your original query.  See [Paginating
-    # results](#paginatingresults) for more information.
+    # results](https://developer.squareup.com/docs/working-with-apis/pagination)
+    # for more information.
     # @param [String] location_id Optional parameter: If specified, only returns
     # DeviceCodes of the specified location. Returns DeviceCodes of all
     # locations if empty.
@@ -73,7 +74,7 @@ module Square
       # Prepare headers.
       _headers = {
         'accept' => 'application/json',
-        'content-type' => 'application/json; charset=utf-8'
+        'Content-Type' => 'application/json'
       }
 
       # Prepare and execute HttpRequest.

data/lib/square/api/disputes_api.rb

@@ -11,13 +11,12 @@ module Square
     # 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 (the dispute status is not `INQUIRY_CLOSED`, `WON`, or `LOST`).
+    # @param [DisputeState] states Optional parameter: The dispute states used
+    # to filter the result. If not specified, the endpoint returns all
+    # disputes.
     # @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 (the dispute status is not `INQUIRY_CLOSED`, `WON`, or
-    # `LOST`) associated with all locations.
+    # disputes associated with all locations.
     # @return [ListDisputesResponse Hash] response from the API call
     def list_disputes(cursor: nil,
                       states: nil,
@@ -131,8 +130,14 @@ module Square
 
     # Returns a list of evidence associated with a dispute.
     # @param [String] dispute_id Required parameter: The ID of the dispute.
+    # @param [String] cursor Optional parameter: A pagination cursor returned by
+    # 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/build-basics/common-api-p
+    # atterns/pagination).
     # @return [ListDisputeEvidenceResponse Hash] response from the API call
-    def list_dispute_evidence(dispute_id:)
+    def list_dispute_evidence(dispute_id:,
+                              cursor: nil)
       # Prepare query url.
       _query_builder = config.get_base_uri
       _query_builder << '/v2/disputes/{dispute_id}/evidence'
@@ -140,6 +145,10 @@ module Square
         _query_builder,
         'dispute_id' => { 'value' => dispute_id, 'encode' => true }
       )
+      _query_builder = APIHelper.append_url_with_query_parameters(
+        _query_builder,
+        'cursor' => cursor
+      )
       _query_url = APIHelper.clean_url _query_builder
 
       # Prepare headers.
@@ -163,38 +172,59 @@ module Square
       )
     end
 
-    # Removes specified evidence from a dispute.
-    # 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).
-    # @param [String] dispute_id Required parameter: The ID of the dispute you
-    # want to remove evidence from.
-    # @param [String] evidence_id Required parameter: The ID of the evidence you
-    # want to remove.
-    # @return [RemoveDisputeEvidenceResponse Hash] response from the API call
-    def remove_dispute_evidence(dispute_id:,
-                                evidence_id:)
+    # 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: The ID of the dispute for
+    # which you want to upload evidence.
+    # @param [CreateDisputeEvidenceFileRequest] request Optional parameter:
+    # 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:,
+                                     request: nil,
+                                     image_file: nil)
       # Prepare query url.
       _query_builder = config.get_base_uri
-      _query_builder << '/v2/disputes/{dispute_id}/evidence/{evidence_id}'
+      _query_builder << '/v2/disputes/{dispute_id}/evidence-files'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'dispute_id' => { 'value' => dispute_id, 'encode' => true },
-        'evidence_id' => { 'value' => evidence_id, 'encode' => true }
+        'dispute_id' => { 'value' => dispute_id, 'encode' => true }
       )
       _query_url = APIHelper.clean_url _query_builder
 
+      if image_file.is_a? FileWrapper
+        image_file_wrapper = image_file.file
+        image_file_content_type = image_file.content_type
+      else
+        image_file_wrapper = image_file
+        image_file_content_type = 'image/jpeg'
+      end
+
       # Prepare headers.
       _headers = {
         'accept' => 'application/json'
       }
 
+      # Prepare form parameters.
+      _parameters = {
+        'request' => Faraday::UploadIO.new(
+          StringIO.new(request.to_json),
+          'application/json'
+        ),
+        'image_file' => Faraday::UploadIO.new(
+          image_file_wrapper,
+          image_file_content_type
+        )
+      }
+      _parameters = APIHelper.form_encode_parameters(_parameters)
+
       # Prepare and execute HttpRequest.
-      _request = config.http_client.delete(
+      _request = config.http_client.post(
         _query_url,
-        headers: _headers
+        headers: _headers,
+        parameters: _parameters
       )
       OAuth2.apply(config, _request)
       _response = execute_request(_request)
@@ -207,36 +237,35 @@ module Square
       )
     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.
-    # @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
-    # retrieve.
-    # @return [RetrieveDisputeEvidenceResponse Hash] response from the API call
-    def retrieve_dispute_evidence(dispute_id:,
-                                  evidence_id:)
+    # Uploads text to use as evidence for a dispute challenge.
+    # @param [String] dispute_id Required parameter: The ID of the dispute for
+    # which you want to upload evidence.
+    # @param [CreateDisputeEvidenceTextRequest] body Required parameter: An
+    # object containing the fields to POST for the request.  See the
+    # corresponding object definition for field details.
+    # @return [CreateDisputeEvidenceTextResponse Hash] response from the API call
+    def create_dispute_evidence_text(dispute_id:,
+                                     body:)
       # Prepare query url.
       _query_builder = config.get_base_uri
-      _query_builder << '/v2/disputes/{dispute_id}/evidence/{evidence_id}'
+      _query_builder << '/v2/disputes/{dispute_id}/evidence-text'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'dispute_id' => { 'value' => dispute_id, 'encode' => true },
-        'evidence_id' => { 'value' => evidence_id, 'encode' => true }
+        'dispute_id' => { 'value' => dispute_id, 'encode' => true }
       )
       _query_url = APIHelper.clean_url _query_builder
 
       # Prepare headers.
       _headers = {
-        'accept' => 'application/json'
+        'accept' => 'application/json',
+        'Content-Type' => 'application/json'
       }
 
       # Prepare and execute HttpRequest.
-      _request = config.http_client.get(
+      _request = config.http_client.post(
         _query_url,
-        headers: _headers
+        headers: _headers,
+        parameters: body.to_json
       )
       OAuth2.apply(config, _request)
       _response = execute_request(_request)
@@ -249,59 +278,34 @@ module Square
       )
     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: The ID of the dispute you
-    # want to upload evidence for.
-    # @param [CreateDisputeEvidenceFileRequest] request Optional parameter:
-    # 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:,
-                                     request: nil,
-                                     image_file: nil)
+    # Removes specified evidence from a dispute.
+    # Square does not send the bank any evidence that is removed.
+    # @param [String] dispute_id Required parameter: The ID of the dispute from
+    # which you want to remove evidence.
+    # @param [String] evidence_id Required parameter: The ID of the evidence you
+    # want to remove.
+    # @return [DeleteDisputeEvidenceResponse Hash] response from the API call
+    def delete_dispute_evidence(dispute_id:,
+                                evidence_id:)
       # Prepare query url.
       _query_builder = config.get_base_uri
-      _query_builder << '/v2/disputes/{dispute_id}/evidence_file'
+      _query_builder << '/v2/disputes/{dispute_id}/evidence/{evidence_id}'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'dispute_id' => { 'value' => dispute_id, 'encode' => true }
+        'dispute_id' => { 'value' => dispute_id, 'encode' => true },
+        'evidence_id' => { 'value' => evidence_id, 'encode' => true }
       )
       _query_url = APIHelper.clean_url _query_builder
 
-      if image_file.is_a? FileWrapper
-        image_file_wrapper = image_file.file
-        image_file_content_type = image_file.content_type
-      else
-        image_file_wrapper = image_file
-        image_file_content_type = 'image/jpeg'
-      end
-
       # Prepare headers.
       _headers = {
         'accept' => 'application/json'
       }
 
-      # Prepare form parameters.
-      _parameters = {
-        'request' => Faraday::UploadIO.new(
-          StringIO.new(request.to_json),
-          'application/json'
-        ),
-        'image_file' => Faraday::UploadIO.new(
-          image_file_wrapper,
-          image_file_content_type
-        )
-      }
-      _parameters = APIHelper.form_encode_parameters(_parameters)
-
       # Prepare and execute HttpRequest.
-      _request = config.http_client.post(
+      _request = config.http_client.delete(
         _query_url,
-        headers: _headers,
-        parameters: _parameters
+        headers: _headers
       )
       OAuth2.apply(config, _request)
       _response = execute_request(_request)
@@ -314,35 +318,35 @@ module Square
       )
     end
 
-    # 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
-    # object containing the fields to POST for the request.  See the
-    # corresponding object definition for field details.
-    # @return [CreateDisputeEvidenceTextResponse Hash] response from the API call
-    def create_dispute_evidence_text(dispute_id:,
-                                     body:)
+    # Returns the metadata for the evidence specified in the request URL path.
+    # You must maintain a copy of any evidence uploaded if you want to reference
+    # it later. Evidence cannot be downloaded after you upload it.
+    # @param [String] dispute_id Required parameter: The ID of the dispute from
+    # which you want to retrieve evidence metadata.
+    # @param [String] evidence_id Required parameter: The ID of the evidence to
+    # retrieve.
+    # @return [RetrieveDisputeEvidenceResponse Hash] response from the API call
+    def retrieve_dispute_evidence(dispute_id:,
+                                  evidence_id:)
       # Prepare query url.
       _query_builder = config.get_base_uri
-      _query_builder << '/v2/disputes/{dispute_id}/evidence_text'
+      _query_builder << '/v2/disputes/{dispute_id}/evidence/{evidence_id}'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'dispute_id' => { 'value' => dispute_id, 'encode' => true }
+        'dispute_id' => { 'value' => dispute_id, 'encode' => true },
+        'evidence_id' => { 'value' => evidence_id, 'encode' => true }
       )
       _query_url = APIHelper.clean_url _query_builder
 
       # Prepare headers.
       _headers = {
-        'accept' => 'application/json',
-        'content-type' => 'application/json; charset=utf-8'
+        'accept' => 'application/json'
       }
 
       # Prepare and execute HttpRequest.
-      _request = config.http_client.post(
+      _request = config.http_client.get(
         _query_url,
-        headers: _headers,
-        parameters: body.to_json
+        headers: _headers
       )
       OAuth2.apply(config, _request)
       _response = execute_request(_request)
@@ -356,16 +360,16 @@ module Square
     end
 
     # Submits evidence to the cardholder's bank.
-    # Before submitting evidence, Square compiles all available evidence. This
-    # includes evidence uploaded
+    # The evidence submitted by this endpoint 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 that
-    # you want to submit evidence for.
+    # [CreateDisputeEvidenceFile]($e/Disputes/CreateDisputeEvidenceFile) and
+    # [CreateDisputeEvidenceText]($e/Disputes/CreateDisputeEvidenceText)
+    # endpoints and
+    # evidence automatically provided by Square, when available. Evidence cannot
+    # be removed from
+    # a dispute after submission.
+    # @param [String] dispute_id Required parameter: The ID of the dispute for
+    # which you want to submit evidence.
     # @return [SubmitEvidenceResponse Hash] response from the API call
     def submit_evidence(dispute_id:)
       # Prepare query url.