square.rb 6.0.0.20200625 → 6.5.0.20201028

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

data/lib/square/api/transactions_api.rb

@@ -42,7 +42,7 @@ module Square
       _query_builder << '/v2/locations/{location_id}/refunds'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'location_id' => location_id
+        'location_id' => { 'value' => location_id, 'encode' => true }
       )
       _query_builder = APIHelper.append_url_with_query_parameters(
         _query_builder,
@@ -69,7 +69,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 transactions for a particular location.
@@ -106,7 +108,7 @@ module Square
       _query_builder << '/v2/locations/{location_id}/transactions'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'location_id' => location_id
+        'location_id' => { 'value' => location_id, 'encode' => true }
       )
       _query_builder = APIHelper.append_url_with_query_parameters(
         _query_builder,
@@ -133,7 +135,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
 
     # Charges a card represented by a card nonce or a customer's card on file.
@@ -169,7 +173,7 @@ module Square
       _query_builder << '/v2/locations/{location_id}/transactions'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'location_id' => location_id
+        'location_id' => { 'value' => location_id, 'encode' => true }
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -191,7 +195,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 details for a single transaction.
@@ -208,8 +214,8 @@ module Square
       _query_builder << '/v2/locations/{location_id}/transactions/{transaction_id}'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'location_id' => location_id,
-        'transaction_id' => transaction_id
+        'location_id' => { 'value' => location_id, 'encode' => true },
+        'transaction_id' => { 'value' => transaction_id, 'encode' => true }
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -229,7 +235,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
 
     # Captures a transaction that was created with the
@@ -250,8 +258,8 @@ module Square
       _query_builder << '/v2/locations/{location_id}/transactions/{transaction_id}/capture'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'location_id' => location_id,
-        'transaction_id' => transaction_id
+        'location_id' => { 'value' => location_id, 'encode' => true },
+        'transaction_id' => { 'value' => transaction_id, 'encode' => true }
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -271,7 +279,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
 
     # Initiates a refund for a previously charged tender.
@@ -299,8 +309,8 @@ module Square
       _query_builder << '/v2/locations/{location_id}/transactions/{transaction_id}/refund'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'location_id' => location_id,
-        'transaction_id' => transaction_id
+        'location_id' => { 'value' => location_id, 'encode' => true },
+        'transaction_id' => { 'value' => transaction_id, 'encode' => true }
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -322,7 +332,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
 
     # Cancels a transaction that was created with the [Charge](#endpoint-charge)
@@ -342,8 +354,8 @@ module Square
       _query_builder << '/v2/locations/{location_id}/transactions/{transaction_id}/void'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'location_id' => location_id,
-        'transaction_id' => transaction_id
+        'location_id' => { 'value' => location_id, 'encode' => true },
+        'transaction_id' => { 'value' => transaction_id, 'encode' => true }
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -363,7 +375,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/v1_employees_api.rb

@@ -75,7 +75,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
 
     #  Use the CreateEmployee endpoint to add an employee to a Square
@@ -115,7 +117,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
 
     # Provides the details for a single employee.
@@ -127,7 +131,7 @@ module Square
       _query_builder << '/v1/me/employees/{employee_id}'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'employee_id' => employee_id
+        'employee_id' => { 'value' => employee_id, 'encode' => true }
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -147,7 +151,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
 
     # UpdateEmployee
@@ -164,7 +170,7 @@ module Square
       _query_builder << '/v1/me/employees/{employee_id}'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'employee_id' => employee_id
+        'employee_id' => { 'value' => employee_id, 'encode' => true }
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -186,7 +192,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
 
     # Provides summary information for all of a business's employee roles.
@@ -230,7 +238,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 an employee role you can then assign to employees.
@@ -270,7 +280,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
 
     # Provides the details for a single employee role.
@@ -282,7 +294,7 @@ module Square
       _query_builder << '/v1/me/roles/{role_id}'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'role_id' => role_id
+        'role_id' => { 'value' => role_id, 'encode' => true }
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -302,7 +314,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
 
     # Modifies the details of an employee role.
@@ -319,7 +333,7 @@ module Square
       _query_builder << '/v1/me/roles/{role_id}'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'role_id' => role_id
+        'role_id' => { 'value' => role_id, 'encode' => true }
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -341,7 +355,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
 
     # Provides summary information for all of a business's employee timecards.
@@ -425,7 +441,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 a timecard for an employee and clocks them in with an
@@ -468,7 +486,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
 
     # Deletes a timecard. Timecards can also be deleted through the
@@ -494,7 +514,7 @@ module Square
       _query_builder << '/v1/me/timecards/{timecard_id}'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'timecard_id' => timecard_id
+        'timecard_id' => { 'value' => timecard_id, 'encode' => true }
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -506,7 +526,9 @@ module Square
       _response = execute_request(_request)
 
       # Return appropriate response type.
-      ApiResponse.new(_response, data: _response.raw_body)
+      ApiResponse.new(
+        _response, data: _response.raw_body
+      )
     end
 
     # Provides the details for a single timecard.
@@ -524,7 +546,7 @@ module Square
       _query_builder << '/v1/me/timecards/{timecard_id}'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'timecard_id' => timecard_id
+        'timecard_id' => { 'value' => timecard_id, 'encode' => true }
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -544,7 +566,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
 
     # Modifies the details of a timecard with an `API_EDIT` event for
@@ -564,7 +588,7 @@ module Square
       _query_builder << '/v1/me/timecards/{timecard_id}'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'timecard_id' => timecard_id
+        'timecard_id' => { 'value' => timecard_id, 'encode' => true }
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -586,7 +610,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
 
     # Provides summary information for all events associated with a
@@ -606,7 +632,7 @@ module Square
       _query_builder << '/v1/me/timecards/{timecard_id}/events'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'timecard_id' => timecard_id
+        'timecard_id' => { 'value' => timecard_id, 'encode' => true }
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -626,7 +652,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
 
     # Provides the details for all of a location's cash drawer shifts during a
@@ -653,7 +681,7 @@ module Square
       _query_builder << '/v1/{location_id}/cash-drawer-shifts'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'location_id' => location_id
+        'location_id' => { 'value' => location_id, 'encode' => true }
       )
       _query_builder = APIHelper.append_url_with_query_parameters(
         _query_builder,
@@ -679,7 +707,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
 
     # Provides the details for a single cash drawer shift, including all events
@@ -696,8 +726,8 @@ module Square
       _query_builder << '/v1/{location_id}/cash-drawer-shifts/{shift_id}'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'location_id' => location_id,
-        'shift_id' => shift_id
+        'location_id' => { 'value' => location_id, 'encode' => true },
+        'shift_id' => { 'value' => shift_id, 'encode' => true }
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -717,7 +747,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