eve_esi 0.4.9

Thread-safe, asynchronous client for EVE Online's ESI & OAuth2
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257

//! # EVE ESI Assets Endpoints
//!
//! This module provides the [`AssetsEndpoints`] struct and associated methods for accessing
//! asset-related ESI endpoints.
//!
//! For an overview & usage examples, see the [endpoints module documentation](super)
//!
//! ## ESI Documentation
//! - <https://developers.eveonline.com/api-explorer>
//!
//! ## Endpoints (6)
//!
//! ### Authenticated (6)
//!
//! | Endpoint                                             | Description                                                                                       |
//! | ---------------------------------------------------- | ------------------------------------------------------------------------------------------------- |
//! | [`AssetsEndpoints::get_character_assets`]            | Get paginated list of assets for the provided character's ID                                      |
//! | [`AssetsEndpoints::get_character_asset_locations`]   | Get list of coordinates for items' location in space using item IDs & character's ID              |
//! | [`AssetsEndpoints::get_character_asset_names`]       | Get list of item names from list of item IDs & a character's ID                                   |
//! | [`AssetsEndpoints::get_corporation_assets`]          | Get paginated list of assets for the provided corporation ID                                      |
//! | [`AssetsEndpoints::get_corporation_asset_locations`] | Get list of coordinates for items' location in space using provided item IDs & a corporation's ID |
//! | [`AssetsEndpoints::get_corporation_asset_names`]     | Get list of item names from list of item IDs & a corporation's ID                                 |

use crate::{
    model::asset::{Asset, AssetLocation, AssetName},
    scope::AssetsScopes,
    Client, Error, ScopeBuilder,
};

/// Provides methods for accessing asset-related endpoints of the EVE Online ESI API.
///
/// For an overview & usage examples, see the [endpoints module documentation](super)
pub struct AssetsEndpoints<'a> {
    client: &'a Client,
}

impl<'a> AssetsEndpoints<'a> {
    /// Creates a new instance of [`AssetsEndpoints`].
    ///
    /// # Arguments
    /// - `client` (&[`Client`]): ESI client used for making HTTP requests to the ESI endpoints.
    pub(super) fn new(client: &'a Client) -> Self {
        Self { client }
    }

    define_endpoint! {
        /// Get paginated list of assets for the provided character ID
        ///
        /// For an overview & usage examples, see the [endpoints module documentation](super)
        ///
        /// # ESI Documentation
        /// - <https://developers.eveonline.com/api-explorer#/operations/GetCharactersCharacterIdAssets>
        ///
        /// # Required Scopes
        /// - [`AssetsScopes::read_assets`](crate::scope::AssetsScopes::read_assets):
        ///   `esi-assets.read_assets.v1`
        ///
        /// # Arguments
        /// - `access_token` (`&str`): Access token used for authenticated ESI routes in string format.
        /// - `character_id`  (`i64`): The ID of the character to retrieve assets for.
        /// - `page`          (`i32`): The page of assets to retrieve, page numbers start at `1`
        ///
        /// # Returns
        /// Returns a [`Result`] containing either:
        /// - `Vec<`[`Asset`]>`: Paginated list of assets for the provided character ID
        /// - [`Error`]: An error if the fetch request fails
        auth_get get_character_assets(
            access_token: &str,
            character_id: i64;
            page: i32
        ) -> Result<Vec<Asset>, Error>
        url = "{}/characters/{}/assets";
        label = "assets";
        required_scopes = ScopeBuilder::new()
            .assets(AssetsScopes::new().read_assets())
            .build();
    }

    define_endpoint! {
        /// Get list of coordinates for items' location in space using provided item IDs & a character's ID
        ///
        /// You can get the item IDs using the [`AssetsEndpoints::get_character_assets`] method
        ///
        /// For an overview & usage examples, see the [endpoints module documentation](super)
        ///
        /// # ESI Documentation
        /// - <https://developers.eveonline.com/api-explorer#/operations/PostCharactersCharacterIdAssetsLocations>
        ///
        /// # Required Scopes
        /// - [`AssetsScopes::read_assets`](crate::scope::AssetsScopes::read_assets):
        ///   `esi-assets.read_assets.v1`
        ///
        /// # Arguments
        /// - `access_token` (`&str`): Access token used for authenticated ESI routes in string format.
        /// - `item_ids`     (`Vec<i64>`): Vec of item IDs to get coordinates for (Limit of 1000 IDs per request)
        /// - `character_id` (`i64`): The ID of the character to retrieve asset locations for.
        ///
        /// # Returns
        /// Returns a [`Result`] containing either:
        /// - `Vec<`[`Asset`]`>`: List of structs containing coordinates for items' location in space
        /// - [`Error`]: An error if the fetch request fails
        auth_post get_character_asset_locations(
            access_token: &str,
            item_ids: Vec<i64>,
            character_id: i64
        ) -> Result<Vec<AssetLocation>, Error>
        url = "{}/characters/{}/assets/locations";
        label = "asset locations";
        required_scopes = ScopeBuilder::new()
            .assets(AssetsScopes::new().read_assets())
            .build();
    }

    define_endpoint! {
        /// Get list of item names from list of item IDs & a character's ID
        ///
        /// Useful for retrieving the names of items with customizable names such as ships or
        /// containers.
        ///
        /// You can get the item IDs using the [`AssetsEndpoints::get_character_assets`] method
        ///
        /// For an overview & usage examples, see the [endpoints module documentation](super)
        ///
        /// # ESI Documentation
        /// - <https://developers.eveonline.com/api-explorer#/operations/PostCharactersCharacterIdAssetsNames>
        ///
        /// # Required Scopes
        /// - [`AssetsScopes::read_assets`](crate::scope::AssetsScopes::read_assets):
        ///   `esi-assets.read_assets.v1`
        ///
        /// # Arguments
        /// - `access_token` (`&str`): Access token used for authenticated ESI routes in string format.
        /// - `item_ids`     (`Vec<i64>`): Vec of item IDs to get names for (Limit of 1000 IDs per request)
        /// - `character_id` (`i64`): The ID of the character to retrieve asset locations for.
        ///
        /// # Returns
        /// Returns a [`Result`] containing either:
        /// - `Vec<`[`AssetName`]`>`: List of item names from list of item IDs & a character's ID
        /// - [`Error`]: An error if the fetch request fails
        auth_post get_character_asset_names(
            access_token: &str,
            item_ids: Vec<i64>,
            character_id: i64
        ) -> Result<Vec<AssetName>, Error>
        url = "{}/characters/{}/assets/names";
        label = "asset names";
        required_scopes = ScopeBuilder::new()
            .assets(AssetsScopes::new().read_assets())
            .build();
    }

    define_endpoint! {
        /// Get paginated list of assets for the provided corporation ID
        ///
        /// For an overview & usage examples, see the [endpoints module documentation](super)
        ///
        /// # ESI Documentation
        /// - <https://developers.eveonline.com/api-explorer#/operations/GetCorporationsCorporationIdAssets>
        ///
        /// # Required Scopes
        /// - [`AssetsScopes::read_corporation_assets`](crate::scope::AssetsScopes::read_corporation_assets):
        ///   `esi-assets.read_corporation_assets.v1`
        ///
        /// # Arguments
        /// - `access_token`    (`&str`): Access token used for authenticated ESI routes in string format.
        /// - `corporation_id`  (`i64`): The ID of the corporation to retrieve assets for.
        /// - `page`            (`i32`): The page of assets to retrieve, page numbers start at `1`
        ///
        /// # Returns
        /// Returns a [`Result`] containing either:
        /// - `Vec<`[`Asset`]`>`: Paginated list of assets for the provided corporation's ID
        /// - [`Error`]: An error if the fetch request fails
        auth_get get_corporation_assets(
            access_token: &str,
            corporation_id: i64;
            page: i32
        ) -> Result<Vec<Asset>, Error>
        url = "{}/corporations/{}/assets";
        label = "assets";
        required_scopes = ScopeBuilder::new()
            .assets(AssetsScopes::new().read_corporation_assets())
            .build();
    }

    define_endpoint! {
        /// Get list of coordinates for items' location in space using provided item IDs & a corporation's ID
        ///
        /// You can get the item IDs using the [`AssetsEndpoints::get_corporation_assets`] method
        ///
        /// For an overview & usage examples, see the [endpoints module documentation](super)
        ///
        /// # ESI Documentation
        /// - <https://developers.eveonline.com/api-explorer#/operations/PostCorporationsCorporationIdAssetsLocations>
        ///
        /// # Required Scopes
        /// - [`AssetsScopes::read_corporation_assets`](crate::scope::AssetsScopes::read_corporation_assets):
        ///   `esi-assets.read_corporation_assets.v1`
        ///
        /// # Arguments
        /// - `access_token`   (`&str`): Access token used for authenticated ESI routes in string format.
        /// - `item_ids`       (`Vec<i64>`): Vec of item IDs to get coordinates for (Limit of 1000 IDs per request)
        /// - `corporation_id` (`i64`): The ID of the corporation to retrieve asset locations for.
        ///
        /// # Returns
        /// Returns a [`Result`] containing either:
        /// - `Vec<`[`Asset`]`>`: List of structs containing coordinates for items' location in space
        /// - [`Error`]: An error if the fetch request fails
        auth_post get_corporation_asset_locations(
            access_token: &str,
            item_ids: Vec<i64>,
            corporation_id: i64
        ) -> Result<Vec<AssetLocation>, Error>
        url = "{}/corporations/{}/assets/locations";
        label = "asset locations";
        required_scopes = ScopeBuilder::new()
            .assets(AssetsScopes::new().read_corporation_assets())
            .build();
    }

    define_endpoint! {
        /// Get list of item names from list of item IDs & a corporation's ID
        ///
        /// Useful for retrieving the names of items with customizable names such as ships or
        /// containers.
        ///
        /// You can get the item IDs using the [`AssetsEndpoints::get_character_assets`] method
        ///
        /// For an overview & usage examples, see the [endpoints module documentation](super)
        ///
        /// # ESI Documentation
        /// - <https://developers.eveonline.com/api-explorer#/operations/PostCorporationsCorporationIdAssetsNames>
        ///
        /// # Required Scopes
        /// - [`AssetsScopes::read_corporation_assets`](crate::scope::AssetsScopes::read_corporation_assets):
        ///   `esi-assets.read_corporation_assets.v1`
        ///
        /// # Arguments
        /// - `access_token`   (`&str`): Access token used for authenticated ESI routes in string format.
        /// - `item_ids`       (`Vec<i64>`): Vec of item IDs to get names for (Limit of 1000 IDs per request)
        /// - `corporation_id` (`i64`): The ID of the corporation to retrieve asset locations for.
        ///
        /// # Returns
        /// Returns a [`Result`] containing either:
        /// - `Vec<`[`AssetName`]`>`: List of item names from list of item IDs & a corporation's ID
        /// - [`Error`]: An error if the fetch request fails
        auth_post get_corporation_asset_names(
            access_token: &str,
            item_ids: Vec<i64>,
            corporation_id: i64
        ) -> Result<Vec<AssetName>, Error>
        url = "{}/corporations/{}/assets/names";
        label = "asset names";
        required_scopes = ScopeBuilder::new()
            .assets(AssetsScopes::new().read_corporation_assets())
            .build();
    }
}