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
// Generated by basecamp-sdk-generator from openapi.json and behavior-model.json. DO NOT EDIT.
//! Templates 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 `ListTemplates`.
#[derive(Debug, Clone, Default, PartialEq)]
pub struct ListTemplatesParams {
/// active|archived|trashed
pub status: 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>,
}
/// `Templates` operations, sent through one [`AccountClient`].
#[derive(Debug, Clone, Copy)]
pub struct TemplatesService<'a> {
client: &'a AccountClient,
}
impl<'a> TemplatesService<'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 template
///
/// `POST /templates.json` — not idempotent, sent exactly once.
pub async fn create(
&self,
body: &CreateTemplateRequestContent,
) -> Result<CreateTemplateResponseContent, Error> {
let mut operation = self.client.operation(&routes::CREATE_TEMPLATE, &[]);
operation.json(body)?;
self.client.send(operation).await
}
/// Start copying a to-do list template into a project
///
/// `POST /template_library/copies.json` — not idempotent, sent exactly once.
pub async fn create_library_copy(
&self,
body: &CreateTemplateLibraryCopyRequestContent,
) -> Result<CreateTemplateLibraryCopyResponseContent, Error> {
let mut operation = self
.client
.operation(&routes::CREATE_TEMPLATE_LIBRARY_COPY, &[]);
operation.json(body)?;
self.client.send(operation).await
}
/// Create a project from a template (asynchronous)
///
/// `POST /templates/{templateId}/project_constructions.json` — not idempotent, sent exactly once.
pub async fn create_project(
&self,
template_id: i64,
body: &CreateProjectFromTemplateRequestContent,
) -> Result<CreateProjectFromTemplateResponseContent, Error> {
let mut operation = self
.client
.operation(&routes::CREATE_PROJECT_FROM_TEMPLATE, &[&template_id]);
operation.json(body)?;
self.client.send(operation).await
}
/// Delete a template (trash it)
///
/// `DELETE /templates/{templateId}` — idempotent; retries up to 3 attempt(s) on 429, 503.
pub async fn delete(&self, template_id: i64) -> Result<(), Error> {
let operation = self
.client
.operation(&routes::DELETE_TEMPLATE, &[&template_id]);
self.client.send_unit(operation).await
}
/// Get a single template by id
///
/// `GET /templates/{templateId}` — idempotent; retries up to 3 attempt(s) on 429, 503.
pub async fn get(&self, template_id: i64) -> Result<GetTemplateResponseContent, Error> {
let operation = self
.client
.operation(&routes::GET_TEMPLATE, &[&template_id]);
self.client.send(operation).await
}
/// Get the status of a project construction
///
/// `GET /templates/{templateId}/project_constructions/{constructionId}` — idempotent; retries up to 3 attempt(s) on 429, 503.
pub async fn get_construction(
&self,
template_id: i64,
construction_id: i64,
) -> Result<GetProjectConstructionResponseContent, Error> {
let operation = self.client.operation(
&routes::GET_PROJECT_CONSTRUCTION,
&[&template_id, &construction_id],
);
self.client.send(operation).await
}
/// Get the account's to-do list template library
///
/// `GET /template_library.json` — idempotent; retries up to 3 attempt(s) on 429, 503.
pub async fn get_library(&self) -> Result<GetTemplateLibraryResponseContent, Error> {
let operation = self.client.operation(&routes::GET_TEMPLATE_LIBRARY, &[]);
self.client.send(operation).await
}
/// Get the current status of a to-do list template copy
///
/// `GET /template_library/copies/{copyId}` — idempotent; retries up to 3 attempt(s) on 429, 503.
pub async fn get_library_copy(
&self,
copy_id: i64,
) -> Result<GetTemplateLibraryCopyResponseContent, Error> {
let operation = self
.client
.operation(&routes::GET_TEMPLATE_LIBRARY_COPY, &[©_id]);
self.client.send(operation).await
}
/// List all templates visible to the current user
///
/// **Pagination**: Uses Link header (RFC5988). Follow the `next` rel URL
/// to fetch additional pages. X-Total-Count header provides total count.
///
/// `GET /templates.json` — idempotent; retries up to 3 attempt(s) on 429, 503.
pub async fn list(
&self,
params: &ListTemplatesParams,
) -> Result<Page<ListTemplatesResponseContent>, Error> {
let mut operation = self.client.operation(&routes::LIST_TEMPLATES, &[]);
operation.query_optional("status", params.status.as_ref());
operation.query_optional("page", params.page.as_ref());
self.client.send_page(operation).await
}
/// Update an existing template
///
/// `PUT /templates/{templateId}` — idempotent; retries up to 3 attempt(s) on 429, 503.
pub async fn update(
&self,
template_id: i64,
body: &UpdateTemplateRequestContent,
) -> Result<UpdateTemplateResponseContent, Error> {
let mut operation = self
.client
.operation(&routes::UPDATE_TEMPLATE, &[&template_id]);
operation.json(body)?;
self.client.send(operation).await
}
}