square.rb 8.1.0.20210121 → 18.1.0.20220316

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,
@@ -259,5 +312,130 @@ module Square
         _response, data: decoded, errors: _errors
       )
     end
+
+    # 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:,
+                            body:)
+      # 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',
+        '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 `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)
+
+      # 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

@@ -5,12 +5,12 @@ module Square
       super(config, http_call_back: http_call_back)
     end
 
-    # Creates a single `TeamMember` object. The `TeamMember` will be returned on
-    # successful creates.
+    # Creates a single `TeamMember` object. The `TeamMember` object is returned
+    # on successful creates.
     # You must provide the following values in your request to this endpoint:
     # - `given_name`
     # - `family_name`
-    # Learn about [Troubleshooting the Teams
+    # Learn about [Troubleshooting the Team
     # API](https://developer.squareup.com/docs/team/troubleshooting#createteamme
     # mber).
     # @param [CreateTeamMemberRequest] body Required parameter: An object
@@ -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.
@@ -47,15 +47,15 @@ module Square
     end
 
     # Creates multiple `TeamMember` objects. The created `TeamMember` objects
-    # will be returned on successful creates.
-    # This process is non-transactional and will process as much of the request
-    # as is possible. If one of the creates in
-    # the request cannot be successfully processed, the request will NOT be
-    # 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).
+    # are returned on successful creates.
+    # This process is non-transactional and processes as much of the request as
+    # possible. If one of the creates in
+    # the request cannot be successfully processed, the request is not marked as
+    # failed, but the body of the response
+    # contains explicit error information for the failed create.
+    # Learn about [Troubleshooting the Team
+    # 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.
@@ -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.
@@ -90,15 +90,15 @@ module Square
     end
 
     # Updates multiple `TeamMember` objects. The updated `TeamMember` objects
-    # will be returned on successful updates.
-    # This process is non-transactional and will process as much of the request
-    # as is possible. If one of the updates in
-    # the request cannot be successfully processed, the request will NOT be
-    # 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).
+    # are returned on successful updates.
+    # This process is non-transactional and processes as much of the request as
+    # possible. If one of the updates in
+    # the request cannot be successfully processed, the request is not marked as
+    # failed, but the body of the response
+    # contains explicit error information for the failed update.
+    # Learn about [Troubleshooting the Team
+    # 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.
@@ -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.
@@ -133,8 +133,8 @@ module Square
     end
 
     # Returns a paginated list of `TeamMember` objects for a business.
-    # The list to be returned can be filtered by:
-    # - location IDs **and**
+    # The list can be filtered by the following:
+    # - location IDs
     # - `status`
     # @param [SearchTeamMembersRequest] body Required parameter: An object
     # containing the fields to POST for the request.  See the corresponding
@@ -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.
@@ -169,10 +169,10 @@ module Square
       )
     end
 
-    # Retrieve a `TeamMember` object for the given `TeamMember.id`.
-    # Learn about [Troubleshooting the Teams
-    # API](https://developer.squareup.com/docs/team/troubleshooting#retrieveteam
-    # member).
+    # Retrieves a `TeamMember` object for the given `TeamMember.id`.
+    # Learn about [Troubleshooting the Team
+    # 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
@@ -207,11 +207,11 @@ module Square
       )
     end
 
-    # 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).
+    # Updates a single `TeamMember` object. The `TeamMember` object is returned
+    # on successful updates.
+    # Learn about [Troubleshooting the Team
+    # 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
@@ -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.
@@ -252,13 +252,13 @@ module Square
       )
     end
 
-    # Retrieve a `WageSetting` object for a team member specified
+    # Retrieves a `WageSetting` object for a team member specified
     # by `TeamMember.id`.
-    # Learn about [Troubleshooting the Teams
+    # Learn about [Troubleshooting the Team
     # API](https://developer.squareup.com/docs/team/troubleshooting#retrievewage
     # setting).
     # @param [String] team_member_id Required parameter: The ID of the team
-    # member to retrieve wage setting for
+    # member for which to retrieve the wage setting.
     # @return [RetrieveWageSettingResponse Hash] response from the API call
     def retrieve_wage_setting(team_member_id:)
       # Prepare query url.
@@ -295,12 +295,12 @@ module Square
     # `WageSetting` with the specified `team_member_id` does not exist.
     # Otherwise,
     # 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).
+    # The `WageSetting` is returned on a successful update.
+    # Learn about [Troubleshooting the Team
+    # 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.
+    # member for which to update the `WageSetting` object.
     # @param [UpdateWageSettingRequest] body Required parameter: An object
     # containing the fields to POST for the request.  See the corresponding
     # object definition for field details.
@@ -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

@@ -5,8 +5,9 @@ module Square
       super(config, http_call_back: http_call_back)
     end
 
-    # Creates a new Terminal checkout request and sends it to the specified
-    # device to take a payment for the requested amount.
+    # Creates a Terminal checkout request and sends it to the specified device
+    # to take a payment
+    # for the requested amount.
     # @param [CreateTerminalCheckoutRequest] body Required parameter: An object
     # containing the fields to POST for the request.  See the corresponding
     # object definition for field details.
@@ -20,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.
@@ -55,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.
@@ -75,9 +76,9 @@ module Square
       )
     end
 
-    # Retrieves a Terminal checkout request by checkout_id.
-    # @param [String] checkout_id Required parameter: Unique ID for the desired
-    # `TerminalCheckout`
+    # Retrieves a Terminal checkout request by `checkout_id`.
+    # @param [String] checkout_id Required parameter: The unique ID for the
+    # desired `TerminalCheckout`.
     # @return [GetTerminalCheckoutResponse Hash] response from the API call
     def get_terminal_checkout(checkout_id:)
       # Prepare query url.
@@ -112,8 +113,8 @@ module Square
 
     # Cancels a Terminal checkout request if the status of the request permits
     # it.
-    # @param [String] checkout_id Required parameter: Unique ID for the desired
-    # `TerminalCheckout`
+    # @param [String] checkout_id Required parameter: The unique ID for the
+    # desired `TerminalCheckout`.
     # @return [CancelTerminalCheckoutResponse Hash] response from the API call
     def cancel_terminal_checkout(checkout_id:)
       # Prepare query url.
@@ -161,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.
@@ -181,7 +182,7 @@ module Square
       )
     end
 
-    # Retrieves a filtered list of Terminal Interac refund requests created by
+    # Retrieves a filtered list of Interac Terminal refund requests created by
     # the seller making the request.
     # @param [SearchTerminalRefundsRequest] body Required parameter: An object
     # containing the fields to POST for the request.  See the corresponding
@@ -196,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.
@@ -216,9 +217,9 @@ module Square
       )
     end
 
-    # Retrieves an Interac terminal refund object by ID.
-    # @param [String] terminal_refund_id Required parameter: Unique ID for the
-    # desired `TerminalRefund`
+    # Retrieves an Interac Terminal refund object by ID.
+    # @param [String] terminal_refund_id Required parameter: The unique ID for
+    # the desired `TerminalRefund`.
     # @return [GetTerminalRefundResponse Hash] response from the API call
     def get_terminal_refund(terminal_refund_id:)
       # Prepare query url.
@@ -251,10 +252,10 @@ module Square
       )
     end
 
-    # Cancels an Interac terminal refund request by refund request ID if the
+    # Cancels an Interac Terminal refund request by refund request ID if the
     # status of the request permits it.
-    # @param [String] terminal_refund_id Required parameter: Unique ID for the
-    # desired `TerminalRefund`
+    # @param [String] terminal_refund_id Required parameter: The unique ID for
+    # the desired `TerminalRefund`.
     # @return [CancelTerminalRefundResponse Hash] response from the API call
     def cancel_terminal_refund(terminal_refund_id:)
       # Prepare query url.