Method: ESIClient::ContactsApi#post_characters_character_id_contacts_with_http_info

Defined in:
lib/esi_client/api/contacts_api.rb

#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 —

Parameters:

  • character_id

    An EVE character ID

  • contact_ids

    A list of contacts to add

  • standing

    Standing for the new contact

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

    the optional parameters

Options Hash (opts):

  • :datasource (String)

    The server name you would like data from

  • :label_id (Integer)

    Add a custom label to the new contact

  • :token (String)

    Access token to use if unable to set a header

  • :user_agent (String)

    Client identifier, takes precedence over headers

  • :watched (BOOLEAN)

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

  • :x_user_agent (String)

    Client identifier, takes precedence over User-Agent

Returns:

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

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



337
338
339
340
341
342
343
344
345
346
347
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
397
398
399
# File 'lib/esi_client/api/contacts_api.rb', line 337

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
  # 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', 'singularity'].include?(opts[:'datasource'])
    fail ArgumentError, 'invalid value for "datasource", must be one of tranquility, singularity'
  end
  # resource path
  local_var_path = "/v1/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_id'] = opts[:'label_id'] if !opts[:'label_id'].nil?
  query_params[:'token'] = opts[:'token'] if !opts[:'token'].nil?
  query_params[:'user_agent'] = opts[:'user_agent'] if !opts[:'user_agent'].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'])
  header_params[:'X-User-Agent'] = opts[:'x_user_agent'] if !opts[:'x_user_agent'].nil?

  # 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