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
use crate::auth::AuthType;
use crate::request::request_builder::NadeoRequestBuilder;
pub use reqwest::header::HeaderMap;
pub use reqwest::Response;
pub use reqwest::Url;
use serde::{Deserialize, Serialize};
pub mod request_builder;
/// Contains information about an API request. NadeoRequests can be executed on an instance of a [`NadeoClient`].
/// If you want to create a request use the [`NadeoRequestBuilder`] with `NadeoRequest::builder()`.
///
/// # Examples
///
/// Gets the clubtag of a player given the *accountID*.
/// ```rust
/// # use nadeo_api::auth::AuthType;
/// # use nadeo_api::request::{HttpMethod, NadeoRequest};
///
/// let mut client = //snap;
///
/// let request = NadeoRequest::builder()
/// .url("https://prod.trackmania.core.nadeo.online/accounts/clubTags/?accountIdList=29e75531-1a9d-4880-98da-e2acfe17c578".to_string())
/// .service(AuthType::NadeoServices)
/// .http_method(HttpMethod::Get)
/// .build()?;
///
/// let response = client.execute(request).await?;
/// ```
///
/// [`NadeoClient`]: crate::client::NadeoClient
/// [`NadeoRequestBuilder`]: NadeoRequestBuilder
#[derive(Debug, Clone)]
pub struct NadeoRequest {
pub(crate) service: AuthType,
pub(crate) url: String,
pub(crate) method: HttpMethod,
pub(crate) headers: HeaderMap,
}
impl NadeoRequest {
/// Creates a new NadeoRequestBuilder. This is the only way of creating a [NadeoRequest].
///
/// [`NadeoRequest`]: NadeoRequest
pub fn builder() -> NadeoRequestBuilder {
NadeoRequestBuilder::default()
}
}
/// The HTTP method used for the API request.
#[derive(Debug, Copy, Clone, Serialize, Deserialize)]
pub enum HttpMethod {
Get,
Post,
Put,
Patch,
Delete,
Head,
}