square.rb 15.0.0.20211020 → 17.1.0.20220120

data/lib/square/api/refunds_api.rb

@@ -31,10 +31,13 @@ module Square
     # the given status are returned. For a list of refund status values, see
     # [PaymentRefund]($m/PaymentRefund).  Default: If omitted, refunds are
     # returned regardless of their status.
-    # @param [String] source_type Optional parameter: If provided, only refunds
-    # with the given source type are returned. - `CARD` - List refunds only for
-    # payments where `CARD` was specified as the payment source.  Default: If
-    # omitted, refunds are returned regardless of the source type.
+    # @param [String] source_type Optional parameter: If provided, only returns
+    # refunds whose payments have the indicated source type. Current values
+    # include `CARD`, `BANK_ACCOUNT`, `WALLET`, `CASH`, and `EXTERNAL`. For
+    # information about these payment source types, see [Take
+    # Payments](https://developer.squareup.com/docs/payments-api/take-payments).
+    #  Default: If omitted, refunds are returned regardless of the source
+    # type.
     # @param [Integer] limit Optional parameter: The maximum number of results
     # to be returned in a single page.  It is possible to receive fewer results
     # than the specified limit on a given page.  If the supplied value is
@@ -105,7 +108,7 @@ module Square
       # Prepare headers.
       _headers = {
         'accept' => 'application/json',
-        'content-type' => 'application/json; charset=utf-8'
+        'Content-Type' => 'application/json'
       }
 
       # Prepare and execute HttpRequest.

data/lib/square/api/sites_api.rb

@@ -5,7 +5,8 @@ module Square
       super(config, http_call_back: http_call_back)
     end
 
-    # Lists the Square Online sites that belong to a seller.
+    # Lists the Square Online sites that belong to a seller. Sites are listed in
+    # descending order by the `created_at` date.
     # __Note:__ Square Online APIs are publicly available as part of an early
     # access program. For more information, see [Early access program for Square
     # Online

data/lib/square/api/snippets_api.rb

@@ -123,7 +123,7 @@ module Square
       # Prepare headers.
       _headers = {
         'accept' => 'application/json',
-        'content-type' => 'application/json; charset=utf-8'
+        'Content-Type' => 'application/json'
       }
 
       # Prepare and execute HttpRequest.

data/lib/square/api/subscriptions_api.rb

@@ -5,7 +5,7 @@ module Square
       super(config, http_call_back: http_call_back)
     end
 
-    # Creates a subscription for a customer to a subscription plan.
+    # Creates a subscription to a subscription plan by a customer.
     # If you provide a card on file in the request, Square charges the card for
     # the subscription. Otherwise, Square bills an invoice to the customer's
     # email
@@ -25,7 +25,7 @@ module Square
       # Prepare headers.
       _headers = {
         'accept' => 'application/json',
-        'content-type' => 'application/json; charset=utf-8'
+        'Content-Type' => 'application/json'
       }
 
       # Prepare and execute HttpRequest.
@@ -75,7 +75,7 @@ module Square
       # Prepare headers.
       _headers = {
         'accept' => 'application/json',
-        'content-type' => 'application/json; charset=utf-8'
+        'Content-Type' => 'application/json'
       }
 
       # Prepare and execute HttpRequest.
@@ -98,8 +98,13 @@ module Square
     # Retrieves a subscription.
     # @param [String] subscription_id Required parameter: The ID of the
     # subscription to retrieve.
+    # @param [String] include Optional parameter: A query parameter to specify
+    # related information to be included in the response.   The supported query
+    # parameter values are:   - `actions`: to include scheduled actions on the
+    # targeted subscription.
     # @return [RetrieveSubscriptionResponse Hash] response from the API call
-    def retrieve_subscription(subscription_id:)
+    def retrieve_subscription(subscription_id:,
+                              include: nil)
       # Prepare query url.
       _query_builder = config.get_base_uri
       _query_builder << '/v2/subscriptions/{subscription_id}'
@@ -107,6 +112,10 @@ module Square
         _query_builder,
         'subscription_id' => { 'value' => subscription_id, 'encode' => true }
       )
+      _query_builder = APIHelper.append_url_with_query_parameters(
+        _query_builder,
+        'include' => include
+      )
       _query_url = APIHelper.clean_url _query_builder
 
       # Prepare headers.
@@ -132,7 +141,7 @@ module Square
 
     # Updates a subscription. You can set, modify, and clear the
     # `subscription` field values.
-    # @param [String] subscription_id Required parameter: The ID for the
+    # @param [String] subscription_id Required parameter: The ID of the
     # subscription to update.
     # @param [UpdateSubscriptionRequest] body Required parameter: An object
     # containing the fields to POST for the request.  See the corresponding
@@ -152,7 +161,7 @@ module Square
       # Prepare headers.
       _headers = {
         'accept' => 'application/json',
-        'content-type' => 'application/json; charset=utf-8'
+        'Content-Type' => 'application/json'
       }
 
       # Prepare and execute HttpRequest.
@@ -172,8 +181,50 @@ module Square
       )
     end
 
-    # Sets the `canceled_date` field to the end of the active billing period.
-    # After this date, the status changes from ACTIVE to CANCELED.
+    # Deletes a scheduled action for a subscription.
+    # @param [String] subscription_id Required parameter: The ID of the
+    # subscription the targeted action is to act upon.
+    # @param [String] action_id Required parameter: The ID of the targeted
+    # action to be deleted.
+    # @return [DeleteSubscriptionActionResponse Hash] response from the API call
+    def delete_subscription_action(subscription_id:,
+                                   action_id:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/subscriptions/{subscription_id}/actions/{action_id}'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'subscription_id' => { 'value' => subscription_id, 'encode' => true },
+        'action_id' => { 'value' => action_id, 'encode' => true }
+      )
+      _query_url = APIHelper.clean_url _query_builder
+
+      # Prepare headers.
+      _headers = {
+        'accept' => 'application/json'
+      }
+
+      # Prepare and execute HttpRequest.
+      _request = config.http_client.delete(
+        _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
+
+    # Schedules a `CANCEL` action to cancel an active subscription
+    # by setting the `canceled_date` field to the end of the active billing
+    # period
+    # and changing the subscription status from ACTIVE to CANCELED after this
+    # date.
     # @param [String] subscription_id Required parameter: The ID of the
     # subscription to cancel.
     # @return [CancelSubscriptionResponse Hash] response from the API call
@@ -214,13 +265,15 @@ module Square
     # returned.
     # @param [String] subscription_id Required parameter: The ID of the
     # subscription to retrieve the events for.
-    # @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 the original query.  For more information, see
+    # @param [String] cursor Optional parameter: When the total number of
+    # resulting subscription events exceeds the limit of a paged response, 
+    # specify the cursor returned from a preceding response here to fetch the
+    # next set of results. If the cursor is unset, the response contains the
+    # last page of the results.  For more information, see
     # [Pagination](https://developer.squareup.com/docs/working-with-apis/paginat
     # ion).
     # @param [Integer] limit Optional parameter: The upper limit on the number
-    # of subscription events to return in the response.  Default: `200`
+    # of subscription events to return in a paged response.
     # @return [ListSubscriptionEventsResponse Hash] response from the API call
     def list_subscription_events(subscription_id:,
                                  cursor: nil,
@@ -260,11 +313,57 @@ module Square
       )
     end
 
-    # Resumes a deactivated subscription.
+    # Schedules a `PAUSE` action to pause an active subscription.
+    # @param [String] subscription_id Required parameter: The ID of the
+    # subscription to pause.
+    # @param [PauseSubscriptionRequest] body Required parameter: An object
+    # containing the fields to POST for the request.  See the corresponding
+    # object definition for field details.
+    # @return [PauseSubscriptionResponse Hash] response from the API call
+    def pause_subscription(subscription_id:,
+                           body:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/subscriptions/{subscription_id}/pause'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'subscription_id' => { 'value' => subscription_id, 'encode' => true }
+      )
+      _query_url = APIHelper.clean_url _query_builder
+
+      # Prepare headers.
+      _headers = {
+        'accept' => 'application/json',
+        'Content-Type' => 'application/json'
+      }
+
+      # 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
+
+    # Schedules a `RESUME` action to resume a paused or a deactivated
+    # subscription.
     # @param [String] subscription_id Required parameter: The ID of the
     # subscription to resume.
+    # @param [ResumeSubscriptionRequest] body Required parameter: An object
+    # containing the fields to POST for the request.  See the corresponding
+    # object definition for field details.
     # @return [ResumeSubscriptionResponse Hash] response from the API call
-    def resume_subscription(subscription_id:)
+    def resume_subscription(subscription_id:,
+                            body:)
       # Prepare query url.
       _query_builder = config.get_base_uri
       _query_builder << '/v2/subscriptions/{subscription_id}/resume'
@@ -276,13 +375,57 @@ module Square
 
       # Prepare headers.
       _headers = {
-        'accept' => 'application/json'
+        'accept' => 'application/json',
+        'Content-Type' => 'application/json'
       }
 
       # 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)
+
+      # 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
+
+    # Schedules a `SWAP_PLAN` action to swap a subscription plan in an existing
+    # subscription.
+    # @param [String] subscription_id Required parameter: The ID of the
+    # subscription to swap the subscription plan for.
+    # @param [SwapPlanRequest] body Required parameter: An object containing the
+    # fields to POST for the request.  See the corresponding object definition
+    # for field details.
+    # @return [SwapPlanResponse Hash] response from the API call
+    def swap_plan(subscription_id:,
+                  body:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/subscriptions/{subscription_id}/swap-plan'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'subscription_id' => { 'value' => subscription_id, 'encode' => true }
+      )
+      _query_url = APIHelper.clean_url _query_builder
+
+      # Prepare headers.
+      _headers = {
+        'accept' => 'application/json',
+        'Content-Type' => 'application/json'
+      }
+
+      # 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)

data/lib/square/api/team_api.rb

@@ -26,7 +26,7 @@ module Square
       # Prepare headers.
       _headers = {
         'accept' => 'application/json',
-        'content-type' => 'application/json; charset=utf-8'
+        'Content-Type' => 'application/json'
       }
 
       # Prepare and execute HttpRequest.
@@ -69,7 +69,7 @@ module Square
       # Prepare headers.
       _headers = {
         'accept' => 'application/json',
-        'content-type' => 'application/json; charset=utf-8'
+        'Content-Type' => 'application/json'
       }
 
       # Prepare and execute HttpRequest.
@@ -112,7 +112,7 @@ module Square
       # Prepare headers.
       _headers = {
         'accept' => 'application/json',
-        'content-type' => 'application/json; charset=utf-8'
+        'Content-Type' => 'application/json'
       }
 
       # Prepare and execute HttpRequest.
@@ -149,7 +149,7 @@ module Square
       # Prepare headers.
       _headers = {
         'accept' => 'application/json',
-        'content-type' => 'application/json; charset=utf-8'
+        'Content-Type' => 'application/json'
       }
 
       # Prepare and execute HttpRequest.
@@ -232,7 +232,7 @@ module Square
       # Prepare headers.
       _headers = {
         'accept' => 'application/json',
-        'content-type' => 'application/json; charset=utf-8'
+        'Content-Type' => 'application/json'
       }
 
       # Prepare and execute HttpRequest.
@@ -319,7 +319,7 @@ module Square
       # Prepare headers.
       _headers = {
         'accept' => 'application/json',
-        'content-type' => 'application/json; charset=utf-8'
+        'Content-Type' => 'application/json'
       }
 
       # Prepare and execute HttpRequest.

data/lib/square/api/terminal_api.rb

@@ -21,7 +21,7 @@ module Square
       # Prepare headers.
       _headers = {
         'accept' => 'application/json',
-        'content-type' => 'application/json; charset=utf-8'
+        'Content-Type' => 'application/json'
       }
 
       # Prepare and execute HttpRequest.
@@ -56,7 +56,7 @@ module Square
       # Prepare headers.
       _headers = {
         'accept' => 'application/json',
-        'content-type' => 'application/json; charset=utf-8'
+        'Content-Type' => 'application/json'
       }
 
       # Prepare and execute HttpRequest.
@@ -162,7 +162,7 @@ module Square
       # Prepare headers.
       _headers = {
         'accept' => 'application/json',
-        'content-type' => 'application/json; charset=utf-8'
+        'Content-Type' => 'application/json'
       }
 
       # Prepare and execute HttpRequest.
@@ -197,7 +197,7 @@ module Square
       # Prepare headers.
       _headers = {
         'accept' => 'application/json',
-        'content-type' => 'application/json; charset=utf-8'
+        'Content-Type' => 'application/json'
       }
 
       # Prepare and execute HttpRequest.

data/lib/square/api/v1_transactions_api.rb

@@ -127,7 +127,7 @@ module Square
       # Prepare headers.
       _headers = {
         'accept' => 'application/json',
-        'content-type' => 'application/json; charset=utf-8'
+        'Content-Type' => 'application/json'
       }
 
       # Prepare and execute HttpRequest.
@@ -369,7 +369,7 @@ module Square
       # Prepare headers.
       _headers = {
         'accept' => 'application/json',
-        'content-type' => 'application/json; charset=utf-8'
+        'Content-Type' => 'application/json'
       }
 
       # Prepare and execute HttpRequest.

data/lib/square/client.rb

@@ -4,13 +4,17 @@ module Square
     attr_reader :config
 
     def sdk_version
-      '15.0.0.20211020'
+      '17.1.0.20220120'
     end
 
     def square_version
       config.square_version
     end
 
+    def user_agent_detail
+      config.user_agent_detail
+    end
+
     # Access to mobile_authorization controller.
     # @return [MobileAuthorizationApi] Returns the controller instance.
     def mobile_authorization
@@ -214,8 +218,8 @@ module Square
                    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-10-20', access_token: '',
-                   additional_headers: {}, config: nil)
+                   square_version: '2022-01-20', access_token: '',
+                   user_agent_detail: '', additional_headers: {}, config: nil)
       @config = if config.nil?
                   Configuration.new(http_client_instance: http_client_instance,
                                     timeout: timeout, max_retries: max_retries,
@@ -227,6 +231,7 @@ module Square
                                     custom_url: custom_url,
                                     square_version: square_version,
                                     access_token: access_token,
+                                    user_agent_detail: user_agent_detail,
                                     additional_headers: additional_headers)
                 else
                   config

data/lib/square/configuration.rb

@@ -5,7 +5,7 @@ module Square
     # The attribute readers for properties.
     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
+                :square_version, :access_token, :user_agent_detail
 
     def additional_headers
       @additional_headers.clone
@@ -20,8 +20,8 @@ module Square
                    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-10-20', access_token: '',
-                   additional_headers: {})
+                   square_version: '2022-01-20', access_token: '',
+                   user_agent_detail: '', additional_headers: {})
       # The Http Client passed from the sdk user for making requests
       @http_client_instance = http_client_instance
 
@@ -61,13 +61,16 @@ module Square
 
       # The Http Client to use for making requests.
       @http_client = create_http_client
+
+      # User agent detail, to be appended with user-agent header.
+      @user_agent_detail = get_user_agent(user_agent_detail)
     end
 
     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)
+                   user_agent_detail: nil, additional_headers: nil)
       http_client_instance ||= self.http_client_instance
       timeout ||= self.timeout
       max_retries ||= self.max_retries
@@ -79,6 +82,7 @@ module Square
       custom_url ||= self.custom_url
       square_version ||= self.square_version
       access_token ||= self.access_token
+      user_agent_detail ||= self.user_agent_detail
       additional_headers ||= self.additional_headers
 
       Configuration.new(http_client_instance: http_client_instance,
@@ -89,6 +93,7 @@ module Square
                         retry_methods: retry_methods, environment: environment,
                         custom_url: custom_url, square_version: square_version,
                         access_token: access_token,
+                        user_agent_detail: user_agent_detail,
                         additional_headers: additional_headers)
     end
 
@@ -101,6 +106,12 @@ module Square
                         http_client_instance: http_client_instance)
     end
 
+    def get_user_agent(user_agent_detail)
+      raise ArgumentError, 'The length of user-agent detail should not exceed 128 characters.' unless user_agent_detail.length < 128
+
+      user_agent_detail
+    end
+
     # All the environments the SDK can run in.
     ENVIRONMENTS = {
       'production' => {

data/test/api/test_locations_api.rb

@@ -7,11 +7,8 @@ class LocationsApiTests < ApiTestBase
     @controller = LocationsApi.new CONFIG, http_call_back: @response_catcher
   end
 
-  # Provides information of all locations of a business.
-  #
-  #Many Square API endpoints require a `location_id` parameter.
-  #The `id` field of the [`Location`]($m/Location) objects returned by this
-  #endpoint correspond to that `location_id` parameter.
+  # Provides details about all of the seller's [locations](https://developer.squareup.com/docs/locations-api),
+  #including those with an inactive status.
   def test_list_locations()
 
     # Perform the API call through the SDK function

data/test/test_helper.rb

@@ -82,7 +82,7 @@ class TestHelper
     unless @cache.keys.include? url  
       @cache[url] = Tempfile.new('APIMatic')
       @cache[url].binmode
-      @cache[url].write(open(url, {ssl_ca_cert: Certifi.where}).read)
+      @cache[url].write(URI.open(url, {ssl_ca_cert: Certifi.where}).read)
     end
     return @cache[url].path
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: square.rb
 version: !ruby/object:Gem::Version
-  version: 15.0.0.20211020
+  version: 17.1.0.20220120
 platform: ruby
 authors:
 - Square Developer Platform
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-10-20 00:00:00.000000000 Z
+date: 2022-01-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logging
@@ -209,9 +209,6 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ">="
     - !ruby/object:Gem::Version
       version: '2.5'
-  - - "<"
-    - !ruby/object:Gem::Version
-      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="