class Wallee::TokenService
Attributes
Public Class Methods
# File lib/wallee-ruby-sdk/api/token_service_api.rb, line 24 def initialize(api_client = ApiClient.default) @api_client = api_client end
Public Instance Methods
Check If Token
Creation Is Possible This operation checks if the given transaction can be used to create a token out of it. @param space_id @param transaction_id The id of the transaction for which we want to check if the token can be created or not. @param [Hash] opts the optional parameters @return [BOOLEAN]
# File lib/wallee-ruby-sdk/api/token_service_api.rb, line 34 def check_token_creation_possible(space_id, transaction_id, opts = {}) data, _status_code, _headers = check_token_creation_possible_with_http_info(space_id, transaction_id, opts) return data end
Check If Token
Creation Is Possible This operation checks if the given transaction can be used to create a token out of it. @param space_id @param transaction_id The id of the transaction for which we want to check if the token can be created or not. @param [Hash] opts the optional parameters @return [Array<(BOOLEAN, Fixnum, Hash)>] BOOLEAN data, response status code and response headers
# File lib/wallee-ruby-sdk/api/token_service_api.rb, line 45 def check_token_creation_possible_with_http_info(space_id, transaction_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: TokenService.check_token_creation_possible ..." end # verify the required parameter 'space_id' is set fail ArgumentError, "Missing the required parameter 'space_id' when calling TokenService.check_token_creation_possible" if space_id.nil? # verify the required parameter 'transaction_id' is set fail ArgumentError, "Missing the required parameter 'transaction_id' when calling TokenService.check_token_creation_possible" if transaction_id.nil? # resource path local_var_path = "/token/check-token-creation-possible".sub('{format}','json') # query parameters query_params = {} query_params[:'spaceId'] = space_id query_params[:'transactionId'] = transaction_id # header parameters header_params = {} # HTTP header 'Accept' (if needed) local_header_accept = [] local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result # HTTP header 'Content-Type' local_header_content_type = [] header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = [] data, status_code, headers = @api_client.call_api(:POST, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'BOOLEAN') if @api_client.config.debugging @api_client.config.logger.debug "API called: TokenService#check_token_creation_possible\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Count Counts the number of items in the database as restricted by the given filter. @param space_id @param [Hash] opts the optional parameters @option opts [EntityQueryFilter] :filter The filter which restricts the entities which are used to calculate the count. @return [Integer]
# File lib/wallee-ruby-sdk/api/token_service_api.rb, line 97 def count(space_id, opts = {}) data, _status_code, _headers = count_with_http_info(space_id, opts) return data end
Count Counts the number of items in the database as restricted by the given filter. @param space_id @param [Hash] opts the optional parameters @option opts [EntityQueryFilter] :filter The filter which restricts the entities which are used to calculate the count. @return [Array<(Integer, Fixnum, Hash)>] Integer data, response status code and response headers
# File lib/wallee-ruby-sdk/api/token_service_api.rb, line 108 def count_with_http_info(space_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: TokenService.count ..." end # verify the required parameter 'space_id' is set fail ArgumentError, "Missing the required parameter 'space_id' when calling TokenService.count" if space_id.nil? # resource path local_var_path = "/token/count".sub('{format}','json') # query parameters query_params = {} query_params[:'spaceId'] = space_id # header parameters header_params = {} # HTTP header 'Accept' (if needed) local_header_accept = ['application/json;charset=utf-8'] local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result # HTTP header 'Content-Type' local_header_content_type = ['application/json;charset=utf-8'] header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(opts[:'filter']) auth_names = [] data, status_code, headers = @api_client.call_api(:POST, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Integer') if @api_client.config.debugging @api_client.config.logger.debug "API called: TokenService#count\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Create Creates the entity with the given properties. @param space_id @param entity The token object with the properties which should be created. @param [Hash] opts the optional parameters @return [Token]
# File lib/wallee-ruby-sdk/api/token_service_api.rb, line 157 def create(space_id, entity, opts = {}) data, _status_code, _headers = create_with_http_info(space_id, entity, opts) return data end
Create Token
Based On Transaction
This operation creates a token for the given transaction and fills it with the stored payment information of the transaction. @param space_id @param transaction_id The id of the transaction for which we want to create the token. @param [Hash] opts the optional parameters @return [TokenVersion]
# File lib/wallee-ruby-sdk/api/token_service_api.rb, line 219 def create_token_based_on_transaction(space_id, transaction_id, opts = {}) data, _status_code, _headers = create_token_based_on_transaction_with_http_info(space_id, transaction_id, opts) return data end
Create Token
Based On Transaction
This operation creates a token for the given transaction and fills it with the stored payment information of the transaction. @param space_id @param transaction_id The id of the transaction for which we want to create the token. @param [Hash] opts the optional parameters @return [Array<(TokenVersion
, Fixnum, Hash)>] TokenVersion
data, response status code and response headers
# File lib/wallee-ruby-sdk/api/token_service_api.rb, line 230 def create_token_based_on_transaction_with_http_info(space_id, transaction_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: TokenService.create_token_based_on_transaction ..." end # verify the required parameter 'space_id' is set fail ArgumentError, "Missing the required parameter 'space_id' when calling TokenService.create_token_based_on_transaction" if space_id.nil? # verify the required parameter 'transaction_id' is set fail ArgumentError, "Missing the required parameter 'transaction_id' when calling TokenService.create_token_based_on_transaction" if transaction_id.nil? # resource path local_var_path = "/token/create-token-based-on-transaction".sub('{format}','json') # query parameters query_params = {} query_params[:'spaceId'] = space_id query_params[:'transactionId'] = transaction_id # header parameters header_params = {} # HTTP header 'Accept' (if needed) local_header_accept = [] local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result # HTTP header 'Content-Type' local_header_content_type = [] header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = [] data, status_code, headers = @api_client.call_api(:POST, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'TokenVersion') if @api_client.config.debugging @api_client.config.logger.debug "API called: TokenService#create_token_based_on_transaction\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Create Transaction
for Token
Update This operation creates a transaction which allows the updating of the provided token. @param space_id @param token_id The id of the token which should be updated. @param [Hash] opts the optional parameters @return [Transaction]
# File lib/wallee-ruby-sdk/api/token_service_api.rb, line 282 def create_transaction_for_token_update(space_id, token_id, opts = {}) data, _status_code, _headers = create_transaction_for_token_update_with_http_info(space_id, token_id, opts) return data end
Create Transaction
for Token
Update This operation creates a transaction which allows the updating of the provided token. @param space_id @param token_id The id of the token which should be updated. @param [Hash] opts the optional parameters @return [Array<(Transaction
, Fixnum, Hash)>] Transaction
data, response status code and response headers
# File lib/wallee-ruby-sdk/api/token_service_api.rb, line 293 def create_transaction_for_token_update_with_http_info(space_id, token_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: TokenService.create_transaction_for_token_update ..." end # verify the required parameter 'space_id' is set fail ArgumentError, "Missing the required parameter 'space_id' when calling TokenService.create_transaction_for_token_update" if space_id.nil? # verify the required parameter 'token_id' is set fail ArgumentError, "Missing the required parameter 'token_id' when calling TokenService.create_transaction_for_token_update" if token_id.nil? # resource path local_var_path = "/token/createTransactionForTokenUpdate".sub('{format}','json') # query parameters query_params = {} query_params[:'spaceId'] = space_id query_params[:'tokenId'] = token_id # header parameters header_params = {} # HTTP header 'Accept' (if needed) local_header_accept = [] local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result # HTTP header 'Content-Type' local_header_content_type = [] header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = [] data, status_code, headers = @api_client.call_api(:POST, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Transaction') if @api_client.config.debugging @api_client.config.logger.debug "API called: TokenService#create_transaction_for_token_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Create Creates the entity with the given properties. @param space_id @param entity The token object with the properties which should be created. @param [Hash] opts the optional parameters @return [Array<(Token
, Fixnum, Hash)>] Token
data, response status code and response headers
# File lib/wallee-ruby-sdk/api/token_service_api.rb, line 168 def create_with_http_info(space_id, entity, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: TokenService.create ..." end # verify the required parameter 'space_id' is set fail ArgumentError, "Missing the required parameter 'space_id' when calling TokenService.create" if space_id.nil? # verify the required parameter 'entity' is set fail ArgumentError, "Missing the required parameter 'entity' when calling TokenService.create" if entity.nil? # resource path local_var_path = "/token/create".sub('{format}','json') # query parameters query_params = {} query_params[:'spaceId'] = space_id # header parameters header_params = {} # HTTP header 'Accept' (if needed) local_header_accept = ['application/json;charset=utf-8'] local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result # HTTP header 'Content-Type' local_header_content_type = ['application/json;charset=utf-8'] header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(entity) auth_names = [] data, status_code, headers = @api_client.call_api(:POST, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Token') if @api_client.config.debugging @api_client.config.logger.debug "API called: TokenService#create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Delete Deletes the entity with the given id. @param space_id @param id @param [Hash] opts the optional parameters @return [nil]
# File lib/wallee-ruby-sdk/api/token_service_api.rb, line 345 def delete(space_id, id, opts = {}) delete_with_http_info(space_id, id, opts) return nil end
Delete Deletes the entity with the given id. @param space_id @param id @param [Hash] opts the optional parameters @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
# File lib/wallee-ruby-sdk/api/token_service_api.rb, line 356 def delete_with_http_info(space_id, id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: TokenService.delete ..." end # verify the required parameter 'space_id' is set fail ArgumentError, "Missing the required parameter 'space_id' when calling TokenService.delete" if space_id.nil? # verify the required parameter 'id' is set fail ArgumentError, "Missing the required parameter 'id' when calling TokenService.delete" if id.nil? # resource path local_var_path = "/token/delete".sub('{format}','json') # query parameters query_params = {} query_params[:'spaceId'] = space_id # header parameters header_params = {} # HTTP header 'Accept' (if needed) local_header_accept = ['application/json;charset=utf-8'] local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result # HTTP header 'Content-Type' local_header_content_type = ['application/json;charset=utf-8'] header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(id) auth_names = [] data, status_code, headers = @api_client.call_api(:POST, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names) if @api_client.config.debugging @api_client.config.logger.debug "API called: TokenService#delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Process Transaction
This operation processes the given transaction by using the token associated with the transaction. @param space_id @param transaction_id The id of the transaction for which we want to check if the token can be created or not. @param [Hash] opts the optional parameters @return [Charge]
# File lib/wallee-ruby-sdk/api/token_service_api.rb, line 406 def process_transaction(space_id, transaction_id, opts = {}) data, _status_code, _headers = process_transaction_with_http_info(space_id, transaction_id, opts) return data end
Process Transaction
This operation processes the given transaction by using the token associated with the transaction. @param space_id @param transaction_id The id of the transaction for which we want to check if the token can be created or not. @param [Hash] opts the optional parameters @return [Array<(Charge
, Fixnum, Hash)>] Charge
data, response status code and response headers
# File lib/wallee-ruby-sdk/api/token_service_api.rb, line 417 def process_transaction_with_http_info(space_id, transaction_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: TokenService.process_transaction ..." end # verify the required parameter 'space_id' is set fail ArgumentError, "Missing the required parameter 'space_id' when calling TokenService.process_transaction" if space_id.nil? # verify the required parameter 'transaction_id' is set fail ArgumentError, "Missing the required parameter 'transaction_id' when calling TokenService.process_transaction" if transaction_id.nil? # resource path local_var_path = "/token/process-transaction".sub('{format}','json') # query parameters query_params = {} query_params[:'spaceId'] = space_id query_params[:'transactionId'] = transaction_id # header parameters header_params = {} # HTTP header 'Accept' (if needed) local_header_accept = [] local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result # HTTP header 'Content-Type' local_header_content_type = [] header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = [] data, status_code, headers = @api_client.call_api(:POST, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Charge') if @api_client.config.debugging @api_client.config.logger.debug "API called: TokenService#process_transaction\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Read Reads the entity with the given 'id' and returns it. @param space_id @param id The id of the token which should be returned. @param [Hash] opts the optional parameters @return [Token]
# File lib/wallee-ruby-sdk/api/token_service_api.rb, line 469 def read(space_id, id, opts = {}) data, _status_code, _headers = read_with_http_info(space_id, id, opts) return data end
Read Reads the entity with the given 'id' and returns it. @param space_id @param id The id of the token which should be returned. @param [Hash] opts the optional parameters @return [Array<(Token
, Fixnum, Hash)>] Token
data, response status code and response headers
# File lib/wallee-ruby-sdk/api/token_service_api.rb, line 480 def read_with_http_info(space_id, id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: TokenService.read ..." end # verify the required parameter 'space_id' is set fail ArgumentError, "Missing the required parameter 'space_id' when calling TokenService.read" if space_id.nil? # verify the required parameter 'id' is set fail ArgumentError, "Missing the required parameter 'id' when calling TokenService.read" if id.nil? # resource path local_var_path = "/token/read".sub('{format}','json') # query parameters query_params = {} query_params[:'spaceId'] = space_id query_params[:'id'] = id # header parameters header_params = {} # HTTP header 'Accept' (if needed) local_header_accept = ['application/json;charset=utf-8'] local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result # HTTP header 'Content-Type' local_header_content_type = ['*/*'] header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = [] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Token') if @api_client.config.debugging @api_client.config.logger.debug "API called: TokenService#read\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Search Searches for the entities as specified by the given query. @param space_id @param query The query restricts the tokens which are returned by the search. @param [Hash] opts the optional parameters @return [Array<Token>]
# File lib/wallee-ruby-sdk/api/token_service_api.rb, line 532 def search(space_id, query, opts = {}) data, _status_code, _headers = search_with_http_info(space_id, query, opts) return data end
Search Searches for the entities as specified by the given query. @param space_id @param query The query restricts the tokens which are returned by the search. @param [Hash] opts the optional parameters @return [Array<(Array<Token>, Fixnum, Hash)>] Array<Token> data, response status code and response headers
# File lib/wallee-ruby-sdk/api/token_service_api.rb, line 543 def search_with_http_info(space_id, query, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: TokenService.search ..." end # verify the required parameter 'space_id' is set fail ArgumentError, "Missing the required parameter 'space_id' when calling TokenService.search" if space_id.nil? # verify the required parameter 'query' is set fail ArgumentError, "Missing the required parameter 'query' when calling TokenService.search" if query.nil? # resource path local_var_path = "/token/search".sub('{format}','json') # query parameters query_params = {} query_params[:'spaceId'] = space_id # header parameters header_params = {} # HTTP header 'Accept' (if needed) local_header_accept = ['application/json;charset=utf-8'] local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result # HTTP header 'Content-Type' local_header_content_type = ['application/json;charset=utf-8'] header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(query) auth_names = [] data, status_code, headers = @api_client.call_api(:POST, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Array<Token>') if @api_client.config.debugging @api_client.config.logger.debug "API called: TokenService#search\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Update This updates the entity with the given properties. Only those properties which should be updated can be provided. The 'id' and 'version' are required to identify the entity. @param space_id @param entity The object with all the properties which should be updated. The id and the version are required properties. @param [Hash] opts the optional parameters @return [Token]
# File lib/wallee-ruby-sdk/api/token_service_api.rb, line 594 def update(space_id, entity, opts = {}) data, _status_code, _headers = update_with_http_info(space_id, entity, opts) return data end
Update This updates the entity with the given properties. Only those properties which should be updated can be provided. The 'id' and 'version' are required to identify the entity. @param space_id @param entity The object with all the properties which should be updated. The id and the version are required properties. @param [Hash] opts the optional parameters @return [Array<(Token
, Fixnum, Hash)>] Token
data, response status code and response headers
# File lib/wallee-ruby-sdk/api/token_service_api.rb, line 605 def update_with_http_info(space_id, entity, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: TokenService.update ..." end # verify the required parameter 'space_id' is set fail ArgumentError, "Missing the required parameter 'space_id' when calling TokenService.update" if space_id.nil? # verify the required parameter 'entity' is set fail ArgumentError, "Missing the required parameter 'entity' when calling TokenService.update" if entity.nil? # resource path local_var_path = "/token/update".sub('{format}','json') # query parameters query_params = {} query_params[:'spaceId'] = space_id # header parameters header_params = {} # HTTP header 'Accept' (if needed) local_header_accept = ['application/json;charset=utf-8'] local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result # HTTP header 'Content-Type' local_header_content_type = ['application/json;charset=utf-8'] header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(entity) auth_names = [] data, status_code, headers = @api_client.call_api(:POST, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Token') if @api_client.config.debugging @api_client.config.logger.debug "API called: TokenService#update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end