Class: ESI::ContactsApi
- Inherits:
-
Object
- Object
- ESI::ContactsApi
- Defined in:
- lib/ruby-esi/api/contacts_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#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: `/legacy/characters/character_id/contacts/` Alternate route: `/v1/characters/character_id/contacts/` Alternate route: `/v2/characters/character_id/contacts/`.
-
#delete_characters_character_id_contacts_with_http_info(character_id, contact_ids, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Delete contacts Bulk delete contacts — Alternate route: `/dev/characters/character_id/contacts/` Alternate route: `/legacy/characters/character_id/contacts/` Alternate route: `/v1/characters/character_id/contacts/` Alternate route: `/v2/characters/character_id/contacts/`.
-
#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.
-
#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.
-
#get_alliances_alliance_id_contacts_labels_with_http_info(alliance_id, opts = {}) ⇒ Array<(Array<GetAlliancesAllianceIdContactsLabels200Ok>, Integer, Hash)>
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.
-
#get_alliances_alliance_id_contacts_with_http_info(alliance_id, opts = {}) ⇒ Array<(Array<GetAlliancesAllianceIdContacts200Ok>, Integer, Hash)>
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.
-
#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.
-
#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.
-
#get_characters_character_id_contacts_labels_with_http_info(character_id, opts = {}) ⇒ Array<(Array<GetCharactersCharacterIdContactsLabels200Ok>, Integer, Hash)>
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.
-
#get_characters_character_id_contacts_with_http_info(character_id, opts = {}) ⇒ Array<(Array<GetCharactersCharacterIdContacts200Ok>, Integer, Hash)>
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.
-
#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.
-
#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.
-
#get_corporations_corporation_id_contacts_labels_with_http_info(corporation_id, opts = {}) ⇒ Array<(Array<GetCorporationsCorporationIdContactsLabels200Ok>, Integer, Hash)>
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.
-
#get_corporations_corporation_id_contacts_with_http_info(corporation_id, opts = {}) ⇒ Array<(Array<GetCorporationsCorporationIdContacts200Ok>, Integer, Hash)>
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.
-
#initialize(api_client = ApiClient.default) ⇒ ContactsApi
constructor
A new instance of ContactsApi.
-
#post_characters_character_id_contacts(character_id, standing, contact_ids, 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/`.
-
#post_characters_character_id_contacts_with_http_info(character_id, standing, contact_ids, opts = {}) ⇒ Array<(Array<Integer>, Integer, Hash)>
Add contacts Bulk add contacts with same settings — Alternate route: `/dev/characters/character_id/contacts/` Alternate route: `/v2/characters/character_id/contacts/`.
-
#put_characters_character_id_contacts(character_id, standing, contact_ids, opts = {}) ⇒ nil
Edit contacts Bulk edit contacts with same settings — Alternate route: ‘/dev/characters/character_id/contacts/` Alternate route: `/v2/characters/character_id/contacts/`.
-
#put_characters_character_id_contacts_with_http_info(character_id, standing, contact_ids, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Edit contacts Bulk edit contacts with same settings — Alternate route: `/dev/characters/character_id/contacts/` Alternate route: `/v2/characters/character_id/contacts/`.
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: `/legacy/characters/character_id/contacts/` Alternate route: `/v1/characters/character_id/contacts/` Alternate route: `/v2/characters/character_id/contacts/`
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, Integer, Hash)>
Delete contacts Bulk delete contacts — Alternate route: `/dev/characters/character_id/contacts/` Alternate route: `/legacy/characters/character_id/contacts/` Alternate route: `/v1/characters/character_id/contacts/` Alternate route: `/v2/characters/character_id/contacts/`
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 103 104 105 106 107 108 109 110 111 112 |
# 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 allowable_values = ["tranquility"] if @api_client.config.client_side_validation && opts[:'datasource'] && !allowable_values.include?(opts[:'datasource']) fail ArgumentError, "invalid value for \"datasource\", must be one of #{allowable_values}" end # resource path local_var_path = '/characters/{character_id}/contacts/'.sub('{' + 'character_id' + '}', CGI.escape(character_id.to_s)) # query parameters query_params = opts[: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 = 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] # auth_names auth_names = opts[:debug_auth_names] || ['evesso'] = opts.merge( :operation => :"ContactsApi.delete_characters_character_id_contacts", :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(:DELETE, local_var_path, ) 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
123 124 125 126 |
# File 'lib/ruby-esi/api/contacts_api.rb', line 123 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
209 210 211 212 |
# File 'lib/ruby-esi/api/contacts_api.rb', line 209 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>, Integer, Hash)>
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
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 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 |
# File 'lib/ruby-esi/api/contacts_api.rb', line 222 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 allowable_values = ["tranquility"] if @api_client.config.client_side_validation && opts[:'datasource'] && !allowable_values.include?(opts[:'datasource']) fail ArgumentError, "invalid value for \"datasource\", must be one of #{allowable_values}" end # resource path local_var_path = '/alliances/{alliance_id}/contacts/labels/'.sub('{' + 'alliance_id' + '}', CGI.escape(alliance_id.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'datasource'] = opts[:'datasource'] if !opts[:'datasource'].nil? query_params[:'token'] = opts[:'token'] if !opts[:'token'].nil? # 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'] header_params[:'If-None-Match'] = opts[:'if_none_match'] if !opts[:'if_none_match'].nil? # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'Array<GetAlliancesAllianceIdContactsLabels200Ok>' # auth_names auth_names = opts[:debug_auth_names] || ['evesso'] = opts.merge( :operation => :"ContactsApi.get_alliances_alliance_id_contacts_labels", :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, ) 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>, Integer, Hash)>
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
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 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 |
# File 'lib/ruby-esi/api/contacts_api.rb', line 137 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 allowable_values = ["tranquility"] if @api_client.config.client_side_validation && opts[:'datasource'] && !allowable_values.include?(opts[:'datasource']) fail ArgumentError, "invalid value for \"datasource\", must be one of #{allowable_values}" 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' + '}', CGI.escape(alliance_id.to_s)) # query parameters query_params = opts[: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 = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept'] header_params[:'If-None-Match'] = opts[:'if_none_match'] if !opts[:'if_none_match'].nil? # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'Array<GetAlliancesAllianceIdContacts200Ok>' # auth_names auth_names = opts[:debug_auth_names] || ['evesso'] = opts.merge( :operation => :"ContactsApi.get_alliances_alliance_id_contacts", :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, ) 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
290 291 292 293 |
# File 'lib/ruby-esi/api/contacts_api.rb', line 290 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
376 377 378 379 |
# File 'lib/ruby-esi/api/contacts_api.rb', line 376 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>, Integer, Hash)>
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
389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 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 |
# File 'lib/ruby-esi/api/contacts_api.rb', line 389 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 allowable_values = ["tranquility"] if @api_client.config.client_side_validation && opts[:'datasource'] && !allowable_values.include?(opts[:'datasource']) fail ArgumentError, "invalid value for \"datasource\", must be one of #{allowable_values}" end # resource path local_var_path = '/characters/{character_id}/contacts/labels/'.sub('{' + 'character_id' + '}', CGI.escape(character_id.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'datasource'] = opts[:'datasource'] if !opts[:'datasource'].nil? query_params[:'token'] = opts[:'token'] if !opts[:'token'].nil? # 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'] header_params[:'If-None-Match'] = opts[:'if_none_match'] if !opts[:'if_none_match'].nil? # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'Array<GetCharactersCharacterIdContactsLabels200Ok>' # auth_names auth_names = opts[:debug_auth_names] || ['evesso'] = opts.merge( :operation => :"ContactsApi.get_characters_character_id_contacts_labels", :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, ) 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>, Integer, Hash)>
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
304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 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 |
# File 'lib/ruby-esi/api/contacts_api.rb', line 304 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 allowable_values = ["tranquility"] if @api_client.config.client_side_validation && opts[:'datasource'] && !allowable_values.include?(opts[:'datasource']) fail ArgumentError, "invalid value for \"datasource\", must be one of #{allowable_values}" 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' + '}', CGI.escape(character_id.to_s)) # query parameters query_params = opts[: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 = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept'] header_params[:'If-None-Match'] = opts[:'if_none_match'] if !opts[:'if_none_match'].nil? # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'Array<GetCharactersCharacterIdContacts200Ok>' # auth_names auth_names = opts[:debug_auth_names] || ['evesso'] = opts.merge( :operation => :"ContactsApi.get_characters_character_id_contacts", :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, ) 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
457 458 459 460 |
# File 'lib/ruby-esi/api/contacts_api.rb', line 457 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
543 544 545 546 |
# File 'lib/ruby-esi/api/contacts_api.rb', line 543 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>, Integer, Hash)>
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
556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 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 |
# File 'lib/ruby-esi/api/contacts_api.rb', line 556 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 allowable_values = ["tranquility"] if @api_client.config.client_side_validation && opts[:'datasource'] && !allowable_values.include?(opts[:'datasource']) fail ArgumentError, "invalid value for \"datasource\", must be one of #{allowable_values}" end # resource path local_var_path = '/corporations/{corporation_id}/contacts/labels/'.sub('{' + 'corporation_id' + '}', CGI.escape(corporation_id.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'datasource'] = opts[:'datasource'] if !opts[:'datasource'].nil? query_params[:'token'] = opts[:'token'] if !opts[:'token'].nil? # 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'] header_params[:'If-None-Match'] = opts[:'if_none_match'] if !opts[:'if_none_match'].nil? # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'Array<GetCorporationsCorporationIdContactsLabels200Ok>' # auth_names auth_names = opts[:debug_auth_names] || ['evesso'] = opts.merge( :operation => :"ContactsApi.get_corporations_corporation_id_contacts_labels", :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, ) 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>, Integer, Hash)>
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
471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 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 |
# File 'lib/ruby-esi/api/contacts_api.rb', line 471 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 allowable_values = ["tranquility"] if @api_client.config.client_side_validation && opts[:'datasource'] && !allowable_values.include?(opts[:'datasource']) fail ArgumentError, "invalid value for \"datasource\", must be one of #{allowable_values}" 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' + '}', CGI.escape(corporation_id.to_s)) # query parameters query_params = opts[: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 = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept'] header_params[:'If-None-Match'] = opts[:'if_none_match'] if !opts[:'if_none_match'].nil? # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'Array<GetCorporationsCorporationIdContacts200Ok>' # auth_names auth_names = opts[:debug_auth_names] || ['evesso'] = opts.merge( :operation => :"ContactsApi.get_corporations_corporation_id_contacts", :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, ) 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, standing, contact_ids, 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/`
626 627 628 629 |
# File 'lib/ruby-esi/api/contacts_api.rb', line 626 def post_characters_character_id_contacts(character_id, standing, contact_ids, opts = {}) data, _status_code, _headers = post_characters_character_id_contacts_with_http_info(character_id, standing, contact_ids, opts) data end |
#post_characters_character_id_contacts_with_http_info(character_id, standing, contact_ids, opts = {}) ⇒ Array<(Array<Integer>, Integer, Hash)>
Add contacts Bulk add contacts with same settings — Alternate route: `/dev/characters/character_id/contacts/` Alternate route: `/v2/characters/character_id/contacts/`
642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 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 |
# File 'lib/ruby-esi/api/contacts_api.rb', line 642 def post_characters_character_id_contacts_with_http_info(character_id, standing, contact_ids, 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 '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 # 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 if @api_client.config.client_side_validation && contact_ids.length > 100 fail ArgumentError, 'invalid value for "contact_ids" when calling ContactsApi.post_characters_character_id_contacts, number of items must be less than or equal to 100.' end if @api_client.config.client_side_validation && contact_ids.length < 1 fail ArgumentError, 'invalid value for "contact_ids" when calling ContactsApi.post_characters_character_id_contacts, number of items must be greater than or equal to 1.' end allowable_values = ["tranquility"] if @api_client.config.client_side_validation && opts[:'datasource'] && !allowable_values.include?(opts[:'datasource']) fail ArgumentError, "invalid value for \"datasource\", must be one of #{allowable_values}" 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' + '}', CGI.escape(character_id.to_s)) # query parameters query_params = opts[: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 = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept'] # HTTP header 'Content-Type' content_type = @api_client.select_header_content_type(['application/json']) if !content_type.nil? header_params['Content-Type'] = content_type end # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] || @api_client.object_to_http_body(contact_ids) # return_type return_type = opts[:debug_return_type] || 'Array<Integer>' # auth_names auth_names = opts[:debug_auth_names] || ['evesso'] = opts.merge( :operation => :"ContactsApi.post_characters_character_id_contacts", :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(:POST, local_var_path, ) 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, standing, contact_ids, opts = {}) ⇒ nil
Edit contacts Bulk edit contacts with same settings — Alternate route: ‘/dev/characters/character_id/contacts/` Alternate route: `/v2/characters/character_id/contacts/`
747 748 749 750 |
# File 'lib/ruby-esi/api/contacts_api.rb', line 747 def put_characters_character_id_contacts(character_id, standing, contact_ids, opts = {}) put_characters_character_id_contacts_with_http_info(character_id, standing, contact_ids, opts) nil end |
#put_characters_character_id_contacts_with_http_info(character_id, standing, contact_ids, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Edit contacts Bulk edit contacts with same settings — Alternate route: `/dev/characters/character_id/contacts/` Alternate route: `/v2/characters/character_id/contacts/`
763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 |
# File 'lib/ruby-esi/api/contacts_api.rb', line 763 def put_characters_character_id_contacts_with_http_info(character_id, standing, contact_ids, 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 '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 # 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 if @api_client.config.client_side_validation && contact_ids.length > 100 fail ArgumentError, 'invalid value for "contact_ids" when calling ContactsApi.put_characters_character_id_contacts, number of items must be less than or equal to 100.' end if @api_client.config.client_side_validation && contact_ids.length < 1 fail ArgumentError, 'invalid value for "contact_ids" when calling ContactsApi.put_characters_character_id_contacts, number of items must be greater than or equal to 1.' end allowable_values = ["tranquility"] if @api_client.config.client_side_validation && opts[:'datasource'] && !allowable_values.include?(opts[:'datasource']) fail ArgumentError, "invalid value for \"datasource\", must be one of #{allowable_values}" 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' + '}', CGI.escape(character_id.to_s)) # query parameters query_params = opts[: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 = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept'] # HTTP header 'Content-Type' content_type = @api_client.select_header_content_type(['application/json']) if !content_type.nil? header_params['Content-Type'] = content_type end # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] || @api_client.object_to_http_body(contact_ids) # return_type return_type = opts[:debug_return_type] # auth_names auth_names = opts[:debug_auth_names] || ['evesso'] = opts.merge( :operation => :"ContactsApi.put_characters_character_id_contacts", :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(:PUT, local_var_path, ) 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 |