square.rb 4.1.0.20200122 → 5.0.0.20200226

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4eff749072f266fc34fb9cacf003d8ea14f5f3c9b04b97be223590de76243e90
-  data.tar.gz: 747c6cb198b982369efc7f37ee540587c8d6415285a41cf4c6619d5843636409
+  metadata.gz: 4db64adc1deef73ef00086f17ac38e54e342472456ebc04cee8b64e691c5ea3a
+  data.tar.gz: bd4ee35fcc7bc37b6a37d7f071b6e9bce6091088879bbf1c9a4b3b6d67de3553
 SHA512:
-  metadata.gz: b4ca6b78862230fe3434b0c61b32b89e967e2d66e92cfffa3f9bed4bd6e63ad4841770b039c834758a78fa45ea592ae9db87bcb04ad120bf97708243c4704d21
-  data.tar.gz: 675ce08c8e5f6e98f8a5381f4f23944a23c18f838a8fcfd596d1a0f8f7539a2bd0e73bdbcf8315e5614e8659800df2068604d73f062c2d8e6b316a5e09a86acc
+  metadata.gz: 9bc48e30881676a19e52933b16fd57d02bb990fcafd282969f010412d31b8296c2511288cb478cb545f418959e8206847d31d53127fc6311f14ebc731ad0a3a9
+  data.tar.gz: 2f6af98a925f9304a1e7c833c3a637bea22329099cba3cf09656cd92bada279c7f8cf3f0d14c08faba2026f6ef777a5dbb1a119477107f6d7b7f403b795f2635

data/lib/square/api/bank_accounts_api.rb

@@ -0,0 +1,136 @@
+module Square
+  # BankAccountsApi
+  class BankAccountsApi < BaseApi
+    def initialize(config, http_call_back: nil)
+      super(config, http_call_back: http_call_back)
+    end
+
+    # Returns a list of [BankAccount](#type-bankaccount) objects linked to a
+    # Square account.
+    # For more information, see
+    # [Bank Accounts
+    # API](https://developer.squareup.com/docs/docs/bank-accounts-api).
+    # @param [String] cursor Optional parameter: The pagination cursor returned
+    # by a previous call to this endpoint. Use it in the next `ListBankAccounts`
+    # request to retrieve the next set  of results.  See the
+    # [Pagination](https://developer.squareup.com/docs/docs/working-with-apis/pa
+    # gination) guide for more information.
+    # @param [Integer] limit Optional parameter: Upper limit on the number of
+    # bank accounts to return in the response.  Currently, 1000 is the largest
+    # supported limit. You can specify a limit  of up to 1000 bank accounts.
+    # This is also the default limit.
+    # @param [String] location_id Optional parameter: Location ID. You can
+    # specify this optional filter  to retrieve only the linked bank accounts
+    # belonging to a specific location.
+    # @return [ListBankAccountsResponse Hash] response from the API call
+    def list_bank_accounts(cursor: nil,
+                           limit: nil,
+                           location_id: nil)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/bank-accounts'
+      _query_builder = APIHelper.append_url_with_query_parameters(
+        _query_builder,
+        'cursor' => cursor,
+        'limit' => limit,
+        'location_id' => location_id
+      )
+      _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 details of a [BankAccount](#type-bankaccount) identified by V1
+    # bank account ID.
+    # For more information, see
+    # [Retrieve a bank account by using an ID issued by V1 Bank Accounts
+    # API](https://developer.squareup.com/docs/docs/bank-accounts-api#retrieve-a
+    # -bank-account-by-using-an-id-issued-by-the-v1-bank-accounts-api).
+    # @param [String] v1_bank_account_id Required parameter: Connect V1 ID of
+    # the desired `BankAccount`. For more information, see  [Retrieve a bank
+    # account by using an ID issued by V1 Bank Accounts
+    # API](https://developer.squareup.com/docs/docs/bank-accounts-api#retrieve-a
+    # -bank-account-by-using-an-id-issued-by-v1-bank-accounts-api).
+    # @return [GetBankAccountByV1IdResponse Hash] response from the API call
+    def get_bank_account_by_v1_id(v1_bank_account_id:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/bank-accounts/by-v1-id/{v1_bank_account_id}'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'v1_bank_account_id' => v1_bank_account_id
+      )
+      _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 details of a [BankAccount](#type-bankaccount)
+    # linked to a Square account. For more information, see
+    # [Bank Accounts
+    # API](https://developer.squareup.com/docs/docs/bank-accounts-api).
+    # @param [String] bank_account_id Required parameter: Square-issued ID of
+    # the desired `BankAccount`.
+    # @return [GetBankAccountResponse Hash] response from the API call
+    def get_bank_account(bank_account_id:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/bank-accounts/{bank_account_id}'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'bank_account_id' => bank_account_id
+      )
+      _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
+  end
+end

data/lib/square/api/base_api.rb

@@ -8,8 +8,8 @@ module Square
       @http_call_back = http_call_back
 
       @global_headers = {
-        'user-agent' => 'Square-Ruby-SDK/4.1.0.20200122',
-        'Square-Version' => '2020-01-22'
+        'user-agent' => 'Square-Ruby-SDK/5.0.0.20200226',
+        'Square-Version' => '2020-02-26'
       }
     end
 

data/lib/square/api/catalog_api.rb

@@ -181,6 +181,14 @@ module Square
       _query_builder << '/v2/catalog/images'
       _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'
@@ -193,8 +201,8 @@ module Square
           'application/json'
         ),
         'image_file' => Faraday::UploadIO.new(
-          image_file,
-          'image/jpeg'
+          image_file_wrapper,
+          image_file_content_type
         )
       }
       _parameters = APIHelper.form_encode_parameters(_parameters)

data/lib/square/api/disputes_api.rb

@@ -0,0 +1,408 @@
+module Square
+  # DisputesApi
+  class DisputesApi < BaseApi
+    def initialize(config, http_call_back: nil)
+      super(config, http_call_back: http_call_back)
+    end
+
+    # 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)
+    # .
+    # @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`).
+    # @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.
+    # @return [ListDisputesResponse Hash] response from the API call
+    def list_disputes(cursor: nil,
+                      states: nil,
+                      location_id: nil)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/disputes'
+      _query_builder = APIHelper.append_url_with_query_parameters(
+        _query_builder,
+        'cursor' => cursor,
+        'states' => states,
+        'location_id' => location_id
+      )
+      _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 details of 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
+    def retrieve_dispute(dispute_id:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/disputes/{dispute_id}'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'dispute_id' => dispute_id
+      )
+      _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
+
+    # 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.
+    # @return [AcceptDisputeResponse Hash] response from the API call
+    def accept_dispute(dispute_id:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/disputes/{dispute_id}/accept'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'dispute_id' => dispute_id
+      )
+      _query_url = APIHelper.clean_url _query_builder
+
+      # Prepare headers.
+      _headers = {
+        'accept' => 'application/json'
+      }
+
+      # Prepare and execute HttpRequest.
+      _request = config.http_client.post(
+        _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 a list of evidence associated with a dispute.
+    # @param [String] dispute_id Required parameter: The ID of the dispute.
+    # @return [ListDisputeEvidenceResponse Hash] response from the API call
+    def list_dispute_evidence(dispute_id:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/disputes/{dispute_id}/evidence'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'dispute_id' => dispute_id
+      )
+      _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
+
+    # 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:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _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
+      )
+      _query_url = APIHelper.clean_url _query_builder
+
+      # Prepare headers.
+      _headers = {
+        'accept' => 'application/json'
+      }
+
+      # Prepare and execute HttpRequest.
+      _request = config.http_client.delete(
+        _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 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:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _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
+      )
+      _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
+
+    # 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. The following is an example of such an HTTP request:
+    # ```
+    # curl -X POST \
+    # -H 'Accept: application/json' \
+    # -H 'Authorization: Bearer {{ACCESS_TOKEN}}' \
+    # -H 'Content-Type: multipart/form-data' \
+    # -F 'evidence=@/path/to/file/filename.tiff' \
+    # -F 'request={ "idempotency_key":"{{UNIQUE_KEY}}",
+    # "evidence_type":"{{EVIDENCE_TYPE}}", "content_type":"image/tiff" }' \
+    # 'https://connect.squareup.com/v2/disputes/{{DISPUTE_ID}}/evidence_file'
+    # ```
+    # 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:
+    # Defines 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_file'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'dispute_id' => dispute_id
+      )
+      _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(
+        _query_url,
+        headers: _headers,
+        parameters: _parameters
+      )
+      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
+
+    # 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).
+    # @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:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/disputes/{dispute_id}/evidence_text'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'dispute_id' => dispute_id
+      )
+      _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
+
+    # Submits evidence to the cardholder's bank.
+    # Before submitting evidence, Square compiles all available evidence. This
+    # 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.
+    # @return [SubmitEvidenceResponse Hash] response from the API call
+    def submit_evidence(dispute_id:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/disputes/{dispute_id}/submit-evidence'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'dispute_id' => dispute_id
+      )
+      _query_url = APIHelper.clean_url _query_builder
+
+      # Prepare headers.
+      _headers = {
+        'accept' => 'application/json'
+      }
+
+      # Prepare and execute HttpRequest.
+      _request = config.http_client.post(
+        _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
+  end
+end

data/lib/square/api/payments_api.rb

@@ -21,8 +21,9 @@ module Square
     # results for the original query.  See
     # [Pagination](https://developer.squareup.com/docs/basics/api101/pagination)
     # for more information.
-    # @param [String] location_id Optional parameter: ID of location associated
-    # with payment
+    # @param [String] location_id Optional parameter: Limit results to the
+    # location supplied. By default, results are returned for all locations
+    # associated with the merchant.
     # @param [Long] total Optional parameter: The exact amount in the
     # total_money for a `Payment`.
     # @param [String] last_4 Optional parameter: The last 4 digits of `Payment`
@@ -118,16 +119,17 @@ module Square
     end
 
     # Cancels (voids) a payment identified by the idempotency key that is
-    # specified in the request.
-    # Use this method when status of a CreatePayment request is unknown.
-    # For example, after you send a CreatePayment
-    # request a network error occurs and you don't get a response. In this case,
-    # you can direct
-    # Square to cancel the payment using this endpoint. In the request, you
-    # provide the same idempotency
-    # key that you provided in your CreatePayment request you want  to cancel.
-    # After cancelling the
-    # payment, you can submit your CreatePayment request again.
+    # specified in the
+    # request.
+    # Use this method when status of a CreatePayment request is unknown. For
+    # example, after you send a
+    # CreatePayment request a network error occurs and you don't get a response.
+    # In this case, you can
+    # direct Square to cancel the payment using this endpoint. In the request,
+    # you provide the same
+    # idempotency key that you provided in your CreatePayment request you want
+    # to cancel. After
+    # cancelling the payment, you can submit your CreatePayment request again.
     # Note that if no payment with the specified idempotency key is found, no
     # action is taken, the end
     # point returns successfully.

data/lib/square/api/transactions_api.rb

@@ -7,6 +7,15 @@ module Square
 
     # Lists refunds for one of a business's locations.
     # Deprecated - recommend using [SearchOrders](#endpoint-orders-searchorders)
+    # ---
+    # - __Deprecation date__: 2019-08-15
+    # - [__Retirement
+    # date__](https://developer.squareup.com/docs/build-basics/api-lifecycle#dep
+    # recated): 2021-09-01
+    # - [Migration
+    # guide](https://developer.squareup.com/docs/payments-api/migrate-from-trans
+    # actions-api)
+    # ---
     # In addition to full or partial tender refunds processed through Square
     # APIs,
     # refunds may result from itemized returns or exchanges through Square's
@@ -75,6 +84,15 @@ module Square
 
     # Lists transactions for a particular location.
     # Deprecated - recommend using [SearchOrders](#endpoint-orders-searchorders)
+    # ---
+    # - __Deprecation date__: 2019-08-15
+    # - [__Retirement
+    # date__](https://developer.squareup.com/docs/build-basics/api-lifecycle#dep
+    # recated): 2021-09-01
+    # - [Migration
+    # guide](https://developer.squareup.com/docs/payments-api/migrate-from-trans
+    # actions-api)
+    # ---
     # Transactions include payment information from sales and exchanges and
     # refund
     # information from returns and exchanges.
@@ -141,6 +159,15 @@ module Square
     # Charges a card represented by a card nonce or a customer's card on file.
     # Deprecated - recommend using
     # [CreatePayment](#endpoint-payments-createpayment)
+    # ---
+    # - __Deprecation date__: 2019-08-15
+    # - [__Retirement
+    # date__](https://developer.squareup.com/docs/build-basics/api-lifecycle#dep
+    # recated): 2021-09-01
+    # - [Migration
+    # guide](https://developer.squareup.com/docs/payments-api/migrate-from-trans
+    # actions-api)
+    # ---
     # Your request to this endpoint must include _either_:
     # - A value for the `card_nonce` parameter (to charge a card nonce generated
     # with the `SqPaymentForm`)
@@ -201,6 +228,15 @@ module Square
     # Retrieves details for a single transaction.
     # Deprecated - recommend using
     # [BatchRetrieveOrders](#endpoint-batchretrieveorders)
+    # ---
+    # - __Deprecation date__: 2019-08-15
+    # - [__Retirement
+    # date__](https://developer.squareup.com/docs/build-basics/api-lifecycle#dep
+    # recated): 2021-09-01
+    # - [Migration
+    # guide](https://developer.squareup.com/docs/payments-api/migrate-from-trans
+    # actions-api)
+    # ---
     # @param [String] location_id Required parameter: The ID of the
     # transaction's associated location.
     # @param [String] transaction_id Required parameter: The ID of the
@@ -241,6 +277,15 @@ module Square
     # Captures a transaction that was created with the
     # [Charge](#endpoint-charge)
     # endpoint with a `delay_capture` value of `true`.
+    # ---
+    # - __Deprecation date__: 2019-08-15
+    # - [__Retirement
+    # date__](https://developer.squareup.com/docs/build-basics/api-lifecycle#dep
+    # recated): 2021-09-01
+    # - [Migration
+    # guide](https://developer.squareup.com/docs/payments-api/migrate-from-trans
+    # actions-api)
+    # ---
     # See [Delayed capture
     # transactions](https://developer.squareup.com/docs/payments/transactions/ov
     # erview#delayed-capture)
@@ -283,6 +328,15 @@ module Square
     # Initiates a refund for a previously charged tender.
     # Deprecated - recommend using
     # [RefundPayment](#endpoint-refunds-refundpayment)
+    # ---
+    # - __Deprecation date__: 2019-08-15
+    # - [__Retirement
+    # date__](https://developer.squareup.com/docs/build-basics/api-lifecycle#dep
+    # recated): 2021-09-01
+    # - [Migration
+    # guide](https://developer.squareup.com/docs/payments-api/migrate-from-trans
+    # actions-api)
+    # ---
     # You must issue a refund within 120 days of the associated payment. See
     # [this article](https://squareup.com/help/us/en/article/5060) for more
     # information
@@ -335,6 +389,15 @@ module Square
 
     # Cancels a transaction that was created with the [Charge](#endpoint-charge)
     # endpoint with a `delay_capture` value of `true`.
+    # ---
+    # - __Deprecation date__: 2019-08-15
+    # - [__Retirement
+    # date__](https://developer.squareup.com/docs/build-basics/api-lifecycle#dep
+    # recated): 2021-09-01
+    # - [Migration
+    # guide](https://developer.squareup.com/docs/payments-api/migrate-from-trans
+    # actions-api)
+    # ---
     # See [Delayed capture
     # transactions](https://developer.squareup.com/docs/payments/transactions/ov
     # erview#delayed-capture)

data/lib/square/api/v1_employees_api.rb

@@ -345,6 +345,15 @@ module Square
     end
 
     # Provides summary information for all of a business's employee timecards.
+    # ---
+    # - __Deprecation date__: 2020-02-26
+    # - [__Retirement
+    # date__](https://developer.squareup.com/docs/docs/build-basics/api-lifecycl
+    # e#deprecated): 2021-02-26
+    # - [Migration
+    # guide](https://developer.squareup.com/docs/docs/migrate-from-v1/guides/v1-
+    # timecards)
+    # ---
     # @param [SortOrder] order Optional parameter: The order in which timecards
     # are listed in the response, based on their created_at field.
     # @param [String] employee_id Optional parameter: If provided, the endpoint
@@ -389,6 +398,7 @@ module Square
                        deleted: nil,
                        limit: nil,
                        batch_token: nil)
+      warn 'Endpoint list_timecards in V1EmployeesApi is deprecated'
       # Prepare query url.
       _query_builder = config.get_base_uri
       _query_builder << '/v1/me/timecards'
@@ -429,7 +439,17 @@ module Square
 
     # Creates a timecard for an employee and clocks them in with an
     # `API_CREATE` event and a `clockin_time` set to the current time unless
-    # the request provides a different value. To import timecards from another
+    # the request provides a different value.
+    # ---
+    # - __Deprecation date__: 2020-02-26
+    # - [__Retirement
+    # date__](https://developer.squareup.com/docs/docs/build-basics/api-lifecycl
+    # e#deprecated): 2021-02-26
+    # - [Migration
+    # guide](https://developer.squareup.com/docs/docs/migrate-from-v1/guides/v1-
+    # timecards)
+    # ---
+    # To import timecards from another
     # system (rather than clocking someone in). Specify the `clockin_time`
     # and* `clockout_time` in the request.
     # Timecards correspond to exactly one shift for a given employee, bounded
@@ -442,6 +462,7 @@ module Square
     # for field details.
     # @return [V1Timecard Hash] response from the API call
     def create_timecard(body:)
+      warn 'Endpoint create_timecard in V1EmployeesApi is deprecated'
       # Prepare query url.
       _query_builder = config.get_base_uri
       _query_builder << '/v1/me/timecards'
@@ -472,6 +493,15 @@ module Square
     # Square Dashboard. Deleted timecards are still accessible through
     # Connect API endpoints, but cannot be modified. The `deleted` field of
     # the `Timecard` object indicates whether the timecard has been deleted.
+    # ---
+    # - __Deprecation date__: 2020-02-26
+    # - [__Retirement
+    # date__](https://developer.squareup.com/docs/docs/build-basics/api-lifecycl
+    # e#deprecated): 2021-02-26
+    # - [Migration
+    # guide](https://developer.squareup.com/docs/docs/migrate-from-v1/guides/v1-
+    # timecards)
+    # ---
     # *Note**: By default, deleted timecards appear alongside valid timecards in
     # results returned by the
     # [ListTimecards](#endpoint-v1employees-listtimecards)
@@ -486,6 +516,7 @@ module Square
     # delete.
     # @return [Object] response from the API call
     def delete_timecard(timecard_id:)
+      warn 'Endpoint delete_timecard in V1EmployeesApi is deprecated'
       # Prepare query url.
       _query_builder = config.get_base_uri
       _query_builder << '/v1/me/timecards/{timecard_id}'
@@ -507,6 +538,15 @@ module Square
     end
 
     # Provides the details for a single timecard.
+    # ---
+    # - __Deprecation date__: 2020-02-26
+    # - [__Retirement
+    # date__](https://developer.squareup.com/docs/docs/build-basics/api-lifecycl
+    # e#deprecated): 2021-02-26
+    # - [Migration
+    # guide](https://developer.squareup.com/docs/docs/migrate-from-v1/guides/v1-
+    # timecards)
+    # ---
     # <aside>
     # Only approved accounts can manage their employees with Square.
     # Unapproved accounts cannot use employee management features with the
@@ -515,6 +555,7 @@ module Square
     # @param [String] timecard_id Required parameter: The timecard's ID.
     # @return [V1Timecard Hash] response from the API call
     def retrieve_timecard(timecard_id:)
+      warn 'Endpoint retrieve_timecard in V1EmployeesApi is deprecated'
       # Prepare query url.
       _query_builder = config.get_base_uri
       _query_builder << '/v1/me/timecards/{timecard_id}'
@@ -546,6 +587,15 @@ module Square
     # Modifies the details of a timecard with an `API_EDIT` event for
     # the timecard. Updating an active timecard with a `clockout_time`
     # clocks the employee out.
+    # ---
+    # - __Deprecation date__: 2020-02-26
+    # - [__Retirement
+    # date__](https://developer.squareup.com/docs/docs/build-basics/api-lifecycl
+    # e#deprecated): 2021-02-26
+    # - [Migration
+    # guide](https://developer.squareup.com/docs/docs/migrate-from-v1/guides/v1-
+    # timecards)
+    # ---
     # @param [String] timecard_id Required parameter: TThe ID of the timecard to
     # modify.
     # @param [V1Timecard] body Required parameter: An object containing the
@@ -554,6 +604,7 @@ module Square
     # @return [V1Timecard Hash] response from the API call
     def update_timecard(timecard_id:,
                         body:)
+      warn 'Endpoint update_timecard in V1EmployeesApi is deprecated'
       # Prepare query url.
       _query_builder = config.get_base_uri
       _query_builder << '/v1/me/timecards/{timecard_id}'
@@ -586,6 +637,15 @@ module Square
 
     # Provides summary information for all events associated with a
     # particular timecard.
+    # ---
+    # - __Deprecation date__: 2020-02-26
+    # - [__Retirement
+    # date__](https://developer.squareup.com/docs/docs/build-basics/api-lifecycl
+    # e#deprecated): 2021-02-26
+    # - [Migration
+    # guide](https://developer.squareup.com/docs/docs/migrate-from-v1/guides/v1-
+    # timecards)
+    # ---
     # <aside>
     # Only approved accounts can manage their employees with Square.
     # Unapproved accounts cannot use employee management features with the
@@ -595,6 +655,7 @@ module Square
     # list events for.
     # @return [List of V1TimecardEvent Hash] response from the API call
     def list_timecard_events(timecard_id:)
+      warn 'Endpoint list_timecard_events in V1EmployeesApi is deprecated'
       # Prepare query url.
       _query_builder = config.get_base_uri
       _query_builder << '/v1/me/timecards/{timecard_id}/events'
@@ -625,6 +686,15 @@ module Square
 
     # Provides the details for all of a location's cash drawer shifts during a
     # date range. The date range you specify cannot exceed 90 days.
+    # ---
+    # - __Deprecation date__: 2020-02-26
+    # - [__Retirement
+    # date__](https://developer.squareup.com/docs/docs/build-basics/api-lifecycl
+    # e#deprecated): 2021-02-26
+    # - [Migration
+    # guide](https://developer.squareup.com/docs/docs/migrate-from-v1/guides/v1-
+    # cashdrawershifts)
+    # ---
     # @param [String] location_id Required parameter: The ID of the location to
     # list cash drawer shifts for.
     # @param [SortOrder] order Optional parameter: The order in which cash
@@ -641,6 +711,7 @@ module Square
                                 order: nil,
                                 begin_time: nil,
                                 end_time: nil)
+      warn 'Endpoint list_cash_drawer_shifts in V1EmployeesApi is deprecated'
       # Prepare query url.
       _query_builder = config.get_base_uri
       _query_builder << '/v1/{location_id}/cash-drawer-shifts'
@@ -677,12 +748,22 @@ module Square
 
     # Provides the details for a single cash drawer shift, including all events
     # that occurred during the shift.
+    # ---
+    # - __Deprecation date__: 2020-02-26
+    # - [__Retirement
+    # date__](https://developer.squareup.com/docs/docs/build-basics/api-lifecycl
+    # e#deprecated): 2021-02-26
+    # - [Migration
+    # guide](https://developer.squareup.com/docs/docs/migrate-from-v1/guides/v1-
+    # cashdrawershifts)
+    # ---
     # @param [String] location_id Required parameter: The ID of the location to
     # list cash drawer shifts for.
     # @param [String] shift_id Required parameter: The shift's ID.
     # @return [V1CashDrawerShift Hash] response from the API call
     def retrieve_cash_drawer_shift(location_id:,
                                    shift_id:)
+      warn 'Endpoint retrieve_cash_drawer_shift in V1EmployeesApi is deprecated'
       # Prepare query url.
       _query_builder = config.get_base_uri
       _query_builder << '/v1/{location_id}/cash-drawer-shifts/{shift_id}'

data/lib/square/api/v1_transactions_api.rb

@@ -8,10 +8,20 @@ module Square
     # Provides non-confidential details for all of a location's associated bank
     # accounts. This endpoint does not provide full bank account numbers, and
     # there is no way to obtain a full bank account number with the Connect API.
+    # ---
+    # - __Deprecation date__: 2020-02-26
+    # - [__Retirement
+    # date__](https://developer.squareup.com/docs/docs/build-basics/api-lifecycl
+    # e#deprecated): 2021-02-26
+    # - [Migration
+    # guide](https://developer.squareup.com/docs/docs/migrate-from-v1/guides/v1-
+    # bankaccounts)
+    # ---
     # @param [String] location_id Required parameter: The ID of the location to
     # list bank accounts for.
     # @return [List of V1BankAccount Hash] response from the API call
     def list_bank_accounts(location_id:)
+      warn 'Endpoint list_bank_accounts in V1TransactionsApi is deprecated'
       # Prepare query url.
       _query_builder = config.get_base_uri
       _query_builder << '/v1/{location_id}/bank-accounts'
@@ -43,6 +53,15 @@ module Square
     # Provides non-confidential details for a merchant's associated bank
     # account. This endpoint does not provide full bank account numbers, and
     # there is no way to obtain a full bank account number with the Connect API.
+    # ---
+    # - __Deprecation date__: 2020-02-26
+    # - [__Retirement
+    # date__](https://developer.squareup.com/docs/docs/build-basics/api-lifecycl
+    # e#deprecated): 2021-02-26
+    # - [Migration
+    # guide](https://developer.squareup.com/docs/docs/migrate-from-v1/guides/v1-
+    # bankaccounts)
+    # ---
     # @param [String] location_id Required parameter: The ID of the bank
     # account's associated location.
     # @param [String] bank_account_id Required parameter: The bank account's
@@ -51,6 +70,7 @@ module Square
     # @return [V1BankAccount Hash] response from the API call
     def retrieve_bank_account(location_id:,
                               bank_account_id:)
+      warn 'Endpoint retrieve_bank_account in V1TransactionsApi is deprecated'
       # Prepare query url.
       _query_builder = config.get_base_uri
       _query_builder << '/v1/{location_id}/bank-accounts/{bank_account_id}'

data/lib/square/client.rb

@@ -4,11 +4,11 @@ module Square
     attr_reader :config
 
     def sdk_version
-      '4.1.0.20200122'
+      '5.0.0.20200226'
     end
 
     def square_version
-      '2020-01-22'
+      '2020-02-26'
     end
 
     # Access to mobile_authorization controller.
@@ -53,6 +53,12 @@ module Square
       @apple_pay ||= ApplePayApi.new config
     end
 
+    # Access to bank_accounts controller.
+    # @return [BankAccountsApi] Returns the controller instance.
+    def bank_accounts
+      @bank_accounts ||= BankAccountsApi.new config
+    end
+
     # Access to cash_drawers controller.
     # @return [CashDrawersApi] Returns the controller instance.
     def cash_drawers
@@ -71,6 +77,12 @@ module Square
       @customers ||= CustomersApi.new config
     end
 
+    # Access to disputes controller.
+    # @return [DisputesApi] Returns the controller instance.
+    def disputes
+      @disputes ||= DisputesApi.new config
+    end
+
     # Access to employees controller.
     # @return [EmployeesApi] Returns the controller instance.
     def employees

data/lib/square/http/faraday_client.rb

@@ -29,9 +29,7 @@ module Square
         http_request.query_url
       ) do |request|
         request.headers = http_request.headers
-        unless http_request.parameters.empty?
-          request.body = http_request.parameters
-        end
+        request.body = http_request.parameters
       end
       convert_response(response, http_request)
     end
@@ -43,9 +41,7 @@ module Square
         http_request.query_url
       ) do |request|
         request.headers = http_request.headers
-        unless http_request.parameters.empty?
-          request.body = http_request.parameters
-        end
+        request.body = http_request.parameters
       end
       convert_response(response, http_request)
     end

data/lib/square/utilities/file_wrapper.rb

@@ -0,0 +1,12 @@
+module Square
+  # A utility to allow users to set the content-type for files
+  class FileWrapper
+    attr_reader :content_type
+    attr_reader :file
+
+    def initialize(file, content_type: 'application/octet-stream')
+      @file = file
+      @content_type = content_type
+    end
+  end
+end

data/lib/square.rb

@@ -7,6 +7,9 @@ require 'logging'
 require_relative 'square/api_helper.rb'
 require_relative 'square/client.rb'
 
+# Utilities
+require_relative 'square/utilities/file_wrapper.rb'
+
 # Http
 require_relative 'square/http/api_response.rb'
 require_relative 'square/http/http_call_back.rb'
@@ -33,9 +36,11 @@ require_relative 'square/api/v1_employees_api.rb'
 require_relative 'square/api/v1_transactions_api.rb'
 require_relative 'square/api/v1_items_api.rb'
 require_relative 'square/api/apple_pay_api.rb'
+require_relative 'square/api/bank_accounts_api.rb'
 require_relative 'square/api/cash_drawers_api.rb'
 require_relative 'square/api/catalog_api.rb'
 require_relative 'square/api/customers_api.rb'
+require_relative 'square/api/disputes_api.rb'
 require_relative 'square/api/employees_api.rb'
 require_relative 'square/api/inventory_api.rb'
 require_relative 'square/api/labor_api.rb'

data/spec/user_journey_spec.rb

@@ -121,8 +121,11 @@ describe "UserJourney" do
 
       # list
       response = sq.customers.list_customers
-      assert_equal response.data.to_h.keys, %i[customers]
-      assert_equal response.status_code, 200
+      if response.data != nil
+        assert_equal response.data.to_h.keys, %i[customers]
+        assert_equal response.status_code, 200
+      end
+
 
       # update
       response = sq.customers.update_customer(customer_id: created_customer[:id], body: customer2)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: square.rb
 version: !ruby/object:Gem::Version
-  version: 4.1.0.20200122
+  version: 5.0.0.20200226
 platform: ruby
 authors:
 - Square Developer Platform
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-22 00:00:00.000000000 Z
+date: 2020-02-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logging
@@ -119,11 +119,13 @@ files:
 - README.md
 - lib/square.rb
 - lib/square/api/apple_pay_api.rb
+- lib/square/api/bank_accounts_api.rb
 - lib/square/api/base_api.rb
 - lib/square/api/cash_drawers_api.rb
 - lib/square/api/catalog_api.rb
 - lib/square/api/checkout_api.rb
 - lib/square/api/customers_api.rb
+- lib/square/api/disputes_api.rb
 - lib/square/api/employees_api.rb
 - lib/square/api/inventory_api.rb
 - lib/square/api/labor_api.rb
@@ -152,6 +154,7 @@ files:
 - lib/square/http/http_method_enum.rb
 - lib/square/http/http_request.rb
 - lib/square/http/http_response.rb
+- lib/square/utilities/file_wrapper.rb
 - spec/user_journey_spec.rb
 - test/api/api_test_base.rb
 - test/api/test_catalog_api.rb