square.rb 6.4.0.20200923 → 9.0.0.20210226

data/lib/square/api/subscriptions_api.rb

@@ -40,7 +40,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
 
     # Searches for subscriptions.
@@ -58,8 +60,8 @@ module Square
     # customer by subscription creation date.
     # For more information, see
     # [Retrieve
-    # subscriptions](https://developer.squareup.com/docs/docs/subscriptions-api/
-    # overview#retrieve-subscriptions).
+    # 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.
@@ -88,7 +90,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
 
     # Retrieves a subscription.
@@ -101,7 +105,7 @@ module Square
       _query_builder << '/v2/subscriptions/{subscription_id}'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'subscription_id' => subscription_id
+        'subscription_id' => { 'value' => subscription_id, 'encode' => true }
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -121,7 +125,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 a subscription. You can set, modify, and clear the
@@ -139,7 +145,7 @@ module Square
       _query_builder << '/v2/subscriptions/{subscription_id}'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'subscription_id' => subscription_id
+        'subscription_id' => { 'value' => subscription_id, 'encode' => true }
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -161,7 +167,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
 
     # Sets the `canceled_date` field to the end of the active billing period.
@@ -175,7 +183,7 @@ module Square
       _query_builder << '/v2/subscriptions/{subscription_id}/cancel'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'subscription_id' => subscription_id
+        'subscription_id' => { 'value' => subscription_id, 'encode' => true }
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -195,7 +203,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
 
     # Lists all events for a specific subscription.
@@ -207,8 +217,8 @@ module Square
     # @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/docs/working-with-apis/pa
-    # gination).
+    # [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
@@ -220,7 +230,7 @@ module Square
       _query_builder << '/v2/subscriptions/{subscription_id}/events'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'subscription_id' => subscription_id
+        'subscription_id' => { 'value' => subscription_id, 'encode' => true }
       )
       _query_builder = APIHelper.append_url_with_query_parameters(
         _query_builder,
@@ -245,7 +255,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/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

data/lib/square/api/terminal_api.rb

@@ -35,7 +35,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
 
     # Retrieves a filtered list of Terminal checkout requests created by the
@@ -68,7 +70,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
 
     # Retrieves a Terminal checkout request by checkout_id.
@@ -81,7 +85,7 @@ module Square
       _query_builder << '/v2/terminals/checkouts/{checkout_id}'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'checkout_id' => checkout_id
+        'checkout_id' => { 'value' => checkout_id, 'encode' => true }
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -101,10 +105,12 @@ 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
 
-    # Cancels a Terminal checkout request, if the status of the request permits
+    # 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`
@@ -115,7 +121,148 @@ module Square
       _query_builder << '/v2/terminals/checkouts/{checkout_id}/cancel'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'checkout_id' => checkout_id
+        'checkout_id' => { 'value' => checkout_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
+
+    # Creates a request to refund an Interac payment completed on a Square
+    # Terminal.
+    # @param [CreateTerminalRefundRequest] body Required parameter: An object
+    # containing the fields to POST for the request.  See the corresponding
+    # object definition for field details.
+    # @return [CreateTerminalRefundResponse Hash] response from the API call
+    def create_terminal_refund(body:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/terminals/refunds'
+      _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 filtered list of Terminal Interac 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
+    # object definition for field details.
+    # @return [SearchTerminalRefundsResponse Hash] response from the API call
+    def search_terminal_refunds(body:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/terminals/refunds/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 an Interac terminal refund object by ID.
+    # @param [String] terminal_refund_id Required parameter: Unique ID for the
+    # desired `TerminalRefund`
+    # @return [GetTerminalRefundResponse Hash] response from the API call
+    def get_terminal_refund(terminal_refund_id:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/terminals/refunds/{terminal_refund_id}'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'terminal_refund_id' => { 'value' => terminal_refund_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
+
+    # 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`
+    # @return [CancelTerminalRefundResponse Hash] response from the API call
+    def cancel_terminal_refund(terminal_refund_id:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/terminals/refunds/{terminal_refund_id}/cancel'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'terminal_refund_id' => { 'value' => terminal_refund_id, 'encode' => true }
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -135,7 +282,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