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
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
// Generated by basecamp-sdk-generator from openapi.json and behavior-model.json. DO NOT EDIT.
//! Recordings operations.
#![allow(
clippy::too_many_arguments,
clippy::wildcard_imports,
clippy::doc_markdown
)]
use crate::client::AccountClient;
use crate::error::Error;
use crate::generated::routes;
#[allow(unused_imports)]
use crate::generated::types::*;
use crate::pagination::Page;
/// Optional query parameters for `ListRecordings`.
#[derive(Debug, Clone, Default, PartialEq)]
pub struct ListRecordingsParams {
/// `bucket`.
pub bucket: Option<String>,
/// active|archived|trashed
pub status: Option<String>,
/// created_at|updated_at
pub sort: Option<String>,
/// asc|desc
pub direction: Option<String>,
/// Page number for paginating through results. Defaults to 1. A positive value selects exactly that page, not a starting offset; see SPEC section 8.
pub page: Option<i32>,
}
/// `Recordings` operations, sent through one [`AccountClient`].
#[derive(Debug, Clone, Copy)]
pub struct RecordingsService<'a> {
client: &'a AccountClient,
}
impl<'a> RecordingsService<'a> {
pub(crate) fn new(client: &'a AccountClient) -> Self {
Self { client }
}
/// The client this service sends through.
pub fn client(&self) -> &'a AccountClient {
self.client
}
/// Archive a recording; bc3 answers 403 for types it never lets be archived, timesheet entries among them
///
/// `PUT /recordings/{recordingId}/status/archived.json` — idempotent; retries up to 3 attempt(s) on 429, 503.
pub async fn archive(&self, recording_id: i64) -> Result<(), Error> {
let operation = self
.client
.operation(&routes::ARCHIVE_RECORDING, &[&recording_id]);
self.client.send_unit(operation).await
}
/// Start copying a recording into another project; poll GetFiling for the result.
///
/// Works like MoveRecording, except the original stays where it is. Name the
/// destination with `filing_destination_id`, a container of the kind the
/// recording sits in now, from the destination project's `dock` (GetProject): a
/// card copies into a card table (`kanban_board`) and lands in Triage, or in
/// Done if it is completed. A dock tool is copied by `destination_project_id`
/// instead. Poll GetFiling with the returned filing's id until `status` leaves
/// `pending` and `processing`; a completed filing's `destination_recording.id`
/// is the copy.
///
/// Not safe to retry blindly: each request makes another copy. Check the first
/// filing's status before trying again.
///
/// 400 when neither destination is given. 403 when the recording only copies
/// along with its parent. 404 when the destination is not one the caller can
/// copy it into. 422 when the copy cannot start, such as when the recording is
/// being moved or the destination cannot take it.
///
/// `POST /recordings/{recordingId}/copies.json` — not idempotent, sent exactly once.
pub async fn copy(
&self,
recording_id: i64,
body: &CopyRecordingRequestContent,
) -> Result<CopyRecordingResponseContent, Error> {
let mut operation = self
.client
.operation(&routes::COPY_RECORDING, &[&recording_id]);
operation.json(body)?;
self.client.send(operation).await
}
/// Get the state of a move or copy started by MoveRecording or CopyRecording.
///
/// `status` is `pending` or `processing` while the work runs, `completed` when
/// it is done, and `failed` if it could not be done. Poll until it leaves
/// `pending` and `processing`. A completed filing carries the recording it made
/// under `destination_recording`; for a move, that is the moved recording's new
/// id. 404 for a filing someone else started, and for a completed one whose
/// recording has since been permanently deleted.
///
/// `GET /filings/{filingId}` — idempotent; retries up to 3 attempt(s) on 429, 503.
pub async fn get_filing(&self, filing_id: i64) -> Result<GetFilingResponseContent, Error> {
let operation = self.client.operation(&routes::GET_FILING, &[&filing_id]);
self.client.send(operation).await
}
/// List recordings of a given type across projects
///
/// **Pagination**: Uses Link header (RFC5988). Follow the `next` rel URL
/// to fetch additional pages. X-Total-Count header provides total count.
///
/// `GET /projects/recordings.json` — idempotent; retries up to 3 attempt(s) on 429, 503.
pub async fn list(
&self,
r#type: &str,
params: &ListRecordingsParams,
) -> Result<Page<ListRecordingsResponseContent>, Error> {
let mut operation = self.client.operation(&routes::LIST_RECORDINGS, &[]);
operation.query("type", r#type);
operation.query_optional("bucket", params.bucket.as_ref());
operation.query_optional("status", params.status.as_ref());
operation.query_optional("sort", params.sort.as_ref());
operation.query_optional("direction", params.direction.as_ref());
operation.query_optional("page", params.page.as_ref());
self.client.send_page(operation).await
}
/// Start moving a recording into another project; poll GetFiling for the result.
///
/// The move runs in the background and this answers 201 with a filing. Poll
/// GetFiling with its id until `status` leaves `pending` and `processing`. Once
/// the move completes, the recording lives in the destination project under a
/// new id, the completed filing's `destination_recording.id`; its old id no
/// longer reaches it.
///
/// Name the destination with `filing_destination_id`: the container the
/// recording moves into, of the same kind it sits in now, found in the
/// destination project's `dock` (GetProject). A card moves into a card table
/// (`kanban_board`) and lands in Triage, or in Done if it is completed; a card
/// table column moves into a card table too. A message moves into a
/// `message_board`; a document, upload or folder into a `vault`; a schedule
/// entry into a `schedule`. A dock tool itself (a message board, card table,
/// Docs & Files, schedule) is moved by `destination_project_id` instead.
///
/// 400 when neither destination is given. 403 when the recording only moves
/// along with its parent, or the caller may not move it. 404 when the
/// destination is not one the caller can move it into. 422 when the move
/// cannot start, such as when the recording is already being moved or the
/// destination cannot take it. A repeated move is harmless: while the first is
/// pending it is 422, and once it is done, 404, because the recording has moved.
///
/// `POST /recordings/{recordingId}/moves.json` — not idempotent, sent exactly once.
pub async fn move_recording(
&self,
recording_id: i64,
body: &MoveRecordingRequestContent,
) -> Result<MoveRecordingResponseContent, Error> {
let mut operation = self
.client
.operation(&routes::MOVE_RECORDING, &[&recording_id]);
operation.json(body)?;
self.client.send(operation).await
}
/// Move a document, upload or vault into another vault in its project, or reorder it in its own vault.
///
/// Passing the vault it is already in changes only its position. The
/// recording moves in place: its id, comments, bookmarks and history stay with
/// it, and a vault takes everything inside it along. A destination in another
/// project is 404; moves to another project are not this operation. 404, 403 and
/// some 422s carry no body.
///
/// 403 when the caller may not move the recording (an account can restrict moves
/// to admins and creators). 422 when position is not a positive whole number, the
/// destination is not a vault or is not active, the recording is not active, or a
/// vault would move into one of its own vaults; only the position and vault-cycle
/// refusals carry an `error` message.
///
/// `POST /recordings/{recordingId}/filing.json` — not idempotent, sent exactly once.
pub async fn move_to_vault(
&self,
recording_id: i64,
body: &MoveRecordingToVaultRequestContent,
) -> Result<(), Error> {
let mut operation = self
.client
.operation(&routes::MOVE_RECORDING_TO_VAULT, &[&recording_id]);
operation.json(body)?;
self.client.send_unit(operation).await
}
/// Put a recording's card in the spotlight area on its project or template home page.
/// Idempotent: spotlighting an already-spotlighted recording still returns 201.
///
/// `POST /recordings/{recordingId}/spotlight.json` — idempotent; retries up to 3 attempt(s) on 429, 503.
pub async fn spotlight(
&self,
recording_id: i64,
) -> Result<SpotlightRecordingResponseContent, Error> {
let operation = self
.client
.operation(&routes::SPOTLIGHT_RECORDING, &[&recording_id]);
self.client.send(operation).await
}
/// Trash a recording; bc3 answers 403 for types it never lets be trashed, timesheet entries among them (DestroyTimesheetEntry removes those, permanently)
///
/// `PUT /recordings/{recordingId}/status/trashed.json` — idempotent; retries up to 3 attempt(s) on 429, 503.
pub async fn trash(&self, recording_id: i64) -> Result<(), Error> {
let operation = self
.client
.operation(&routes::TRASH_RECORDING, &[&recording_id]);
self.client.send_unit(operation).await
}
/// Unarchive a recording (restore to active status)
///
/// `PUT /recordings/{recordingId}/status/active.json` — idempotent; retries up to 3 attempt(s) on 429, 503.
pub async fn unarchive(&self, recording_id: i64) -> Result<(), Error> {
let operation = self
.client
.operation(&routes::UNARCHIVE_RECORDING, &[&recording_id]);
self.client.send_unit(operation).await
}
/// Remove a recording from the spotlight area.
/// Idempotent: removing an absent spotlight also returns 204.
///
/// `DELETE /recordings/{recordingId}/spotlight.json` — idempotent; retries up to 3 attempt(s) on 429, 503.
pub async fn unspotlight(&self, recording_id: i64) -> Result<(), Error> {
let operation = self
.client
.operation(&routes::UNSPOTLIGHT_RECORDING, &[&recording_id]);
self.client.send_unit(operation).await
}
}