square.rb 9.0.0.20210226 → 11.0.0.20210513

data/lib/square/api/transactions_api.rb

@@ -12,24 +12,29 @@ module Square
     # Point of Sale applications.
     # Refunds with a `status` of `PENDING` are not currently included in this
     # endpoint's response.
-    # Max results per [page](#paginatingresults): 50
+    # Max results per
+    # [page](https://developer.squareup.com/docs/working-with-apis/pagination):
+    # 50
     # @param [String] location_id Required parameter: The ID of the location to
     # list refunds for.
     # @param [String] begin_time Optional parameter: The beginning of the
     # requested reporting period, in RFC 3339 format.  See [Date
-    # ranges](#dateranges) for details on date inclusivity/exclusivity.  Default
-    # value: The current time minus one year.
+    # ranges](https://developer.squareup.com/docs/build-basics/working-with-date
+    # s) for details on date inclusivity/exclusivity.  Default value: The
+    # current time minus one year.
     # @param [String] end_time Optional parameter: The end of the requested
-    # reporting period, in RFC 3339 format.  See [Date ranges](#dateranges) for
-    # details on date inclusivity/exclusivity.  Default value: The current
-    # time.
+    # reporting period, in RFC 3339 format.  See [Date
+    # ranges](https://developer.squareup.com/docs/build-basics/working-with-date
+    # s) for details on date inclusivity/exclusivity.  Default value: The
+    # current time.
     # @param [SortOrder] sort_order Optional parameter: The order in which
     # results are listed in the response (`ASC` for oldest first, `DESC` for
     # newest first).  Default value: `DESC`
     # @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.
     # @return [ListRefundsResponse Hash] response from the API call
     def list_refunds(location_id:,
                      begin_time: nil,
@@ -78,24 +83,29 @@ module Square
     # Transactions include payment information from sales and exchanges and
     # refund
     # information from returns and exchanges.
-    # Max results per [page](#paginatingresults): 50
+    # Max results per
+    # [page](https://developer.squareup.com/docs/working-with-apis/pagination):
+    # 50
     # @param [String] location_id Required parameter: The ID of the location to
     # list transactions for.
     # @param [String] begin_time Optional parameter: The beginning of the
     # requested reporting period, in RFC 3339 format.  See [Date
-    # ranges](#dateranges) for details on date inclusivity/exclusivity.  Default
-    # value: The current time minus one year.
+    # ranges](https://developer.squareup.com/docs/build-basics/working-with-date
+    # s) for details on date inclusivity/exclusivity.  Default value: The
+    # current time minus one year.
     # @param [String] end_time Optional parameter: The end of the requested
-    # reporting period, in RFC 3339 format.  See [Date ranges](#dateranges) for
-    # details on date inclusivity/exclusivity.  Default value: The current
-    # time.
+    # reporting period, in RFC 3339 format.  See [Date
+    # ranges](https://developer.squareup.com/docs/build-basics/working-with-date
+    # s) for details on date inclusivity/exclusivity.  Default value: The
+    # current time.
     # @param [SortOrder] sort_order Optional parameter: The order in which
     # results are listed in the response (`ASC` for oldest first, `DESC` for
     # newest first).  Default value: `DESC`
     # @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.
     # @return [ListTransactionsResponse Hash] response from the API call
     def list_transactions(location_id:,
                           begin_time: nil,
@@ -156,9 +166,9 @@ module Square
     # When this response is returned, the amount of Square's processing fee
     # might not yet be
     # calculated. To obtain the processing fee, wait about ten seconds and call
-    # [RetrieveTransaction](#endpoint-retrievetransaction). See the
+    # [RetrieveTransaction]($e/Transactions/RetrieveTransaction). See the
     # `processing_fee_money`
-    # field of each [Tender included](#type-tender) in the transaction.
+    # field of each [Tender included]($m/Tender) in the transaction.
     # @param [String] location_id Required parameter: The ID of the location to
     # associate the created transaction with.
     # @param [ChargeRequest] body Required parameter: An object containing the
@@ -241,7 +251,7 @@ module Square
     end
 
     # Captures a transaction that was created with the
-    # [Charge](#endpoint-charge)
+    # [Charge]($e/Transactions/Charge)
     # endpoint with a `delay_capture` value of `true`.
     # See [Delayed capture
     # transactions](https://developer.squareup.com/docs/payments/transactions/ov
@@ -337,7 +347,8 @@ module Square
       )
     end
 
-    # Cancels a transaction that was created with the [Charge](#endpoint-charge)
+    # Cancels a transaction that was created with the
+    # [Charge]($e/Transactions/Charge)
     # endpoint with a `delay_capture` value of `true`.
     # See [Delayed capture
     # transactions](https://developer.squareup.com/docs/payments/transactions/ov

data/lib/square/api/v1_employees_api.rb

@@ -247,7 +247,8 @@ module Square
     # employee with that role. For example, an employee with a "Shift Manager"
     # role might be able to issue refunds in Square Point of Sale, whereas an
     # employee with a "Clerk" role might not.
-    # Roles are assigned with the [V1UpdateEmployee](#endpoint-v1updateemployee)
+    # Roles are assigned with the
+    # [V1UpdateEmployee]($e/V1Employees/UpdateEmployeeRole)
     # endpoint. An employee can have only one role at a time.
     # If an employee has no role, they have none of the permissions associated
     # with roles. All employees can accept payments with Square Point of Sale.

data/lib/square/api/v1_transactions_api.rb

@@ -20,6 +20,7 @@ module Square
                     order: nil,
                     limit: nil,
                     batch_token: nil)
+      warn 'Endpoint list_orders in V1TransactionsApi is deprecated'
       # Prepare query url.
       _query_builder = config.get_base_uri
       _query_builder << '/v1/{location_id}/orders'
@@ -66,6 +67,7 @@ module Square
     # @return [V1Order Hash] response from the API call
     def retrieve_order(location_id:,
                        order_id:)
+      warn 'Endpoint retrieve_order in V1TransactionsApi is deprecated'
       # Prepare query url.
       _query_builder = config.get_base_uri
       _query_builder << '/v1/{location_id}/orders/{order_id}'
@@ -111,6 +113,7 @@ module Square
     def update_order(location_id:,
                      order_id:,
                      body:)
+      warn 'Endpoint update_order in V1TransactionsApi is deprecated'
       # Prepare query url.
       _query_builder = config.get_base_uri
       _query_builder << '/v1/{location_id}/orders/{order_id}'
@@ -184,6 +187,7 @@ module Square
                       limit: nil,
                       batch_token: nil,
                       include_partial: false)
+      warn 'Endpoint list_payments in V1TransactionsApi is deprecated'
       # Prepare query url.
       _query_builder = config.get_base_uri
       _query_builder << '/v1/{location_id}/payments'
@@ -233,6 +237,7 @@ module Square
     # @return [V1Payment Hash] response from the API call
     def retrieve_payment(location_id:,
                          payment_id:)
+      warn 'Endpoint retrieve_payment in V1TransactionsApi is deprecated'
       # Prepare query url.
       _query_builder = config.get_base_uri
       _query_builder << '/v1/{location_id}/payments/{payment_id}'
@@ -294,6 +299,7 @@ module Square
                      end_time: nil,
                      limit: nil,
                      batch_token: nil)
+      warn 'Endpoint list_refunds in V1TransactionsApi is deprecated'
       # Prepare query url.
       _query_builder = config.get_base_uri
       _query_builder << '/v1/{location_id}/refunds'
@@ -350,6 +356,7 @@ module Square
     # @return [V1Refund Hash] response from the API call
     def create_refund(location_id:,
                       body:)
+      warn 'Endpoint create_refund in V1TransactionsApi is deprecated'
       # Prepare query url.
       _query_builder = config.get_base_uri
       _query_builder << '/v1/{location_id}/refunds'
@@ -417,6 +424,7 @@ module Square
                          limit: nil,
                          status: nil,
                          batch_token: nil)
+      warn 'Endpoint list_settlements in V1TransactionsApi is deprecated'
       # Prepare query url.
       _query_builder = config.get_base_uri
       _query_builder << '/v1/{location_id}/settlements'
@@ -479,6 +487,7 @@ module Square
     # @return [V1Settlement Hash] response from the API call
     def retrieve_settlement(location_id:,
                             settlement_id:)
+      warn 'Endpoint retrieve_settlement in V1TransactionsApi is deprecated'
       # Prepare query url.
       _query_builder = config.get_base_uri
       _query_builder << '/v1/{location_id}/settlements/{settlement_id}'

data/lib/square/api_helper.rb

@@ -63,9 +63,7 @@ module Square
     # Appends the given set of parameters to the given query string.
     # @param [String] The query string builder to add the query parameters to.
     # @param [Hash] The parameters to append.
-    # @param [String] The format of array parameter serialization.
-    def self.append_url_with_query_parameters(query_builder, parameters,
-                                              array_serialization: 'indexed')
+    def self.append_url_with_query_parameters(query_builder, parameters)
       # Perform parameter validation.
       unless query_builder.instance_of? String
         raise ArgumentError, 'Given value for parameter \"query_builder\"
@@ -75,6 +73,8 @@ module Square
       # Return if there are no parameters to replace.
       return query_builder if parameters.nil?
 
+      array_serialization = 'indexed'
+
       parameters.each do |key, value|
         seperator = query_builder.include?('?') ? '&' : '?'
         unless value.nil?
@@ -151,8 +151,8 @@ module Square
     # Form encodes a hash of parameters.
     # @param [Hash] The hash of parameters to encode.
     # @return [Hash] A hash with the same parameters form encoded.
-    def self.form_encode_parameters(form_parameters,
-                                    array_serialization: 'indexed')
+    def self.form_encode_parameters(form_parameters)
+      array_serialization = 'indexed'
       encoded = {}
       form_parameters.each do |key, value|
         encoded.merge!(APIHelper.form_encode(value, key, formatting:

data/lib/square/client.rb

@@ -4,7 +4,7 @@ module Square
     attr_reader :config
 
     def sdk_version
-      '9.0.0.20210226'
+      '11.0.0.20210513'
     end
 
     def square_version
@@ -167,6 +167,18 @@ module Square
       @refunds ||= RefundsApi.new config
     end
 
+    # Access to sites controller.
+    # @return [SitesApi] Returns the controller instance.
+    def sites
+      @sites ||= SitesApi.new config
+    end
+
+    # Access to snippets controller.
+    # @return [SnippetsApi] Returns the controller instance.
+    def snippets
+      @snippets ||= SnippetsApi.new config
+    end
+
     # Access to subscriptions controller.
     # @return [SubscriptionsApi] Returns the controller instance.
     def subscriptions
@@ -188,7 +200,7 @@ module Square
     def initialize(timeout: 60, max_retries: 0, retry_interval: 1,
                    backoff_factor: 1, environment: 'production',
                    custom_url: 'https://connect.squareup.com',
-                   square_version: '2021-02-26', access_token: 'TODO: Replace',
+                   square_version: '2021-05-13', 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

@@ -24,7 +24,7 @@ module Square
     def initialize(timeout: 60, max_retries: 0, retry_interval: 1,
                    backoff_factor: 1, environment: 'production',
                    custom_url: 'https://connect.squareup.com',
-                   square_version: '2021-02-26', access_token: 'TODO: Replace',
+                   square_version: '2021-05-13', access_token: 'TODO: Replace',
                    additional_headers: {})
       # The value to use for connection timeout
       @timeout = timeout

data/test/api/test_locations_api.rb

@@ -10,7 +10,7 @@ class LocationsApiTests < ApiTestBase
   # Provides information of all locations of a business.
   #
   #Many Square API endpoints require a `location_id` parameter.
-  #The `id` field of the [`Location`](#type-location) objects returned by this
+  #The `id` field of the [`Location`]($m/Location) objects returned by this
   #endpoint correspond to that `location_id` parameter.
   def test_list_locations()
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: square.rb
 version: !ruby/object:Gem::Version
-  version: 9.0.0.20210226
+  version: 11.0.0.20210513
 platform: ruby
 authors:
 - Square Developer Platform
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-02-26 00:00:00.000000000 Z
+date: 2021-05-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logging
@@ -160,6 +160,8 @@ files:
 - lib/square/api/orders_api.rb
 - lib/square/api/payments_api.rb
 - lib/square/api/refunds_api.rb
+- lib/square/api/sites_api.rb
+- lib/square/api/snippets_api.rb
 - lib/square/api/subscriptions_api.rb
 - lib/square/api/team_api.rb
 - lib/square/api/terminal_api.rb