square.rb 6.3.0.20200826 → 6.4.0.20200923

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 973136d2e4f8177385869ee692c78d893fc79df5a5cb27512a57a24318027cfe
-  data.tar.gz: 8b502686044b15c7a047abc2c2a6dfa44cd7741406892b7bfb1f42e5a8af9190
+  metadata.gz: ff331317ad3b1bea0c21cf6a6cc9bfd0b46296890792bf0f5d19d21be6ea8ddb
+  data.tar.gz: dbf543ea3a0ebd7a70cd04e754ffc843d13575899c7e0fe1697c0a538d68fa0c
 SHA512:
-  metadata.gz: 1138a5aeefa0e9f4a1c7fbb8d9275b7f9519bcd3092f7ee694818e00077c661893fa5c1c200d75b587bf8f6a4752b874c32f00a7f089036304302c880e5d2fc9
-  data.tar.gz: 669ef667f74ed01898f5fabcde7be3c92835878cc7a0fbded426b44906478a7c37dc72d1d3bd730c9d6b4701754592b24414cd33ca30402741664997907d403b
+  metadata.gz: 15818b53efa7435cc292b14f3d504feef1ab423e3edafdba332694ad229910d8400eb08e6ba67906c19629ac2ecdc9a76251d29f85790fb3046a115aca3a566c
+  data.tar.gz: 749326579ee962e569e387f932af7176f0137e6f6b175e7392bfa9b8e19e872092f34b7f2097fa9ce9d21cd744c2837cd23015e5c826b50510664887bd9ee546

data/lib/square/api/base_api.rb

@@ -8,7 +8,7 @@ module Square
       @http_call_back = http_call_back
 
       @global_headers = {
-        'user-agent' => 'Square-Ruby-SDK/6.3.0.20200826',
+        'user-agent' => 'Square-Ruby-SDK/6.4.0.20200923',
         'Square-Version' => config.square_version
       }
     end

data/lib/square/api/disputes_api.rb

@@ -92,9 +92,6 @@ module Square
     # Square debits the disputed amount from the seller’s Square
     # account. If the Square account balance does not have
     # sufficient funds, Square debits the associated bank account.
-    # For an overview of the Disputes API, see
-    # [Overview](https://developer.squareup.com/docs/docs/disputes-api/overview)
-    # .
     # @param [String] dispute_id Required parameter: ID of the dispute you want
     # to accept.
     # @return [AcceptDisputeResponse Hash] response from the API call
@@ -245,9 +242,6 @@ module Square
     # accepts
     # HTTP multipart/form-data file uploads in HEIC, HEIF, JPEG, PDF, PNG,
     # and TIFF formats.
-    # For more information, see [Challenge a
-    # Dispute](https://developer.squareup.com/docs/docs/disputes-api/process-dis
-    # putes#challenge-a-dispute).
     # @param [String] dispute_id Required parameter: ID of the dispute you want
     # to upload evidence for.
     # @param [CreateDisputeEvidenceFileRequest] request Optional parameter:
@@ -307,11 +301,7 @@ module Square
       ApiResponse.new(_response, data: decoded, errors: _errors)
     end
 
-    # Uploads text to use as evidence for a dispute challenge. For more
-    # information, see
-    # [Challenge a
-    # Dispute](https://developer.squareup.com/docs/docs/disputes-api/process-dis
-    # putes#challenge-a-dispute).
+    # Uploads text to use as evidence for a dispute challenge.
     # @param [String] dispute_id Required parameter: The ID of the dispute you
     # want to upload evidence for.
     # @param [CreateDisputeEvidenceTextRequest] body Required parameter: An
@@ -359,10 +349,7 @@ module Square
     # [CreateDisputeEvidenceText](https://developer.squareup.com/docs/reference/
     # square/disputes-api/create-dispute-evidence-text) endpoints,
     # and evidence automatically provided by Square, when
-    # available. For more information, see
-    # [Challenge a
-    # Dispute](https://developer.squareup.com/docs/docs/disputes-api/process-dis
-    # putes#challenge-a-dispute).
+    # available.
     # @param [String] dispute_id Required parameter: The ID of the dispute you
     # want to submit evidence for.
     # @return [SubmitEvidenceResponse Hash] response from the API call

data/lib/square/api/invoices_api.rb

@@ -8,9 +8,6 @@ module Square
     # Returns a list of invoices for a given location. The response
     # is paginated. If truncated, the response includes a `cursor` that you
     # use in a subsequent request to fetch the next set of invoices.
-    # For more information about retrieving invoices, see [Retrieve
-    # invoices](https://developer.squareup.com/docs/docs/invoices-api/overview#r
-    # etrieve-invoices).
     # @param [String] location_id Required parameter: The ID of the location for
     # which to list invoices.
     # @param [String] cursor Optional parameter: A pagination cursor returned by
@@ -60,8 +57,6 @@ module Square
     # A draft invoice remains in your account and no action is taken.
     # You must publish the invoice before Square can process it (send it to the
     # customer's email address or charge the customer’s card on file).
-    # For more information, see [Manage Invoices Using the Invoices
-    # API](https://developer.squareup.com/docs/docs/invoices-api/overview).
     # @param [CreateInvoiceRequest] body Required parameter: An object
     # containing the fields to POST for the request.  See the corresponding
     # object definition for field details.
@@ -100,9 +95,6 @@ module Square
     # optionally one customer.
     # The response is paginated. If truncated, the response includes a `cursor`
     # that you use in a subsequent request to fetch the next set of invoices.
-    # For more information about retrieving invoices, see [Retrieve
-    # invoices](https://developer.squareup.com/docs/docs/invoices-api/overview#r
-    # etrieve-invoices).
     # @param [SearchInvoicesRequest] body Required parameter: An object
     # containing the fields to POST for the request.  See the corresponding
     # object definition for field details.
@@ -217,9 +209,6 @@ module Square
     # as specified in the request.
     # There are no restrictions to updating an invoice in a draft state.
     # However, there are guidelines for updating a published invoice.
-    # For more information, see [Update an
-    # invoice](https://developer.squareup.com/docs/docs/invoices-api/overview#up
-    # date-an-invoice).
     # @param [String] invoice_id Required parameter: The id of the invoice to
     # update.
     # @param [UpdateInvoiceRequest] body Required parameter: An object
@@ -313,10 +302,6 @@ module Square
     # Square emails the invoice or `PARTIALLY_PAID` if Square charge a card on
     # file for a portion of the
     # invoice amount).
-    # For more information, see
-    # [Create and publish an
-    # invoice](https://developer.squareup.com/docs/docs/invoices-api/overview#cr
-    # eate-and-publish-an-invoice).
     # @param [String] invoice_id Required parameter: The id of the invoice to
     # publish.
     # @param [PublishInvoiceRequest] body Required parameter: An object

data/lib/square/api/orders_api.rb

@@ -13,9 +13,6 @@ module Square
     # guide.
     # You can modify open orders using the
     # [UpdateOrder](#endpoint-orders-updateorder) endpoint.
-    # To learn more about the Orders API, see the
-    # [Orders API
-    # Overview](https://developer.squareup.com/docs/orders-api/what-it-does).
     # @param [CreateOrderRequest] body Required parameter: An object containing
     # the fields to POST for the request.  See the corresponding object
     # definition for field details.
@@ -177,9 +174,6 @@ module Square
     # To pay for an order, please refer to the [Pay for
     # Orders](https://developer.squareup.com/docs/orders-api/pay-for-orders)
     # guide.
-    # To learn more about the Orders API, see the
-    # [Orders API
-    # Overview](https://developer.squareup.com/docs/orders-api/what-it-does).
     # @param [String] order_id Required parameter: The ID of the order to
     # update.
     # @param [UpdateOrderRequest] body Required parameter: An object containing
@@ -237,8 +231,6 @@ module Square
     # layed-capture).
     # Using a delayed capture payment with PayOrder will complete the approved
     # payment.
-    # Learn how to [pay for orders with a single payment using the Payments
-    # API](https://developer.squareup.com/docs/orders-api/pay-for-orders).
     # @param [String] order_id Required parameter: The ID of the order being
     # paid.
     # @param [PayOrderRequest] body Required parameter: An object containing the

data/lib/square/api/payments_api.rb

@@ -22,14 +22,18 @@ module Square
     # [Pagination](https://developer.squareup.com/docs/basics/api101/pagination)
     # for more information.
     # @param [String] location_id Optional parameter: Limit results to the
-    # location supplied. By default, results are returned for all locations
-    # associated with the merchant.
+    # location supplied. By default, results are returned for the default (main)
+    # location 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`
     # card.
     # @param [String] card_brand Optional parameter: The brand of `Payment`
     # card. For example, `VISA`
+    # @param [Integer] limit Optional parameter: Maximum number of results to be
+    # returned in a single page. It is possible to receive fewer results than
+    # the specified limit on a given page.  If the supplied value is greater
+    # than 100, at most 100 results will be returned.  Default: `100`
     # @return [ListPaymentsResponse Hash] response from the API call
     def list_payments(begin_time: nil,
                       end_time: nil,
@@ -38,7 +42,8 @@ module Square
                       location_id: nil,
                       total: nil,
                       last_4: nil,
-                      card_brand: nil)
+                      card_brand: nil,
+                      limit: nil)
       # Prepare query url.
       _query_builder = config.get_base_uri
       _query_builder << '/v2/payments'
@@ -51,7 +56,8 @@ module Square
         'location_id' => location_id,
         'total' => total,
         'last_4' => last_4,
-        'card_brand' => card_brand
+        'card_brand' => card_brand,
+        'limit' => limit
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -82,9 +88,6 @@ module Square
     # For example, tip money, whether to autocomplete the payment, or a
     # reference ID
     # to correlate this payment with another system.
-    # For more information about these
-    # payment options, see [Take
-    # Payments](https://developer.squareup.com/docs/payments-api/take-payments).
     # The `PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS` OAuth permission is required
     # to enable application fees.
     # @param [CreatePaymentRequest] body Required parameter: An object
@@ -199,10 +202,7 @@ module Square
 
     # Cancels (voids) a payment. If you set `autocomplete` to false when
     # creating a payment,
-    # you can cancel the payment using this endpoint. For more information, see
-    # [Delayed
-    # Payments](https://developer.squareup.com/docs/payments-api/take-payments#d
-    # elayed-payments).
+    # you can cancel the payment using this endpoint.
     # @param [String] payment_id Required parameter: `payment_id` identifying
     # the payment to be canceled.
     # @return [CancelPaymentResponse Hash] response from the API call
@@ -240,10 +240,7 @@ module Square
     # created.
     # If you set autocomplete to false when creating a payment, you can complete
     # (capture)
-    # the payment using this endpoint. For more information, see
-    # [Delayed
-    # Payments](https://developer.squareup.com/docs/payments-api/take-payments#d
-    # elayed-payments).
+    # the payment using this endpoint.
     # @param [String] payment_id Required parameter: Unique ID identifying the
     # payment to be completed.
     # @return [CompletePaymentResponse Hash] response from the API call

data/lib/square/api/refunds_api.rb

@@ -32,6 +32,10 @@ module Square
     # with the given source type are returned. - `CARD` - List refunds only for
     # payments where card was specified as payment source.  Default: If omitted
     # refunds are returned regardless of source type.
+    # @param [Integer] limit Optional parameter: Maximum number of results to be
+    # returned in a single page. It is possible to receive fewer results than
+    # the specified limit on a given page.  If the supplied value is greater
+    # than 100, at most 100 results will be returned.  Default: `100`
     # @return [ListPaymentRefundsResponse Hash] response from the API call
     def list_payment_refunds(begin_time: nil,
                              end_time: nil,
@@ -39,7 +43,8 @@ module Square
                              cursor: nil,
                              location_id: nil,
                              status: nil,
-                             source_type: nil)
+                             source_type: nil,
+                             limit: nil)
       # Prepare query url.
       _query_builder = config.get_base_uri
       _query_builder << '/v2/refunds'
@@ -51,7 +56,8 @@ module Square
         'cursor' => cursor,
         'location_id' => location_id,
         'status' => status,
-        'source_type' => source_type
+        'source_type' => source_type,
+        'limit' => limit
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -75,9 +81,7 @@ module Square
     end
 
     # Refunds a payment. You can refund the entire payment amount or a
-    # portion of it. For more information, see
-    # [Payments and Refunds
-    # Overview](https://developer.squareup.com/docs/payments-api/overview).
+    # portion of it.
     # @param [RefundPaymentRequest] body Required parameter: An object
     # containing the fields to POST for the request.  See the corresponding
     # object definition for field details.

data/lib/square/client.rb

@@ -4,7 +4,7 @@ module Square
     attr_reader :config
 
     def sdk_version
-      '6.3.0.20200826'
+      '6.4.0.20200923'
     end
 
     def square_version
@@ -193,7 +193,7 @@ module Square
 
     def initialize(timeout: 60, max_retries: 0, retry_interval: 1,
                    backoff_factor: 1, environment: 'production',
-                   square_version: '2020-08-26', access_token: 'TODO: Replace',
+                   square_version: '2020-09-23', access_token: 'TODO: Replace',
                    additional_headers: {}, config: nil)
       @config = if config.nil?
                   Configuration.new(timeout: timeout, max_retries: max_retries,

data/lib/square/configuration.rb

@@ -22,7 +22,7 @@ module Square
 
     def initialize(timeout: 60, max_retries: 0, retry_interval: 1,
                    backoff_factor: 1, environment: 'production',
-                   square_version: '2020-08-26', access_token: 'TODO: Replace',
+                   square_version: '2020-09-23', access_token: 'TODO: Replace',
                    additional_headers: {})
       # The value to use for connection timeout
       @timeout = timeout

data/test/api/api_test_base.rb

@@ -1,8 +1,3 @@
-# square
-#
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
-
 require 'json'
 require 'minitest/autorun'
 require 'minitest/hell'
@@ -19,6 +14,6 @@ class ApiTestBase < Minitest::Test
   # Create configuration and set any test parameters
   CONFIG = Configuration.new(
     access_token: ENV.fetch('SQUARE_SANDBOX_TOKEN', 'AccessToken'),
-    environment: "sandbox"
+    environment: 'sandbox'
   )
 end

data/test/api/test_catalog_api.rb

@@ -1,7 +1,4 @@
-# square
-#
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
+
 
 require_relative 'api_test_base'
 

data/test/api/test_customers_api.rb

@@ -1,7 +1,4 @@
-# square
-#
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
+
 
 require_relative 'api_test_base'
 

data/test/api/test_employees_api.rb

@@ -1,7 +1,4 @@
-# square
-#
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
+
 
 require_relative 'api_test_base'
 

data/test/api/test_labor_api.rb

@@ -1,7 +1,4 @@
-# square
-#
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
+
 
 require_relative 'api_test_base'
 
@@ -35,12 +32,11 @@ class LaborApiTests < ApiTestBase
   # Returns a paginated list of `EmployeeWage` instances for a business.
   def test_list_employee_wages()
     # Parameters for the API call
-    employee_id = nil
     limit = nil
     cursor = nil
 
     # Perform the API call through the SDK function
-    result = @controller.list_employee_wages(employee_id: employee_id, limit: limit, cursor: cursor)
+    result = @controller.list_employee_wages(limit: limit, cursor: cursor)
 
     # Test response code
     assert_equal(200, @response_catcher.response.status_code)

data/test/api/test_locations_api.rb

@@ -1,35 +1,24 @@
-# square
-#
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
-
-require_relative 'api_test_base'
-
-class LocationsApiTests < ApiTestBase
-  # Called only once for the class before any test has executed
-  def setup
-    @response_catcher = HttpResponseCatcher.new
-    @controller = LocationsApi.new CONFIG, http_call_back: @response_catcher
-  end
-
-  # Provides the details for all of a business's locations.
+require_relative 'api_test_base'
+
+class LocationsApiTests < ApiTestBase
+  # Called only once for the class before any test has executed
+  def setup
+    @response_catcher = HttpResponseCatcher.new
+    @controller = LocationsApi.new CONFIG, http_call_back: @response_catcher
+  end
+
+  # Provides information of all locations of a business.
   #
   #Most other Connect API endpoints have a required `location_id` path parameter.
   #The `id` field of the [`Location`](#type-location) objects returned by this
-  #endpoint correspond to that `location_id` parameter.
-  def test_test_list_locations()
-
-    # Perform the API call through the SDK function
-    result = @controller.list_locations()
-
-    # Test response code
-    assert_equal(200, @response_catcher.response.status_code)
-
-    # Test headers
-    expected_headers = {}
-    expected_headers['content-type'] = 'application/json'
-
-    assert(TestHelper.match_headers(expected_headers, @response_catcher.response.headers))
-  end
-
-end
+  #endpoint correspond to that `location_id` parameter.
+  def test_list_locations()
+
+    # Perform the API call through the SDK function
+    result = @controller.list_locations()
+
+    # Test response code
+    assert_equal(200, @response_catcher.response.status_code)
+  end
+
+end

data/test/api/test_merchants_api.rb

@@ -1,7 +1,4 @@
-# square
-#
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
+
 
 require_relative 'api_test_base'
 

data/test/api/test_payments_api.rb

@@ -1,7 +1,4 @@
-# square
-#
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
+
 
 require_relative 'api_test_base'
 
@@ -12,8 +9,8 @@ class PaymentsApiTests < ApiTestBase
     @controller = PaymentsApi.new CONFIG, http_call_back: @response_catcher
   end
 
-  # Retrieves a list of payments taken by the account making the request.
-  #
+  # Retrieves a list of payments taken by the account making the request.
+  #
   #Max results per page: 100
   def test_test_list_payments()
     # Parameters for the API call

data/test/api/test_refunds_api.rb

@@ -1,7 +1,4 @@
-# square
-#
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
+
 
 require_relative 'api_test_base'
 
@@ -12,8 +9,8 @@ class RefundsApiTests < ApiTestBase
     @controller = RefundsApi.new CONFIG, http_call_back: @response_catcher
   end
 
-  # Retrieves a list of refunds for the account making the request.
-  #
+  # Retrieves a list of refunds for the account making the request.
+  #
   #Max results per page: 100
   def test_test_list_payment_refunds()
     # Parameters for the API call

data/test/http_response_catcher.rb

@@ -1,8 +1,3 @@
-# square
-#
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
-
 class HttpResponseCatcher < Square::HttpCallBack
   attr_accessor :response
 

data/test/test_helper.rb

@@ -1,8 +1,3 @@
-# square
-#
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
-
 require 'tempfile'
 require 'open-uri'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: square.rb
 version: !ruby/object:Gem::Version
-  version: 6.3.0.20200826
+  version: 6.4.0.20200923
 platform: ruby
 authors:
 - Square Developer Platform
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-08-26 00:00:00.000000000 Z
+date: 2020-09-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logging
@@ -16,42 +16,48 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: '2.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: '2.3'
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.15'
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.15'
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.1
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.13'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.13'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: certifi
   requirement: !ruby/object:Gem::Requirement
@@ -59,6 +65,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2018.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2018.01.18
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -66,34 +75,43 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2018.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2018.01.18
 - !ruby/object:Gem::Dependency
   name: faraday-http-cache
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.2'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '5.14'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.14.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '5.14'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.14.1
 - !ruby/object:Gem::Dependency
   name: minitest-proveit
   requirement: !ruby/object:Gem::Requirement