Class: ESI::ContactsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/ruby-esi/api/contacts_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ContactsApi

Returns a new instance of ContactsApi.



19
20
21
 
# File 'lib/ruby-esi/api/contacts_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/ruby-esi/api/contacts_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#delete_characters_character_id_contacts(character_id, contact_ids, opts = {}) ⇒ nil

Delete contacts Bulk delete contacts — Alternate route: ‘/dev/characters/character_id/contacts/` Alternate route: `/v2/characters/character_id/contacts/`

Parameters:

  • character_id —

    An EVE character ID

  • contact_ids —

    A list of contacts to delete

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

    the optional parameters

Options Hash (opts):

  • :datasource (String) —

    The server name you would like data from (default to tranquility)

  • :token (String) —

    Access token to use if unable to set a header

Returns:

  • (nil) 


30
31
32
33
 
# File 'lib/ruby-esi/api/contacts_api.rb', line 30

def delete_characters_character_id_contacts(character_id, contact_ids, opts = {})
  delete_characters_character_id_contacts_with_http_info(character_id, contact_ids, opts)
  nil
end

#delete_characters_character_id_contacts_with_http_info(character_id, contact_ids, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete contacts Bulk delete contacts — Alternate route: &#x60;/dev/characters/character_id/contacts/&#x60; Alternate route: &#x60;/v2/characters/character_id/contacts/&#x60;

Parameters:

  • character_id —

    An EVE character ID

  • contact_ids —

    A list of contacts to delete

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

    the optional parameters

Options Hash (opts):

  • :datasource (String) —

    The server name you would like data from

  • :token (String) —

    Access token to use if unable to set a header

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



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
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/ruby-esi/api/contacts_api.rb', line 43

def delete_characters_character_id_contacts_with_http_info(character_id, contact_ids, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ContactsApi.delete_characters_character_id_contacts ...'
  end
  # verify the required parameter 'character_id' is set
  if @api_client.config.client_side_validation && character_id.nil?
    fail ArgumentError, "Missing the required parameter 'character_id' when calling ContactsApi.delete_characters_character_id_contacts"
  end
  if @api_client.config.client_side_validation && character_id < 1
    fail ArgumentError, 'invalid value for "character_id" when calling ContactsApi.delete_characters_character_id_contacts, must be greater than or equal to 1.'
  end

  # verify the required parameter 'contact_ids' is set
  if @api_client.config.client_side_validation && contact_ids.nil?
    fail ArgumentError, "Missing the required parameter 'contact_ids' when calling ContactsApi.delete_characters_character_id_contacts"
  end
  if @api_client.config.client_side_validation && contact_ids.length > 20
    fail ArgumentError, 'invalid value for "contact_ids" when calling ContactsApi.delete_characters_character_id_contacts, number of items must be less than or equal to 20.'
  end

  if @api_client.config.client_side_validation && contact_ids.length < 1
    fail ArgumentError, 'invalid value for "contact_ids" when calling ContactsApi.delete_characters_character_id_contacts, number of items must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && opts[:'datasource'] && !['tranquility'].include?(opts[:'datasource'])
    fail ArgumentError, 'invalid value for "datasource", must be one of tranquility'
  end
  # resource path
  local_var_path = '/characters/{character_id}/contacts/'.sub('{' + 'character_id' + '}', character_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'contact_ids'] = @api_client.build_collection_param(contact_ids, :csv)
  query_params[:'datasource'] = opts[:'datasource'] if !opts[:'datasource'].nil?
  query_params[:'token'] = opts[:'token'] if !opts[:'token'].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 = ['evesso']
  data, status_code, headers = @api_client.call_api(:DELETE, 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: ContactsApi#delete_characters_character_id_contacts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_alliances_alliance_id_contacts(alliance_id, opts = {}) ⇒ Array<GetAlliancesAllianceIdContacts200Ok>

Get alliance contacts Return contacts of an alliance — Alternate route: ‘/dev/alliances/alliance_id/contacts/` Alternate route: `/v2/alliances/alliance_id/contacts/` — This route is cached for up to 300 seconds

Parameters:

  • alliance_id —

    An EVE alliance ID

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

    the optional parameters

Options Hash (opts):

  • :datasource (String) —

    The server name you would like data from (default to tranquility)

  • :if_none_match (String) —

    ETag from a previous request. A 304 will be returned if this matches the current ETag

  • :page (Integer) —

    Which page of results to return (default to 1)

  • :token (String) —

    Access token to use if unable to set a header

Returns:



112
113
114
115
 
# File 'lib/ruby-esi/api/contacts_api.rb', line 112

def get_alliances_alliance_id_contacts(alliance_id, opts = {})
  data, _status_code, _headers = get_alliances_alliance_id_contacts_with_http_info(alliance_id, opts)
  data
end

#get_alliances_alliance_id_contacts_labels(alliance_id, opts = {}) ⇒ Array<GetAlliancesAllianceIdContactsLabels200Ok>

Get alliance contact labels Return custom labels for an alliance’s contacts — Alternate route: ‘/dev/alliances/alliance_id/contacts/labels/` Alternate route: `/legacy/alliances/alliance_id/contacts/labels/` Alternate route: `/v1/alliances/alliance_id/contacts/labels/` — This route is cached for up to 300 seconds

Parameters:

  • alliance_id —

    An EVE alliance ID

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

    the optional parameters

Options Hash (opts):

  • :datasource (String) —

    The server name you would like data from (default to tranquility)

  • :if_none_match (String) —

    ETag from a previous request. A 304 will be returned if this matches the current ETag

  • :token (String) —

    Access token to use if unable to set a header

Returns:



188
189
190
191
 
# File 'lib/ruby-esi/api/contacts_api.rb', line 188

def get_alliances_alliance_id_contacts_labels(alliance_id, opts = {})
  data, _status_code, _headers = get_alliances_alliance_id_contacts_labels_with_http_info(alliance_id, opts)
  data
end

#get_alliances_alliance_id_contacts_labels_with_http_info(alliance_id, opts = {}) ⇒ Array<(Array<GetAlliancesAllianceIdContactsLabels200Ok>, Fixnum, Hash)>

Get alliance contact labels Return custom labels for an alliance&#39;s contacts — Alternate route: &#x60;/dev/alliances/alliance_id/contacts/labels/&#x60; Alternate route: &#x60;/legacy/alliances/alliance_id/contacts/labels/&#x60; Alternate route: &#x60;/v1/alliances/alliance_id/contacts/labels/&#x60; — This route is cached for up to 300 seconds

Parameters:

  • alliance_id —

    An EVE alliance ID

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

    the optional parameters

Options Hash (opts):

  • :datasource (String) —

    The server name you would like data from

  • :if_none_match (String) —

    ETag from a previous request. A 304 will be returned if this matches the current ETag

  • :token (String) —

    Access token to use if unable to set a header

Returns:



201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
 
# File 'lib/ruby-esi/api/contacts_api.rb', line 201

def get_alliances_alliance_id_contacts_labels_with_http_info(alliance_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ContactsApi.get_alliances_alliance_id_contacts_labels ...'
  end
  # verify the required parameter 'alliance_id' is set
  if @api_client.config.client_side_validation && alliance_id.nil?
    fail ArgumentError, "Missing the required parameter 'alliance_id' when calling ContactsApi.get_alliances_alliance_id_contacts_labels"
  end
  if @api_client.config.client_side_validation && alliance_id < 1
    fail ArgumentError, 'invalid value for "alliance_id" when calling ContactsApi.get_alliances_alliance_id_contacts_labels, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && opts[:'datasource'] && !['tranquility'].include?(opts[:'datasource'])
    fail ArgumentError, 'invalid value for "datasource", must be one of tranquility'
  end
  # resource path
  local_var_path = '/alliances/{alliance_id}/contacts/labels/'.sub('{' + 'alliance_id' + '}', alliance_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'datasource'] = opts[:'datasource'] if !opts[:'datasource'].nil?
  query_params[:'token'] = opts[:'token'] if !opts[:'token'].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'])
  header_params[:'If-None-Match'] = opts[:'if_none_match'] if !opts[:'if_none_match'].nil?

  # form parameters
  form_params = {}

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

#get_alliances_alliance_id_contacts_with_http_info(alliance_id, opts = {}) ⇒ Array<(Array<GetAlliancesAllianceIdContacts200Ok>, Fixnum, Hash)>

Get alliance contacts Return contacts of an alliance — Alternate route: &#x60;/dev/alliances/alliance_id/contacts/&#x60; Alternate route: &#x60;/v2/alliances/alliance_id/contacts/&#x60; — This route is cached for up to 300 seconds

Parameters:

  • alliance_id —

    An EVE alliance ID

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

    the optional parameters

Options Hash (opts):

  • :datasource (String) —

    The server name you would like data from

  • :if_none_match (String) —

    ETag from a previous request. A 304 will be returned if this matches the current ETag

  • :page (Integer) —

    Which page of results to return

  • :token (String) —

    Access token to use if unable to set a header

Returns:



126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
 
# File 'lib/ruby-esi/api/contacts_api.rb', line 126

def get_alliances_alliance_id_contacts_with_http_info(alliance_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ContactsApi.get_alliances_alliance_id_contacts ...'
  end
  # verify the required parameter 'alliance_id' is set
  if @api_client.config.client_side_validation && alliance_id.nil?
    fail ArgumentError, "Missing the required parameter 'alliance_id' when calling ContactsApi.get_alliances_alliance_id_contacts"
  end
  if @api_client.config.client_side_validation && alliance_id < 1
    fail ArgumentError, 'invalid value for "alliance_id" when calling ContactsApi.get_alliances_alliance_id_contacts, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && opts[:'datasource'] && !['tranquility'].include?(opts[:'datasource'])
    fail ArgumentError, 'invalid value for "datasource", must be one of tranquility'
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling ContactsApi.get_alliances_alliance_id_contacts, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/alliances/{alliance_id}/contacts/'.sub('{' + 'alliance_id' + '}', alliance_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'datasource'] = opts[:'datasource'] if !opts[:'datasource'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'token'] = opts[:'token'] if !opts[:'token'].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'])
  header_params[:'If-None-Match'] = opts[:'if_none_match'] if !opts[:'if_none_match'].nil?

  # form parameters
  form_params = {}

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

#get_characters_character_id_contacts(character_id, opts = {}) ⇒ Array<GetCharactersCharacterIdContacts200Ok>

Get contacts Return contacts of a character — Alternate route: ‘/dev/characters/character_id/contacts/` Alternate route: `/v2/characters/character_id/contacts/` — This route is cached for up to 300 seconds

Parameters:

  • character_id —

    An EVE character ID

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

    the optional parameters

Options Hash (opts):

  • :datasource (String) —

    The server name you would like data from (default to tranquility)

  • :if_none_match (String) —

    ETag from a previous request. A 304 will be returned if this matches the current ETag

  • :page (Integer) —

    Which page of results to return (default to 1)

  • :token (String) —

    Access token to use if unable to set a header

Returns:



259
260
261
262
 
# File 'lib/ruby-esi/api/contacts_api.rb', line 259

def get_characters_character_id_contacts(character_id, opts = {})
  data, _status_code, _headers = get_characters_character_id_contacts_with_http_info(character_id, opts)
  data
end

#get_characters_character_id_contacts_labels(character_id, opts = {}) ⇒ Array<GetCharactersCharacterIdContactsLabels200Ok>

Get contact labels Return custom labels for a character’s contacts — Alternate route: ‘/dev/characters/character_id/contacts/labels/` Alternate route: `/legacy/characters/character_id/contacts/labels/` Alternate route: `/v1/characters/character_id/contacts/labels/` — This route is cached for up to 300 seconds

Parameters:

  • character_id —

    An EVE character ID

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

    the optional parameters

Options Hash (opts):

  • :datasource (String) —

    The server name you would like data from (default to tranquility)

  • :if_none_match (String) —

    ETag from a previous request. A 304 will be returned if this matches the current ETag

  • :token (String) —

    Access token to use if unable to set a header

Returns:



335
336
337
338
 
# File 'lib/ruby-esi/api/contacts_api.rb', line 335

def get_characters_character_id_contacts_labels(character_id, opts = {})
  data, _status_code, _headers = get_characters_character_id_contacts_labels_with_http_info(character_id, opts)
  data
end

#get_characters_character_id_contacts_labels_with_http_info(character_id, opts = {}) ⇒ Array<(Array<GetCharactersCharacterIdContactsLabels200Ok>, Fixnum, Hash)>

Get contact labels Return custom labels for a character&#39;s contacts — Alternate route: &#x60;/dev/characters/character_id/contacts/labels/&#x60; Alternate route: &#x60;/legacy/characters/character_id/contacts/labels/&#x60; Alternate route: &#x60;/v1/characters/character_id/contacts/labels/&#x60; — This route is cached for up to 300 seconds

Parameters:

  • character_id —

    An EVE character ID

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

    the optional parameters

Options Hash (opts):

  • :datasource (String) —

    The server name you would like data from

  • :if_none_match (String) —

    ETag from a previous request. A 304 will be returned if this matches the current ETag

  • :token (String) —

    Access token to use if unable to set a header

Returns:



348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
 
# File 'lib/ruby-esi/api/contacts_api.rb', line 348

def get_characters_character_id_contacts_labels_with_http_info(character_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ContactsApi.get_characters_character_id_contacts_labels ...'
  end
  # verify the required parameter 'character_id' is set
  if @api_client.config.client_side_validation && character_id.nil?
    fail ArgumentError, "Missing the required parameter 'character_id' when calling ContactsApi.get_characters_character_id_contacts_labels"
  end
  if @api_client.config.client_side_validation && character_id < 1
    fail ArgumentError, 'invalid value for "character_id" when calling ContactsApi.get_characters_character_id_contacts_labels, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && opts[:'datasource'] && !['tranquility'].include?(opts[:'datasource'])
    fail ArgumentError, 'invalid value for "datasource", must be one of tranquility'
  end
  # resource path
  local_var_path = '/characters/{character_id}/contacts/labels/'.sub('{' + 'character_id' + '}', character_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'datasource'] = opts[:'datasource'] if !opts[:'datasource'].nil?
  query_params[:'token'] = opts[:'token'] if !opts[:'token'].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'])
  header_params[:'If-None-Match'] = opts[:'if_none_match'] if !opts[:'if_none_match'].nil?

  # form parameters
  form_params = {}

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

#get_characters_character_id_contacts_with_http_info(character_id, opts = {}) ⇒ Array<(Array<GetCharactersCharacterIdContacts200Ok>, Fixnum, Hash)>

Get contacts Return contacts of a character — Alternate route: &#x60;/dev/characters/character_id/contacts/&#x60; Alternate route: &#x60;/v2/characters/character_id/contacts/&#x60; — This route is cached for up to 300 seconds

Parameters:

  • character_id —

    An EVE character ID

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

    the optional parameters

Options Hash (opts):

  • :datasource (String) —

    The server name you would like data from

  • :if_none_match (String) —

    ETag from a previous request. A 304 will be returned if this matches the current ETag

  • :page (Integer) —

    Which page of results to return

  • :token (String) —

    Access token to use if unable to set a header

Returns:



273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
 
# File 'lib/ruby-esi/api/contacts_api.rb', line 273

def get_characters_character_id_contacts_with_http_info(character_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ContactsApi.get_characters_character_id_contacts ...'
  end
  # verify the required parameter 'character_id' is set
  if @api_client.config.client_side_validation && character_id.nil?
    fail ArgumentError, "Missing the required parameter 'character_id' when calling ContactsApi.get_characters_character_id_contacts"
  end
  if @api_client.config.client_side_validation && character_id < 1
    fail ArgumentError, 'invalid value for "character_id" when calling ContactsApi.get_characters_character_id_contacts, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && opts[:'datasource'] && !['tranquility'].include?(opts[:'datasource'])
    fail ArgumentError, 'invalid value for "datasource", must be one of tranquility'
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling ContactsApi.get_characters_character_id_contacts, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/characters/{character_id}/contacts/'.sub('{' + 'character_id' + '}', character_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'datasource'] = opts[:'datasource'] if !opts[:'datasource'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'token'] = opts[:'token'] if !opts[:'token'].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'])
  header_params[:'If-None-Match'] = opts[:'if_none_match'] if !opts[:'if_none_match'].nil?

  # form parameters
  form_params = {}

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

#get_corporations_corporation_id_contacts(corporation_id, opts = {}) ⇒ Array<GetCorporationsCorporationIdContacts200Ok>

Get corporation contacts Return contacts of a corporation — Alternate route: ‘/dev/corporations/corporation_id/contacts/` Alternate route: `/v2/corporations/corporation_id/contacts/` — This route is cached for up to 300 seconds

Parameters:

  • corporation_id —

    An EVE corporation ID

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

    the optional parameters

Options Hash (opts):

  • :datasource (String) —

    The server name you would like data from (default to tranquility)

  • :if_none_match (String) —

    ETag from a previous request. A 304 will be returned if this matches the current ETag

  • :page (Integer) —

    Which page of results to return (default to 1)

  • :token (String) —

    Access token to use if unable to set a header

Returns:



406
407
408
409
 
# File 'lib/ruby-esi/api/contacts_api.rb', line 406

def get_corporations_corporation_id_contacts(corporation_id, opts = {})
  data, _status_code, _headers = get_corporations_corporation_id_contacts_with_http_info(corporation_id, opts)
  data
end

#get_corporations_corporation_id_contacts_labels(corporation_id, opts = {}) ⇒ Array<GetCorporationsCorporationIdContactsLabels200Ok>

Get corporation contact labels Return custom labels for a corporation’s contacts — Alternate route: ‘/dev/corporations/corporation_id/contacts/labels/` Alternate route: `/legacy/corporations/corporation_id/contacts/labels/` Alternate route: `/v1/corporations/corporation_id/contacts/labels/` — This route is cached for up to 300 seconds

Parameters:

  • corporation_id —

    An EVE corporation ID

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

    the optional parameters

Options Hash (opts):

  • :datasource (String) —

    The server name you would like data from (default to tranquility)

  • :if_none_match (String) —

    ETag from a previous request. A 304 will be returned if this matches the current ETag

  • :token (String) —

    Access token to use if unable to set a header

Returns:



482
483
484
485
 
# File 'lib/ruby-esi/api/contacts_api.rb', line 482

def get_corporations_corporation_id_contacts_labels(corporation_id, opts = {})
  data, _status_code, _headers = get_corporations_corporation_id_contacts_labels_with_http_info(corporation_id, opts)
  data
end

#get_corporations_corporation_id_contacts_labels_with_http_info(corporation_id, opts = {}) ⇒ Array<(Array<GetCorporationsCorporationIdContactsLabels200Ok>, Fixnum, Hash)>

Get corporation contact labels Return custom labels for a corporation&#39;s contacts — Alternate route: &#x60;/dev/corporations/corporation_id/contacts/labels/&#x60; Alternate route: &#x60;/legacy/corporations/corporation_id/contacts/labels/&#x60; Alternate route: &#x60;/v1/corporations/corporation_id/contacts/labels/&#x60; — This route is cached for up to 300 seconds

Parameters:

  • corporation_id —

    An EVE corporation ID

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

    the optional parameters

Options Hash (opts):

  • :datasource (String) —

    The server name you would like data from

  • :if_none_match (String) —

    ETag from a previous request. A 304 will be returned if this matches the current ETag

  • :token (String) —

    Access token to use if unable to set a header

Returns:



495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
 
# File 'lib/ruby-esi/api/contacts_api.rb', line 495

def get_corporations_corporation_id_contacts_labels_with_http_info(corporation_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ContactsApi.get_corporations_corporation_id_contacts_labels ...'
  end
  # verify the required parameter 'corporation_id' is set
  if @api_client.config.client_side_validation && corporation_id.nil?
    fail ArgumentError, "Missing the required parameter 'corporation_id' when calling ContactsApi.get_corporations_corporation_id_contacts_labels"
  end
  if @api_client.config.client_side_validation && corporation_id < 1
    fail ArgumentError, 'invalid value for "corporation_id" when calling ContactsApi.get_corporations_corporation_id_contacts_labels, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && opts[:'datasource'] && !['tranquility'].include?(opts[:'datasource'])
    fail ArgumentError, 'invalid value for "datasource", must be one of tranquility'
  end
  # resource path
  local_var_path = '/corporations/{corporation_id}/contacts/labels/'.sub('{' + 'corporation_id' + '}', corporation_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'datasource'] = opts[:'datasource'] if !opts[:'datasource'].nil?
  query_params[:'token'] = opts[:'token'] if !opts[:'token'].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'])
  header_params[:'If-None-Match'] = opts[:'if_none_match'] if !opts[:'if_none_match'].nil?

  # form parameters
  form_params = {}

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

#get_corporations_corporation_id_contacts_with_http_info(corporation_id, opts = {}) ⇒ Array<(Array<GetCorporationsCorporationIdContacts200Ok>, Fixnum, Hash)>

Get corporation contacts Return contacts of a corporation — Alternate route: &#x60;/dev/corporations/corporation_id/contacts/&#x60; Alternate route: &#x60;/v2/corporations/corporation_id/contacts/&#x60; — This route is cached for up to 300 seconds

Parameters:

  • corporation_id —

    An EVE corporation ID

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

    the optional parameters

Options Hash (opts):

  • :datasource (String) —

    The server name you would like data from

  • :if_none_match (String) —

    ETag from a previous request. A 304 will be returned if this matches the current ETag

  • :page (Integer) —

    Which page of results to return

  • :token (String) —

    Access token to use if unable to set a header

Returns:



420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
 
# File 'lib/ruby-esi/api/contacts_api.rb', line 420

def get_corporations_corporation_id_contacts_with_http_info(corporation_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ContactsApi.get_corporations_corporation_id_contacts ...'
  end
  # verify the required parameter 'corporation_id' is set
  if @api_client.config.client_side_validation && corporation_id.nil?
    fail ArgumentError, "Missing the required parameter 'corporation_id' when calling ContactsApi.get_corporations_corporation_id_contacts"
  end
  if @api_client.config.client_side_validation && corporation_id < 1
    fail ArgumentError, 'invalid value for "corporation_id" when calling ContactsApi.get_corporations_corporation_id_contacts, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && opts[:'datasource'] && !['tranquility'].include?(opts[:'datasource'])
    fail ArgumentError, 'invalid value for "datasource", must be one of tranquility'
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling ContactsApi.get_corporations_corporation_id_contacts, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/corporations/{corporation_id}/contacts/'.sub('{' + 'corporation_id' + '}', corporation_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'datasource'] = opts[:'datasource'] if !opts[:'datasource'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'token'] = opts[:'token'] if !opts[:'token'].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'])
  header_params[:'If-None-Match'] = opts[:'if_none_match'] if !opts[:'if_none_match'].nil?

  # form parameters
  form_params = {}

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

#post_characters_character_id_contacts(character_id, contact_ids, standing, opts = {}) ⇒ Array<Integer>

Add contacts Bulk add contacts with same settings — Alternate route: ‘/dev/characters/character_id/contacts/` Alternate route: `/v2/characters/character_id/contacts/`

Parameters:

  • character_id —

    An EVE character ID

  • contact_ids —

    A list of contacts

  • standing —

    Standing for the contact

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

    the optional parameters

Options Hash (opts):

  • :datasource (String) —

    The server name you would like data from (default to tranquility)

  • :label_ids (Array<Integer>) —

    Add custom labels to the new contact

  • :token (String) —

    Access token to use if unable to set a header

  • :watched (BOOLEAN) —

    Whether the contact should be watched, note this is only effective on characters (default to false)

Returns:

  • (Array<Integer>) 


555
556
557
558
 
# File 'lib/ruby-esi/api/contacts_api.rb', line 555

def post_characters_character_id_contacts(character_id, contact_ids, standing, opts = {})
  data, _status_code, _headers = post_characters_character_id_contacts_with_http_info(character_id, contact_ids, standing, opts)
  data
end

#post_characters_character_id_contacts_with_http_info(character_id, contact_ids, standing, opts = {}) ⇒ Array<(Array<Integer>, Fixnum, Hash)>

Add contacts Bulk add contacts with same settings — Alternate route: &#x60;/dev/characters/character_id/contacts/&#x60; Alternate route: &#x60;/v2/characters/character_id/contacts/&#x60;

Parameters:

  • character_id —

    An EVE character ID

  • contact_ids —

    A list of contacts

  • standing —

    Standing for the contact

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

    the optional parameters

Options Hash (opts):

  • :datasource (String) —

    The server name you would like data from

  • :label_ids (Array<Integer>) —

    Add custom labels to the new contact

  • :token (String) —

    Access token to use if unable to set a header

  • :watched (BOOLEAN) —

    Whether the contact should be watched, note this is only effective on characters

Returns:

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

    Array<Integer> data, response status code and response headers



571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
 
# File 'lib/ruby-esi/api/contacts_api.rb', line 571

def post_characters_character_id_contacts_with_http_info(character_id, contact_ids, standing, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ContactsApi.post_characters_character_id_contacts ...'
  end
  # verify the required parameter 'character_id' is set
  if @api_client.config.client_side_validation && character_id.nil?
    fail ArgumentError, "Missing the required parameter 'character_id' when calling ContactsApi.post_characters_character_id_contacts"
  end
  if @api_client.config.client_side_validation && character_id < 1
    fail ArgumentError, 'invalid value for "character_id" when calling ContactsApi.post_characters_character_id_contacts, must be greater than or equal to 1.'
  end

  # verify the required parameter 'contact_ids' is set
  if @api_client.config.client_side_validation && contact_ids.nil?
    fail ArgumentError, "Missing the required parameter 'contact_ids' when calling ContactsApi.post_characters_character_id_contacts"
  end
  # verify the required parameter 'standing' is set
  if @api_client.config.client_side_validation && standing.nil?
    fail ArgumentError, "Missing the required parameter 'standing' when calling ContactsApi.post_characters_character_id_contacts"
  end
  if @api_client.config.client_side_validation && standing > 10
    fail ArgumentError, 'invalid value for "standing" when calling ContactsApi.post_characters_character_id_contacts, must be smaller than or equal to 10.'
  end

  if @api_client.config.client_side_validation && standing < -10
    fail ArgumentError, 'invalid value for "standing" when calling ContactsApi.post_characters_character_id_contacts, must be greater than or equal to -10.'
  end

  if @api_client.config.client_side_validation && opts[:'datasource'] && !['tranquility'].include?(opts[:'datasource'])
    fail ArgumentError, 'invalid value for "datasource", must be one of tranquility'
  end
  if @api_client.config.client_side_validation && !opts[:'label_ids'].nil? && opts[:'label_ids'].length > 63
    fail ArgumentError, 'invalid value for "opts[:"label_ids"]" when calling ContactsApi.post_characters_character_id_contacts, number of items must be less than or equal to 63.'
  end

  # resource path
  local_var_path = '/characters/{character_id}/contacts/'.sub('{' + 'character_id' + '}', character_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'standing'] = standing
  query_params[:'datasource'] = opts[:'datasource'] if !opts[:'datasource'].nil?
  query_params[:'label_ids'] = @api_client.build_collection_param(opts[:'label_ids'], :csv) if !opts[:'label_ids'].nil?
  query_params[:'token'] = opts[:'token'] if !opts[:'token'].nil?
  query_params[:'watched'] = opts[:'watched'] if !opts[:'watched'].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 = @api_client.object_to_http_body(contact_ids)
  auth_names = ['evesso']
  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<Integer>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ContactsApi#post_characters_character_id_contacts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_characters_character_id_contacts(character_id, contact_ids, standing, opts = {}) ⇒ nil

Edit contacts Bulk edit contacts with same settings — Alternate route: ‘/dev/characters/character_id/contacts/` Alternate route: `/v2/characters/character_id/contacts/`

Parameters:

  • character_id —

    An EVE character ID

  • contact_ids —

    A list of contacts

  • standing —

    Standing for the contact

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

    the optional parameters

Options Hash (opts):

  • :datasource (String) —

    The server name you would like data from (default to tranquility)

  • :label_ids (Array<Integer>) —

    Add custom labels to the contact

  • :token (String) —

    Access token to use if unable to set a header

  • :watched (BOOLEAN) —

    Whether the contact should be watched, note this is only effective on characters (default to false)

Returns:

  • (nil) 


653
654
655
656
 
# File 'lib/ruby-esi/api/contacts_api.rb', line 653

def put_characters_character_id_contacts(character_id, contact_ids, standing, opts = {})
  put_characters_character_id_contacts_with_http_info(character_id, contact_ids, standing, opts)
  nil
end

#put_characters_character_id_contacts_with_http_info(character_id, contact_ids, standing, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Edit contacts Bulk edit contacts with same settings — Alternate route: &#x60;/dev/characters/character_id/contacts/&#x60; Alternate route: &#x60;/v2/characters/character_id/contacts/&#x60;

Parameters:

  • character_id —

    An EVE character ID

  • contact_ids —

    A list of contacts

  • standing —

    Standing for the contact

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

    the optional parameters

Options Hash (opts):

  • :datasource (String) —

    The server name you would like data from

  • :label_ids (Array<Integer>) —

    Add custom labels to the contact

  • :token (String) —

    Access token to use if unable to set a header

  • :watched (BOOLEAN) —

    Whether the contact should be watched, note this is only effective on characters

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
 
# File 'lib/ruby-esi/api/contacts_api.rb', line 669

def put_characters_character_id_contacts_with_http_info(character_id, contact_ids, standing, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ContactsApi.put_characters_character_id_contacts ...'
  end
  # verify the required parameter 'character_id' is set
  if @api_client.config.client_side_validation && character_id.nil?
    fail ArgumentError, "Missing the required parameter 'character_id' when calling ContactsApi.put_characters_character_id_contacts"
  end
  if @api_client.config.client_side_validation && character_id < 1
    fail ArgumentError, 'invalid value for "character_id" when calling ContactsApi.put_characters_character_id_contacts, must be greater than or equal to 1.'
  end

  # verify the required parameter 'contact_ids' is set
  if @api_client.config.client_side_validation && contact_ids.nil?
    fail ArgumentError, "Missing the required parameter 'contact_ids' when calling ContactsApi.put_characters_character_id_contacts"
  end
  # verify the required parameter 'standing' is set
  if @api_client.config.client_side_validation && standing.nil?
    fail ArgumentError, "Missing the required parameter 'standing' when calling ContactsApi.put_characters_character_id_contacts"
  end
  if @api_client.config.client_side_validation && standing > 10
    fail ArgumentError, 'invalid value for "standing" when calling ContactsApi.put_characters_character_id_contacts, must be smaller than or equal to 10.'
  end

  if @api_client.config.client_side_validation && standing < -10
    fail ArgumentError, 'invalid value for "standing" when calling ContactsApi.put_characters_character_id_contacts, must be greater than or equal to -10.'
  end

  if @api_client.config.client_side_validation && opts[:'datasource'] && !['tranquility'].include?(opts[:'datasource'])
    fail ArgumentError, 'invalid value for "datasource", must be one of tranquility'
  end
  if @api_client.config.client_side_validation && !opts[:'label_ids'].nil? && opts[:'label_ids'].length > 63
    fail ArgumentError, 'invalid value for "opts[:"label_ids"]" when calling ContactsApi.put_characters_character_id_contacts, number of items must be less than or equal to 63.'
  end

  # resource path
  local_var_path = '/characters/{character_id}/contacts/'.sub('{' + 'character_id' + '}', character_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'standing'] = standing
  query_params[:'datasource'] = opts[:'datasource'] if !opts[:'datasource'].nil?
  query_params[:'label_ids'] = @api_client.build_collection_param(opts[:'label_ids'], :csv) if !opts[:'label_ids'].nil?
  query_params[:'token'] = opts[:'token'] if !opts[:'token'].nil?
  query_params[:'watched'] = opts[:'watched'] if !opts[:'watched'].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 = @api_client.object_to_http_body(contact_ids)
  auth_names = ['evesso']
  data, status_code, headers = @api_client.call_api(:PUT, 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: ContactsApi#put_characters_character_id_contacts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end