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
// Generated by basecamp-sdk-generator from openapi.json and behavior-model.json. DO NOT EDIT.
//! Gauges 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 `ListGaugeNeedles`.
#[derive(Debug, Clone, Default, PartialEq)]
pub struct ListGaugeNeedlesParams {
/// 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>,
}
/// Optional query parameters for `ListGauges`.
#[derive(Debug, Clone, Default, PartialEq)]
pub struct ListGaugesParams {
/// Comma-separated list of project IDs. When provided, results are returned
/// in the order specified instead of by risk level.
pub bucket_ids: 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>,
}
/// `Gauges` operations, sent through one [`AccountClient`].
#[derive(Debug, Clone, Copy)]
pub struct GaugesService<'a> {
client: &'a AccountClient,
}
impl<'a> GaugesService<'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 gauge needle (progress update) for a project
///
/// `POST /projects/{projectId}/gauge/needles.json` — not idempotent, sent exactly once.
pub async fn create_gauge_needle(
&self,
project_id: i64,
body: &CreateGaugeNeedleRequestContent,
) -> Result<CreateGaugeNeedleResponseContent, Error> {
let mut operation = self
.client
.operation(&routes::CREATE_GAUGE_NEEDLE, &[&project_id]);
operation.json(body)?;
self.client.send(operation).await
}
/// Destroy a gauge needle
///
/// `DELETE /gauge_needles/{needleId}` — idempotent; retries up to 2 attempt(s) on 429, 503.
pub async fn destroy_gauge_needle(&self, needle_id: i64) -> Result<(), Error> {
let operation = self
.client
.operation(&routes::DESTROY_GAUGE_NEEDLE, &[&needle_id]);
self.client.send_unit(operation).await
}
/// Get a gauge needle by ID
///
/// `GET /gauge_needles/{needleId}` — idempotent; retries up to 3 attempt(s) on 429, 503.
pub async fn gauge_needle(
&self,
needle_id: i64,
) -> Result<GetGaugeNeedleResponseContent, Error> {
let operation = self
.client
.operation(&routes::GET_GAUGE_NEEDLE, &[&needle_id]);
self.client.send(operation).await
}
/// List gauge needles for a project, ordered newest first.
///
/// `GET /projects/{projectId}/gauge/needles.json` — idempotent; retries up to 3 attempt(s) on 429, 503.
pub async fn list_gauge_needles(
&self,
project_id: i64,
params: &ListGaugeNeedlesParams,
) -> Result<Page<ListGaugeNeedlesResponseContent>, Error> {
let mut operation = self
.client
.operation(&routes::LIST_GAUGE_NEEDLES, &[&project_id]);
operation.query_optional("page", params.page.as_ref());
self.client.send_page(operation).await
}
/// List gauges across all projects the authenticated user has access to.
/// Gauges are sorted by risk level (red, yellow, green), then alphabetically.
///
/// `GET /reports/gauges.json` — idempotent; retries up to 3 attempt(s) on 429, 503.
pub async fn list_gauges(
&self,
params: &ListGaugesParams,
) -> Result<Page<ListGaugesResponseContent>, Error> {
let mut operation = self.client.operation(&routes::LIST_GAUGES, &[]);
operation.query_optional("bucket_ids", params.bucket_ids.as_ref());
operation.query_optional("page", params.page.as_ref());
self.client.send_page(operation).await
}
/// Enable or disable the gauge for a project. Only project admins can toggle gauges.
///
/// `PUT /projects/{projectId}/gauge.json` — idempotent; retries up to 2 attempt(s) on 429, 503.
pub async fn toggle_gauge(
&self,
project_id: i64,
body: &ToggleGaugeRequestContent,
) -> Result<(), Error> {
let mut operation = self.client.operation(&routes::TOGGLE_GAUGE, &[&project_id]);
operation.json(body)?;
self.client.send_unit(operation).await
}
/// Update a gauge needle's description. Position and color are immutable.
///
/// `PUT /gauge_needles/{needleId}` — idempotent; retries up to 2 attempt(s) on 429, 503.
pub async fn update_gauge_needle(
&self,
needle_id: i64,
body: &UpdateGaugeNeedleRequestContent,
) -> Result<UpdateGaugeNeedleResponseContent, Error> {
let mut operation = self
.client
.operation(&routes::UPDATE_GAUGE_NEEDLE, &[&needle_id]);
operation.json(body)?;
self.client.send(operation).await
}
}