Class: VeniceClient::CharactersApi

Inherits:
Object
  • Object
show all
Defined in:
lib/venice_client/api/characters_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ CharactersApi

Returns a new instance of CharactersApi.



19
20
21
 
# File 'lib/venice_client/api/characters_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/venice_client/api/characters_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#get_character_by_slug(slug, opts = {}) ⇒ GetCharacterBySlug200Response

/api/v1/characters/slug This is a preview API and may change. Returns a single character by its slug.

Parameters:

  • slug (String) —

    The slug of the character to retrieve

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

    the optional parameters

Returns:



27
28
29
30
 
# File 'lib/venice_client/api/characters_api.rb', line 27

def get_character_by_slug(slug, opts = {})
  data, _status_code, _headers = get_character_by_slug_with_http_info(slug, opts)
  data
end

#get_character_by_slug_with_http_info(slug, opts = {}) ⇒ Array<(GetCharacterBySlug200Response, Integer, Hash)>

/api/v1/characters/slug This is a preview API and may change. Returns a single character by its slug.

Parameters:

  • slug (String) —

    The slug of the character to retrieve

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

    the optional parameters

Returns:



37
38
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
76
77
78
79
80
81
82
83
 
# File 'lib/venice_client/api/characters_api.rb', line 37

def get_character_by_slug_with_http_info(slug, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CharactersApi.get_character_by_slug ...'
  end
  # verify the required parameter 'slug' is set
  if @api_client.config.client_side_validation && slug.nil?
    fail ArgumentError, "Missing the required parameter 'slug' when calling CharactersApi.get_character_by_slug"
  end
  # resource path
  local_var_path = '/characters/{slug}'.sub('{' + 'slug' + '}', CGI.escape(slug.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'GetCharacterBySlug200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['BearerAuth']

  new_options = opts.merge(
    :operation => :"CharactersApi.get_character_by_slug",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CharactersApi#get_character_by_slug\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_characters(opts = {}) ⇒ ListCharacters200Response

/api/v1/characters This is a preview API and may change. Returns a list of characters supported in the API.

Parameters:

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

    the optional parameters

Returns:



89
90
91
92
 
# File 'lib/venice_client/api/characters_api.rb', line 89

def list_characters(opts = {})
  data, _status_code, _headers = list_characters_with_http_info(opts)
  data
end

#list_characters_with_http_info(opts = {}) ⇒ Array<(ListCharacters200Response, Integer, Hash)>

/api/v1/characters This is a preview API and may change. Returns a list of characters supported in the API.

Parameters:

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

    the optional parameters

Returns:

  • (Array<(ListCharacters200Response, Integer, Hash)>) —

    ListCharacters200Response data, response status code and response headers



98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'lib/venice_client/api/characters_api.rb', line 98

def list_characters_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CharactersApi.list_characters ...'
  end
  # resource path
  local_var_path = '/characters'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'ListCharacters200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['BearerAuth']

  new_options = opts.merge(
    :operation => :"CharactersApi.list_characters",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CharactersApi#list_characters\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end