square.rb 6.1.0.20200722 → 7.0.0.20201118

data/lib/square/api/refunds_api.rb

@@ -6,32 +6,36 @@ module Square
     end
 
     # Retrieves a list of refunds for the account making the request.
-    # Max results per page: 100
-    # @param [String] begin_time Optional parameter: Timestamp for the beginning
-    # of the requested reporting period, in RFC 3339 format.  Default: The
-    # current time minus one year.
-    # @param [String] end_time Optional parameter: Timestamp for the end of the
-    # requested reporting period, in RFC 3339 format.  Default: The current
+    # 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:
+    # The current time minus one year.
+    # @param [String] end_time Optional parameter: The timestamp for the end of
+    # the requested reporting period, in RFC 3339 format.  Default: The current
     # time.
     # @param [String] sort_order Optional parameter: The order in which results
-    # are listed. - `ASC` - oldest to newest - `DESC` - newest to oldest
+    # are listed: - `ASC` - Oldest to newest. - `DESC` - Newest to oldest
     # (default).
     # @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.  See
+    # a previous call to this endpoint. Provide this cursor to retrieve the next
+    # set of results for the original query.  For more information, see
     # [Pagination](https://developer.squareup.com/docs/basics/api101/pagination)
-    # for more information.
+    # .
     # @param [String] location_id Optional parameter: Limit results to the
     # location supplied. By default, results are returned for all locations
-    # associated with the merchant.
+    # 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
-    # returned regardless of status.
+    # [PaymentRefund](#type-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 payment source.  Default: If omitted
-    # refunds are returned regardless of source type.
+    # payments where `CARD` was specified as the payment source.  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
+    # greater than 100, no more than 100 results are returned.  Default: 100
     # @return [ListPaymentRefundsResponse Hash] response from the API call
     def list_payment_refunds(begin_time: nil,
                              end_time: nil,
@@ -39,7 +43,8 @@ module Square
                              cursor: nil,
                              location_id: nil,
                              status: nil,
-                             source_type: nil)
+                             source_type: nil,
+                             limit: nil)
       # Prepare query url.
       _query_builder = config.get_base_uri
       _query_builder << '/v2/refunds'
@@ -51,7 +56,8 @@ module Square
         'cursor' => cursor,
         'location_id' => location_id,
         'status' => status,
-        'source_type' => source_type
+        'source_type' => source_type,
+        'limit' => limit
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -71,13 +77,13 @@ module Square
       # Return appropriate response type.
       decoded = APIHelper.json_deserialize(_response.raw_body)
       _errors = APIHelper.map_response(decoded, ['errors'])
-      ApiResponse.new(_response, data: decoded, errors: _errors)
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
     end
 
     # Refunds a payment. You can refund the entire payment amount or a
-    # portion of it. For more information, see
-    # [Payments and Refunds
-    # Overview](https://developer.squareup.com/docs/payments-api/overview).
+    # portion of it.
     # @param [RefundPaymentRequest] body Required parameter: An object
     # containing the fields to POST for the request.  See the corresponding
     # object definition for field details.
@@ -106,12 +112,14 @@ module Square
       # Return appropriate response type.
       decoded = APIHelper.json_deserialize(_response.raw_body)
       _errors = APIHelper.map_response(decoded, ['errors'])
-      ApiResponse.new(_response, data: decoded, errors: _errors)
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
     end
 
-    # Retrieves a specific `Refund` using the `refund_id`.
-    # @param [String] refund_id Required parameter: Unique ID for the desired
-    # `PaymentRefund`.
+    # Retrieves a specific refund using the `refund_id`.
+    # @param [String] refund_id Required parameter: The unique ID for the
+    # desired `PaymentRefund`.
     # @return [GetPaymentRefundResponse Hash] response from the API call
     def get_payment_refund(refund_id:)
       # Prepare query url.
@@ -119,7 +127,7 @@ module Square
       _query_builder << '/v2/refunds/{refund_id}'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'refund_id' => refund_id
+        'refund_id' => { 'value' => refund_id, 'encode' => true }
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -139,7 +147,9 @@ module Square
       # Return appropriate response type.
       decoded = APIHelper.json_deserialize(_response.raw_body)
       _errors = APIHelper.map_response(decoded, ['errors'])
-      ApiResponse.new(_response, data: decoded, errors: _errors)
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
     end
   end
 end

data/lib/square/api/subscriptions_api.rb

@@ -0,0 +1,263 @@
+module Square
+  # SubscriptionsApi
+  class SubscriptionsApi < BaseApi
+    def initialize(config, http_call_back: nil)
+      super(config, http_call_back: http_call_back)
+    end
+
+    # Creates a subscription for a customer to a subscription plan.
+    # 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
+    # address. The subscription starts immediately, unless the request includes
+    # the optional `start_date`. Each individual subscription is associated with
+    # a particular location.
+    # @param [CreateSubscriptionRequest] body Required parameter: An object
+    # containing the fields to POST for the request.  See the corresponding
+    # object definition for field details.
+    # @return [CreateSubscriptionResponse Hash] response from the API call
+    def create_subscription(body:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/subscriptions'
+      _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
+
+    # Searches for subscriptions.
+    # Results are ordered chronologically by subscription creation date. If
+    # the request specifies more than one location ID,
+    # the endpoint orders the result
+    # by location ID, and then by creation date within each location. If no
+    # locations are given
+    # in the query, all locations are searched.
+    # You can also optionally specify `customer_ids` to search by customer.
+    # If left unset, all customers
+    # associated with the specified locations are returned.
+    # If the request specifies customer IDs, the endpoint orders results
+    # first by location, within location by customer ID, and within
+    # customer by subscription creation date.
+    # For more information, see
+    # [Retrieve
+    # subscriptions](https://developer.squareup.com/docs/subscriptions-api/overv
+    # iew#retrieve-subscriptions).
+    # @param [SearchSubscriptionsRequest] body Required parameter: An object
+    # containing the fields to POST for the request.  See the corresponding
+    # object definition for field details.
+    # @return [SearchSubscriptionsResponse Hash] response from the API call
+    def search_subscriptions(body:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/subscriptions/search'
+      _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 a subscription.
+    # @param [String] subscription_id Required parameter: The ID of the
+    # subscription to retrieve.
+    # @return [RetrieveSubscriptionResponse Hash] response from the API call
+    def retrieve_subscription(subscription_id:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/subscriptions/{subscription_id}'
+      _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.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
+
+    # Updates a subscription. You can set, modify, and clear the
+    # `subscription` field values.
+    # @param [String] subscription_id Required parameter: The ID for the
+    # subscription to update.
+    # @param [UpdateSubscriptionRequest] body Required parameter: An object
+    # containing the fields to POST for the request.  See the corresponding
+    # object definition for field details.
+    # @return [UpdateSubscriptionResponse Hash] response from the API call
+    def update_subscription(subscription_id:,
+                            body:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/subscriptions/{subscription_id}'
+      _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; charset=utf-8'
+      }
+
+      # Prepare and execute HttpRequest.
+      _request = config.http_client.put(
+        _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
+
+    # Sets the `canceled_date` field to the end of the active billing period.
+    # After this date, the status changes from ACTIVE to CANCELED.
+    # @param [String] subscription_id Required parameter: The ID of the
+    # subscription to cancel.
+    # @return [CancelSubscriptionResponse Hash] response from the API call
+    def cancel_subscription(subscription_id:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/subscriptions/{subscription_id}/cancel'
+      _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
+
+    # Lists all events for a specific subscription.
+    # In the current implementation, only `START_SUBSCRIPTION` and
+    # `STOP_SUBSCRIPTION` (when the subscription was canceled) events are
+    # 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
+    # [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`
+    # @return [ListSubscriptionEventsResponse Hash] response from the API call
+    def list_subscription_events(subscription_id:,
+                                 cursor: nil,
+                                 limit: nil)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/subscriptions/{subscription_id}/events'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'subscription_id' => { 'value' => subscription_id, 'encode' => true }
+      )
+      _query_builder = APIHelper.append_url_with_query_parameters(
+        _query_builder,
+        'cursor' => cursor,
+        'limit' => limit
+      )
+      _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

data/lib/square/api/team_api.rb

@@ -8,11 +8,11 @@ module Square
     # Creates a single `TeamMember` object. The `TeamMember` will be returned on
     # successful creates.
     # You must provide the following values in your request to this endpoint:
-    # - `first_name`
-    # - `last_name`
+    # - `given_name`
+    # - `family_name`
     # Learn about [Troubleshooting the Teams
-    # API](https://developer.squareup.com/docs/docs/team/troubleshooting#createt
-    # eammember).
+    # API](https://developer.squareup.com/docs/team/troubleshooting#createteamme
+    # mber).
     # @param [CreateTeamMemberRequest] body Required parameter: An object
     # containing the fields to POST for the request.  See the corresponding
     # object definition for field details.
@@ -41,7 +41,9 @@ module Square
       # Return appropriate response type.
       decoded = APIHelper.json_deserialize(_response.raw_body)
       _errors = APIHelper.map_response(decoded, ['errors'])
-      ApiResponse.new(_response, data: decoded, errors: _errors)
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
     end
 
     # Creates multiple `TeamMember` objects. The created `TeamMember` objects
@@ -52,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/docs/team/troubleshooting#bulkcre
-    # ateteammembers).
+    # API](https://developer.squareup.com/docs/team/troubleshooting#bulkcreatete
+    # ammembers).
     # @param [BulkCreateTeamMembersRequest] body Required parameter: An object
     # containing the fields to POST for the request.  See the corresponding
     # object definition for field details.
@@ -82,7 +84,9 @@ module Square
       # Return appropriate response type.
       decoded = APIHelper.json_deserialize(_response.raw_body)
       _errors = APIHelper.map_response(decoded, ['errors'])
-      ApiResponse.new(_response, data: decoded, errors: _errors)
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
     end
 
     # Updates multiple `TeamMember` objects. The updated `TeamMember` objects
@@ -93,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/docs/team/troubleshooting#bulkupd
-    # ateteammembers).
+    # API](https://developer.squareup.com/docs/team/troubleshooting#bulkupdatete
+    # ammembers).
     # @param [BulkUpdateTeamMembersRequest] body Required parameter: An object
     # containing the fields to POST for the request.  See the corresponding
     # object definition for field details.
@@ -123,13 +127,15 @@ module Square
       # Return appropriate response type.
       decoded = APIHelper.json_deserialize(_response.raw_body)
       _errors = APIHelper.map_response(decoded, ['errors'])
-      ApiResponse.new(_response, data: decoded, errors: _errors)
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
     end
 
     # Returns a paginated list of `TeamMember` objects for a business.
     # The list to be returned can be filtered by:
     # - location IDs **and**
-    # - `is_active`
+    # - `status`
     # @param [SearchTeamMembersRequest] body Required parameter: An object
     # containing the fields to POST for the request.  See the corresponding
     # object definition for field details.
@@ -158,13 +164,15 @@ module Square
       # Return appropriate response type.
       decoded = APIHelper.json_deserialize(_response.raw_body)
       _errors = APIHelper.map_response(decoded, ['errors'])
-      ApiResponse.new(_response, data: decoded, errors: _errors)
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
     end
 
-    # Retrieve a `TeamMember` object for the given `TeamMember.id`
+    # Retrieve a `TeamMember` object for the given `TeamMember.id`.
     # Learn about [Troubleshooting the Teams
-    # API](https://developer.squareup.com/docs/docs/team/troubleshooting#retriev
-    # eteammember).
+    # API](https://developer.squareup.com/docs/team/troubleshooting#retrieveteam
+    # member).
     # @param [String] team_member_id Required parameter: The ID of the team
     # member to retrieve.
     # @return [RetrieveTeamMemberResponse Hash] response from the API call
@@ -174,7 +182,7 @@ module Square
       _query_builder << '/v2/team-members/{team_member_id}'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'team_member_id' => team_member_id
+        'team_member_id' => { 'value' => team_member_id, 'encode' => true }
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -194,14 +202,16 @@ module Square
       # Return appropriate response type.
       decoded = APIHelper.json_deserialize(_response.raw_body)
       _errors = APIHelper.map_response(decoded, ['errors'])
-      ApiResponse.new(_response, data: decoded, errors: _errors)
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
     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/docs/team/troubleshooting#updatet
-    # eammember).
+    # API](https://developer.squareup.com/docs/team/troubleshooting#updateteamme
+    # mber).
     # @param [String] team_member_id Required parameter: The ID of the team
     # member to update.
     # @param [UpdateTeamMemberRequest] body Required parameter: An object
@@ -215,7 +225,7 @@ module Square
       _query_builder << '/v2/team-members/{team_member_id}'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'team_member_id' => team_member_id
+        'team_member_id' => { 'value' => team_member_id, 'encode' => true }
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -237,14 +247,16 @@ module Square
       # Return appropriate response type.
       decoded = APIHelper.json_deserialize(_response.raw_body)
       _errors = APIHelper.map_response(decoded, ['errors'])
-      ApiResponse.new(_response, data: decoded, errors: _errors)
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
     end
 
     # Retrieve a `WageSetting` object for a team member specified
     # by `TeamMember.id`.
     # Learn about [Troubleshooting the Teams
-    # API](https://developer.squareup.com/docs/docs/team/troubleshooting#retriev
-    # ewagesetting).
+    # 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
     # @return [RetrieveWageSettingResponse Hash] response from the API call
@@ -254,7 +266,7 @@ module Square
       _query_builder << '/v2/team-members/{team_member_id}/wage-setting'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'team_member_id' => team_member_id
+        'team_member_id' => { 'value' => team_member_id, 'encode' => true }
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -274,7 +286,9 @@ module Square
       # Return appropriate response type.
       decoded = APIHelper.json_deserialize(_response.raw_body)
       _errors = APIHelper.map_response(decoded, ['errors'])
-      ApiResponse.new(_response, data: decoded, errors: _errors)
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
     end
 
     # Creates or updates a `WageSetting` object. The object is created if a
@@ -283,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/docs/team/troubleshooting#updatew
-    # agesetting).
+    # API](https://developer.squareup.com/docs/team/troubleshooting#updatewagese
+    # tting).
     # @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
@@ -298,7 +312,7 @@ module Square
       _query_builder << '/v2/team-members/{team_member_id}/wage-setting'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'team_member_id' => team_member_id
+        'team_member_id' => { 'value' => team_member_id, 'encode' => true }
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -320,7 +334,9 @@ module Square
       # Return appropriate response type.
       decoded = APIHelper.json_deserialize(_response.raw_body)
       _errors = APIHelper.map_response(decoded, ['errors'])
-      ApiResponse.new(_response, data: decoded, errors: _errors)
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
     end
   end
 end