esi-sdk 1.1.2 → 2.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (49) hide show
  1. checksums.yaml +4 -4
  2. data/.github/workflows/cicd.yml +17 -2
  3. data/.gitignore +2 -0
  4. data/CHANGELOG.md +38 -0
  5. data/Gemfile +1 -0
  6. data/Gemfile.lock +21 -40
  7. data/README.md +2 -0
  8. data/Rakefile +75 -37
  9. data/bin/console +1 -1
  10. data/esi-sdk.gemspec +2 -3
  11. data/lib/esi/client/alliance.rb +103 -10
  12. data/lib/esi/client/assets.rb +193 -18
  13. data/lib/esi/client/bookmarks.rb +130 -12
  14. data/lib/esi/client/calendar.rb +144 -16
  15. data/lib/esi/client/character.rb +414 -42
  16. data/lib/esi/client/clones.rb +65 -6
  17. data/lib/esi/client/contacts.rb +294 -30
  18. data/lib/esi/client/contracts.rb +294 -31
  19. data/lib/esi/client/corporation.rb +755 -152
  20. data/lib/esi/client/dogma.rb +118 -12
  21. data/lib/esi/client/faction_warfare.rb +198 -14
  22. data/lib/esi/client/fittings.rb +94 -10
  23. data/lib/esi/client/fleets.rb +469 -49
  24. data/lib/esi/client/incursions.rb +23 -1
  25. data/lib/esi/client/industry.rb +250 -23
  26. data/lib/esi/client/insurance.rb +23 -1
  27. data/lib/esi/client/killmails.rb +95 -10
  28. data/lib/esi/client/location.rb +98 -9
  29. data/lib/esi/client/loyalty.rb +57 -6
  30. data/lib/esi/client/mail.rb +262 -28
  31. data/lib/esi/client/market.rb +322 -34
  32. data/lib/esi/client/opportunities.rb +124 -13
  33. data/lib/esi/client/planetary_interaction.rb +124 -13
  34. data/lib/esi/client/routes.rb +34 -6
  35. data/lib/esi/client/search.rb +64 -7
  36. data/lib/esi/client/skills.rb +95 -9
  37. data/lib/esi/client/sovereignty.rb +69 -3
  38. data/lib/esi/client/status.rb +24 -1
  39. data/lib/esi/client/universe.rb +817 -194
  40. data/lib/esi/client/user_interface.rb +157 -14
  41. data/lib/esi/client/wallet.rb +199 -22
  42. data/lib/esi/client/wars.rb +81 -9
  43. data/lib/esi/client.rb +74 -82
  44. data/lib/esi/errors.rb +12 -1
  45. data/lib/esi/version.rb +1 -1
  46. data/package.json +19 -0
  47. data/release.config.js +2 -2
  48. data/yarn.lock +3695 -0
  49. metadata +10 -22
@@ -17,7 +17,7 @@ module ESI
17
17
  # @esi_version v1
18
18
  # @esi_version v2
19
19
  #
20
- # @param character_id [Integer,String] An EVE character ID
20
+ # @param character_id [Integer] An EVE character ID
21
21
  # @param params [Hash] Additional query string parameters
22
22
  # @param headers [Hash] Additional headers
23
23
  #
@@ -30,11 +30,41 @@ module ESI
30
30
  # @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout
31
31
  #
32
32
  # @see https://esi.evetech.net/ui/#/Location/get_characters_character_id_location
33
- def get_character_location(character_id:, params: {}, headers: {})
34
- get("/characters/#{character_id}/location/", headers: headers, params: params)
33
+ def get_character_location(character_id:, headers: {}, params: {})
34
+ get_character_location_raw(character_id: character_id, headers: headers, params: params).json
35
35
  end
36
36
  alias get_characters_character_id_location get_character_location
37
37
 
38
+ # Information about the characters current location. Returns the current solar system id, and also the current station or structure ID if applicable.
39
+ #
40
+ # This endpoint is cached for up to 5 seconds.
41
+ #
42
+ # This endpoint requires authorization (see {ESI::Client#authorize}).
43
+ #
44
+ # @esi_scope esi-location.read_location.v1
45
+ #
46
+ # @esi_version dev
47
+ # @esi_version legacy
48
+ # @esi_version v1
49
+ # @esi_version v2
50
+ #
51
+ # @param character_id [Integer] An EVE character ID
52
+ # @param params [Hash] Additional query string parameters
53
+ # @param headers [Hash] Additional headers
54
+ #
55
+ # @raise [ESI::Errors::BadRequestError] Bad request
56
+ # @raise [ESI::Errors::UnauthorizedError] Unauthorized
57
+ # @raise [ESI::Errors::ForbiddenError] Forbidden
58
+ # @raise [ESI::Errors::ErrorLimitedError] Error limited
59
+ # @raise [ESI::Errors::InternalServerError] Internal server error
60
+ # @raise [ESI::Errors::ServiceUnavailableError] Service unavailable
61
+ # @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout
62
+ #
63
+ # @see https://esi.evetech.net/ui/#/Location/get_characters_character_id_location
64
+ def get_character_location_raw(character_id:, headers: {}, params: {})
65
+ get("/characters/#{character_id}/location/", headers: headers, params: params)
66
+ end
67
+
38
68
  # Checks if the character is currently online.
39
69
  #
40
70
  # This endpoint is cached for up to 60 seconds.
@@ -47,7 +77,7 @@ module ESI
47
77
  # @esi_version v2
48
78
  # @esi_version v3
49
79
  #
50
- # @param character_id [Integer,String] An EVE character ID
80
+ # @param character_id [Integer] An EVE character ID
51
81
  # @param params [Hash] Additional query string parameters
52
82
  # @param headers [Hash] Additional headers
53
83
  #
@@ -60,11 +90,40 @@ module ESI
60
90
  # @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout
61
91
  #
62
92
  # @see https://esi.evetech.net/ui/#/Location/get_characters_character_id_online
63
- def get_character_online(character_id:, params: {}, headers: {})
64
- get("/characters/#{character_id}/online/", headers: headers, params: params)
93
+ def get_character_online(character_id:, headers: {}, params: {})
94
+ get_character_online_raw(character_id: character_id, headers: headers, params: params).json
65
95
  end
66
96
  alias get_characters_character_id_online get_character_online
67
97
 
98
+ # Checks if the character is currently online.
99
+ #
100
+ # This endpoint is cached for up to 60 seconds.
101
+ #
102
+ # This endpoint requires authorization (see {ESI::Client#authorize}).
103
+ #
104
+ # @esi_scope esi-location.read_online.v1
105
+ #
106
+ # @esi_version dev
107
+ # @esi_version v2
108
+ # @esi_version v3
109
+ #
110
+ # @param character_id [Integer] An EVE character ID
111
+ # @param params [Hash] Additional query string parameters
112
+ # @param headers [Hash] Additional headers
113
+ #
114
+ # @raise [ESI::Errors::BadRequestError] Bad request
115
+ # @raise [ESI::Errors::UnauthorizedError] Unauthorized
116
+ # @raise [ESI::Errors::ForbiddenError] Forbidden
117
+ # @raise [ESI::Errors::ErrorLimitedError] Error limited
118
+ # @raise [ESI::Errors::InternalServerError] Internal server error
119
+ # @raise [ESI::Errors::ServiceUnavailableError] Service unavailable
120
+ # @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout
121
+ #
122
+ # @see https://esi.evetech.net/ui/#/Location/get_characters_character_id_online
123
+ def get_character_online_raw(character_id:, headers: {}, params: {})
124
+ get("/characters/#{character_id}/online/", headers: headers, params: params)
125
+ end
126
+
68
127
  # Get the current ship type, name and id.
69
128
  #
70
129
  # This endpoint is cached for up to 5 seconds.
@@ -78,7 +137,7 @@ module ESI
78
137
  # @esi_version v1
79
138
  # @esi_version v2
80
139
  #
81
- # @param character_id [Integer,String] An EVE character ID
140
+ # @param character_id [Integer] An EVE character ID
82
141
  # @param params [Hash] Additional query string parameters
83
142
  # @param headers [Hash] Additional headers
84
143
  #
@@ -91,10 +150,40 @@ module ESI
91
150
  # @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout
92
151
  #
93
152
  # @see https://esi.evetech.net/ui/#/Location/get_characters_character_id_ship
94
- def get_character_ship(character_id:, params: {}, headers: {})
95
- get("/characters/#{character_id}/ship/", headers: headers, params: params)
153
+ def get_character_ship(character_id:, headers: {}, params: {})
154
+ get_character_ship_raw(character_id: character_id, headers: headers, params: params).json
96
155
  end
97
156
  alias get_characters_character_id_ship get_character_ship
157
+
158
+ # Get the current ship type, name and id.
159
+ #
160
+ # This endpoint is cached for up to 5 seconds.
161
+ #
162
+ # This endpoint requires authorization (see {ESI::Client#authorize}).
163
+ #
164
+ # @esi_scope esi-location.read_ship_type.v1
165
+ #
166
+ # @esi_version dev
167
+ # @esi_version legacy
168
+ # @esi_version v1
169
+ # @esi_version v2
170
+ #
171
+ # @param character_id [Integer] An EVE character ID
172
+ # @param params [Hash] Additional query string parameters
173
+ # @param headers [Hash] Additional headers
174
+ #
175
+ # @raise [ESI::Errors::BadRequestError] Bad request
176
+ # @raise [ESI::Errors::UnauthorizedError] Unauthorized
177
+ # @raise [ESI::Errors::ForbiddenError] Forbidden
178
+ # @raise [ESI::Errors::ErrorLimitedError] Error limited
179
+ # @raise [ESI::Errors::InternalServerError] Internal server error
180
+ # @raise [ESI::Errors::ServiceUnavailableError] Service unavailable
181
+ # @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout
182
+ #
183
+ # @see https://esi.evetech.net/ui/#/Location/get_characters_character_id_ship
184
+ def get_character_ship_raw(character_id:, headers: {}, params: {})
185
+ get("/characters/#{character_id}/ship/", headers: headers, params: params)
186
+ end
98
187
  end
99
188
  end
100
189
  end
@@ -16,7 +16,7 @@ module ESI
16
16
  # @esi_version legacy
17
17
  # @esi_version v1
18
18
  #
19
- # @param character_id [Integer,String] An EVE character ID
19
+ # @param character_id [Integer] An EVE character ID
20
20
  # @param params [Hash] Additional query string parameters
21
21
  # @param headers [Hash] Additional headers
22
22
  #
@@ -29,18 +29,47 @@ module ESI
29
29
  # @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout
30
30
  #
31
31
  # @see https://esi.evetech.net/ui/#/Loyalty/get_characters_character_id_loyalty_points
32
- def get_character_loyalty_points(character_id:, params: {}, headers: {})
33
- get("/characters/#{character_id}/loyalty/points/", headers: headers, params: params)
32
+ def get_character_loyalty_points(character_id:, headers: {}, params: {})
33
+ get_character_loyalty_points_raw(character_id: character_id, headers: headers, params: params).json
34
34
  end
35
35
  alias get_characters_character_id_loyalty_points get_character_loyalty_points
36
36
 
37
+ # Return a list of loyalty points for all corporations the character has worked for.
38
+ #
39
+ # This endpoint is cached for up to 3600 seconds.
40
+ #
41
+ # This endpoint requires authorization (see {ESI::Client#authorize}).
42
+ #
43
+ # @esi_scope esi-characters.read_loyalty.v1
44
+ #
45
+ # @esi_version dev
46
+ # @esi_version legacy
47
+ # @esi_version v1
48
+ #
49
+ # @param character_id [Integer] An EVE character ID
50
+ # @param params [Hash] Additional query string parameters
51
+ # @param headers [Hash] Additional headers
52
+ #
53
+ # @raise [ESI::Errors::BadRequestError] Bad request
54
+ # @raise [ESI::Errors::UnauthorizedError] Unauthorized
55
+ # @raise [ESI::Errors::ForbiddenError] Forbidden
56
+ # @raise [ESI::Errors::ErrorLimitedError] Error limited
57
+ # @raise [ESI::Errors::InternalServerError] Internal server error
58
+ # @raise [ESI::Errors::ServiceUnavailableError] Service unavailable
59
+ # @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout
60
+ #
61
+ # @see https://esi.evetech.net/ui/#/Loyalty/get_characters_character_id_loyalty_points
62
+ def get_character_loyalty_points_raw(character_id:, headers: {}, params: {})
63
+ get("/characters/#{character_id}/loyalty/points/", headers: headers, params: params)
64
+ end
65
+
37
66
  # Return a list of offers from a specific corporation's loyalty store.
38
67
  #
39
68
  # @esi_version dev
40
69
  # @esi_version legacy
41
70
  # @esi_version v1
42
71
  #
43
- # @param corporation_id [Integer,String] An EVE corporation ID
72
+ # @param corporation_id [Integer] An EVE corporation ID
44
73
  # @param params [Hash] Additional query string parameters
45
74
  # @param headers [Hash] Additional headers
46
75
  #
@@ -52,10 +81,32 @@ module ESI
52
81
  # @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout
53
82
  #
54
83
  # @see https://esi.evetech.net/ui/#/Loyalty/get_loyalty_stores_corporation_id_offers
55
- def get_loyalty_stores_corporation_offers(corporation_id:, params: {}, headers: {})
56
- get("/loyalty/stores/#{corporation_id}/offers/", headers: headers, params: params)
84
+ def get_loyalty_stores_corporation_offers(corporation_id:, headers: {}, params: {})
85
+ get_loyalty_stores_corporation_offers_raw(corporation_id: corporation_id, headers: headers, params: params).json
57
86
  end
58
87
  alias get_loyalty_stores_corporation_id_offers get_loyalty_stores_corporation_offers
88
+
89
+ # Return a list of offers from a specific corporation's loyalty store.
90
+ #
91
+ # @esi_version dev
92
+ # @esi_version legacy
93
+ # @esi_version v1
94
+ #
95
+ # @param corporation_id [Integer] An EVE corporation ID
96
+ # @param params [Hash] Additional query string parameters
97
+ # @param headers [Hash] Additional headers
98
+ #
99
+ # @raise [ESI::Errors::BadRequestError] Bad request
100
+ # @raise [ESI::Errors::NotFoundError] No loyalty point store found for the provided corporation
101
+ # @raise [ESI::Errors::ErrorLimitedError] Error limited
102
+ # @raise [ESI::Errors::InternalServerError] Internal server error
103
+ # @raise [ESI::Errors::ServiceUnavailableError] Service unavailable
104
+ # @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout
105
+ #
106
+ # @see https://esi.evetech.net/ui/#/Loyalty/get_loyalty_stores_corporation_id_offers
107
+ def get_loyalty_stores_corporation_offers_raw(corporation_id:, headers: {}, params: {})
108
+ get("/loyalty/stores/#{corporation_id}/offers/", headers: headers, params: params)
109
+ end
59
110
  end
60
111
  end
61
112
  end
@@ -14,8 +14,8 @@ module ESI
14
14
  # @esi_version legacy
15
15
  # @esi_version v1
16
16
  #
17
- # @param character_id [Integer,String] An EVE character ID
18
- # @param mail_id [Integer,String] An EVE mail ID
17
+ # @param character_id [Integer] An EVE character ID
18
+ # @param mail_id [Integer] An EVE mail ID
19
19
  # @param params [Hash] Additional query string parameters
20
20
  # @param headers [Hash] Additional headers
21
21
  #
@@ -28,11 +28,39 @@ module ESI
28
28
  # @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout
29
29
  #
30
30
  # @see https://esi.evetech.net/ui/#/Mail/delete_characters_character_id_mail_mail_id
31
- def delete_character_mail(character_id:, mail_id:, params: {}, headers: {})
32
- delete("/characters/#{character_id}/mail/#{mail_id}/", headers: headers, params: params)
31
+ def delete_character_mail(character_id:, mail_id:, headers: {}, params: {})
32
+ delete_character_mail_raw(character_id: character_id, mail_id: mail_id, headers: headers, params: params).json
33
33
  end
34
34
  alias delete_characters_character_id_mail_mail_id delete_character_mail
35
35
 
36
+ # Delete a mail.
37
+ #
38
+ # This endpoint requires authorization (see {ESI::Client#authorize}).
39
+ #
40
+ # @esi_scope esi-mail.organize_mail.v1
41
+ #
42
+ # @esi_version dev
43
+ # @esi_version legacy
44
+ # @esi_version v1
45
+ #
46
+ # @param character_id [Integer] An EVE character ID
47
+ # @param mail_id [Integer] An EVE mail ID
48
+ # @param params [Hash] Additional query string parameters
49
+ # @param headers [Hash] Additional headers
50
+ #
51
+ # @raise [ESI::Errors::BadRequestError] Bad request
52
+ # @raise [ESI::Errors::UnauthorizedError] Unauthorized
53
+ # @raise [ESI::Errors::ForbiddenError] Forbidden
54
+ # @raise [ESI::Errors::ErrorLimitedError] Error limited
55
+ # @raise [ESI::Errors::InternalServerError] Internal server error
56
+ # @raise [ESI::Errors::ServiceUnavailableError] Service unavailable
57
+ # @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout
58
+ #
59
+ # @see https://esi.evetech.net/ui/#/Mail/delete_characters_character_id_mail_mail_id
60
+ def delete_character_mail_raw(character_id:, mail_id:, headers: {}, params: {})
61
+ delete("/characters/#{character_id}/mail/#{mail_id}/", headers: headers, params: params)
62
+ end
63
+
36
64
  # Delete a mail label.
37
65
  #
38
66
  # This endpoint requires authorization (see {ESI::Client#authorize}).
@@ -43,8 +71,8 @@ module ESI
43
71
  # @esi_version legacy
44
72
  # @esi_version v1
45
73
  #
46
- # @param character_id [Integer,String] An EVE character ID
47
- # @param label_id [Integer,String] An EVE label id
74
+ # @param character_id [Integer] An EVE character ID
75
+ # @param label_id [Integer] An EVE label id
48
76
  # @param params [Hash] Additional query string parameters
49
77
  # @param headers [Hash] Additional headers
50
78
  #
@@ -58,11 +86,40 @@ module ESI
58
86
  # @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout
59
87
  #
60
88
  # @see https://esi.evetech.net/ui/#/Mail/delete_characters_character_id_mail_labels_label_id
61
- def delete_character_mail_label(character_id:, label_id:, params: {}, headers: {})
62
- delete("/characters/#{character_id}/mail/labels/#{label_id}/", headers: headers, params: params)
89
+ def delete_character_mail_label(character_id:, label_id:, headers: {}, params: {})
90
+ delete_character_mail_label_raw(character_id: character_id, label_id: label_id, headers: headers, params: params).json
63
91
  end
64
92
  alias delete_characters_character_id_mail_labels_label_id delete_character_mail_label
65
93
 
94
+ # Delete a mail label.
95
+ #
96
+ # This endpoint requires authorization (see {ESI::Client#authorize}).
97
+ #
98
+ # @esi_scope esi-mail.organize_mail.v1
99
+ #
100
+ # @esi_version dev
101
+ # @esi_version legacy
102
+ # @esi_version v1
103
+ #
104
+ # @param character_id [Integer] An EVE character ID
105
+ # @param label_id [Integer] An EVE label id
106
+ # @param params [Hash] Additional query string parameters
107
+ # @param headers [Hash] Additional headers
108
+ #
109
+ # @raise [ESI::Errors::BadRequestError] Bad request
110
+ # @raise [ESI::Errors::UnauthorizedError] Unauthorized
111
+ # @raise [ESI::Errors::ForbiddenError] Forbidden
112
+ # @raise [ESI::Errors::ErrorLimitedError] Error limited
113
+ # @raise [ESI::Errors::UnprocessableEntityError] Default labels cannot be deleted
114
+ # @raise [ESI::Errors::InternalServerError] Internal server error
115
+ # @raise [ESI::Errors::ServiceUnavailableError] Service unavailable
116
+ # @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout
117
+ #
118
+ # @see https://esi.evetech.net/ui/#/Mail/delete_characters_character_id_mail_labels_label_id
119
+ def delete_character_mail_label_raw(character_id:, label_id:, headers: {}, params: {})
120
+ delete("/characters/#{character_id}/mail/labels/#{label_id}/", headers: headers, params: params)
121
+ end
122
+
66
123
  # Return the contents of an EVE mail.
67
124
  #
68
125
  # This endpoint is cached for up to 30 seconds.
@@ -75,8 +132,8 @@ module ESI
75
132
  # @esi_version legacy
76
133
  # @esi_version v1
77
134
  #
78
- # @param character_id [Integer,String] An EVE character ID
79
- # @param mail_id [Integer,String] An EVE mail ID
135
+ # @param character_id [Integer] An EVE character ID
136
+ # @param mail_id [Integer] An EVE mail ID
80
137
  # @param params [Hash] Additional query string parameters
81
138
  # @param headers [Hash] Additional headers
82
139
  #
@@ -90,11 +147,42 @@ module ESI
90
147
  # @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout
91
148
  #
92
149
  # @see https://esi.evetech.net/ui/#/Mail/get_characters_character_id_mail_mail_id
93
- def get_character_mail(character_id:, mail_id:, params: {}, headers: {})
94
- get("/characters/#{character_id}/mail/#{mail_id}/", headers: headers, params: params)
150
+ def get_character_mail(character_id:, mail_id:, headers: {}, params: {})
151
+ get_character_mail_raw(character_id: character_id, mail_id: mail_id, headers: headers, params: params).json
95
152
  end
96
153
  alias get_characters_character_id_mail_mail_id get_character_mail
97
154
 
155
+ # Return the contents of an EVE mail.
156
+ #
157
+ # This endpoint is cached for up to 30 seconds.
158
+ #
159
+ # This endpoint requires authorization (see {ESI::Client#authorize}).
160
+ #
161
+ # @esi_scope esi-mail.read_mail.v1
162
+ #
163
+ # @esi_version dev
164
+ # @esi_version legacy
165
+ # @esi_version v1
166
+ #
167
+ # @param character_id [Integer] An EVE character ID
168
+ # @param mail_id [Integer] An EVE mail ID
169
+ # @param params [Hash] Additional query string parameters
170
+ # @param headers [Hash] Additional headers
171
+ #
172
+ # @raise [ESI::Errors::BadRequestError] Bad request
173
+ # @raise [ESI::Errors::UnauthorizedError] Unauthorized
174
+ # @raise [ESI::Errors::ForbiddenError] Forbidden
175
+ # @raise [ESI::Errors::NotFoundError] Mail not found
176
+ # @raise [ESI::Errors::ErrorLimitedError] Error limited
177
+ # @raise [ESI::Errors::InternalServerError] Internal server error
178
+ # @raise [ESI::Errors::ServiceUnavailableError] Service unavailable
179
+ # @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout
180
+ #
181
+ # @see https://esi.evetech.net/ui/#/Mail/get_characters_character_id_mail_mail_id
182
+ def get_character_mail_raw(character_id:, mail_id:, headers: {}, params: {})
183
+ get("/characters/#{character_id}/mail/#{mail_id}/", headers: headers, params: params)
184
+ end
185
+
98
186
  # Return a list of the users mail labels, unread counts for each label and a total unread count.
99
187
  #
100
188
  # This endpoint is cached for up to 30 seconds.
@@ -106,7 +194,7 @@ module ESI
106
194
  # @esi_version dev
107
195
  # @esi_version v3
108
196
  #
109
- # @param character_id [Integer,String] An EVE character ID
197
+ # @param character_id [Integer] An EVE character ID
110
198
  # @param params [Hash] Additional query string parameters
111
199
  # @param headers [Hash] Additional headers
112
200
  #
@@ -119,11 +207,39 @@ module ESI
119
207
  # @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout
120
208
  #
121
209
  # @see https://esi.evetech.net/ui/#/Mail/get_characters_character_id_mail_labels
122
- def get_character_mail_labels(character_id:, params: {}, headers: {})
123
- get("/characters/#{character_id}/mail/labels/", headers: headers, params: params)
210
+ def get_character_mail_labels(character_id:, headers: {}, params: {})
211
+ get_character_mail_labels_raw(character_id: character_id, headers: headers, params: params).json
124
212
  end
125
213
  alias get_characters_character_id_mail_labels get_character_mail_labels
126
214
 
215
+ # Return a list of the users mail labels, unread counts for each label and a total unread count.
216
+ #
217
+ # This endpoint is cached for up to 30 seconds.
218
+ #
219
+ # This endpoint requires authorization (see {ESI::Client#authorize}).
220
+ #
221
+ # @esi_scope esi-mail.read_mail.v1
222
+ #
223
+ # @esi_version dev
224
+ # @esi_version v3
225
+ #
226
+ # @param character_id [Integer] An EVE character ID
227
+ # @param params [Hash] Additional query string parameters
228
+ # @param headers [Hash] Additional headers
229
+ #
230
+ # @raise [ESI::Errors::BadRequestError] Bad request
231
+ # @raise [ESI::Errors::UnauthorizedError] Unauthorized
232
+ # @raise [ESI::Errors::ForbiddenError] Forbidden
233
+ # @raise [ESI::Errors::ErrorLimitedError] Error limited
234
+ # @raise [ESI::Errors::InternalServerError] Internal server error
235
+ # @raise [ESI::Errors::ServiceUnavailableError] Service unavailable
236
+ # @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout
237
+ #
238
+ # @see https://esi.evetech.net/ui/#/Mail/get_characters_character_id_mail_labels
239
+ def get_character_mail_labels_raw(character_id:, headers: {}, params: {})
240
+ get("/characters/#{character_id}/mail/labels/", headers: headers, params: params)
241
+ end
242
+
127
243
  # Return all mailing lists that the character is subscribed to.
128
244
  #
129
245
  # This endpoint is cached for up to 120 seconds.
@@ -136,7 +252,7 @@ module ESI
136
252
  # @esi_version legacy
137
253
  # @esi_version v1
138
254
  #
139
- # @param character_id [Integer,String] An EVE character ID
255
+ # @param character_id [Integer] An EVE character ID
140
256
  # @param params [Hash] Additional query string parameters
141
257
  # @param headers [Hash] Additional headers
142
258
  #
@@ -149,11 +265,40 @@ module ESI
149
265
  # @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout
150
266
  #
151
267
  # @see https://esi.evetech.net/ui/#/Mail/get_characters_character_id_mail_lists
152
- def get_character_mail_lists(character_id:, params: {}, headers: {})
153
- get("/characters/#{character_id}/mail/lists/", headers: headers, params: params)
268
+ def get_character_mail_lists(character_id:, headers: {}, params: {})
269
+ get_character_mail_lists_raw(character_id: character_id, headers: headers, params: params).json
154
270
  end
155
271
  alias get_characters_character_id_mail_lists get_character_mail_lists
156
272
 
273
+ # Return all mailing lists that the character is subscribed to.
274
+ #
275
+ # This endpoint is cached for up to 120 seconds.
276
+ #
277
+ # This endpoint requires authorization (see {ESI::Client#authorize}).
278
+ #
279
+ # @esi_scope esi-mail.read_mail.v1
280
+ #
281
+ # @esi_version dev
282
+ # @esi_version legacy
283
+ # @esi_version v1
284
+ #
285
+ # @param character_id [Integer] An EVE character ID
286
+ # @param params [Hash] Additional query string parameters
287
+ # @param headers [Hash] Additional headers
288
+ #
289
+ # @raise [ESI::Errors::BadRequestError] Bad request
290
+ # @raise [ESI::Errors::UnauthorizedError] Unauthorized
291
+ # @raise [ESI::Errors::ForbiddenError] Forbidden
292
+ # @raise [ESI::Errors::ErrorLimitedError] Error limited
293
+ # @raise [ESI::Errors::InternalServerError] Internal server error
294
+ # @raise [ESI::Errors::ServiceUnavailableError] Service unavailable
295
+ # @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout
296
+ #
297
+ # @see https://esi.evetech.net/ui/#/Mail/get_characters_character_id_mail_lists
298
+ def get_character_mail_lists_raw(character_id:, headers: {}, params: {})
299
+ get("/characters/#{character_id}/mail/lists/", headers: headers, params: params)
300
+ end
301
+
157
302
  # Create and send a new mail.
158
303
  #
159
304
  # This endpoint requires authorization (see {ESI::Client#authorize}).
@@ -164,8 +309,9 @@ module ESI
164
309
  # @esi_version legacy
165
310
  # @esi_version v1
166
311
  #
167
- # @param character_id [Integer,String] An EVE character ID
312
+ # @param character_id [Integer] An EVE character ID
168
313
  # @param mail [Hash] The mail to send
314
+ # @param params [Hash] Additional query string parameters
169
315
  # @param headers [Hash] Additional headers
170
316
  #
171
317
  # @raise [ESI::Errors::BadRequestError] Bad request
@@ -178,11 +324,40 @@ module ESI
178
324
  # @raise [ESI::Errors::EveServerError] Internal error thrown from the EVE server. Most of the time this means you have hit an EVE server rate limit
179
325
  #
180
326
  # @see https://esi.evetech.net/ui/#/Mail/post_characters_character_id_mail
181
- def post_character_mail(character_id:, mail:, headers: {})
182
- post("/characters/#{character_id}/mail/", headers: headers, payload: mail)
327
+ def post_character_mail(character_id:, mail:, headers: {}, params: {})
328
+ post_character_mail_raw(character_id: character_id, mail: mail, headers: headers, params: params).json
183
329
  end
184
330
  alias post_characters_character_id_mail post_character_mail
185
331
 
332
+ # Create and send a new mail.
333
+ #
334
+ # This endpoint requires authorization (see {ESI::Client#authorize}).
335
+ #
336
+ # @esi_scope esi-mail.send_mail.v1
337
+ #
338
+ # @esi_version dev
339
+ # @esi_version legacy
340
+ # @esi_version v1
341
+ #
342
+ # @param character_id [Integer] An EVE character ID
343
+ # @param mail [Hash] The mail to send
344
+ # @param params [Hash] Additional query string parameters
345
+ # @param headers [Hash] Additional headers
346
+ #
347
+ # @raise [ESI::Errors::BadRequestError] Bad request
348
+ # @raise [ESI::Errors::UnauthorizedError] Unauthorized
349
+ # @raise [ESI::Errors::ForbiddenError] Forbidden
350
+ # @raise [ESI::Errors::ErrorLimitedError] Error limited
351
+ # @raise [ESI::Errors::InternalServerError] Internal server error
352
+ # @raise [ESI::Errors::ServiceUnavailableError] Service unavailable
353
+ # @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout
354
+ # @raise [ESI::Errors::EveServerError] Internal error thrown from the EVE server. Most of the time this means you have hit an EVE server rate limit
355
+ #
356
+ # @see https://esi.evetech.net/ui/#/Mail/post_characters_character_id_mail
357
+ def post_character_mail_raw(character_id:, mail:, headers: {}, params: {})
358
+ post("/characters/#{character_id}/mail/", headers: headers, params: params, payload: mail)
359
+ end
360
+
186
361
  # Create a mail label.
187
362
  #
188
363
  # This endpoint requires authorization (see {ESI::Client#authorize}).
@@ -193,8 +368,9 @@ module ESI
193
368
  # @esi_version legacy
194
369
  # @esi_version v2
195
370
  #
196
- # @param character_id [Integer,String] An EVE character ID
371
+ # @param character_id [Integer] An EVE character ID
197
372
  # @param label [Hash] Label to create
373
+ # @param params [Hash] Additional query string parameters
198
374
  # @param headers [Hash] Additional headers
199
375
  #
200
376
  # @raise [ESI::Errors::BadRequestError] Bad request
@@ -206,11 +382,39 @@ module ESI
206
382
  # @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout
207
383
  #
208
384
  # @see https://esi.evetech.net/ui/#/Mail/post_characters_character_id_mail_labels
209
- def post_character_mail_labels(character_id:, label:, headers: {})
210
- post("/characters/#{character_id}/mail/labels/", headers: headers, payload: label)
385
+ def post_character_mail_labels(character_id:, label:, headers: {}, params: {})
386
+ post_character_mail_labels_raw(character_id: character_id, label: label, headers: headers, params: params).json
211
387
  end
212
388
  alias post_characters_character_id_mail_labels post_character_mail_labels
213
389
 
390
+ # Create a mail label.
391
+ #
392
+ # This endpoint requires authorization (see {ESI::Client#authorize}).
393
+ #
394
+ # @esi_scope esi-mail.organize_mail.v1
395
+ #
396
+ # @esi_version dev
397
+ # @esi_version legacy
398
+ # @esi_version v2
399
+ #
400
+ # @param character_id [Integer] An EVE character ID
401
+ # @param label [Hash] Label to create
402
+ # @param params [Hash] Additional query string parameters
403
+ # @param headers [Hash] Additional headers
404
+ #
405
+ # @raise [ESI::Errors::BadRequestError] Bad request
406
+ # @raise [ESI::Errors::UnauthorizedError] Unauthorized
407
+ # @raise [ESI::Errors::ForbiddenError] Forbidden
408
+ # @raise [ESI::Errors::ErrorLimitedError] Error limited
409
+ # @raise [ESI::Errors::InternalServerError] Internal server error
410
+ # @raise [ESI::Errors::ServiceUnavailableError] Service unavailable
411
+ # @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout
412
+ #
413
+ # @see https://esi.evetech.net/ui/#/Mail/post_characters_character_id_mail_labels
414
+ def post_character_mail_labels_raw(character_id:, label:, headers: {}, params: {})
415
+ post("/characters/#{character_id}/mail/labels/", headers: headers, params: params, payload: label)
416
+ end
417
+
214
418
  # Update metadata about a mail.
215
419
  #
216
420
  # This endpoint requires authorization (see {ESI::Client#authorize}).
@@ -221,9 +425,10 @@ module ESI
221
425
  # @esi_version legacy
222
426
  # @esi_version v1
223
427
  #
224
- # @param character_id [Integer,String] An EVE character ID
225
- # @param mail_id [Integer,String] An EVE mail ID
428
+ # @param character_id [Integer] An EVE character ID
429
+ # @param mail_id [Integer] An EVE mail ID
226
430
  # @param contents [Hash] Data used to update the mail
431
+ # @param params [Hash] Additional query string parameters
227
432
  # @param headers [Hash] Additional headers
228
433
  #
229
434
  # @raise [ESI::Errors::BadRequestError] Bad request
@@ -235,10 +440,39 @@ module ESI
235
440
  # @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout
236
441
  #
237
442
  # @see https://esi.evetech.net/ui/#/Mail/put_characters_character_id_mail_mail_id
238
- def put_character_mail(character_id:, mail_id:, contents:, headers: {})
239
- put("/characters/#{character_id}/mail/#{mail_id}/", headers: headers, payload: contents)
443
+ def put_character_mail(character_id:, mail_id:, contents:, headers: {}, params: {})
444
+ put_character_mail_raw(character_id: character_id, mail_id: mail_id, contents: contents, headers: headers, params: params).json
240
445
  end
241
446
  alias put_characters_character_id_mail_mail_id put_character_mail
447
+
448
+ # Update metadata about a mail.
449
+ #
450
+ # This endpoint requires authorization (see {ESI::Client#authorize}).
451
+ #
452
+ # @esi_scope esi-mail.organize_mail.v1
453
+ #
454
+ # @esi_version dev
455
+ # @esi_version legacy
456
+ # @esi_version v1
457
+ #
458
+ # @param character_id [Integer] An EVE character ID
459
+ # @param mail_id [Integer] An EVE mail ID
460
+ # @param contents [Hash] Data used to update the mail
461
+ # @param params [Hash] Additional query string parameters
462
+ # @param headers [Hash] Additional headers
463
+ #
464
+ # @raise [ESI::Errors::BadRequestError] Bad request
465
+ # @raise [ESI::Errors::UnauthorizedError] Unauthorized
466
+ # @raise [ESI::Errors::ForbiddenError] Forbidden
467
+ # @raise [ESI::Errors::ErrorLimitedError] Error limited
468
+ # @raise [ESI::Errors::InternalServerError] Internal server error
469
+ # @raise [ESI::Errors::ServiceUnavailableError] Service unavailable
470
+ # @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout
471
+ #
472
+ # @see https://esi.evetech.net/ui/#/Mail/put_characters_character_id_mail_mail_id
473
+ def put_character_mail_raw(character_id:, mail_id:, contents:, headers: {}, params: {})
474
+ put("/characters/#{character_id}/mail/#{mail_id}/", headers: headers, params: params, payload: contents)
475
+ end
242
476
  end
243
477
  end
244
478
  end