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

//! # EVE ESI Clones Endpoints
//!
//! This module provides the [`ClonesEndpoints`] struct and associated methods for accessing
//! clone-related ESI endpoints.
//!
//! For an overview & usage examples, see the [endpoints module documentation](super)
//!
//! ## ESI Documentation
//! - <https://developers.eveonline.com/api-explorer>
//!
//! ## Endpoints (2)
//!
//! ### Authenticated (2)
//!
//! | Endpoint                                 | Description                                                                   |
//! | ---------------------------------------- | ----------------------------------------------------------------------------- |
//! | [`ClonesEndpoints::get_clones`]          | Get list of clones for the provided character ID                              |
//! | [`ClonesEndpoints::get_active_implants`] | Get list of type IDs of implants for the provided character ID's active clone |

use crate::{model::clones::CharacterClones, scope::ClonesScopes, Client, Error, ScopeBuilder};

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

impl<'a> ClonesEndpoints<'a> {
    /// Creates a new instance of [`ClonesEndpoints`].
    ///
    /// # 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 list of clones 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/GetCharactersCharacterIdClones>
        ///
        /// # Required Scopes
        /// - [`ClonesScopes::read_clones`](crate::scope::ClonesScopes::read_clones):
        ///   `esi-assets.read_clones.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 clones for
        ///
        /// # Returns
        /// Returns a [`Result`] containing either:
        /// - [`CharacterClones`]: list of clones for the provided character ID
        /// - [`Error`]: An error if the fetch request fails
        auth_get get_clones(
            access_token: &str,
            character_id: i64
        ) -> Result<CharacterClones, Error>
        url = "{}/characters/{}/clones";
        label = "clones";
        required_scopes = ScopeBuilder::new()
            .clones(ClonesScopes::new().read_clones())
            .build();
    }

    define_endpoint! {
        /// Get list of type IDs of implants for the provided character ID's active clone
        ///
        /// For an overview & usage examples, see the [endpoints module documentation](super)
        ///
        /// # ESI Documentation
        /// - <https://developers.eveonline.com/api-explorer#/operations/GetCharactersCharacterIdImplants>
        ///
        /// # Required Scopes
        /// - [`ClonesScopes::read_implants`](crate::scope::ClonesScopes::read_implants):
        ///   `esi-clones.read_implants.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 implants for
        ///
        /// # Returns
        /// Returns a [`Result`] containing either:
        /// - `Vec<`[`i64`]`>`: List of type IDs of implants for the provided character ID's active clone
        /// - [`Error`]: An error if the fetch request fails
        auth_get get_active_implants(
            access_token: &str,
            character_id: i64
        ) -> Result<Vec<i64>, Error>
        url = "{}/characters/{}/implants";
        label = "implants for active clone";
        required_scopes = ScopeBuilder::new()
            .clones(ClonesScopes::new().read_implants())
            .build();
    }
}