square.rb 14.1.0.20210915 → 15.0.0.20211020

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cb09b4404e4f7f5cb0923e135ada308b9a9c3482106b0ab8cc2e80eee63f8de0
-  data.tar.gz: fc7d73e6a5d955857fe4bfb4341a75cdd80764f3cced0e19afbbb37cdca4d9bb
+  metadata.gz: 25322287d3387bc053e23f58c5a3b74476789df2145f9648f46b330517aa7574
+  data.tar.gz: a5476f517732ce5df169b402fded9909cefa155e02c90d9af5996e4dc087a887
 SHA512:
-  metadata.gz: fcf0ff7ca1313121f98083f32cdf8201c30be1814a7f7f6aac89c09e752e129a92ba1f5117f9049559d835846a3e49abfc1d83c906a59c362b8fd05e2c31fbf6
-  data.tar.gz: 2870c75eef04c8798e3699c17a4e88296bfe144400b81c7bf4463c0d3bcface04ef151cae4a0b0349266890d16485a4257d5aa4756d4985684dceb789021b0eb
+  metadata.gz: 2d30c67ff2493a1dded81c4078d3549c0c195f092f9826735cd1f98bb6749153bd45d6614419f95f6d6fb32ed505459abc11ab0508b3fa51f0ad089f8a0cce51
+  data.tar.gz: 2b4a9e0bdb771a3658ec3a46b9838421c154ff1b280da9d27e589111dbb010c2d3c5672ae38d5b22e52ae26f864ae6d8cd76e53effc65e65fdefafcf0b949aa4

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright 2121 Square, Inc.
+Copyright 2021 Square, Inc.
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
 You may obtain a copy of the License at

data/README.md

@@ -115,8 +115,8 @@ require 'square'
 # for the Square account whose assets you want to manage.
 
 client = Square::Client.new(
-    access_token: 'YOUR SANDBOX ACCESS TOKEN HERE',
-    environment: 'sandbox'
+  access_token: 'YOUR SANDBOX ACCESS TOKEN HERE',
+  environment: 'sandbox'
 )
 
 # Call list_locations method to get all locations in this Square account
@@ -124,10 +124,10 @@ result = client.locations.list_locations
 
 # Call the #success? method to see if the call succeeded
 if result.success?
-	# The #data Struct contains a list of locations
+  # The #data Struct contains a list of locations
   locations = result.data.locations
 
-	# Iterate over the list
+  # Iterate over the list
   locations.each do |location|
     # Each location is represented as a Hash
     location.each do |key, value|
@@ -176,6 +176,7 @@ This error was returned when an invalid token was used to call the API.
 After you’ve tried out the Square APIs and tested your application using sandbox, you will want to switch to your production credentials so that you can manage real Square resources. Don't forget to switch your access token from sandbox to production for real data.
 
 ## SDK patterns
+
 If you know a few patterns, you’ll be able to call any API in the SDK. Here are some important ones:
 
 ### Get an access token
@@ -196,30 +197,31 @@ To use the Square API, you import the Client class, instantiate a Client object,
 
 - Instantiate a `Square::Client` object with the access token for the Square account whose resources you want to manage. To access sandbox resources, initialize the `Square::Client` with environment set to sandbox:
 
-```ruby
-client = Square::Client.new(
+  ```ruby
+  client = Square::Client.new(
     access_token: 'SANDBOX ACCESS TOKEN HERE',
     environment: 'sandbox'
-)
-```
+  )
+  ```
 
 - To access production resources, set environment to production:
 
-```ruby
-client = Square::Client.new(
+  ```ruby
+  client = Square::Client.new(
     access_token: 'ACCESS TOKEN HERE',
     environment: 'production'
-)
-```
+  )
+  ```
 
 - To set a custom environment provide a `custom_url`, and set environment to `custom`:
 
-```ruby
-client = Square::Client.new(
+  ```ruby
+  client = Square::Client.new(
     access_token:'ACCESS TOKEN HERE',
     environment: 'custom',
     custom_url: 'https://your.customdomain.com'
-)
+  )
+  ```
  
 ### Get an Instance of an API object and call its methods
 
@@ -227,9 +229,9 @@ Each API is implemented as a class. The Client object instantiates every API cla
 
 - Work with an API by calling the methods on the API object. For example, you would call list_customers to get a list of all customers in the Square account:
 
-```ruby
-result = client.customers.list_customers
-```
+  ```ruby
+  result = client.customers.list_customers
+  ```
 
 See the SDK documentation for the list of methods for each API class.
 
@@ -250,6 +252,7 @@ result = client.customers.create_customer(request_body)
 ```
 
 If your call succeeds, you’ll see a response that looks like this:
+
 ```
 {'customer': {'created_at': '2019-06-28T21:23:05.126Z', 'creation_source': 'THIRD_PARTY', 'family_name': 'Earhardt', 'given_name': 'Amelia', 'id': 'CBASEDwl3El91nohQ2FLEk4aBfcgAQ', 'preferences': {'email_unsubscribed': False}, 'updated_at': '2019-06-28T21:23:05.126Z'}}
 ```
@@ -274,7 +277,7 @@ end
 
 ## Tests
 
-First, clone the gem locally and `cd` into the directory.
+First, clone the repo locally and `cd` into the directory.
 
 ```sh
 git clone https://github.com/square/square-ruby-sdk.git
@@ -346,4 +349,4 @@ You can also use the Square API to create applications or services that work wit
 [Snippets]: doc/api/snippets.md
 [Cards]: doc/api/cards.md
 [Gift Cards]: doc/api/gift-cards.md
-[Gift Card Activities]: doc/api/gift-card-activities.md
+[Gift Card Activities]: doc/api/gift-card-activities.md

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/14.1.0.20210915',
+        'user-agent' => 'Square-Ruby-SDK/15.0.0.20211020',
         'Square-Version' => config.square_version
       }
     end
@@ -24,9 +24,7 @@ module Square
 
       APIHelper.clean_hash(request.headers)
       request.headers.merge!(@global_headers)
-      unless config.additional_headers.nil?
-        request.headers.merge!(config.additional_headers)
-      end
+      request.headers.merge!(config.additional_headers) unless config.additional_headers.nil?
 
       response = if binary
                    config.http_client.execute_as_binary(request)

data/lib/square/api/customer_groups_api.rb

@@ -13,7 +13,7 @@ module Square
     # ion).
     # @param [Integer] limit Optional parameter: The maximum number of results
     # to return in a single page. This limit is advisory. The response might
-    # contain more or fewer results.  The limit is ignored if it is less than 1
+    # contain more or fewer results. The limit is ignored if it is less than 1
     # or greater than 50. The default value is 50.  For more information, see
     # [Pagination](https://developer.squareup.com/docs/working-with-apis/paginat
     # ion).

data/lib/square/api/customer_segments_api.rb

@@ -13,7 +13,7 @@ module Square
     # ion).
     # @param [Integer] limit Optional parameter: The maximum number of results
     # to return in a single page. This limit is advisory. The response might
-    # contain more or fewer results.  The limit is ignored if it is less than 1
+    # contain more or fewer results. The limit is ignored if it is less than 1
     # or greater than 50. The default value is 50.  For more information, see
     # [Pagination](https://developer.squareup.com/docs/working-with-apis/paginat
     # ion).

data/lib/square/api/customers_api.rb

@@ -19,7 +19,7 @@ module Square
     # ion).
     # @param [Integer] limit Optional parameter: The maximum number of results
     # to return in a single page. This limit is advisory. The response might
-    # contain more or fewer results.  The limit is ignored if it is less than 1
+    # contain more or fewer results. The limit is ignored if it is less than 1
     # or greater than 100. The default value is 100.  For more information, see
     # [Pagination](https://developer.squareup.com/docs/working-with-apis/paginat
     # ion).

data/lib/square/api/payments_api.rb

@@ -296,8 +296,12 @@ module Square
     # `status`.
     # @param [String] payment_id Required parameter: The unique ID identifying
     # the payment to be completed.
+    # @param [CompletePaymentRequest] body Required parameter: An object
+    # containing the fields to POST for the request.  See the corresponding
+    # object definition for field details.
     # @return [CompletePaymentResponse Hash] response from the API call
-    def complete_payment(payment_id:)
+    def complete_payment(payment_id:,
+                         body:)
       # Prepare query url.
       _query_builder = config.get_base_uri
       _query_builder << '/v2/payments/{payment_id}/complete'
@@ -309,13 +313,15 @@ module Square
 
       # Prepare headers.
       _headers = {
-        'accept' => 'application/json'
+        'accept' => 'application/json',
+        'content-type' => 'application/json; charset=utf-8'
       }
 
       # Prepare and execute HttpRequest.
       _request = config.http_client.post(
         _query_url,
-        headers: _headers
+        headers: _headers,
+        parameters: body.to_json
       )
       OAuth2.apply(config, _request)
       _response = execute_request(_request)

data/lib/square/api/transactions_api.rb

@@ -5,80 +5,6 @@ module Square
       super(config, http_call_back: http_call_back)
     end
 
-    # Lists refunds for one of a business's locations.
-    # In addition to full or partial tender refunds processed through Square
-    # APIs,
-    # refunds may result from itemized returns or exchanges through Square's
-    # Point of Sale applications.
-    # Refunds with a `status` of `PENDING` are not currently included in this
-    # endpoint's response.
-    # 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](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](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](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,
-                     end_time: nil,
-                     sort_order: nil,
-                     cursor: nil)
-      warn 'Endpoint list_refunds in TransactionsApi is deprecated'
-      # Prepare query url.
-      _query_builder = config.get_base_uri
-      _query_builder << '/v2/locations/{location_id}/refunds'
-      _query_builder = APIHelper.append_url_with_template_parameters(
-        _query_builder,
-        'location_id' => { 'value' => location_id, 'encode' => true }
-      )
-      _query_builder = APIHelper.append_url_with_query_parameters(
-        _query_builder,
-        'begin_time' => begin_time,
-        'end_time' => end_time,
-        'sort_order' => sort_order,
-        'cursor' => cursor
-      )
-      _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
-
     # Lists transactions for a particular location.
     # Transactions include payment information from sales and exchanges and
     # refund
@@ -150,67 +76,6 @@ module Square
       )
     end
 
-    # 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 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)
-    # In order for an eCommerce payment to potentially qualify for
-    # [Square chargeback protection](https://squareup.com/help/article/5394),
-    # you
-    # _must_ provide values for the following parameters in your request:
-    # - `buyer_email_address`
-    # - At least one of `billing_address` or `shipping_address`
-    # 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]($e/Transactions/RetrieveTransaction). See the
-    # `processing_fee_money`
-    # 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
-    # fields to POST for the request.  See the corresponding object definition
-    # for field details.
-    # @return [ChargeResponse Hash] response from the API call
-    def charge(location_id:,
-               body:)
-      warn 'Endpoint charge in TransactionsApi is deprecated'
-      # Prepare query url.
-      _query_builder = config.get_base_uri
-      _query_builder << '/v2/locations/{location_id}/transactions'
-      _query_builder = APIHelper.append_url_with_template_parameters(
-        _query_builder,
-        'location_id' => { 'value' => location_id, 'encode' => true }
-      )
-      _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
-
     # Retrieves details for a single transaction.
     # @param [String] location_id Required parameter: The ID of the
     # transaction's associated location.
@@ -295,59 +160,6 @@ module Square
       )
     end
 
-    # Initiates a refund for a previously charged tender.
-    # 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
-    # on refund behavior.
-    # NOTE: Card-present transactions with Interac credit cards **cannot be
-    # refunded using the Connect API**. Interac transactions must refunded
-    # in-person (e.g., dipping the card using POS app).
-    # @param [String] location_id Required parameter: The ID of the original
-    # transaction's associated location.
-    # @param [String] transaction_id Required parameter: The ID of the original
-    # transaction that includes the tender to refund.
-    # @param [CreateRefundRequest] body Required parameter: An object containing
-    # the fields to POST for the request.  See the corresponding object
-    # definition for field details.
-    # @return [CreateRefundResponse Hash] response from the API call
-    def create_refund(location_id:,
-                      transaction_id:,
-                      body:)
-      warn 'Endpoint create_refund in TransactionsApi is deprecated'
-      # Prepare query url.
-      _query_builder = config.get_base_uri
-      _query_builder << '/v2/locations/{location_id}/transactions/{transaction_id}/refund'
-      _query_builder = APIHelper.append_url_with_template_parameters(
-        _query_builder,
-        'location_id' => { 'value' => location_id, 'encode' => true },
-        'transaction_id' => { 'value' => transaction_id, 'encode' => true }
-      )
-      _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
-
     # Cancels a transaction that was created with the
     # [Charge]($e/Transactions/Charge)
     # endpoint with a `delay_capture` value of `true`.

data/lib/square/client.rb

@@ -4,7 +4,7 @@ module Square
     attr_reader :config
 
     def sdk_version
-      '14.1.0.20210915'
+      '15.0.0.20211020'
     end
 
     def square_version
@@ -209,15 +209,16 @@ module Square
       @terminal ||= TerminalApi.new config
     end
 
-    def initialize(timeout: 60, max_retries: 0, retry_interval: 1,
-                   backoff_factor: 2,
+    def initialize(http_client_instance: nil, timeout: 60, max_retries: 0,
+                   retry_interval: 1, 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-09-15', access_token: 'TODO: Replace',
+                   square_version: '2021-10-20', access_token: '',
                    additional_headers: {}, config: nil)
       @config = if config.nil?
-                  Configuration.new(timeout: timeout, max_retries: max_retries,
+                  Configuration.new(http_client_instance: http_client_instance,
+                                    timeout: timeout, max_retries: max_retries,
                                     retry_interval: retry_interval,
                                     backoff_factor: backoff_factor,
                                     retry_statuses: retry_statuses,

data/lib/square/configuration.rb

@@ -3,26 +3,28 @@ module Square
   # are configured in this class.
   class Configuration
     # The attribute readers for properties.
-    attr_reader :http_client, :timeout, :max_retries, :retry_interval, :backoff_factor,
-                :retry_statuses, :retry_methods, :environment, :custom_url, :square_version,
-                :access_token,
-                
+    attr_reader :http_client, :http_client_instance, :timeout, :max_retries, :retry_interval,
+                :backoff_factor, :retry_statuses, :retry_methods, :environment, :custom_url,
+                :square_version, :access_token
+
     def additional_headers
       @additional_headers.clone
     end
 
-
     class << self
       attr_reader :environments
     end
 
-    def initialize(timeout: 60, max_retries: 0, retry_interval: 1,
-                   backoff_factor: 2,
+    def initialize(http_client_instance: nil, timeout: 60, max_retries: 0,
+                   retry_interval: 1, 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-09-15', access_token: 'TODO: Replace',
+                   square_version: '2021-10-20', access_token: '',
                    additional_headers: {})
+      # The Http Client passed from the sdk user for making requests
+      @http_client_instance = http_client_instance
+
       # The value to use for connection timeout
       @timeout = timeout
 
@@ -61,10 +63,12 @@ module Square
       @http_client = create_http_client
     end
 
-    def clone_with(timeout: nil, max_retries: nil, retry_interval: nil,
-                   backoff_factor: nil, retry_statuses: nil, retry_methods: nil,
-                   environment: nil, custom_url: nil, square_version: nil,
-                   access_token: nil, additional_headers: nil)
+    def clone_with(http_client_instance: nil, timeout: nil, max_retries: nil,
+                   retry_interval: nil, backoff_factor: nil,
+                   retry_statuses: nil, retry_methods: nil, environment: nil,
+                   custom_url: nil, square_version: nil, access_token: nil,
+                   additional_headers: nil)
+      http_client_instance ||= self.http_client_instance
       timeout ||= self.timeout
       max_retries ||= self.max_retries
       retry_interval ||= self.retry_interval
@@ -77,7 +81,8 @@ module Square
       access_token ||= self.access_token
       additional_headers ||= self.additional_headers
 
-      Configuration.new(timeout: timeout, max_retries: max_retries,
+      Configuration.new(http_client_instance: http_client_instance,
+                        timeout: timeout, max_retries: max_retries,
                         retry_interval: retry_interval,
                         backoff_factor: backoff_factor,
                         retry_statuses: retry_statuses,
@@ -92,7 +97,8 @@ module Square
                         retry_interval: retry_interval,
                         backoff_factor: backoff_factor,
                         retry_statuses: retry_statuses,
-                        retry_methods: retry_methods)
+                        retry_methods: retry_methods,
+                        http_client_instance: http_client_instance)
     end
 
     # All the environments the SDK can run in.

data/lib/square/http/api_response.rb

@@ -25,7 +25,7 @@ module Square
           end.new(*data.values)
 
           @cursor = data.fetch(:cursor, nil)
-          data.reject! { |k| k == :cursor || k == :errors }
+          data.reject! { |k| %i[cursor errors].include?(k) }
           @data = Struct.new(*data.keys).new(*data.values) if data.keys.any?
         end
       else

data/lib/square/http/faraday_client.rb

@@ -7,7 +7,25 @@ module Square
     # The constructor.
     def initialize(timeout:, max_retries:, retry_interval:,
                    backoff_factor:, retry_statuses:, retry_methods:,
-                   cache: false, verify: true)
+                   http_client_instance: nil, cache: false, verify: true)
+      if http_client_instance.nil?
+        create_connection(timeout: timeout, max_retries: max_retries,
+                          retry_interval: retry_interval, backoff_factor: backoff_factor,
+                          retry_statuses: retry_statuses, retry_methods: retry_methods,
+                          cache: cache, verify: verify)
+      else
+        if http_client_instance.instance_variable_get('@connection').nil?
+          raise ArgumentError,
+                "`connection` cannot be nil in `#{self.class}`. Please specify a valid value."
+        end
+        @connection = http_client_instance.instance_variable_get('@connection')
+      end
+    end
+
+    # Method to initialize connection.
+    def create_connection(timeout:, max_retries:, retry_interval:,
+                          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
@@ -24,6 +42,7 @@ module Square
         faraday.options[:params_encoder] = Faraday::FlatParamsEncoder
         faraday.options[:timeout] = timeout if timeout.positive?
       end
+      @connection
     end
 
     # Method overridden from HttpClient.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: square.rb
 version: !ruby/object:Gem::Version
-  version: 14.1.0.20210915
+  version: 15.0.0.20211020
 platform: ruby
 authors:
 - Square Developer Platform
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-09-16 00:00:00.000000000 Z
+date: 2021-10-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logging