Class: TripletexApi::TokenconsumerApi

Inherits:
Object
  • Object
show all
Defined in:
lib/tripletex_api/api/tokenconsumer_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ TokenconsumerApi

Returns a new instance of TokenconsumerApi.



19
20
21
# File 'lib/tripletex_api/api/tokenconsumer_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_clientObject

Returns the value of attribute api_client.



17
18
19
# File 'lib/tripletex_api/api/tokenconsumer_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#get_by_token(token, opts = {}) ⇒ ResponseWrapperConsumerToken

Get consumer token by token string.

Parameters:

  • token

    Element ID

  • opts (Hash) (defaults to: {})

    the optional parameters

Options Hash (opts):

  • :fields (String)

    Fields filter pattern

Returns:



29
30
31
32
# File 'lib/tripletex_api/api/tokenconsumer_api.rb', line 29

def get_by_token(token, opts = {})
  data, _status_code, _headers = get_by_token_with_http_info(token, opts)
  return data
end

#get_by_token_with_http_info(token, opts = {}) ⇒ Array<(ResponseWrapperConsumerToken, Fixnum, Hash)>

Get consumer token by token string.

Parameters:

  • token

    Element ID

  • opts (Hash) (defaults to: {})

    the optional parameters

Options Hash (opts):

  • :fields (String)

    Fields filter pattern

Returns:



40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
# File 'lib/tripletex_api/api/tokenconsumer_api.rb', line 40

def get_by_token_with_http_info(token, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TokenconsumerApi.get_by_token ..."
  end
  # verify the required parameter 'token' is set
  if @api_client.config.client_side_validation && token.nil?
    fail ArgumentError, "Missing the required parameter 'token' when calling TokenconsumerApi.get_by_token"
  end
  # resource path
  local_var_path = "/token/consumer/byToken"

  # query parameters
  query_params = {}
  query_params[:'token'] = token
  query_params[:'fields'] = opts[:'fields'] if !opts[:'fields'].nil?

  # header parameters
  header_params = {}

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['tokenAuthScheme']
  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 => 'ResponseWrapperConsumerToken')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TokenconsumerApi#get_by_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end