square.rb 6.3.0.20200826 → 17.1.0.20220120

data/lib/square/api/team_api.rb

@@ -5,14 +5,14 @@ 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:
-    # - `first_name`
-    # - `last_name`
-    # Learn about [Troubleshooting the Teams
-    # API](https://developer.squareup.com/docs/docs/team/troubleshooting#createt
-    # eammember).
+    # - `given_name`
+    # - `family_name`
+    # Learn about [Troubleshooting the Team
+    # 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.
@@ -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.
@@ -41,19 +41,21 @@ 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
-    # 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/docs/team/troubleshooting#bulkcre
-    # ateteammembers).
+    # 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.
@@ -67,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.
@@ -82,19 +84,21 @@ 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
-    # 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/docs/team/troubleshooting#bulkupd
-    # ateteammembers).
+    # 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.
@@ -108,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.
@@ -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`
+    # 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
     # object definition for field details.
@@ -143,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.
@@ -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`
-    # Learn about [Troubleshooting the Teams
-    # API](https://developer.squareup.com/docs/docs/team/troubleshooting#retriev
-    # eteammember).
+    # 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
@@ -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).
+    # 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
@@ -215,14 +225,14 @@ 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
 
       # Prepare headers.
       _headers = {
         'accept' => 'application/json',
-        'content-type' => 'application/json; charset=utf-8'
+        'Content-Type' => 'application/json'
       }
 
       # Prepare and execute HttpRequest.
@@ -237,16 +247,18 @@ 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
+    # Retrieves 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).
+    # 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.
@@ -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,19 +286,21 @@ 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
     # `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/docs/team/troubleshooting#updatew
-    # agesetting).
+    # 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.
@@ -298,14 +312,14 @@ 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
 
       # Prepare headers.
       _headers = {
         'accept' => 'application/json',
-        'content-type' => 'application/json; charset=utf-8'
+        'Content-Type' => 'application/json'
       }
 
       # Prepare and execute HttpRequest.
@@ -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

@@ -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.
@@ -35,7 +36,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
@@ -53,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.
@@ -68,12 +71,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 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.
@@ -81,7 +86,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,13 +106,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
 
-    # 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`
+    # @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.
@@ -115,7 +122,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'
+      }
+
+      # 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 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
+    # 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'
+      }
+
+      # 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: 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.
+      _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: 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.
+      _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 +283,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