esi-sdk 1.1.1

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 (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,117 @@
1
+ # frozen_string_literal: true
2
+
3
+ module ESI
4
+ class Client
5
+ # ESI dogma operations.
6
+ module Dogma
7
+ # Get information on a dogma attribute.
8
+ #
9
+ # @esi_version dev
10
+ # @esi_version legacy
11
+ # @esi_version v1
12
+ #
13
+ # @param attribute_id [Integer,String] A dogma attribute ID
14
+ # @param params [Hash] Additional query string parameters
15
+ # @param headers [Hash] Additional headers
16
+ #
17
+ # @raise [ESI::Errors::BadRequestError] Bad request
18
+ # @raise [ESI::Errors::NotFoundError] Dogma attribute not found
19
+ # @raise [ESI::Errors::ErrorLimitedError] Error limited
20
+ # @raise [ESI::Errors::InternalServerError] Internal server error
21
+ # @raise [ESI::Errors::ServiceUnavailableError] Service unavailable
22
+ # @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout
23
+ #
24
+ # @see https://esi.evetech.net/ui/#/Dogma/get_dogma_attributes_attribute_id
25
+ def get_dogma_attribute(attribute_id:, params: {}, headers: {})
26
+ get("/dogma/attributes/#{attribute_id}/", headers: headers, params: params)
27
+ end
28
+ alias get_dogma_attributes_attribute_id get_dogma_attribute
29
+
30
+ # Get a list of dogma attribute ids.
31
+ #
32
+ # @esi_version dev
33
+ # @esi_version legacy
34
+ # @esi_version v1
35
+ #
36
+ # @param params [Hash] Additional query string parameters
37
+ # @param headers [Hash] Additional headers
38
+ #
39
+ # @raise [ESI::Errors::BadRequestError] Bad request
40
+ # @raise [ESI::Errors::ErrorLimitedError] Error limited
41
+ # @raise [ESI::Errors::InternalServerError] Internal server error
42
+ # @raise [ESI::Errors::ServiceUnavailableError] Service unavailable
43
+ # @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout
44
+ #
45
+ # @see https://esi.evetech.net/ui/#/Dogma/get_dogma_attributes
46
+ def get_dogma_attributes(params: {}, headers: {})
47
+ get("/dogma/attributes/", headers: headers, params: params)
48
+ end
49
+
50
+ # Returns info about a dynamic item resulting from mutation with a mutaplasmid.
51
+ #
52
+ # @esi_version dev
53
+ # @esi_version legacy
54
+ # @esi_version v1
55
+ #
56
+ # @param item_id [Integer,String] item_id integer
57
+ # @param type_id [Integer,String] type_id integer
58
+ # @param params [Hash] Additional query string parameters
59
+ # @param headers [Hash] Additional headers
60
+ #
61
+ # @raise [ESI::Errors::BadRequestError] Bad request
62
+ # @raise [ESI::Errors::NotFoundError] Item not found
63
+ # @raise [ESI::Errors::ErrorLimitedError] Error limited
64
+ # @raise [ESI::Errors::InternalServerError] Internal server error
65
+ # @raise [ESI::Errors::ServiceUnavailableError] Service unavailable
66
+ # @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout
67
+ #
68
+ # @see https://esi.evetech.net/ui/#/Dogma/get_dogma_dynamic_items_type_id_item_id
69
+ def get_dogma_dynamic_items_type_item(item_id:, type_id:, params: {}, headers: {})
70
+ get("/dogma/dynamic/items/#{type_id}/#{item_id}/", headers: headers, params: params)
71
+ end
72
+ alias get_dogma_dynamic_items_type_id_item_id get_dogma_dynamic_items_type_item
73
+
74
+ # Get information on a dogma effect.
75
+ #
76
+ # @esi_version dev
77
+ # @esi_version v2
78
+ #
79
+ # @param effect_id [Integer,String] A dogma effect 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::NotFoundError] Dogma effect not found
85
+ # @raise [ESI::Errors::ErrorLimitedError] Error limited
86
+ # @raise [ESI::Errors::InternalServerError] Internal server error
87
+ # @raise [ESI::Errors::ServiceUnavailableError] Service unavailable
88
+ # @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout
89
+ #
90
+ # @see https://esi.evetech.net/ui/#/Dogma/get_dogma_effects_effect_id
91
+ def get_dogma_effect(effect_id:, params: {}, headers: {})
92
+ get("/dogma/effects/#{effect_id}/", headers: headers, params: params)
93
+ end
94
+ alias get_dogma_effects_effect_id get_dogma_effect
95
+
96
+ # Get a list of dogma effect ids.
97
+ #
98
+ # @esi_version dev
99
+ # @esi_version legacy
100
+ # @esi_version v1
101
+ #
102
+ # @param params [Hash] Additional query string parameters
103
+ # @param headers [Hash] Additional headers
104
+ #
105
+ # @raise [ESI::Errors::BadRequestError] Bad request
106
+ # @raise [ESI::Errors::ErrorLimitedError] Error limited
107
+ # @raise [ESI::Errors::InternalServerError] Internal server error
108
+ # @raise [ESI::Errors::ServiceUnavailableError] Service unavailable
109
+ # @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout
110
+ #
111
+ # @see https://esi.evetech.net/ui/#/Dogma/get_dogma_effects
112
+ def get_dogma_effects(params: {}, headers: {})
113
+ get("/dogma/effects/", headers: headers, params: params)
114
+ end
115
+ end
116
+ end
117
+ end
@@ -0,0 +1,196 @@
1
+ # frozen_string_literal: true
2
+
3
+ module ESI
4
+ class Client
5
+ # ESI faction warfare operations.
6
+ module FactionWarfare
7
+ # Statistical overview of a character involved in faction warfare.
8
+ #
9
+ # This endpoint requires authorization (see {ESI::Client#authorize}).
10
+ #
11
+ # @esi_scope esi-characters.read_fw_stats.v1
12
+ #
13
+ # @esi_version dev
14
+ # @esi_version legacy
15
+ # @esi_version v1
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/#/Faction Warfare/get_characters_character_id_fw_stats
31
+ def get_character_fw_stats(character_id:, params: {}, headers: {})
32
+ get("/characters/#{character_id}/fw/stats/", headers: headers, params: params)
33
+ end
34
+ alias get_characters_character_id_fw_stats get_character_fw_stats
35
+
36
+ # Statistics about a corporation involved in faction warfare.
37
+ #
38
+ # This endpoint requires authorization (see {ESI::Client#authorize}).
39
+ #
40
+ # @esi_scope esi-corporations.read_fw_stats.v1
41
+ #
42
+ # @esi_version dev
43
+ # @esi_version legacy
44
+ # @esi_version v1
45
+ # @esi_version v2
46
+ #
47
+ # @param corporation_id [Integer,String] An EVE corporation 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/#/Faction Warfare/get_corporations_corporation_id_fw_stats
60
+ def get_corporation_fw_stats(corporation_id:, params: {}, headers: {})
61
+ get("/corporations/#{corporation_id}/fw/stats/", headers: headers, params: params)
62
+ end
63
+ alias get_corporations_corporation_id_fw_stats get_corporation_fw_stats
64
+
65
+ # Top 100 leaderboard of pilots for kills and victory points separated by total, last week and yesterday.
66
+ #
67
+ # @esi_version dev
68
+ # @esi_version legacy
69
+ # @esi_version v1
70
+ # @esi_version v2
71
+ #
72
+ # @param params [Hash] Additional query string parameters
73
+ # @param headers [Hash] Additional headers
74
+ #
75
+ # @raise [ESI::Errors::BadRequestError] Bad request
76
+ # @raise [ESI::Errors::ErrorLimitedError] Error limited
77
+ # @raise [ESI::Errors::InternalServerError] Internal server error
78
+ # @raise [ESI::Errors::ServiceUnavailableError] Service unavailable
79
+ # @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout
80
+ #
81
+ # @see https://esi.evetech.net/ui/#/Faction Warfare/get_fw_leaderboards_characters
82
+ def get_fw_leaderboard_characters(params: {}, headers: {})
83
+ get("/fw/leaderboards/characters/", headers: headers, params: params)
84
+ end
85
+ alias get_fw_leaderboards_characters get_fw_leaderboard_characters
86
+
87
+ # Top 10 leaderboard of corporations for kills and victory points separated by total, last week and yesterday.
88
+ #
89
+ # @esi_version dev
90
+ # @esi_version legacy
91
+ # @esi_version v1
92
+ # @esi_version v2
93
+ #
94
+ # @param params [Hash] Additional query string parameters
95
+ # @param headers [Hash] Additional headers
96
+ #
97
+ # @raise [ESI::Errors::BadRequestError] Bad request
98
+ # @raise [ESI::Errors::ErrorLimitedError] Error limited
99
+ # @raise [ESI::Errors::InternalServerError] Internal server error
100
+ # @raise [ESI::Errors::ServiceUnavailableError] Service unavailable
101
+ # @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout
102
+ #
103
+ # @see https://esi.evetech.net/ui/#/Faction Warfare/get_fw_leaderboards_corporations
104
+ def get_fw_leaderboard_corporations(params: {}, headers: {})
105
+ get("/fw/leaderboards/corporations/", headers: headers, params: params)
106
+ end
107
+ alias get_fw_leaderboards_corporations get_fw_leaderboard_corporations
108
+
109
+ # Top 4 leaderboard of factions for kills and victory points separated by total, last week and yesterday.
110
+ #
111
+ # @esi_version dev
112
+ # @esi_version legacy
113
+ # @esi_version v1
114
+ # @esi_version v2
115
+ #
116
+ # @param params [Hash] Additional query string parameters
117
+ # @param headers [Hash] Additional headers
118
+ #
119
+ # @raise [ESI::Errors::BadRequestError] Bad request
120
+ # @raise [ESI::Errors::ErrorLimitedError] Error limited
121
+ # @raise [ESI::Errors::InternalServerError] Internal server error
122
+ # @raise [ESI::Errors::ServiceUnavailableError] Service unavailable
123
+ # @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout
124
+ #
125
+ # @see https://esi.evetech.net/ui/#/Faction Warfare/get_fw_leaderboards
126
+ def get_fw_leaderboards(params: {}, headers: {})
127
+ get("/fw/leaderboards/", headers: headers, params: params)
128
+ end
129
+
130
+ # Statistical overviews of factions involved in faction warfare.
131
+ #
132
+ # @esi_version dev
133
+ # @esi_version legacy
134
+ # @esi_version v1
135
+ # @esi_version v2
136
+ #
137
+ # @param params [Hash] Additional query string parameters
138
+ # @param headers [Hash] Additional headers
139
+ #
140
+ # @raise [ESI::Errors::BadRequestError] Bad request
141
+ # @raise [ESI::Errors::ErrorLimitedError] Error limited
142
+ # @raise [ESI::Errors::InternalServerError] Internal server error
143
+ # @raise [ESI::Errors::ServiceUnavailableError] Service unavailable
144
+ # @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout
145
+ #
146
+ # @see https://esi.evetech.net/ui/#/Faction Warfare/get_fw_stats
147
+ def get_fw_stats(params: {}, headers: {})
148
+ get("/fw/stats/", headers: headers, params: params)
149
+ end
150
+
151
+ # An overview of the current ownership of faction warfare solar systems.
152
+ #
153
+ # This endpoint is cached for up to 1800 seconds.
154
+ #
155
+ # @esi_version dev
156
+ # @esi_version legacy
157
+ # @esi_version v2
158
+ # @esi_version v3
159
+ #
160
+ # @param params [Hash] Additional query string parameters
161
+ # @param headers [Hash] Additional headers
162
+ #
163
+ # @raise [ESI::Errors::BadRequestError] Bad request
164
+ # @raise [ESI::Errors::ErrorLimitedError] Error limited
165
+ # @raise [ESI::Errors::InternalServerError] Internal server error
166
+ # @raise [ESI::Errors::ServiceUnavailableError] Service unavailable
167
+ # @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout
168
+ #
169
+ # @see https://esi.evetech.net/ui/#/Faction Warfare/get_fw_systems
170
+ def get_fw_systems(params: {}, headers: {})
171
+ get("/fw/systems/", headers: headers, params: params)
172
+ end
173
+
174
+ # Data about which NPC factions are at war.
175
+ #
176
+ # @esi_version dev
177
+ # @esi_version legacy
178
+ # @esi_version v1
179
+ # @esi_version v2
180
+ #
181
+ # @param params [Hash] Additional query string parameters
182
+ # @param headers [Hash] Additional headers
183
+ #
184
+ # @raise [ESI::Errors::BadRequestError] Bad request
185
+ # @raise [ESI::Errors::ErrorLimitedError] Error limited
186
+ # @raise [ESI::Errors::InternalServerError] Internal server error
187
+ # @raise [ESI::Errors::ServiceUnavailableError] Service unavailable
188
+ # @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout
189
+ #
190
+ # @see https://esi.evetech.net/ui/#/Faction Warfare/get_fw_wars
191
+ def get_fw_wars(params: {}, headers: {})
192
+ get("/fw/wars/", headers: headers, params: params)
193
+ end
194
+ end
195
+ end
196
+ end
@@ -0,0 +1,93 @@
1
+ # frozen_string_literal: true
2
+
3
+ module ESI
4
+ class Client
5
+ # ESI fittings operations.
6
+ module Fitting
7
+ # Delete a fitting from a character.
8
+ #
9
+ # This endpoint requires authorization (see {ESI::Client#authorize}).
10
+ #
11
+ # @esi_scope esi-fittings.write_fittings.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 fitting_id [Integer,String] ID for a fitting of this character
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/#/Fittings/delete_characters_character_id_fittings_fitting_id
31
+ def delete_character_fitting(character_id:, fitting_id:, params: {}, headers: {})
32
+ delete("/characters/#{character_id}/fittings/#{fitting_id}/", headers: headers, params: params)
33
+ end
34
+ alias delete_characters_character_id_fittings_fitting_id delete_character_fitting
35
+
36
+ # Return fittings of a character.
37
+ #
38
+ # This endpoint is cached for up to 300 seconds.
39
+ #
40
+ # This endpoint requires authorization (see {ESI::Client#authorize}).
41
+ #
42
+ # @esi_scope esi-fittings.read_fittings.v1
43
+ #
44
+ # @esi_version dev
45
+ # @esi_version v2
46
+ #
47
+ # @param character_id [Integer,String] An EVE character 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/#/Fittings/get_characters_character_id_fittings
60
+ def get_character_fittings(character_id:, params: {}, headers: {})
61
+ get("/characters/#{character_id}/fittings/", headers: headers, params: params)
62
+ end
63
+ alias get_characters_character_id_fittings get_character_fittings
64
+
65
+ # Save a new fitting for a character.
66
+ #
67
+ # This endpoint requires authorization (see {ESI::Client#authorize}).
68
+ #
69
+ # @esi_scope esi-fittings.write_fittings.v1
70
+ #
71
+ # @esi_version dev
72
+ # @esi_version v2
73
+ #
74
+ # @param character_id [Integer,String] An EVE character ID
75
+ # @param fitting [Hash] Details about the new fitting
76
+ # @param headers [Hash] Additional headers
77
+ #
78
+ # @raise [ESI::Errors::BadRequestError] Bad request
79
+ # @raise [ESI::Errors::UnauthorizedError] Unauthorized
80
+ # @raise [ESI::Errors::ForbiddenError] Forbidden
81
+ # @raise [ESI::Errors::ErrorLimitedError] Error limited
82
+ # @raise [ESI::Errors::InternalServerError] Internal server error
83
+ # @raise [ESI::Errors::ServiceUnavailableError] Service unavailable
84
+ # @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout
85
+ #
86
+ # @see https://esi.evetech.net/ui/#/Fittings/post_characters_character_id_fittings
87
+ def post_character_fittings(character_id:, fitting:, headers: {})
88
+ post("/characters/#{character_id}/fittings/", headers: headers, payload: fitting)
89
+ end
90
+ alias post_characters_character_id_fittings post_character_fittings
91
+ end
92
+ end
93
+ end