class PostFinanceCheckout::TokenVersionService
Attributes
Public Class Methods
# File lib/postfinancecheckout-ruby-sdk/api/token_version_service_api.rb, line 24 def initialize(api_client = ApiClient.default) @api_client = api_client end
Public Instance Methods
Active Version Returns the token version which is currently active given by the token id. In case no token version is active the method will return null. @param space_id @param id The id of a token for which you want to look up the current active token version. @param [Hash] opts the optional parameters @return [TokenVersion]
# File lib/postfinancecheckout-ruby-sdk/api/token_version_service_api.rb, line 34 def active_version(space_id, id, opts = {}) data, _status_code, _headers = active_version_with_http_info(space_id, id, opts) return data end
Active Version Returns the token version which is currently active given by the token id. In case no token version is active the method will return null. @param space_id @param id The id of a token for which you want to look up the current active token version. @param [Hash] opts the optional parameters @return [Array<(TokenVersion
, Fixnum, Hash)>] TokenVersion
data, response status code and response headers
# File lib/postfinancecheckout-ruby-sdk/api/token_version_service_api.rb, line 45 def active_version_with_http_info(space_id, id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: TokenVersionService.active_version ..." end # verify the required parameter 'space_id' is set fail ArgumentError, "Missing the required parameter 'space_id' when calling TokenVersionService.active_version" if space_id.nil? # verify the required parameter 'id' is set fail ArgumentError, "Missing the required parameter 'id' when calling TokenVersionService.active_version" if id.nil? # resource path local_var_path = "/token-version/active-version".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 => 'TokenVersion') if @api_client.config.debugging @api_client.config.logger.debug "API called: TokenVersionService#active_version\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/postfinancecheckout-ruby-sdk/api/token_version_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/postfinancecheckout-ruby-sdk/api/token_version_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: TokenVersionService.count ..." end # verify the required parameter 'space_id' is set fail ArgumentError, "Missing the required parameter 'space_id' when calling TokenVersionService.count" if space_id.nil? # resource path local_var_path = "/token-version/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: TokenVersionService#count\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 version which should be returned. @param [Hash] opts the optional parameters @return [TokenVersion]
# File lib/postfinancecheckout-ruby-sdk/api/token_version_service_api.rb, line 157 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 version which should be returned. @param [Hash] opts the optional parameters @return [Array<(TokenVersion
, Fixnum, Hash)>] TokenVersion
data, response status code and response headers
# File lib/postfinancecheckout-ruby-sdk/api/token_version_service_api.rb, line 168 def read_with_http_info(space_id, id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: TokenVersionService.read ..." end # verify the required parameter 'space_id' is set fail ArgumentError, "Missing the required parameter 'space_id' when calling TokenVersionService.read" if space_id.nil? # verify the required parameter 'id' is set fail ArgumentError, "Missing the required parameter 'id' when calling TokenVersionService.read" if id.nil? # resource path local_var_path = "/token-version/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 => 'TokenVersion') if @api_client.config.debugging @api_client.config.logger.debug "API called: TokenVersionService#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 token versions which are returned by the search. @param [Hash] opts the optional parameters @return [Array<TokenVersion>]
# File lib/postfinancecheckout-ruby-sdk/api/token_version_service_api.rb, line 220 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 token versions which are returned by the search. @param [Hash] opts the optional parameters @return [Array<(Array<TokenVersion>, Fixnum, Hash)>] Array<TokenVersion> data, response status code and response headers
# File lib/postfinancecheckout-ruby-sdk/api/token_version_service_api.rb, line 231 def search_with_http_info(space_id, query, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: TokenVersionService.search ..." end # verify the required parameter 'space_id' is set fail ArgumentError, "Missing the required parameter 'space_id' when calling TokenVersionService.search" if space_id.nil? # verify the required parameter 'query' is set fail ArgumentError, "Missing the required parameter 'query' when calling TokenVersionService.search" if query.nil? # resource path local_var_path = "/token-version/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<TokenVersion>') if @api_client.config.debugging @api_client.config.logger.debug "API called: TokenVersionService#search\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end