Skip to main content

spatio_sdk/models/
password_required_error.rs

1/*
2 * SpatioAPI
3 *
4 * The REST API that owns every resource in your Spatio workspace: notes, sheets, slides, tasks, calendar events, mail, chat, files, and contacts. SpatioMCP wraps this API; Spatio Desktop reads from it. You can call it directly from your own code.  All requests must be authenticated with a Personal Access Token (`Authorization: Bearer pat_...`) or an OAuth 2.1 access token, and use HTTPS.  Official SDKs (MIT, generated from this spec on every release):  - TypeScript: https://github.com/spatio-labs/spatio-ts (`npm install @spatio-labs/spatio-ts`) - Python: https://github.com/spatio-labs/spatio-py (`pip install spatio-sdk`) - Go: https://github.com/spatio-labs/spatio-go (`go get github.com/spatio-labs/spatio-go`)  This specification is generated from the platform-service Go source on every push to `main`. The spec, not hand-written documentation, is the source of truth: server stubs and SDKs are generated from it, and any drift between the spec and the running service fails CI. 
5 *
6 * The version of the OpenAPI document: v1
7 * Contact: hello@spatio.app
8 * Generated by: https://openapi-generator.tech
9 */
10
11use crate::models;
12use serde::{Deserialize, Serialize};
13
14/// PasswordRequiredError : Returned by `GET /public/notes/{token}` when the note is password-protected. `requiresPassword` is always `true` in this response; `invalidPassword` is `true` only when a password was supplied and rejected. 
15#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)]
16pub struct PasswordRequiredError {
17    /// Human-readable error message.
18    #[serde(rename = "error")]
19    pub error: String,
20    /// Machine-readable error code. Stable across releases for the canonical codes (`ambiguous_account`, `no_notes_provider`, `note_not_found`). Absent for generic errors. 
21    #[serde(rename = "code", skip_serializing_if = "Option::is_none")]
22    pub code: Option<String>,
23    #[serde(rename = "requiresPassword")]
24    pub requires_password: bool,
25    #[serde(rename = "invalidPassword", skip_serializing_if = "Option::is_none")]
26    pub invalid_password: Option<bool>,
27}
28
29impl PasswordRequiredError {
30    /// Returned by `GET /public/notes/{token}` when the note is password-protected. `requiresPassword` is always `true` in this response; `invalidPassword` is `true` only when a password was supplied and rejected. 
31    pub fn new(error: String, requires_password: bool) -> PasswordRequiredError {
32        PasswordRequiredError {
33            error,
34            code: None,
35            requires_password,
36            invalid_password: None,
37        }
38    }
39}
40