module ESI::Client::Contact

ESI contacts operations.

Public Instance Methods

delete_character_contacts(character_id:, contact_ids:, headers: {}, params: {}) click to toggle source

Bulk delete contacts.

This endpoint requires authorization (see {ESI::Client#authorize}).

@esi_scope esi-characters.write_contacts.v1

@esi_version dev @esi_version v2

@param character_id [Integer] An EVE character ID @param contact_ids [Array] A list of contacts to delete @param params [Hash] Additional query string parameters @param headers [Hash] Additional headers

@raise [ESI::Errors::BadRequestError] Bad request @raise [ESI::Errors::UnauthorizedError] Unauthorized @raise [ESI::Errors::ForbiddenError] Forbidden @raise [ESI::Errors::ErrorLimitedError] Error limited @raise [ESI::Errors::InternalServerError] Internal server error @raise [ESI::Errors::ServiceUnavailableError] Service unavailable @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout

@see esi.evetech.net/ui/#/Contacts/delete_characters_character_id_contacts

# File lib/esi/client/contacts.rb, line 30
def delete_character_contacts(character_id:, contact_ids:, headers: {}, params: {})
  params.merge!("contact_ids" => contact_ids)
  delete("/characters/#{character_id}/contacts/", headers: headers, params: params)
end
delete_characters_character_id_contacts(character_id:, contact_ids:, headers: {}, params: {})
get_alliance_contact_labels(alliance_id:, headers: {}, params: {}) click to toggle source

Return custom labels for an alliance's contacts.

This endpoint is cached for up to 300 seconds.

This endpoint requires authorization (see {ESI::Client#authorize}).

@esi_scope esi-alliances.read_contacts.v1

@esi_version dev @esi_version legacy @esi_version v1

@param alliance_id [Integer] An EVE alliance ID @param params [Hash] Additional query string parameters @param headers [Hash] Additional headers

@raise [ESI::Errors::BadRequestError] Bad request @raise [ESI::Errors::UnauthorizedError] Unauthorized @raise [ESI::Errors::ForbiddenError] Forbidden @raise [ESI::Errors::ErrorLimitedError] Error limited @raise [ESI::Errors::InternalServerError] Internal server error @raise [ESI::Errors::ServiceUnavailableError] Service unavailable @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout

@see esi.evetech.net/ui/#/Contacts/get_alliances_alliance_id_contacts_labels

# File lib/esi/client/contacts.rb, line 61
def get_alliance_contact_labels(alliance_id:, headers: {}, params: {})
  get("/alliances/#{alliance_id}/contacts/labels/", headers: headers, params: params)
end
get_alliance_contacts(alliance_id:, headers: {}, params: {}) click to toggle source

Return contacts of an alliance.

This endpoint is cached for up to 300 seconds.

This endpoint requires authorization (see {ESI::Client#authorize}).

@esi_scope esi-alliances.read_contacts.v1

@esi_version dev @esi_version v2

@param alliance_id [Integer] An EVE alliance ID @param params [Hash] Additional query string parameters @param headers [Hash] Additional headers

@raise [ESI::Errors::BadRequestError] Bad request @raise [ESI::Errors::UnauthorizedError] Unauthorized @raise [ESI::Errors::ForbiddenError] Forbidden @raise [ESI::Errors::ErrorLimitedError] Error limited @raise [ESI::Errors::InternalServerError] Internal server error @raise [ESI::Errors::ServiceUnavailableError] Service unavailable @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout

@see esi.evetech.net/ui/#/Contacts/get_alliances_alliance_id_contacts

# File lib/esi/client/contacts.rb, line 90
def get_alliance_contacts(alliance_id:, headers: {}, params: {})
  get("/alliances/#{alliance_id}/contacts/", headers: headers, params: params)
end
get_alliances_alliance_id_contacts(alliance_id:, headers: {}, params: {})
get_alliances_alliance_id_contacts_labels(alliance_id:, headers: {}, params: {})
get_character_contact_labels(character_id:, headers: {}, params: {}) click to toggle source

Return custom labels for a character's contacts.

This endpoint is cached for up to 300 seconds.

This endpoint requires authorization (see {ESI::Client#authorize}).

@esi_scope esi-characters.read_contacts.v1

@esi_version dev @esi_version legacy @esi_version v1

@param character_id [Integer] An EVE character ID @param params [Hash] Additional query string parameters @param headers [Hash] Additional headers

@raise [ESI::Errors::BadRequestError] Bad request @raise [ESI::Errors::UnauthorizedError] Unauthorized @raise [ESI::Errors::ForbiddenError] Forbidden @raise [ESI::Errors::ErrorLimitedError] Error limited @raise [ESI::Errors::InternalServerError] Internal server error @raise [ESI::Errors::ServiceUnavailableError] Service unavailable @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout

@see esi.evetech.net/ui/#/Contacts/get_characters_character_id_contacts_labels

# File lib/esi/client/contacts.rb, line 120
def get_character_contact_labels(character_id:, headers: {}, params: {})
  get("/characters/#{character_id}/contacts/labels/", headers: headers, params: params)
end
get_character_contacts(character_id:, headers: {}, params: {}) click to toggle source

Return contacts of a character.

This endpoint is cached for up to 300 seconds.

This endpoint requires authorization (see {ESI::Client#authorize}).

@esi_scope esi-characters.read_contacts.v1

@esi_version dev @esi_version v2

@param character_id [Integer] An EVE character ID @param params [Hash] Additional query string parameters @param headers [Hash] Additional headers

@raise [ESI::Errors::BadRequestError] Bad request @raise [ESI::Errors::UnauthorizedError] Unauthorized @raise [ESI::Errors::ForbiddenError] Forbidden @raise [ESI::Errors::ErrorLimitedError] Error limited @raise [ESI::Errors::InternalServerError] Internal server error @raise [ESI::Errors::ServiceUnavailableError] Service unavailable @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout

@see esi.evetech.net/ui/#/Contacts/get_characters_character_id_contacts

# File lib/esi/client/contacts.rb, line 149
def get_character_contacts(character_id:, headers: {}, params: {})
  get("/characters/#{character_id}/contacts/", headers: headers, params: params)
end
get_characters_character_id_contacts(character_id:, headers: {}, params: {})
get_characters_character_id_contacts_labels(character_id:, headers: {}, params: {})
get_corporation_contact_labels(corporation_id:, headers: {}, params: {}) click to toggle source

Return custom labels for a corporation's contacts.

This endpoint is cached for up to 300 seconds.

This endpoint requires authorization (see {ESI::Client#authorize}).

@esi_scope esi-corporations.read_contacts.v1

@esi_version dev @esi_version legacy @esi_version v1

@param corporation_id [Integer] An EVE corporation ID @param params [Hash] Additional query string parameters @param headers [Hash] Additional headers

@raise [ESI::Errors::BadRequestError] Bad request @raise [ESI::Errors::UnauthorizedError] Unauthorized @raise [ESI::Errors::ForbiddenError] Forbidden @raise [ESI::Errors::ErrorLimitedError] Error limited @raise [ESI::Errors::InternalServerError] Internal server error @raise [ESI::Errors::ServiceUnavailableError] Service unavailable @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout

@see esi.evetech.net/ui/#/Contacts/get_corporations_corporation_id_contacts_labels

# File lib/esi/client/contacts.rb, line 179
def get_corporation_contact_labels(corporation_id:, headers: {}, params: {})
  get("/corporations/#{corporation_id}/contacts/labels/", headers: headers, params: params)
end
get_corporation_contacts(corporation_id:, headers: {}, params: {}) click to toggle source

Return contacts of a corporation.

This endpoint is cached for up to 300 seconds.

This endpoint requires authorization (see {ESI::Client#authorize}).

@esi_scope esi-corporations.read_contacts.v1

@esi_version dev @esi_version v2

@param corporation_id [Integer] An EVE corporation ID @param params [Hash] Additional query string parameters @param headers [Hash] Additional headers

@raise [ESI::Errors::BadRequestError] Bad request @raise [ESI::Errors::UnauthorizedError] Unauthorized @raise [ESI::Errors::ForbiddenError] Forbidden @raise [ESI::Errors::ErrorLimitedError] Error limited @raise [ESI::Errors::InternalServerError] Internal server error @raise [ESI::Errors::ServiceUnavailableError] Service unavailable @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout

@see esi.evetech.net/ui/#/Contacts/get_corporations_corporation_id_contacts

# File lib/esi/client/contacts.rb, line 208
def get_corporation_contacts(corporation_id:, headers: {}, params: {})
  get("/corporations/#{corporation_id}/contacts/", headers: headers, params: params)
end
get_corporations_corporation_id_contacts(corporation_id:, headers: {}, params: {})
get_corporations_corporation_id_contacts_labels(corporation_id:, headers: {}, params: {})
post_character_contacts(character_id:, contact_ids:, standing:, label_ids: nil, watched: nil, headers: {}, params: {}) click to toggle source

Bulk add contacts with same settings.

This endpoint requires authorization (see {ESI::Client#authorize}).

@esi_scope esi-characters.write_contacts.v1

@esi_version dev @esi_version v2

@param character_id [Integer] An EVE character ID @param contact_ids [Array] A list of contacts @param label_ids [Array] Add custom labels to the new contact @param standing [Number] Standing for the contact @param watched [Boolean] Whether the contact should be watched, note this is only effective on characters @param params [Hash] Additional query string parameters @param headers [Hash] Additional headers

@raise [ESI::Errors::BadRequestError] Bad request @raise [ESI::Errors::UnauthorizedError] Unauthorized @raise [ESI::Errors::ForbiddenError] Forbidden @raise [ESI::Errors::ErrorLimitedError] Error limited @raise [ESI::Errors::InternalServerError] Internal server error @raise [ESI::Errors::ServiceUnavailableError] Service unavailable @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout @raise [ESI::Errors::EveServerError] Internal error thrown from the EVE server

@see esi.evetech.net/ui/#/Contacts/post_characters_character_id_contacts

# File lib/esi/client/contacts.rb, line 240
def post_character_contacts(character_id:, contact_ids:, standing:, label_ids: nil, watched: nil, headers: {}, params: {})
  params.merge!("label_ids" => label_ids, "standing" => standing, "watched" => watched)
  post("/characters/#{character_id}/contacts/", headers: headers, params: params, payload: contact_ids)
end
post_characters_character_id_contacts(character_id:, contact_ids:, standing:, label_ids: nil, watched: nil, headers: {}, params: {})
put_character_contacts(character_id:, contact_ids:, standing:, label_ids: nil, watched: nil, headers: {}, params: {}) click to toggle source

Bulk edit contacts with same settings.

This endpoint requires authorization (see {ESI::Client#authorize}).

@esi_scope esi-characters.write_contacts.v1

@esi_version dev @esi_version v2

@param character_id [Integer] An EVE character ID @param contact_ids [Array] A list of contacts @param label_ids [Array] Add custom labels to the contact @param standing [Number] Standing for the contact @param watched [Boolean] Whether the contact should be watched, note this is only effective on characters @param params [Hash] Additional query string parameters @param headers [Hash] Additional headers

@raise [ESI::Errors::BadRequestError] Bad request @raise [ESI::Errors::UnauthorizedError] Unauthorized @raise [ESI::Errors::ForbiddenError] Forbidden @raise [ESI::Errors::ErrorLimitedError] Error limited @raise [ESI::Errors::InternalServerError] Internal server error @raise [ESI::Errors::ServiceUnavailableError] Service unavailable @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout

@see esi.evetech.net/ui/#/Contacts/put_characters_character_id_contacts

# File lib/esi/client/contacts.rb, line 272
def put_character_contacts(character_id:, contact_ids:, standing:, label_ids: nil, watched: nil, headers: {}, params: {})
  params.merge!("label_ids" => label_ids, "standing" => standing, "watched" => watched)
  put("/characters/#{character_id}/contacts/", headers: headers, params: params, payload: contact_ids)
end
put_characters_character_id_contacts(character_id:, contact_ids:, standing:, label_ids: nil, watched: nil, headers: {}, params: {})