fars 0.2.0

An unofficial Rust client for the Firebase Auth REST API.
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

//! Implements the link with email password API of the Firebase Auth.
//!
//! You can link an email/password to a current user by issuing an HTTP POST request to the Auth setAccountInfo endpoint.
//!
//! See also [API reference](https://firebase.google.com/docs/reference/rest/auth#section-link-with-email-password).

use serde::{Deserialize, Serialize};

use crate::ApiKey;
use crate::Client;
use crate::Endpoint;
use crate::ProviderUserInfo;
use crate::Result;

/// Request body payload for the link with email password API.
///
/// See also [API reference](https://firebase.google.com/docs/reference/rest/auth#section-link-with-email-password).
#[derive(Serialize)]
pub struct LinkWithEmailPasswordRequestBodyPayload {
    /// The Firebase ID token of the account you are trying to link the credential to.
    #[serde(rename = "idToken")]
    id_token: String,
    /// The email to link to the account.
    #[serde(rename = "email")]
    email: String,
    /// The new password of the account.
    #[serde(rename = "password")]
    password: String,
    /// Whether or not to return an ID and refresh token. Should always be true.
    #[serde(rename = "returnSecureToken")]
    return_secure_token: bool,
}

impl LinkWithEmailPasswordRequestBodyPayload {
    /// Creates a new request body payload for the link with email password API.
    ///
    /// See also [API reference](https://firebase.google.com/docs/reference/rest/auth#section-link-with-email-password).
    ///
    /// ## Arguments
    /// - `id_token` - The Firebase ID token of the account you are trying to link the credential to.
    /// - `email` - The email to link to the account.
    /// - `password` - The new password of the account.
    pub fn new(
        id_token: String,
        email: String,
        password: String,
    ) -> Self {
        Self {
            id_token,
            email,
            password,
            return_secure_token: true,
        }
    }
}

/// Response payload for the link with email password API.
///
/// See also [API reference](https://firebase.google.com/docs/reference/rest/auth#section-link-with-email-password).
#[derive(Deserialize, Debug)]
pub struct LinkWithEmailPasswordResponsePayload {
    /// The uid of the current user.
    #[serde(rename = "localId")]
    pub local_id: String,
    /// The email of the account.
    #[serde(rename = "email")]
    pub email: String,
    /// The display name for the account.
    #[serde(rename = "displayName")]
    pub display_name: Option<String>,
    /// The photo url for the account.
    #[serde(rename = "photoUrl")]
    pub photo_url: Option<String>,
    /// Hash version of password.
    #[serde(rename = "passwordHash")]
    pub password_hash: String,
    /// List of all linked provider objects which contain "providerId" and "federatedId".
    #[serde(rename = "providerUserInfo")]
    pub provider_user_info: Vec<ProviderUserInfo>,
    /// Whether or not the account's email has been verified.
    #[serde(rename = "emailVerified")]
    pub email_verified: bool,
    /// New Firebase Auth ID token for user.
    #[serde(rename = "idToken")]
    pub id_token: String,
    /// A Firebase Auth refresh token.
    #[serde(rename = "refreshToken")]
    pub refresh_token: String,
    /// The number of seconds in which the ID token expires.
    #[serde(rename = "expiresIn")]
    pub expires_in: String,
}

/// Links the user account with the given credentials.
///
/// See also [API reference](https://firebase.google.com/docs/reference/rest/auth#section-link-with-email-password).
///
/// ## Arguments
/// - `client` - HTTP client.
/// - `api_key` - Your Firebase project's API key.
/// - `request_payload` - Request body payload.
///
/// ## Errors
/// - `Error::HttpRequestError` - Failed to send a request.
/// - `Error::ReadResponseTextFailed` - Failed to read the response body as text.
/// - `Error::DeserializeResponseJsonFailed` - Failed to deserialize the response body as JSON.
/// - `Error::DeserializeErrorResponseJsonFailed` - Failed to deserialize the error response body as JSON.
/// - `Error::InvalidIdToken` - Invalid ID token.
/// - `Error::ApiError` - API error on the Firebase Auth.
///
/// ## Common error codes
/// - CREDENTIAL_TOO_OLD_LOGIN_AGAIN: The user's credential is no longer valid. The user must sign in again.
/// - TOKEN_EXPIRED: The user's credential is no longer valid. The user must sign in again.
/// - INVALID_ID_TOKEN:The user's credential is no longer valid. The user must sign in again.
/// - WEAK_PASSWORD: The password must be 6 characters long or more.
///
/// ## Example
/// ```
/// use fars::api;
/// use fars::Client;
/// use fars::ApiKey;
///
/// let request_payload = api::LinkWithEmailPasswordRequestBodyPayload::new(
///     "id-token".to_string(),
///     "email".to_string(),
///     "password".to_string(),
/// );
///
/// let response_payload = api::link_with_email_password(
///     Client::new(),
///     ApiKey::new("your-firebase-project-api-key"),
///     request_payload,
/// ).await?;
/// ```
pub async fn link_with_email_password(
    client: &Client,
    api_key: &ApiKey,
    request_payload: LinkWithEmailPasswordRequestBodyPayload,
) -> Result<LinkWithEmailPasswordResponsePayload> {
    client.send_post::<
        LinkWithEmailPasswordRequestBodyPayload,
        LinkWithEmailPasswordResponsePayload,
    >(
        Endpoint::Update,
        api_key,
        request_payload,
        None,
    )
    .await
}