square.rb 14.1.0.20210915 → 17.0.0.20211215

data/lib/square/api/payments_api.rb

@@ -107,7 +107,7 @@ module Square
       # Prepare headers.
       _headers = {
         'accept' => 'application/json',
-        'content-type' => 'application/json; charset=utf-8'
+        'Content-Type' => 'application/json'
       }
 
       # Prepare and execute HttpRequest.
@@ -155,7 +155,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.
@@ -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'
       }
 
       # 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/refunds_api.rb

@@ -105,7 +105,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/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/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.