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
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166

use anyhow::Result;

use crate::Client;

pub struct PhoneAutoReceptionists {
    pub client: Client,
}

impl PhoneAutoReceptionists {
    #[doc(hidden)]
    pub fn new(client: Client) -> Self {
        PhoneAutoReceptionists { client }
    }

    /**
     * Update auto receptionist details.
     *
     * This function performs a `PATCH` to the `/phone/auto_receptionists/{autoReceptionistId}` endpoint.
     *
     * An auto receptionist answers calls with a personalized recording and routes calls to a phone user, call queue, common area phone, or voicemail. An auto receptionist can also be set up so that it routes calls to an interactive voice response (IVR) system to allow callers to select the routing options.<br>
     * Use this API to [change information](https://support.zoom.us/hc/en-us/articles/360021121312-Managing-Auto-Receptionists-and-Interactive-Voice-Response-IVR-#h_1d5ffc56-6ba3-4ce5-9d86-4a1a1ee743f3) such as display name and extension number assigned to the main auto receptionist.<br><br>
     * **Prerequisites:**<br>
     * * Pro or higher account with Zoom Phone license.<br>
     * **Scopes:** `phone:write:admin` <br>
     *
     *
     *  **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
     *
     * **Parameters:**
     *
     * * `auto_receptionist_id: &str` -- Unique Identifier of the Auto Receptionist. It can be retrieved from the [List Sites API](https://marketplace.zoom.us/docs/api-reference/zoom-api/phone-site/listphonesites).
     */
    pub async fn update_auto_receptionist(
        &self,
        auto_receptionist_id: &str,
        body: &crate::types::UpdateAutoReceptionistRequest,
    ) -> Result<()> {
        let url = format!(
            "/phone/auto_receptionists/{}",
            crate::progenitor_support::encode_path(auto_receptionist_id),
        );

        self.client
            .patch(&url, Some(reqwest::Body::from(serde_json::to_vec(body)?)))
            .await
    }

    /**
     * Assign phone numbers.
     *
     * This function performs a `POST` to the `/phone/auto_receptionists/{autoReceptionistId}/phone_numbers` endpoint.
     *
     * Assign available phone numbers to an [auto receptionist](https://support.zoom.us/hc/en-us/articles/360021121312-Managing-Auto-Receptionists-and-Interactive-Voice-Response-IVR-). The available numbers can be retrieved using the List Phone Numbers API with `type` query parameter set to "unassigned".
     *
     * **Prerequisites:**
     * * Pro or higher account plan with Zoom Phone License
     * * Account owner or admin permissions<br>
     * **Scopes:** `phone:write:admin`<br>
     *
     *
     *  **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
     *
     * **Parameters:**
     *
     * * `auto_receptionist_id: &str` -- Unique Identifier of the Auto Receptionist. It can be retrieved from the [List Sites API](https://marketplace.zoom.us/docs/api-reference/zoom-api/phone-site/listphonesites).
     */
    pub async fn assign_phone_numbers_auto_receptionist(
        &self,
        auto_receptionist_id: &str,
        body: &crate::types::AddByocNumberResponse,
    ) -> Result<()> {
        let url = format!(
            "/phone/auto_receptionists/{}/phone_numbers",
            crate::progenitor_support::encode_path(auto_receptionist_id),
        );

        self.client
            .post(&url, Some(reqwest::Body::from(serde_json::to_vec(body)?)))
            .await
    }

    /**
     * Unassign all phone numbers.
     *
     * This function performs a `DELETE` to the `/phone/auto_receptionists/{autoReceptionistId}/phone_numbers` endpoint.
     *
     * Unassign all phone numbers that were previously assigned to an [auto receptionist](https://support.zoom.us/hc/en-us/articles/360021121312-Managing-Auto-Receptionists-and-Interactive-Voice-Response-IVR-).
     *
     * **Prerequisites:**
     * * Pro or higher account plan with Zoom Phone License
     * * Account owner or admin permissions<br>
     * **Scopes:** `phone:write:admin`<br>
     *
     *  **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
     *
     */
    pub async fn unassign_all_phone_nums_auto_receptionist(
        &self,
        auto_receptionist_id: &str,
    ) -> Result<()> {
        let url = format!(
            "/phone/auto_receptionists/{}/phone_numbers",
            crate::progenitor_support::encode_path(auto_receptionist_id),
        );

        self.client.delete(&url, None).await
    }

    /**
     * Unassign a phone number.
     *
     * This function performs a `DELETE` to the `/phone/auto_receptionists/{autoReceptionistId}/phone_numbers/{phoneNumberId}` endpoint.
     *
     * Unassign a specific phone number that was previously assigned to an [auto receptionist](https://support.zoom.us/hc/en-us/articles/360021121312-Managing-Auto-Receptionists-and-Interactive-Voice-Response-IVR-).
     *
     * **Prerequisites:**
     * * Pro or higher account plan with Zoom Phone License
     * * Account owner or admin permissions<br>
     * **Scopes:** `phone:write:admin`<br>
     *
     *
     *  **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
     *
     * **Parameters:**
     *
     * * `auto_receptionist_id: &str` -- Unique identifier of the auto receptionist. This can be retrieved from the List Phone Sites API.
     * * `phone_number_id: &str` -- Unique Identifier of the phone number or provide the actual phone number in e164 format (example: +19995550123).
     */
    pub async fn unassign_phone_num_auto_receptionist(
        &self,
        auto_receptionist_id: &str,
        phone_number_id: &str,
    ) -> Result<()> {
        let url = format!(
            "/phone/auto_receptionists/{}/phone_numbers/{}",
            crate::progenitor_support::encode_path(auto_receptionist_id),
            crate::progenitor_support::encode_path(phone_number_id),
        );

        self.client.delete(&url, None).await
    }

    /**
     * Add an auto receptionist.
     *
     * This function performs a `POST` to the `/phone/auto_receptionists` endpoint.
     *
     * Auto receptionists answer calls with a personalized recording and routes calls to a phone user, call queue, common area phone, voicemail or an IVR system. Use this API to add an [auto receptionist](https://support.zoom.us/hc/en-us/articles/360021121312-Managing-Auto-Receptionists-and-Interactive-Voice-Response-IVR-) to a Zoom Phone.<br>
     *
     * **Prerequisites:**<br>
     * * Pro or higher account with Zoom Phone license.<br>
     * **Scopes:** `phone:write:admin` <br>
     *  **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
     *
     *
     */
    pub async fn add_auto_receptionist(
        &self,
        body: &crate::types::AddAutoReceptionistRequest,
    ) -> Result<crate::types::AddAutoReceptionistResponse> {
        let url = "/phone/auto_receptionists".to_string();
        self.client
            .post(&url, Some(reqwest::Body::from(serde_json::to_vec(body)?)))
            .await
    }
}