square.rb 11.0.0.20210513 → 12.0.0.20210616

data/lib/square/api/team_api.rb

@@ -5,12 +5,12 @@ module Square
       super(config, http_call_back: http_call_back)
     end
 
-    # Creates a single `TeamMember` object. The `TeamMember` will be returned on
-    # successful creates.
+    # Creates a single `TeamMember` object. The `TeamMember` object is returned
+    # on successful creates.
     # You must provide the following values in your request to this endpoint:
     # - `given_name`
     # - `family_name`
-    # Learn about [Troubleshooting the Teams
+    # Learn about [Troubleshooting the Team
     # API](https://developer.squareup.com/docs/team/troubleshooting#createteamme
     # mber).
     # @param [CreateTeamMemberRequest] body Required parameter: An object
@@ -47,13 +47,13 @@ module Square
     end
 
     # Creates multiple `TeamMember` objects. The created `TeamMember` objects
-    # will be returned on successful creates.
-    # This process is non-transactional and will process as much of the request
-    # as is possible. If one of the creates in
-    # the request cannot be successfully processed, the request will NOT be
-    # marked as failed, but the body of the response
-    # will contain explicit error information for this particular create.
-    # Learn about [Troubleshooting the Teams
+    # are returned on successful creates.
+    # This process is non-transactional and processes as much of the request as
+    # possible. If one of the creates in
+    # the request cannot be successfully processed, the request is not marked as
+    # failed, but the body of the response
+    # contains explicit error information for the failed create.
+    # Learn about [Troubleshooting the Team
     # API](https://developer.squareup.com/docs/team/troubleshooting#bulk-create-
     # team-members).
     # @param [BulkCreateTeamMembersRequest] body Required parameter: An object
@@ -90,13 +90,13 @@ module Square
     end
 
     # Updates multiple `TeamMember` objects. The updated `TeamMember` objects
-    # will be returned on successful updates.
-    # This process is non-transactional and will process as much of the request
-    # as is possible. If one of the updates in
-    # the request cannot be successfully processed, the request will NOT be
-    # marked as failed, but the body of the response
-    # will contain explicit error information for this particular update.
-    # Learn about [Troubleshooting the Teams
+    # are returned on successful updates.
+    # This process is non-transactional and processes as much of the request as
+    # possible. If one of the updates in
+    # the request cannot be successfully processed, the request is not marked as
+    # failed, but the body of the response
+    # contains explicit error information for the failed update.
+    # Learn about [Troubleshooting the Team
     # API](https://developer.squareup.com/docs/team/troubleshooting#bulk-update-
     # team-members).
     # @param [BulkUpdateTeamMembersRequest] body Required parameter: An object
@@ -133,8 +133,8 @@ module Square
     end
 
     # Returns a paginated list of `TeamMember` objects for a business.
-    # The list to be returned can be filtered by:
-    # - location IDs **and**
+    # The list can be filtered by the following:
+    # - location IDs
     # - `status`
     # @param [SearchTeamMembersRequest] body Required parameter: An object
     # containing the fields to POST for the request.  See the corresponding
@@ -169,8 +169,8 @@ module Square
       )
     end
 
-    # Retrieve a `TeamMember` object for the given `TeamMember.id`.
-    # Learn about [Troubleshooting the Teams
+    # Retrieves a `TeamMember` object for the given `TeamMember.id`.
+    # Learn about [Troubleshooting the Team
     # API](https://developer.squareup.com/docs/team/troubleshooting#retrieve-a-t
     # eam-member).
     # @param [String] team_member_id Required parameter: The ID of the team
@@ -207,9 +207,9 @@ module Square
       )
     end
 
-    # Updates a single `TeamMember` object. The `TeamMember` will be returned on
-    # successful updates.
-    # Learn about [Troubleshooting the Teams
+    # Updates a single `TeamMember` object. The `TeamMember` object is returned
+    # on successful updates.
+    # Learn about [Troubleshooting the Team
     # API](https://developer.squareup.com/docs/team/troubleshooting#update-a-tea
     # m-member).
     # @param [String] team_member_id Required parameter: The ID of the team
@@ -252,13 +252,13 @@ module Square
       )
     end
 
-    # Retrieve a `WageSetting` object for a team member specified
+    # Retrieves a `WageSetting` object for a team member specified
     # by `TeamMember.id`.
-    # Learn about [Troubleshooting the Teams
+    # Learn about [Troubleshooting the Team
     # API](https://developer.squareup.com/docs/team/troubleshooting#retrievewage
     # setting).
     # @param [String] team_member_id Required parameter: The ID of the team
-    # member to retrieve wage setting for
+    # member for which to retrieve the wage setting.
     # @return [RetrieveWageSettingResponse Hash] response from the API call
     def retrieve_wage_setting(team_member_id:)
       # Prepare query url.
@@ -295,12 +295,12 @@ module Square
     # `WageSetting` with the specified `team_member_id` does not exist.
     # Otherwise,
     # it fully replaces the `WageSetting` object for the team member.
-    # The `WageSetting` will be returned upon successful update.
-    # Learn about [Troubleshooting the Teams
+    # The `WageSetting` is returned on a successful update.
+    # Learn about [Troubleshooting the Team
     # API](https://developer.squareup.com/docs/team/troubleshooting#create-or-up
     # date-a-wage-setting).
     # @param [String] team_member_id Required parameter: The ID of the team
-    # member to update the `WageSetting` object for.
+    # member for which to update the `WageSetting` object.
     # @param [UpdateWageSettingRequest] body Required parameter: An object
     # containing the fields to POST for the request.  See the corresponding
     # object definition for field details.

data/lib/square/api/transactions_api.rb

@@ -152,8 +152,9 @@ module Square
 
     # Charges a card represented by a card nonce or a customer's card on file.
     # Your request to this endpoint must include _either_:
-    # - A value for the `card_nonce` parameter (to charge a card nonce generated
-    # with the `SqPaymentForm`)
+    # - A value for the `card_nonce` parameter (to charge a card payment token
+    # generated
+    # with the Web Payments SDK)
     # - Values for the `customer_card_id` and `customer_id` parameters (to
     # charge
     # a customer's card on file)

data/lib/square/client.rb

@@ -4,7 +4,7 @@ module Square
     attr_reader :config
 
     def sdk_version
-      '11.0.0.20210513'
+      '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
@@ -198,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-05-13', 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-05-13', 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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: square.rb
 version: !ruby/object:Gem::Version
-  version: 11.0.0.20210513
+  version: 12.0.0.20210616
 platform: ruby
 authors:
 - Square Developer Platform
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-05-13 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