esi-sdk 1.1.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (68) hide show
  1. checksums.yaml +7 -0
  2. data/.editorconfig +9 -0
  3. data/.github/ISSUE_TEMPLATE/bug_report.md +36 -0
  4. data/.github/ISSUE_TEMPLATE/feature_request.md +20 -0
  5. data/.github/ISSUE_TEMPLATE/support.md +7 -0
  6. data/.github/PULL_REQUEST_TEMPLATE.md +37 -0
  7. data/.github/dependabot.yml +17 -0
  8. data/.github/workflows/cicd.yml +181 -0
  9. data/.gitignore +11 -0
  10. data/.rspec +2 -0
  11. data/.rubocop.yml +36 -0
  12. data/.ruby-version +1 -0
  13. data/.yardext.rb +18 -0
  14. data/.yardopts +17 -0
  15. data/CHANGELOG.md +17 -0
  16. data/CODE_OF_CONDUCT.md +84 -0
  17. data/CONTRIBUTING.md +69 -0
  18. data/Gemfile +24 -0
  19. data/Gemfile.lock +141 -0
  20. data/LICENSE.txt +21 -0
  21. data/README.md +87 -0
  22. data/Rakefile +349 -0
  23. data/SECURITY.md +13 -0
  24. data/bin/console +15 -0
  25. data/bin/setup +8 -0
  26. data/esi-sdk.gemspec +32 -0
  27. data/exe/esi-sdk +4 -0
  28. data/lib/esi/client/alliance.rb +104 -0
  29. data/lib/esi/client/assets.rb +179 -0
  30. data/lib/esi/client/bookmarks.rb +126 -0
  31. data/lib/esi/client/calendar.rb +139 -0
  32. data/lib/esi/client/character.rb +389 -0
  33. data/lib/esi/client/clones.rb +69 -0
  34. data/lib/esi/client/contacts.rb +277 -0
  35. data/lib/esi/client/contracts.rb +274 -0
  36. data/lib/esi/client/corporation.rb +626 -0
  37. data/lib/esi/client/dogma.rb +117 -0
  38. data/lib/esi/client/faction_warfare.rb +196 -0
  39. data/lib/esi/client/fittings.rb +93 -0
  40. data/lib/esi/client/fleets.rb +428 -0
  41. data/lib/esi/client/incursions.rb +30 -0
  42. data/lib/esi/client/industry.rb +237 -0
  43. data/lib/esi/client/insurance.rb +30 -0
  44. data/lib/esi/client/killmails.rb +95 -0
  45. data/lib/esi/client/location.rb +100 -0
  46. data/lib/esi/client/loyalty.rb +61 -0
  47. data/lib/esi/client/mail.rb +244 -0
  48. data/lib/esi/client/market.rb +302 -0
  49. data/lib/esi/client/opportunities.rb +124 -0
  50. data/lib/esi/client/planetary_interaction.rb +122 -0
  51. data/lib/esi/client/routes.rb +37 -0
  52. data/lib/esi/client/search.rb +68 -0
  53. data/lib/esi/client/skills.rb +97 -0
  54. data/lib/esi/client/sovereignty.rb +74 -0
  55. data/lib/esi/client/status.rb +31 -0
  56. data/lib/esi/client/universe.rb +640 -0
  57. data/lib/esi/client/user_interface.rb +145 -0
  58. data/lib/esi/client/wallet.rb +191 -0
  59. data/lib/esi/client/wars.rb +82 -0
  60. data/lib/esi/client.rb +225 -0
  61. data/lib/esi/errors.rb +51 -0
  62. data/lib/esi/version.rb +5 -0
  63. data/lib/esi-sdk.rb +8 -0
  64. data/release.config.js +32 -0
  65. data/yard/fulldoc/html/css/pygments-default.css +69 -0
  66. data/yard/fulldoc/html/setup.rb +6 -0
  67. data/yard/layout/html/setup.rb +6 -0
  68. metadata +156 -0
@@ -0,0 +1,244 @@
1
+ # frozen_string_literal: true
2
+
3
+ module ESI
4
+ class Client
5
+ # ESI mail operations.
6
+ module Mail
7
+ # Delete a mail.
8
+ #
9
+ # This endpoint requires authorization (see {ESI::Client#authorize}).
10
+ #
11
+ # @esi_scope esi-mail.organize_mail.v1
12
+ #
13
+ # @esi_version dev
14
+ # @esi_version legacy
15
+ # @esi_version v1
16
+ #
17
+ # @param character_id [Integer,String] An EVE character ID
18
+ # @param mail_id [Integer,String] An EVE mail ID
19
+ # @param params [Hash] Additional query string parameters
20
+ # @param headers [Hash] Additional headers
21
+ #
22
+ # @raise [ESI::Errors::BadRequestError] Bad request
23
+ # @raise [ESI::Errors::UnauthorizedError] Unauthorized
24
+ # @raise [ESI::Errors::ForbiddenError] Forbidden
25
+ # @raise [ESI::Errors::ErrorLimitedError] Error limited
26
+ # @raise [ESI::Errors::InternalServerError] Internal server error
27
+ # @raise [ESI::Errors::ServiceUnavailableError] Service unavailable
28
+ # @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout
29
+ #
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)
33
+ end
34
+ alias delete_characters_character_id_mail_mail_id delete_character_mail
35
+
36
+ # Delete a mail label.
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,String] An EVE character ID
47
+ # @param label_id [Integer,String] An EVE label 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::UnprocessableEntityError] Default labels cannot be deleted
56
+ # @raise [ESI::Errors::InternalServerError] Internal server error
57
+ # @raise [ESI::Errors::ServiceUnavailableError] Service unavailable
58
+ # @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout
59
+ #
60
+ # @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)
63
+ end
64
+ alias delete_characters_character_id_mail_labels_label_id delete_character_mail_label
65
+
66
+ # Return the contents of an EVE mail.
67
+ #
68
+ # This endpoint is cached for up to 30 seconds.
69
+ #
70
+ # This endpoint requires authorization (see {ESI::Client#authorize}).
71
+ #
72
+ # @esi_scope esi-mail.read_mail.v1
73
+ #
74
+ # @esi_version dev
75
+ # @esi_version legacy
76
+ # @esi_version v1
77
+ #
78
+ # @param character_id [Integer,String] An EVE character ID
79
+ # @param mail_id [Integer,String] An EVE mail ID
80
+ # @param params [Hash] Additional query string parameters
81
+ # @param headers [Hash] Additional headers
82
+ #
83
+ # @raise [ESI::Errors::BadRequestError] Bad request
84
+ # @raise [ESI::Errors::UnauthorizedError] Unauthorized
85
+ # @raise [ESI::Errors::ForbiddenError] Forbidden
86
+ # @raise [ESI::Errors::NotFoundError] Mail not found
87
+ # @raise [ESI::Errors::ErrorLimitedError] Error limited
88
+ # @raise [ESI::Errors::InternalServerError] Internal server error
89
+ # @raise [ESI::Errors::ServiceUnavailableError] Service unavailable
90
+ # @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout
91
+ #
92
+ # @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)
95
+ end
96
+ alias get_characters_character_id_mail_mail_id get_character_mail
97
+
98
+ # Return a list of the users mail labels, unread counts for each label and a total unread count.
99
+ #
100
+ # This endpoint is cached for up to 30 seconds.
101
+ #
102
+ # This endpoint requires authorization (see {ESI::Client#authorize}).
103
+ #
104
+ # @esi_scope esi-mail.read_mail.v1
105
+ #
106
+ # @esi_version dev
107
+ # @esi_version v3
108
+ #
109
+ # @param character_id [Integer,String] An EVE character ID
110
+ # @param params [Hash] Additional query string parameters
111
+ # @param headers [Hash] Additional headers
112
+ #
113
+ # @raise [ESI::Errors::BadRequestError] Bad request
114
+ # @raise [ESI::Errors::UnauthorizedError] Unauthorized
115
+ # @raise [ESI::Errors::ForbiddenError] Forbidden
116
+ # @raise [ESI::Errors::ErrorLimitedError] Error limited
117
+ # @raise [ESI::Errors::InternalServerError] Internal server error
118
+ # @raise [ESI::Errors::ServiceUnavailableError] Service unavailable
119
+ # @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout
120
+ #
121
+ # @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)
124
+ end
125
+ alias get_characters_character_id_mail_labels get_character_mail_labels
126
+
127
+ # Return all mailing lists that the character is subscribed to.
128
+ #
129
+ # This endpoint is cached for up to 120 seconds.
130
+ #
131
+ # This endpoint requires authorization (see {ESI::Client#authorize}).
132
+ #
133
+ # @esi_scope esi-mail.read_mail.v1
134
+ #
135
+ # @esi_version dev
136
+ # @esi_version legacy
137
+ # @esi_version v1
138
+ #
139
+ # @param character_id [Integer,String] An EVE character ID
140
+ # @param params [Hash] Additional query string parameters
141
+ # @param headers [Hash] Additional headers
142
+ #
143
+ # @raise [ESI::Errors::BadRequestError] Bad request
144
+ # @raise [ESI::Errors::UnauthorizedError] Unauthorized
145
+ # @raise [ESI::Errors::ForbiddenError] Forbidden
146
+ # @raise [ESI::Errors::ErrorLimitedError] Error limited
147
+ # @raise [ESI::Errors::InternalServerError] Internal server error
148
+ # @raise [ESI::Errors::ServiceUnavailableError] Service unavailable
149
+ # @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout
150
+ #
151
+ # @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)
154
+ end
155
+ alias get_characters_character_id_mail_lists get_character_mail_lists
156
+
157
+ # Create and send a new mail.
158
+ #
159
+ # This endpoint requires authorization (see {ESI::Client#authorize}).
160
+ #
161
+ # @esi_scope esi-mail.send_mail.v1
162
+ #
163
+ # @esi_version dev
164
+ # @esi_version legacy
165
+ # @esi_version v1
166
+ #
167
+ # @param character_id [Integer,String] An EVE character ID
168
+ # @param mail [Hash] The mail to send
169
+ # @param headers [Hash] Additional headers
170
+ #
171
+ # @raise [ESI::Errors::BadRequestError] Bad request
172
+ # @raise [ESI::Errors::UnauthorizedError] Unauthorized
173
+ # @raise [ESI::Errors::ForbiddenError] Forbidden
174
+ # @raise [ESI::Errors::ErrorLimitedError] Error limited
175
+ # @raise [ESI::Errors::InternalServerError] Internal server error
176
+ # @raise [ESI::Errors::ServiceUnavailableError] Service unavailable
177
+ # @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout
178
+ # @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
+ #
180
+ # @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)
183
+ end
184
+ alias post_characters_character_id_mail post_character_mail
185
+
186
+ # Create a mail label.
187
+ #
188
+ # This endpoint requires authorization (see {ESI::Client#authorize}).
189
+ #
190
+ # @esi_scope esi-mail.organize_mail.v1
191
+ #
192
+ # @esi_version dev
193
+ # @esi_version legacy
194
+ # @esi_version v2
195
+ #
196
+ # @param character_id [Integer,String] An EVE character ID
197
+ # @param label [Hash] Label to create
198
+ # @param headers [Hash] Additional headers
199
+ #
200
+ # @raise [ESI::Errors::BadRequestError] Bad request
201
+ # @raise [ESI::Errors::UnauthorizedError] Unauthorized
202
+ # @raise [ESI::Errors::ForbiddenError] Forbidden
203
+ # @raise [ESI::Errors::ErrorLimitedError] Error limited
204
+ # @raise [ESI::Errors::InternalServerError] Internal server error
205
+ # @raise [ESI::Errors::ServiceUnavailableError] Service unavailable
206
+ # @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout
207
+ #
208
+ # @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)
211
+ end
212
+ alias post_characters_character_id_mail_labels post_character_mail_labels
213
+
214
+ # Update metadata about a mail.
215
+ #
216
+ # This endpoint requires authorization (see {ESI::Client#authorize}).
217
+ #
218
+ # @esi_scope esi-mail.organize_mail.v1
219
+ #
220
+ # @esi_version dev
221
+ # @esi_version legacy
222
+ # @esi_version v1
223
+ #
224
+ # @param character_id [Integer,String] An EVE character ID
225
+ # @param mail_id [Integer,String] An EVE mail ID
226
+ # @param contents [Hash] Data used to update the mail
227
+ # @param headers [Hash] Additional headers
228
+ #
229
+ # @raise [ESI::Errors::BadRequestError] Bad request
230
+ # @raise [ESI::Errors::UnauthorizedError] Unauthorized
231
+ # @raise [ESI::Errors::ForbiddenError] Forbidden
232
+ # @raise [ESI::Errors::ErrorLimitedError] Error limited
233
+ # @raise [ESI::Errors::InternalServerError] Internal server error
234
+ # @raise [ESI::Errors::ServiceUnavailableError] Service unavailable
235
+ # @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout
236
+ #
237
+ # @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)
240
+ end
241
+ alias put_characters_character_id_mail_mail_id put_character_mail
242
+ end
243
+ end
244
+ end
@@ -0,0 +1,302 @@
1
+ # frozen_string_literal: true
2
+
3
+ module ESI
4
+ class Client
5
+ # ESI market operations.
6
+ module Market
7
+ # List open market orders placed by a character.
8
+ #
9
+ # This endpoint is cached for up to 1200 seconds.
10
+ #
11
+ # This endpoint requires authorization (see {ESI::Client#authorize}).
12
+ #
13
+ # @esi_scope esi-markets.read_character_orders.v1
14
+ #
15
+ # @esi_version dev
16
+ # @esi_version v2
17
+ #
18
+ # @param character_id [Integer,String] An EVE character ID
19
+ # @param params [Hash] Additional query string parameters
20
+ # @param headers [Hash] Additional headers
21
+ #
22
+ # @raise [ESI::Errors::BadRequestError] Bad request
23
+ # @raise [ESI::Errors::UnauthorizedError] Unauthorized
24
+ # @raise [ESI::Errors::ForbiddenError] Forbidden
25
+ # @raise [ESI::Errors::ErrorLimitedError] Error limited
26
+ # @raise [ESI::Errors::InternalServerError] Internal server error
27
+ # @raise [ESI::Errors::ServiceUnavailableError] Service unavailable
28
+ # @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout
29
+ #
30
+ # @see https://esi.evetech.net/ui/#/Market/get_characters_character_id_orders
31
+ def get_character_orders(character_id:, params: {}, headers: {})
32
+ get("/characters/#{character_id}/orders/", headers: headers, params: params)
33
+ end
34
+ alias get_characters_character_id_orders get_character_orders
35
+
36
+ # List cancelled and expired market orders placed by a character up to 90 days in the past.
37
+ #
38
+ # This endpoint is cached for up to 3600 seconds.
39
+ #
40
+ # This endpoint requires authorization (see {ESI::Client#authorize}).
41
+ #
42
+ # @esi_scope esi-markets.read_character_orders.v1
43
+ #
44
+ # @esi_version dev
45
+ # @esi_version legacy
46
+ # @esi_version v1
47
+ #
48
+ # @param character_id [Integer,String] An EVE character ID
49
+ # @param params [Hash] Additional query string parameters
50
+ # @param headers [Hash] Additional headers
51
+ #
52
+ # @raise [ESI::Errors::BadRequestError] Bad request
53
+ # @raise [ESI::Errors::UnauthorizedError] Unauthorized
54
+ # @raise [ESI::Errors::ForbiddenError] Forbidden
55
+ # @raise [ESI::Errors::ErrorLimitedError] Error limited
56
+ # @raise [ESI::Errors::InternalServerError] Internal server error
57
+ # @raise [ESI::Errors::ServiceUnavailableError] Service unavailable
58
+ # @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout
59
+ #
60
+ # @see https://esi.evetech.net/ui/#/Market/get_characters_character_id_orders_history
61
+ def get_character_orders_history(character_id:, params: {}, headers: {})
62
+ get("/characters/#{character_id}/orders/history/", headers: headers, params: params)
63
+ end
64
+ alias get_characters_character_id_orders_history get_character_orders_history
65
+
66
+ # List open market orders placed on behalf of a corporation.
67
+ #
68
+ # This endpoint is cached for up to 1200 seconds.
69
+ #
70
+ # This endpoint requires authorization (see {ESI::Client#authorize}).
71
+ #
72
+ # @esi_scope esi-markets.read_corporation_orders.v1
73
+ #
74
+ # @esi_version dev
75
+ # @esi_version v3
76
+ #
77
+ # @param corporation_id [Integer,String] An EVE corporation ID
78
+ # @param params [Hash] Additional query string parameters
79
+ # @param headers [Hash] Additional headers
80
+ #
81
+ # @raise [ESI::Errors::BadRequestError] Bad request
82
+ # @raise [ESI::Errors::UnauthorizedError] Unauthorized
83
+ # @raise [ESI::Errors::ForbiddenError] Forbidden
84
+ # @raise [ESI::Errors::ErrorLimitedError] Error limited
85
+ # @raise [ESI::Errors::InternalServerError] Internal server error
86
+ # @raise [ESI::Errors::ServiceUnavailableError] Service unavailable
87
+ # @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout
88
+ #
89
+ # @see https://esi.evetech.net/ui/#/Market/get_corporations_corporation_id_orders
90
+ def get_corporation_orders(corporation_id:, params: {}, headers: {})
91
+ get("/corporations/#{corporation_id}/orders/", headers: headers, params: params)
92
+ end
93
+ alias get_corporations_corporation_id_orders get_corporation_orders
94
+
95
+ # List cancelled and expired market orders placed on behalf of a corporation up to 90 days in the past.
96
+ #
97
+ # This endpoint is cached for up to 3600 seconds.
98
+ #
99
+ # This endpoint requires authorization (see {ESI::Client#authorize}).
100
+ #
101
+ # @esi_scope esi-markets.read_corporation_orders.v1
102
+ #
103
+ # @esi_version dev
104
+ # @esi_version v2
105
+ #
106
+ # @param corporation_id [Integer,String] An EVE corporation ID
107
+ # @param params [Hash] Additional query string parameters
108
+ # @param headers [Hash] Additional headers
109
+ #
110
+ # @raise [ESI::Errors::BadRequestError] Bad request
111
+ # @raise [ESI::Errors::UnauthorizedError] Unauthorized
112
+ # @raise [ESI::Errors::ForbiddenError] Forbidden
113
+ # @raise [ESI::Errors::ErrorLimitedError] Error limited
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/#/Market/get_corporations_corporation_id_orders_history
119
+ def get_corporation_orders_history(corporation_id:, params: {}, headers: {})
120
+ get("/corporations/#{corporation_id}/orders/history/", headers: headers, params: params)
121
+ end
122
+ alias get_corporations_corporation_id_orders_history get_corporation_orders_history
123
+
124
+ # Get a list of item groups.
125
+ #
126
+ # @esi_version dev
127
+ # @esi_version legacy
128
+ # @esi_version v1
129
+ #
130
+ # @param params [Hash] Additional query string parameters
131
+ # @param headers [Hash] Additional headers
132
+ #
133
+ # @raise [ESI::Errors::BadRequestError] Bad request
134
+ # @raise [ESI::Errors::ErrorLimitedError] Error limited
135
+ # @raise [ESI::Errors::InternalServerError] Internal server error
136
+ # @raise [ESI::Errors::ServiceUnavailableError] Service unavailable
137
+ # @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout
138
+ #
139
+ # @see https://esi.evetech.net/ui/#/Market/get_markets_groups
140
+ def get_market_groups(params: {}, headers: {})
141
+ get("/markets/groups/", headers: headers, params: params)
142
+ end
143
+ alias get_markets_groups get_market_groups
144
+
145
+ # Get information on an item group.
146
+ #
147
+ # @esi_version dev
148
+ # @esi_version legacy
149
+ # @esi_version v1
150
+ #
151
+ # @param market_group_id [Integer,String] An Eve item group ID
152
+ # @param params [Hash] Additional query string parameters
153
+ # @param headers [Hash] Additional headers
154
+ #
155
+ # @raise [ESI::Errors::BadRequestError] Bad request
156
+ # @raise [ESI::Errors::NotFoundError] Market group not found
157
+ # @raise [ESI::Errors::ErrorLimitedError] Error limited
158
+ # @raise [ESI::Errors::InternalServerError] Internal server error
159
+ # @raise [ESI::Errors::ServiceUnavailableError] Service unavailable
160
+ # @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout
161
+ #
162
+ # @see https://esi.evetech.net/ui/#/Market/get_markets_groups_market_group_id
163
+ def get_market_groups_market_group(market_group_id:, params: {}, headers: {})
164
+ get("/markets/groups/#{market_group_id}/", headers: headers, params: params)
165
+ end
166
+ alias get_markets_groups_market_group_id get_market_groups_market_group
167
+
168
+ # Return a list of prices.
169
+ #
170
+ # This endpoint is cached for up to 3600 seconds.
171
+ #
172
+ # @esi_version dev
173
+ # @esi_version legacy
174
+ # @esi_version v1
175
+ #
176
+ # @param params [Hash] Additional query string parameters
177
+ # @param headers [Hash] Additional headers
178
+ #
179
+ # @raise [ESI::Errors::BadRequestError] Bad request
180
+ # @raise [ESI::Errors::ErrorLimitedError] Error limited
181
+ # @raise [ESI::Errors::InternalServerError] Internal server error
182
+ # @raise [ESI::Errors::ServiceUnavailableError] Service unavailable
183
+ # @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout
184
+ #
185
+ # @see https://esi.evetech.net/ui/#/Market/get_markets_prices
186
+ def get_market_prices(params: {}, headers: {})
187
+ get("/markets/prices/", headers: headers, params: params)
188
+ end
189
+ alias get_markets_prices get_market_prices
190
+
191
+ # Return a list of historical market statistics for the specified type in a region.
192
+ #
193
+ # @esi_version dev
194
+ # @esi_version legacy
195
+ # @esi_version v1
196
+ #
197
+ # @param region_id [Integer,String] Return statistics in this region
198
+ # @param type_id [Integer] Return statistics for this type
199
+ # @param params [Hash] Additional query string parameters
200
+ # @param headers [Hash] Additional headers
201
+ #
202
+ # @raise [ESI::Errors::BadRequestError] Bad request
203
+ # @raise [ESI::Errors::NotFoundError] Type not found
204
+ # @raise [ESI::Errors::ErrorLimitedError] Error limited
205
+ # @raise [ESI::Errors::UnprocessableEntityError] Not found
206
+ # @raise [ESI::Errors::InternalServerError] Internal server error
207
+ # @raise [ESI::Errors::ServiceUnavailableError] Service unavailable
208
+ # @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout
209
+ # @raise [ESI::Errors::EveServerError] Internal error thrown from the EVE server
210
+ #
211
+ # @see https://esi.evetech.net/ui/#/Market/get_markets_region_id_history
212
+ def get_markets_region_history(region_id:, type_id:, params: {}, headers: {})
213
+ query_string = URI.encode_www_form([["type_id", type_id]])
214
+ get("/markets/#{region_id}/history/?#{query_string}", headers: headers, params: params)
215
+ end
216
+ alias get_markets_region_id_history get_markets_region_history
217
+
218
+ # Return a list of orders in a region.
219
+ #
220
+ # This endpoint is cached for up to 300 seconds.
221
+ #
222
+ # @esi_version dev
223
+ # @esi_version legacy
224
+ # @esi_version v1
225
+ #
226
+ # @param region_id [Integer,String] Return orders in this region
227
+ # @param order_type [String] Filter buy/sell orders, return all orders by default. If you query without type_id, we always return both buy and sell orders
228
+ # @param type_id [Integer] Return orders only for this type
229
+ # @param params [Hash] Additional query string parameters
230
+ # @param headers [Hash] Additional headers
231
+ #
232
+ # @raise [ESI::Errors::BadRequestError] Bad request
233
+ # @raise [ESI::Errors::NotFoundError] Not found
234
+ # @raise [ESI::Errors::ErrorLimitedError] Error limited
235
+ # @raise [ESI::Errors::UnprocessableEntityError] Not found
236
+ # @raise [ESI::Errors::InternalServerError] Internal server error
237
+ # @raise [ESI::Errors::ServiceUnavailableError] Service unavailable
238
+ # @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout
239
+ #
240
+ # @see https://esi.evetech.net/ui/#/Market/get_markets_region_id_orders
241
+ def get_markets_region_orders(region_id:, order_type:, type_id:, params: {}, headers: {})
242
+ query_string = URI.encode_www_form([["order_type", order_type], ["type_id", type_id]])
243
+ get("/markets/#{region_id}/orders/?#{query_string}", headers: headers, params: params)
244
+ end
245
+ alias get_markets_region_id_orders get_markets_region_orders
246
+
247
+ # Return a list of type IDs that have active orders in the region, for efficient market indexing.
248
+ #
249
+ # This endpoint is cached for up to 600 seconds.
250
+ #
251
+ # @esi_version dev
252
+ # @esi_version legacy
253
+ # @esi_version v1
254
+ #
255
+ # @param region_id [Integer,String] Return statistics in this region
256
+ # @param params [Hash] Additional query string parameters
257
+ # @param headers [Hash] Additional headers
258
+ #
259
+ # @raise [ESI::Errors::BadRequestError] Bad request
260
+ # @raise [ESI::Errors::ErrorLimitedError] Error limited
261
+ # @raise [ESI::Errors::InternalServerError] Internal server error
262
+ # @raise [ESI::Errors::ServiceUnavailableError] Service unavailable
263
+ # @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout
264
+ #
265
+ # @see https://esi.evetech.net/ui/#/Market/get_markets_region_id_types
266
+ def get_markets_region_types(region_id:, params: {}, headers: {})
267
+ get("/markets/#{region_id}/types/", headers: headers, params: params)
268
+ end
269
+ alias get_markets_region_id_types get_markets_region_types
270
+
271
+ # Return all orders in a structure.
272
+ #
273
+ # This endpoint is cached for up to 300 seconds.
274
+ #
275
+ # This endpoint requires authorization (see {ESI::Client#authorize}).
276
+ #
277
+ # @esi_scope esi-markets.structure_markets.v1
278
+ #
279
+ # @esi_version dev
280
+ # @esi_version legacy
281
+ # @esi_version v1
282
+ #
283
+ # @param structure_id [Integer,String] Return orders in this structure
284
+ # @param params [Hash] Additional query string parameters
285
+ # @param headers [Hash] Additional headers
286
+ #
287
+ # @raise [ESI::Errors::BadRequestError] Bad request
288
+ # @raise [ESI::Errors::UnauthorizedError] Unauthorized
289
+ # @raise [ESI::Errors::ForbiddenError] Forbidden
290
+ # @raise [ESI::Errors::ErrorLimitedError] Error limited
291
+ # @raise [ESI::Errors::InternalServerError] Internal server error
292
+ # @raise [ESI::Errors::ServiceUnavailableError] Service unavailable
293
+ # @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout
294
+ #
295
+ # @see https://esi.evetech.net/ui/#/Market/get_markets_structures_structure_id
296
+ def get_markets_structure(structure_id:, params: {}, headers: {})
297
+ get("/markets/structures/#{structure_id}/", headers: headers, params: params)
298
+ end
299
+ alias get_markets_structures_structure_id get_markets_structure
300
+ end
301
+ end
302
+ end
@@ -0,0 +1,124 @@
1
+ # frozen_string_literal: true
2
+
3
+ module ESI
4
+ class Client
5
+ # ESI opportunities operations.
6
+ module Opportunity
7
+ # Return a list of tasks finished by a character.
8
+ #
9
+ # This endpoint is cached for up to 3600 seconds.
10
+ #
11
+ # This endpoint requires authorization (see {ESI::Client#authorize}).
12
+ #
13
+ # @esi_scope esi-characters.read_opportunities.v1
14
+ #
15
+ # @esi_version dev
16
+ # @esi_version legacy
17
+ # @esi_version v1
18
+ #
19
+ # @param character_id [Integer,String] An EVE character ID
20
+ # @param params [Hash] Additional query string parameters
21
+ # @param headers [Hash] Additional headers
22
+ #
23
+ # @raise [ESI::Errors::BadRequestError] Bad request
24
+ # @raise [ESI::Errors::UnauthorizedError] Unauthorized
25
+ # @raise [ESI::Errors::ForbiddenError] Forbidden
26
+ # @raise [ESI::Errors::ErrorLimitedError] Error limited
27
+ # @raise [ESI::Errors::InternalServerError] Internal server error
28
+ # @raise [ESI::Errors::ServiceUnavailableError] Service unavailable
29
+ # @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout
30
+ #
31
+ # @see https://esi.evetech.net/ui/#/Opportunities/get_characters_character_id_opportunities
32
+ def get_character_opportunities(character_id:, params: {}, headers: {})
33
+ get("/characters/#{character_id}/opportunities/", headers: headers, params: params)
34
+ end
35
+ alias get_characters_character_id_opportunities get_character_opportunities
36
+
37
+ # Return information of an opportunities group.
38
+ #
39
+ # @esi_version dev
40
+ # @esi_version legacy
41
+ # @esi_version v1
42
+ #
43
+ # @param group_id [Integer,String] ID of an opportunities group
44
+ # @param params [Hash] Additional query string parameters
45
+ # @param headers [Hash] Additional headers
46
+ #
47
+ # @raise [ESI::Errors::BadRequestError] Bad request
48
+ # @raise [ESI::Errors::ErrorLimitedError] Error limited
49
+ # @raise [ESI::Errors::InternalServerError] Internal server error
50
+ # @raise [ESI::Errors::ServiceUnavailableError] Service unavailable
51
+ # @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout
52
+ #
53
+ # @see https://esi.evetech.net/ui/#/Opportunities/get_opportunities_groups_group_id
54
+ def get_opportunities_group(group_id:, params: {}, headers: {})
55
+ get("/opportunities/groups/#{group_id}/", headers: headers, params: params)
56
+ end
57
+ alias get_opportunities_groups_group_id get_opportunities_group
58
+
59
+ # Return information of an opportunities task.
60
+ #
61
+ # @esi_version dev
62
+ # @esi_version legacy
63
+ # @esi_version v1
64
+ #
65
+ # @param task_id [Integer,String] ID of an opportunities task
66
+ # @param params [Hash] Additional query string parameters
67
+ # @param headers [Hash] Additional headers
68
+ #
69
+ # @raise [ESI::Errors::BadRequestError] Bad request
70
+ # @raise [ESI::Errors::ErrorLimitedError] Error limited
71
+ # @raise [ESI::Errors::InternalServerError] Internal server error
72
+ # @raise [ESI::Errors::ServiceUnavailableError] Service unavailable
73
+ # @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout
74
+ #
75
+ # @see https://esi.evetech.net/ui/#/Opportunities/get_opportunities_tasks_task_id
76
+ def get_opportunities_task(task_id:, params: {}, headers: {})
77
+ get("/opportunities/tasks/#{task_id}/", headers: headers, params: params)
78
+ end
79
+ alias get_opportunities_tasks_task_id get_opportunities_task
80
+
81
+ # Return a list of opportunities groups.
82
+ #
83
+ # @esi_version dev
84
+ # @esi_version legacy
85
+ # @esi_version v1
86
+ #
87
+ # @param params [Hash] Additional query string parameters
88
+ # @param headers [Hash] Additional headers
89
+ #
90
+ # @raise [ESI::Errors::BadRequestError] Bad request
91
+ # @raise [ESI::Errors::ErrorLimitedError] Error limited
92
+ # @raise [ESI::Errors::InternalServerError] Internal server error
93
+ # @raise [ESI::Errors::ServiceUnavailableError] Service unavailable
94
+ # @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout
95
+ #
96
+ # @see https://esi.evetech.net/ui/#/Opportunities/get_opportunities_groups
97
+ def get_opportunity_groups(params: {}, headers: {})
98
+ get("/opportunities/groups/", headers: headers, params: params)
99
+ end
100
+ alias get_opportunities_groups get_opportunity_groups
101
+
102
+ # Return a list of opportunities tasks.
103
+ #
104
+ # @esi_version dev
105
+ # @esi_version legacy
106
+ # @esi_version v1
107
+ #
108
+ # @param params [Hash] Additional query string parameters
109
+ # @param headers [Hash] Additional headers
110
+ #
111
+ # @raise [ESI::Errors::BadRequestError] Bad request
112
+ # @raise [ESI::Errors::ErrorLimitedError] Error limited
113
+ # @raise [ESI::Errors::InternalServerError] Internal server error
114
+ # @raise [ESI::Errors::ServiceUnavailableError] Service unavailable
115
+ # @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout
116
+ #
117
+ # @see https://esi.evetech.net/ui/#/Opportunities/get_opportunities_tasks
118
+ def get_opportunity_tasks(params: {}, headers: {})
119
+ get("/opportunities/tasks/", headers: headers, params: params)
120
+ end
121
+ alias get_opportunities_tasks get_opportunity_tasks
122
+ end
123
+ end
124
+ end