square.rb 9.1.0.20210317 → 12.0.0.20210616

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.1.0.20210317'
+      '12.0.0.20210616'
     end
 
     def square_version
@@ -53,6 +53,12 @@ module Square
       @bookings ||= BookingsApi.new config
     end
 
+    # Access to cards controller.
+    # @return [CardsApi] Returns the controller instance.
+    def cards
+      @cards ||= CardsApi.new config
+    end
+
     # Access to cash_drawers controller.
     # @return [CashDrawersApi] Returns the controller instance.
     def cash_drawers
@@ -101,6 +107,18 @@ module Square
       @employees ||= EmployeesApi.new config
     end
 
+    # Access to gift_cards controller.
+    # @return [GiftCardsApi] Returns the controller instance.
+    def gift_cards
+      @gift_cards ||= GiftCardsApi.new config
+    end
+
+    # Access to gift_card_activities controller.
+    # @return [GiftCardActivitiesApi] Returns the controller instance.
+    def gift_card_activities
+      @gift_card_activities ||= GiftCardActivitiesApi.new config
+    end
+
     # Access to inventory controller.
     # @return [InventoryApi] Returns the controller instance.
     def inventory
@@ -167,6 +185,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
@@ -186,14 +216,18 @@ module Square
     end
 
     def initialize(timeout: 60, max_retries: 0, retry_interval: 1,
-                   backoff_factor: 1, environment: 'production',
+                   backoff_factor: 2,
+                   retry_statuses: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524],
+                   retry_methods: %i[get put], environment: 'production',
                    custom_url: 'https://connect.squareup.com',
-                   square_version: '2021-03-17', access_token: 'TODO: Replace',
+                   square_version: '2021-06-16', access_token: 'TODO: Replace',
                    additional_headers: {}, config: nil)
       @config = if config.nil?
                   Configuration.new(timeout: timeout, max_retries: max_retries,
                                     retry_interval: retry_interval,
                                     backoff_factor: backoff_factor,
+                                    retry_statuses: retry_statuses,
+                                    retry_methods: retry_methods,
                                     environment: environment,
                                     custom_url: custom_url,
                                     square_version: square_version,

data/lib/square/configuration.rb

@@ -8,6 +8,8 @@ module Square
     attr_reader :max_retries
     attr_reader :retry_interval
     attr_reader :backoff_factor
+    attr_reader :retry_statuses
+    attr_reader :retry_methods
     attr_reader :environment
     attr_reader :custom_url
     attr_reader :square_version
@@ -22,9 +24,11 @@ module Square
     end
 
     def initialize(timeout: 60, max_retries: 0, retry_interval: 1,
-                   backoff_factor: 1, environment: 'production',
+                   backoff_factor: 2,
+                   retry_statuses: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524],
+                   retry_methods: %i[get put], environment: 'production',
                    custom_url: 'https://connect.squareup.com',
-                   square_version: '2021-03-17', access_token: 'TODO: Replace',
+                   square_version: '2021-06-16', access_token: 'TODO: Replace',
                    additional_headers: {})
       # The value to use for connection timeout
       @timeout = timeout
@@ -39,6 +43,12 @@ module Square
       # by in order to provide backoff
       @backoff_factor = backoff_factor
 
+      # A list of HTTP statuses to retry
+      @retry_statuses = retry_statuses
+
+      # A list of HTTP methods to retry
+      @retry_methods = retry_methods
+
       # Current API environment
       @environment = String(environment)
 
@@ -59,13 +69,15 @@ module Square
     end
 
     def clone_with(timeout: nil, max_retries: nil, retry_interval: nil,
-                   backoff_factor: nil, environment: nil, custom_url: nil,
-                   square_version: nil, access_token: nil,
-                   additional_headers: nil)
+                   backoff_factor: nil, retry_statuses: nil, retry_methods: nil,
+                   environment: nil, custom_url: nil, square_version: nil,
+                   access_token: nil, additional_headers: nil)
       timeout ||= self.timeout
       max_retries ||= self.max_retries
       retry_interval ||= self.retry_interval
       backoff_factor ||= self.backoff_factor
+      retry_statuses ||= self.retry_statuses
+      retry_methods ||= self.retry_methods
       environment ||= self.environment
       custom_url ||= self.custom_url
       square_version ||= self.square_version
@@ -75,8 +87,9 @@ module Square
       Configuration.new(timeout: timeout, max_retries: max_retries,
                         retry_interval: retry_interval,
                         backoff_factor: backoff_factor,
-                        environment: environment, custom_url: custom_url,
-                        square_version: square_version,
+                        retry_statuses: retry_statuses,
+                        retry_methods: retry_methods, environment: environment,
+                        custom_url: custom_url, square_version: square_version,
                         access_token: access_token,
                         additional_headers: additional_headers)
     end
@@ -84,7 +97,9 @@ module Square
     def create_http_client
       FaradayClient.new(timeout: timeout, max_retries: max_retries,
                         retry_interval: retry_interval,
-                        backoff_factor: backoff_factor)
+                        backoff_factor: backoff_factor,
+                        retry_statuses: retry_statuses,
+                        retry_methods: retry_methods)
     end
 
     # All the environments the SDK can run in.

data/lib/square/http/faraday_client.rb

@@ -6,7 +6,8 @@ module Square
   class FaradayClient < HttpClient
     # The constructor.
     def initialize(timeout:, max_retries:, retry_interval:,
-                   backoff_factor:, cache: false, verify: true)
+                   backoff_factor:, retry_statuses:, retry_methods:,
+                   cache: false, verify: true)
       @connection = Faraday.new do |faraday|
         faraday.use Faraday::HttpCache, serializer: Marshal if cache
         faraday.use FaradayMiddleware::FollowRedirects
@@ -16,7 +17,9 @@ module Square
         faraday.ssl[:ca_file] = Certifi.where
         faraday.ssl[:verify] = verify
         faraday.request :retry, max: max_retries, interval: retry_interval,
-                                backoff_factor: backoff_factor
+                                backoff_factor: backoff_factor,
+                                retry_statuses: retry_statuses,
+                                methods: retry_methods
         faraday.adapter Faraday.default_adapter
         faraday.options[:params_encoder] = Faraday::FlatParamsEncoder
         faraday.options[:timeout] = timeout if timeout > 0

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.1.0.20210317
+  version: 12.0.0.20210616
 platform: ruby
 authors:
 - Square Developer Platform
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-17 00:00:00.000000000 Z
+date: 2021-06-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logging
@@ -31,9 +31,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
-    - - ">="
+    - - "<="
       - !ruby/object:Gem::Version
-        version: 1.0.1
+        version: 1.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -41,9 +41,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
-    - - ">="
+    - - "<="
       - !ruby/object:Gem::Version
-        version: 1.0.1
+        version: 1.3.0
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
   requirement: !ruby/object:Gem::Requirement
@@ -140,6 +140,7 @@ files:
 - lib/square/api/bank_accounts_api.rb
 - lib/square/api/base_api.rb
 - lib/square/api/bookings_api.rb
+- lib/square/api/cards_api.rb
 - lib/square/api/cash_drawers_api.rb
 - lib/square/api/catalog_api.rb
 - lib/square/api/checkout_api.rb
@@ -149,6 +150,8 @@ files:
 - lib/square/api/devices_api.rb
 - lib/square/api/disputes_api.rb
 - lib/square/api/employees_api.rb
+- lib/square/api/gift_card_activities_api.rb
+- lib/square/api/gift_cards_api.rb
 - lib/square/api/inventory_api.rb
 - lib/square/api/invoices_api.rb
 - lib/square/api/labor_api.rb
@@ -160,6 +163,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