Class: EsiClient::ContactsApi
- Inherits:
-
Object
- Object
- EsiClient::ContactsApi
- Defined in:
- lib/esi-ruby/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: ‘/v1/characters/character_id/contacts/` Alternate route: `/legacy/characters/character_id/contacts/`.
-
#delete_characters_character_id_contacts_with_http_info(character_id, contact_ids, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>
Delete contacts Bulk delete contacts — Alternate route: `/v1/characters/character_id/contacts/` Alternate route: `/legacy/characters/character_id/contacts/`.
-
#get_characters_character_id_contacts(character_id, opts = {}) ⇒ Array<GetCharactersCharacterIdContacts200Ok>
Get contacts Return contacts of a character — Alternate route: ‘/v1/characters/character_id/contacts/` Alternate route: `/legacy/characters/character_id/contacts/` Alternate route: `/dev/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 contacts the character defined — Alternate route: ‘/v1/characters/character_id/contacts/labels/` Alternate route: `/legacy/characters/character_id/contacts/labels/` Alternate route: `/dev/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>, Fixnum, Hash)>
Get contact labels Return custom labels for contacts the character defined — Alternate route: `/v1/characters/character_id/contacts/labels/` Alternate route: `/legacy/characters/character_id/contacts/labels/` Alternate route: `/dev/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>, Fixnum, Hash)>
Get contacts Return contacts of a character — Alternate route: `/v1/characters/character_id/contacts/` Alternate route: `/legacy/characters/character_id/contacts/` Alternate route: `/dev/characters/character_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, contact_ids, standing, opts = {}) ⇒ Array<Integer>
Add contacts Bulk add contacts with same settings — Alternate route: ‘/v1/characters/character_id/contacts/` Alternate route: `/legacy/characters/character_id/contacts/` Alternate route: `/dev/characters/character_id/contacts/`.
-
#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: `/v1/characters/character_id/contacts/` Alternate route: `/legacy/characters/character_id/contacts/` Alternate route: `/dev/characters/character_id/contacts/`.
-
#put_characters_character_id_contacts(character_id, contact_ids, standing, opts = {}) ⇒ nil
Edit contacts Bulk edit contacts with same settings — Alternate route: ‘/v1/characters/character_id/contacts/` Alternate route: `/legacy/characters/character_id/contacts/` Alternate route: `/dev/characters/character_id/contacts/`.
-
#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: `/v1/characters/character_id/contacts/` Alternate route: `/legacy/characters/character_id/contacts/` Alternate route: `/dev/characters/character_id/contacts/`.
Constructor Details
#initialize(api_client = ApiClient.default) ⇒ ContactsApi
Returns a new instance of ContactsApi.
18 19 20 |
# File 'lib/esi-ruby/api/contacts_api.rb', line 18 def initialize(api_client = ApiClient.default) @api_client = api_client end |
Instance Attribute Details
#api_client ⇒ Object
Returns the value of attribute api_client.
16 17 18 |
# File 'lib/esi-ruby/api/contacts_api.rb', line 16 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: ‘/v1/characters/character_id/contacts/` Alternate route: `/legacy/characters/character_id/contacts/`
32 33 34 35 |
# File 'lib/esi-ruby/api/contacts_api.rb', line 32 def delete_characters_character_id_contacts(character_id, contact_ids, opts = {}) delete_characters_character_id_contacts_with_http_info(character_id, contact_ids, opts) return 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: `/v1/characters/character_id/contacts/` Alternate route: `/legacy/characters/character_id/contacts/`
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 |
# File 'lib/esi-ruby/api/contacts_api.rb', line 47 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 fail ArgumentError, "Missing the required parameter 'character_id' when calling ContactsApi.delete_characters_character_id_contacts" if character_id.nil? # verify the required parameter 'contact_ids' is set fail ArgumentError, "Missing the required parameter 'contact_ids' when calling ContactsApi.delete_characters_character_id_contacts" if contact_ids.nil? if 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 = "/characters/{character_id}/contacts/".sub('{format}','json').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? query_params[:'user_agent'] = opts[:'user_agent'] if !opts[:'user_agent'].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(: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_characters_character_id_contacts(character_id, opts = {}) ⇒ Array<GetCharactersCharacterIdContacts200Ok>
Get contacts Return contacts of a character — Alternate route: ‘/v1/characters/character_id/contacts/` Alternate route: `/legacy/characters/character_id/contacts/` Alternate route: `/dev/characters/character_id/contacts/` — This route is cached for up to 300 seconds
101 102 103 104 |
# File 'lib/esi-ruby/api/contacts_api.rb', line 101 def get_characters_character_id_contacts(character_id, opts = {}) data, _status_code, _headers = get_characters_character_id_contacts_with_http_info(character_id, opts) return data end |
#get_characters_character_id_contacts_labels(character_id, opts = {}) ⇒ Array<GetCharactersCharacterIdContactsLabels200Ok>
Get contact labels Return custom labels for contacts the character defined — Alternate route: ‘/v1/characters/character_id/contacts/labels/` Alternate route: `/legacy/characters/character_id/contacts/labels/` Alternate route: `/dev/characters/character_id/contacts/labels/` — This route is cached for up to 300 seconds
169 170 171 172 |
# File 'lib/esi-ruby/api/contacts_api.rb', line 169 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) return 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 contacts the character defined — Alternate route: `/v1/characters/character_id/contacts/labels/` Alternate route: `/legacy/characters/character_id/contacts/labels/` Alternate route: `/dev/characters/character_id/contacts/labels/` — This route is cached for up to 300 seconds
183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 |
# File 'lib/esi-ruby/api/contacts_api.rb', line 183 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 fail ArgumentError, "Missing the required parameter 'character_id' when calling ContactsApi.get_characters_character_id_contacts_labels" if character_id.nil? if 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 = "/characters/{character_id}/contacts/labels/".sub('{format}','json').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? query_params[:'user_agent'] = opts[:'user_agent'] if !opts[:'user_agent'].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 = 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: `/v1/characters/character_id/contacts/` Alternate route: `/legacy/characters/character_id/contacts/` Alternate route: `/dev/characters/character_id/contacts/` — This route is cached for up to 300 seconds
116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 |
# File 'lib/esi-ruby/api/contacts_api.rb', line 116 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 fail ArgumentError, "Missing the required parameter 'character_id' when calling ContactsApi.get_characters_character_id_contacts" if character_id.nil? if 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 = "/characters/{character_id}/contacts/".sub('{format}','json').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? query_params[:'user_agent'] = opts[:'user_agent'] if !opts[:'user_agent'].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 = 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 |
#post_characters_character_id_contacts(character_id, contact_ids, standing, opts = {}) ⇒ Array<Integer>
Add contacts Bulk add contacts with same settings — Alternate route: ‘/v1/characters/character_id/contacts/` Alternate route: `/legacy/characters/character_id/contacts/` Alternate route: `/dev/characters/character_id/contacts/`
239 240 241 242 |
# File 'lib/esi-ruby/api/contacts_api.rb', line 239 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) return 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: `/v1/characters/character_id/contacts/` Alternate route: `/legacy/characters/character_id/contacts/` Alternate route: `/dev/characters/character_id/contacts/`
257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 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 |
# File 'lib/esi-ruby/api/contacts_api.rb', line 257 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 fail ArgumentError, "Missing the required parameter 'character_id' when calling ContactsApi.post_characters_character_id_contacts" if character_id.nil? # verify the required parameter 'contact_ids' is set fail ArgumentError, "Missing the required parameter 'contact_ids' when calling ContactsApi.post_characters_character_id_contacts" if contact_ids.nil? # verify the required parameter 'standing' is set fail ArgumentError, "Missing the required parameter 'standing' when calling ContactsApi.post_characters_character_id_contacts" if standing.nil? if 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 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 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 = "/characters/{character_id}/contacts/".sub('{format}','json').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 |
#put_characters_character_id_contacts(character_id, contact_ids, standing, opts = {}) ⇒ nil
Edit contacts Bulk edit contacts with same settings — Alternate route: ‘/v1/characters/character_id/contacts/` Alternate route: `/legacy/characters/character_id/contacts/` Alternate route: `/dev/characters/character_id/contacts/`
328 329 330 331 |
# File 'lib/esi-ruby/api/contacts_api.rb', line 328 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) return 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: `/v1/characters/character_id/contacts/` Alternate route: `/legacy/characters/character_id/contacts/` Alternate route: `/dev/characters/character_id/contacts/`
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 400 401 |
# File 'lib/esi-ruby/api/contacts_api.rb', line 346 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 fail ArgumentError, "Missing the required parameter 'character_id' when calling ContactsApi.put_characters_character_id_contacts" if character_id.nil? # verify the required parameter 'contact_ids' is set fail ArgumentError, "Missing the required parameter 'contact_ids' when calling ContactsApi.put_characters_character_id_contacts" if contact_ids.nil? # verify the required parameter 'standing' is set fail ArgumentError, "Missing the required parameter 'standing' when calling ContactsApi.put_characters_character_id_contacts" if standing.nil? if 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 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 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 = "/characters/{character_id}/contacts/".sub('{format}','json').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(: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 |