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,104 @@
1
+ # frozen_string_literal: true
2
+
3
+ module ESI
4
+ class Client
5
+ # ESI alliance operations.
6
+ module Alliance
7
+ # Public information about an alliance.
8
+ #
9
+ # This endpoint is cached for up to 3600 seconds.
10
+ #
11
+ # @esi_version dev
12
+ # @esi_version legacy
13
+ # @esi_version v3
14
+ # @esi_version v4
15
+ #
16
+ # @param alliance_id [Integer,String] An EVE alliance ID
17
+ # @param params [Hash] Additional query string parameters
18
+ # @param headers [Hash] Additional headers
19
+ #
20
+ # @raise [ESI::Errors::BadRequestError] Bad request
21
+ # @raise [ESI::Errors::NotFoundError] Alliance not found
22
+ # @raise [ESI::Errors::ErrorLimitedError] Error limited
23
+ # @raise [ESI::Errors::InternalServerError] Internal server error
24
+ # @raise [ESI::Errors::ServiceUnavailableError] Service unavailable
25
+ # @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout
26
+ #
27
+ # @see https://esi.evetech.net/ui/#/Alliance/get_alliances_alliance_id
28
+ def get_alliance(alliance_id:, params: {}, headers: {})
29
+ get("/alliances/#{alliance_id}/", headers: headers, params: params)
30
+ end
31
+ alias get_alliances_alliance_id get_alliance
32
+
33
+ # List all current member corporations of an alliance.
34
+ #
35
+ # This endpoint is cached for up to 3600 seconds.
36
+ #
37
+ # @esi_version dev
38
+ # @esi_version legacy
39
+ # @esi_version v1
40
+ # @esi_version v2
41
+ #
42
+ # @param alliance_id [Integer,String] An EVE alliance ID
43
+ # @param params [Hash] Additional query string parameters
44
+ # @param headers [Hash] Additional headers
45
+ #
46
+ # @raise [ESI::Errors::BadRequestError] Bad request
47
+ # @raise [ESI::Errors::ErrorLimitedError] Error limited
48
+ # @raise [ESI::Errors::InternalServerError] Internal server error
49
+ # @raise [ESI::Errors::ServiceUnavailableError] Service unavailable
50
+ # @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout
51
+ #
52
+ # @see https://esi.evetech.net/ui/#/Alliance/get_alliances_alliance_id_corporations
53
+ def get_alliance_corporations(alliance_id:, params: {}, headers: {})
54
+ get("/alliances/#{alliance_id}/corporations/", headers: headers, params: params)
55
+ end
56
+ alias get_alliances_alliance_id_corporations get_alliance_corporations
57
+
58
+ # Get the icon urls for a alliance.
59
+ #
60
+ # @esi_version legacy
61
+ # @esi_version v1
62
+ #
63
+ # @param alliance_id [Integer,String] An EVE alliance ID
64
+ # @param params [Hash] Additional query string parameters
65
+ # @param headers [Hash] Additional headers
66
+ #
67
+ # @raise [ESI::Errors::BadRequestError] Bad request
68
+ # @raise [ESI::Errors::NotFoundError] No image server for this datasource
69
+ # @raise [ESI::Errors::ErrorLimitedError] Error limited
70
+ # @raise [ESI::Errors::InternalServerError] Internal server error
71
+ # @raise [ESI::Errors::ServiceUnavailableError] Service unavailable
72
+ # @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout
73
+ #
74
+ # @see https://esi.evetech.net/ui/#/Alliance/get_alliances_alliance_id_icons
75
+ def get_alliance_icons(alliance_id:, params: {}, headers: {})
76
+ get("/alliances/#{alliance_id}/icons/", headers: headers, params: params)
77
+ end
78
+ alias get_alliances_alliance_id_icons get_alliance_icons
79
+
80
+ # List all active player alliances.
81
+ #
82
+ # This endpoint is cached for up to 3600 seconds.
83
+ #
84
+ # @esi_version dev
85
+ # @esi_version legacy
86
+ # @esi_version v1
87
+ # @esi_version v2
88
+ #
89
+ # @param params [Hash] Additional query string parameters
90
+ # @param headers [Hash] Additional headers
91
+ #
92
+ # @raise [ESI::Errors::BadRequestError] Bad request
93
+ # @raise [ESI::Errors::ErrorLimitedError] Error limited
94
+ # @raise [ESI::Errors::InternalServerError] Internal server error
95
+ # @raise [ESI::Errors::ServiceUnavailableError] Service unavailable
96
+ # @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout
97
+ #
98
+ # @see https://esi.evetech.net/ui/#/Alliance/get_alliances
99
+ def get_alliances(params: {}, headers: {})
100
+ get("/alliances/", headers: headers, params: params)
101
+ end
102
+ end
103
+ end
104
+ end
@@ -0,0 +1,179 @@
1
+ # frozen_string_literal: true
2
+
3
+ module ESI
4
+ class Client
5
+ # ESI assets operations.
6
+ module Asset
7
+ # Return a list of the characters assets.
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-assets.read_assets.v1
14
+ #
15
+ # @esi_version dev
16
+ # @esi_version v5
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::NotFoundError] Requested page does not exist
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/#/Assets/get_characters_character_id_assets
32
+ def get_character_assets(character_id:, params: {}, headers: {})
33
+ get("/characters/#{character_id}/assets/", headers: headers, params: params)
34
+ end
35
+ alias get_characters_character_id_assets get_character_assets
36
+
37
+ # Return a list of the corporation assets.
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-assets.read_corporation_assets.v1
44
+ #
45
+ # @esi_version dev
46
+ # @esi_version v5
47
+ #
48
+ # @param corporation_id [Integer,String] An EVE corporation 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/#/Assets/get_corporations_corporation_id_assets
61
+ def get_corporation_assets(corporation_id:, params: {}, headers: {})
62
+ get("/corporations/#{corporation_id}/assets/", headers: headers, params: params)
63
+ end
64
+ alias get_corporations_corporation_id_assets get_corporation_assets
65
+
66
+ # Return locations for a set of item ids, which you can get from character assets endpoint. Coordinates for items in hangars or stations are set to (0,0,0).
67
+ #
68
+ # This endpoint requires authorization (see {ESI::Client#authorize}).
69
+ #
70
+ # @esi_scope esi-assets.read_assets.v1
71
+ #
72
+ # @esi_version dev
73
+ # @esi_version v2
74
+ #
75
+ # @param character_id [Integer,String] An EVE character ID
76
+ # @param item_ids [Array] A list of item ids
77
+ # @param headers [Hash] Additional headers
78
+ #
79
+ # @raise [ESI::Errors::BadRequestError] Bad request
80
+ # @raise [ESI::Errors::UnauthorizedError] Unauthorized
81
+ # @raise [ESI::Errors::ForbiddenError] Forbidden
82
+ # @raise [ESI::Errors::ErrorLimitedError] Error limited
83
+ # @raise [ESI::Errors::InternalServerError] Internal server error
84
+ # @raise [ESI::Errors::ServiceUnavailableError] Service unavailable
85
+ # @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout
86
+ #
87
+ # @see https://esi.evetech.net/ui/#/Assets/post_characters_character_id_assets_locations
88
+ def post_character_asset_locations(character_id:, item_ids:, headers: {})
89
+ post("/characters/#{character_id}/assets/locations/", headers: headers, payload: item_ids)
90
+ end
91
+ alias post_characters_character_id_assets_locations post_character_asset_locations
92
+
93
+ # Return names for a set of item ids, which you can get from character assets endpoint. Typically used for items that can customize names, like containers or ships.
94
+ #
95
+ # This endpoint requires authorization (see {ESI::Client#authorize}).
96
+ #
97
+ # @esi_scope esi-assets.read_assets.v1
98
+ #
99
+ # @esi_version dev
100
+ # @esi_version legacy
101
+ # @esi_version v1
102
+ #
103
+ # @param character_id [Integer,String] An EVE character ID
104
+ # @param item_ids [Array] A list of item ids
105
+ # @param headers [Hash] Additional headers
106
+ #
107
+ # @raise [ESI::Errors::BadRequestError] Bad request
108
+ # @raise [ESI::Errors::UnauthorizedError] Unauthorized
109
+ # @raise [ESI::Errors::ForbiddenError] Forbidden
110
+ # @raise [ESI::Errors::ErrorLimitedError] Error limited
111
+ # @raise [ESI::Errors::InternalServerError] Internal server error
112
+ # @raise [ESI::Errors::ServiceUnavailableError] Service unavailable
113
+ # @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout
114
+ #
115
+ # @see https://esi.evetech.net/ui/#/Assets/post_characters_character_id_assets_names
116
+ def post_character_asset_names(character_id:, item_ids:, headers: {})
117
+ post("/characters/#{character_id}/assets/names/", headers: headers, payload: item_ids)
118
+ end
119
+ alias post_characters_character_id_assets_names post_character_asset_names
120
+
121
+ # Return locations for a set of item ids, which you can get from corporation assets endpoint. Coordinates for items in hangars or stations are set to (0,0,0).
122
+ #
123
+ # This endpoint requires authorization (see {ESI::Client#authorize}).
124
+ #
125
+ # @esi_scope esi-assets.read_corporation_assets.v1
126
+ #
127
+ # @esi_version dev
128
+ # @esi_version v2
129
+ #
130
+ # @param corporation_id [Integer,String] An EVE corporation ID
131
+ # @param item_ids [Array] A list of item ids
132
+ # @param headers [Hash] Additional headers
133
+ #
134
+ # @raise [ESI::Errors::BadRequestError] Bad request
135
+ # @raise [ESI::Errors::UnauthorizedError] Unauthorized
136
+ # @raise [ESI::Errors::ForbiddenError] Forbidden
137
+ # @raise [ESI::Errors::NotFoundError] Invalid IDs
138
+ # @raise [ESI::Errors::ErrorLimitedError] Error limited
139
+ # @raise [ESI::Errors::InternalServerError] Internal server error
140
+ # @raise [ESI::Errors::ServiceUnavailableError] Service unavailable
141
+ # @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout
142
+ #
143
+ # @see https://esi.evetech.net/ui/#/Assets/post_corporations_corporation_id_assets_locations
144
+ def post_corporation_asset_locations(corporation_id:, item_ids:, headers: {})
145
+ post("/corporations/#{corporation_id}/assets/locations/", headers: headers, payload: item_ids)
146
+ end
147
+ alias post_corporations_corporation_id_assets_locations post_corporation_asset_locations
148
+
149
+ # Return names for a set of item ids, which you can get from corporation assets endpoint. Only valid for items that can customize names, like containers or ships.
150
+ #
151
+ # This endpoint requires authorization (see {ESI::Client#authorize}).
152
+ #
153
+ # @esi_scope esi-assets.read_corporation_assets.v1
154
+ #
155
+ # @esi_version dev
156
+ # @esi_version legacy
157
+ # @esi_version v1
158
+ #
159
+ # @param corporation_id [Integer,String] An EVE corporation ID
160
+ # @param item_ids [Array] A list of item ids
161
+ # @param headers [Hash] Additional headers
162
+ #
163
+ # @raise [ESI::Errors::BadRequestError] Bad request
164
+ # @raise [ESI::Errors::UnauthorizedError] Unauthorized
165
+ # @raise [ESI::Errors::ForbiddenError] Forbidden
166
+ # @raise [ESI::Errors::NotFoundError] Invalid IDs
167
+ # @raise [ESI::Errors::ErrorLimitedError] Error limited
168
+ # @raise [ESI::Errors::InternalServerError] Internal server error
169
+ # @raise [ESI::Errors::ServiceUnavailableError] Service unavailable
170
+ # @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout
171
+ #
172
+ # @see https://esi.evetech.net/ui/#/Assets/post_corporations_corporation_id_assets_names
173
+ def post_corporation_asset_names(corporation_id:, item_ids:, headers: {})
174
+ post("/corporations/#{corporation_id}/assets/names/", headers: headers, payload: item_ids)
175
+ end
176
+ alias post_corporations_corporation_id_assets_names post_corporation_asset_names
177
+ end
178
+ end
179
+ end
@@ -0,0 +1,126 @@
1
+ # frozen_string_literal: true
2
+
3
+ module ESI
4
+ class Client
5
+ # ESI bookmarks operations.
6
+ module Bookmark
7
+ # A list of your character's personal bookmark folders.
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-bookmarks.read_character_bookmarks.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/#/Bookmarks/get_characters_character_id_bookmarks_folders
31
+ def get_character_bookmark_folders(character_id:, params: {}, headers: {})
32
+ get("/characters/#{character_id}/bookmarks/folders/", headers: headers, params: params)
33
+ end
34
+ alias get_characters_character_id_bookmarks_folders get_character_bookmark_folders
35
+
36
+ # A list of your character's personal bookmarks.
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-bookmarks.read_character_bookmarks.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/#/Bookmarks/get_characters_character_id_bookmarks
60
+ def get_character_bookmarks(character_id:, params: {}, headers: {})
61
+ get("/characters/#{character_id}/bookmarks/", headers: headers, params: params)
62
+ end
63
+ alias get_characters_character_id_bookmarks get_character_bookmarks
64
+
65
+ # A list of your corporation's bookmark folders.
66
+ #
67
+ # This endpoint is cached for up to 3600 seconds.
68
+ #
69
+ # This endpoint requires authorization (see {ESI::Client#authorize}).
70
+ #
71
+ # @esi_scope esi-bookmarks.read_corporation_bookmarks.v1
72
+ #
73
+ # @esi_version dev
74
+ # @esi_version legacy
75
+ # @esi_version v1
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/#/Bookmarks/get_corporations_corporation_id_bookmarks_folders
90
+ def get_corporation_bookmark_folders(corporation_id:, params: {}, headers: {})
91
+ get("/corporations/#{corporation_id}/bookmarks/folders/", headers: headers, params: params)
92
+ end
93
+ alias get_corporations_corporation_id_bookmarks_folders get_corporation_bookmark_folders
94
+
95
+ # A list of your corporation's bookmarks.
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-bookmarks.read_corporation_bookmarks.v1
102
+ #
103
+ # @esi_version dev
104
+ # @esi_version legacy
105
+ # @esi_version v1
106
+ #
107
+ # @param corporation_id [Integer,String] An EVE corporation ID
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::UnauthorizedError] Unauthorized
113
+ # @raise [ESI::Errors::ForbiddenError] Forbidden
114
+ # @raise [ESI::Errors::ErrorLimitedError] Error limited
115
+ # @raise [ESI::Errors::InternalServerError] Internal server error
116
+ # @raise [ESI::Errors::ServiceUnavailableError] Service unavailable
117
+ # @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout
118
+ #
119
+ # @see https://esi.evetech.net/ui/#/Bookmarks/get_corporations_corporation_id_bookmarks
120
+ def get_corporation_bookmarks(corporation_id:, params: {}, headers: {})
121
+ get("/corporations/#{corporation_id}/bookmarks/", headers: headers, params: params)
122
+ end
123
+ alias get_corporations_corporation_id_bookmarks get_corporation_bookmarks
124
+ end
125
+ end
126
+ end
@@ -0,0 +1,139 @@
1
+ # frozen_string_literal: true
2
+
3
+ module ESI
4
+ class Client
5
+ # ESI calendar operations.
6
+ module Calendar
7
+ # Get 50 event summaries from the calendar. If no from_event ID is given, the resource will return the next 50 chronological event summaries from now. If a from_event ID is specified, it will return the next 50 chronological event summaries from after that event.
8
+ #
9
+ # This endpoint is cached for up to 5 seconds.
10
+ #
11
+ # This endpoint requires authorization (see {ESI::Client#authorize}).
12
+ #
13
+ # @esi_scope esi-calendar.read_calendar_events.v1
14
+ #
15
+ # @esi_version dev
16
+ # @esi_version legacy
17
+ # @esi_version v1
18
+ # @esi_version v2
19
+ #
20
+ # @param character_id [Integer,String] An EVE character ID
21
+ # @param from_event [Integer] The event ID to retrieve events from
22
+ # @param params [Hash] Additional query string parameters
23
+ # @param headers [Hash] Additional headers
24
+ #
25
+ # @raise [ESI::Errors::BadRequestError] Bad request
26
+ # @raise [ESI::Errors::UnauthorizedError] Unauthorized
27
+ # @raise [ESI::Errors::ForbiddenError] Forbidden
28
+ # @raise [ESI::Errors::ErrorLimitedError] Error limited
29
+ # @raise [ESI::Errors::InternalServerError] Internal server error
30
+ # @raise [ESI::Errors::ServiceUnavailableError] Service unavailable
31
+ # @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout
32
+ #
33
+ # @see https://esi.evetech.net/ui/#/Calendar/get_characters_character_id_calendar
34
+ def get_character_calendar(character_id:, from_event:, params: {}, headers: {})
35
+ query_string = URI.encode_www_form([["from_event", from_event]])
36
+ get("/characters/#{character_id}/calendar/?#{query_string}", headers: headers, params: params)
37
+ end
38
+ alias get_characters_character_id_calendar get_character_calendar
39
+
40
+ # Get all the information for a specific event.
41
+ #
42
+ # This endpoint is cached for up to 5 seconds.
43
+ #
44
+ # This endpoint requires authorization (see {ESI::Client#authorize}).
45
+ #
46
+ # @esi_scope esi-calendar.read_calendar_events.v1
47
+ #
48
+ # @esi_version dev
49
+ # @esi_version legacy
50
+ # @esi_version v3
51
+ # @esi_version v4
52
+ #
53
+ # @param character_id [Integer,String] An EVE character ID
54
+ # @param event_id [Integer,String] The id of the event requested
55
+ # @param params [Hash] Additional query string parameters
56
+ # @param headers [Hash] Additional headers
57
+ #
58
+ # @raise [ESI::Errors::BadRequestError] Bad request
59
+ # @raise [ESI::Errors::UnauthorizedError] Unauthorized
60
+ # @raise [ESI::Errors::ForbiddenError] Forbidden
61
+ # @raise [ESI::Errors::NotFoundError] Not found
62
+ # @raise [ESI::Errors::ErrorLimitedError] Error limited
63
+ # @raise [ESI::Errors::InternalServerError] Internal server error
64
+ # @raise [ESI::Errors::ServiceUnavailableError] Service unavailable
65
+ # @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout
66
+ #
67
+ # @see https://esi.evetech.net/ui/#/Calendar/get_characters_character_id_calendar_event_id
68
+ def get_character_calendar_event(character_id:, event_id:, params: {}, headers: {})
69
+ get("/characters/#{character_id}/calendar/#{event_id}/", headers: headers, params: params)
70
+ end
71
+ alias get_characters_character_id_calendar_event_id get_character_calendar_event
72
+
73
+ # Get all invited attendees for a given event.
74
+ #
75
+ # This endpoint is cached for up to 600 seconds.
76
+ #
77
+ # This endpoint requires authorization (see {ESI::Client#authorize}).
78
+ #
79
+ # @esi_scope esi-calendar.read_calendar_events.v1
80
+ #
81
+ # @esi_version dev
82
+ # @esi_version legacy
83
+ # @esi_version v1
84
+ # @esi_version v2
85
+ #
86
+ # @param character_id [Integer,String] An EVE character ID
87
+ # @param event_id [Integer,String] The id of the event requested
88
+ # @param params [Hash] Additional query string parameters
89
+ # @param headers [Hash] Additional headers
90
+ #
91
+ # @raise [ESI::Errors::BadRequestError] Bad request
92
+ # @raise [ESI::Errors::UnauthorizedError] Unauthorized
93
+ # @raise [ESI::Errors::ForbiddenError] Forbidden
94
+ # @raise [ESI::Errors::NotFoundError] Not found
95
+ # @raise [ESI::Errors::ErrorLimitedError] Error limited
96
+ # @raise [ESI::Errors::InternalServerError] Internal server error
97
+ # @raise [ESI::Errors::ServiceUnavailableError] Service unavailable
98
+ # @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout
99
+ #
100
+ # @see https://esi.evetech.net/ui/#/Calendar/get_characters_character_id_calendar_event_id_attendees
101
+ def get_character_calendar_event_attendees(character_id:, event_id:, params: {}, headers: {})
102
+ get("/characters/#{character_id}/calendar/#{event_id}/attendees/", headers: headers, params: params)
103
+ end
104
+ alias get_characters_character_id_calendar_event_id_attendees get_character_calendar_event_attendees
105
+
106
+ # Set your response status to an event.
107
+ #
108
+ # This endpoint is cached for up to 5 seconds.
109
+ #
110
+ # This endpoint requires authorization (see {ESI::Client#authorize}).
111
+ #
112
+ # @esi_scope esi-calendar.respond_calendar_events.v1
113
+ #
114
+ # @esi_version dev
115
+ # @esi_version legacy
116
+ # @esi_version v3
117
+ # @esi_version v4
118
+ #
119
+ # @param character_id [Integer,String] An EVE character ID
120
+ # @param event_id [Integer,String] The ID of the event requested
121
+ # @param response [Hash] The response value to set, overriding current value
122
+ # @param headers [Hash] Additional headers
123
+ #
124
+ # @raise [ESI::Errors::BadRequestError] Bad request
125
+ # @raise [ESI::Errors::UnauthorizedError] Unauthorized
126
+ # @raise [ESI::Errors::ForbiddenError] Forbidden
127
+ # @raise [ESI::Errors::ErrorLimitedError] Error limited
128
+ # @raise [ESI::Errors::InternalServerError] Internal server error
129
+ # @raise [ESI::Errors::ServiceUnavailableError] Service unavailable
130
+ # @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout
131
+ #
132
+ # @see https://esi.evetech.net/ui/#/Calendar/put_characters_character_id_calendar_event_id
133
+ def put_character_calendar_event(character_id:, event_id:, response:, headers: {})
134
+ put("/characters/#{character_id}/calendar/#{event_id}/", headers: headers, payload: response)
135
+ end
136
+ alias put_characters_character_id_calendar_event_id put_character_calendar_event
137
+ end
138
+ end
139
+ end