Class: SignRequestClient::ApiTokensApi

Inherits:
Object
  • Object
show all
Defined in:
lib/signrequest_client/api/api_tokens_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ApiTokensApi

Returns a new instance of ApiTokensApi.



19
20
21
 
# File 'lib/signrequest_client/api/api_tokens_api.rb', line 19

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/signrequest_client/api/api_tokens_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#api_tokens_list(opts = {}) ⇒ InlineResponse200

Retrieve a list of API tokens

Parameters:

  • (defaults to: {})

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    A page number within the paginated result set.

  • :limit (Integer) —

    Number of results to return per page.

Returns:



28
29
30
31
 
# File 'lib/signrequest_client/api/api_tokens_api.rb', line 28

def api_tokens_list(opts = {})
  data, _status_code, _headers = api_tokens_list_with_http_info(opts)
  data
end

#api_tokens_list_with_http_info(opts = {}) ⇒ Array<(InlineResponse200, Fixnum, Hash)>

Retrieve a list of API tokens

Parameters:

  • (defaults to: {})

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    A page number within the paginated result set.

  • :limit (Integer) —

    Number of results to return per page.

Returns:

  • InlineResponse200 data, response status code and response headers



39
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
 
# File 'lib/signrequest_client/api/api_tokens_api.rb', line 39

def api_tokens_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ApiTokensApi.api_tokens_list ...'
  end
  # resource path
  local_var_path = '/api-tokens/'

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

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

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