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
use serde::{Deserialize, Serialize};
use crate::{field_access, impl_default, impl_display};
/// Represents the details of a push device with the push account ID as the key.
///
/// Modified from `openapi-generator-cli` output:
///
/// ```shell,no_build,no_run
/// $ openapi-generator-cli generate -g rust -i ./zerver/openapi/zulip.yaml -o zulip-openapi --skip-validate-spec
/// ```
///
/// ```text
/// /*
/// * Zulip REST API
/// *
/// * Powerful open source group chat
/// *
/// * The version of the OpenAPI document: 1.0.0
/// *
/// * Generated by: https://openapi-generator.tech
/// */
/// ```
///
/// See [zerver/openapi/zulip.yaml](https://github.com/zulip/zulip/blob/main/zerver/openapi/zulip.yaml) for the original OpenAPI configuration.
///
/// Configuration slightly modified to work with the Rust generator of [`openapi-generator-cli`](https://openapi-generator.tech).
#[derive(Clone, Debug, PartialEq, Serialize, Deserialize)]
pub struct PushDevice {
#[serde(skip_serializing_if = "Option::is_none")]
status: Option<PushDeviceStatus>,
#[serde(skip_serializing_if = "Option::is_none")]
error_code: Option<String>,
}
impl PushDevice {
/// Creates a new [PushDevice].
pub fn new() -> Self {
Self {
status: None,
error_code: None,
}
}
}
field_access! {
PushDevice {
/// The push account's registration status.
status: option { PushDeviceStatus },
}
}
field_access! {
PushDevice {
/// If the status is `\"failed\"`, a [Zulip API error code](https://zulip.com/api/rest-error-handling) indicating the type of failure that occurred.
///
/// The following error codes have recommended client behavior:
///
/// - `\"INVALID_BOUNCER_PUBLIC_KEY\"`: Inform the user to update app.
/// - `\"REQUEST_EXPIRED`: Retry with a fresh payload.
error_code: option_cow_deref { str, String },
}
}
impl_default!(PushDevice);
impl_display!(PushDevice);
/// Represents the push account's registration status.
///
/// Either:
///
/// - `\"active\"`
/// - `\"pending\"`
/// - `\"failed\"`
#[derive(Clone, Copy, Debug, Eq, PartialEq, Deserialize, Serialize)]
#[serde(rename_all = "snake_case")]
pub enum PushDeviceStatus {
Active,
Pending,
Failed,
}
impl PushDeviceStatus {
/// Creates a new [PushDeviceStatus].
pub const fn new() -> Self {
Self::Active
}
}
impl_default!(PushDeviceStatus);
impl_display!(PushDeviceStatus);