square.rb 9.1.1.20210317 → 10.0.0.20210421

data/lib/square/api/payments_api.rb

@@ -6,6 +6,9 @@ module Square
     end
 
     # Retrieves a list of payments taken by the account making the request.
+    # Results are eventually consistent, and new payments or changes to payments
+    # might take several
+    # seconds to appear.
     # The maximum results per page is 100.
     # @param [String] begin_time Optional parameter: The timestamp for the
     # beginning of the reporting period, in RFC 3339 format. Inclusive. Default:
@@ -88,7 +91,7 @@ module Square
     # Square gift card) or record a payment that the seller received outside of
     # Square
     # (cash payment from a buyer or a payment that an external entity
-    # procesed on behalf of the seller).
+    # processed on behalf of the seller).
     # The endpoint creates a
     # `Payment` object and returns it in the response.
     # @param [CreatePaymentRequest] body Required parameter: An object

data/lib/square/api/refunds_api.rb

@@ -6,6 +6,9 @@ module Square
     end
 
     # Retrieves a list of refunds for the account making the request.
+    # Results are eventually consistent, and new refunds or changes to refunds
+    # might take several
+    # seconds to appear.
     # The maximum results per page is 100.
     # @param [String] begin_time Optional parameter: The timestamp for the
     # beginning of the requested reporting period, in RFC 3339 format.  Default:
@@ -26,7 +29,7 @@ module Square
     # associated with the seller.
     # @param [String] status Optional parameter: If provided, only refunds with
     # the given status are returned. For a list of refund status values, see
-    # [PaymentRefund](#type-paymentrefund).  Default: If omitted, refunds are
+    # [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

data/lib/square/api/subscriptions_api.rb

@@ -220,7 +220,7 @@ module Square
     # [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 the response.  Default: `200`
     # @return [ListSubscriptionEventsResponse Hash] response from the API call
     def list_subscription_events(subscription_id:,
                                  cursor: nil,
@@ -259,5 +259,40 @@ module Square
         _response, data: decoded, errors: _errors
       )
     end
+
+    # Resumes a deactivated subscription.
+    # @param [String] subscription_id Required parameter: The ID of the
+    # subscription to resume.
+    # @return [ResumeSubscriptionResponse Hash] response from the API call
+    def resume_subscription(subscription_id:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/subscriptions/{subscription_id}/resume'
+      _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'
+      }
+
+      # Prepare and execute HttpRequest.
+      _request = config.http_client.post(
+        _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

data/lib/square/api/team_api.rb

@@ -54,8 +54,8 @@ module Square
     # marked as failed, but the body of the response
     # will contain explicit error information for this particular create.
     # Learn about [Troubleshooting the Teams
-    # API](https://developer.squareup.com/docs/team/troubleshooting#bulkcreatete
-    # ammembers).
+    # API](https://developer.squareup.com/docs/team/troubleshooting#bulk-create-
+    # team-members).
     # @param [BulkCreateTeamMembersRequest] body Required parameter: An object
     # containing the fields to POST for the request.  See the corresponding
     # object definition for field details.
@@ -97,8 +97,8 @@ module Square
     # marked as failed, but the body of the response
     # will contain explicit error information for this particular update.
     # Learn about [Troubleshooting the Teams
-    # API](https://developer.squareup.com/docs/team/troubleshooting#bulkupdatete
-    # ammembers).
+    # API](https://developer.squareup.com/docs/team/troubleshooting#bulk-update-
+    # team-members).
     # @param [BulkUpdateTeamMembersRequest] body Required parameter: An object
     # containing the fields to POST for the request.  See the corresponding
     # object definition for field details.
@@ -171,8 +171,8 @@ module Square
 
     # Retrieve a `TeamMember` object for the given `TeamMember.id`.
     # Learn about [Troubleshooting the Teams
-    # API](https://developer.squareup.com/docs/team/troubleshooting#retrieveteam
-    # member).
+    # 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
     # member to retrieve.
     # @return [RetrieveTeamMemberResponse Hash] response from the API call
@@ -210,8 +210,8 @@ module Square
     # Updates a single `TeamMember` object. The `TeamMember` will be returned on
     # successful updates.
     # Learn about [Troubleshooting the Teams
-    # API](https://developer.squareup.com/docs/team/troubleshooting#updateteamme
-    # mber).
+    # 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
     # member to update.
     # @param [UpdateTeamMemberRequest] body Required parameter: An object
@@ -297,8 +297,8 @@ module Square
     # it fully replaces the `WageSetting` object for the team member.
     # The `WageSetting` will be returned upon successful update.
     # Learn about [Troubleshooting the Teams
-    # API](https://developer.squareup.com/docs/team/troubleshooting#updatewagese
-    # tting).
+    # 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.
     # @param [UpdateWageSettingRequest] body Required parameter: An object

data/lib/square/api/transactions_api.rb

@@ -12,24 +12,29 @@ module Square
     # Point of Sale applications.
     # Refunds with a `status` of `PENDING` are not currently included in this
     # endpoint's response.
-    # Max results per [page](#paginatingresults): 50
+    # 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](#dateranges) for details on date inclusivity/exclusivity.  Default
-    # value: The current time minus one year.
+    # 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](#dateranges) for
-    # details on date inclusivity/exclusivity.  Default value: The current
-    # time.
+    # 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](#paginatingresults) for more information.
+    # 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,
@@ -78,24 +83,29 @@ module Square
     # Transactions include payment information from sales and exchanges and
     # refund
     # information from returns and exchanges.
-    # Max results per [page](#paginatingresults): 50
+    # 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 transactions 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.
+    # 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](#dateranges) for
-    # details on date inclusivity/exclusivity.  Default value: The current
-    # time.
+    # 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](#paginatingresults) for more information.
+    # results](https://developer.squareup.com/docs/working-with-apis/pagination)
+    # for more information.
     # @return [ListTransactionsResponse Hash] response from the API call
     def list_transactions(location_id:,
                           begin_time: nil,
@@ -156,9 +166,9 @@ module Square
     # 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](#endpoint-retrievetransaction). See the
+    # [RetrieveTransaction]($e/Transactions/RetrieveTransaction). See the
     # `processing_fee_money`
-    # field of each [Tender included](#type-tender) in the transaction.
+    # 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
@@ -241,7 +251,7 @@ module Square
     end
 
     # Captures a transaction that was created with the
-    # [Charge](#endpoint-charge)
+    # [Charge]($e/Transactions/Charge)
     # endpoint with a `delay_capture` value of `true`.
     # See [Delayed capture
     # transactions](https://developer.squareup.com/docs/payments/transactions/ov
@@ -337,7 +347,8 @@ module Square
       )
     end
 
-    # Cancels a transaction that was created with the [Charge](#endpoint-charge)
+    # Cancels a transaction that was created with the
+    # [Charge]($e/Transactions/Charge)
     # endpoint with a `delay_capture` value of `true`.
     # See [Delayed capture
     # transactions](https://developer.squareup.com/docs/payments/transactions/ov

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/client.rb

@@ -4,7 +4,7 @@ module Square
     attr_reader :config
 
     def sdk_version
-      '9.1.1.20210317'
+      '10.0.0.20210421'
     end
 
     def square_version
@@ -188,7 +188,7 @@ module Square
     def initialize(timeout: 60, max_retries: 0, retry_interval: 1,
                    backoff_factor: 1, environment: 'production',
                    custom_url: 'https://connect.squareup.com',
-                   square_version: '2021-03-17', access_token: 'TODO: Replace',
+                   square_version: '2021-04-21', access_token: 'TODO: Replace',
                    additional_headers: {}, config: nil)
       @config = if config.nil?
                   Configuration.new(timeout: timeout, max_retries: max_retries,

data/lib/square/configuration.rb

@@ -24,7 +24,7 @@ module Square
     def initialize(timeout: 60, max_retries: 0, retry_interval: 1,
                    backoff_factor: 1, environment: 'production',
                    custom_url: 'https://connect.squareup.com',
-                   square_version: '2021-03-17', access_token: 'TODO: Replace',
+                   square_version: '2021-04-21', access_token: 'TODO: Replace',
                    additional_headers: {})
       # The value to use for connection timeout
       @timeout = timeout

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.1.20210317
+  version: 10.0.0.20210421
 platform: ruby
 authors:
 - Square Developer Platform
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-04-02 00:00:00.000000000 Z
+date: 2021-04-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logging