square.rb 5.2.2.20200422 → 6.3.0.20200826

data/lib/square/api/v1_locations_api.rb

@@ -6,15 +6,6 @@ module Square
     end
 
     # Get the general information for a business.
-    # ---
-    # - __Deprecation date__: 2019-11-20
-    # - [__Retirement
-    # date__](https://developer.squareup.com/docs/build-basics/api-lifecycle#dep
-    # recated): 2020-11-18
-    # - [Migration
-    # guide](https://developer.squareup.com/docs/migrate-from-v1/guides/v1-locat
-    # ions)
-    # ---
     # @return [V1Merchant Hash] response from the API call
     def retrieve_business
       warn 'Endpoint retrieve_business in V1LocationsApi is deprecated'
@@ -44,15 +35,6 @@ module Square
 
     # Provides details for all business locations associated with a Square
     # account, including the Square-assigned object ID for the location.
-    # ---
-    # - __Deprecation date__: 2019-11-20
-    # - [__Retirement
-    # date__](https://developer.squareup.com/docs/build-basics/api-lifecycle#dep
-    # recated): 2020-11-18
-    # - [Migration
-    # guide](https://developer.squareup.com/docs/migrate-from-v1/guides/v1-locat
-    # ions)
-    # ---
     # @return [List of V1Merchant Hash] response from the API call
     def list_locations
       warn 'Endpoint list_locations in V1LocationsApi is deprecated'

data/lib/square/api/v1_transactions_api.rb

@@ -8,15 +8,6 @@ module Square
     # Provides non-confidential details for all of a location's associated bank
     # accounts. This endpoint does not provide full bank account numbers, and
     # there is no way to obtain a full bank account number with the Connect API.
-    # ---
-    # - __Deprecation date__: 2020-02-26
-    # - [__Retirement
-    # date__](https://developer.squareup.com/docs/docs/build-basics/api-lifecycl
-    # e#deprecated): 2021-02-26
-    # - [Migration
-    # guide](https://developer.squareup.com/docs/docs/migrate-from-v1/guides/v1-
-    # bankaccounts)
-    # ---
     # @param [String] location_id Required parameter: The ID of the location to
     # list bank accounts for.
     # @return [List of V1BankAccount Hash] response from the API call
@@ -53,15 +44,6 @@ module Square
     # Provides non-confidential details for a merchant's associated bank
     # account. This endpoint does not provide full bank account numbers, and
     # there is no way to obtain a full bank account number with the Connect API.
-    # ---
-    # - __Deprecation date__: 2020-02-26
-    # - [__Retirement
-    # date__](https://developer.squareup.com/docs/docs/build-basics/api-lifecycl
-    # e#deprecated): 2021-02-26
-    # - [Migration
-    # guide](https://developer.squareup.com/docs/docs/migrate-from-v1/guides/v1-
-    # bankaccounts)
-    # ---
     # @param [String] location_id Required parameter: The ID of the bank
     # account's associated location.
     # @param [String] bank_account_id Required parameter: The bank account's
@@ -272,7 +254,7 @@ module Square
                       end_time: nil,
                       limit: nil,
                       batch_token: nil,
-                      include_partial: nil)
+                      include_partial: false)
       # Prepare query url.
       _query_builder = config.get_base_uri
       _query_builder << '/v1/{location_id}/payments'

data/lib/square/client.rb

@@ -4,11 +4,11 @@ module Square
     attr_reader :config
 
     def sdk_version
-      '5.2.2.20200422'
+      '6.3.0.20200826'
     end
 
     def square_version
-      '2020-04-22'
+      config.square_version
     end
 
     # Access to mobile_authorization controller.
@@ -113,6 +113,12 @@ module Square
       @inventory ||= InventoryApi.new config
     end
 
+    # Access to invoices controller.
+    # @return [InvoicesApi] Returns the controller instance.
+    def invoices
+      @invoices ||= InvoicesApi.new config
+    end
+
     # Access to labor controller.
     # @return [LaborApi] Returns the controller instance.
     def labor
@@ -125,36 +131,36 @@ module Square
       @locations ||= LocationsApi.new config
     end
 
-    # Access to reporting controller.
-    # @return [ReportingApi] Returns the controller instance.
-    def reporting
-      @reporting ||= ReportingApi.new config
-    end
-
     # Access to checkout controller.
     # @return [CheckoutApi] Returns the controller instance.
     def checkout
       @checkout ||= CheckoutApi.new config
     end
 
-    # Access to orders controller.
-    # @return [OrdersApi] Returns the controller instance.
-    def orders
-      @orders ||= OrdersApi.new config
-    end
-
     # Access to transactions controller.
     # @return [TransactionsApi] Returns the controller instance.
     def transactions
       @transactions ||= TransactionsApi.new config
     end
 
+    # Access to loyalty controller.
+    # @return [LoyaltyApi] Returns the controller instance.
+    def loyalty
+      @loyalty ||= LoyaltyApi.new config
+    end
+
     # Access to merchants controller.
     # @return [MerchantsApi] Returns the controller instance.
     def merchants
       @merchants ||= MerchantsApi.new config
     end
 
+    # Access to orders controller.
+    # @return [OrdersApi] Returns the controller instance.
+    def orders
+      @orders ||= OrdersApi.new config
+    end
+
     # Access to payments controller.
     # @return [PaymentsApi] Returns the controller instance.
     def payments
@@ -167,6 +173,18 @@ module Square
       @refunds ||= RefundsApi.new config
     end
 
+    # Access to subscriptions controller.
+    # @return [SubscriptionsApi] Returns the controller instance.
+    def subscriptions
+      @subscriptions ||= SubscriptionsApi.new config
+    end
+
+    # Access to team controller.
+    # @return [TeamApi] Returns the controller instance.
+    def team
+      @team ||= TeamApi.new config
+    end
+
     # Access to terminal controller.
     # @return [TerminalApi] Returns the controller instance.
     def terminal
@@ -175,13 +193,14 @@ module Square
 
     def initialize(timeout: 60, max_retries: 0, retry_interval: 1,
                    backoff_factor: 1, environment: 'production',
-                   access_token: 'TODO: Replace', additional_headers: {},
-                   config: nil)
+                   square_version: '2020-08-26', 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,
                                     environment: environment,
+                                    square_version: square_version,
                                     access_token: access_token,
                                     additional_headers: additional_headers)
                 else

data/lib/square/configuration.rb

@@ -9,6 +9,7 @@ module Square
     attr_reader :retry_interval
     attr_reader :backoff_factor
     attr_reader :environment
+    attr_reader :square_version
     attr_reader :access_token
 
     def additional_headers
@@ -21,7 +22,8 @@ module Square
 
     def initialize(timeout: 60, max_retries: 0, retry_interval: 1,
                    backoff_factor: 1, environment: 'production',
-                   access_token: 'TODO: Replace', additional_headers: {})
+                   square_version: '2020-08-26', access_token: 'TODO: Replace',
+                   additional_headers: {})
       # The value to use for connection timeout
       @timeout = timeout
 
@@ -38,6 +40,9 @@ module Square
       # Current API environment
       @environment = String(environment)
 
+      # Square Connect API versions
+      @square_version = square_version
+
       # OAuth 2.0 Access Token
       @access_token = access_token
 
@@ -49,20 +54,23 @@ module Square
     end
 
     def clone_with(timeout: nil, max_retries: nil, retry_interval: nil,
-                   backoff_factor: nil, environment: nil, access_token: nil,
-                   additional_headers: nil)
+                   backoff_factor: nil, environment: 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
       environment ||= self.environment
+      square_version ||= self.square_version
       access_token ||= self.access_token
       additional_headers ||= self.additional_headers
 
       Configuration.new(timeout: timeout, max_retries: max_retries,
                         retry_interval: retry_interval,
                         backoff_factor: backoff_factor,
-                        environment: environment, access_token: access_token,
+                        environment: environment,
+                        square_version: square_version,
+                        access_token: access_token,
                         additional_headers: additional_headers)
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: square.rb
 version: !ruby/object:Gem::Version
-  version: 5.2.2.20200422
+  version: 6.3.0.20200826
 platform: ruby
 authors:
 - Square Developer Platform
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-25 00:00:00.000000000 Z
+date: 2020-08-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logging
@@ -131,15 +131,18 @@ files:
 - lib/square/api/disputes_api.rb
 - lib/square/api/employees_api.rb
 - lib/square/api/inventory_api.rb
+- lib/square/api/invoices_api.rb
 - lib/square/api/labor_api.rb
 - lib/square/api/locations_api.rb
+- lib/square/api/loyalty_api.rb
 - lib/square/api/merchants_api.rb
 - lib/square/api/mobile_authorization_api.rb
 - lib/square/api/o_auth_api.rb
 - lib/square/api/orders_api.rb
 - lib/square/api/payments_api.rb
 - lib/square/api/refunds_api.rb
-- lib/square/api/reporting_api.rb
+- lib/square/api/subscriptions_api.rb
+- lib/square/api/team_api.rb
 - lib/square/api/terminal_api.rb
 - lib/square/api/transactions_api.rb
 - lib/square/api/v1_employees_api.rb
@@ -190,7 +193,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.8
 signing_key: 
 specification_version: 4
 summary: square

data/lib/square/api/reporting_api.rb

@@ -1,138 +0,0 @@
-module Square
-  # ReportingApi
-  class ReportingApi < BaseApi
-    def initialize(config, http_call_back: nil)
-      super(config, http_call_back: http_call_back)
-    end
-
-    # Returns a list of refunded transactions (across all possible originating
-    # locations) relating to monies
-    # credited to the provided location ID by another Square account using the
-    # `additional_recipients` field in a transaction.
-    # Max results per [page](#paginatingresults): 50
-    # @param [String] location_id Required parameter: The ID of the location to
-    # list AdditionalRecipientReceivableRefunds 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.
-    # @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.
-    # @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.
-    # @return [ListAdditionalRecipientReceivableRefundsResponse Hash] response from the API call
-    def list_additional_recipient_receivable_refunds(location_id:,
-                                                     begin_time: nil,
-                                                     end_time: nil,
-                                                     sort_order: nil,
-                                                     cursor: nil)
-      warn 'Endpoint list_additional_recipient_receivable_refunds in Reporting'\
-           'Api is deprecated'
-      # Prepare query url.
-      _query_builder = config.get_base_uri
-      _query_builder << '/v2/locations/{location_id}/additional-recipient-receivable-refunds'
-      _query_builder = APIHelper.append_url_with_template_parameters(
-        _query_builder,
-        'location_id' => location_id
-      )
-      _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
-
-    # Returns a list of receivables (across all possible sending locations)
-    # representing monies credited
-    # to the provided location ID by another Square account using the
-    # `additional_recipients` field in a transaction.
-    # Max results per [page](#paginatingresults): 50
-    # @param [String] location_id Required parameter: The ID of the location to
-    # list AdditionalRecipientReceivables 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.
-    # @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.
-    # @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.
-    # @return [ListAdditionalRecipientReceivablesResponse Hash] response from the API call
-    def list_additional_recipient_receivables(location_id:,
-                                              begin_time: nil,
-                                              end_time: nil,
-                                              sort_order: nil,
-                                              cursor: nil)
-      warn 'Endpoint list_additional_recipient_receivables in ReportingApi is '\
-           'deprecated'
-      # Prepare query url.
-      _query_builder = config.get_base_uri
-      _query_builder << '/v2/locations/{location_id}/additional-recipient-receivables'
-      _query_builder = APIHelper.append_url_with_template_parameters(
-        _query_builder,
-        'location_id' => location_id
-      )
-      _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
-  end
-end