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

//! Implements the unlink provider API of the Firebase Auth.
//!
//! You can unlink a provider from 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-unlink-provider).

use std::collections::HashSet;

use serde::{Deserialize, Serialize};

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

/// Request body payload for the unlink provider API.
///
/// See also [API reference](https://firebase.google.com/docs/reference/rest/auth#section-unlink-provider).
#[derive(Serialize)]
pub struct UnlinkProviderRequestBodyPayload {
    /// The Firebase ID token of the account.
    #[serde(rename = "idToken")]
    id_token: String,
    /// The list of provider IDs to unlink, eg: 'google.com', 'password', etc.
    #[serde(rename = "deleteProvider")]
    delete_provider: Vec<String>,
}

impl UnlinkProviderRequestBodyPayload {
    /// Creates a new request body payload for the unlink provider API.
    ///
    /// See also [API reference](https://firebase.google.com/docs/reference/rest/auth#section-unlink-provider).
    ///
    /// ## Arguments
    /// - `id_token` - The Firebase ID token of the account.
    /// - `delete_provider` - The list of provider IDs to unlink, eg: 'google.com', 'password', etc.
    pub fn new(
        id_token: String,
        delete_provider: HashSet<ProviderId>,
    ) -> Self {
        Self {
            id_token,
            delete_provider: delete_provider
                .into_iter()
                .map(|provider_id| provider_id.format())
                .collect(),
        }
    }
}

/// Response payload for the unlink provider API.
///
/// See also [API reference](https://firebase.google.com/docs/reference/rest/auth#section-unlink-provider).
#[derive(Deserialize, Debug)]
pub struct UnlinkProviderResponsePayload {
    /// The uid of the current user.
    #[serde(rename = "localId")]
    pub local_id: String,
    /// The email of the account.
    #[serde(rename = "email")]
    pub email: Option<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 the password.
    #[serde(rename = "passwordHash")]
    pub password_hash: Option<String>,
    /// List of all linked provider objects which contain "providerId" and "federatedId".
    #[serde(rename = "providerUserInfo")]
    pub provider_user_info: Option<Vec<ProviderUserInfo>>,
    /// Whether or not the account's email has been verified.
    #[serde(rename = "emailVerified")]
    pub email_verified: bool,
}

/// Unlinks a provider from a user account.
///
/// See also [API reference](https://firebase.google.com/docs/reference/rest/auth#section-unlink-provider).
///
/// ## 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
/// - INVALID_ID_TOKEN: The user's credential is no longer valid. The user must sign in again.
///
/// ## Example
/// ```
/// use fars::api;
/// use fars::ProviderId;
/// use fars::Client;
/// use fars::ApiKey;
///
/// let request_payload = api::UnlinkProviderRequestBodyPayload::new(
///     "id-token".to_string(),
///     [ProviderId::Google].iter().cloned().collect(),
/// );
///
/// let response_payload = api::unlink_provider(
///     Client::new(),
///     ApiKey::new("your-firebase-project-api-key"),
///     request_payload,
/// ).await?;
/// ```
pub async fn unlink_provider(
    client: &Client,
    api_key: &ApiKey,
    request_payload: UnlinkProviderRequestBodyPayload,
) -> Result<UnlinkProviderResponsePayload> {
    client.send_post::<
        UnlinkProviderRequestBodyPayload,
        UnlinkProviderResponsePayload,
    >(
        Endpoint::Update,
        api_key,
        request_payload,
        None,
    )
    .await
}