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
// Generated by basecamp-sdk-generator from openapi.json and behavior-model.json. DO NOT EDIT.
//! Comments 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 `ListComments`.
#[derive(Debug, Clone, Default, PartialEq)]
pub struct ListCommentsParams {
/// 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>,
}
/// `Comments` operations, sent through one [`AccountClient`].
#[derive(Debug, Clone, Copy)]
pub struct CommentsService<'a> {
client: &'a AccountClient,
}
impl<'a> CommentsService<'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
}
/// Create a new comment on a recording
///
/// `POST /recordings/{recordingId}/comments.json` — not idempotent, sent exactly once.
pub async fn create(
&self,
recording_id: i64,
body: &CreateCommentRequestContent,
) -> Result<CreateCommentResponseContent, Error> {
let mut operation = self
.client
.operation(&routes::CREATE_COMMENT, &[&recording_id]);
operation.json(body)?;
self.client.send(operation).await
}
/// Get a single comment by id
///
/// `GET /comments/{commentId}` — idempotent; retries up to 3 attempt(s) on 429, 503.
pub async fn get(&self, comment_id: i64) -> Result<GetCommentResponseContent, Error> {
let operation = self.client.operation(&routes::GET_COMMENT, &[&comment_id]);
self.client.send(operation).await
}
/// List comments on a recording
///
/// **Pagination**: Uses Link header (RFC5988). Follow the `next` rel URL
/// to fetch additional pages. X-Total-Count header provides total count.
///
/// `GET /recordings/{recordingId}/comments.json` — idempotent; retries up to 3 attempt(s) on 429, 503.
pub async fn list(
&self,
recording_id: i64,
params: &ListCommentsParams,
) -> Result<Page<ListCommentsResponseContent>, Error> {
let mut operation = self
.client
.operation(&routes::LIST_COMMENTS, &[&recording_id]);
operation.query_optional("page", params.page.as_ref());
self.client.send_page(operation).await
}
/// Update an existing comment
///
/// `PUT /comments/{commentId}` — idempotent; retries up to 3 attempt(s) on 429, 503.
pub async fn update(
&self,
comment_id: i64,
body: &UpdateCommentRequestContent,
) -> Result<UpdateCommentResponseContent, Error> {
let mut operation = self
.client
.operation(&routes::UPDATE_COMMENT, &[&comment_id]);
operation.json(body)?;
self.client.send(operation).await
}
}