Skip to main content

basecamp_sdk/generated/
types.rs

1// Generated by basecamp-sdk-generator from openapi.json and behavior-model.json. DO NOT EDIT.
2
3//! The request and response shapes the Basecamp API speaks.
4
5#![allow(deprecated, clippy::doc_markdown)]
6
7use std::collections::BTreeMap;
8
9use serde::{Deserialize, Serialize};
10
11use crate::types::{AuthRoutableUrl, Date, DateChange, DateTime, FlexibleTime, SensitiveString};
12
13/// The `Account` shape of the Basecamp API.
14#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
15#[non_exhaustive]
16pub struct Account {
17    /// `id`.
18    pub id: i64,
19    /// `name`.
20    pub name: String,
21    /// `owner_name`.
22    #[serde(default, skip_serializing_if = "Option::is_none")]
23    pub owner_name: Option<String>,
24    /// `active`.
25    #[serde(default, skip_serializing_if = "Option::is_none")]
26    pub active: Option<bool>,
27    /// `created_at`.
28    pub created_at: DateTime,
29    /// `updated_at`.
30    pub updated_at: DateTime,
31    /// `trial`.
32    #[serde(default, skip_serializing_if = "Option::is_none")]
33    pub trial: Option<bool>,
34    /// `trial_ends_on`.
35    #[serde(default, skip_serializing_if = "Option::is_none")]
36    pub trial_ends_on: Option<Date>,
37    /// `frozen`.
38    #[serde(default, skip_serializing_if = "Option::is_none")]
39    pub frozen: Option<bool>,
40    /// `paused`.
41    #[serde(default, skip_serializing_if = "Option::is_none")]
42    pub paused: Option<bool>,
43    /// `limits`.
44    #[serde(default, skip_serializing_if = "Option::is_none")]
45    pub limits: Option<AccountLimits>,
46    /// `subscription`.
47    #[serde(default, skip_serializing_if = "Option::is_none")]
48    pub subscription: Option<AccountSubscription>,
49    /// `settings`.
50    #[serde(default, skip_serializing_if = "Option::is_none")]
51    pub settings: Option<AccountSettings>,
52    /// `logo`.
53    #[serde(default, skip_serializing_if = "Option::is_none")]
54    pub logo: Option<AccountLogo>,
55}
56
57/// The `AccountLimits` shape of the Basecamp API.
58#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
59#[non_exhaustive]
60pub struct AccountLimits {
61    /// `can_create_projects`.
62    #[serde(default, skip_serializing_if = "Option::is_none")]
63    pub can_create_projects: Option<bool>,
64    /// `can_pin_projects`.
65    #[serde(default, skip_serializing_if = "Option::is_none")]
66    pub can_pin_projects: Option<bool>,
67    /// `can_create_users`.
68    #[serde(default, skip_serializing_if = "Option::is_none")]
69    pub can_create_users: Option<bool>,
70    /// `can_upload_files`.
71    #[serde(default, skip_serializing_if = "Option::is_none")]
72    pub can_upload_files: Option<bool>,
73}
74
75/// The `AccountLogo` shape of the Basecamp API.
76#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
77#[non_exhaustive]
78pub struct AccountLogo {
79    /// `url`.
80    #[serde(default, skip_serializing_if = "Option::is_none")]
81    pub url: Option<String>,
82}
83
84/// The `AccountSettings` shape of the Basecamp API.
85#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
86#[non_exhaustive]
87pub struct AccountSettings {
88    /// `company_hq_enabled`.
89    #[serde(default, skip_serializing_if = "Option::is_none")]
90    pub company_hq_enabled: Option<bool>,
91    /// `teams_enabled`.
92    #[serde(default, skip_serializing_if = "Option::is_none")]
93    pub teams_enabled: Option<bool>,
94    /// `projects_enabled`.
95    #[serde(default, skip_serializing_if = "Option::is_none")]
96    pub projects_enabled: Option<bool>,
97}
98
99/// The `AccountSubscription` shape of the Basecamp API.
100#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
101#[non_exhaustive]
102pub struct AccountSubscription {
103    /// `short_name`.
104    #[serde(default, skip_serializing_if = "Option::is_none")]
105    pub short_name: Option<String>,
106    /// `proper_name`.
107    #[serde(default, skip_serializing_if = "Option::is_none")]
108    pub proper_name: Option<String>,
109    /// `project_limit`.
110    #[serde(default, skip_serializing_if = "Option::is_none")]
111    pub project_limit: Option<i32>,
112    /// `teams`.
113    #[serde(default, skip_serializing_if = "Option::is_none")]
114    pub teams: Option<bool>,
115    /// `clients`.
116    #[serde(default, skip_serializing_if = "Option::is_none")]
117    pub clients: Option<bool>,
118    /// `templates`.
119    #[serde(default, skip_serializing_if = "Option::is_none")]
120    pub templates: Option<bool>,
121    /// `logo`.
122    #[serde(default, skip_serializing_if = "Option::is_none")]
123    pub logo: Option<bool>,
124    /// `timesheet`.
125    #[serde(default, skip_serializing_if = "Option::is_none")]
126    pub timesheet: Option<bool>,
127}
128
129/// The `BadRequestErrorResponseContent` shape of the Basecamp API.
130#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
131#[non_exhaustive]
132pub struct BadRequestErrorResponseContent {
133    /// `error`.
134    pub error: String,
135    /// `message`.
136    #[serde(default, skip_serializing_if = "Option::is_none")]
137    pub message: Option<String>,
138}
139
140/// `BareFieldBadRequestErrorResponseContent`.
141pub type BareFieldBadRequestErrorResponseContent = FieldErrorMap;
142
143/// `BareFieldValidationErrorResponseContent`.
144pub type BareFieldValidationErrorResponseContent = FieldErrorMap;
145
146/// A personal bookmark: the current user's link to a single recording.
147/// The wrapped recording is the shared recording projection, whose `parent`
148/// is optional (docked recordings and doors omit it).
149#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
150#[non_exhaustive]
151pub struct Bookmark {
152    /// `id`.
153    pub id: i64,
154    /// `created_at`.
155    pub created_at: DateTime,
156    /// `updated_at`.
157    pub updated_at: DateTime,
158    /// `recording`.
159    pub recording: Recording,
160}
161
162/// The current user's bookmark state for one recording.
163#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
164#[non_exhaustive]
165pub struct BookmarkStatus {
166    /// `bookmarked`.
167    pub bookmarked: bool,
168}
169
170/// The `Boost` shape of the Basecamp API.
171#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
172#[non_exhaustive]
173pub struct Boost {
174    /// `id`.
175    pub id: i64,
176    /// `content`.
177    #[serde(default, skip_serializing_if = "Option::is_none")]
178    pub content: Option<String>,
179    /// `created_at`.
180    pub created_at: DateTime,
181    /// `booster`.
182    #[serde(default, skip_serializing_if = "Option::is_none")]
183    pub booster: Option<Person>,
184    /// `recording`.
185    #[serde(default, skip_serializing_if = "Option::is_none")]
186    pub recording: Option<RecordingParent>,
187}
188
189/// One project's slice of a filtered card listing: the parent project and the
190/// matching cards (each carrying its steps).
191#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
192#[non_exhaustive]
193pub struct BucketCardsGroup {
194    /// `bucket`.
195    pub bucket: RecordingBucket,
196    /// `cards`.
197    pub cards: Vec<Card>,
198}
199
200/// One project's slice of a filtered to-do listing: the parent project and the
201/// matching to-dos (each carrying its steps).
202#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
203#[non_exhaustive]
204pub struct BucketTodosGroup {
205    /// `bucket`.
206    pub bucket: RecordingBucket,
207    /// `todos`.
208    pub todos: Vec<Todo>,
209}
210
211/// A per-account calendar (wire type Calendar), keyed by its own bucket id.
212#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
213#[non_exhaustive]
214pub struct Calendar {
215    /// `id`.
216    pub id: i64,
217    /// `type`.
218    pub r#type: String,
219    /// `name`.
220    pub name: String,
221    /// One of: white, red, orange, yellow, green, blue, aqua, purple, gray,
222    /// pink, brown.
223    pub color: String,
224    /// `created_at`.
225    pub created_at: DateTime,
226    /// `updated_at`.
227    pub updated_at: DateTime,
228    /// `url`.
229    pub url: String,
230    /// `app_url`.
231    pub app_url: String,
232    /// API URL of the calendar's underlying schedule resource.
233    pub schedule_url: String,
234}
235
236/// The writable calendar payload — the wire body is the nested
237/// {calendar: {color}} envelope.
238#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
239pub struct CalendarAttributes {
240    /// One of: white, red, orange, yellow, green, blue, aqua, purple, gray,
241    /// pink, brown.
242    pub color: String,
243}
244
245/// The `Campfire` shape of the Basecamp API.
246#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
247#[non_exhaustive]
248pub struct Campfire {
249    /// `id`.
250    pub id: i64,
251    /// `status`.
252    pub status: String,
253    /// `visible_to_clients`.
254    pub visible_to_clients: bool,
255    /// `created_at`.
256    pub created_at: DateTime,
257    /// `updated_at`.
258    pub updated_at: DateTime,
259    /// `title`.
260    pub title: String,
261    /// `inherits_status`.
262    pub inherits_status: bool,
263    /// `type`.
264    pub r#type: String,
265    /// `url`.
266    pub url: String,
267    /// `app_url`.
268    pub app_url: String,
269    /// `bookmark_url`.
270    #[serde(default, skip_serializing_if = "Option::is_none")]
271    pub bookmark_url: Option<String>,
272    /// `subscription_url`.
273    #[serde(default, skip_serializing_if = "Option::is_none")]
274    pub subscription_url: Option<String>,
275    /// `position`.
276    #[serde(default, skip_serializing_if = "Option::is_none")]
277    pub position: Option<i32>,
278    /// `bucket`.
279    pub bucket: TodoBucket,
280    /// `creator`.
281    pub creator: Person,
282    /// `topic`.
283    #[serde(default, skip_serializing_if = "Option::is_none")]
284    pub topic: Option<String>,
285    /// `lines_url`.
286    #[serde(default, skip_serializing_if = "Option::is_none")]
287    pub lines_url: Option<String>,
288    /// `files_url`.
289    #[serde(default, skip_serializing_if = "Option::is_none")]
290    pub files_url: Option<String>,
291}
292
293/// The `CampfireLine` shape of the Basecamp API.
294#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
295#[non_exhaustive]
296pub struct CampfireLine {
297    /// `id`.
298    pub id: i64,
299    /// `status`.
300    pub status: String,
301    /// `visible_to_clients`.
302    pub visible_to_clients: bool,
303    /// `created_at`.
304    pub created_at: DateTime,
305    /// `updated_at`.
306    pub updated_at: DateTime,
307    /// `title`.
308    pub title: String,
309    /// `inherits_status`.
310    pub inherits_status: bool,
311    /// `type`.
312    pub r#type: String,
313    /// `url`.
314    pub url: String,
315    /// `app_url`.
316    pub app_url: String,
317    /// `bookmark_url`.
318    #[serde(default, skip_serializing_if = "Option::is_none")]
319    pub bookmark_url: Option<String>,
320    /// `content`.
321    #[serde(default, skip_serializing_if = "Option::is_none")]
322    pub content: Option<String>,
323    /// `attachments`.
324    #[serde(default, skip_serializing_if = "Option::is_none")]
325    pub attachments: Option<Vec<CampfireLineAttachment>>,
326    /// `parent`.
327    pub parent: RecordingParent,
328    /// `bucket`.
329    pub bucket: TodoBucket,
330    /// `creator`.
331    pub creator: Person,
332    /// `boosts_count`.
333    #[serde(default, skip_serializing_if = "Option::is_none")]
334    pub boosts_count: Option<i32>,
335    /// `boosts_url`.
336    #[serde(default, skip_serializing_if = "Option::is_none")]
337    pub boosts_url: Option<String>,
338}
339
340/// The `CampfireLineAttachment` shape of the Basecamp API.
341#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
342#[non_exhaustive]
343pub struct CampfireLineAttachment {
344    /// `title`.
345    #[serde(default, skip_serializing_if = "Option::is_none")]
346    pub title: Option<String>,
347    /// `url`.
348    #[serde(default, skip_serializing_if = "Option::is_none")]
349    pub url: Option<String>,
350    /// `filename`.
351    #[serde(default, skip_serializing_if = "Option::is_none")]
352    pub filename: Option<String>,
353    /// `content_type`.
354    #[serde(default, skip_serializing_if = "Option::is_none")]
355    pub content_type: Option<String>,
356    /// `byte_size`.
357    #[serde(default, skip_serializing_if = "Option::is_none")]
358    pub byte_size: Option<i64>,
359    /// `download_url`.
360    #[serde(default, skip_serializing_if = "Option::is_none")]
361    pub download_url: Option<AuthRoutableUrl>,
362}
363
364/// The `Card` shape of the Basecamp API.
365#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
366#[non_exhaustive]
367pub struct Card {
368    /// `id`.
369    pub id: i64,
370    /// `status`.
371    pub status: String,
372    /// `visible_to_clients`.
373    pub visible_to_clients: bool,
374    /// `created_at`.
375    pub created_at: DateTime,
376    /// `updated_at`.
377    pub updated_at: DateTime,
378    /// `title`.
379    pub title: String,
380    /// `inherits_status`.
381    pub inherits_status: bool,
382    /// `type`.
383    pub r#type: String,
384    /// `url`.
385    pub url: String,
386    /// `app_url`.
387    pub app_url: String,
388    /// `bookmark_url`.
389    #[serde(default, skip_serializing_if = "Option::is_none")]
390    pub bookmark_url: Option<String>,
391    /// `subscription_url`.
392    #[serde(default, skip_serializing_if = "Option::is_none")]
393    pub subscription_url: Option<String>,
394    /// `position`.
395    #[serde(default, skip_serializing_if = "Option::is_none")]
396    pub position: Option<i32>,
397    /// `content`.
398    #[serde(default, skip_serializing_if = "Option::is_none")]
399    pub content: Option<String>,
400    /// `description`.
401    #[serde(default, skip_serializing_if = "Option::is_none")]
402    pub description: Option<String>,
403    /// `description_attachments`.
404    pub description_attachments: Vec<RichTextAttachment>,
405    /// `due_on`.
406    #[serde(default, skip_serializing_if = "Option::is_none")]
407    pub due_on: Option<Date>,
408    /// `completed`.
409    #[serde(default, skip_serializing_if = "Option::is_none")]
410    pub completed: Option<bool>,
411    /// `completion`.
412    #[serde(default, skip_serializing_if = "Option::is_none")]
413    pub completion: Option<RecordingCompletion>,
414    /// This shape is deprecated since 2026-10: Never sent by Basecamp; read completion.created_at instead
415    #[deprecated(
416        note = "This shape is deprecated since 2026-10: Never sent by Basecamp; read completion.created_at instead"
417    )]
418    #[serde(default, skip_serializing_if = "Option::is_none")]
419    pub completed_at: Option<DateTime>,
420    /// `comments_count`.
421    #[serde(default, skip_serializing_if = "Option::is_none")]
422    pub comments_count: Option<i32>,
423    /// `comments_url`.
424    #[serde(default, skip_serializing_if = "Option::is_none")]
425    pub comments_url: Option<String>,
426    /// `completion_url`.
427    #[serde(default, skip_serializing_if = "Option::is_none")]
428    pub completion_url: Option<String>,
429    /// `parent`.
430    pub parent: RecordingParent,
431    /// `bucket`.
432    pub bucket: TodoBucket,
433    /// `creator`.
434    pub creator: Person,
435    /// This shape is deprecated since 2026-10: Never sent by Basecamp; read completion.creator instead
436    #[deprecated(
437        note = "This shape is deprecated since 2026-10: Never sent by Basecamp; read completion.creator instead"
438    )]
439    #[serde(default, skip_serializing_if = "Option::is_none")]
440    pub completer: Option<Person>,
441    /// `assignees`.
442    #[serde(
443        default,
444        deserialize_with = "crate::types::person_list::deserialize_optional",
445        skip_serializing_if = "Option::is_none"
446    )]
447    pub assignees: Option<Vec<Person>>,
448    /// `completion_subscribers`.
449    #[serde(
450        default,
451        deserialize_with = "crate::types::person_list::deserialize_optional",
452        skip_serializing_if = "Option::is_none"
453    )]
454    pub completion_subscribers: Option<Vec<Person>>,
455    /// The first 100 subtasks, embedded read-only. A card with more than 100
456    /// reports the total in `subtasks_count`; fetch the rest from `subtasks_url`.
457    #[serde(default, skip_serializing_if = "Option::is_none")]
458    pub steps: Option<Vec<Subtask>>,
459    /// `boosts_count`.
460    #[serde(default, skip_serializing_if = "Option::is_none")]
461    pub boosts_count: Option<i32>,
462    /// `boosts_url`.
463    #[serde(default, skip_serializing_if = "Option::is_none")]
464    pub boosts_url: Option<String>,
465    /// Subtask accounting (BC3 #12659). `subtasks_count` is the real total,
466    /// `subtasks_completed_count` how many are done, and `subtasks_url` the
467    /// paginated listing of all of them (`ListSubtasks`).
468    #[serde(default, skip_serializing_if = "Option::is_none")]
469    pub subtasks_count: Option<i32>,
470    /// `subtasks_completed_count`.
471    #[serde(default, skip_serializing_if = "Option::is_none")]
472    pub subtasks_completed_count: Option<i32>,
473    /// `subtasks_url`.
474    #[serde(default, skip_serializing_if = "Option::is_none")]
475    pub subtasks_url: Option<String>,
476}
477
478/// The `CardColumn` shape of the Basecamp API.
479#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
480#[non_exhaustive]
481pub struct CardColumn {
482    /// `id`.
483    pub id: i64,
484    /// `status`.
485    pub status: String,
486    /// `visible_to_clients`.
487    pub visible_to_clients: bool,
488    /// `created_at`.
489    pub created_at: DateTime,
490    /// `updated_at`.
491    pub updated_at: DateTime,
492    /// `title`.
493    pub title: String,
494    /// `inherits_status`.
495    pub inherits_status: bool,
496    /// `type`.
497    pub r#type: String,
498    /// `url`.
499    pub url: String,
500    /// `app_url`.
501    pub app_url: String,
502    /// `bookmark_url`.
503    #[serde(default, skip_serializing_if = "Option::is_none")]
504    pub bookmark_url: Option<String>,
505    /// `position`.
506    #[serde(default, skip_serializing_if = "Option::is_none")]
507    pub position: Option<i32>,
508    /// `color`.
509    #[serde(default, skip_serializing_if = "Option::is_none")]
510    pub color: Option<String>,
511    /// `description`.
512    #[serde(default, skip_serializing_if = "Option::is_none")]
513    pub description: Option<String>,
514    /// `cards_count`.
515    #[serde(default, skip_serializing_if = "Option::is_none")]
516    pub cards_count: Option<i32>,
517    /// `comments_count`.
518    #[serde(default, skip_serializing_if = "Option::is_none")]
519    pub comments_count: Option<i32>,
520    /// `cards_url`.
521    #[serde(default, skip_serializing_if = "Option::is_none")]
522    pub cards_url: Option<String>,
523    /// `parent`.
524    pub parent: RecordingParent,
525    /// `bucket`.
526    pub bucket: TodoBucket,
527    /// `creator`.
528    pub creator: Person,
529    /// `subscribers`.
530    #[serde(
531        default,
532        deserialize_with = "crate::types::person_list::deserialize_optional",
533        skip_serializing_if = "Option::is_none"
534    )]
535    pub subscribers: Option<Vec<Person>>,
536    /// `on_hold`.
537    #[serde(default, skip_serializing_if = "Option::is_none")]
538    pub on_hold: Option<CardColumnOnHold>,
539}
540
541/// The `CardColumnOnHold` shape of the Basecamp API.
542#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
543#[non_exhaustive]
544pub struct CardColumnOnHold {
545    /// `id`.
546    pub id: i64,
547    /// `status`.
548    pub status: String,
549    /// `inherits_status`.
550    pub inherits_status: bool,
551    /// `title`.
552    pub title: String,
553    /// `created_at`.
554    pub created_at: DateTime,
555    /// `updated_at`.
556    pub updated_at: DateTime,
557    /// `cards_count`.
558    pub cards_count: i32,
559    /// `cards_url`.
560    pub cards_url: String,
561}
562
563/// The `CardTable` shape of the Basecamp API.
564#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
565#[non_exhaustive]
566pub struct CardTable {
567    /// `id`.
568    pub id: i64,
569    /// `status`.
570    pub status: String,
571    /// `visible_to_clients`.
572    pub visible_to_clients: bool,
573    /// `created_at`.
574    pub created_at: DateTime,
575    /// `updated_at`.
576    pub updated_at: DateTime,
577    /// `title`.
578    pub title: String,
579    /// `inherits_status`.
580    pub inherits_status: bool,
581    /// `type`.
582    pub r#type: String,
583    /// `url`.
584    pub url: String,
585    /// `app_url`.
586    pub app_url: String,
587    /// `bookmark_url`.
588    #[serde(default, skip_serializing_if = "Option::is_none")]
589    pub bookmark_url: Option<String>,
590    /// `subscription_url`.
591    #[serde(default, skip_serializing_if = "Option::is_none")]
592    pub subscription_url: Option<String>,
593    /// Position on the project dock. Absent on a card table template, which the
594    /// library orders by title instead.
595    #[serde(default, skip_serializing_if = "Option::is_none")]
596    pub position: Option<i32>,
597    /// `parent`.
598    #[serde(default, skip_serializing_if = "Option::is_none")]
599    pub parent: Option<RecordingParent>,
600    /// Public sharing URL. Absent for callers who may not share publicly, so the
601    /// same card table can carry it for one person and not another.
602    #[serde(default, skip_serializing_if = "Option::is_none")]
603    pub public_link_url: Option<String>,
604    /// `bucket`.
605    pub bucket: TodoBucket,
606    /// `creator`.
607    pub creator: Person,
608    /// `subscribers`.
609    #[serde(
610        default,
611        deserialize_with = "crate::types::person_list::deserialize_optional",
612        skip_serializing_if = "Option::is_none"
613    )]
614    pub subscribers: Option<Vec<Person>>,
615    /// `lists`.
616    #[serde(default, skip_serializing_if = "Option::is_none")]
617    pub lists: Option<Vec<CardColumn>>,
618    /// The card table's wormholes: shortcuts for sending cards to other card
619    /// tables, usually in other projects. Only wormholes whose destination the
620    /// requester can reach are listed; the rest are omitted, not shown unlinked.
621    /// Not needed to move a card within its project; MoveCard reaches any column
622    /// there directly.
623    #[serde(default, skip_serializing_if = "Option::is_none")]
624    pub wormholes: Option<Vec<Wormhole>>,
625}
626
627/// The `Chatbot` shape of the Basecamp API.
628#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
629#[non_exhaustive]
630pub struct Chatbot {
631    /// `id`.
632    pub id: i64,
633    /// `created_at`.
634    pub created_at: DateTime,
635    /// `updated_at`.
636    pub updated_at: DateTime,
637    /// `service_name`.
638    pub service_name: String,
639    /// Only present when the requester is an account administrator; possession of this URL is enough to command the bot.
640    #[serde(default, skip_serializing_if = "Option::is_none")]
641    pub command_url: Option<String>,
642    /// `url`.
643    #[serde(default, skip_serializing_if = "Option::is_none")]
644    pub url: Option<String>,
645    /// `app_url`.
646    #[serde(default, skip_serializing_if = "Option::is_none")]
647    pub app_url: Option<String>,
648    /// Only present when the requester is an account administrator; possession of this URL is enough to post lines as the bot.
649    #[serde(default, skip_serializing_if = "Option::is_none")]
650    pub lines_url: Option<String>,
651}
652
653/// The `ClientApproval` shape of the Basecamp API.
654#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
655#[non_exhaustive]
656pub struct ClientApproval {
657    /// `id`.
658    pub id: i64,
659    /// `status`.
660    pub status: String,
661    /// `visible_to_clients`.
662    pub visible_to_clients: bool,
663    /// `created_at`.
664    pub created_at: DateTime,
665    /// `updated_at`.
666    pub updated_at: DateTime,
667    /// `title`.
668    pub title: String,
669    /// `inherits_status`.
670    pub inherits_status: bool,
671    /// `type`.
672    pub r#type: String,
673    /// `url`.
674    pub url: String,
675    /// `app_url`.
676    pub app_url: String,
677    /// `bookmark_url`.
678    #[serde(default, skip_serializing_if = "Option::is_none")]
679    pub bookmark_url: Option<String>,
680    /// `subscription_url`.
681    #[serde(default, skip_serializing_if = "Option::is_none")]
682    pub subscription_url: Option<String>,
683    /// `parent`.
684    pub parent: RecordingParent,
685    /// `bucket`.
686    pub bucket: RecordingBucket,
687    /// `creator`.
688    pub creator: Person,
689    /// `content`.
690    #[serde(default, skip_serializing_if = "Option::is_none")]
691    pub content: Option<String>,
692    /// `content_attachments`.
693    pub content_attachments: Vec<RichTextAttachment>,
694    /// `subject`.
695    #[serde(default, skip_serializing_if = "Option::is_none")]
696    pub subject: Option<String>,
697    /// `due_on`.
698    #[serde(default, skip_serializing_if = "Option::is_none")]
699    pub due_on: Option<Date>,
700    /// `replies_count`.
701    #[serde(default, skip_serializing_if = "Option::is_none")]
702    pub replies_count: Option<i32>,
703    /// `replies_url`.
704    #[serde(default, skip_serializing_if = "Option::is_none")]
705    pub replies_url: Option<String>,
706    /// `approval_status`.
707    #[serde(default, skip_serializing_if = "Option::is_none")]
708    pub approval_status: Option<String>,
709    /// `approver`.
710    #[serde(default, skip_serializing_if = "Option::is_none")]
711    pub approver: Option<Person>,
712    /// `responses`.
713    #[serde(default, skip_serializing_if = "Option::is_none")]
714    pub responses: Option<Vec<ClientApprovalResponse>>,
715}
716
717/// The `ClientApprovalResponse` shape of the Basecamp API.
718#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
719#[non_exhaustive]
720pub struct ClientApprovalResponse {
721    /// `id`.
722    #[serde(default, skip_serializing_if = "Option::is_none")]
723    pub id: Option<i64>,
724    /// `status`.
725    #[serde(default, skip_serializing_if = "Option::is_none")]
726    pub status: Option<String>,
727    /// `visible_to_clients`.
728    #[serde(default, skip_serializing_if = "Option::is_none")]
729    pub visible_to_clients: Option<bool>,
730    /// `created_at`.
731    #[serde(default, skip_serializing_if = "Option::is_none")]
732    pub created_at: Option<DateTime>,
733    /// `updated_at`.
734    #[serde(default, skip_serializing_if = "Option::is_none")]
735    pub updated_at: Option<DateTime>,
736    /// `title`.
737    #[serde(default, skip_serializing_if = "Option::is_none")]
738    pub title: Option<String>,
739    /// `inherits_status`.
740    #[serde(default, skip_serializing_if = "Option::is_none")]
741    pub inherits_status: Option<bool>,
742    /// `type`.
743    #[serde(default, skip_serializing_if = "Option::is_none")]
744    pub r#type: Option<String>,
745    /// `app_url`.
746    #[serde(default, skip_serializing_if = "Option::is_none")]
747    pub app_url: Option<String>,
748    /// `bookmark_url`.
749    #[serde(default, skip_serializing_if = "Option::is_none")]
750    pub bookmark_url: Option<String>,
751    /// `parent`.
752    #[serde(default, skip_serializing_if = "Option::is_none")]
753    pub parent: Option<RecordingParent>,
754    /// `bucket`.
755    #[serde(default, skip_serializing_if = "Option::is_none")]
756    pub bucket: Option<RecordingBucket>,
757    /// `creator`.
758    #[serde(default, skip_serializing_if = "Option::is_none")]
759    pub creator: Option<Person>,
760    /// `content`.
761    #[serde(default, skip_serializing_if = "Option::is_none")]
762    pub content: Option<String>,
763    /// `approved`.
764    #[serde(default, skip_serializing_if = "Option::is_none")]
765    pub approved: Option<bool>,
766}
767
768/// The `ClientCompany` shape of the Basecamp API.
769#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
770#[non_exhaustive]
771pub struct ClientCompany {
772    /// `id`.
773    pub id: i64,
774    /// `name`.
775    pub name: String,
776}
777
778/// The `ClientCorrespondence` shape of the Basecamp API.
779#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
780#[non_exhaustive]
781pub struct ClientCorrespondence {
782    /// `id`.
783    pub id: i64,
784    /// `status`.
785    pub status: String,
786    /// `visible_to_clients`.
787    pub visible_to_clients: bool,
788    /// `created_at`.
789    pub created_at: DateTime,
790    /// `updated_at`.
791    pub updated_at: DateTime,
792    /// `title`.
793    pub title: String,
794    /// `inherits_status`.
795    pub inherits_status: bool,
796    /// `type`.
797    pub r#type: String,
798    /// `url`.
799    pub url: String,
800    /// `app_url`.
801    pub app_url: String,
802    /// `bookmark_url`.
803    #[serde(default, skip_serializing_if = "Option::is_none")]
804    pub bookmark_url: Option<String>,
805    /// `subscription_url`.
806    #[serde(default, skip_serializing_if = "Option::is_none")]
807    pub subscription_url: Option<String>,
808    /// `parent`.
809    pub parent: RecordingParent,
810    /// `bucket`.
811    pub bucket: RecordingBucket,
812    /// `creator`.
813    pub creator: Person,
814    /// `content`.
815    #[serde(default, skip_serializing_if = "Option::is_none")]
816    pub content: Option<String>,
817    /// `content_attachments`.
818    pub content_attachments: Vec<RichTextAttachment>,
819    /// `subject`.
820    pub subject: String,
821    /// `replies_count`.
822    #[serde(default, skip_serializing_if = "Option::is_none")]
823    pub replies_count: Option<i32>,
824    /// `replies_url`.
825    #[serde(default, skip_serializing_if = "Option::is_none")]
826    pub replies_url: Option<String>,
827}
828
829/// One rejected `create` row: the address as submitted and the validation
830/// messages for it. Always emitted; `null` when the row carried no address (the
831/// row is still rejected, with a "can't be blank" message). `@required` models
832/// the presence and the nullability is layered on in the OpenAPI
833/// (smithy-build.json jsonAdd -\> type: \["string","null"\]), the Wormhole.color
834/// treatment.
835#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
836#[non_exhaustive]
837pub struct ClientInvitationError {
838    /// `email_address`.
839    #[serde(deserialize_with = "serde::Deserialize::deserialize")]
840    pub email_address: Option<String>,
841    /// `messages`.
842    pub messages: Vec<String>,
843}
844
845/// The per-row 422 body: {"errors": \[{"email_address": ..., "messages": \[...\]}\]}.
846#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
847#[non_exhaustive]
848pub struct ClientInvitationErrors {
849    /// `errors`.
850    pub errors: Vec<ClientInvitationError>,
851}
852
853/// `ClientInvitationValidationErrorResponseContent`.
854pub type ClientInvitationValidationErrorResponseContent = ClientInvitationErrors;
855
856/// The `ClientReply` shape of the Basecamp API.
857#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
858#[non_exhaustive]
859pub struct ClientReply {
860    /// `id`.
861    pub id: i64,
862    /// `status`.
863    pub status: String,
864    /// `visible_to_clients`.
865    pub visible_to_clients: bool,
866    /// `created_at`.
867    pub created_at: DateTime,
868    /// `updated_at`.
869    pub updated_at: DateTime,
870    /// `title`.
871    pub title: String,
872    /// `inherits_status`.
873    pub inherits_status: bool,
874    /// `type`.
875    pub r#type: String,
876    /// `url`.
877    pub url: String,
878    /// `app_url`.
879    pub app_url: String,
880    /// `bookmark_url`.
881    #[serde(default, skip_serializing_if = "Option::is_none")]
882    pub bookmark_url: Option<String>,
883    /// `parent`.
884    pub parent: RecordingParent,
885    /// `bucket`.
886    pub bucket: RecordingBucket,
887    /// `creator`.
888    pub creator: Person,
889    /// `content`.
890    pub content: String,
891    /// `content_attachments`.
892    pub content_attachments: Vec<RichTextAttachment>,
893}
894
895/// This shape is deprecated since 2024-01: Use Client Visibility feature instead
896#[deprecated(
897    note = "This shape is deprecated since 2024-01: Use Client Visibility feature instead"
898)]
899#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
900#[non_exhaustive]
901pub struct ClientSide {
902    /// `url`.
903    #[serde(default, skip_serializing_if = "Option::is_none")]
904    pub url: Option<String>,
905    /// `app_url`.
906    #[serde(default, skip_serializing_if = "Option::is_none")]
907    pub app_url: Option<String>,
908}
909
910/// The `CloudFile` shape of the Basecamp API.
911#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
912#[non_exhaustive]
913pub struct CloudFile {
914    /// `id`.
915    pub id: i64,
916    /// `status`.
917    pub status: String,
918    /// `visible_to_clients`.
919    pub visible_to_clients: bool,
920    /// `created_at`.
921    pub created_at: DateTime,
922    /// `updated_at`.
923    pub updated_at: DateTime,
924    /// `title`.
925    pub title: String,
926    /// `inherits_status`.
927    pub inherits_status: bool,
928    /// `type`.
929    pub r#type: String,
930    /// The link on the external service — NOT this record's API URL. The
931    /// cloud_files jbuilder renders the shared recording partial first and then
932    /// `json.(recording.recordable, :url, :service)`, which overwrites the
933    /// recording's `url` key with the recordable's. `app_url` is still this
934    /// record's Basecamp URL.
935    pub url: String,
936    /// `app_url`.
937    pub app_url: String,
938    /// `bookmark_url`.
939    #[serde(default, skip_serializing_if = "Option::is_none")]
940    pub bookmark_url: Option<String>,
941    /// `subscription_url`.
942    #[serde(default, skip_serializing_if = "Option::is_none")]
943    pub subscription_url: Option<String>,
944    /// `comments_count`.
945    #[serde(default, skip_serializing_if = "Option::is_none")]
946    pub comments_count: Option<i32>,
947    /// `comments_url`.
948    #[serde(default, skip_serializing_if = "Option::is_none")]
949    pub comments_url: Option<String>,
950    /// `position`.
951    #[serde(default, skip_serializing_if = "Option::is_none")]
952    pub position: Option<i32>,
953    /// `parent`.
954    pub parent: RecordingParent,
955    /// `bucket`.
956    pub bucket: TodoBucket,
957    /// `creator`.
958    pub creator: Person,
959    /// `description`.
960    #[serde(default, skip_serializing_if = "Option::is_none")]
961    pub description: Option<String>,
962    /// `description_attachments`.
963    pub description_attachments: Vec<RichTextAttachment>,
964    /// `service`.
965    pub service: CloudFileService,
966    /// `boosts_count`.
967    #[serde(default, skip_serializing_if = "Option::is_none")]
968    pub boosts_count: Option<i32>,
969    /// `boosts_url`.
970    #[serde(default, skip_serializing_if = "Option::is_none")]
971    pub boosts_url: Option<String>,
972}
973
974/// The external service a cloud file points at, embedded in every cloud file
975/// response so clients can render the service's name, supporting text, and
976/// example URL without shipping a hard-coded catalogue. Serialized by
977/// CloudFile::Service#as_json.
978#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
979#[non_exhaustive]
980pub struct CloudFileService {
981    /// `name`.
982    pub name: String,
983    /// A representative URL for the service, suitable as an input placeholder.
984    pub example_url: String,
985    /// Short identifier for the external service — "dropbox", "google_doc",
986    /// "figma", "other", … Derived from the CloudFile::Service subclass name, so it
987    /// is always present. `other` accepts any well-formed HTTPS URL.
988    pub code: String,
989    /// Regular expressions the cloud file's `url` is validated against. Sending a
990    /// `url` that matches none of the selected service's patterns is a 422.
991    pub valid_patterns: Vec<String>,
992    /// Human-readable hint ("a file or folder on Dropbox"). Absent for services
993    /// that declare none — CloudFile::Service::Services::Other, for one.
994    #[serde(default, skip_serializing_if = "Option::is_none")]
995    pub supporting_text: Option<String>,
996}
997
998/// The `Comment` shape of the Basecamp API.
999#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
1000#[non_exhaustive]
1001pub struct Comment {
1002    /// `id`.
1003    pub id: i64,
1004    /// `status`.
1005    pub status: String,
1006    /// `visible_to_clients`.
1007    pub visible_to_clients: bool,
1008    /// `created_at`.
1009    pub created_at: DateTime,
1010    /// `updated_at`.
1011    pub updated_at: DateTime,
1012    /// `title`.
1013    pub title: String,
1014    /// `inherits_status`.
1015    pub inherits_status: bool,
1016    /// `type`.
1017    pub r#type: String,
1018    /// `url`.
1019    pub url: String,
1020    /// `app_url`.
1021    pub app_url: String,
1022    /// `bookmark_url`.
1023    #[serde(default, skip_serializing_if = "Option::is_none")]
1024    pub bookmark_url: Option<String>,
1025    /// `parent`.
1026    pub parent: RecordingParent,
1027    /// `bucket`.
1028    pub bucket: TodoBucket,
1029    /// `creator`.
1030    pub creator: Person,
1031    /// `content`.
1032    pub content: String,
1033    /// `content_attachments`.
1034    pub content_attachments: Vec<RichTextAttachment>,
1035    /// `boosts_count`.
1036    #[serde(default, skip_serializing_if = "Option::is_none")]
1037    pub boosts_count: Option<i32>,
1038    /// `boosts_url`.
1039    #[serde(default, skip_serializing_if = "Option::is_none")]
1040    pub boosts_url: Option<String>,
1041}
1042
1043/// The `CopyRecordingRequestContent` shape of the Basecamp API.
1044#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
1045pub struct CopyRecordingRequestContent {
1046    /// The container to copy into, chosen as for MoveRecording's
1047    /// filing_destination_id: a container of the kind the recording sits in now,
1048    /// such as a to-do list, in this project or another, for a to-do. For a dock
1049    /// tool, the destination project's dock. Give this or destination_project_id.
1050    #[serde(default, skip_serializing_if = "Option::is_none")]
1051    pub filing_destination_id: Option<i64>,
1052    /// The project to copy a dock tool to. Applies to tools only, and wins over
1053    /// filing_destination_id when a request for a tool gives both.
1054    #[serde(default, skip_serializing_if = "Option::is_none")]
1055    pub destination_project_id: Option<i64>,
1056    /// When copying into a vault, a folder inside it to put the copy in.
1057    #[serde(default, skip_serializing_if = "Option::is_none")]
1058    pub parent_id: Option<i64>,
1059    /// Copy the recording's comments too. Defaults to false.
1060    #[serde(default, skip_serializing_if = "Option::is_none")]
1061    pub include_comments: Option<bool>,
1062}
1063
1064/// `CopyRecordingResponseContent`.
1065pub type CopyRecordingResponseContent = Filing;
1066
1067/// `CreateAnswerResponseContent`.
1068pub type CreateAnswerResponseContent = QuestionAnswer;
1069
1070/// A raw byte payload, sent as the request body.
1071pub type CreateAttachmentInputPayload = Vec<u8>;
1072
1073/// The `CreateAttachmentResponseContent` shape of the Basecamp API.
1074#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
1075#[non_exhaustive]
1076pub struct CreateAttachmentResponseContent {
1077    /// `attachable_sgid`.
1078    #[serde(default, skip_serializing_if = "Option::is_none")]
1079    pub attachable_sgid: Option<String>,
1080}
1081
1082/// `CreateBookmarkResponseContent`.
1083pub type CreateBookmarkResponseContent = Bookmark;
1084
1085/// The `CreateBubbleUpRequestContent` shape of the Basecamp API.
1086#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
1087pub struct CreateBubbleUpRequestContent {
1088    /// Timing for the bubble-up. `"now"` bubbles up immediately; a scheduling
1089    /// keyword (`"today"`, `"tomorrow"`, `"weekend"`, `"next_week"`) or an ISO8601
1090    /// date (e.g. `"2026-09-10"`) schedules it to resurface later. bc3 requires a
1091    /// value — omitting `at` errors server-side (`Date.iso8601(nil)`) — so send
1092    /// `"now"` for the immediate case.
1093    #[serde(default, skip_serializing_if = "Option::is_none")]
1094    pub at: Option<String>,
1095}
1096
1097/// The `CreateCampfireLineRequestContent` shape of the Basecamp API.
1098#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
1099pub struct CreateCampfireLineRequestContent {
1100    /// `content`.
1101    pub content: String,
1102    /// `content_type`.
1103    #[serde(default, skip_serializing_if = "Option::is_none")]
1104    pub content_type: Option<String>,
1105}
1106
1107/// `CreateCampfireLineResponseContent`.
1108pub type CreateCampfireLineResponseContent = CampfireLine;
1109
1110/// Raw binary content of the file. Set the Content-Type header to match
1111/// the file's media type (e.g. "image/png", "application/pdf").
1112pub type CreateCampfireUploadInputPayload = Vec<u8>;
1113
1114/// `CreateCampfireUploadResponseContent`.
1115pub type CreateCampfireUploadResponseContent = CampfireLine;
1116
1117/// The `CreateCardColumnRequestContent` shape of the Basecamp API.
1118#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
1119pub struct CreateCardColumnRequestContent {
1120    /// `title`.
1121    pub title: String,
1122    /// `description`.
1123    #[serde(default, skip_serializing_if = "Option::is_none")]
1124    pub description: Option<String>,
1125}
1126
1127/// `CreateCardColumnResponseContent`.
1128pub type CreateCardColumnResponseContent = CardColumn;
1129
1130/// The `CreateCardRequestContent` shape of the Basecamp API.
1131#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
1132pub struct CreateCardRequestContent {
1133    /// `title`.
1134    pub title: String,
1135    /// `content`.
1136    #[serde(default, skip_serializing_if = "Option::is_none")]
1137    pub content: Option<String>,
1138    /// `due_on`.
1139    #[serde(default, skip_serializing_if = "Option::is_none")]
1140    pub due_on: Option<Date>,
1141    /// People to assign to the new card. BC3 keeps only the ids it finds among
1142    /// the card table's reachable people and silently drops the rest.
1143    #[serde(default, skip_serializing_if = "Option::is_none")]
1144    pub assignee_ids: Option<Vec<i64>>,
1145    /// Notify the people assigned through assignee_ids. Off unless true.
1146    #[serde(default, skip_serializing_if = "Option::is_none")]
1147    pub notify: Option<bool>,
1148}
1149
1150/// `CreateCardResponseContent`.
1151pub type CreateCardResponseContent = Card;
1152
1153/// The `CreateCardStepRequestContent` shape of the Basecamp API.
1154#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
1155pub struct CreateCardStepRequestContent {
1156    /// `title`.
1157    pub title: String,
1158    /// `due_on`.
1159    #[serde(default, skip_serializing_if = "Option::is_none")]
1160    pub due_on: Option<Date>,
1161    /// `assignee_ids`.
1162    #[serde(default, skip_serializing_if = "Option::is_none")]
1163    pub assignee_ids: Option<Vec<i64>>,
1164}
1165
1166/// `CreateCardStepResponseContent`.
1167pub type CreateCardStepResponseContent = Subtask;
1168
1169/// The `CreateChatbotRequestContent` shape of the Basecamp API.
1170#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
1171pub struct CreateChatbotRequestContent {
1172    /// `service_name`.
1173    pub service_name: String,
1174    /// `command_url`.
1175    #[serde(default, skip_serializing_if = "Option::is_none")]
1176    pub command_url: Option<String>,
1177}
1178
1179/// `CreateChatbotResponseContent`.
1180pub type CreateChatbotResponseContent = Chatbot;
1181
1182/// A new client to invite. Unlike CreatePersonRequest, only the address is
1183/// required: bc3 defaults `name` to the email address when omitted.
1184#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
1185pub struct CreateClientRequest {
1186    /// `email_address`.
1187    pub email_address: String,
1188    /// `name`.
1189    #[serde(default, skip_serializing_if = "Option::is_none")]
1190    pub name: Option<String>,
1191    /// `title`.
1192    #[serde(default, skip_serializing_if = "Option::is_none")]
1193    pub title: Option<String>,
1194    /// `company_name`.
1195    #[serde(default, skip_serializing_if = "Option::is_none")]
1196    pub company_name: Option<String>,
1197}
1198
1199/// The `CreateCloudFileRequestContent` shape of the Basecamp API.
1200#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
1201pub struct CreateCloudFileRequestContent {
1202    /// `url`.
1203    pub url: String,
1204    /// Short identifier for the external service — "dropbox", "google_doc",
1205    /// "figma", "other", … Derived from the CloudFile::Service subclass name, so it
1206    /// is always present. `other` accepts any well-formed HTTPS URL.
1207    pub service: String,
1208    /// `title`.
1209    #[serde(default, skip_serializing_if = "Option::is_none")]
1210    pub title: Option<String>,
1211    /// `description`.
1212    #[serde(default, skip_serializing_if = "Option::is_none")]
1213    pub description: Option<String>,
1214    /// `subscriptions`.
1215    #[serde(default, skip_serializing_if = "Option::is_none")]
1216    pub subscriptions: Option<Vec<i64>>,
1217    /// Whether the cloud file is visible to the project's clients. Applies only
1218    /// when creating directly in the tool's vault — an item created inside a
1219    /// folder inherits the folder's visibility and ignores this. A client caller
1220    /// always creates client-visible records regardless of what is sent.
1221    #[serde(default, skip_serializing_if = "Option::is_none")]
1222    pub visible_to_clients: Option<bool>,
1223}
1224
1225/// `CreateCloudFileResponseContent`.
1226pub type CreateCloudFileResponseContent = CloudFile;
1227
1228/// The `CreateCommentRequestContent` shape of the Basecamp API.
1229#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
1230pub struct CreateCommentRequestContent {
1231    /// `content`.
1232    pub content: String,
1233}
1234
1235/// `CreateCommentResponseContent`.
1236pub type CreateCommentResponseContent = Comment;
1237
1238/// The `CreateDocumentRequestContent` shape of the Basecamp API.
1239#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
1240pub struct CreateDocumentRequestContent {
1241    /// `title`.
1242    pub title: String,
1243    /// `content`.
1244    #[serde(default, skip_serializing_if = "Option::is_none")]
1245    pub content: Option<String>,
1246    /// active|drafted
1247    #[serde(default, skip_serializing_if = "Option::is_none")]
1248    pub status: Option<String>,
1249    /// `subscriptions`.
1250    #[serde(default, skip_serializing_if = "Option::is_none")]
1251    pub subscriptions: Option<Vec<i64>>,
1252    /// `visible_to_clients`.
1253    #[serde(default, skip_serializing_if = "Option::is_none")]
1254    pub visible_to_clients: Option<bool>,
1255}
1256
1257/// `CreateDocumentResponseContent`.
1258pub type CreateDocumentResponseContent = Document;
1259
1260/// The `CreateDoorPayload` shape of the Basecamp API.
1261#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
1262pub struct CreateDoorPayload {
1263    /// Short identifier for the external service: figma, dropbox, google_drive,
1264    /// github, notion, trello, slack, zoom, airtable, jira, miro, … or `other`
1265    /// for a generic link.
1266    pub service: String,
1267    /// The address the link points to. Supply an HTTP or HTTPS URL; a value
1268    /// without a scheme is prefixed with `https://`.
1269    pub url: String,
1270    /// Name shown in the External links section. Defaults to "Untitled".
1271    #[serde(default, skip_serializing_if = "Option::is_none")]
1272    pub title: Option<String>,
1273    /// Rich-text (HTML) description shown beneath the title.
1274    #[serde(default, skip_serializing_if = "Option::is_none")]
1275    pub description: Option<String>,
1276}
1277
1278/// The `CreateDoorRequestContent` shape of the Basecamp API.
1279#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
1280pub struct CreateDoorRequestContent {
1281    /// `door`.
1282    pub door: CreateDoorPayload,
1283    /// Whether the project's clients can see the external link. Omitted means
1284    /// false: the link is private to the team. A client caller always creates a
1285    /// client-visible link regardless of what is sent.
1286    #[serde(default, skip_serializing_if = "Option::is_none")]
1287    pub visible_to_clients: Option<bool>,
1288}
1289
1290/// `CreateDoorResponseContent`.
1291pub type CreateDoorResponseContent = Door;
1292
1293/// The `CreateEmbedRequestContent` shape of the Basecamp API.
1294#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
1295pub struct CreateEmbedRequestContent {
1296    /// The URL of the content to embed.
1297    pub url: String,
1298}
1299
1300/// `CreateEmbedResponseContent`.
1301pub type CreateEmbedResponseContent = Embed;
1302
1303/// The `CreateEventBoostRequestContent` shape of the Basecamp API.
1304#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
1305pub struct CreateEventBoostRequestContent {
1306    /// `content`.
1307    pub content: String,
1308}
1309
1310/// `CreateEventBoostResponseContent`.
1311pub type CreateEventBoostResponseContent = Boost;
1312
1313/// The `CreateFolderRequestContent` shape of the Basecamp API.
1314#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
1315pub struct CreateFolderRequestContent {
1316    /// The folder's name. Defaults to `New folder` when blank, null, or omitted.
1317    #[serde(default, skip_serializing_if = "Option::is_none")]
1318    pub name: Option<String>,
1319    /// IDs of the projects to file into the folder — the same ids the folder
1320    /// reports back as `bucket_ids` and expands as `projects`. This does not
1321    /// round-trip under its own name. Omit it, or send null or an empty array,
1322    /// for an empty folder.
1323    #[serde(default, skip_serializing_if = "Option::is_none")]
1324    pub project_ids: Option<Vec<i64>>,
1325}
1326
1327/// `CreateFolderResponseContent`.
1328pub type CreateFolderResponseContent = FolderWithProjects;
1329
1330/// The `CreateGaugeNeedleRequestContent` shape of the Basecamp API.
1331#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
1332pub struct CreateGaugeNeedleRequestContent {
1333    /// `gauge_needle`.
1334    pub gauge_needle: GaugeNeedlePayload,
1335    /// Who to notify: "everyone", "default" (the project's existing
1336    /// subscribers), or "custom" (the people in `subscriptions`). Omit for
1337    /// nobody: bc3 defaults `notify` to "custom", which with no `subscriptions`
1338    /// notifies no one, and any unrecognized value (`Subscribers#find_subscribers`
1339    /// accepts exactly these three) falls through to nobody as well.
1340    #[serde(default, skip_serializing_if = "Option::is_none")]
1341    pub notify: Option<String>,
1342    /// Array of people IDs to notify (only used when notify is "custom")
1343    #[serde(default, skip_serializing_if = "Option::is_none")]
1344    pub subscriptions: Option<Vec<i64>>,
1345}
1346
1347/// `CreateGaugeNeedleResponseContent`.
1348pub type CreateGaugeNeedleResponseContent = GaugeNeedle;
1349
1350/// The `CreateGoogleDocumentRequestContent` shape of the Basecamp API.
1351#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
1352pub struct CreateGoogleDocumentRequestContent {
1353    /// `url`.
1354    pub url: String,
1355    /// One of "doc", "sheet", "slide", "other". Backed by a Rails enum, so an
1356    /// unrecognized value is rejected up front with a field-keyed 422
1357    /// ({"errors": {"document_type": \["is not a valid document type"\]}}) rather
1358    /// than reaching validation.
1359    pub document_type: String,
1360    /// `title`.
1361    #[serde(default, skip_serializing_if = "Option::is_none")]
1362    pub title: Option<String>,
1363    /// `description`.
1364    #[serde(default, skip_serializing_if = "Option::is_none")]
1365    pub description: Option<String>,
1366    /// active|drafted — defaults to drafted
1367    #[serde(default, skip_serializing_if = "Option::is_none")]
1368    pub status: Option<String>,
1369    /// `subscriptions`.
1370    #[serde(default, skip_serializing_if = "Option::is_none")]
1371    pub subscriptions: Option<Vec<i64>>,
1372    /// Whether the document is visible to the project's clients. Applies only
1373    /// when creating directly in the tool's vault — an item created inside a
1374    /// folder inherits the folder's visibility and ignores this. A client caller
1375    /// always creates client-visible records regardless of what is sent.
1376    #[serde(default, skip_serializing_if = "Option::is_none")]
1377    pub visible_to_clients: Option<bool>,
1378}
1379
1380/// `CreateGoogleDocumentResponseContent`.
1381pub type CreateGoogleDocumentResponseContent = GoogleDocument;
1382
1383/// The `CreateHillChartVersionRequestContent` shape of the Basecamp API.
1384#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
1385pub struct CreateHillChartVersionRequestContent {
1386    /// A note about the update, as rich text (HTML).
1387    #[serde(default, skip_serializing_if = "Option::is_none")]
1388    pub description: Option<String>,
1389    /// Todolists to move, each with its ID and new position. Todolists left
1390    /// out keep their current position.
1391    #[serde(default, skip_serializing_if = "Option::is_none")]
1392    pub dots: Option<Vec<HillChartDotPosition>>,
1393    /// People to notify of the update and subscribe to it. If absent, nobody
1394    /// else is notified.
1395    #[serde(default, skip_serializing_if = "Option::is_none")]
1396    pub subscriptions: Option<Vec<i64>>,
1397}
1398
1399/// `CreateHillChartVersionResponseContent`.
1400pub type CreateHillChartVersionResponseContent = HillChartVersion;
1401
1402/// The `CreateLineupMarkerRequestContent` shape of the Basecamp API.
1403#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
1404pub struct CreateLineupMarkerRequestContent {
1405    /// `name`.
1406    pub name: String,
1407    /// `date`.
1408    pub date: String,
1409}
1410
1411/// `CreateLineupMarkerResponseContent`.
1412pub type CreateLineupMarkerResponseContent = LineupMarker;
1413
1414/// The `CreateMessageRequestContent` shape of the Basecamp API.
1415#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
1416pub struct CreateMessageRequestContent {
1417    /// `subject`.
1418    pub subject: String,
1419    /// `content`.
1420    #[serde(default, skip_serializing_if = "Option::is_none")]
1421    pub content: Option<String>,
1422    /// active|drafted
1423    #[serde(default, skip_serializing_if = "Option::is_none")]
1424    pub status: Option<String>,
1425    /// `category_id`.
1426    #[serde(default, skip_serializing_if = "Option::is_none")]
1427    pub category_id: Option<i64>,
1428    /// `subscriptions`.
1429    #[serde(default, skip_serializing_if = "Option::is_none")]
1430    pub subscriptions: Option<Vec<i64>>,
1431    /// `visible_to_clients`.
1432    #[serde(default, skip_serializing_if = "Option::is_none")]
1433    pub visible_to_clients: Option<bool>,
1434}
1435
1436/// `CreateMessageResponseContent`.
1437pub type CreateMessageResponseContent = Message;
1438
1439/// The `CreateMessageTypeRequestContent` shape of the Basecamp API.
1440#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
1441pub struct CreateMessageTypeRequestContent {
1442    /// `name`.
1443    pub name: String,
1444    /// `icon`.
1445    pub icon: String,
1446}
1447
1448/// `CreateMessageTypeResponseContent`.
1449pub type CreateMessageTypeResponseContent = MessageType;
1450
1451/// The `CreatePersonRequest` shape of the Basecamp API.
1452#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
1453pub struct CreatePersonRequest {
1454    /// `name`.
1455    pub name: String,
1456    /// `email_address`.
1457    pub email_address: String,
1458    /// `title`.
1459    #[serde(default, skip_serializing_if = "Option::is_none")]
1460    pub title: Option<String>,
1461    /// `company_name`.
1462    #[serde(default, skip_serializing_if = "Option::is_none")]
1463    pub company_name: Option<String>,
1464}
1465
1466/// The `CreatePingRequestContent` shape of the Basecamp API.
1467#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
1468pub struct CreatePingRequestContent {
1469    /// Person ids of the people to ping. People the caller cannot reach are
1470    /// dropped.
1471    pub user_ids: Vec<i64>,
1472    /// Create a new group even when a Ping with exactly these people exists.
1473    #[serde(default, skip_serializing_if = "Option::is_none")]
1474    pub new_group: Option<bool>,
1475}
1476
1477/// `CreatePingResponseContent`.
1478pub type CreatePingResponseContent = Ping;
1479
1480/// The `CreateProjectFromTemplateRequestContent` shape of the Basecamp API.
1481#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
1482pub struct CreateProjectFromTemplateRequestContent {
1483    /// `project`.
1484    pub project: ProjectConstructionAttributes,
1485}
1486
1487/// `CreateProjectFromTemplateResponseContent`.
1488pub type CreateProjectFromTemplateResponseContent = ProjectConstruction;
1489
1490/// The `CreateProjectRequestContent` shape of the Basecamp API.
1491#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
1492pub struct CreateProjectRequestContent {
1493    /// `name`.
1494    pub name: String,
1495    /// `description`.
1496    #[serde(default, skip_serializing_if = "Option::is_none")]
1497    pub description: Option<String>,
1498    /// The project's color, used for it on calendars: white, red, orange,
1499    /// yellow, green, blue, aqua, purple, gray, pink or brown. Omitted, Basecamp
1500    /// derives one from the project's name. Basecamp answers a value outside the enum
1501    /// with a server error, not a validation error.
1502    #[serde(default, skip_serializing_if = "Option::is_none")]
1503    pub color: Option<String>,
1504    /// What kind of project it is: `topic` (a regular project, the default),
1505    /// `team`, or `company_hq` (the account's Company HQ, at most one per
1506    /// account; a second answers 422). BC3's enum also has `guide`, which marks
1507    /// a project as a sample nobody can edit afterwards, so it isn't offered.
1508    #[serde(default, skip_serializing_if = "Option::is_none")]
1509    pub purpose: Option<String>,
1510    /// invite|employee|team
1511    #[serde(default, skip_serializing_if = "Option::is_none")]
1512    pub admissions: Option<String>,
1513    /// Turn on the project's timesheet. Basecamp ignores this when the caller
1514    /// can't use timesheets (the account lacks them, or the caller is a client).
1515    #[serde(default, skip_serializing_if = "Option::is_none")]
1516    pub timesheet_enabled: Option<bool>,
1517    /// How a wallpaper uploaded later is laid out. UpdateProjectWallpaper
1518    /// uploads one.
1519    #[serde(default, skip_serializing_if = "Option::is_none")]
1520    pub wallpaper_mode: Option<String>,
1521}
1522
1523/// `CreateProjectResponseContent`.
1524pub type CreateProjectResponseContent = Project;
1525
1526/// The `CreateQuestionRequestContent` shape of the Basecamp API.
1527#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
1528pub struct CreateQuestionRequestContent {
1529    /// `title`.
1530    pub title: String,
1531    /// `schedule`.
1532    pub schedule: QuestionScheduleInput,
1533    /// `visible_to_clients`.
1534    #[serde(default, skip_serializing_if = "Option::is_none")]
1535    pub visible_to_clients: Option<bool>,
1536}
1537
1538/// `CreateQuestionResponseContent`.
1539pub type CreateQuestionResponseContent = Question;
1540
1541/// The `CreateRecordingBoostRequestContent` shape of the Basecamp API.
1542#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
1543pub struct CreateRecordingBoostRequestContent {
1544    /// `content`.
1545    pub content: String,
1546}
1547
1548/// `CreateRecordingBoostResponseContent`.
1549pub type CreateRecordingBoostResponseContent = Boost;
1550
1551/// The `CreateScheduleEntryRequestContent` shape of the Basecamp API.
1552#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
1553pub struct CreateScheduleEntryRequestContent {
1554    /// `summary`.
1555    pub summary: String,
1556    /// The entry's start, as a bare date ("2026-06-01") for an all-day entry or a
1557    /// full timestamp ("2026-06-01T09:00:00Z") otherwise — the same two forms the
1558    /// response renders, and the same two ReplaceScheduleEntry accepts.
1559    ///
1560    /// Create and replace share one permit list:
1561    /// `Schedules::Entries::BaseController#base_schedule_entry_params` is what
1562    /// both `new_schedule_entry_params` and `update_schedule_entry_params` call,
1563    /// and Schedule::Entry does no format-specific parsing of either bound, so
1564    /// whatever one operation takes the other takes too.
1565    ///
1566    /// Treat the value as opaque and send it verbatim. Parsing it into a
1567    /// date-time type and re-rendering rewrites an all-day entry's bounds into
1568    /// midnight timestamps, which is why every SDK models it as a string.
1569    pub starts_at: String,
1570    /// The entry's end. See starts_at for the date-vs-timestamp rule.
1571    pub ends_at: String,
1572    /// `description`.
1573    #[serde(default, skip_serializing_if = "Option::is_none")]
1574    pub description: Option<String>,
1575    /// `participant_ids`.
1576    #[serde(default, skip_serializing_if = "Option::is_none")]
1577    pub participant_ids: Option<Vec<i64>>,
1578    /// `all_day`.
1579    #[serde(default, skip_serializing_if = "Option::is_none")]
1580    pub all_day: Option<bool>,
1581    /// `notify`.
1582    #[serde(default, skip_serializing_if = "Option::is_none")]
1583    pub notify: Option<bool>,
1584    /// The entry's join link — a video-call URL or similar, up to 2500
1585    /// characters, validated as a URL when present. A scheme-less value is
1586    /// normalized to `https://`.
1587    ///
1588    /// Spell it `url` on the way in and read it back as `join_url`: the response
1589    /// key `url` is the entry's own Basecamp API URL, written by a partial that
1590    /// renders before this field, so BC3 emits the join link under a
1591    /// non-colliding name. Sending `join_url` instead is silently dropped by
1592    /// strong parameters — the create succeeds with no join link.
1593    ///
1594    /// Accepted on create since long before it was documented:
1595    /// `Schedules::Entries::BaseController#base_schedule_entry_params` permits it
1596    /// and `new_schedule_entry_params` passes it through unchanged for API
1597    /// requests. Modeling it only on ReplaceScheduleEntry forced callers into a
1598    /// three-request read-modify-write for a field the create already took — and
1599    /// create is the notifying write, so participants learned about a video call
1600    /// before its link existed.
1601    #[serde(default, skip_serializing_if = "Option::is_none")]
1602    pub url: Option<String>,
1603    /// Whether the entry is highlighted on the schedule. Defaults to false.
1604    ///
1605    /// Do not send an explicit null: `schedule_entries.highlighted` is NOT NULL,
1606    /// so BC3 raises rather than falling back to the default. Omit it instead —
1607    /// every SDK's request compactor already drops unset members.
1608    #[serde(default, skip_serializing_if = "Option::is_none")]
1609    pub highlighted: Option<bool>,
1610    /// Publication state at creation — `active|drafted`, defaulting to `active`
1611    /// for an API create.
1612    ///
1613    /// A top-level parameter, not part of the entry's attributes: `status` is a
1614    /// Recording column, so `wrap_parameters` leaves it outside the
1615    /// `schedule_entry` envelope and `Recording::StatusParam#status_param` reads
1616    /// it directly. On create it accepts `drafted`, `active`, `archived` or
1617    /// `trashed` and raises `ActionController::BadRequest` — a 400, not a 422 —
1618    /// for anything else; the two documented values are the two worth sending.
1619    ///
1620    /// Unlike messages and documents, schedule-entry drafts are not listed by
1621    /// GetMyDrafts.
1622    #[serde(default, skip_serializing_if = "Option::is_none")]
1623    pub status: Option<String>,
1624    /// `subscriptions`.
1625    #[serde(default, skip_serializing_if = "Option::is_none")]
1626    pub subscriptions: Option<Vec<i64>>,
1627    /// `visible_to_clients`.
1628    #[serde(default, skip_serializing_if = "Option::is_none")]
1629    pub visible_to_clients: Option<bool>,
1630}
1631
1632/// `CreateScheduleEntryResponseContent`.
1633pub type CreateScheduleEntryResponseContent = ScheduleEntry;
1634
1635/// A minted stream ticket. `url` already carries the ticket in its query
1636/// string; connect to it verbatim.
1637#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
1638#[non_exhaustive]
1639pub struct CreateStreamTicketResponseContent {
1640    /// The signed ticket — an opaque bearer credential, never parsed or logged.
1641    pub ticket: SensitiveString,
1642    /// Ticket lifetime in seconds (about 120). Server-owned: expiry is arbitrated
1643    /// by the server, so mint fresh per connection rather than scheduling on it.
1644    pub expires_in: i32,
1645    /// The exact WebSocket URL to connect to, ticket included. Sensitive because
1646    /// it embeds the ticket.
1647    pub url: SensitiveString,
1648}
1649
1650/// The `CreateSubtaskRequestContent` shape of the Basecamp API.
1651#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
1652pub struct CreateSubtaskRequestContent {
1653    /// `title`.
1654    pub title: String,
1655    /// `due_on`.
1656    #[serde(default, skip_serializing_if = "Option::is_none")]
1657    pub due_on: Option<Date>,
1658    /// `assignee_ids`.
1659    #[serde(default, skip_serializing_if = "Option::is_none")]
1660    pub assignee_ids: Option<Vec<i64>>,
1661}
1662
1663/// `CreateSubtaskResponseContent`.
1664pub type CreateSubtaskResponseContent = Subtask;
1665
1666/// The `CreateTemplateLibraryCardTableRequestContent` shape of the Basecamp API.
1667#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
1668pub struct CreateTemplateLibraryCardTableRequestContent {
1669    /// The template's name. Write-only: the response carries it as `title`.
1670    pub name: String,
1671}
1672
1673/// `CreateTemplateLibraryCardTableResponseContent`.
1674pub type CreateTemplateLibraryCardTableResponseContent = CardTable;
1675
1676/// The `CreateTemplateLibraryCopyRequestContent` shape of the Basecamp API.
1677#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
1678pub struct CreateTemplateLibraryCopyRequestContent {
1679    /// The to-do list or card table in the library to copy.
1680    pub template_recording_id: i64,
1681    /// The destination project. Basecamp resolves the container from the
1682    /// template's kind, so a caller naming a project needs to know nothing about
1683    /// docks or to-do sets. Supply this or destination_parent_id; if both are
1684    /// sent, destination_parent_id wins.
1685    #[serde(default, skip_serializing_if = "Option::is_none")]
1686    pub destination_project_id: Option<i64>,
1687    /// The container to copy into, for a caller that already holds one: the
1688    /// project's to-do set for a to-do list template, or its dock for a card
1689    /// table. A caller who may not edit it gets 404, not 403.
1690    #[serde(default, skip_serializing_if = "Option::is_none")]
1691    pub destination_parent_id: Option<i64>,
1692    /// Confirm granting destination-project access to people referenced by the template.
1693    #[serde(default, skip_serializing_if = "Option::is_none")]
1694    pub adding_people_confirmed: Option<bool>,
1695}
1696
1697/// `CreateTemplateLibraryCopyResponseContent`.
1698pub type CreateTemplateLibraryCopyResponseContent = TemplateLibraryCopy;
1699
1700/// The `CreateTemplateLibraryTodolistRequestContent` shape of the Basecamp API.
1701#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
1702pub struct CreateTemplateLibraryTodolistRequestContent {
1703    /// What to call the template.
1704    pub name: String,
1705    /// Rich text describing the template.
1706    #[serde(default, skip_serializing_if = "Option::is_none")]
1707    pub description: Option<String>,
1708}
1709
1710/// `CreateTemplateLibraryTodolistResponseContent`.
1711pub type CreateTemplateLibraryTodolistResponseContent = Todolist;
1712
1713/// The `CreateTemplateRequestContent` shape of the Basecamp API.
1714#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
1715pub struct CreateTemplateRequestContent {
1716    /// `name`.
1717    pub name: String,
1718    /// `description`.
1719    #[serde(default, skip_serializing_if = "Option::is_none")]
1720    pub description: Option<String>,
1721}
1722
1723/// `CreateTemplateResponseContent`.
1724pub type CreateTemplateResponseContent = Template;
1725
1726/// The `CreateTemplatificationRequestContent` shape of the Basecamp API.
1727#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
1728pub struct CreateTemplatificationRequestContent {
1729    /// What to call the template. Defaults to the source recording's own title.
1730    #[serde(default, skip_serializing_if = "Option::is_none")]
1731    pub template_name: Option<String>,
1732    /// Carry the comments across.
1733    #[serde(default, skip_serializing_if = "Option::is_none")]
1734    pub copy_comments: Option<bool>,
1735    /// Carry assignees and the people involved across, adding them to the library
1736    /// if they are not already there.
1737    #[serde(default, skip_serializing_if = "Option::is_none")]
1738    pub copy_assignments: Option<bool>,
1739    /// Gather the cards into Triage. Card tables only, and ignored otherwise.
1740    #[serde(default, skip_serializing_if = "Option::is_none")]
1741    pub move_cards_to_triage: Option<bool>,
1742}
1743
1744/// `CreateTemplatificationResponseContent`.
1745pub type CreateTemplatificationResponseContent = Templatification;
1746
1747/// The `CreateTimesheetEntryRequestContent` shape of the Basecamp API.
1748#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
1749pub struct CreateTimesheetEntryRequestContent {
1750    /// `date`.
1751    pub date: String,
1752    /// `hours`.
1753    pub hours: String,
1754    /// `description`.
1755    #[serde(default, skip_serializing_if = "Option::is_none")]
1756    pub description: Option<String>,
1757    /// `person_id`.
1758    #[serde(default, skip_serializing_if = "Option::is_none")]
1759    pub person_id: Option<i64>,
1760}
1761
1762/// `CreateTimesheetEntryResponseContent`.
1763pub type CreateTimesheetEntryResponseContent = TimesheetEntry;
1764
1765/// The `CreateTodoRequestContent` shape of the Basecamp API.
1766#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
1767pub struct CreateTodoRequestContent {
1768    /// `content`.
1769    pub content: String,
1770    /// `description`.
1771    #[serde(default, skip_serializing_if = "Option::is_none")]
1772    pub description: Option<String>,
1773    /// `assignee_ids`.
1774    #[serde(default, skip_serializing_if = "Option::is_none")]
1775    pub assignee_ids: Option<Vec<i64>>,
1776    /// `completion_subscriber_ids`.
1777    #[serde(default, skip_serializing_if = "Option::is_none")]
1778    pub completion_subscriber_ids: Option<Vec<i64>>,
1779    /// `notify`.
1780    #[serde(default, skip_serializing_if = "Option::is_none")]
1781    pub notify: Option<bool>,
1782    /// `due_on`.
1783    #[serde(default, skip_serializing_if = "Option::is_none")]
1784    pub due_on: Option<Date>,
1785    /// `starts_on`.
1786    #[serde(default, skip_serializing_if = "Option::is_none")]
1787    pub starts_on: Option<Date>,
1788}
1789
1790/// `CreateTodoResponseContent`.
1791pub type CreateTodoResponseContent = Todo;
1792
1793/// The `CreateTodolistGroupRequestContent` shape of the Basecamp API.
1794#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
1795pub struct CreateTodolistGroupRequestContent {
1796    /// `name`.
1797    pub name: String,
1798}
1799
1800/// `CreateTodolistGroupResponseContent`.
1801pub type CreateTodolistGroupResponseContent = Todolist;
1802
1803/// The `CreateTodolistRequestContent` shape of the Basecamp API.
1804#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
1805pub struct CreateTodolistRequestContent {
1806    /// `name`.
1807    pub name: String,
1808    /// `description`.
1809    #[serde(default, skip_serializing_if = "Option::is_none")]
1810    pub description: Option<String>,
1811    /// `visible_to_clients`.
1812    #[serde(default, skip_serializing_if = "Option::is_none")]
1813    pub visible_to_clients: Option<bool>,
1814}
1815
1816/// `CreateTodolistResponseContent`.
1817pub type CreateTodolistResponseContent = Todolist;
1818
1819/// The `CreateTodosetTodoRequestContent` shape of the Basecamp API.
1820#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
1821pub struct CreateTodosetTodoRequestContent {
1822    /// `content`.
1823    pub content: String,
1824    /// `description`.
1825    #[serde(default, skip_serializing_if = "Option::is_none")]
1826    pub description: Option<String>,
1827    /// `assignee_ids`.
1828    #[serde(default, skip_serializing_if = "Option::is_none")]
1829    pub assignee_ids: Option<Vec<i64>>,
1830    /// `completion_subscriber_ids`.
1831    #[serde(default, skip_serializing_if = "Option::is_none")]
1832    pub completion_subscriber_ids: Option<Vec<i64>>,
1833    /// `notify`.
1834    #[serde(default, skip_serializing_if = "Option::is_none")]
1835    pub notify: Option<bool>,
1836    /// `due_on`.
1837    #[serde(default, skip_serializing_if = "Option::is_none")]
1838    pub due_on: Option<Date>,
1839    /// `starts_on`.
1840    #[serde(default, skip_serializing_if = "Option::is_none")]
1841    pub starts_on: Option<Date>,
1842}
1843
1844/// `CreateTodosetTodoResponseContent`.
1845pub type CreateTodosetTodoResponseContent = Todo;
1846
1847/// The `CreateToolRequestContent` shape of the Basecamp API.
1848#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
1849pub struct CreateToolRequestContent {
1850    /// Tool type to add to the project dock. Values: Chat::Transcript|Inbox|Kanban::Board|Message::Board|Questionnaire|Schedule|Todoset|Vault.
1851    pub tool_type: String,
1852    /// Title for the new tool. When omitted, Basecamp assigns the next available default title for the tool type.
1853    #[serde(default, skip_serializing_if = "Option::is_none")]
1854    pub title: Option<String>,
1855    /// Create the tool already visible to clients. Honored only for tool types that manage their own client visibility (Chat::Transcript, Kanban::Board), which otherwise start hidden; every other tool type ignores it and inherits the project default.
1856    #[serde(default, skip_serializing_if = "Option::is_none")]
1857    pub visible_to_clients: Option<bool>,
1858}
1859
1860/// `CreateToolResponseContent`.
1861pub type CreateToolResponseContent = Tool;
1862
1863/// The `CreateUploadRequestContent` shape of the Basecamp API.
1864#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
1865pub struct CreateUploadRequestContent {
1866    /// `attachable_sgid`.
1867    pub attachable_sgid: String,
1868    /// `description`.
1869    #[serde(default, skip_serializing_if = "Option::is_none")]
1870    pub description: Option<String>,
1871    /// `base_name`.
1872    #[serde(default, skip_serializing_if = "Option::is_none")]
1873    pub base_name: Option<String>,
1874    /// `subscriptions`.
1875    #[serde(default, skip_serializing_if = "Option::is_none")]
1876    pub subscriptions: Option<Vec<i64>>,
1877    /// `visible_to_clients`.
1878    #[serde(default, skip_serializing_if = "Option::is_none")]
1879    pub visible_to_clients: Option<bool>,
1880}
1881
1882/// `CreateUploadResponseContent`.
1883pub type CreateUploadResponseContent = Upload;
1884
1885/// The `CreateUploadVersionRequestContent` shape of the Basecamp API.
1886#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
1887pub struct CreateUploadVersionRequestContent {
1888    /// `attachable_sgid`.
1889    pub attachable_sgid: String,
1890    /// Omit to keep the uploaded file's own name. Sending "" also keeps it.
1891    #[serde(default, skip_serializing_if = "Option::is_none")]
1892    pub base_name: Option<String>,
1893    /// Presence-aware: omit to carry the previous version's description forward,
1894    /// send "" to clear it, send a value to set it.
1895    #[serde(default, skip_serializing_if = "Option::is_none")]
1896    pub description: Option<String>,
1897    /// Who to notify: "default", "everyone", or "custom" (the people in subscriptions).
1898    ///
1899    /// Omit both this and subscriptions to notify nobody. A subscriptions array sent
1900    /// without notify is read as "custom".
1901    #[serde(default, skip_serializing_if = "Option::is_none")]
1902    pub notify: Option<String>,
1903    /// People to notify about the replacement and subscribe to the upload.
1904    #[serde(default, skip_serializing_if = "Option::is_none")]
1905    pub subscriptions: Option<Vec<i64>>,
1906}
1907
1908/// `CreateUploadVersionResponseContent`.
1909pub type CreateUploadVersionResponseContent = Upload;
1910
1911/// The `CreateVaultRequestContent` shape of the Basecamp API.
1912#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
1913pub struct CreateVaultRequestContent {
1914    /// `title`.
1915    pub title: String,
1916}
1917
1918/// `CreateVaultResponseContent`.
1919pub type CreateVaultResponseContent = Vault;
1920
1921/// The `CreateWebhookRequestContent` shape of the Basecamp API.
1922#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
1923pub struct CreateWebhookRequestContent {
1924    /// `payload_url`.
1925    pub payload_url: String,
1926    /// `types`.
1927    pub types: Vec<String>,
1928    /// `active`.
1929    #[serde(default, skip_serializing_if = "Option::is_none")]
1930    pub active: Option<bool>,
1931}
1932
1933/// `CreateWebhookResponseContent`.
1934pub type CreateWebhookResponseContent = Webhook;
1935
1936/// The `CreateWormholeRequestContent` shape of the Basecamp API.
1937#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
1938pub struct CreateWormholeRequestContent {
1939    /// Id of the destination column (on another accessible card table) to link to.
1940    pub destination_recording_id: i64,
1941}
1942
1943/// `CreateWormholeResponseContent`.
1944pub type CreateWormholeResponseContent = Wormhole;
1945
1946/// `DisableCardColumnOnHoldResponseContent`.
1947pub type DisableCardColumnOnHoldResponseContent = CardColumn;
1948
1949/// `DisableProjectClientsResponseContent`.
1950pub type DisableProjectClientsResponseContent = ProjectClientEnablement;
1951
1952/// The `DockItem` shape of the Basecamp API.
1953#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
1954#[non_exhaustive]
1955pub struct DockItem {
1956    /// `id`.
1957    pub id: i64,
1958    /// `title`.
1959    pub title: String,
1960    /// `name`.
1961    pub name: String,
1962    /// `enabled`.
1963    pub enabled: bool,
1964    /// `position`.
1965    #[serde(default, skip_serializing_if = "Option::is_none")]
1966    pub position: Option<i32>,
1967    /// `url`.
1968    pub url: String,
1969    /// `app_url`.
1970    pub app_url: String,
1971}
1972
1973/// The `Document` shape of the Basecamp API.
1974#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
1975#[non_exhaustive]
1976pub struct Document {
1977    /// `id`.
1978    pub id: i64,
1979    /// `status`.
1980    pub status: String,
1981    /// `visible_to_clients`.
1982    pub visible_to_clients: bool,
1983    /// `created_at`.
1984    pub created_at: DateTime,
1985    /// `updated_at`.
1986    pub updated_at: DateTime,
1987    /// `title`.
1988    pub title: String,
1989    /// `inherits_status`.
1990    pub inherits_status: bool,
1991    /// `type`.
1992    pub r#type: String,
1993    /// `url`.
1994    pub url: String,
1995    /// `app_url`.
1996    pub app_url: String,
1997    /// `bookmark_url`.
1998    #[serde(default, skip_serializing_if = "Option::is_none")]
1999    pub bookmark_url: Option<String>,
2000    /// `subscription_url`.
2001    #[serde(default, skip_serializing_if = "Option::is_none")]
2002    pub subscription_url: Option<String>,
2003    /// `comments_count`.
2004    #[serde(default, skip_serializing_if = "Option::is_none")]
2005    pub comments_count: Option<i32>,
2006    /// `comments_url`.
2007    #[serde(default, skip_serializing_if = "Option::is_none")]
2008    pub comments_url: Option<String>,
2009    /// `position`.
2010    #[serde(default, skip_serializing_if = "Option::is_none")]
2011    pub position: Option<i32>,
2012    /// `parent`.
2013    pub parent: RecordingParent,
2014    /// `bucket`.
2015    pub bucket: TodoBucket,
2016    /// `creator`.
2017    pub creator: Person,
2018    /// `content`.
2019    #[serde(default, skip_serializing_if = "Option::is_none")]
2020    pub content: Option<String>,
2021    /// `content_attachments`.
2022    pub content_attachments: Vec<RichTextAttachment>,
2023    /// `boosts_count`.
2024    #[serde(default, skip_serializing_if = "Option::is_none")]
2025    pub boosts_count: Option<i32>,
2026    /// `boosts_url`.
2027    #[serde(default, skip_serializing_if = "Option::is_none")]
2028    pub boosts_url: Option<String>,
2029}
2030
2031/// An external link (`Door` recording), as ListDoors, GetDoor, CreateDoor and
2032/// UpdateDoor render it: the shared recording envelope plus the outside `url`,
2033/// the `service` struct and `description`. Docked, so it carries no `parent`.
2034#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
2035#[non_exhaustive]
2036pub struct Door {
2037    /// `id`.
2038    pub id: i64,
2039    /// `status`.
2040    pub status: String,
2041    /// `visible_to_clients`.
2042    pub visible_to_clients: bool,
2043    /// `created_at`.
2044    pub created_at: DateTime,
2045    /// `updated_at`.
2046    pub updated_at: DateTime,
2047    /// `title`.
2048    pub title: String,
2049    /// `inherits_status`.
2050    pub inherits_status: bool,
2051    /// `type`.
2052    pub r#type: String,
2053    /// The external link's outside address (e.g. the Figma URL) — NOT this
2054    /// record's API URL. The door partial renders the shared recording partial
2055    /// and then `json.(recording.recordable, :url, :service, :description)`,
2056    /// which overwrites the recording's url key. `app_url` is still this record's
2057    /// Basecamp URL (a redirector to the outside address).
2058    pub url: String,
2059    /// `app_url`.
2060    pub app_url: String,
2061    /// `bookmark_url`.
2062    #[serde(default, skip_serializing_if = "Option::is_none")]
2063    pub bookmark_url: Option<String>,
2064    /// `subscription_url`.
2065    #[serde(default, skip_serializing_if = "Option::is_none")]
2066    pub subscription_url: Option<String>,
2067    /// Ordinal position within the project's External links section.
2068    #[serde(default, skip_serializing_if = "Option::is_none")]
2069    pub position: Option<i32>,
2070    /// `bucket`.
2071    pub bucket: RecordingBucket,
2072    /// `creator`.
2073    pub creator: Person,
2074    /// `service`.
2075    pub service: DoorService,
2076    /// Rich-text (HTML) description shown beneath the link.
2077    #[serde(default, skip_serializing_if = "Option::is_none")]
2078    pub description: Option<String>,
2079}
2080
2081/// Metadata describing the recognized external service backing an external link
2082/// (`Door` recording): its display name, a canonical example URL, a short code,
2083/// the URL patterns Basecamp recognizes for it, and human supporting text. `code`
2084/// is `other` for a generic link.
2085#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
2086#[non_exhaustive]
2087pub struct DoorService {
2088    /// `name`.
2089    #[serde(default, skip_serializing_if = "Option::is_none")]
2090    pub name: Option<String>,
2091    /// `example_url`.
2092    #[serde(default, skip_serializing_if = "Option::is_none")]
2093    pub example_url: Option<String>,
2094    /// `code`.
2095    #[serde(default, skip_serializing_if = "Option::is_none")]
2096    pub code: Option<String>,
2097    /// `valid_patterns`.
2098    #[serde(default, skip_serializing_if = "Option::is_none")]
2099    pub valid_patterns: Option<Vec<String>>,
2100    /// `supporting_text`.
2101    #[serde(default, skip_serializing_if = "Option::is_none")]
2102    pub supporting_text: Option<String>,
2103}
2104
2105/// A draft envelope: a message, document, upload, or client approval/
2106/// correspondence saved but not yet published. Flat and purpose-built —
2107/// NOT the shared recording projection.
2108#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
2109#[non_exhaustive]
2110pub struct Draft {
2111    /// `id`.
2112    pub id: i64,
2113    /// `app_url`.
2114    pub app_url: String,
2115    /// `title`.
2116    pub title: String,
2117    /// Short recordable name: message, document, upload, client_approval,
2118    /// or client_correspondence.
2119    pub r#type: String,
2120    /// `bucket`.
2121    pub bucket: DraftBucket,
2122    /// `parent`.
2123    #[serde(deserialize_with = "serde::Deserialize::deserialize")]
2124    pub parent: Option<DraftParent>,
2125    /// Up to 300 characters of plain text; empty string when the draft has no body.
2126    pub excerpt: String,
2127    /// `created_at`.
2128    pub created_at: DateTime,
2129    /// `updated_at`.
2130    pub updated_at: DateTime,
2131    /// Always present; `null` unless the draft is scheduled to publish later.
2132    /// Required-presence with nullable value, like `parent`.
2133    #[serde(deserialize_with = "serde::Deserialize::deserialize")]
2134    pub scheduled_posting_at: Option<DateTime>,
2135}
2136
2137/// The project a draft lives in (drafts-specific projection: id, name, app_url).
2138#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
2139#[non_exhaustive]
2140pub struct DraftBucket {
2141    /// `id`.
2142    pub id: i64,
2143    /// `name`.
2144    pub name: String,
2145    /// `app_url`.
2146    pub app_url: String,
2147}
2148
2149/// The parent recording a draft is filed under (id, title, app_url).
2150#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
2151#[non_exhaustive]
2152pub struct DraftParent {
2153    /// `id`.
2154    pub id: i64,
2155    /// `title`.
2156    pub title: String,
2157    /// `app_url`.
2158    pub app_url: String,
2159}
2160
2161/// Content from another site, such as a YouTube video, that rich text shows
2162/// inline. Put it in rich text as `\<bc-attachment sgid="SGID"\>\</bc-attachment\>`
2163/// once its status is `active`; an embed that is not active shows as a link to
2164/// its URL.
2165#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
2166#[non_exhaustive]
2167pub struct Embed {
2168    /// `url`.
2169    pub url: String,
2170    /// `pending` while Basecamp asks the provider about the URL, then `active`,
2171    /// or `not_found` when the provider has nothing to embed.
2172    pub status: String,
2173    /// An embed's signed global id, an opaque string.
2174    pub sgid: String,
2175    /// The provider's oEmbed type, such as `video`, `rich` or `photo`. Present
2176    /// only when the embed is active.
2177    #[serde(default, skip_serializing_if = "Option::is_none")]
2178    pub r#type: Option<String>,
2179    /// Such as `embed/youtube-video`. Present only when the embed is active.
2180    #[serde(default, skip_serializing_if = "Option::is_none")]
2181    pub content_type: Option<String>,
2182    /// Present only when the embed is active, and null when the provider gave no
2183    /// image.
2184    #[serde(default, skip_serializing_if = "Option::is_none")]
2185    pub image_url: Option<String>,
2186    /// The provider's HTML, sanitized. Present only when the embed is active and
2187    /// the provider gave HTML; may be empty.
2188    #[serde(default, skip_serializing_if = "Option::is_none")]
2189    pub content: Option<String>,
2190}
2191
2192/// `EnableCardColumnOnHoldResponseContent`.
2193pub type EnableCardColumnOnHoldResponseContent = CardColumn;
2194
2195/// The `EnableOutOfOfficeRequestContent` shape of the Basecamp API.
2196#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
2197pub struct EnableOutOfOfficeRequestContent {
2198    /// `out_of_office`.
2199    pub out_of_office: OutOfOfficePayload,
2200}
2201
2202/// `EnableOutOfOfficeResponseContent`.
2203pub type EnableOutOfOfficeResponseContent = OutOfOffice;
2204
2205/// `EnableProjectClientsResponseContent`.
2206pub type EnableProjectClientsResponseContent = ProjectClientEnablement;
2207
2208/// The `Event` shape of the Basecamp API.
2209#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
2210#[non_exhaustive]
2211pub struct Event {
2212    /// `id`.
2213    pub id: i64,
2214    /// `recording_id`.
2215    pub recording_id: i64,
2216    /// `action`.
2217    pub action: String,
2218    /// `details`.
2219    #[serde(default, skip_serializing_if = "Option::is_none")]
2220    pub details: Option<EventDetails>,
2221    /// `created_at`.
2222    pub created_at: DateTime,
2223    /// `creator`.
2224    pub creator: Person,
2225    /// `performed_by`.
2226    #[serde(default, skip_serializing_if = "Option::is_none")]
2227    pub performed_by: Option<Person>,
2228    /// Present only on boostable events (action completed, adopted,
2229    /// column_changed or moved_in); the event boost operations refuse any
2230    /// other event with 403.
2231    #[serde(default, skip_serializing_if = "Option::is_none")]
2232    pub boosts_count: Option<i32>,
2233    /// Present only on boostable events; see boosts_count.
2234    #[serde(default, skip_serializing_if = "Option::is_none")]
2235    pub boosts_url: Option<String>,
2236}
2237
2238/// The `EventDetails` shape of the Basecamp API.
2239#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
2240#[non_exhaustive]
2241pub struct EventDetails {
2242    /// `added_person_ids`.
2243    #[serde(default, skip_serializing_if = "Option::is_none")]
2244    pub added_person_ids: Option<Vec<i64>>,
2245    /// `removed_person_ids`.
2246    #[serde(default, skip_serializing_if = "Option::is_none")]
2247    pub removed_person_ids: Option<Vec<i64>>,
2248    /// `notified_recipient_ids`.
2249    #[serde(default, skip_serializing_if = "Option::is_none")]
2250    pub notified_recipient_ids: Option<Vec<i64>>,
2251}
2252
2253/// A single item in the /files.json feed. An optional-field superset over three
2254/// wire variants — a full Upload recording, a Basecamp Document recording, and a
2255/// rich-text attachment wrapped in a recording envelope (distinguished by
2256/// `attachable_sgid` and blob metadata). Every field is optional; a given
2257/// instance populates only the fields of the variant it represents. Unknown
2258/// fields are ignored by every SDK decoder, so the superset need not enumerate
2259/// every field of the Upload/Document recordings.
2260#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
2261#[non_exhaustive]
2262pub struct EverythingFile {
2263    /// Recording (Upload/Document) or attachment id.
2264    #[serde(default, skip_serializing_if = "Option::is_none")]
2265    pub id: Option<i64>,
2266    /// `status`.
2267    #[serde(default, skip_serializing_if = "Option::is_none")]
2268    pub status: Option<String>,
2269    /// `visible_to_clients`.
2270    #[serde(default, skip_serializing_if = "Option::is_none")]
2271    pub visible_to_clients: Option<bool>,
2272    /// `created_at`.
2273    #[serde(default, skip_serializing_if = "Option::is_none")]
2274    pub created_at: Option<DateTime>,
2275    /// `updated_at`.
2276    #[serde(default, skip_serializing_if = "Option::is_none")]
2277    pub updated_at: Option<DateTime>,
2278    /// `title`.
2279    #[serde(default, skip_serializing_if = "Option::is_none")]
2280    pub title: Option<String>,
2281    /// `inherits_status`.
2282    #[serde(default, skip_serializing_if = "Option::is_none")]
2283    pub inherits_status: Option<bool>,
2284    /// "Upload", "Document", or "Attachment".
2285    #[serde(default, skip_serializing_if = "Option::is_none")]
2286    pub r#type: Option<String>,
2287    /// `url`.
2288    #[serde(default, skip_serializing_if = "Option::is_none")]
2289    pub url: Option<String>,
2290    /// `app_url`.
2291    #[serde(default, skip_serializing_if = "Option::is_none")]
2292    pub app_url: Option<String>,
2293    /// `bookmark_url`.
2294    #[serde(default, skip_serializing_if = "Option::is_none")]
2295    pub bookmark_url: Option<String>,
2296    /// `subscription_url`.
2297    #[serde(default, skip_serializing_if = "Option::is_none")]
2298    pub subscription_url: Option<String>,
2299    /// `comments_count`.
2300    #[serde(default, skip_serializing_if = "Option::is_none")]
2301    pub comments_count: Option<i32>,
2302    /// `comments_url`.
2303    #[serde(default, skip_serializing_if = "Option::is_none")]
2304    pub comments_url: Option<String>,
2305    /// `boosts_count`.
2306    #[serde(default, skip_serializing_if = "Option::is_none")]
2307    pub boosts_count: Option<i32>,
2308    /// `boosts_url`.
2309    #[serde(default, skip_serializing_if = "Option::is_none")]
2310    pub boosts_url: Option<String>,
2311    /// `position`.
2312    #[serde(default, skip_serializing_if = "Option::is_none")]
2313    pub position: Option<i32>,
2314    /// `parent`.
2315    #[serde(default, skip_serializing_if = "Option::is_none")]
2316    pub parent: Option<RecordingParent>,
2317    /// `bucket`.
2318    #[serde(default, skip_serializing_if = "Option::is_none")]
2319    pub bucket: Option<RecordingBucket>,
2320    /// `creator`.
2321    #[serde(default, skip_serializing_if = "Option::is_none")]
2322    pub creator: Option<Person>,
2323    /// Present on the rich-text attachment variant: signed global id of the
2324    /// attachment (uploads/documents omit it).
2325    #[serde(default, skip_serializing_if = "Option::is_none")]
2326    pub attachable_sgid: Option<String>,
2327    /// `content_type`.
2328    #[serde(default, skip_serializing_if = "Option::is_none")]
2329    pub content_type: Option<String>,
2330    /// `byte_size`.
2331    #[serde(default, skip_serializing_if = "Option::is_none")]
2332    pub byte_size: Option<i64>,
2333    /// `filename`.
2334    #[serde(default, skip_serializing_if = "Option::is_none")]
2335    pub filename: Option<String>,
2336    /// `download_url`.
2337    #[serde(default, skip_serializing_if = "Option::is_none")]
2338    pub download_url: Option<AuthRoutableUrl>,
2339    /// `app_download_url`.
2340    #[serde(default, skip_serializing_if = "Option::is_none")]
2341    pub app_download_url: Option<String>,
2342    /// Pixel width; null for non-image blobs and may be float-spelled (1024.0).
2343    #[serde(
2344        default,
2345        deserialize_with = "crate::types::flex_int::deserialize",
2346        skip_serializing_if = "Option::is_none"
2347    )]
2348    pub width: Option<i32>,
2349    /// Pixel height; null for non-image blobs and may be float-spelled (1024.0).
2350    #[serde(
2351        default,
2352        deserialize_with = "crate::types::flex_int::deserialize",
2353        skip_serializing_if = "Option::is_none"
2354    )]
2355    pub height: Option<i32>,
2356    /// Rich-text description (upload/document variants).
2357    #[serde(default, skip_serializing_if = "Option::is_none")]
2358    pub description: Option<String>,
2359    /// `description_attachments`.
2360    #[serde(default, skip_serializing_if = "Option::is_none")]
2361    pub description_attachments: Option<Vec<RichTextAttachment>>,
2362    /// Rich-text body of the Document variant (uploads/attachments omit it).
2363    #[serde(default, skip_serializing_if = "Option::is_none")]
2364    pub content: Option<String>,
2365    /// `content_attachments`.
2366    #[serde(default, skip_serializing_if = "Option::is_none")]
2367    pub content_attachments: Option<Vec<RichTextAttachment>>,
2368}
2369
2370/// One feed row: a thin pointer, not resource state. Refetch the referenced
2371/// recording through the canonical resource APIs before acting on it. The same
2372/// shape rides the inbox (`InboxItem.event`) and, with two transport-only
2373/// extras, the live stream.
2374#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
2375#[non_exhaustive]
2376pub struct FeedEvent {
2377    /// Feed-global event id; the poll lane serves ids in strict ascending order.
2378    pub id: i64,
2379    /// Event kind (e.g. `message_created`).
2380    pub kind: String,
2381    /// The action that produced the event (e.g. `created`).
2382    pub action: String,
2383    /// Cataloged event type (e.g. `message.created`). Only cataloged types are served.
2384    pub event_type: String,
2385    /// The bucket (project or circle) the recording lives in.
2386    pub bucket_id: i64,
2387    /// The person the action is attributed to.
2388    pub creator_id: i64,
2389    /// The agent that carried out a delegated action; `null` on the wire when the
2390    /// action was performed directly. The effective performer — used by the
2391    /// `performers`/`exclude_performers` filters — is this when present, else
2392    /// `creator_id`.
2393    #[serde(default, skip_serializing_if = "Option::is_none")]
2394    pub performed_by_id: Option<i64>,
2395    /// The recording the event references.
2396    pub recording_id: i64,
2397    /// `created_at`.
2398    pub created_at: DateTime,
2399    /// Type-specific details, carried verbatim as a JSON document — present only
2400    /// for the types that publish one, absent (not empty) for every other type.
2401    /// `boost.created` publishes `boost_id`, plus `boosted_event_id` and
2402    /// `boosted_event_type`, both `null` for a boost on the recording itself
2403    /// (`boosted_event_type` also `null` when the boosted event's kind is not
2404    /// cataloged); `card.moved` publishes `column_id` and `previous_column_id`,
2405    /// the containing columns (going on hold within a column reports the same
2406    /// column twice). Verbatim on purpose: the connector's push lane delivers
2407    /// the same object, and a typed projection would drop explicit nulls and
2408    /// any member a newly cataloged type adds, making the two lanes disagree.
2409    /// Go carries it as `json.RawMessage`; TypeScript `unknown`; Python `Any`;
2410    /// Ruby a Hash; Kotlin `JsonElement`; Rust `serde_json::Value`; Swift the
2411    /// SDK's `JSONValue` (numbers as `Double`).
2412    #[serde(default, skip_serializing_if = "Option::is_none")]
2413    pub details: Option<serde_json::Value>,
2414}
2415
2416/// 409 from the event feed's poll lanes (PollEvents, PollInbox): the held
2417/// `position` was minted for a different filter set than the request presented.
2418/// Positions are bound to their filter set; re-enter with `since=\<id\>` or
2419/// `since=now` to acknowledge the filter change. Both digests are the bare
2420/// 16-lowercase-hex `srv2` filter digest BC3 publishes in
2421/// doc/api/sections/event_feed.md ("Filter digests").
2422#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
2423#[non_exhaustive]
2424pub struct FeedFilterMismatchErrorResponseContent {
2425    /// `error`.
2426    pub error: String,
2427    /// The digest of the filter set the position was minted for.
2428    pub position_digest: String,
2429    /// The digest of the filter set this request presented.
2430    pub filters_digest: String,
2431}
2432
2433/// 410 from PollEvents: the held `position` predates the feed's epoch — an
2434/// operational fence that can be raised. `epoch_after_id` names the epoch and
2435/// `resume` is an absolute URL that re-enters the feed AT THE EPOCH
2436/// (`since=\<epoch_after_id\>`) with the request's canonical filters preserved,
2437/// so the servable history above the fence is not skipped. Not interchangeable
2438/// with the inbox's InboxPositionGoneError, whose recovery re-enters at
2439/// `since=0`. Consumers validate the URL (same origin as the API base, no scheme
2440/// downgrade) before following it — SPEC.md §23 "Continuation and Resume URL
2441/// Validation".
2442#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
2443#[non_exhaustive]
2444pub struct FeedPositionGoneErrorResponseContent {
2445    /// `error`.
2446    pub error: String,
2447    /// The feed's epoch: the event id after which history is servable.
2448    pub epoch_after_id: i64,
2449    /// Absolute re-entry URL for the feed, at the epoch, filters preserved.
2450    pub resume: String,
2451}
2452
2453/// 400 from the event feed's poll lanes (PollEvents, PollInbox). Two distinct
2454/// cases share the status: a malformed `position` (recover by re-entering with
2455/// `since=`) and a malformed filter (fix the filters; a position reset will not
2456/// help). `reason` tells them apart — `invalid_position` or `invalid_filter`
2457/// (bc3 #13362) — and is OPTIONAL: a server that has not shipped it answers the
2458/// flat `{error}` body, and a consumer that finds `reason` absent must treat the
2459/// 400 as undifferentiated and surface it rather than guess between recovering
2460/// and stopping.
2461#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
2462#[non_exhaustive]
2463pub struct FeedRequestErrorResponseContent {
2464    /// `error`.
2465    pub error: String,
2466    /// `invalid_position` (re-enter with `since=`) or `invalid_filter` (fix the
2467    /// filters). Absent from servers that predate bc3 #13362: then the 400 is
2468    /// undifferentiated.
2469    #[serde(default, skip_serializing_if = "Option::is_none")]
2470    pub reason: Option<String>,
2471}
2472
2473/// `FieldErrorMap`.
2474pub type FieldErrorMap = BTreeMap<String, Vec<String>>;
2475
2476/// The field-keyed 422 body: {"errors": {"color": \["is not a valid color"\]}}.
2477#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
2478#[non_exhaustive]
2479pub struct FieldKeyedErrors {
2480    /// `errors`.
2481    pub errors: FieldErrorMap,
2482}
2483
2484/// `FieldValidationErrorResponseContent`.
2485pub type FieldValidationErrorResponseContent = FieldKeyedErrors;
2486
2487/// A move or copy of a recording into another project, as MoveRecording,
2488/// CopyRecording and GetFiling answer it.
2489#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
2490#[non_exhaustive]
2491pub struct Filing {
2492    /// `id`.
2493    pub id: i64,
2494    /// pending|processing|completed|failed
2495    pub status: String,
2496    /// Move|Copy
2497    pub r#type: String,
2498    /// `source_recording_id`.
2499    pub source_recording_id: i64,
2500    /// The filing's own API URL, for polling.
2501    pub url: String,
2502    /// `destination_recording`.
2503    #[serde(default, skip_serializing_if = "Option::is_none")]
2504    pub destination_recording: Option<FilingDestinationRecording>,
2505}
2506
2507/// The `FilingDestinationRecording` shape of the Basecamp API.
2508#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
2509#[non_exhaustive]
2510pub struct FilingDestinationRecording {
2511    /// `id`.
2512    pub id: i64,
2513    /// The recordable type, such as `Kanban::Card`, `Todo` or `Message`.
2514    pub r#type: String,
2515    /// `url`.
2516    pub url: String,
2517    /// `app_url`.
2518    pub app_url: String,
2519}
2520
2521/// The `FirstWeekDay` values the Basecamp API declares.
2522#[derive(Debug, Clone, PartialEq, Eq, Hash, Default)]
2523#[non_exhaustive]
2524pub enum FirstWeekDay {
2525    #[default]
2526    /// `Sunday`.
2527    Sunday,
2528    /// `Monday`.
2529    Monday,
2530    /// `Tuesday`.
2531    Tuesday,
2532    /// `Wednesday`.
2533    Wednesday,
2534    /// `Thursday`.
2535    Thursday,
2536    /// `Friday`.
2537    Friday,
2538    /// `Saturday`.
2539    Saturday,
2540    /// A value this SDK does not know, kept as the API sent it so a read-modify-write
2541    /// round-trips it.
2542    Unknown(String),
2543}
2544
2545impl FirstWeekDay {
2546    /// The value as the API spells it.
2547    pub fn as_str(&self) -> &str {
2548        match self {
2549            FirstWeekDay::Sunday => "Sunday",
2550            FirstWeekDay::Monday => "Monday",
2551            FirstWeekDay::Tuesday => "Tuesday",
2552            FirstWeekDay::Wednesday => "Wednesday",
2553            FirstWeekDay::Thursday => "Thursday",
2554            FirstWeekDay::Friday => "Friday",
2555            FirstWeekDay::Saturday => "Saturday",
2556            FirstWeekDay::Unknown(value) => value,
2557        }
2558    }
2559}
2560
2561impl From<&str> for FirstWeekDay {
2562    fn from(value: &str) -> Self {
2563        match value {
2564            "Sunday" => FirstWeekDay::Sunday,
2565            "Monday" => FirstWeekDay::Monday,
2566            "Tuesday" => FirstWeekDay::Tuesday,
2567            "Wednesday" => FirstWeekDay::Wednesday,
2568            "Thursday" => FirstWeekDay::Thursday,
2569            "Friday" => FirstWeekDay::Friday,
2570            "Saturday" => FirstWeekDay::Saturday,
2571            other => FirstWeekDay::Unknown(other.to_string()),
2572        }
2573    }
2574}
2575
2576impl std::fmt::Display for FirstWeekDay {
2577    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
2578        f.write_str(self.as_str())
2579    }
2580}
2581
2582impl Serialize for FirstWeekDay {
2583    fn serialize<S: serde::Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error> {
2584        serializer.serialize_str(self.as_str())
2585    }
2586}
2587
2588impl<'de> Deserialize<'de> for FirstWeekDay {
2589    fn deserialize<D: serde::Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error> {
2590        let value = String::deserialize(deserializer)?;
2591        Ok(Self::from(value.as_str()))
2592    }
2593}
2594
2595/// A folder as the list returns it: the base shape, without expanded projects.
2596///
2597/// Deliberately distinct from FolderWithProjects. A single shape with an
2598/// optional `projects` member would make every list item declare a field the
2599/// list response never populates.
2600#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
2601#[non_exhaustive]
2602pub struct Folder {
2603    /// `id`.
2604    pub id: i64,
2605    /// `name`.
2606    pub name: String,
2607    /// Always the string `Stack` — the wire type kept its pre-rename name.
2608    pub r#type: String,
2609    /// `created_at`.
2610    pub created_at: DateTime,
2611    /// `updated_at`.
2612    pub updated_at: DateTime,
2613    /// IDs of the projects filed into this folder. Same ids as `project_ids` on
2614    /// create, and the ids FolderWithProjects expands under `projects`.
2615    pub bucket_ids: Vec<i64>,
2616    /// `is_emoji_only_name`.
2617    pub is_emoji_only_name: bool,
2618    /// `star_url`.
2619    pub star_url: String,
2620    /// Gauges URL covering this folder's projects; always emitted, `null` when
2621    /// none of them is gauged. `@required` models the presence — the nullability
2622    /// is layered on in the OpenAPI (smithy-build.json jsonAdd -\> type:
2623    /// \["string","null"\]), so Go types it *string because the value is nullable,
2624    /// not because the key is optional.
2625    #[serde(deserialize_with = "serde::Deserialize::deserialize")]
2626    pub gauges_url: Option<String>,
2627    /// The viewer's colour customization for this folder; always emitted, `null`
2628    /// when unset. Required-and-nullable, like gauges_url.
2629    #[serde(deserialize_with = "serde::Deserialize::deserialize")]
2630    pub color: Option<String>,
2631    /// The viewer's folder image; always emitted, `null` when unset. Read-only:
2632    /// there is no image create or update in v1. Required-and-nullable, like
2633    /// gauges_url.
2634    #[serde(deserialize_with = "serde::Deserialize::deserialize")]
2635    pub image_url: Option<String>,
2636    /// `url`.
2637    pub url: String,
2638}
2639
2640/// One folder plus the projects grouped inside it, as get/create/update return it.
2641///
2642/// The `projects` entries are the shared project projection, minus the
2643/// `bookmarked` flag that only the projects index adds.
2644#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
2645#[non_exhaustive]
2646pub struct FolderWithProjects {
2647    /// `id`.
2648    pub id: i64,
2649    /// `name`.
2650    pub name: String,
2651    /// Always the string `Stack` — the wire type kept its pre-rename name.
2652    pub r#type: String,
2653    /// `created_at`.
2654    pub created_at: DateTime,
2655    /// `updated_at`.
2656    pub updated_at: DateTime,
2657    /// IDs of the projects filed into this folder — the same set `projects`
2658    /// expands.
2659    pub bucket_ids: Vec<i64>,
2660    /// `is_emoji_only_name`.
2661    pub is_emoji_only_name: bool,
2662    /// `star_url`.
2663    pub star_url: String,
2664    /// Gauges URL covering this folder's projects; always emitted, `null` when
2665    /// none of them is gauged. Required-and-nullable (see Folder.gauges_url).
2666    #[serde(deserialize_with = "serde::Deserialize::deserialize")]
2667    pub gauges_url: Option<String>,
2668    /// The viewer's colour customization for this folder; always emitted, `null`
2669    /// when unset. Required-and-nullable.
2670    #[serde(deserialize_with = "serde::Deserialize::deserialize")]
2671    pub color: Option<String>,
2672    /// The viewer's folder image; always emitted, `null` when unset. Read-only.
2673    /// Required-and-nullable.
2674    #[serde(deserialize_with = "serde::Deserialize::deserialize")]
2675    pub image_url: Option<String>,
2676    /// `url`.
2677    pub url: String,
2678    /// The projects filed into this folder, expanded. Always emitted; empty for
2679    /// an empty folder.
2680    pub projects: Vec<Project>,
2681}
2682
2683/// The `ForbiddenErrorResponseContent` shape of the Basecamp API.
2684#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
2685#[non_exhaustive]
2686pub struct ForbiddenErrorResponseContent {
2687    /// `error`.
2688    pub error: String,
2689    /// `message`.
2690    #[serde(default, skip_serializing_if = "Option::is_none")]
2691    pub message: Option<String>,
2692}
2693
2694/// The `Forward` shape of the Basecamp API.
2695#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
2696#[non_exhaustive]
2697pub struct Forward {
2698    /// `id`.
2699    pub id: i64,
2700    /// `status`.
2701    pub status: String,
2702    /// `visible_to_clients`.
2703    pub visible_to_clients: bool,
2704    /// `created_at`.
2705    pub created_at: DateTime,
2706    /// `updated_at`.
2707    pub updated_at: DateTime,
2708    /// `title`.
2709    pub title: String,
2710    /// `inherits_status`.
2711    pub inherits_status: bool,
2712    /// `type`.
2713    pub r#type: String,
2714    /// `url`.
2715    pub url: String,
2716    /// `app_url`.
2717    pub app_url: String,
2718    /// `bookmark_url`.
2719    #[serde(default, skip_serializing_if = "Option::is_none")]
2720    pub bookmark_url: Option<String>,
2721    /// `subscription_url`.
2722    #[serde(default, skip_serializing_if = "Option::is_none")]
2723    pub subscription_url: Option<String>,
2724    /// `parent`.
2725    pub parent: RecordingParent,
2726    /// `bucket`.
2727    pub bucket: TodoBucket,
2728    /// `creator`.
2729    pub creator: Person,
2730    /// `content`.
2731    #[serde(default, skip_serializing_if = "Option::is_none")]
2732    pub content: Option<String>,
2733    /// `content_attachments`.
2734    pub content_attachments: Vec<RichTextAttachment>,
2735    /// `subject`.
2736    pub subject: String,
2737    /// `from`.
2738    #[serde(default, skip_serializing_if = "Option::is_none")]
2739    pub from: Option<String>,
2740    /// `replies_count`.
2741    #[serde(default, skip_serializing_if = "Option::is_none")]
2742    pub replies_count: Option<i32>,
2743    /// `replies_url`.
2744    #[serde(default, skip_serializing_if = "Option::is_none")]
2745    pub replies_url: Option<String>,
2746}
2747
2748/// The `ForwardReply` shape of the Basecamp API.
2749#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
2750#[non_exhaustive]
2751pub struct ForwardReply {
2752    /// `id`.
2753    pub id: i64,
2754    /// `status`.
2755    pub status: String,
2756    /// `visible_to_clients`.
2757    pub visible_to_clients: bool,
2758    /// `created_at`.
2759    pub created_at: DateTime,
2760    /// `updated_at`.
2761    pub updated_at: DateTime,
2762    /// `title`.
2763    pub title: String,
2764    /// `inherits_status`.
2765    pub inherits_status: bool,
2766    /// `type`.
2767    pub r#type: String,
2768    /// `url`.
2769    pub url: String,
2770    /// `app_url`.
2771    pub app_url: String,
2772    /// `bookmark_url`.
2773    #[serde(default, skip_serializing_if = "Option::is_none")]
2774    pub bookmark_url: Option<String>,
2775    /// `parent`.
2776    pub parent: RecordingParent,
2777    /// `bucket`.
2778    pub bucket: TodoBucket,
2779    /// `creator`.
2780    pub creator: Person,
2781    /// `content`.
2782    pub content: String,
2783    /// `content_attachments`.
2784    pub content_attachments: Vec<RichTextAttachment>,
2785    /// `boosts_count`.
2786    #[serde(default, skip_serializing_if = "Option::is_none")]
2787    pub boosts_count: Option<i32>,
2788    /// `boosts_url`.
2789    #[serde(default, skip_serializing_if = "Option::is_none")]
2790    pub boosts_url: Option<String>,
2791}
2792
2793/// The `Gauge` shape of the Basecamp API.
2794#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
2795#[non_exhaustive]
2796pub struct Gauge {
2797    /// `id`.
2798    pub id: i64,
2799    /// `status`.
2800    #[serde(default, skip_serializing_if = "Option::is_none")]
2801    pub status: Option<String>,
2802    /// `visible_to_clients`.
2803    #[serde(default, skip_serializing_if = "Option::is_none")]
2804    pub visible_to_clients: Option<bool>,
2805    /// `created_at`.
2806    pub created_at: DateTime,
2807    /// `updated_at`.
2808    pub updated_at: DateTime,
2809    /// `title`.
2810    #[serde(default, skip_serializing_if = "Option::is_none")]
2811    pub title: Option<String>,
2812    /// `inherits_status`.
2813    #[serde(default, skip_serializing_if = "Option::is_none")]
2814    pub inherits_status: Option<bool>,
2815    /// `type`.
2816    #[serde(default, skip_serializing_if = "Option::is_none")]
2817    pub r#type: Option<String>,
2818    /// `url`.
2819    #[serde(default, skip_serializing_if = "Option::is_none")]
2820    pub url: Option<String>,
2821    /// `app_url`.
2822    #[serde(default, skip_serializing_if = "Option::is_none")]
2823    pub app_url: Option<String>,
2824    /// `bookmark_url`.
2825    #[serde(default, skip_serializing_if = "Option::is_none")]
2826    pub bookmark_url: Option<String>,
2827    /// `bucket`.
2828    #[serde(default, skip_serializing_if = "Option::is_none")]
2829    pub bucket: Option<RecordingBucket>,
2830    /// `creator`.
2831    #[serde(default, skip_serializing_if = "Option::is_none")]
2832    pub creator: Option<Person>,
2833    /// `description`.
2834    #[serde(default, skip_serializing_if = "Option::is_none")]
2835    pub description: Option<String>,
2836    /// Optional (no `@required`): the type-specific partial renders the
2837    /// companion array only when the gauge has needles (bc3 `if
2838    /// gauge.any_needles?`), so a needle-less gauge omits the key entirely.
2839    /// Non-nullable — never served as JSON `null`.
2840    #[serde(default, skip_serializing_if = "Option::is_none")]
2841    pub description_attachments: Option<Vec<RichTextAttachment>>,
2842    /// `enabled`.
2843    #[serde(default, skip_serializing_if = "Option::is_none")]
2844    pub enabled: Option<bool>,
2845    /// `last_needle_color`.
2846    #[serde(default, skip_serializing_if = "Option::is_none")]
2847    pub last_needle_color: Option<String>,
2848    /// `last_needle_position`.
2849    #[serde(default, skip_serializing_if = "Option::is_none")]
2850    pub last_needle_position: Option<i32>,
2851    /// Emitted alongside the other needle keys (so optional, like them), and
2852    /// JSON `null` for a gauge whose only needle is its first — there is no
2853    /// previous position yet. The enhance pass layers `nullable: true` onto the
2854    /// OpenAPI so the static SDKs type the value as nullable rather than
2855    /// flattening the first needle's null into a real 0.
2856    #[serde(default, skip_serializing_if = "Option::is_none")]
2857    pub previous_needle_position: Option<i32>,
2858}
2859
2860/// The `GaugeNeedle` shape of the Basecamp API.
2861#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
2862#[non_exhaustive]
2863pub struct GaugeNeedle {
2864    /// `id`.
2865    pub id: i64,
2866    /// `status`.
2867    #[serde(default, skip_serializing_if = "Option::is_none")]
2868    pub status: Option<String>,
2869    /// `visible_to_clients`.
2870    #[serde(default, skip_serializing_if = "Option::is_none")]
2871    pub visible_to_clients: Option<bool>,
2872    /// `created_at`.
2873    pub created_at: DateTime,
2874    /// `updated_at`.
2875    pub updated_at: DateTime,
2876    /// `title`.
2877    #[serde(default, skip_serializing_if = "Option::is_none")]
2878    pub title: Option<String>,
2879    /// `inherits_status`.
2880    #[serde(default, skip_serializing_if = "Option::is_none")]
2881    pub inherits_status: Option<bool>,
2882    /// `type`.
2883    #[serde(default, skip_serializing_if = "Option::is_none")]
2884    pub r#type: Option<String>,
2885    /// `url`.
2886    #[serde(default, skip_serializing_if = "Option::is_none")]
2887    pub url: Option<String>,
2888    /// `app_url`.
2889    #[serde(default, skip_serializing_if = "Option::is_none")]
2890    pub app_url: Option<String>,
2891    /// `bookmark_url`.
2892    #[serde(default, skip_serializing_if = "Option::is_none")]
2893    pub bookmark_url: Option<String>,
2894    /// `subscription_url`.
2895    #[serde(default, skip_serializing_if = "Option::is_none")]
2896    pub subscription_url: Option<String>,
2897    /// `comments_count`.
2898    #[serde(default, skip_serializing_if = "Option::is_none")]
2899    pub comments_count: Option<i32>,
2900    /// `comments_url`.
2901    #[serde(default, skip_serializing_if = "Option::is_none")]
2902    pub comments_url: Option<String>,
2903    /// `boosts_count`.
2904    #[serde(default, skip_serializing_if = "Option::is_none")]
2905    pub boosts_count: Option<i32>,
2906    /// `boosts_url`.
2907    #[serde(default, skip_serializing_if = "Option::is_none")]
2908    pub boosts_url: Option<String>,
2909    /// `parent`.
2910    #[serde(default, skip_serializing_if = "Option::is_none")]
2911    pub parent: Option<RecordingParent>,
2912    /// `bucket`.
2913    #[serde(default, skip_serializing_if = "Option::is_none")]
2914    pub bucket: Option<RecordingBucket>,
2915    /// `creator`.
2916    #[serde(default, skip_serializing_if = "Option::is_none")]
2917    pub creator: Option<Person>,
2918    /// `description`.
2919    #[serde(default, skip_serializing_if = "Option::is_none")]
2920    pub description: Option<String>,
2921    /// `description_attachments`.
2922    pub description_attachments: Vec<RichTextAttachment>,
2923    /// `color`.
2924    #[serde(default, skip_serializing_if = "Option::is_none")]
2925    pub color: Option<String>,
2926    /// `position`.
2927    #[serde(default, skip_serializing_if = "Option::is_none")]
2928    pub position: Option<i32>,
2929    /// Comment count of the needle: the singular branch-partial key that
2930    /// gauges/needles/_needle.json.jbuilder emits unconditionally, distinct from
2931    /// the envelope's plural `comments_count`, which a needle also carries. The
2932    /// same pair SearchResult models.
2933    pub comment_count: i32,
2934}
2935
2936/// The `GaugeNeedlePayload` shape of the Basecamp API.
2937#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
2938pub struct GaugeNeedlePayload {
2939    /// Position of the needle (0-100)
2940    pub position: i32,
2941    /// Status color: green (default), yellow, or red
2942    #[serde(default, skip_serializing_if = "Option::is_none")]
2943    pub color: Option<String>,
2944    /// Rich text (HTML) description of the progress update
2945    #[serde(default, skip_serializing_if = "Option::is_none")]
2946    pub description: Option<String>,
2947}
2948
2949/// The `GaugeNeedleUpdatePayload` shape of the Basecamp API.
2950#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
2951pub struct GaugeNeedleUpdatePayload {
2952    /// Rich text (HTML) description. Required: it is the only member bc3's
2953    /// update accepts (`needle_params.except(:color, :position)`), and
2954    /// `params.require(:gauge_needle)` rejects an empty wrapper as missing, so a
2955    /// payload without it is the same 400 as no wrapper at all.
2956    pub description: String,
2957}
2958
2959/// The `GaugeTogglePayload` shape of the Basecamp API.
2960#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
2961pub struct GaugeTogglePayload {
2962    /// `enabled`.
2963    pub enabled: bool,
2964}
2965
2966/// `GetAccountResponseContent`.
2967pub type GetAccountResponseContent = Account;
2968
2969/// `GetAnswerResponseContent`.
2970pub type GetAnswerResponseContent = QuestionAnswer;
2971
2972/// `GetAnswersByPersonResponseContent`.
2973pub type GetAnswersByPersonResponseContent = Vec<QuestionAnswer>;
2974
2975/// The `GetAssignedTodosResponseContent` shape of the Basecamp API.
2976#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
2977#[non_exhaustive]
2978pub struct GetAssignedTodosResponseContent {
2979    /// `person`.
2980    #[serde(default, skip_serializing_if = "Option::is_none")]
2981    pub person: Option<Person>,
2982    /// `grouped_by`.
2983    #[serde(default, skip_serializing_if = "Option::is_none")]
2984    pub grouped_by: Option<String>,
2985    /// `todos`.
2986    #[serde(default, skip_serializing_if = "Option::is_none")]
2987    pub todos: Option<Vec<Todo>>,
2988}
2989
2990/// `GetBookmarkResponseContent`.
2991pub type GetBookmarkResponseContent = BookmarkStatus;
2992
2993/// `GetBoostResponseContent`.
2994pub type GetBoostResponseContent = Boost;
2995
2996/// `GetBubbleUpsResponseContent`.
2997pub type GetBubbleUpsResponseContent = Vec<Notification>;
2998
2999/// `GetCalendarResponseContent`.
3000pub type GetCalendarResponseContent = Calendar;
3001
3002/// `GetCampfireLineResponseContent`.
3003pub type GetCampfireLineResponseContent = CampfireLine;
3004
3005/// `GetCampfireResponseContent`.
3006pub type GetCampfireResponseContent = Campfire;
3007
3008/// `GetCardColumnResponseContent`.
3009pub type GetCardColumnResponseContent = CardColumn;
3010
3011/// `GetCardResponseContent`.
3012pub type GetCardResponseContent = Card;
3013
3014/// `GetCardStepResponseContent`.
3015pub type GetCardStepResponseContent = Subtask;
3016
3017/// `GetCardTableResponseContent`.
3018pub type GetCardTableResponseContent = CardTable;
3019
3020/// `GetChatbotResponseContent`.
3021pub type GetChatbotResponseContent = Chatbot;
3022
3023/// `GetClientApprovalResponseContent`.
3024pub type GetClientApprovalResponseContent = ClientApproval;
3025
3026/// `GetClientCorrespondenceResponseContent`.
3027pub type GetClientCorrespondenceResponseContent = ClientCorrespondence;
3028
3029/// `GetClientReplyResponseContent`.
3030pub type GetClientReplyResponseContent = ClientReply;
3031
3032/// `GetCloudFileResponseContent`.
3033pub type GetCloudFileResponseContent = CloudFile;
3034
3035/// `GetCommentResponseContent`.
3036pub type GetCommentResponseContent = Comment;
3037
3038/// `GetDocumentResponseContent`.
3039pub type GetDocumentResponseContent = Document;
3040
3041/// `GetDoorResponseContent`.
3042pub type GetDoorResponseContent = Door;
3043
3044/// `GetEmbedResponseContent`.
3045pub type GetEmbedResponseContent = Embed;
3046
3047/// `GetEverythingCheckinsResponseContent`.
3048pub type GetEverythingCheckinsResponseContent = Vec<Recording>;
3049
3050/// `GetEverythingCommentsResponseContent`.
3051pub type GetEverythingCommentsResponseContent = Vec<Recording>;
3052
3053/// `GetEverythingCompletedCardsResponseContent`.
3054pub type GetEverythingCompletedCardsResponseContent = Vec<BucketCardsGroup>;
3055
3056/// `GetEverythingCompletedTodosResponseContent`.
3057pub type GetEverythingCompletedTodosResponseContent = Vec<BucketTodosGroup>;
3058
3059/// `GetEverythingFilesResponseContent`.
3060pub type GetEverythingFilesResponseContent = Vec<EverythingFile>;
3061
3062/// `GetEverythingForwardsResponseContent`.
3063pub type GetEverythingForwardsResponseContent = Vec<Recording>;
3064
3065/// `GetEverythingMessagesResponseContent`.
3066pub type GetEverythingMessagesResponseContent = Vec<Recording>;
3067
3068/// `GetEverythingNoDueDateCardsResponseContent`.
3069pub type GetEverythingNoDueDateCardsResponseContent = Vec<BucketCardsGroup>;
3070
3071/// `GetEverythingNoDueDateTodosResponseContent`.
3072pub type GetEverythingNoDueDateTodosResponseContent = Vec<BucketTodosGroup>;
3073
3074/// `GetEverythingNotNowCardsResponseContent`.
3075pub type GetEverythingNotNowCardsResponseContent = Vec<BucketCardsGroup>;
3076
3077/// `GetEverythingOpenCardsResponseContent`.
3078pub type GetEverythingOpenCardsResponseContent = Vec<BucketCardsGroup>;
3079
3080/// `GetEverythingOpenTodosResponseContent`.
3081pub type GetEverythingOpenTodosResponseContent = Vec<BucketTodosGroup>;
3082
3083/// `GetEverythingOverdueCardsResponseContent`.
3084pub type GetEverythingOverdueCardsResponseContent = Vec<Card>;
3085
3086/// `GetEverythingOverdueTodosResponseContent`.
3087pub type GetEverythingOverdueTodosResponseContent = Vec<Todo>;
3088
3089/// `GetEverythingUnassignedCardsResponseContent`.
3090pub type GetEverythingUnassignedCardsResponseContent = Vec<BucketCardsGroup>;
3091
3092/// `GetEverythingUnassignedTodosResponseContent`.
3093pub type GetEverythingUnassignedTodosResponseContent = Vec<BucketTodosGroup>;
3094
3095/// `GetFilingResponseContent`.
3096pub type GetFilingResponseContent = Filing;
3097
3098/// `GetFolderResponseContent`.
3099pub type GetFolderResponseContent = FolderWithProjects;
3100
3101/// `GetForwardReplyResponseContent`.
3102pub type GetForwardReplyResponseContent = ForwardReply;
3103
3104/// `GetForwardResponseContent`.
3105pub type GetForwardResponseContent = Forward;
3106
3107/// `GetGaugeNeedleResponseContent`.
3108pub type GetGaugeNeedleResponseContent = GaugeNeedle;
3109
3110/// `GetGoogleDocumentResponseContent`.
3111pub type GetGoogleDocumentResponseContent = GoogleDocument;
3112
3113/// `GetHillChartResponseContent`.
3114pub type GetHillChartResponseContent = HillChart;
3115
3116/// `GetHillChartVersionResponseContent`.
3117pub type GetHillChartVersionResponseContent = HillChartVersion;
3118
3119/// `GetInboxResponseContent`.
3120pub type GetInboxResponseContent = Inbox;
3121
3122/// `GetMessageBoardResponseContent`.
3123pub type GetMessageBoardResponseContent = MessageBoard;
3124
3125/// `GetMessageResponseContent`.
3126pub type GetMessageResponseContent = Message;
3127
3128/// `GetMessageTypeResponseContent`.
3129pub type GetMessageTypeResponseContent = MessageType;
3130
3131/// The `GetMyAssignmentsResponseContent` shape of the Basecamp API.
3132#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
3133#[non_exhaustive]
3134pub struct GetMyAssignmentsResponseContent {
3135    /// `priorities`.
3136    #[serde(default, skip_serializing_if = "Option::is_none")]
3137    pub priorities: Option<Vec<MyAssignment>>,
3138    /// `non_priorities`.
3139    #[serde(default, skip_serializing_if = "Option::is_none")]
3140    pub non_priorities: Option<Vec<MyAssignment>>,
3141}
3142
3143/// `GetMyCompletedAssignmentsResponseContent`.
3144pub type GetMyCompletedAssignmentsResponseContent = Vec<MyAssignment>;
3145
3146/// `GetMyDueAssignmentsResponseContent`.
3147pub type GetMyDueAssignmentsResponseContent = Vec<MyAssignment>;
3148
3149/// `GetMyNoteResponseContent`.
3150pub type GetMyNoteResponseContent = MyNote;
3151
3152/// The `GetMyNotificationsResponseContent` shape of the Basecamp API.
3153#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
3154#[non_exhaustive]
3155pub struct GetMyNotificationsResponseContent {
3156    /// `unreads`.
3157    #[serde(default, skip_serializing_if = "Option::is_none")]
3158    pub unreads: Option<Vec<Notification>>,
3159    /// `reads`.
3160    #[serde(default, skip_serializing_if = "Option::is_none")]
3161    pub reads: Option<Vec<Notification>>,
3162    /// Total number of current bubble-ups, for notification UI counts
3163    /// (independent of the `limit_bubble_ups` cap on the `bubble_ups` array).
3164    pub bubble_ups_count: i32,
3165    /// Total number of scheduled bubble-ups, for notification UI counts
3166    /// (present even when `limit_bubble_ups` omits the `scheduled_bubble_ups`
3167    /// array).
3168    pub scheduled_bubble_ups_count: i32,
3169    /// Legacy "save forever" collection. Permanently `\[\]` on BC5 by documented
3170    /// contract (`doc/api/sections/my_notifications.md`, codified by BC3 #11628):
3171    /// an always-empty placeholder superseded by `bubble_ups`. BC4 (the `four`
3172    /// branch) still populates it — an accepted BC4→BC5 subtractive delta
3173    /// recorded in `spec/api-gaps/memories-emptied-regression.md`. New
3174    /// integrations should use `bubble_ups` / `scheduled_bubble_ups` and must
3175    /// not rely on `memories` on BC5.
3176    #[serde(default, skip_serializing_if = "Option::is_none")]
3177    pub memories: Option<Vec<Notification>>,
3178    /// Items the user has saved with Bubble Up (BC5 addition). Roughly the
3179    /// successor to `memories` but with optional scheduling — see
3180    /// `scheduled_bubble_ups` for the time-deferred subset.
3181    #[serde(default, skip_serializing_if = "Option::is_none")]
3182    pub bubble_ups: Option<Vec<Notification>>,
3183    /// Bubble Ups scheduled to resurface in the future (BC5 addition).
3184    #[serde(default, skip_serializing_if = "Option::is_none")]
3185    pub scheduled_bubble_ups: Option<Vec<Notification>>,
3186}
3187
3188/// `GetMyPreferencesResponseContent`.
3189pub type GetMyPreferencesResponseContent = Preferences;
3190
3191/// `GetMyProfileResponseContent`.
3192pub type GetMyProfileResponseContent = Person;
3193
3194/// `GetOutOfOfficeResponseContent`.
3195pub type GetOutOfOfficeResponseContent = OutOfOffice;
3196
3197/// The `GetOverdueTodosResponseContent` shape of the Basecamp API.
3198#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
3199#[non_exhaustive]
3200pub struct GetOverdueTodosResponseContent {
3201    /// `under_a_week_late`.
3202    #[serde(default, skip_serializing_if = "Option::is_none")]
3203    pub under_a_week_late: Option<Vec<Todo>>,
3204    /// `over_a_week_late`.
3205    #[serde(default, skip_serializing_if = "Option::is_none")]
3206    pub over_a_week_late: Option<Vec<Todo>>,
3207    /// `over_a_month_late`.
3208    #[serde(default, skip_serializing_if = "Option::is_none")]
3209    pub over_a_month_late: Option<Vec<Todo>>,
3210    /// `over_three_months_late`.
3211    #[serde(default, skip_serializing_if = "Option::is_none")]
3212    pub over_three_months_late: Option<Vec<Todo>>,
3213}
3214
3215/// The `GetPersonProgressResponseContent` shape of the Basecamp API.
3216#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
3217#[non_exhaustive]
3218pub struct GetPersonProgressResponseContent {
3219    /// `person`.
3220    pub person: Person,
3221    /// `events`.
3222    pub events: Vec<TimelineEvent>,
3223}
3224
3225impl crate::pagination::PageItems for GetPersonProgressResponseContent {
3226    type Item = TimelineEvent;
3227
3228    fn into_items(self) -> Vec<TimelineEvent> {
3229        self.events
3230    }
3231}
3232
3233/// `GetPersonResponseContent`.
3234pub type GetPersonResponseContent = Person;
3235
3236/// `GetPingResponseContent`.
3237pub type GetPingResponseContent = Ping;
3238
3239/// `GetProgressReportResponseContent`.
3240pub type GetProgressReportResponseContent = Vec<TimelineEvent>;
3241
3242/// `GetProjectConstructionResponseContent`.
3243pub type GetProjectConstructionResponseContent = ProjectConstruction;
3244
3245/// `GetProjectResponseContent`.
3246pub type GetProjectResponseContent = Project;
3247
3248/// `GetProjectTimelineResponseContent`.
3249pub type GetProjectTimelineResponseContent = Vec<TimelineEvent>;
3250
3251/// `GetProjectTimesheetResponseContent`.
3252pub type GetProjectTimesheetResponseContent = Vec<TimesheetEntry>;
3253
3254/// `GetQuestionRemindersResponseContent`.
3255pub type GetQuestionRemindersResponseContent = Vec<QuestionReminder>;
3256
3257/// `GetQuestionResponseContent`.
3258pub type GetQuestionResponseContent = Question;
3259
3260/// `GetQuestionnaireResponseContent`.
3261pub type GetQuestionnaireResponseContent = Questionnaire;
3262
3263/// `GetRecordingTimesheetResponseContent`.
3264pub type GetRecordingTimesheetResponseContent = Vec<TimesheetEntry>;
3265
3266/// `GetScheduleEntryOccurrenceResponseContent`.
3267pub type GetScheduleEntryOccurrenceResponseContent = ScheduleEntry;
3268
3269/// `GetScheduleEntryResponseContent`.
3270pub type GetScheduleEntryResponseContent = ScheduleEntry;
3271
3272/// `GetScheduleResponseContent`.
3273pub type GetScheduleResponseContent = Schedule;
3274
3275/// `GetSearchMetadataResponseContent`.
3276pub type GetSearchMetadataResponseContent = SearchMetadata;
3277
3278/// `GetSubscriptionResponseContent`.
3279pub type GetSubscriptionResponseContent = Subscription;
3280
3281/// `GetSubtaskResponseContent`.
3282pub type GetSubtaskResponseContent = Subtask;
3283
3284/// `GetTemplateLibraryCardTablesResponseContent`.
3285pub type GetTemplateLibraryCardTablesResponseContent = TemplateLibraryCardTables;
3286
3287/// `GetTemplateLibraryCopyResponseContent`.
3288pub type GetTemplateLibraryCopyResponseContent = TemplateLibraryCopy;
3289
3290/// `GetTemplateLibraryTodolistsResponseContent`.
3291pub type GetTemplateLibraryTodolistsResponseContent = TemplateLibraryTodolists;
3292
3293/// `GetTemplateResponseContent`.
3294pub type GetTemplateResponseContent = Template;
3295
3296/// `GetTemplatificationResponseContent`.
3297pub type GetTemplatificationResponseContent = Templatification;
3298
3299/// `GetTimesheetEntryResponseContent`.
3300pub type GetTimesheetEntryResponseContent = TimesheetEntry;
3301
3302/// `GetTimesheetReportResponseContent`.
3303pub type GetTimesheetReportResponseContent = Vec<TimesheetEntry>;
3304
3305/// `GetTodoResponseContent`.
3306pub type GetTodoResponseContent = Todo;
3307
3308/// `GetTodolistOrGroupResponseContent`.
3309pub type GetTodolistOrGroupResponseContent = Todolist;
3310
3311/// `GetTodosetResponseContent`.
3312pub type GetTodosetResponseContent = Todoset;
3313
3314/// `GetToolResponseContent`.
3315pub type GetToolResponseContent = Tool;
3316
3317/// The `GetUpcomingScheduleResponseContent` shape of the Basecamp API.
3318#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
3319#[non_exhaustive]
3320pub struct GetUpcomingScheduleResponseContent {
3321    /// Non-recurring entries starting in the window, chronological. Always
3322    /// present — `reports/schedules/upcoming/index.json.jbuilder` writes all
3323    /// three keys unconditionally, so an empty window is three empty arrays
3324    /// rather than a missing key.
3325    pub schedule_entries: Vec<UpcomingScheduleEntry>,
3326    /// Realized occurrences of recurring entries falling in the window. Rendered
3327    /// through the same calendar entry partial as schedule_entries, so the two
3328    /// arrays carry the same shape; an occurrence is distinguished only by its
3329    /// `recurring` flag being true. Always present.
3330    pub recurring_schedule_entry_occurrences: Vec<UpcomingScheduleEntry>,
3331    /// Dated to-dos, cards and steps falling in the window. Always present.
3332    pub assignables: Vec<UpcomingAssignable>,
3333}
3334
3335/// `GetUploadResponseContent`.
3336pub type GetUploadResponseContent = Upload;
3337
3338/// `GetVaultResponseContent`.
3339pub type GetVaultResponseContent = Vault;
3340
3341/// `GetWebhookResponseContent`.
3342pub type GetWebhookResponseContent = Webhook;
3343
3344/// The `GoogleDocument` shape of the Basecamp API.
3345#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
3346#[non_exhaustive]
3347pub struct GoogleDocument {
3348    /// `id`.
3349    pub id: i64,
3350    /// `status`.
3351    pub status: String,
3352    /// `visible_to_clients`.
3353    pub visible_to_clients: bool,
3354    /// `created_at`.
3355    pub created_at: DateTime,
3356    /// `updated_at`.
3357    pub updated_at: DateTime,
3358    /// `title`.
3359    pub title: String,
3360    /// `inherits_status`.
3361    pub inherits_status: bool,
3362    /// `type`.
3363    pub r#type: String,
3364    /// The Google Workspace document link — NOT this record's API URL. Same
3365    /// recordable-overwrites-recording rendering as CloudFile#url.
3366    pub url: String,
3367    /// `app_url`.
3368    pub app_url: String,
3369    /// `bookmark_url`.
3370    #[serde(default, skip_serializing_if = "Option::is_none")]
3371    pub bookmark_url: Option<String>,
3372    /// `subscription_url`.
3373    #[serde(default, skip_serializing_if = "Option::is_none")]
3374    pub subscription_url: Option<String>,
3375    /// `comments_count`.
3376    #[serde(default, skip_serializing_if = "Option::is_none")]
3377    pub comments_count: Option<i32>,
3378    /// `comments_url`.
3379    #[serde(default, skip_serializing_if = "Option::is_none")]
3380    pub comments_url: Option<String>,
3381    /// `position`.
3382    #[serde(default, skip_serializing_if = "Option::is_none")]
3383    pub position: Option<i32>,
3384    /// `parent`.
3385    pub parent: RecordingParent,
3386    /// `bucket`.
3387    pub bucket: TodoBucket,
3388    /// `creator`.
3389    pub creator: Person,
3390    /// `description`.
3391    #[serde(default, skip_serializing_if = "Option::is_none")]
3392    pub description: Option<String>,
3393    /// `description_attachments`.
3394    pub description_attachments: Vec<RichTextAttachment>,
3395    /// One of "doc", "sheet", "slide", "other". Backed by a Rails enum, so an
3396    /// unrecognized value is rejected up front with a field-keyed 422
3397    /// ({"errors": {"document_type": \["is not a valid document type"\]}}) rather
3398    /// than reaching validation.
3399    pub document_type: String,
3400    /// `boosts_count`.
3401    #[serde(default, skip_serializing_if = "Option::is_none")]
3402    pub boosts_count: Option<i32>,
3403    /// `boosts_url`.
3404    #[serde(default, skip_serializing_if = "Option::is_none")]
3405    pub boosts_url: Option<String>,
3406}
3407
3408/// The `HillChart` shape of the Basecamp API.
3409#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
3410#[non_exhaustive]
3411pub struct HillChart {
3412    /// `enabled`.
3413    pub enabled: bool,
3414    /// `stale`.
3415    pub stale: bool,
3416    /// `updated_at`.
3417    #[serde(default, skip_serializing_if = "Option::is_none")]
3418    pub updated_at: Option<DateTime>,
3419    /// `app_update_url`.
3420    #[serde(default, skip_serializing_if = "Option::is_none")]
3421    pub app_update_url: Option<String>,
3422    /// `app_versions_url`.
3423    #[serde(default, skip_serializing_if = "Option::is_none")]
3424    pub app_versions_url: Option<String>,
3425    /// `dots`.
3426    #[serde(default, skip_serializing_if = "Option::is_none")]
3427    pub dots: Option<Vec<HillChartDot>>,
3428    /// API URL of the chart's progress updates (`ListHillChartVersions`).
3429    /// Present only when the chart has at least one progress update.
3430    #[serde(default, skip_serializing_if = "Option::is_none")]
3431    pub versions_url: Option<String>,
3432}
3433
3434/// The `HillChartDot` shape of the Basecamp API.
3435#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
3436#[non_exhaustive]
3437pub struct HillChartDot {
3438    /// `id`.
3439    pub id: i64,
3440    /// `label`.
3441    pub label: String,
3442    /// `color`.
3443    pub color: String,
3444    /// `position`.
3445    pub position: i32,
3446    /// `url`.
3447    #[serde(default, skip_serializing_if = "Option::is_none")]
3448    pub url: Option<String>,
3449    /// `app_url`.
3450    #[serde(default, skip_serializing_if = "Option::is_none")]
3451    pub app_url: Option<String>,
3452}
3453
3454/// Where to move one tracked todolist in a progress update.
3455#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
3456pub struct HillChartDotPosition {
3457    /// The todolist's ID. It must be tracked on the hill chart.
3458    pub id: i64,
3459    /// A whole number from 0 to 100, on the same scale as the hill chart's dots.
3460    pub position: i32,
3461}
3462
3463/// A progress update on a hill chart: the note someone wrote when they
3464/// updated the chart, and where each tracked todolist sat at that moment.
3465#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
3466#[non_exhaustive]
3467pub struct HillChartVersion {
3468    /// `id`.
3469    pub id: i64,
3470    /// `status`.
3471    pub status: String,
3472    /// `visible_to_clients`.
3473    pub visible_to_clients: bool,
3474    /// `created_at`.
3475    pub created_at: DateTime,
3476    /// `updated_at`.
3477    pub updated_at: DateTime,
3478    /// `title`.
3479    pub title: String,
3480    /// `inherits_status`.
3481    pub inherits_status: bool,
3482    /// `type`.
3483    pub r#type: String,
3484    /// `url`.
3485    pub url: String,
3486    /// `app_url`.
3487    pub app_url: String,
3488    /// `bookmark_url`.
3489    #[serde(default, skip_serializing_if = "Option::is_none")]
3490    pub bookmark_url: Option<String>,
3491    /// `subscription_url`.
3492    #[serde(default, skip_serializing_if = "Option::is_none")]
3493    pub subscription_url: Option<String>,
3494    /// `comments_count`.
3495    #[serde(default, skip_serializing_if = "Option::is_none")]
3496    pub comments_count: Option<i32>,
3497    /// `comments_url`.
3498    #[serde(default, skip_serializing_if = "Option::is_none")]
3499    pub comments_url: Option<String>,
3500    /// `boosts_count`.
3501    #[serde(default, skip_serializing_if = "Option::is_none")]
3502    pub boosts_count: Option<i32>,
3503    /// `boosts_url`.
3504    #[serde(default, skip_serializing_if = "Option::is_none")]
3505    pub boosts_url: Option<String>,
3506    /// `parent`.
3507    pub parent: RecordingParent,
3508    /// `bucket`.
3509    pub bucket: TodoBucket,
3510    /// `creator`.
3511    pub creator: Person,
3512    /// The note written with the update, as rich text.
3513    #[serde(default, skip_serializing_if = "Option::is_none")]
3514    pub description: Option<String>,
3515    /// `description_attachments`.
3516    pub description_attachments: Vec<RichTextAttachment>,
3517    /// Where each tracked todolist sat on the hill when the update was made,
3518    /// ordered by position.
3519    pub dots: Vec<HillChartVersionDot>,
3520}
3521
3522/// A todolist's place on the hill in one progress update.
3523#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
3524#[non_exhaustive]
3525pub struct HillChartVersionDot {
3526    /// The todolist's ID, or null when it has since been permanently deleted
3527    /// or moved to another project; `url` and `app_url` are then omitted.
3528    #[serde(default, skip_serializing_if = "Option::is_none")]
3529    pub id: Option<i64>,
3530    /// The todolist's full name at the time of the update.
3531    pub label: String,
3532    /// `color`.
3533    pub color: String,
3534    /// Position on the same 0–100 scale as the hill chart's dots.
3535    pub position: i32,
3536    /// `url`.
3537    #[serde(default, skip_serializing_if = "Option::is_none")]
3538    pub url: Option<String>,
3539    /// `app_url`.
3540    #[serde(default, skip_serializing_if = "Option::is_none")]
3541    pub app_url: Option<String>,
3542}
3543
3544/// The `Inbox` shape of the Basecamp API.
3545#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
3546#[non_exhaustive]
3547pub struct Inbox {
3548    /// `id`.
3549    pub id: i64,
3550    /// `status`.
3551    pub status: String,
3552    /// `visible_to_clients`.
3553    pub visible_to_clients: bool,
3554    /// `created_at`.
3555    pub created_at: DateTime,
3556    /// `updated_at`.
3557    pub updated_at: DateTime,
3558    /// `title`.
3559    pub title: String,
3560    /// `inherits_status`.
3561    pub inherits_status: bool,
3562    /// `type`.
3563    pub r#type: String,
3564    /// `url`.
3565    pub url: String,
3566    /// `app_url`.
3567    pub app_url: String,
3568    /// `bookmark_url`.
3569    #[serde(default, skip_serializing_if = "Option::is_none")]
3570    pub bookmark_url: Option<String>,
3571    /// `position`.
3572    #[serde(default, skip_serializing_if = "Option::is_none")]
3573    pub position: Option<i32>,
3574    /// `bucket`.
3575    pub bucket: TodoBucket,
3576    /// `creator`.
3577    pub creator: Person,
3578    /// `forwards_count`.
3579    #[serde(default, skip_serializing_if = "Option::is_none")]
3580    pub forwards_count: Option<i32>,
3581    /// `forwards_url`.
3582    #[serde(default, skip_serializing_if = "Option::is_none")]
3583    pub forwards_url: Option<String>,
3584}
3585
3586/// One addressed delivery. `addressing_id` is the item's own identity — the
3587/// dedupe key — since one event can address the same principal for several
3588/// reasons.
3589#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
3590#[non_exhaustive]
3591pub struct InboxItem {
3592    /// `addressing_id`.
3593    pub addressing_id: i64,
3594    /// Why the principal was addressed: `mentioned`, `assigned`, `subscribed`,
3595    /// `watched`, `pinged`, or `boosted`.
3596    pub reason: String,
3597    /// `addressed_at`.
3598    pub addressed_at: DateTime,
3599    /// `event`.
3600    pub event: FeedEvent,
3601}
3602
3603/// 410 from PollInbox: the held `position` fell behind the inbox's 30-day
3604/// retention window. There is no epoch; `resume` is an absolute URL that
3605/// re-enters the inbox at `since=0`, the earliest retained item — exactly-once
3606/// continuation, since a stale position has seen none of the retained backlog.
3607/// A distinct shape from the feed's FeedPositionGoneError on purpose: the two
3608/// recoveries are not interchangeable, and a consumer must not handle one lane's
3609/// 410 with the other's arm. Validate the URL before following it, as for the
3610/// feed.
3611#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
3612#[non_exhaustive]
3613pub struct InboxPositionGoneErrorResponseContent {
3614    /// `error`.
3615    pub error: String,
3616    /// Absolute re-entry URL for the inbox, at `since=0`, filters preserved.
3617    pub resume: String,
3618}
3619
3620/// The `InternalServerErrorResponseContent` shape of the Basecamp API.
3621#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
3622#[non_exhaustive]
3623pub struct InternalServerErrorResponseContent {
3624    /// `error`.
3625    pub error: String,
3626    /// `message`.
3627    #[serde(default, skip_serializing_if = "Option::is_none")]
3628    pub message: Option<String>,
3629}
3630
3631/// The `LineupMarker` shape of the Basecamp API.
3632#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
3633#[non_exhaustive]
3634pub struct LineupMarker {
3635    /// `id`.
3636    pub id: i64,
3637    /// `name`.
3638    pub name: String,
3639    /// `date`.
3640    pub date: String,
3641    /// `created_at`.
3642    pub created_at: DateTime,
3643    /// `updated_at`.
3644    pub updated_at: DateTime,
3645}
3646
3647/// `ListAnswersResponseContent`.
3648pub type ListAnswersResponseContent = Vec<QuestionAnswer>;
3649
3650/// `ListAssignablePeopleResponseContent`.
3651pub type ListAssignablePeopleResponseContent = Vec<Person>;
3652
3653/// `ListCampfireLinesResponseContent`.
3654pub type ListCampfireLinesResponseContent = Vec<CampfireLine>;
3655
3656/// `ListCampfireUploadsResponseContent`.
3657pub type ListCampfireUploadsResponseContent = Vec<CampfireLine>;
3658
3659/// `ListCampfiresResponseContent`.
3660pub type ListCampfiresResponseContent = Vec<Campfire>;
3661
3662/// `ListCardsResponseContent`.
3663pub type ListCardsResponseContent = Vec<Card>;
3664
3665/// `ListChatbotsResponseContent`.
3666pub type ListChatbotsResponseContent = Vec<Chatbot>;
3667
3668/// `ListClientApprovalsResponseContent`.
3669pub type ListClientApprovalsResponseContent = Vec<ClientApproval>;
3670
3671/// `ListClientCorrespondencesResponseContent`.
3672pub type ListClientCorrespondencesResponseContent = Vec<ClientCorrespondence>;
3673
3674/// `ListClientRepliesResponseContent`.
3675pub type ListClientRepliesResponseContent = Vec<ClientReply>;
3676
3677/// `ListCommentsResponseContent`.
3678pub type ListCommentsResponseContent = Vec<Comment>;
3679
3680/// `ListDocumentsResponseContent`.
3681pub type ListDocumentsResponseContent = Vec<Document>;
3682
3683/// `ListDoorsResponseContent`.
3684pub type ListDoorsResponseContent = Vec<Door>;
3685
3686/// `ListEventBoostsResponseContent`.
3687pub type ListEventBoostsResponseContent = Vec<Boost>;
3688
3689/// `ListEventsResponseContent`.
3690pub type ListEventsResponseContent = Vec<Event>;
3691
3692/// `ListFoldersResponseContent`.
3693pub type ListFoldersResponseContent = Vec<Folder>;
3694
3695/// `ListForwardRepliesResponseContent`.
3696pub type ListForwardRepliesResponseContent = Vec<ForwardReply>;
3697
3698/// `ListForwardsResponseContent`.
3699pub type ListForwardsResponseContent = Vec<Forward>;
3700
3701/// `ListGaugeNeedlesResponseContent`.
3702pub type ListGaugeNeedlesResponseContent = Vec<GaugeNeedle>;
3703
3704/// `ListGaugesResponseContent`.
3705pub type ListGaugesResponseContent = Vec<Gauge>;
3706
3707/// `ListHillChartVersionsResponseContent`.
3708pub type ListHillChartVersionsResponseContent = Vec<HillChartVersion>;
3709
3710/// `ListLineupMarkersResponseContent`.
3711pub type ListLineupMarkersResponseContent = Vec<LineupMarker>;
3712
3713/// `ListMessageTypesResponseContent`.
3714pub type ListMessageTypesResponseContent = Vec<MessageType>;
3715
3716/// `ListMessagesResponseContent`.
3717pub type ListMessagesResponseContent = Vec<Message>;
3718
3719/// `ListMyBookmarksResponseContent`.
3720pub type ListMyBookmarksResponseContent = Vec<Bookmark>;
3721
3722/// `ListMyDraftsResponseContent`.
3723pub type ListMyDraftsResponseContent = Vec<Draft>;
3724
3725/// `ListPeopleResponseContent`.
3726pub type ListPeopleResponseContent = Vec<Person>;
3727
3728/// `ListPingablePeopleResponseContent`.
3729pub type ListPingablePeopleResponseContent = Vec<Person>;
3730
3731/// `ListPingsResponseContent`.
3732pub type ListPingsResponseContent = Vec<Ping>;
3733
3734/// `ListProjectPeopleResponseContent`.
3735pub type ListProjectPeopleResponseContent = Vec<Person>;
3736
3737/// `ListProjectsResponseContent`.
3738pub type ListProjectsResponseContent = Vec<Project>;
3739
3740/// `ListQuestionAnswerersResponseContent`.
3741pub type ListQuestionAnswerersResponseContent = Vec<Person>;
3742
3743/// `ListQuestionsResponseContent`.
3744pub type ListQuestionsResponseContent = Vec<Question>;
3745
3746/// `ListRecentProjectsResponseContent`.
3747pub type ListRecentProjectsResponseContent = Vec<Project>;
3748
3749/// `ListRecordingBoostsResponseContent`.
3750pub type ListRecordingBoostsResponseContent = Vec<Boost>;
3751
3752/// `ListRecordingsResponseContent`.
3753pub type ListRecordingsResponseContent = Vec<Recording>;
3754
3755/// `ListScheduleEntriesResponseContent`.
3756pub type ListScheduleEntriesResponseContent = Vec<ScheduleEntry>;
3757
3758/// `ListSubtasksResponseContent`.
3759pub type ListSubtasksResponseContent = Vec<Subtask>;
3760
3761/// `ListTemplatesResponseContent`.
3762pub type ListTemplatesResponseContent = Vec<Template>;
3763
3764/// `ListTodolistGroupsResponseContent`.
3765pub type ListTodolistGroupsResponseContent = Vec<Todolist>;
3766
3767/// `ListTodolistsResponseContent`.
3768pub type ListTodolistsResponseContent = Vec<Todolist>;
3769
3770/// `ListTodosResponseContent`.
3771pub type ListTodosResponseContent = Vec<Todo>;
3772
3773/// `ListUploadVersionsResponseContent`.
3774pub type ListUploadVersionsResponseContent = Vec<UploadVersion>;
3775
3776/// `ListUploadsResponseContent`.
3777pub type ListUploadsResponseContent = Vec<Upload>;
3778
3779/// `ListVaultsResponseContent`.
3780pub type ListVaultsResponseContent = Vec<Vault>;
3781
3782/// `ListWebhooksResponseContent`.
3783pub type ListWebhooksResponseContent = Vec<Webhook>;
3784
3785/// The `MarkAsReadRequestContent` shape of the Basecamp API.
3786#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
3787pub struct MarkAsReadRequestContent {
3788    /// Array of readable_sgid values identifying the items to mark as read.
3789    /// At most 500 per request.
3790    pub readables: Vec<String>,
3791}
3792
3793/// The `Message` shape of the Basecamp API.
3794#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
3795#[non_exhaustive]
3796pub struct Message {
3797    /// `id`.
3798    pub id: i64,
3799    /// `status`.
3800    pub status: String,
3801    /// `visible_to_clients`.
3802    pub visible_to_clients: bool,
3803    /// `created_at`.
3804    pub created_at: DateTime,
3805    /// `updated_at`.
3806    pub updated_at: DateTime,
3807    /// `title`.
3808    pub title: String,
3809    /// `inherits_status`.
3810    pub inherits_status: bool,
3811    /// `type`.
3812    pub r#type: String,
3813    /// `url`.
3814    pub url: String,
3815    /// `app_url`.
3816    pub app_url: String,
3817    /// `bookmark_url`.
3818    #[serde(default, skip_serializing_if = "Option::is_none")]
3819    pub bookmark_url: Option<String>,
3820    /// `subscription_url`.
3821    #[serde(default, skip_serializing_if = "Option::is_none")]
3822    pub subscription_url: Option<String>,
3823    /// `comments_count`.
3824    #[serde(default, skip_serializing_if = "Option::is_none")]
3825    pub comments_count: Option<i32>,
3826    /// `comments_url`.
3827    #[serde(default, skip_serializing_if = "Option::is_none")]
3828    pub comments_url: Option<String>,
3829    /// `parent`.
3830    pub parent: RecordingParent,
3831    /// `bucket`.
3832    pub bucket: TodoBucket,
3833    /// `creator`.
3834    pub creator: Person,
3835    /// `subject`.
3836    pub subject: String,
3837    /// `content`.
3838    pub content: String,
3839    /// `content_attachments`.
3840    pub content_attachments: Vec<RichTextAttachment>,
3841    /// `category`.
3842    #[serde(default, skip_serializing_if = "Option::is_none")]
3843    pub category: Option<MessageType>,
3844    /// `boosts_count`.
3845    #[serde(default, skip_serializing_if = "Option::is_none")]
3846    pub boosts_count: Option<i32>,
3847    /// `boosts_url`.
3848    #[serde(default, skip_serializing_if = "Option::is_none")]
3849    pub boosts_url: Option<String>,
3850}
3851
3852/// The `MessageBoard` shape of the Basecamp API.
3853#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
3854#[non_exhaustive]
3855pub struct MessageBoard {
3856    /// `id`.
3857    pub id: i64,
3858    /// `status`.
3859    pub status: String,
3860    /// `visible_to_clients`.
3861    pub visible_to_clients: bool,
3862    /// `created_at`.
3863    pub created_at: DateTime,
3864    /// `updated_at`.
3865    pub updated_at: DateTime,
3866    /// `title`.
3867    pub title: String,
3868    /// `inherits_status`.
3869    pub inherits_status: bool,
3870    /// `type`.
3871    pub r#type: String,
3872    /// `url`.
3873    pub url: String,
3874    /// `app_url`.
3875    pub app_url: String,
3876    /// `bookmark_url`.
3877    #[serde(default, skip_serializing_if = "Option::is_none")]
3878    pub bookmark_url: Option<String>,
3879    /// `position`.
3880    #[serde(default, skip_serializing_if = "Option::is_none")]
3881    pub position: Option<i32>,
3882    /// `bucket`.
3883    pub bucket: TodoBucket,
3884    /// `creator`.
3885    pub creator: Person,
3886    /// `messages_count`.
3887    #[serde(default, skip_serializing_if = "Option::is_none")]
3888    pub messages_count: Option<i32>,
3889    /// `messages_url`.
3890    #[serde(default, skip_serializing_if = "Option::is_none")]
3891    pub messages_url: Option<String>,
3892    /// `app_messages_url`.
3893    #[serde(default, skip_serializing_if = "Option::is_none")]
3894    pub app_messages_url: Option<String>,
3895}
3896
3897/// The `MessageType` shape of the Basecamp API.
3898#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
3899#[non_exhaustive]
3900pub struct MessageType {
3901    /// `id`.
3902    pub id: i64,
3903    /// `name`.
3904    pub name: String,
3905    /// `icon`.
3906    pub icon: String,
3907    /// `created_at`.
3908    pub created_at: DateTime,
3909    /// `updated_at`.
3910    pub updated_at: DateTime,
3911}
3912
3913/// The `MoveCardColumnRequestContent` shape of the Basecamp API.
3914#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
3915pub struct MoveCardColumnRequestContent {
3916    /// The column to move.
3917    pub source_id: i64,
3918    /// The card table the column moves within: the same id as `cardTableId`.
3919    /// Basecamp refuses any other destination, a column included, with 422.
3920    pub target_id: i64,
3921    /// 1-based slot among the card table's columns, not counting Triage,
3922    /// Not Now or Done. 1 puts the column first; a slot past the last puts it
3923    /// last. Default: 1.
3924    #[serde(default, skip_serializing_if = "Option::is_none")]
3925    pub position: Option<i32>,
3926}
3927
3928/// The `MoveCardRequestContent` shape of the Basecamp API.
3929#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
3930pub struct MoveCardRequestContent {
3931    /// Any column in the card's project, on this or another card table, or a
3932    /// wormhole id to send the card to another project.
3933    pub column_id: i64,
3934    /// 1-indexed position within the destination column. Defaults to 1 (top).
3935    #[serde(default, skip_serializing_if = "Option::is_none")]
3936    pub position: Option<i32>,
3937}
3938
3939/// The `MoveRecordingRequestContent` shape of the Basecamp API.
3940#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
3941pub struct MoveRecordingRequestContent {
3942    /// The container to move into, of the kind the recording sits in now: a card
3943    /// table for a card, a message board for a message, a vault for a document,
3944    /// upload, cloud file, Google document or folder, a schedule for a schedule
3945    /// entry, a questionnaire for a check-in question, an inbox for an email
3946    /// forward, a to-do set for a to-do list, and a to-do list, in this project
3947    /// or another, for a to-do or to-do list group. For a dock tool, the
3948    /// destination project's dock. Give this or destination_project_id.
3949    #[serde(default, skip_serializing_if = "Option::is_none")]
3950    pub filing_destination_id: Option<i64>,
3951    /// The project to move a dock tool to. Applies to tools only, and wins over
3952    /// filing_destination_id when a request for a tool gives both.
3953    #[serde(default, skip_serializing_if = "Option::is_none")]
3954    pub destination_project_id: Option<i64>,
3955    /// When moving into a vault, a folder inside it to put the recording in.
3956    #[serde(default, skip_serializing_if = "Option::is_none")]
3957    pub parent_id: Option<i64>,
3958}
3959
3960/// `MoveRecordingResponseContent`.
3961pub type MoveRecordingResponseContent = Filing;
3962
3963/// The `MoveRecordingToVaultRequestContent` shape of the Basecamp API.
3964#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
3965pub struct MoveRecordingToVaultRequestContent {
3966    /// The destination vault. The recording's current vault keeps it where it is
3967    /// and changes only its position.
3968    pub parent_id: i64,
3969    /// 1-indexed position within the destination vault. Defaults to 1 (first); a
3970    /// position past the end places it last.
3971    #[serde(default, skip_serializing_if = "Option::is_none")]
3972    pub position: Option<i32>,
3973}
3974
3975/// The `MyAssignment` shape of the Basecamp API.
3976#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
3977#[non_exhaustive]
3978pub struct MyAssignment {
3979    /// `id`.
3980    pub id: i64,
3981    /// `app_url`.
3982    #[serde(default, skip_serializing_if = "Option::is_none")]
3983    pub app_url: Option<String>,
3984    /// `content`.
3985    #[serde(default, skip_serializing_if = "Option::is_none")]
3986    pub content: Option<String>,
3987    /// `starts_on`.
3988    #[serde(default, skip_serializing_if = "Option::is_none")]
3989    pub starts_on: Option<Date>,
3990    /// `due_on`.
3991    #[serde(default, skip_serializing_if = "Option::is_none")]
3992    pub due_on: Option<Date>,
3993    /// `bucket`.
3994    #[serde(default, skip_serializing_if = "Option::is_none")]
3995    pub bucket: Option<MyAssignmentBucket>,
3996    /// `completed`.
3997    #[serde(default, skip_serializing_if = "Option::is_none")]
3998    pub completed: Option<bool>,
3999    /// `type`.
4000    #[serde(default, skip_serializing_if = "Option::is_none")]
4001    pub r#type: Option<String>,
4002    /// `assignees`.
4003    #[serde(default, skip_serializing_if = "Option::is_none")]
4004    pub assignees: Option<Vec<MyAssignmentAssignee>>,
4005    /// `comments_count`.
4006    #[serde(default, skip_serializing_if = "Option::is_none")]
4007    pub comments_count: Option<i32>,
4008    /// `has_description`.
4009    #[serde(default, skip_serializing_if = "Option::is_none")]
4010    pub has_description: Option<bool>,
4011    /// Present on priority items
4012    #[serde(default, skip_serializing_if = "Option::is_none")]
4013    pub priority_recording_id: Option<i64>,
4014    /// `parent`.
4015    #[serde(default, skip_serializing_if = "Option::is_none")]
4016    pub parent: Option<MyAssignmentParent>,
4017    /// `children`.
4018    #[serde(default, skip_serializing_if = "Option::is_none")]
4019    pub children: Option<Vec<MyAssignment>>,
4020}
4021
4022/// A person as bc3's `people/_person_minimal.json.jbuilder` renders them —
4023/// the same three-key partial behind UpcomingSchedulePerson and
4024/// OutOfOfficePerson. All three keys are emitted unconditionally, so all
4025/// three are required.
4026#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
4027#[non_exhaustive]
4028pub struct MyAssignmentAssignee {
4029    /// `id`.
4030    pub id: i64,
4031    /// `name`.
4032    pub name: String,
4033    /// `avatar_url`.
4034    pub avatar_url: String,
4035}
4036
4037/// The `MyAssignmentBucket` shape of the Basecamp API.
4038#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
4039#[non_exhaustive]
4040pub struct MyAssignmentBucket {
4041    /// `id`.
4042    pub id: i64,
4043    /// `name`.
4044    #[serde(default, skip_serializing_if = "Option::is_none")]
4045    pub name: Option<String>,
4046    /// `app_url`.
4047    #[serde(default, skip_serializing_if = "Option::is_none")]
4048    pub app_url: Option<String>,
4049}
4050
4051/// The `MyAssignmentParent` shape of the Basecamp API.
4052#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
4053#[non_exhaustive]
4054pub struct MyAssignmentParent {
4055    /// `id`.
4056    pub id: i64,
4057    /// `title`.
4058    #[serde(default, skip_serializing_if = "Option::is_none")]
4059    pub title: Option<String>,
4060    /// `app_url`.
4061    #[serde(default, skip_serializing_if = "Option::is_none")]
4062    pub app_url: Option<String>,
4063}
4064
4065/// The per-user notebook note (wire type Notebook::Note). Before the first
4066/// write, id/created_at/updated_at are present-but-null (required-nullable,
4067/// layered in the OpenAPI via jsonAdd) and content is empty.
4068#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
4069#[non_exhaustive]
4070pub struct MyNote {
4071    /// Null until the note is first written.
4072    #[serde(deserialize_with = "serde::Deserialize::deserialize")]
4073    pub id: Option<i64>,
4074    /// `type`.
4075    pub r#type: String,
4076    /// Null until the note is first written.
4077    #[serde(deserialize_with = "serde::Deserialize::deserialize")]
4078    pub created_at: Option<DateTime>,
4079    /// Null until the note is first written.
4080    #[serde(deserialize_with = "serde::Deserialize::deserialize")]
4081    pub updated_at: Option<DateTime>,
4082    /// `content`.
4083    pub content: String,
4084    /// `content_attachments`.
4085    pub content_attachments: Vec<RichTextAttachment>,
4086    /// `url`.
4087    pub url: String,
4088    /// `app_url`.
4089    pub app_url: String,
4090}
4091
4092/// The writable note payload — the wire body is the nested {note: {content}}
4093/// envelope, the ProjectConstructionAttributes treatment.
4094#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
4095pub struct MyNoteAttributes {
4096    /// The note's rich-text body (HTML).
4097    pub content: String,
4098}
4099
4100/// The `NotFoundErrorResponseContent` shape of the Basecamp API.
4101#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
4102#[non_exhaustive]
4103pub struct NotFoundErrorResponseContent {
4104    /// `error`.
4105    pub error: String,
4106    /// `message`.
4107    #[serde(default, skip_serializing_if = "Option::is_none")]
4108    pub message: Option<String>,
4109}
4110
4111/// The `Notification` shape of the Basecamp API.
4112#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
4113#[non_exhaustive]
4114pub struct Notification {
4115    /// `id`.
4116    pub id: i64,
4117    /// `created_at`.
4118    pub created_at: DateTime,
4119    /// `updated_at`.
4120    pub updated_at: DateTime,
4121    /// The notification category: `inbox`, `chats`, `pings`, `bubbles`,
4122    /// or `mentions`.
4123    #[serde(default, skip_serializing_if = "Option::is_none")]
4124    pub section: Option<String>,
4125    /// `unread_count`.
4126    #[serde(default, skip_serializing_if = "Option::is_none")]
4127    pub unread_count: Option<i32>,
4128    /// `unread_at`.
4129    #[serde(default, skip_serializing_if = "Option::is_none")]
4130    pub unread_at: Option<DateTime>,
4131    /// `read_at`.
4132    #[serde(default, skip_serializing_if = "Option::is_none")]
4133    pub read_at: Option<DateTime>,
4134    /// `readable_sgid`.
4135    #[serde(default, skip_serializing_if = "Option::is_none")]
4136    pub readable_sgid: Option<String>,
4137    /// `readable_identifier`.
4138    #[serde(default, skip_serializing_if = "Option::is_none")]
4139    pub readable_identifier: Option<String>,
4140    /// `title`.
4141    #[serde(default, skip_serializing_if = "Option::is_none")]
4142    pub title: Option<String>,
4143    /// `type`.
4144    #[serde(default, skip_serializing_if = "Option::is_none")]
4145    pub r#type: Option<String>,
4146    /// `bucket_name`.
4147    #[serde(default, skip_serializing_if = "Option::is_none")]
4148    pub bucket_name: Option<String>,
4149    /// `creator`.
4150    #[serde(default, skip_serializing_if = "Option::is_none")]
4151    pub creator: Option<Person>,
4152    /// `content_excerpt`.
4153    #[serde(default, skip_serializing_if = "Option::is_none")]
4154    pub content_excerpt: Option<String>,
4155    /// `app_url`.
4156    #[serde(default, skip_serializing_if = "Option::is_none")]
4157    pub app_url: Option<String>,
4158    /// `unread_url`.
4159    #[serde(default, skip_serializing_if = "Option::is_none")]
4160    pub unread_url: Option<String>,
4161    /// `bookmark_url`.
4162    #[serde(default, skip_serializing_if = "Option::is_none")]
4163    pub bookmark_url: Option<String>,
4164    /// `memory_url`.
4165    #[serde(default, skip_serializing_if = "Option::is_none")]
4166    pub memory_url: Option<String>,
4167    /// URL for the Bubble Up record covering this notification (BC5 addition).
4168    /// Eligibility-gated — only present on items the current user can bubble up.
4169    #[serde(default, skip_serializing_if = "Option::is_none")]
4170    pub bubble_up_url: Option<String>,
4171    /// Scheduled resurfacing time when this item is queued as a scheduled
4172    /// Bubble Up (BC5 addition). Absent when there is no scheduled time.
4173    #[serde(default, skip_serializing_if = "Option::is_none")]
4174    pub bubble_up_at: Option<DateTime>,
4175    /// `subscription_url`.
4176    #[serde(default, skip_serializing_if = "Option::is_none")]
4177    pub subscription_url: Option<String>,
4178    /// `subscribed`.
4179    #[serde(default, skip_serializing_if = "Option::is_none")]
4180    pub subscribed: Option<bool>,
4181    /// `previewable_attachments`.
4182    #[serde(default, skip_serializing_if = "Option::is_none")]
4183    pub previewable_attachments: Option<Vec<PreviewableAttachment>>,
4184    /// Present on ping notifications
4185    #[serde(
4186        default,
4187        deserialize_with = "crate::types::person_list::deserialize_optional",
4188        skip_serializing_if = "Option::is_none"
4189    )]
4190    pub participants: Option<Vec<Person>>,
4191    /// Whether the ping has a custom name (pings only)
4192    #[serde(default, skip_serializing_if = "Option::is_none")]
4193    pub named: Option<bool>,
4194    /// Custom image URL (pings only)
4195    #[serde(default, skip_serializing_if = "Option::is_none")]
4196    pub image_url: Option<String>,
4197}
4198
4199/// When out of office is not enabled, `enabled` is `false` and
4200/// `start_date`, `end_date`, and `back_on_date` are omitted.
4201#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
4202#[non_exhaustive]
4203pub struct OutOfOffice {
4204    /// `person`.
4205    #[serde(default, skip_serializing_if = "Option::is_none")]
4206    pub person: Option<OutOfOfficePerson>,
4207    /// `enabled`.
4208    #[serde(default, skip_serializing_if = "Option::is_none")]
4209    pub enabled: Option<bool>,
4210    /// `ongoing`.
4211    #[serde(default, skip_serializing_if = "Option::is_none")]
4212    pub ongoing: Option<bool>,
4213    /// `start_date`.
4214    #[serde(default, skip_serializing_if = "Option::is_none")]
4215    pub start_date: Option<String>,
4216    /// `end_date`.
4217    #[serde(default, skip_serializing_if = "Option::is_none")]
4218    pub end_date: Option<String>,
4219    /// First working day after the out-of-office window ends.
4220    /// Omitted when out of office is not enabled.
4221    #[serde(default, skip_serializing_if = "Option::is_none")]
4222    pub back_on_date: Option<String>,
4223}
4224
4225/// The `OutOfOfficePayload` shape of the Basecamp API.
4226#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
4227pub struct OutOfOfficePayload {
4228    /// Start date in ISO 8601 format (YYYY-MM-DD)
4229    pub start_date: String,
4230    /// End date in ISO 8601 format (YYYY-MM-DD)
4231    pub end_date: String,
4232}
4233
4234/// A person as bc3's `people/_person_minimal.json.jbuilder` renders them —
4235/// the same three-key partial behind UpcomingSchedulePerson and
4236/// MyAssignmentAssignee. All three keys are emitted unconditionally, so all
4237/// three are required.
4238#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
4239#[non_exhaustive]
4240pub struct OutOfOfficePerson {
4241    /// `id`.
4242    pub id: i64,
4243    /// `name`.
4244    pub name: String,
4245    /// `avatar_url`.
4246    pub avatar_url: String,
4247}
4248
4249/// The `PauseQuestionResponseContent` shape of the Basecamp API.
4250#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
4251#[non_exhaustive]
4252pub struct PauseQuestionResponseContent {
4253    /// `paused`.
4254    #[serde(default, skip_serializing_if = "Option::is_none")]
4255    pub paused: Option<bool>,
4256}
4257
4258/// The copy requires confirmation before granting destination-project access
4259/// to people referenced by the template.
4260#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
4261#[non_exhaustive]
4262pub struct PeopleConfirmationRequiredErrorResponseContent {
4263    /// `error`.
4264    pub error: String,
4265    /// `people`.
4266    pub people: Vec<TemplateLibraryConfirmationPerson>,
4267}
4268
4269/// The `Person` shape of the Basecamp API.
4270#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
4271#[non_exhaustive]
4272pub struct Person {
4273    /// `id`.
4274    #[serde(default, deserialize_with = "crate::types::flexible_i64::deserialize")]
4275    pub id: i64,
4276    /// `attachable_sgid`.
4277    #[serde(default, skip_serializing_if = "Option::is_none")]
4278    pub attachable_sgid: Option<String>,
4279    /// `name`.
4280    pub name: SensitiveString,
4281    /// `email_address`.
4282    #[serde(default, skip_serializing_if = "Option::is_none")]
4283    pub email_address: Option<SensitiveString>,
4284    /// `personable_type`.
4285    #[serde(default, skip_serializing_if = "Option::is_none")]
4286    pub personable_type: Option<String>,
4287    /// `title`.
4288    #[serde(default, skip_serializing_if = "Option::is_none")]
4289    pub title: Option<String>,
4290    /// `bio`.
4291    #[serde(default, skip_serializing_if = "Option::is_none")]
4292    pub bio: Option<String>,
4293    /// Alias of `bio` introduced in BC5. BC3 emits both keys with identical content;
4294    /// older BC4 responses may omit `tagline`. Prefer `bio` for cross-version reads.
4295    #[serde(default, skip_serializing_if = "Option::is_none")]
4296    pub tagline: Option<String>,
4297    /// `location`.
4298    #[serde(default, skip_serializing_if = "Option::is_none")]
4299    pub location: Option<String>,
4300    /// `created_at`.
4301    #[serde(default, skip_serializing_if = "Option::is_none")]
4302    pub created_at: Option<DateTime>,
4303    /// `updated_at`.
4304    #[serde(default, skip_serializing_if = "Option::is_none")]
4305    pub updated_at: Option<DateTime>,
4306    /// `admin`.
4307    #[serde(default, skip_serializing_if = "Option::is_none")]
4308    pub admin: Option<bool>,
4309    /// `owner`.
4310    #[serde(default, skip_serializing_if = "Option::is_none")]
4311    pub owner: Option<bool>,
4312    /// `client`.
4313    #[serde(default, skip_serializing_if = "Option::is_none")]
4314    pub client: Option<bool>,
4315    /// `employee`.
4316    #[serde(default, skip_serializing_if = "Option::is_none")]
4317    pub employee: Option<bool>,
4318    /// `time_zone`.
4319    #[serde(default, skip_serializing_if = "Option::is_none")]
4320    pub time_zone: Option<String>,
4321    /// `avatar_url`.
4322    #[serde(default, skip_serializing_if = "Option::is_none")]
4323    pub avatar_url: Option<SensitiveString>,
4324    /// `company`.
4325    #[serde(default, skip_serializing_if = "Option::is_none")]
4326    pub company: Option<PersonCompany>,
4327    /// `can_manage_projects`.
4328    #[serde(default, skip_serializing_if = "Option::is_none")]
4329    pub can_manage_projects: Option<bool>,
4330    /// `can_manage_people`.
4331    #[serde(default, skip_serializing_if = "Option::is_none")]
4332    pub can_manage_people: Option<bool>,
4333    /// `can_ping`.
4334    #[serde(default, skip_serializing_if = "Option::is_none")]
4335    pub can_ping: Option<bool>,
4336    /// `can_access_timesheet`.
4337    #[serde(default, skip_serializing_if = "Option::is_none")]
4338    pub can_access_timesheet: Option<bool>,
4339    /// `can_access_hill_charts`.
4340    #[serde(default, skip_serializing_if = "Option::is_none")]
4341    pub can_access_hill_charts: Option<bool>,
4342}
4343
4344/// The `PersonCompany` shape of the Basecamp API.
4345#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
4346#[non_exhaustive]
4347pub struct PersonCompany {
4348    /// `id`.
4349    pub id: i64,
4350    /// `name`.
4351    pub name: String,
4352}
4353
4354/// A Ping: a private conversation between people, held in its own bucket with
4355/// one Campfire. The Campfire's lines are read and written through the
4356/// Campfires service; `room_url` and `links.lines` name it.
4357#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
4358#[non_exhaustive]
4359pub struct Ping {
4360    /// The Ping's id, which is also its bucket's id.
4361    pub id: i64,
4362    /// `created_at`.
4363    pub created_at: DateTime,
4364    /// `updated_at`.
4365    pub updated_at: DateTime,
4366    /// The Ping's name for the caller: its given name when `named`, else the
4367    /// names of the other people in it.
4368    pub title: String,
4369    /// Whether someone gave the Ping a name.
4370    pub named: bool,
4371    /// The Ping's own image, present only when one was uploaded.
4372    #[serde(default, skip_serializing_if = "Option::is_none")]
4373    pub image_url: Option<String>,
4374    /// `avatar_url`.
4375    pub avatar_url: SensitiveString,
4376    /// `url`.
4377    pub url: String,
4378    /// `app_url`.
4379    pub app_url: String,
4380    /// `bookmark_url`.
4381    pub bookmark_url: String,
4382    /// The Ping's Campfire (`/buckets/{bucketId}/chats/{campfireId}.json`).
4383    pub room_url: String,
4384    /// Present only when the Ping can be renamed: one with more than one other
4385    /// person in it.
4386    #[serde(default, skip_serializing_if = "Option::is_none")]
4387    pub edit_title_url: Option<String>,
4388    /// `links`.
4389    pub links: PingLinks,
4390    /// The people in the Ping other than the caller; the caller alone when
4391    /// nobody else is in it.
4392    #[serde(deserialize_with = "crate::types::person_list::deserialize")]
4393    pub people: Vec<Person>,
4394}
4395
4396/// The Ping's Campfire endpoints, so a client need not derive them from
4397/// `room_url`. The wire object also repeats `url`, `app_url`, `bookmark_url`
4398/// and `edit_title_url` as `self`, `app`, `bookmark` and `edit_title`; those
4399/// are read from the Ping's own fields.
4400#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
4401#[non_exhaustive]
4402pub struct PingLinks {
4403    /// The Campfire's lines (`/buckets/{bucketId}/chats/{campfireId}/lines.json`).
4404    pub lines: String,
4405    /// The Campfire's uploads.
4406    pub files: String,
4407}
4408
4409/// The poll envelope. Every 200 carries `events` and `position`; `next` only
4410/// while the walk continues.
4411#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
4412#[non_exhaustive]
4413pub struct PollEventsResponseContent {
4414    /// Up to 100 events, oldest first, strict event-id order. A page may be empty
4415    /// while the walk crosses history the filters exclude — keep following `next`.
4416    pub events: Vec<FeedEvent>,
4417    /// Durable position token for resuming later. Persist only after the page's
4418    /// events have been processed.
4419    pub position: String,
4420    /// Absolute continuation URL, present only while the current walk has more
4421    /// to serve; absent means the walk reached its (frozen) head — poll again
4422    /// later from `position`.
4423    #[serde(default, skip_serializing_if = "Option::is_none")]
4424    pub next: Option<String>,
4425}
4426
4427/// The inbox envelope: `items` and `position` on every 200, `next` while the
4428/// walk continues.
4429#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
4430#[non_exhaustive]
4431pub struct PollInboxResponseContent {
4432    /// `items`.
4433    pub items: Vec<InboxItem>,
4434    /// Durable inbox position. Persist only after the page's items have been
4435    /// processed.
4436    pub position: String,
4437    /// Absolute continuation URL, present only while the walk has more to serve.
4438    #[serde(default, skip_serializing_if = "Option::is_none")]
4439    pub next: Option<String>,
4440}
4441
4442/// The `Preferences` shape of the Basecamp API.
4443#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
4444#[non_exhaustive]
4445pub struct Preferences {
4446    /// `url`.
4447    #[serde(default, skip_serializing_if = "Option::is_none")]
4448    pub url: Option<String>,
4449    /// `app_url`.
4450    #[serde(default, skip_serializing_if = "Option::is_none")]
4451    pub app_url: Option<String>,
4452    /// Returned as a Rails-style name (e.g. "Central Time (US & Canada)").
4453    #[serde(default, skip_serializing_if = "Option::is_none")]
4454    pub time_zone_name: Option<String>,
4455    /// `first_week_day`.
4456    #[serde(default, skip_serializing_if = "Option::is_none")]
4457    pub first_week_day: Option<String>,
4458    /// `time_format`.
4459    #[serde(default, skip_serializing_if = "Option::is_none")]
4460    pub time_format: Option<String>,
4461}
4462
4463/// The `PreferencesPayload` shape of the Basecamp API.
4464#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
4465pub struct PreferencesPayload {
4466    /// Time zone name. Accepts any valid Rails time zone name (e.g.
4467    /// "London", "UTC") as well as IANA identifiers (e.g.
4468    /// "America/Chicago"), which are normalized to the matching
4469    /// Rails-style name before saving.
4470    #[serde(default, skip_serializing_if = "Option::is_none")]
4471    pub time_zone_name: Option<String>,
4472    /// First day of the week: Sunday, Monday, Tuesday, etc.
4473    #[serde(default, skip_serializing_if = "Option::is_none")]
4474    pub first_week_day: Option<String>,
4475    /// Time display format: twelve_hour or twenty_four_hour
4476    #[serde(default, skip_serializing_if = "Option::is_none")]
4477    pub time_format: Option<String>,
4478}
4479
4480/// The `PreviewableAttachment` shape of the Basecamp API.
4481#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
4482#[non_exhaustive]
4483pub struct PreviewableAttachment {
4484    /// `id`.
4485    #[serde(default, skip_serializing_if = "Option::is_none")]
4486    pub id: Option<i64>,
4487    /// `url`.
4488    #[serde(default, skip_serializing_if = "Option::is_none")]
4489    pub url: Option<String>,
4490    /// `app_url`.
4491    #[serde(default, skip_serializing_if = "Option::is_none")]
4492    pub app_url: Option<String>,
4493    /// `content_type`.
4494    #[serde(default, skip_serializing_if = "Option::is_none")]
4495    pub content_type: Option<String>,
4496    /// `filename`.
4497    #[serde(default, skip_serializing_if = "Option::is_none")]
4498    pub filename: Option<String>,
4499    /// `filesize`.
4500    #[serde(default, skip_serializing_if = "Option::is_none")]
4501    pub filesize: Option<i64>,
4502    /// `width`.
4503    #[serde(default, skip_serializing_if = "Option::is_none")]
4504    pub width: Option<i32>,
4505    /// `height`.
4506    #[serde(default, skip_serializing_if = "Option::is_none")]
4507    pub height: Option<i32>,
4508}
4509
4510/// The `PrioritizeAssignmentRequestContent` shape of the Basecamp API.
4511#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
4512pub struct PrioritizeAssignmentRequestContent {
4513    /// The recording id to prioritize.
4514    pub id: i64,
4515}
4516
4517/// The `Project` shape of the Basecamp API.
4518#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
4519#[non_exhaustive]
4520pub struct Project {
4521    /// `id`.
4522    pub id: i64,
4523    /// active|archived|trashed
4524    pub status: String,
4525    /// `created_at`.
4526    pub created_at: DateTime,
4527    /// `updated_at`.
4528    pub updated_at: DateTime,
4529    /// `name`.
4530    pub name: String,
4531    /// `description`.
4532    #[serde(default, skip_serializing_if = "Option::is_none")]
4533    pub description: Option<String>,
4534    /// `purpose`.
4535    #[serde(default, skip_serializing_if = "Option::is_none")]
4536    pub purpose: Option<String>,
4537    /// `start_date`.
4538    #[serde(default, skip_serializing_if = "Option::is_none")]
4539    pub start_date: Option<String>,
4540    /// `end_date`.
4541    #[serde(default, skip_serializing_if = "Option::is_none")]
4542    pub end_date: Option<String>,
4543    /// `clients_enabled`.
4544    #[serde(default, skip_serializing_if = "Option::is_none")]
4545    pub clients_enabled: Option<bool>,
4546    /// True when the project's timesheet is turned on. The project timesheet
4547    /// report (GET /projects/{projectId}/timesheet.json) answers 404 until it is.
4548    #[serde(default, skip_serializing_if = "Option::is_none")]
4549    pub timesheet_enabled: Option<bool>,
4550    /// `bookmark_url`.
4551    #[serde(default, skip_serializing_if = "Option::is_none")]
4552    pub bookmark_url: Option<String>,
4553    /// Bucket stars collection for this project (`/buckets/{id}/stars.json`).
4554    #[serde(default, skip_serializing_if = "Option::is_none")]
4555    pub star_url: Option<String>,
4556    /// `url`.
4557    pub url: String,
4558    /// `app_url`.
4559    pub app_url: String,
4560    /// `dock`.
4561    #[serde(default, skip_serializing_if = "Option::is_none")]
4562    pub dock: Option<Vec<DockItem>>,
4563    /// True when the project is pinned on the current user's home page at all,
4564    /// whether starred or filed into a stack.
4565    #[serde(default, skip_serializing_if = "Option::is_none")]
4566    pub bookmarked: Option<bool>,
4567    /// True only when the project carries a star on the current user's home page.
4568    #[serde(default, skip_serializing_if = "Option::is_none")]
4569    pub starred: Option<bool>,
4570    /// `client_company`.
4571    #[serde(default, skip_serializing_if = "Option::is_none")]
4572    pub client_company: Option<ClientCompany>,
4573    /// `wallpaper`.
4574    #[serde(default, skip_serializing_if = "Option::is_none")]
4575    pub wallpaper: Option<ProjectWallpaper>,
4576    /// `logo`.
4577    #[serde(default, skip_serializing_if = "Option::is_none")]
4578    pub logo: Option<ProjectLogo>,
4579    /// `clientside`.
4580    #[deprecated(
4581        note = "This shape is deprecated since 2024-01: Use Client Visibility feature instead"
4582    )]
4583    #[serde(default, skip_serializing_if = "Option::is_none")]
4584    pub clientside: Option<ClientSide>,
4585}
4586
4587/// The `ProjectAccessResult` shape of the Basecamp API.
4588#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
4589#[non_exhaustive]
4590pub struct ProjectAccessResult {
4591    /// `granted`.
4592    #[serde(
4593        default,
4594        deserialize_with = "crate::types::person_list::deserialize_optional",
4595        skip_serializing_if = "Option::is_none"
4596    )]
4597    pub granted: Option<Vec<Person>>,
4598    /// `revoked`.
4599    #[serde(
4600        default,
4601        deserialize_with = "crate::types::person_list::deserialize_optional",
4602        skip_serializing_if = "Option::is_none"
4603    )]
4604    pub revoked: Option<Vec<Person>>,
4605}
4606
4607/// The project's client-enablement state after a toggle.
4608#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
4609#[non_exhaustive]
4610pub struct ProjectClientEnablement {
4611    /// `clients_enabled`.
4612    pub clients_enabled: bool,
4613}
4614
4615/// The `ProjectConstruction` shape of the Basecamp API.
4616#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
4617#[non_exhaustive]
4618pub struct ProjectConstruction {
4619    /// `id`.
4620    pub id: i64,
4621    /// `status`.
4622    pub status: String,
4623    /// `url`.
4624    #[serde(default, skip_serializing_if = "Option::is_none")]
4625    pub url: Option<String>,
4626    /// `project`.
4627    #[serde(default, skip_serializing_if = "Option::is_none")]
4628    pub project: Option<Project>,
4629}
4630
4631/// The `ProjectConstructionAttributes` shape of the Basecamp API.
4632#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
4633pub struct ProjectConstructionAttributes {
4634    /// `name`.
4635    pub name: String,
4636    /// `description`.
4637    #[serde(default, skip_serializing_if = "Option::is_none")]
4638    pub description: Option<String>,
4639    /// Date the new project starts on. Template dates are relative to the start
4640    /// of the template's first week, and template weeks start on a Sunday, so
4641    /// the project's dates are anchored to the Sunday on or before this date.
4642    /// Omitted, they are anchored to the week in which the construction is
4643    /// processed.
4644    #[serde(default, skip_serializing_if = "Option::is_none")]
4645    pub start_date: Option<String>,
4646    /// Who can join the new project: invite, employee or team. Basecamp stores this with the construction
4647    /// and applies it when the project is built, so a value outside the enum
4648    /// isn't refused up front: the construction fails.
4649    #[serde(default, skip_serializing_if = "Option::is_none")]
4650    pub admissions: Option<String>,
4651    /// Turn on the new project's timesheet. Basecamp ignores this when the
4652    /// caller can't use timesheets (the account lacks them, or the caller is a
4653    /// client).
4654    #[serde(default, skip_serializing_if = "Option::is_none")]
4655    pub timesheet_enabled: Option<bool>,
4656}
4657
4658/// The account has reached its project limit. Raised by CreateProject and by
4659/// UnarchiveProject, both of which add to the active project count.
4660#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
4661#[non_exhaustive]
4662pub struct ProjectLimitErrorResponseContent {
4663    /// `error`.
4664    pub error: String,
4665    /// `message`.
4666    #[serde(default, skip_serializing_if = "Option::is_none")]
4667    pub message: Option<String>,
4668}
4669
4670/// The project's logo, included only in single-project responses when attached.
4671/// Project lists and home responses omit it. Absent logos omit this member, not null.
4672#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
4673#[non_exhaustive]
4674pub struct ProjectLogo {
4675    /// An authenticated API-host URL that redirects to storage, not a public image link.
4676    /// Use the SDK's authenticated download helper rather than an image element.
4677    pub url: String,
4678}
4679
4680/// The project's wallpaper, included only in single-project responses when attached.
4681/// Project lists and home responses omit it.
4682#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
4683#[non_exhaustive]
4684pub struct ProjectWallpaper {
4685    /// An authenticated API-host URL that redirects to the wallpaper image in storage, not a public image link.
4686    /// Use the SDK's authenticated download helper instead of placing this URL directly in an image element.
4687    pub url: String,
4688    /// fill|tile
4689    pub mode: String,
4690}
4691
4692/// The `Question` shape of the Basecamp API.
4693#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
4694#[non_exhaustive]
4695pub struct Question {
4696    /// `id`.
4697    pub id: i64,
4698    /// `status`.
4699    pub status: String,
4700    /// `visible_to_clients`.
4701    pub visible_to_clients: bool,
4702    /// `created_at`.
4703    pub created_at: DateTime,
4704    /// `updated_at`.
4705    pub updated_at: DateTime,
4706    /// `title`.
4707    pub title: String,
4708    /// `inherits_status`.
4709    pub inherits_status: bool,
4710    /// `type`.
4711    pub r#type: String,
4712    /// `url`.
4713    pub url: String,
4714    /// `app_url`.
4715    pub app_url: String,
4716    /// `bookmark_url`.
4717    #[serde(default, skip_serializing_if = "Option::is_none")]
4718    pub bookmark_url: Option<String>,
4719    /// `subscription_url`.
4720    #[serde(default, skip_serializing_if = "Option::is_none")]
4721    pub subscription_url: Option<String>,
4722    /// `parent`.
4723    pub parent: RecordingParent,
4724    /// `bucket`.
4725    pub bucket: RecordingBucket,
4726    /// `creator`.
4727    pub creator: Person,
4728    /// `paused`.
4729    #[serde(default, skip_serializing_if = "Option::is_none")]
4730    pub paused: Option<bool>,
4731    /// `schedule`.
4732    #[serde(default, skip_serializing_if = "Option::is_none")]
4733    pub schedule: Option<QuestionSchedule>,
4734    /// `answers_count`.
4735    #[serde(default, skip_serializing_if = "Option::is_none")]
4736    pub answers_count: Option<i32>,
4737    /// `answers_url`.
4738    #[serde(default, skip_serializing_if = "Option::is_none")]
4739    pub answers_url: Option<String>,
4740}
4741
4742/// The `QuestionAnswer` shape of the Basecamp API.
4743#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
4744#[non_exhaustive]
4745pub struct QuestionAnswer {
4746    /// `id`.
4747    pub id: i64,
4748    /// `status`.
4749    pub status: String,
4750    /// `visible_to_clients`.
4751    pub visible_to_clients: bool,
4752    /// `created_at`.
4753    pub created_at: DateTime,
4754    /// `updated_at`.
4755    pub updated_at: DateTime,
4756    /// `title`.
4757    pub title: String,
4758    /// `inherits_status`.
4759    pub inherits_status: bool,
4760    /// `type`.
4761    pub r#type: String,
4762    /// `url`.
4763    pub url: String,
4764    /// `app_url`.
4765    pub app_url: String,
4766    /// `bookmark_url`.
4767    #[serde(default, skip_serializing_if = "Option::is_none")]
4768    pub bookmark_url: Option<String>,
4769    /// `subscription_url`.
4770    #[serde(default, skip_serializing_if = "Option::is_none")]
4771    pub subscription_url: Option<String>,
4772    /// `comments_count`.
4773    #[serde(default, skip_serializing_if = "Option::is_none")]
4774    pub comments_count: Option<i32>,
4775    /// `comments_url`.
4776    #[serde(default, skip_serializing_if = "Option::is_none")]
4777    pub comments_url: Option<String>,
4778    /// `content`.
4779    pub content: String,
4780    /// `content_attachments`.
4781    pub content_attachments: Vec<RichTextAttachment>,
4782    /// `group_on`.
4783    #[serde(default, skip_serializing_if = "Option::is_none")]
4784    pub group_on: Option<Date>,
4785    /// `parent`.
4786    pub parent: RecordingParent,
4787    /// `bucket`.
4788    pub bucket: RecordingBucket,
4789    /// `creator`.
4790    pub creator: Person,
4791    /// `boosts_count`.
4792    #[serde(default, skip_serializing_if = "Option::is_none")]
4793    pub boosts_count: Option<i32>,
4794    /// `boosts_url`.
4795    #[serde(default, skip_serializing_if = "Option::is_none")]
4796    pub boosts_url: Option<String>,
4797}
4798
4799/// The `QuestionAnswerPayload` shape of the Basecamp API.
4800#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
4801pub struct QuestionAnswerPayload {
4802    /// `content`.
4803    pub content: String,
4804    /// `group_on`.
4805    #[serde(default, skip_serializing_if = "Option::is_none")]
4806    pub group_on: Option<Date>,
4807}
4808
4809/// The `QuestionAnswerUpdatePayload` shape of the Basecamp API.
4810#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
4811pub struct QuestionAnswerUpdatePayload {
4812    /// `content`.
4813    pub content: String,
4814    /// `group_on`.
4815    #[serde(default, skip_serializing_if = "Option::is_none")]
4816    pub group_on: Option<Date>,
4817}
4818
4819/// The `QuestionReminder` shape of the Basecamp API.
4820#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
4821#[non_exhaustive]
4822pub struct QuestionReminder {
4823    /// `reminder_id`.
4824    #[serde(default, skip_serializing_if = "Option::is_none")]
4825    pub reminder_id: Option<i64>,
4826    /// `remind_at`.
4827    #[serde(default, skip_serializing_if = "Option::is_none")]
4828    pub remind_at: Option<DateTime>,
4829    /// `group_on`.
4830    #[serde(default, skip_serializing_if = "Option::is_none")]
4831    pub group_on: Option<Date>,
4832    /// `question`.
4833    #[serde(default, skip_serializing_if = "Option::is_none")]
4834    pub question: Option<Question>,
4835}
4836
4837/// The `QuestionSchedule` shape of the Basecamp API.
4838#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
4839#[non_exhaustive]
4840pub struct QuestionSchedule {
4841    /// `frequency`.
4842    #[serde(default, skip_serializing_if = "Option::is_none")]
4843    pub frequency: Option<String>,
4844    /// `days`.
4845    #[serde(default, skip_serializing_if = "Option::is_none")]
4846    pub days: Option<Vec<i32>>,
4847    /// `hour`.
4848    #[serde(default, skip_serializing_if = "Option::is_none")]
4849    pub hour: Option<i32>,
4850    /// `minute`.
4851    #[serde(default, skip_serializing_if = "Option::is_none")]
4852    pub minute: Option<i32>,
4853    /// `week_instance`.
4854    #[serde(default, skip_serializing_if = "Option::is_none")]
4855    pub week_instance: Option<i32>,
4856    /// `week_interval`.
4857    #[serde(default, skip_serializing_if = "Option::is_none")]
4858    pub week_interval: Option<i32>,
4859    /// `month_interval`.
4860    #[serde(default, skip_serializing_if = "Option::is_none")]
4861    pub month_interval: Option<i32>,
4862    /// `start_date`.
4863    #[serde(default, skip_serializing_if = "Option::is_none")]
4864    pub start_date: Option<String>,
4865    /// `end_date`.
4866    #[serde(default, skip_serializing_if = "Option::is_none")]
4867    pub end_date: Option<String>,
4868}
4869
4870/// The schedule a question is created or updated with. BC3 reads the time of
4871/// day as a string ("5:00pm"); hour and minute appear only in responses.
4872#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
4873pub struct QuestionScheduleInput {
4874    /// `frequency`.
4875    #[serde(default, skip_serializing_if = "Option::is_none")]
4876    pub frequency: Option<String>,
4877    /// `days`.
4878    #[serde(default, skip_serializing_if = "Option::is_none")]
4879    pub days: Option<Vec<i32>>,
4880    /// `time_of_day`.
4881    #[serde(default, skip_serializing_if = "Option::is_none")]
4882    pub time_of_day: Option<String>,
4883    /// `week_instance`.
4884    #[serde(default, skip_serializing_if = "Option::is_none")]
4885    pub week_instance: Option<i32>,
4886    /// `start_date`.
4887    #[serde(default, skip_serializing_if = "Option::is_none")]
4888    pub start_date: Option<String>,
4889}
4890
4891/// The `Questionnaire` shape of the Basecamp API.
4892#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
4893#[non_exhaustive]
4894pub struct Questionnaire {
4895    /// `id`.
4896    pub id: i64,
4897    /// `status`.
4898    pub status: String,
4899    /// `visible_to_clients`.
4900    pub visible_to_clients: bool,
4901    /// `created_at`.
4902    pub created_at: DateTime,
4903    /// `updated_at`.
4904    pub updated_at: DateTime,
4905    /// `title`.
4906    pub title: String,
4907    /// `inherits_status`.
4908    pub inherits_status: bool,
4909    /// `type`.
4910    pub r#type: String,
4911    /// `url`.
4912    pub url: String,
4913    /// `app_url`.
4914    pub app_url: String,
4915    /// `bookmark_url`.
4916    #[serde(default, skip_serializing_if = "Option::is_none")]
4917    pub bookmark_url: Option<String>,
4918    /// `questions_url`.
4919    #[serde(default, skip_serializing_if = "Option::is_none")]
4920    pub questions_url: Option<String>,
4921    /// `questions_count`.
4922    #[serde(default, skip_serializing_if = "Option::is_none")]
4923    pub questions_count: Option<i32>,
4924    /// `name`.
4925    pub name: String,
4926    /// `bucket`.
4927    pub bucket: RecordingBucket,
4928    /// `creator`.
4929    pub creator: Person,
4930}
4931
4932/// The `RateLimitErrorResponseContent` shape of the Basecamp API.
4933#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
4934#[non_exhaustive]
4935pub struct RateLimitErrorResponseContent {
4936    /// `error`.
4937    pub error: String,
4938    /// `message`.
4939    #[serde(default, skip_serializing_if = "Option::is_none")]
4940    pub message: Option<String>,
4941    /// `retry_after`.
4942    #[serde(default, skip_serializing_if = "Option::is_none")]
4943    pub retry_after: Option<i32>,
4944}
4945
4946/// The `Recording` shape of the Basecamp API.
4947#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
4948#[non_exhaustive]
4949pub struct Recording {
4950    /// `id`.
4951    pub id: i64,
4952    /// `status`.
4953    pub status: String,
4954    /// `visible_to_clients`.
4955    pub visible_to_clients: bool,
4956    /// `created_at`.
4957    pub created_at: DateTime,
4958    /// `updated_at`.
4959    pub updated_at: DateTime,
4960    /// `title`.
4961    pub title: String,
4962    /// `inherits_status`.
4963    pub inherits_status: bool,
4964    /// `type`.
4965    pub r#type: String,
4966    /// API URL of the recording. Exception: in the `type=Door` (external-link)
4967    /// projection, `url` is the door's **external destination address** (e.g. the
4968    /// Figma/Dropbox URL) and `app_url` is the Basecamp redirector — see the
4969    /// door-specific `service`/`description` fields below.
4970    pub url: String,
4971    /// `app_url`.
4972    pub app_url: String,
4973    /// `bookmark_url`.
4974    #[serde(default, skip_serializing_if = "Option::is_none")]
4975    pub bookmark_url: Option<String>,
4976    /// URL of the Bubble Up record for this recording (BC5 addition). Optional
4977    /// here because this is a polymorphic projection:
4978    /// `recordings/_recording.json.jbuilder` emits the key only when the caller
4979    /// passes `local_assigns\[:bubbleupable\]`, and `todolists/_todolist` is the
4980    /// only partial that does. So a Todolist-shaped instance carries it and the
4981    /// other recording types do not.
4982    #[serde(default, skip_serializing_if = "Option::is_none")]
4983    pub bubble_up_url: Option<String>,
4984    /// `content`.
4985    #[serde(default, skip_serializing_if = "Option::is_none")]
4986    pub content: Option<String>,
4987    /// Rich-text companion arrays carried through the generic recording
4988    /// projection (`to_recordable_partial_path` renders the full type-specific
4989    /// partial). A given recording is one type, so it carries only the array
4990    /// matching its rich-text attribute (`content_attachments` for a
4991    /// Comment/Message, `description_attachments` for a Todo/Card); a
4992    /// webhook-sourced recording (base partial) carries neither. Optional (no
4993    /// `@required`), non-nullable.
4994    #[serde(default, skip_serializing_if = "Option::is_none")]
4995    pub content_attachments: Option<Vec<RichTextAttachment>>,
4996    /// See `content_attachments` — the description-attribute companion array.
4997    #[serde(default, skip_serializing_if = "Option::is_none")]
4998    pub description_attachments: Option<Vec<RichTextAttachment>>,
4999    /// `comments_count`.
5000    #[serde(default, skip_serializing_if = "Option::is_none")]
5001    pub comments_count: Option<i32>,
5002    /// `comments_url`.
5003    #[serde(default, skip_serializing_if = "Option::is_none")]
5004    pub comments_url: Option<String>,
5005    /// `subscription_url`.
5006    #[serde(default, skip_serializing_if = "Option::is_none")]
5007    pub subscription_url: Option<String>,
5008    /// Boost count/URL. Carried on boostable recordings — notably the account-wide
5009    /// aggregate feeds (`/messages.json`, `/comments.json`), whose type-specific
5010    /// partials render with `boostable: true`. Optional (absent on non-boostable
5011    /// recordings and on the base/webhook partial).
5012    #[serde(default, skip_serializing_if = "Option::is_none")]
5013    pub boosts_count: Option<i32>,
5014    /// `boosts_url`.
5015    #[serde(default, skip_serializing_if = "Option::is_none")]
5016    pub boosts_url: Option<String>,
5017    /// Subtask count/URL. Carried on subtaskable recordings — to-dos and cards,
5018    /// whose type-specific partials render with `subtaskable: true` (BC3
5019    /// #12659). Optional (absent on every other recording type and on the
5020    /// base/webhook partial).
5021    #[serde(default, skip_serializing_if = "Option::is_none")]
5022    pub subtasks_count: Option<i32>,
5023    /// `subtasks_completed_count`.
5024    #[serde(default, skip_serializing_if = "Option::is_none")]
5025    pub subtasks_completed_count: Option<i32>,
5026    /// `subtasks_url`.
5027    #[serde(default, skip_serializing_if = "Option::is_none")]
5028    pub subtasks_url: Option<String>,
5029    /// Message subject. Present on `Message` recordings — notably the account-wide
5030    /// `/messages.json` aggregate feed, whose message partial renders `subject`.
5031    #[serde(default, skip_serializing_if = "Option::is_none")]
5032    pub subject: Option<String>,
5033    /// `category`.
5034    #[serde(default, skip_serializing_if = "Option::is_none")]
5035    pub category: Option<RecordingCategory>,
5036    /// Check-in grouping date (YYYY-MM-DD). Present on automatic check-in answer
5037    /// (`Question::Answer`) recordings — notably the `/checkins.json` aggregate
5038    /// feed, whose answer partial renders `group_on`.
5039    #[serde(default, skip_serializing_if = "Option::is_none")]
5040    pub group_on: Option<Date>,
5041    /// Sender of an inbox forward. Present on `Inbox::Forward` recordings — notably
5042    /// the `/forwards.json` aggregate feed, whose forward partial renders `from`.
5043    #[serde(default, skip_serializing_if = "Option::is_none")]
5044    pub from: Option<String>,
5045    /// Reply count/URL for an inbox forward. Present on `Inbox::Forward`
5046    /// recordings — notably the `/forwards.json` aggregate feed.
5047    #[serde(default, skip_serializing_if = "Option::is_none")]
5048    pub replies_count: Option<i32>,
5049    /// `replies_url`.
5050    #[serde(default, skip_serializing_if = "Option::is_none")]
5051    pub replies_url: Option<String>,
5052    /// Ordinal position within the project's External links section. Present on
5053    /// `Door` (external-link) recordings.
5054    #[serde(default, skip_serializing_if = "Option::is_none")]
5055    pub position: Option<i32>,
5056    /// Rich-text (HTML) description shown beneath an external link. Present only
5057    /// on `Door` recordings returned by the `type=Door` recordings query (the only
5058    /// endpoint that returns the full door shape). The external destination
5059    /// address is `url` (not this field); `app_url` is the Basecamp redirector.
5060    /// See `spec/api-gaps/external-links-doors.md`.
5061    #[serde(default, skip_serializing_if = "Option::is_none")]
5062    pub description: Option<String>,
5063    /// `service`.
5064    #[serde(default, skip_serializing_if = "Option::is_none")]
5065    pub service: Option<DoorService>,
5066    /// `parent`.
5067    #[serde(default, skip_serializing_if = "Option::is_none")]
5068    pub parent: Option<RecordingParent>,
5069    /// `bucket`.
5070    pub bucket: RecordingBucket,
5071    /// `creator`.
5072    pub creator: Person,
5073}
5074
5075/// The `RecordingBucket` shape of the Basecamp API.
5076#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
5077#[non_exhaustive]
5078pub struct RecordingBucket {
5079    /// `id`.
5080    pub id: i64,
5081    /// `name`.
5082    pub name: String,
5083    /// `type`.
5084    pub r#type: String,
5085}
5086
5087/// A message category (type) as rendered by the shared recordings/_category
5088/// partial: id, display name, and icon. Present on categorized Message
5089/// recordings.
5090#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
5091#[non_exhaustive]
5092pub struct RecordingCategory {
5093    /// `id`.
5094    pub id: i64,
5095    /// `name`.
5096    pub name: String,
5097    /// `icon`.
5098    #[serde(default, skip_serializing_if = "Option::is_none")]
5099    pub icon: Option<String>,
5100}
5101
5102/// Who completed a to-do, card or subtask, and when.
5103#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
5104#[non_exhaustive]
5105pub struct RecordingCompletion {
5106    /// `created_at`.
5107    pub created_at: DateTime,
5108    /// `creator`.
5109    pub creator: Person,
5110}
5111
5112/// The `RecordingParent` shape of the Basecamp API.
5113#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
5114#[non_exhaustive]
5115pub struct RecordingParent {
5116    /// `id`.
5117    pub id: i64,
5118    /// `title`.
5119    pub title: String,
5120    /// `type`.
5121    pub r#type: String,
5122    /// `url`.
5123    pub url: String,
5124    /// `app_url`.
5125    pub app_url: String,
5126    /// `bucket`.
5127    #[serde(default, skip_serializing_if = "Option::is_none")]
5128    pub bucket: Option<RecordingBucket>,
5129}
5130
5131/// The `ReorderUpNextRequestContent` shape of the Basecamp API.
5132#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
5133pub struct ReorderUpNextRequestContent {
5134    /// The recording id to move, chosen the same way as when prioritizing.
5135    pub source_id: i64,
5136    /// The 1-based position to move it to.
5137    pub position: i32,
5138}
5139
5140/// The `ReplaceDocumentRequestContent` shape of the Basecamp API.
5141#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
5142pub struct ReplaceDocumentRequestContent {
5143    /// `title`.
5144    #[serde(default, skip_serializing_if = "Option::is_none")]
5145    pub title: Option<String>,
5146    /// `content`.
5147    #[serde(default, skip_serializing_if = "Option::is_none")]
5148    pub content: Option<String>,
5149}
5150
5151/// `ReplaceDocumentResponseContent`.
5152pub type ReplaceDocumentResponseContent = Document;
5153
5154/// The `ReplaceScheduleEntryRequestContent` shape of the Basecamp API.
5155#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
5156pub struct ReplaceScheduleEntryRequestContent {
5157    /// `summary`.
5158    #[serde(default, skip_serializing_if = "Option::is_none")]
5159    pub summary: Option<String>,
5160    /// The entry's start, as a bare date ("2026-06-01") for an all-day entry or a
5161    /// full timestamp otherwise. Same rule as CreateScheduleEntry: send it
5162    /// verbatim, never parsed and re-rendered.
5163    pub starts_at: String,
5164    /// The entry's end. See starts_at for the date-vs-timestamp rule.
5165    pub ends_at: String,
5166    /// `description`.
5167    #[serde(default, skip_serializing_if = "Option::is_none")]
5168    pub description: Option<String>,
5169    /// Replaces the entry's participants.
5170    ///
5171    /// Omitting this member preserves the current participants; sending an empty
5172    /// array clears them. That guarantee is BC3-side and recent: until
5173    /// basecamp/bc3#12425, `Schedules::EntriesController#update` called
5174    /// `replace_participants` unconditionally, so any update omitting the key —
5175    /// including the shape in BC3's own "Update a schedule entry" doc example —
5176    /// silently removed every participant and notified each one. The controller
5177    /// now guards on the request actually addressing participants.
5178    #[serde(default, skip_serializing_if = "Option::is_none")]
5179    pub participant_ids: Option<Vec<i64>>,
5180    /// Whether the entry occupies whole days rather than a time range.
5181    ///
5182    /// Not carved out, and the carve-out list is what makes that dangerous to
5183    /// forget: `schedule_entries.all_day` is NOT NULL with a `false` default, so
5184    /// omitting this member on a replace resets it — silently converting an
5185    /// all-day entry into a midnight-to-midnight timed one. The SDK's merge-safe
5186    /// update and edit resend it from the read-back for exactly this reason.
5187    ///
5188    /// Sending an explicit null is worse than omitting it: the column rejects
5189    /// NULL, so BC3 raises rather than falling back to the default. The same is
5190    /// true of highlighted.
5191    #[serde(default, skip_serializing_if = "Option::is_none")]
5192    pub all_day: Option<bool>,
5193    /// `notify`.
5194    #[serde(default, skip_serializing_if = "Option::is_none")]
5195    pub notify: Option<bool>,
5196    /// The entry's join link — a video-call URL or similar, up to 2500
5197    /// characters, validated as a URL when present.
5198    ///
5199    /// Omitting this member preserves the current join link; sending an empty
5200    /// string clears it. Read it back as `join_url`, never as `url`: the entry's
5201    /// `url` is its own Basecamp API URL, written by a partial that renders
5202    /// before this one, so BC3 emits the join link under a non-colliding key.
5203    /// Echoing the response's `url` into this member would write the API URL into
5204    /// the join link.
5205    #[serde(default, skip_serializing_if = "Option::is_none")]
5206    pub url: Option<String>,
5207    /// Whether the entry is highlighted on the schedule.
5208    ///
5209    /// Omitting this member preserves the current highlight; sending false
5210    /// removes it. Preserved on omission because until basecamp/bc3#12502 the
5211    /// field was writable but never returned, so no caller could resend it.
5212    #[serde(default, skip_serializing_if = "Option::is_none")]
5213    pub highlighted: Option<bool>,
5214}
5215
5216/// `ReplaceScheduleEntryResponseContent`.
5217pub type ReplaceScheduleEntryResponseContent = ScheduleEntry;
5218
5219/// The `ReplaceTodoRequestContent` shape of the Basecamp API.
5220#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
5221pub struct ReplaceTodoRequestContent {
5222    /// `content`.
5223    pub content: String,
5224    /// `description`.
5225    #[serde(default, skip_serializing_if = "Option::is_none")]
5226    pub description: Option<String>,
5227    /// `assignee_ids`.
5228    #[serde(default, skip_serializing_if = "Option::is_none")]
5229    pub assignee_ids: Option<Vec<i64>>,
5230    /// `completion_subscriber_ids`.
5231    #[serde(default, skip_serializing_if = "Option::is_none")]
5232    pub completion_subscriber_ids: Option<Vec<i64>>,
5233    /// `notify`.
5234    #[serde(default, skip_serializing_if = "Option::is_none")]
5235    pub notify: Option<bool>,
5236    /// `due_on`.
5237    #[serde(default, skip_serializing_if = "Option::is_none")]
5238    pub due_on: Option<Date>,
5239    /// `starts_on`.
5240    #[serde(default, skip_serializing_if = "Option::is_none")]
5241    pub starts_on: Option<Date>,
5242}
5243
5244/// `ReplaceTodoResponseContent`.
5245pub type ReplaceTodoResponseContent = Todo;
5246
5247/// The `RepositionCardStepRequestContent` shape of the Basecamp API.
5248#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
5249pub struct RepositionCardStepRequestContent {
5250    /// `source_id`.
5251    pub source_id: i64,
5252    /// The 1-based position to move it to (1 = top), the same `reposition_to`
5253    /// a to-do uses. bc3's doc said "Zero indexed" until BC3 #12659 corrected
5254    /// it; the server never was.
5255    pub position: i32,
5256}
5257
5258/// The `RepositionSubtaskRequestContent` shape of the Basecamp API.
5259#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
5260pub struct RepositionSubtaskRequestContent {
5261    /// The 1-based position to move it to
5262    pub position: i32,
5263}
5264
5265/// The `RepositionTodoRequestContent` shape of the Basecamp API.
5266#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
5267pub struct RepositionTodoRequestContent {
5268    /// `position`.
5269    pub position: i32,
5270    /// A to-do list, or the project's to-do set, in the same project, to move the
5271    /// todo into instead of its current parent. 422 when it is neither.
5272    #[serde(default, skip_serializing_if = "Option::is_none")]
5273    pub parent_id: Option<i64>,
5274}
5275
5276/// The `RepositionTodolistGroupRequestContent` shape of the Basecamp API.
5277#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
5278pub struct RepositionTodolistGroupRequestContent {
5279    /// `position`.
5280    pub position: i32,
5281}
5282
5283/// The `RepositionTodolistRequestContent` shape of the Basecamp API.
5284#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
5285pub struct RepositionTodolistRequestContent {
5286    /// `position`.
5287    pub position: i32,
5288}
5289
5290/// The `RepositionToolRequestContent` shape of the Basecamp API.
5291#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
5292pub struct RepositionToolRequestContent {
5293    /// `position`.
5294    pub position: i32,
5295}
5296
5297/// The `ResumeQuestionResponseContent` shape of the Basecamp API.
5298#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
5299#[non_exhaustive]
5300pub struct ResumeQuestionResponseContent {
5301    /// `paused`.
5302    #[serde(default, skip_serializing_if = "Option::is_none")]
5303    pub paused: Option<bool>,
5304}
5305
5306/// Structured metadata for a downloadable file attachment embedded in a
5307/// rich text attribute. Every rich text attribute in an API response is
5308/// accompanied by a corresponding `*_attachments` array named after the
5309/// attribute (a Todo's `description_attachments` for its `description`).
5310/// Mentions, remote images, and opengraph embeds are excluded — only
5311/// downloadable file attachments appear.
5312#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
5313#[non_exhaustive]
5314pub struct RichTextAttachment {
5315    /// `id`.
5316    pub id: i64,
5317    /// `sgid`.
5318    pub sgid: String,
5319    /// `filename`.
5320    pub filename: String,
5321    /// `content_type`.
5322    pub content_type: String,
5323    /// `byte_size`.
5324    pub byte_size: i64,
5325    /// `download_url`.
5326    pub download_url: AuthRoutableUrl,
5327    /// Pixel dimensions, present as keys on every attachment but null for
5328    /// non-image blobs, and the BC3 API may serialize them float-spelled
5329    /// (`1024.0`) — hence optional/nullable rather than `@required` (the enhance
5330    /// pass marks them `nullable: true` in the OpenAPI). All SDKs decode both
5331    /// forms faithfully and type the nullable value statically: Go `types.FlexInt`
5332    /// → `*int32`, Kotlin `Int?` via `FlexibleIntSerializer`, Swift `Int32?`,
5333    /// TypeScript `number | null`, Python `Optional\[int | float\]` (raw JSON keeps
5334    /// the float), Ruby nilable. See SPEC.md §10 Type Fidelity.
5335    #[serde(
5336        default,
5337        deserialize_with = "crate::types::flex_int::deserialize",
5338        skip_serializing_if = "Option::is_none"
5339    )]
5340    pub width: Option<i32>,
5341    /// See `width` — same nullable/float-spelled behavior and cross-SDK note.
5342    #[serde(
5343        default,
5344        deserialize_with = "crate::types::flex_int::deserialize",
5345        skip_serializing_if = "Option::is_none"
5346    )]
5347    pub height: Option<i32>,
5348    /// `previewable`.
5349    pub previewable: bool,
5350    /// `preview_url`.
5351    pub preview_url: String,
5352    /// `thumbnail_url`.
5353    pub thumbnail_url: String,
5354}
5355
5356/// The `Schedule` shape of the Basecamp API.
5357#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
5358#[non_exhaustive]
5359pub struct Schedule {
5360    /// `id`.
5361    pub id: i64,
5362    /// `status`.
5363    pub status: String,
5364    /// `visible_to_clients`.
5365    pub visible_to_clients: bool,
5366    /// `created_at`.
5367    pub created_at: DateTime,
5368    /// `updated_at`.
5369    pub updated_at: DateTime,
5370    /// `title`.
5371    pub title: String,
5372    /// `inherits_status`.
5373    pub inherits_status: bool,
5374    /// `type`.
5375    pub r#type: String,
5376    /// `url`.
5377    pub url: String,
5378    /// `app_url`.
5379    pub app_url: String,
5380    /// `bookmark_url`.
5381    #[serde(default, skip_serializing_if = "Option::is_none")]
5382    pub bookmark_url: Option<String>,
5383    /// `position`.
5384    #[serde(default, skip_serializing_if = "Option::is_none")]
5385    pub position: Option<i32>,
5386    /// `bucket`.
5387    pub bucket: TodoBucket,
5388    /// `creator`.
5389    pub creator: Person,
5390    /// `include_due_assignments`.
5391    #[serde(default, skip_serializing_if = "Option::is_none")]
5392    pub include_due_assignments: Option<bool>,
5393    /// `entries_count`.
5394    #[serde(default, skip_serializing_if = "Option::is_none")]
5395    pub entries_count: Option<i32>,
5396    /// `entries_url`.
5397    #[serde(default, skip_serializing_if = "Option::is_none")]
5398    pub entries_url: Option<String>,
5399}
5400
5401/// The `ScheduleAttributes` shape of the Basecamp API.
5402#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
5403pub struct ScheduleAttributes {
5404    /// `start_date`.
5405    #[serde(default, skip_serializing_if = "Option::is_none")]
5406    pub start_date: Option<String>,
5407    /// `end_date`.
5408    #[serde(default, skip_serializing_if = "Option::is_none")]
5409    pub end_date: Option<String>,
5410}
5411
5412/// The `ScheduleEntry` shape of the Basecamp API.
5413#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
5414#[non_exhaustive]
5415pub struct ScheduleEntry {
5416    /// `id`.
5417    pub id: i64,
5418    /// `status`.
5419    pub status: String,
5420    /// `visible_to_clients`.
5421    pub visible_to_clients: bool,
5422    /// `created_at`.
5423    pub created_at: DateTime,
5424    /// `updated_at`.
5425    pub updated_at: DateTime,
5426    /// `title`.
5427    pub title: String,
5428    /// `inherits_status`.
5429    pub inherits_status: bool,
5430    /// `type`.
5431    pub r#type: String,
5432    /// `url`.
5433    pub url: String,
5434    /// `app_url`.
5435    pub app_url: String,
5436    /// `bookmark_url`.
5437    #[serde(default, skip_serializing_if = "Option::is_none")]
5438    pub bookmark_url: Option<String>,
5439    /// `subscription_url`.
5440    #[serde(default, skip_serializing_if = "Option::is_none")]
5441    pub subscription_url: Option<String>,
5442    /// `comments_count`.
5443    #[serde(default, skip_serializing_if = "Option::is_none")]
5444    pub comments_count: Option<i32>,
5445    /// `comments_url`.
5446    #[serde(default, skip_serializing_if = "Option::is_none")]
5447    pub comments_url: Option<String>,
5448    /// `parent`.
5449    pub parent: RecordingParent,
5450    /// `bucket`.
5451    pub bucket: TodoBucket,
5452    /// `creator`.
5453    pub creator: Person,
5454    /// `summary`.
5455    pub summary: String,
5456    /// `description`.
5457    #[serde(default, skip_serializing_if = "Option::is_none")]
5458    pub description: Option<String>,
5459    /// `description_attachments`.
5460    pub description_attachments: Vec<RichTextAttachment>,
5461    /// Always sent. schedule_entries.all_day is NOT NULL with a false default,
5462    /// and every partial that renders an entry emits it.
5463    pub all_day: bool,
5464    /// Always sent, and a date rather than a timestamp for an all-day entry:
5465    /// BC3 renders starts_at_date_or_time, which is `starts_at.to_date` unless
5466    /// the entry is timed, so an all-day entry reads back as `2016-06-01` and a
5467    /// timed one as a full timestamp. The sibling all_day field discriminates.
5468    ///
5469    /// ISO8601Timestamp is a plain string in this model, so both shapes decode;
5470    /// treat the value as opaque and round-trip it verbatim rather than parsing
5471    /// it into a date type and re-rendering, which would rewrite an all-day
5472    /// entry's bounds.
5473    pub starts_at: FlexibleTime,
5474    /// Always sent. See starts_at for the date-vs-timestamp rendering.
5475    pub ends_at: FlexibleTime,
5476    /// `participants`.
5477    #[serde(
5478        default,
5479        deserialize_with = "crate::types::person_list::deserialize_optional",
5480        skip_serializing_if = "Option::is_none"
5481    )]
5482    pub participants: Option<Vec<Person>>,
5483    /// The entry's join link, or null when it has none.
5484    ///
5485    /// Sent under this key rather than `url`, which is the entry's own Basecamp
5486    /// API URL: recordings/_recording writes that key first and the entry partial
5487    /// renders after it. Write it back through the `url` member of
5488    /// ReplaceScheduleEntry — the two spellings are deliberate, not a typo.
5489    ///
5490    /// Optional is now UNDER-modelled, and deliberately left that way for one
5491    /// release. Every operation that still returns this structure —
5492    /// GetScheduleEntry, GetScheduleEntryOccurrence, ListScheduleEntries,
5493    /// CreateScheduleEntry, ReplaceScheduleEntry — renders
5494    /// schedules/entries/_entry, which emits this key unconditionally, so it is
5495    /// really required-and-nullable.
5496    ///
5497    /// It was optional because this structure used to cover two wire shapes: the
5498    /// reduced schedules/calendar/_entry, which omits it, reached here through
5499    /// GetUpcomingSchedule. That is no longer true — the report has its own
5500    /// UpcomingScheduleEntry projection (#635) — so the reason is retired and
5501    /// only the cost of tightening remains. Promoting it is a separate contract
5502    /// change: it forces every inline schedule-entry stub across six SDKs to
5503    /// carry the key, and pairs with a required-and-nullable jsonAdd, so it
5504    /// belongs in its own reviewable diff rather than riding this one.
5505    #[serde(default, skip_serializing_if = "Option::is_none")]
5506    pub join_url: Option<String>,
5507    /// Whether the entry is highlighted on the schedule.
5508    ///
5509    /// Under-modelled for the same reason as join_url, and more plainly so: this
5510    /// one is not even nullable (`schedule_entries.highlighted` is NOT NULL with
5511    /// a false default), so the entry partial's unconditional emission makes it
5512    /// straightforwardly @required. Tracked with join_url.
5513    #[serde(default, skip_serializing_if = "Option::is_none")]
5514    pub highlighted: Option<bool>,
5515    /// `boosts_count`.
5516    #[serde(default, skip_serializing_if = "Option::is_none")]
5517    pub boosts_count: Option<i32>,
5518    /// `boosts_url`.
5519    #[serde(default, skip_serializing_if = "Option::is_none")]
5520    pub boosts_url: Option<String>,
5521}
5522
5523/// The `SearchMetadata` shape of the Basecamp API.
5524#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
5525#[non_exhaustive]
5526pub struct SearchMetadata {
5527    /// `recording_search_types`.
5528    pub recording_search_types: Vec<SearchType>,
5529    /// `file_search_types`.
5530    pub file_search_types: Vec<SearchType>,
5531    /// `default_creator_label`.
5532    pub default_creator_label: String,
5533    /// `default_bucket_label`.
5534    pub default_bucket_label: String,
5535    /// `default_circle_label`.
5536    pub default_circle_label: String,
5537    /// `default_file_type_label`.
5538    pub default_file_type_label: String,
5539    /// `default_type_label`.
5540    pub default_type_label: String,
5541}
5542
5543/// `SearchResponseContent`.
5544pub type SearchResponseContent = Vec<SearchResult>;
5545
5546/// One hit from account-wide search — a polymorphic projection over every
5547/// searchable recording type.
5548///
5549/// Most result types render the common recording envelope
5550/// (`recordings/_recording.json.jbuilder`) plus their own recordable partial,
5551/// but `api_search_result_template_path` special-cases four branches — chat
5552/// lines, kanban (card table) lists, file attachments and gauge needles — and
5553/// the file-attachment branch writes its own projection from scratch instead
5554/// of the envelope. Members are therefore optional unless every branch emits
5555/// them; the doc comments name the branches that carry each optional member.
5556#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
5557#[non_exhaustive]
5558pub struct SearchResult {
5559    /// The recording id. Optional only because the file-attachment branch
5560    /// (`searches/_attachment.json.jbuilder`) skips the recording envelope and
5561    /// emits none of the top-level id/title/type/url/app_url keys; every other
5562    /// branch emits all five.
5563    #[serde(default, skip_serializing_if = "Option::is_none")]
5564    pub id: Option<i64>,
5565    /// `status`.
5566    #[serde(default, skip_serializing_if = "Option::is_none")]
5567    pub status: Option<String>,
5568    /// `visible_to_clients`.
5569    #[serde(default, skip_serializing_if = "Option::is_none")]
5570    pub visible_to_clients: Option<bool>,
5571    /// `created_at`.
5572    #[serde(default, skip_serializing_if = "Option::is_none")]
5573    pub created_at: Option<DateTime>,
5574    /// `updated_at`.
5575    #[serde(default, skip_serializing_if = "Option::is_none")]
5576    pub updated_at: Option<DateTime>,
5577    /// See `id` — omitted by the file-attachment branch, emitted by every other
5578    /// branch.
5579    #[serde(default, skip_serializing_if = "Option::is_none")]
5580    pub title: Option<String>,
5581    /// `inherits_status`.
5582    #[serde(default, skip_serializing_if = "Option::is_none")]
5583    pub inherits_status: Option<bool>,
5584    /// See `id` — omitted by the file-attachment branch, emitted by every other
5585    /// branch. A file-attachment hit is therefore recognizable by the absence
5586    /// of this key (its file keys, `filename` through `app_download_url`, are
5587    /// the positive signal).
5588    #[serde(default, skip_serializing_if = "Option::is_none")]
5589    pub r#type: Option<String>,
5590    /// See `id` — omitted by the file-attachment branch, emitted by every other
5591    /// branch.
5592    #[serde(default, skip_serializing_if = "Option::is_none")]
5593    pub url: Option<String>,
5594    /// See `id` — omitted by the file-attachment branch, emitted by every other
5595    /// branch.
5596    #[serde(default, skip_serializing_if = "Option::is_none")]
5597    pub app_url: Option<String>,
5598    /// `bookmark_url`.
5599    #[serde(default, skip_serializing_if = "Option::is_none")]
5600    pub bookmark_url: Option<String>,
5601    /// Subscription URL, emitted by the common recording envelope for any
5602    /// subscribable result — kanban lists and gauge needles among the special
5603    /// branches, plus subscribable generic-branch types (messages, todos, …).
5604    #[serde(default, skip_serializing_if = "Option::is_none")]
5605    pub subscription_url: Option<String>,
5606    /// URL of the Bubble Up record for this recording (BC5 addition). Optional
5607    /// here because this is a polymorphic projection:
5608    /// `recordings/_recording.json.jbuilder` emits the key only when the caller
5609    /// passes `local_assigns\[:bubbleupable\]`, and `todolists/_todolist` is the
5610    /// only partial that does. So a Todolist-shaped instance carries it and the
5611    /// other recording types do not.
5612    #[serde(default, skip_serializing_if = "Option::is_none")]
5613    pub bubble_up_url: Option<String>,
5614    /// `parent`.
5615    #[serde(default, skip_serializing_if = "Option::is_none")]
5616    pub parent: Option<RecordingParent>,
5617    /// `bucket`.
5618    #[serde(default, skip_serializing_if = "Option::is_none")]
5619    pub bucket: Option<RecordingBucket>,
5620    /// `creator`.
5621    #[serde(default, skip_serializing_if = "Option::is_none")]
5622    pub creator: Option<Person>,
5623    /// Always present, always null. `api/searches/show.json.jbuilder` renders the
5624    /// recording's own partial and then unconditionally overwrites `content` with
5625    /// `nil` to strip the large HTML body out of the search payload. The key is
5626    /// therefore guaranteed present on every result — required — and its value is
5627    /// guaranteed null. Read `plain_text_content` instead.
5628    #[serde(deserialize_with = "serde::Deserialize::deserialize")]
5629    pub content: Option<String>,
5630    /// Always present, always null — the description-attribute counterpart to
5631    /// `content`. Read `plain_text_description` instead.
5632    #[serde(deserialize_with = "serde::Deserialize::deserialize")]
5633    pub description: Option<String>,
5634    /// A highlighted, truncated excerpt of the recording's content — **not** plain
5635    /// text despite the name. `excerpt_and_highlight_matches` converts the rich
5636    /// text with `to_plain_text`, escapes it with `html_escape_once`, then wraps
5637    /// each query match in `\<mark class="circled-text"\>\<span\>\</span\>…\</mark\>` and
5638    /// truncates the result to 300 characters. Treat it as an HTML fragment.
5639    ///
5640    /// Optional and non-nullable: emitted only when the underlying recordable
5641    /// responds to `content`, so a result whose type has no content attribute
5642    /// omits the key entirely rather than sending null.
5643    #[serde(default, skip_serializing_if = "Option::is_none")]
5644    pub plain_text_content: Option<String>,
5645    /// The description-attribute counterpart to `plain_text_content`, with the
5646    /// same highlighting, escaping, and 300-character truncation. Optional and
5647    /// non-nullable — omitted when the recordable has no description attribute.
5648    #[serde(default, skip_serializing_if = "Option::is_none")]
5649    pub plain_text_description: Option<String>,
5650    /// Rich-text companion arrays carried through the polymorphic search
5651    /// projection. A given result is one recording type, so it carries only
5652    /// the array matching its rich-text attribute (`content_attachments` for a
5653    /// Comment/Message, `description_attachments` for a Todo); a webhook-sourced
5654    /// result carries neither. Optional (no `@required`), non-nullable.
5655    #[serde(default, skip_serializing_if = "Option::is_none")]
5656    pub content_attachments: Option<Vec<RichTextAttachment>>,
5657    /// See `content_attachments` — the description-attribute companion array.
5658    #[serde(default, skip_serializing_if = "Option::is_none")]
5659    pub description_attachments: Option<Vec<RichTextAttachment>>,
5660    /// File attachments on the result, in either of two wire shapes — see
5661    /// `SearchResultAttachment`.
5662    ///
5663    /// For a result whose recordable carries downloadable rich-text
5664    /// attachments, `searches/show.json.jbuilder` emits this key through the
5665    /// same `attachments/_attachment` partial that builds the rich-text
5666    /// companion array above, so it repeats that array's elements. For a chat
5667    /// *upload* line, `chats/lines/_upload.json.jbuilder` instead builds a
5668    /// bespoke six-key aggregate inline — and because upload lines have no
5669    /// rich-text attribute, the show template never overwrites it, so that
5670    /// distinct shape survives to the wire.
5671    #[serde(default, skip_serializing_if = "Option::is_none")]
5672    pub attachments: Option<Vec<SearchResultAttachment>>,
5673    /// `subject`.
5674    #[serde(default, skip_serializing_if = "Option::is_none")]
5675    pub subject: Option<String>,
5676    /// Boost count, emitted by the recording envelope when the branch passes
5677    /// `boostable` — chat lines and gauge needles.
5678    #[serde(default, skip_serializing_if = "Option::is_none")]
5679    pub boosts_count: Option<i32>,
5680    /// See `boosts_count` — the companion URL.
5681    #[serde(default, skip_serializing_if = "Option::is_none")]
5682    pub boosts_url: Option<String>,
5683    /// Language of a code chat line (`chats/lines/_code.json.jbuilder`);
5684    /// validated present on the model, so never null when the key is emitted.
5685    #[serde(default, skip_serializing_if = "Option::is_none")]
5686    pub language: Option<String>,
5687    /// Image URL of a soundtracked (play-kind) chat line whose sound carries an
5688    /// image; such a line emits `image_url` in place of `content`.
5689    #[serde(default, skip_serializing_if = "Option::is_none")]
5690    pub image_url: Option<String>,
5691    /// Sound URL of a play-kind chat line; always emitted for that kind.
5692    #[serde(default, skip_serializing_if = "Option::is_none")]
5693    pub sound_url: Option<String>,
5694    /// Everyone subscribed to the kanban list, as full Person projections.
5695    #[serde(
5696        default,
5697        deserialize_with = "crate::types::person_list::deserialize_optional",
5698        skip_serializing_if = "Option::is_none"
5699    )]
5700    pub subscribers: Option<Vec<Person>>,
5701    /// Color of a kanban list or gauge needle. Emitted unconditionally by both
5702    /// branches with a null value when unset, so it is nullable (the enhance
5703    /// pass layers `nullable: true` onto the OpenAPI).
5704    #[serde(default, skip_serializing_if = "Option::is_none")]
5705    pub color: Option<String>,
5706    /// Number of cards in the kanban list.
5707    #[serde(default, skip_serializing_if = "Option::is_none")]
5708    pub cards_count: Option<i32>,
5709    /// Comment count of a kanban list or gauge needle (branch-partial key,
5710    /// singular `comment_count` — distinct from the envelope's
5711    /// `comments_count`, which a needle also carries).
5712    #[serde(default, skip_serializing_if = "Option::is_none")]
5713    pub comment_count: Option<i32>,
5714    /// API URL of the kanban list's cards.
5715    #[serde(default, skip_serializing_if = "Option::is_none")]
5716    pub cards_url: Option<String>,
5717    /// `on_hold`.
5718    #[serde(default, skip_serializing_if = "Option::is_none")]
5719    pub on_hold: Option<CardColumnOnHold>,
5720    /// Comment count, emitted by the recording envelope when the branch passes
5721    /// `commentable` — gauge needles among the special branches, plus
5722    /// commentable generic-branch types.
5723    #[serde(default, skip_serializing_if = "Option::is_none")]
5724    pub comments_count: Option<i32>,
5725    /// See `comments_count` — the companion URL.
5726    #[serde(default, skip_serializing_if = "Option::is_none")]
5727    pub comments_url: Option<String>,
5728    /// Position of the result. Two emitters share the key: the recording
5729    /// envelope emits list position for positioned recordings (kanban lists
5730    /// among the special branches), and the gauge-needle branch overwrites it
5731    /// with the needle's own 0–100 gauge position.
5732    #[serde(default, skip_serializing_if = "Option::is_none")]
5733    pub position: Option<i32>,
5734    /// Filename of a file-attachment hit. This and the following file keys are
5735    /// emitted only by the file-attachment branch — the one branch that omits
5736    /// the id/title/type/url/app_url envelope keys.
5737    #[serde(default, skip_serializing_if = "Option::is_none")]
5738    pub filename: Option<String>,
5739    /// MIME type of a file-attachment hit.
5740    #[serde(default, skip_serializing_if = "Option::is_none")]
5741    pub content_type: Option<String>,
5742    /// Size in bytes of a file-attachment hit.
5743    #[serde(default, skip_serializing_if = "Option::is_none")]
5744    pub byte_size: Option<i64>,
5745    /// Whether the file can be previewed.
5746    #[serde(default, skip_serializing_if = "Option::is_none")]
5747    pub previewable: Option<bool>,
5748    /// Pixel width, emitted only when the file is previewable. May be
5749    /// float-spelled (`1024.0`) and nullable, like every other blob dimension —
5750    /// see `RichTextAttachment.width` for the cross-SDK typing note.
5751    #[serde(
5752        default,
5753        deserialize_with = "crate::types::flex_int::deserialize",
5754        skip_serializing_if = "Option::is_none"
5755    )]
5756    pub width: Option<i32>,
5757    /// See `width` — same conditional emission and nullable/float-spelled
5758    /// behavior.
5759    #[serde(
5760        default,
5761        deserialize_with = "crate::types::flex_int::deserialize",
5762        skip_serializing_if = "Option::is_none"
5763    )]
5764    pub height: Option<i32>,
5765    /// Full-size preview URL of a file-attachment hit.
5766    #[serde(default, skip_serializing_if = "Option::is_none")]
5767    pub preview_url: Option<String>,
5768    /// Thumbnail URL of a file-attachment hit.
5769    #[serde(default, skip_serializing_if = "Option::is_none")]
5770    pub thumbnail_url: Option<String>,
5771    /// Authenticated download URL of a file-attachment hit.
5772    #[serde(default, skip_serializing_if = "Option::is_none")]
5773    pub download_url: Option<AuthRoutableUrl>,
5774    /// Web (app-host) download URL of a file-attachment hit.
5775    #[serde(default, skip_serializing_if = "Option::is_none")]
5776    pub app_download_url: Option<String>,
5777}
5778
5779/// A file attached to a search result, in either of two wire shapes.
5780///
5781/// This is an optional-field superset over the two variants the search
5782/// projection emits (the TimelineAttachment approach): the rich-text
5783/// attachment/blob shape rendered through `attachments/_attachment` +
5784/// `blobs/_blob` — the same emitters `RichTextAttachment` models — and the
5785/// bespoke six-key aggregate a chat upload line builds inline in
5786/// `chats/lines/_upload.json.jbuilder`. Only the four keys both variants
5787/// always emit are `@required`; the rest identify their variant.
5788#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
5789#[non_exhaustive]
5790pub struct SearchResultAttachment {
5791    /// Original filename (both variants).
5792    pub filename: String,
5793    /// MIME type of the file (both variants).
5794    pub content_type: String,
5795    /// Size of the file in bytes (both variants).
5796    pub byte_size: i64,
5797    /// Authenticated download URL for the file (both variants).
5798    pub download_url: AuthRoutableUrl,
5799    /// Attachment id (rich-text variant).
5800    #[serde(default, skip_serializing_if = "Option::is_none")]
5801    pub id: Option<i64>,
5802    /// Signed global id of the attachment (rich-text variant).
5803    #[serde(default, skip_serializing_if = "Option::is_none")]
5804    pub sgid: Option<String>,
5805    /// Whether the blob can be previewed (rich-text variant).
5806    #[serde(default, skip_serializing_if = "Option::is_none")]
5807    pub previewable: Option<bool>,
5808    /// Full-size preview URL (rich-text variant).
5809    #[serde(default, skip_serializing_if = "Option::is_none")]
5810    pub preview_url: Option<String>,
5811    /// Thumbnail URL (rich-text variant).
5812    #[serde(default, skip_serializing_if = "Option::is_none")]
5813    pub thumbnail_url: Option<String>,
5814    /// Pixel width (rich-text variant) — null for non-image blobs and may be
5815    /// float-spelled (`1024.0`); see `RichTextAttachment.width`.
5816    #[serde(
5817        default,
5818        deserialize_with = "crate::types::flex_int::deserialize",
5819        skip_serializing_if = "Option::is_none"
5820    )]
5821    pub width: Option<i32>,
5822    /// See `width` (rich-text variant).
5823    #[serde(
5824        default,
5825        deserialize_with = "crate::types::flex_int::deserialize",
5826        skip_serializing_if = "Option::is_none"
5827    )]
5828    pub height: Option<i32>,
5829    /// Title of the attachment recording (chat upload-line variant).
5830    #[serde(default, skip_serializing_if = "Option::is_none")]
5831    pub title: Option<String>,
5832    /// Browser preview URL of the blob (chat upload-line variant).
5833    #[serde(default, skip_serializing_if = "Option::is_none")]
5834    pub url: Option<String>,
5835}
5836
5837/// A selectable search filter option. `key` is the value passed back as a
5838/// filter parameter (null represents the default "everything" option); `value`
5839/// is the human-readable label.
5840#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
5841#[non_exhaustive]
5842pub struct SearchType {
5843    /// Always present on the wire; `null` for the default "everything" option.
5844    /// `@required` models the presence; nullability of the value is layered on in
5845    /// the OpenAPI (smithy-build.json jsonAdd -\> type: \["string", "null"\]) since
5846    /// Smithy has no native required-and-nullable.
5847    #[serde(deserialize_with = "serde::Deserialize::deserialize")]
5848    pub key: Option<String>,
5849    /// `value`.
5850    pub value: String,
5851}
5852
5853/// The `SetCardColumnColorRequestContent` shape of the Basecamp API.
5854#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
5855pub struct SetCardColumnColorRequestContent {
5856    /// Valid colors: white, red, orange, yellow, green, blue, aqua, purple, gray, pink, brown
5857    pub color: String,
5858}
5859
5860/// `SetCardColumnColorResponseContent`.
5861pub type SetCardColumnColorResponseContent = CardColumn;
5862
5863/// The `SetCardStepCompletionRequestContent` shape of the Basecamp API.
5864#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
5865pub struct SetCardStepCompletionRequestContent {
5866    /// Set to "on" to complete the step, "" (empty) to uncomplete
5867    pub completion: String,
5868}
5869
5870/// `SetCardStepCompletionResponseContent`.
5871pub type SetCardStepCompletionResponseContent = Subtask;
5872
5873/// The `SetClientVisibilityRequestContent` shape of the Basecamp API.
5874#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
5875pub struct SetClientVisibilityRequestContent {
5876    /// `visible_to_clients`.
5877    pub visible_to_clients: bool,
5878}
5879
5880/// `SetClientVisibilityResponseContent`.
5881pub type SetClientVisibilityResponseContent = Recording;
5882
5883/// `SpotlightRecordingResponseContent`.
5884pub type SpotlightRecordingResponseContent = Recording;
5885
5886/// The account has reached its file storage limit.
5887///
5888/// Raised by ResourceLimits#ensure_account_can_upload_files ahead of any operation
5889/// that stores new bytes. No retry can satisfy it: the account needs more storage,
5890/// so this maps to `limit_exceeded` rather than a retryable server error.
5891#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
5892#[non_exhaustive]
5893pub struct StorageLimitErrorResponseContent {
5894    /// `error`.
5895    pub error: String,
5896    /// `message`.
5897    #[serde(default, skip_serializing_if = "Option::is_none")]
5898    pub message: Option<String>,
5899}
5900
5901/// `SubscribeResponseContent`.
5902pub type SubscribeResponseContent = Subscription;
5903
5904/// The `Subscription` shape of the Basecamp API.
5905#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
5906#[non_exhaustive]
5907pub struct Subscription {
5908    /// `subscribed`.
5909    pub subscribed: bool,
5910    /// `count`.
5911    pub count: i32,
5912    /// `url`.
5913    pub url: String,
5914    /// `subscribers`.
5915    #[serde(
5916        default,
5917        deserialize_with = "crate::types::person_list::deserialize_optional",
5918        skip_serializing_if = "Option::is_none"
5919    )]
5920    pub subscribers: Option<Vec<Person>>,
5921}
5922
5923/// The `Subtask` shape of the Basecamp API.
5924#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
5925#[non_exhaustive]
5926pub struct Subtask {
5927    /// `id`.
5928    pub id: i64,
5929    /// `status`.
5930    pub status: String,
5931    /// `visible_to_clients`.
5932    pub visible_to_clients: bool,
5933    /// `created_at`.
5934    pub created_at: DateTime,
5935    /// `updated_at`.
5936    pub updated_at: DateTime,
5937    /// `title`.
5938    pub title: String,
5939    /// `inherits_status`.
5940    pub inherits_status: bool,
5941    /// `type`.
5942    pub r#type: String,
5943    /// `url`.
5944    pub url: String,
5945    /// `app_url`.
5946    pub app_url: String,
5947    /// `bookmark_url`.
5948    #[serde(default, skip_serializing_if = "Option::is_none")]
5949    pub bookmark_url: Option<String>,
5950    /// `position`.
5951    #[serde(default, skip_serializing_if = "Option::is_none")]
5952    pub position: Option<i32>,
5953    /// `due_on`.
5954    #[serde(default, skip_serializing_if = "Option::is_none")]
5955    pub due_on: Option<Date>,
5956    /// `completed`.
5957    #[serde(default, skip_serializing_if = "Option::is_none")]
5958    pub completed: Option<bool>,
5959    /// `completion`.
5960    #[serde(default, skip_serializing_if = "Option::is_none")]
5961    pub completion: Option<RecordingCompletion>,
5962    /// This shape is deprecated since 2026-10: Never sent by Basecamp; read completion.created_at instead
5963    #[deprecated(
5964        note = "This shape is deprecated since 2026-10: Never sent by Basecamp; read completion.created_at instead"
5965    )]
5966    #[serde(default, skip_serializing_if = "Option::is_none")]
5967    pub completed_at: Option<DateTime>,
5968    /// `parent`.
5969    pub parent: RecordingParent,
5970    /// `bucket`.
5971    pub bucket: TodoBucket,
5972    /// `creator`.
5973    pub creator: Person,
5974    /// This shape is deprecated since 2026-10: Never sent by Basecamp; read completion.creator instead
5975    #[deprecated(
5976        note = "This shape is deprecated since 2026-10: Never sent by Basecamp; read completion.creator instead"
5977    )]
5978    #[serde(default, skip_serializing_if = "Option::is_none")]
5979    pub completer: Option<Person>,
5980    /// `assignees`.
5981    #[serde(
5982        default,
5983        deserialize_with = "crate::types::person_list::deserialize_optional",
5984        skip_serializing_if = "Option::is_none"
5985    )]
5986    pub assignees: Option<Vec<Person>>,
5987    /// `completion_url`.
5988    #[serde(default, skip_serializing_if = "Option::is_none")]
5989    pub completion_url: Option<String>,
5990}
5991
5992/// The `Template` shape of the Basecamp API.
5993#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
5994#[non_exhaustive]
5995pub struct Template {
5996    /// `id`.
5997    pub id: i64,
5998    /// `status`.
5999    #[serde(default, skip_serializing_if = "Option::is_none")]
6000    pub status: Option<String>,
6001    /// `created_at`.
6002    pub created_at: DateTime,
6003    /// `updated_at`.
6004    pub updated_at: DateTime,
6005    /// `name`.
6006    pub name: String,
6007    /// `description`.
6008    #[serde(default, skip_serializing_if = "Option::is_none")]
6009    pub description: Option<String>,
6010    /// `url`.
6011    #[serde(default, skip_serializing_if = "Option::is_none")]
6012    pub url: Option<String>,
6013    /// `app_url`.
6014    #[serde(default, skip_serializing_if = "Option::is_none")]
6015    pub app_url: Option<String>,
6016    /// `dock`.
6017    #[serde(default, skip_serializing_if = "Option::is_none")]
6018    pub dock: Option<Vec<DockItem>>,
6019}
6020
6021/// The `TemplateLibraryCardTables` shape of the Basecamp API.
6022#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
6023#[non_exhaustive]
6024pub struct TemplateLibraryCardTables {
6025    /// `bucket`.
6026    pub bucket: RecordingBucket,
6027    /// `kanban_boardset`.
6028    #[serde(deserialize_with = "serde::Deserialize::deserialize")]
6029    pub kanban_boardset: Option<RecordingParent>,
6030    /// Active templates in title order, as recording projections: read one through
6031    /// GetCardTable to see its columns.
6032    pub card_tables: Vec<Recording>,
6033}
6034
6035/// The `TemplateLibraryConfirmationPerson` shape of the Basecamp API.
6036#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
6037#[non_exhaustive]
6038pub struct TemplateLibraryConfirmationPerson {
6039    /// `id`.
6040    pub id: i64,
6041    /// `name`.
6042    pub name: SensitiveString,
6043    /// `avatar_url`.
6044    pub avatar_url: SensitiveString,
6045}
6046
6047/// The `TemplateLibraryCopy` shape of the Basecamp API.
6048#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
6049#[non_exhaustive]
6050pub struct TemplateLibraryCopy {
6051    /// `id`.
6052    pub id: i64,
6053    /// pending|processing|completed|failed
6054    pub status: String,
6055    /// `source_recording_id`.
6056    pub source_recording_id: i64,
6057    /// `destination_parent_id`.
6058    pub destination_parent_id: i64,
6059    /// `url`.
6060    pub url: String,
6061    /// `destination_todolist`.
6062    #[serde(default, skip_serializing_if = "Option::is_none")]
6063    pub destination_todolist: Option<Todolist>,
6064    /// `destination_card_table`.
6065    #[serde(default, skip_serializing_if = "Option::is_none")]
6066    pub destination_card_table: Option<CardTable>,
6067}
6068
6069/// The `TemplateLibraryTodolists` shape of the Basecamp API.
6070#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
6071#[non_exhaustive]
6072pub struct TemplateLibraryTodolists {
6073    /// `bucket`.
6074    pub bucket: RecordingBucket,
6075    /// `todoset`.
6076    pub todoset: RecordingParent,
6077    /// `todolists`.
6078    pub todolists: Vec<Todolist>,
6079}
6080
6081/// The record of templatifying a recording into the library. Carries no
6082/// destination parent, unlike a copy: the destination is always the library.
6083#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
6084#[non_exhaustive]
6085pub struct Templatification {
6086    /// `id`.
6087    pub id: i64,
6088    /// pending|processing|completed|failed
6089    pub status: String,
6090    /// `source_recording_id`.
6091    pub source_recording_id: i64,
6092    /// `url`.
6093    pub url: String,
6094    /// `destination_todolist`.
6095    #[serde(default, skip_serializing_if = "Option::is_none")]
6096    pub destination_todolist: Option<Todolist>,
6097    /// `destination_card_table`.
6098    #[serde(default, skip_serializing_if = "Option::is_none")]
6099    pub destination_card_table: Option<CardTable>,
6100}
6101
6102/// A single timeline-event attachment. This is an optional-field superset over
6103/// two wire variants — a full Upload recording (upload-kind recordings, rendered
6104/// by BC3's uploads/_upload partial: the complete recording projection + rich-
6105/// text description + the upload body) and a rich-text attachment/blob partial
6106/// (all other recordings) — so one element type decodes either. Every field is
6107/// optional; a given instance populates only the fields of the variant it
6108/// represents. The upload-recording variant enumerates the full documented
6109/// projection so no documented field is silently dropped on decode.
6110#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
6111#[non_exhaustive]
6112pub struct TimelineAttachment {
6113    /// Attachment or upload-recording id.
6114    #[serde(default, skip_serializing_if = "Option::is_none")]
6115    pub id: Option<i64>,
6116    /// MIME type of the file.
6117    #[serde(default, skip_serializing_if = "Option::is_none")]
6118    pub content_type: Option<String>,
6119    /// Size of the file in bytes.
6120    #[serde(default, skip_serializing_if = "Option::is_none")]
6121    pub byte_size: Option<i64>,
6122    /// Original filename.
6123    #[serde(default, skip_serializing_if = "Option::is_none")]
6124    pub filename: Option<String>,
6125    /// Authenticated download URL for the file.
6126    #[serde(default, skip_serializing_if = "Option::is_none")]
6127    pub download_url: Option<AuthRoutableUrl>,
6128    /// Pixel width; null for non-image blobs and may be float-spelled (1024.0).
6129    #[serde(
6130        default,
6131        deserialize_with = "crate::types::flex_int::deserialize",
6132        skip_serializing_if = "Option::is_none"
6133    )]
6134    pub width: Option<i32>,
6135    /// Pixel height; null for non-image blobs and may be float-spelled (1024.0).
6136    #[serde(
6137        default,
6138        deserialize_with = "crate::types::flex_int::deserialize",
6139        skip_serializing_if = "Option::is_none"
6140    )]
6141    pub height: Option<i32>,
6142    /// Recording type, e.g. "Upload" (upload-recording variant).
6143    #[serde(default, skip_serializing_if = "Option::is_none")]
6144    pub r#type: Option<String>,
6145    /// Title of the upload recording.
6146    #[serde(default, skip_serializing_if = "Option::is_none")]
6147    pub title: Option<String>,
6148    /// Publication status of the upload recording (e.g. "active").
6149    #[serde(default, skip_serializing_if = "Option::is_none")]
6150    pub status: Option<String>,
6151    /// Whether the recording inherits its status from its parent.
6152    #[serde(default, skip_serializing_if = "Option::is_none")]
6153    pub inherits_status: Option<bool>,
6154    /// When the upload recording was created.
6155    #[serde(default, skip_serializing_if = "Option::is_none")]
6156    pub created_at: Option<DateTime>,
6157    /// When the upload recording was last updated.
6158    #[serde(default, skip_serializing_if = "Option::is_none")]
6159    pub updated_at: Option<DateTime>,
6160    /// API URL of the upload recording.
6161    #[serde(default, skip_serializing_if = "Option::is_none")]
6162    pub url: Option<String>,
6163    /// Web URL of the upload recording.
6164    #[serde(default, skip_serializing_if = "Option::is_none")]
6165    pub app_url: Option<String>,
6166    /// Personal bookmark toggle URL for the current user.
6167    #[serde(default, skip_serializing_if = "Option::is_none")]
6168    pub bookmark_url: Option<String>,
6169    /// Subscription URL; present only when the recording is subscribable.
6170    #[serde(default, skip_serializing_if = "Option::is_none")]
6171    pub subscription_url: Option<String>,
6172    /// Number of comments on the recording.
6173    #[serde(default, skip_serializing_if = "Option::is_none")]
6174    pub comments_count: Option<i32>,
6175    /// API URL for the recording's comments.
6176    #[serde(default, skip_serializing_if = "Option::is_none")]
6177    pub comments_url: Option<String>,
6178    /// Number of boosts on the recording.
6179    #[serde(default, skip_serializing_if = "Option::is_none")]
6180    pub boosts_count: Option<i32>,
6181    /// API URL for the recording's boosts.
6182    #[serde(default, skip_serializing_if = "Option::is_none")]
6183    pub boosts_url: Option<String>,
6184    /// Position within its parent; present only when the recording is positioned.
6185    #[serde(default, skip_serializing_if = "Option::is_none")]
6186    pub position: Option<i32>,
6187    /// `parent`.
6188    #[serde(default, skip_serializing_if = "Option::is_none")]
6189    pub parent: Option<RecordingParent>,
6190    /// `bucket`.
6191    #[serde(default, skip_serializing_if = "Option::is_none")]
6192    pub bucket: Option<TodoBucket>,
6193    /// `creator`.
6194    #[serde(default, skip_serializing_if = "Option::is_none")]
6195    pub creator: Option<Person>,
6196    /// Rich-text description of the upload (HTML), when present.
6197    #[serde(default, skip_serializing_if = "Option::is_none")]
6198    pub description: Option<String>,
6199    /// Rich-text attachments referenced by the description.
6200    #[serde(default, skip_serializing_if = "Option::is_none")]
6201    pub description_attachments: Option<Vec<RichTextAttachment>>,
6202    /// Web download URL (upload-recording variant).
6203    #[serde(default, skip_serializing_if = "Option::is_none")]
6204    pub app_download_url: Option<String>,
6205    /// Whether the upload recording is visible to clients.
6206    #[serde(default, skip_serializing_if = "Option::is_none")]
6207    pub visible_to_clients: Option<bool>,
6208    /// Signed global id of the attachable (attachment variant).
6209    #[serde(default, skip_serializing_if = "Option::is_none")]
6210    pub attachable_sgid: Option<String>,
6211    /// Signed global id of the attachment (attachment variant).
6212    #[serde(default, skip_serializing_if = "Option::is_none")]
6213    pub sgid: Option<String>,
6214    /// URL to poll attachment processing status (attachment variant).
6215    #[serde(default, skip_serializing_if = "Option::is_none")]
6216    pub status_url: Option<String>,
6217    /// Caption text, if any (attachment variant).
6218    #[serde(default, skip_serializing_if = "Option::is_none")]
6219    pub caption: Option<String>,
6220    /// Storage key of the underlying blob (attachment variant).
6221    #[serde(default, skip_serializing_if = "Option::is_none")]
6222    pub key: Option<String>,
6223    /// Whether the blob can be previewed (attachment variant).
6224    #[serde(default, skip_serializing_if = "Option::is_none")]
6225    pub previewable: Option<bool>,
6226    /// Full-size preview URL (attachment variant).
6227    #[serde(default, skip_serializing_if = "Option::is_none")]
6228    pub preview_url: Option<String>,
6229    /// Thumbnail preview URL (attachment variant).
6230    #[serde(default, skip_serializing_if = "Option::is_none")]
6231    pub thumbnail_url: Option<String>,
6232}
6233
6234/// The `TimelineEvent` shape of the Basecamp API.
6235#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
6236#[non_exhaustive]
6237pub struct TimelineEvent {
6238    /// `id`.
6239    #[serde(default, skip_serializing_if = "Option::is_none")]
6240    pub id: Option<i64>,
6241    /// `created_at`.
6242    #[serde(default, skip_serializing_if = "Option::is_none")]
6243    pub created_at: Option<DateTime>,
6244    /// What kind of activity the event records. Open, non-exhaustive vocabulary —
6245    /// BC3 documents "common values include" and adds new kinds over time, so
6246    /// treat unrecognized values as valid. Common values include message_created,
6247    /// comment_created, todo_created, todo_completed, upload_created,
6248    /// document_created, google_document_created, schedule_entry_created,
6249    /// schedule_entry_rescheduled, question_created, question_answer_created,
6250    /// chat_transcript_rollup, kanban_card_created, kanban_card_completed,
6251    /// inbox_forward_created, client_correspondence_created, dock_created, and
6252    /// project_access_changed.
6253    #[serde(default, skip_serializing_if = "Option::is_none")]
6254    pub kind: Option<String>,
6255    /// `parent_recording_id`.
6256    #[serde(default, skip_serializing_if = "Option::is_none")]
6257    pub parent_recording_id: Option<i64>,
6258    /// `url`.
6259    #[serde(default, skip_serializing_if = "Option::is_none")]
6260    pub url: Option<String>,
6261    /// `app_url`.
6262    #[serde(default, skip_serializing_if = "Option::is_none")]
6263    pub app_url: Option<String>,
6264    /// `creator`.
6265    #[serde(default, skip_serializing_if = "Option::is_none")]
6266    pub creator: Option<Person>,
6267    /// `action`.
6268    #[serde(default, skip_serializing_if = "Option::is_none")]
6269    pub action: Option<String>,
6270    /// `target`.
6271    #[serde(default, skip_serializing_if = "Option::is_none")]
6272    pub target: Option<String>,
6273    /// `title`.
6274    #[serde(default, skip_serializing_if = "Option::is_none")]
6275    pub title: Option<String>,
6276    /// `summary_excerpt`.
6277    #[serde(default, skip_serializing_if = "Option::is_none")]
6278    pub summary_excerpt: Option<String>,
6279    /// Avatar URLs of participants — populated for chat_transcript_rollup events
6280    /// (the people summarized in the rollup); an empty array otherwise.
6281    #[serde(default, skip_serializing_if = "Option::is_none")]
6282    pub avatars_sample: Option<Vec<String>>,
6283    /// `bucket`.
6284    #[serde(default, skip_serializing_if = "Option::is_none")]
6285    pub bucket: Option<TodoBucket>,
6286    /// `data`.
6287    #[serde(default, skip_serializing_if = "Option::is_none")]
6288    pub data: Option<TimelineEventData>,
6289    /// Files attached to the event's recording, when it has any. Heterogeneous:
6290    /// an upload-kind recording contributes its full Upload shape, while other
6291    /// recordings contribute rich-text attachment/blob partials. Modeled as an
6292    /// optional-field superset so a single element type decodes either variant;
6293    /// consumers should treat the per-variant fields as present-or-absent.
6294    #[serde(default, skip_serializing_if = "Option::is_none")]
6295    pub attachments: Option<Vec<TimelineAttachment>>,
6296}
6297
6298/// Schedule-entry timing carried on schedule_entry_* timeline events. starts_at
6299/// and ends_at are date-or-timestamp: a full ISO 8601 timestamp for timed
6300/// entries, or a bare date (YYYY-MM-DD) when all_day is true. Modeled as
6301/// ISO8601Timestamp (mirroring ScheduleEntry), with the Go enhancement pass
6302/// mapping them to types.FlexibleTime so date-only values decode; the other
6303/// SDKs type them as plain strings.
6304#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
6305#[non_exhaustive]
6306pub struct TimelineEventData {
6307    /// Whether the entry is all-day. BC3 emits all three members unconditionally
6308    /// whenever the data object is present (schedule_entry_* events), so they are
6309    /// required within this struct.
6310    pub all_day: bool,
6311    /// `starts_at`.
6312    #[serde(deserialize_with = "serde::Deserialize::deserialize")]
6313    pub starts_at: Option<FlexibleTime>,
6314    /// `ends_at`.
6315    #[serde(deserialize_with = "serde::Deserialize::deserialize")]
6316    pub ends_at: Option<FlexibleTime>,
6317}
6318
6319/// The `TimesheetEntry` shape of the Basecamp API.
6320#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
6321#[non_exhaustive]
6322pub struct TimesheetEntry {
6323    /// `id`.
6324    pub id: i64,
6325    /// `status`.
6326    pub status: String,
6327    /// `visible_to_clients`.
6328    pub visible_to_clients: bool,
6329    /// `created_at`.
6330    pub created_at: DateTime,
6331    /// `updated_at`.
6332    pub updated_at: DateTime,
6333    /// `title`.
6334    pub title: String,
6335    /// `inherits_status`.
6336    pub inherits_status: bool,
6337    /// `type`.
6338    pub r#type: String,
6339    /// `url`.
6340    pub url: String,
6341    /// `app_url`.
6342    pub app_url: String,
6343    /// `bookmark_url`.
6344    #[serde(default, skip_serializing_if = "Option::is_none")]
6345    pub bookmark_url: Option<String>,
6346    /// `parent`.
6347    pub parent: RecordingParent,
6348    /// `bucket`.
6349    pub bucket: TodoBucket,
6350    /// `creator`.
6351    pub creator: Person,
6352    /// `date`.
6353    #[serde(default, skip_serializing_if = "Option::is_none")]
6354    pub date: Option<String>,
6355    /// `description`.
6356    #[serde(default, skip_serializing_if = "Option::is_none")]
6357    pub description: Option<String>,
6358    /// `hours`.
6359    #[serde(default, skip_serializing_if = "Option::is_none")]
6360    pub hours: Option<String>,
6361    /// `person`.
6362    #[serde(default, skip_serializing_if = "Option::is_none")]
6363    pub person: Option<Person>,
6364}
6365
6366/// The `Todo` shape of the Basecamp API.
6367#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
6368#[non_exhaustive]
6369pub struct Todo {
6370    /// `id`.
6371    pub id: i64,
6372    /// active|archived|trashed
6373    pub status: String,
6374    /// `visible_to_clients`.
6375    pub visible_to_clients: bool,
6376    /// `created_at`.
6377    pub created_at: DateTime,
6378    /// `updated_at`.
6379    pub updated_at: DateTime,
6380    /// `title`.
6381    pub title: String,
6382    /// `inherits_status`.
6383    pub inherits_status: bool,
6384    /// `type`.
6385    pub r#type: String,
6386    /// `url`.
6387    pub url: String,
6388    /// `app_url`.
6389    pub app_url: String,
6390    /// `bookmark_url`.
6391    #[serde(default, skip_serializing_if = "Option::is_none")]
6392    pub bookmark_url: Option<String>,
6393    /// `subscription_url`.
6394    #[serde(default, skip_serializing_if = "Option::is_none")]
6395    pub subscription_url: Option<String>,
6396    /// `comments_count`.
6397    #[serde(default, skip_serializing_if = "Option::is_none")]
6398    pub comments_count: Option<i32>,
6399    /// `comments_url`.
6400    #[serde(default, skip_serializing_if = "Option::is_none")]
6401    pub comments_url: Option<String>,
6402    /// `position`.
6403    #[serde(default, skip_serializing_if = "Option::is_none")]
6404    pub position: Option<i32>,
6405    /// `parent`.
6406    pub parent: TodoParent,
6407    /// `bucket`.
6408    pub bucket: TodoBucket,
6409    /// `creator`.
6410    pub creator: Person,
6411    /// `description`.
6412    #[serde(default, skip_serializing_if = "Option::is_none")]
6413    pub description: Option<String>,
6414    /// `completed`.
6415    #[serde(default, skip_serializing_if = "Option::is_none")]
6416    pub completed: Option<bool>,
6417    /// `completion`.
6418    #[serde(default, skip_serializing_if = "Option::is_none")]
6419    pub completion: Option<RecordingCompletion>,
6420    /// `content`.
6421    pub content: String,
6422    /// `description_attachments`.
6423    pub description_attachments: Vec<RichTextAttachment>,
6424    /// `starts_on`.
6425    #[serde(default, skip_serializing_if = "Option::is_none")]
6426    pub starts_on: Option<Date>,
6427    /// `due_on`.
6428    #[serde(default, skip_serializing_if = "Option::is_none")]
6429    pub due_on: Option<Date>,
6430    /// `assignees`.
6431    #[serde(
6432        default,
6433        deserialize_with = "crate::types::person_list::deserialize_optional",
6434        skip_serializing_if = "Option::is_none"
6435    )]
6436    pub assignees: Option<Vec<Person>>,
6437    /// `completion_subscribers`.
6438    #[serde(
6439        default,
6440        deserialize_with = "crate::types::person_list::deserialize_optional",
6441        skip_serializing_if = "Option::is_none"
6442    )]
6443    pub completion_subscribers: Option<Vec<Person>>,
6444    /// `completion_url`.
6445    #[serde(default, skip_serializing_if = "Option::is_none")]
6446    pub completion_url: Option<String>,
6447    /// `boosts_count`.
6448    #[serde(default, skip_serializing_if = "Option::is_none")]
6449    pub boosts_count: Option<i32>,
6450    /// `boosts_url`.
6451    #[serde(default, skip_serializing_if = "Option::is_none")]
6452    pub boosts_url: Option<String>,
6453    /// Subtask accounting (BC3 #12659). `subtasks_count` is the real total,
6454    /// `subtasks_completed_count` how many are done, and `subtasks_url` the
6455    /// paginated listing of all of them (`ListSubtasks`).
6456    #[serde(default, skip_serializing_if = "Option::is_none")]
6457    pub subtasks_count: Option<i32>,
6458    /// `subtasks_completed_count`.
6459    #[serde(default, skip_serializing_if = "Option::is_none")]
6460    pub subtasks_completed_count: Option<i32>,
6461    /// `subtasks_url`.
6462    #[serde(default, skip_serializing_if = "Option::is_none")]
6463    pub subtasks_url: Option<String>,
6464    /// The first 100 subtasks, embedded read-only (BC5 addition). The shared
6465    /// `subtasks/subtask` jbuilder partial emits the same `Subtask` shape a card
6466    /// embeds. A to-do with more than 100 reports the total in
6467    /// `subtasks_count`; fetch the rest from `subtasks_url`.
6468    #[serde(default, skip_serializing_if = "Option::is_none")]
6469    pub steps: Option<Vec<Subtask>>,
6470}
6471
6472/// The `TodoBucket` shape of the Basecamp API.
6473#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
6474#[non_exhaustive]
6475pub struct TodoBucket {
6476    /// `id`.
6477    pub id: i64,
6478    /// `name`.
6479    pub name: String,
6480    /// `type`.
6481    pub r#type: String,
6482}
6483
6484/// The `TodoParent` shape of the Basecamp API.
6485#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
6486#[non_exhaustive]
6487pub struct TodoParent {
6488    /// `id`.
6489    pub id: i64,
6490    /// `title`.
6491    pub title: String,
6492    /// `type`.
6493    pub r#type: String,
6494    /// `url`.
6495    pub url: String,
6496    /// `app_url`.
6497    pub app_url: String,
6498}
6499
6500/// A to-do list, or a group inside one. There is only this shape.
6501///
6502/// BC3 has no group model: a "group" is a `Todolist` whose parent is another
6503/// `Todolist` (`Todolist.group?`), there is no `Todolist::Group` class, and
6504/// `todolists/groups/index.json.jbuilder` and `show.json.jbuilder` both render
6505/// `todolists/_todolist.json.jbuilder` — the same partial the list routes use.
6506/// So a group reports `"type": "Todolist"` (the shared recording partial emits
6507/// `recordable_type`) and carries `description`/`description_attachments` like
6508/// any other list. Every operation that returns a list or a group returns this
6509/// structure: the polymorphic GET/PUT, the todoset-scoped list, and the
6510/// group list, group create and group get.
6511///
6512/// Discriminate STRUCTURALLY, never on `type` — which reads `"Todolist"` for
6513/// both variants. `_todolist.json.jbuilder` branches on `recording.parent.todoset?`
6514/// and emits exactly one of:
6515///
6516/// - `groups_url` — a to-do list; its `parent` is a Todoset.
6517/// - `group_position_url` — a group; its `parent` is a Todolist.
6518///
6519/// The two are mutually exclusive and exactly one is always present.
6520#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
6521#[non_exhaustive]
6522pub struct Todolist {
6523    /// `id`.
6524    pub id: i64,
6525    /// active|archived|trashed
6526    pub status: String,
6527    /// `visible_to_clients`.
6528    pub visible_to_clients: bool,
6529    /// `created_at`.
6530    pub created_at: DateTime,
6531    /// `updated_at`.
6532    pub updated_at: DateTime,
6533    /// `title`.
6534    pub title: String,
6535    /// `inherits_status`.
6536    pub inherits_status: bool,
6537    /// `type`.
6538    pub r#type: String,
6539    /// `url`.
6540    pub url: String,
6541    /// `app_url`.
6542    pub app_url: String,
6543    /// `bookmark_url`.
6544    #[serde(default, skip_serializing_if = "Option::is_none")]
6545    pub bookmark_url: Option<String>,
6546    /// `subscription_url`.
6547    #[serde(default, skip_serializing_if = "Option::is_none")]
6548    pub subscription_url: Option<String>,
6549    /// URL of the Bubble Up record for this recording (BC5 addition). Required:
6550    /// `todolists/_todolist.json.jbuilder` renders the shared recording partial
6551    /// with `bubbleupable: true` unconditionally, and every list, show, and group
6552    /// path renders that partial — so the key is present on every projection of
6553    /// this shape.
6554    pub bubble_up_url: String,
6555    /// `comments_count`.
6556    #[serde(default, skip_serializing_if = "Option::is_none")]
6557    pub comments_count: Option<i32>,
6558    /// `comments_url`.
6559    #[serde(default, skip_serializing_if = "Option::is_none")]
6560    pub comments_url: Option<String>,
6561    /// `position`.
6562    #[serde(default, skip_serializing_if = "Option::is_none")]
6563    pub position: Option<i32>,
6564    /// `parent`.
6565    pub parent: TodoParent,
6566    /// `bucket`.
6567    pub bucket: TodoBucket,
6568    /// `creator`.
6569    pub creator: Person,
6570    /// Rich text description (HTML). Required and never null: the shared rich-text
6571    /// partial emits the key unconditionally, and `format_api_content` funnels a
6572    /// blank or absent rich text through `call_pipeline`, which returns `""` rather
6573    /// than nil. A list with no description carries `""`, not `null`, and a group
6574    /// carries it too — `todolists/groups/{index,show}.json.jbuilder` render the
6575    /// same partial.
6576    pub description: String,
6577    /// Downloadable files embedded in `description`. Required and never null:
6578    /// the partial emits `rich_text&.downloadable_attachments.to_a`, so the value
6579    /// is `\[\]` when there is no description and when there are no attachments.
6580    pub description_attachments: Vec<RichTextAttachment>,
6581    /// `completed`.
6582    #[serde(default, skip_serializing_if = "Option::is_none")]
6583    pub completed: Option<bool>,
6584    /// `completed_ratio`.
6585    #[serde(default, skip_serializing_if = "Option::is_none")]
6586    pub completed_ratio: Option<String>,
6587    /// `name`.
6588    pub name: String,
6589    /// `todos_url`.
6590    #[serde(default, skip_serializing_if = "Option::is_none")]
6591    pub todos_url: Option<String>,
6592    /// API URL for this list's groups. The to-do-list half of the structural
6593    /// discriminator: emitted only when `parent` is a Todoset, and mutually
6594    /// exclusive with `group_position_url`.
6595    #[serde(default, skip_serializing_if = "Option::is_none")]
6596    pub groups_url: Option<String>,
6597    /// API URL for repositioning this group within its parent list. The group half
6598    /// of the structural discriminator: emitted only when `parent` is a Todolist,
6599    /// and mutually exclusive with `groups_url`.
6600    #[serde(default, skip_serializing_if = "Option::is_none")]
6601    pub group_position_url: Option<String>,
6602    /// In-app (non-API) URL for this record's to-dos, alongside the API-host
6603    /// `todos_url`.
6604    #[serde(default, skip_serializing_if = "Option::is_none")]
6605    pub app_todos_url: Option<String>,
6606    /// Color of the list or group, one of BC3's `Colored` enum values
6607    /// (`white red orange yellow green blue aqua purple gray pink brown`). For a
6608    /// top-level list a hill-chart dot color takes precedence over the recording's
6609    /// own.
6610    ///
6611    /// **Required and nullable.** The key is always present and the value is often
6612    /// `null`. `_todolist.json.jbuilder` calls `json.color` in both branches of its
6613    /// `todolist_group?` conditional, so no projection of this shape omits it;
6614    /// `recordings.color` is a nullable integer column, so the value is JSON `null`
6615    /// whenever it is unset — which, for a group, is the ordinary case.
6616    ///
6617    /// Smithy expresses neither half natively here, so both are layered onto the
6618    /// OpenAPI projection through `jsonAdd` in `spec/smithy-build.json`: the
6619    /// `\["string", "null"\]` union for the value, the same treatment
6620    /// `SearchResult.content` and `SearchType.key` get, and an append to
6621    /// `Todolist.required` for the presence.
6622    ///
6623    /// The member stays natively optional because `@required` collides with this
6624    /// shape's `@examples` (`GetTodolistOrGroup`): Smithy cannot express a `null`
6625    /// in an example for a `String` shape, so requiring the member would force the
6626    /// group example to advertise a color that uncolored groups do not have —
6627    /// trading a faithful example for a type the projection can state anyway. The
6628    /// sibling shapes that carry the same field (`Wormhole`, `Folder`,
6629    /// `FolderWithProjects`) are natively `@required` because none of them carries
6630    /// examples. Nullability is not the weaker claim about presence: absence and
6631    /// `null` are different wire facts, and BC3 only ever sends the second.
6632    #[serde(deserialize_with = "serde::Deserialize::deserialize")]
6633    pub color: Option<String>,
6634    /// In-app (non-API) URL for this recording's comments, alongside the API-host
6635    /// `comments_url`. Required and never null: `_todolist.json.jbuilder` emits
6636    /// `json.comments_app_url` unconditionally, from the
6637    /// `bucket_recording_comments_url` route helper — which returns a String or
6638    /// raises, and has no nil path. Native `@required` is enough here precisely
6639    /// because the value is never null, so it costs the examples a real URL rather
6640    /// than a fiction.
6641    pub comments_app_url: String,
6642    /// `boosts_count`.
6643    #[serde(default, skip_serializing_if = "Option::is_none")]
6644    pub boosts_count: Option<i32>,
6645    /// `boosts_url`.
6646    #[serde(default, skip_serializing_if = "Option::is_none")]
6647    pub boosts_url: Option<String>,
6648}
6649
6650/// The `Todoset` shape of the Basecamp API.
6651#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
6652#[non_exhaustive]
6653pub struct Todoset {
6654    /// `id`.
6655    pub id: i64,
6656    /// `status`.
6657    pub status: String,
6658    /// `visible_to_clients`.
6659    pub visible_to_clients: bool,
6660    /// `created_at`.
6661    pub created_at: DateTime,
6662    /// `updated_at`.
6663    pub updated_at: DateTime,
6664    /// `title`.
6665    pub title: String,
6666    /// `inherits_status`.
6667    pub inherits_status: bool,
6668    /// `type`.
6669    pub r#type: String,
6670    /// `url`.
6671    pub url: String,
6672    /// `app_url`.
6673    pub app_url: String,
6674    /// `bookmark_url`.
6675    #[serde(default, skip_serializing_if = "Option::is_none")]
6676    pub bookmark_url: Option<String>,
6677    /// `position`.
6678    #[serde(default, skip_serializing_if = "Option::is_none")]
6679    pub position: Option<i32>,
6680    /// `bucket`.
6681    pub bucket: TodoBucket,
6682    /// `creator`.
6683    pub creator: Person,
6684    /// `name`.
6685    pub name: String,
6686    /// `todolists_count`.
6687    #[serde(default, skip_serializing_if = "Option::is_none")]
6688    pub todolists_count: Option<i32>,
6689    /// `todolists_url`.
6690    #[serde(default, skip_serializing_if = "Option::is_none")]
6691    pub todolists_url: Option<String>,
6692    /// `completed_ratio`.
6693    #[serde(default, skip_serializing_if = "Option::is_none")]
6694    pub completed_ratio: Option<String>,
6695    /// `completed`.
6696    #[serde(default, skip_serializing_if = "Option::is_none")]
6697    pub completed: Option<bool>,
6698    /// `app_todolists_url`.
6699    #[serde(default, skip_serializing_if = "Option::is_none")]
6700    pub app_todolists_url: Option<String>,
6701    /// Total count of todos across all todolists in this todoset (BC5 addition).
6702    #[serde(default, skip_serializing_if = "Option::is_none")]
6703    pub todos_count: Option<i32>,
6704    /// Count of completed loose todos at the todoset level (BC5 addition).
6705    #[serde(default, skip_serializing_if = "Option::is_none")]
6706    pub completed_loose_todos_count: Option<i32>,
6707    /// API URL for listing todos directly under this todoset (BC5 addition).
6708    #[serde(default, skip_serializing_if = "Option::is_none")]
6709    pub todos_url: Option<String>,
6710    /// In-app URL for viewing the todoset's todos (BC5 addition).
6711    #[serde(default, skip_serializing_if = "Option::is_none")]
6712    pub app_todos_url: Option<String>,
6713}
6714
6715/// The `ToggleGaugeRequestContent` shape of the Basecamp API.
6716#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
6717pub struct ToggleGaugeRequestContent {
6718    /// `gauge`.
6719    pub gauge: GaugeTogglePayload,
6720}
6721
6722/// The `Tool` shape of the Basecamp API.
6723#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
6724#[non_exhaustive]
6725pub struct Tool {
6726    /// `id`.
6727    pub id: i64,
6728    /// `status`.
6729    #[serde(default, skip_serializing_if = "Option::is_none")]
6730    pub status: Option<String>,
6731    /// `visible_to_clients`.
6732    pub visible_to_clients: bool,
6733    /// `created_at`.
6734    pub created_at: DateTime,
6735    /// `updated_at`.
6736    pub updated_at: DateTime,
6737    /// `title`.
6738    pub title: String,
6739    /// `inherits_status`.
6740    pub inherits_status: bool,
6741    /// The tool's recordable type, e.g. `Chat::Transcript`, `Todoset`, `Vault`.
6742    pub r#type: String,
6743    /// `url`.
6744    #[serde(default, skip_serializing_if = "Option::is_none")]
6745    pub url: Option<String>,
6746    /// `app_url`.
6747    #[serde(default, skip_serializing_if = "Option::is_none")]
6748    pub app_url: Option<String>,
6749    /// `bookmark_url`.
6750    #[serde(default, skip_serializing_if = "Option::is_none")]
6751    pub bookmark_url: Option<String>,
6752    /// Absent for tool types that are not subscribable.
6753    #[serde(default, skip_serializing_if = "Option::is_none")]
6754    pub subscription_url: Option<String>,
6755    /// Emitted only for a positioned recording. For a docked tool that makes an
6756    /// absent position the disabled signal — disabling removes the tool from the
6757    /// dock without deleting it. Positioning is independent of dockedness, so
6758    /// this does not generalize: a nested vault is not docked and is positioned.
6759    #[serde(default, skip_serializing_if = "Option::is_none")]
6760    pub position: Option<i32>,
6761    /// `parent`.
6762    #[serde(default, skip_serializing_if = "Option::is_none")]
6763    pub parent: Option<RecordingParent>,
6764    /// `bucket`.
6765    #[serde(default, skip_serializing_if = "Option::is_none")]
6766    pub bucket: Option<RecordingBucket>,
6767    /// `creator`.
6768    pub creator: Person,
6769    /// Not emitted by this projection. The dock array on a project
6770    /// (`DockItem$name`) carries the tool's slug; this key is absent from every
6771    /// GetTool/CreateTool/UpdateTool response.
6772    #[serde(default, skip_serializing_if = "Option::is_none")]
6773    pub name: Option<String>,
6774    /// Not emitted by this projection. The dock array on a project
6775    /// (`DockItem$enabled`) is the authoritative enabled flag; on a docked tool's
6776    /// own response, an absent `position` is the equivalent signal.
6777    #[serde(default, skip_serializing_if = "Option::is_none")]
6778    pub enabled: Option<bool>,
6779}
6780
6781/// The `UnauthorizedErrorResponseContent` shape of the Basecamp API.
6782#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
6783#[non_exhaustive]
6784pub struct UnauthorizedErrorResponseContent {
6785    /// `error`.
6786    pub error: String,
6787    /// `message`.
6788    #[serde(default, skip_serializing_if = "Option::is_none")]
6789    pub message: Option<String>,
6790}
6791
6792/// A dated to-do, card or step as the upcoming-schedule report renders it.
6793///
6794/// Rendered by `app/views/api/schedules/calendar/_assignable.json.jbuilder`,
6795/// which — like the calendar entry partial — writes its own keys instead of
6796/// rendering `recordings/_recording`. Nothing else in the API returns this
6797/// shape.
6798///
6799/// The member that bites: BC3 emits the item's text under `content`, not
6800/// `title`. The previous model of this report declared `title`, so the field
6801/// callers most wanted was permanently absent while a key that was always
6802/// present went unmodelled.
6803#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
6804#[non_exhaustive]
6805pub struct UpcomingAssignable {
6806    /// `id`.
6807    pub id: i64,
6808    /// `status`.
6809    pub status: String,
6810    /// `visible_to_clients`.
6811    pub visible_to_clients: bool,
6812    /// The item's own Basecamp API URL.
6813    pub url: String,
6814    /// `app_url`.
6815    pub app_url: String,
6816    /// The item's start date, `null` unless this is a to-do that has one:
6817    /// Kanban cards and steps both define `starts_on` as a literal nil to
6818    /// duck-type Todo, and the partial reads it unconditionally.
6819    ///
6820    /// The key is in fact always present. It is modeled optional-and-nullable
6821    /// anyway, matching the deliberate treatment of `Todo.starts_on` and
6822    /// `Todo`/`Card.due_on` (see the fifth-g pass in
6823    /// `scripts/enhance-openapi-go-types.sh`): the static SDKs then type it
6824    /// `string | null | undefined`, which accepts the null this really sends and
6825    /// also tolerates a partial payload. Nullability rides that same pass, which
6826    /// is what keeps the Go type `types.Date` rather than a bare string.
6827    #[serde(default, skip_serializing_if = "Option::is_none")]
6828    pub starts_on: Option<Date>,
6829    /// The item's due date, `null` when it has none. Optional-and-nullable for
6830    /// the same reason as starts_on.
6831    #[serde(default, skip_serializing_if = "Option::is_none")]
6832    pub due_on: Option<Date>,
6833    /// The item's kind, LOWERCASE and singular: "todo", "card" or "step".
6834    /// `short_recordable_name` demodulizes and downcases the recordable class,
6835    /// so this does not match the CamelCase `type` other recording projections
6836    /// carry.
6837    pub r#type: String,
6838    /// The item's text — `recordable.title`. Spelled `content`, not `title`:
6839    /// this partial names it after the Todo/Card content attribute rather than
6840    /// the recording's title.
6841    pub content: String,
6842    /// Present and possibly empty, never absent.
6843    pub assignees: Vec<UpcomingSchedulePerson>,
6844    /// `bucket`.
6845    pub bucket: UpcomingScheduleBucket,
6846    /// `parent`.
6847    pub parent: UpcomingAssignableParent,
6848    /// Where to POST/PUT the item's completion.
6849    ///
6850    /// Only the to-do branch is an absolute URL: BC3 renders
6851    /// `completion_bucket_todo_url` for a to-do and
6852    /// `bucket_step_completions_path` for everything else, and a `_path` helper
6853    /// emits no host. Resolve this against the account base rather than assuming
6854    /// it is absolute.
6855    pub completion_url: String,
6856    /// `completed`.
6857    pub completed: bool,
6858    /// Whether the item repeats.
6859    pub repeating: bool,
6860    /// `completion`.
6861    #[serde(default, skip_serializing_if = "Option::is_none")]
6862    pub completion: Option<UpcomingAssignableCompletion>,
6863    /// `comments_count`.
6864    pub comments_count: i32,
6865}
6866
6867/// When an assignable was completed and by whom.
6868#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
6869#[non_exhaustive]
6870pub struct UpcomingAssignableCompletion {
6871    /// `created_at`.
6872    pub created_at: DateTime,
6873    /// `creator`.
6874    pub creator: UpcomingSchedulePerson,
6875}
6876
6877/// The to-do list, card column or parent to-do an assignable is filed under:
6878/// id and title only, with no `type`, `url` or `app_url`.
6879///
6880/// The title is not always the parent's own: for a to-do inside a grouped
6881/// list, `todolist_or_group_title` folds in the grandparent list's title as
6882/// "List: Group".
6883#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
6884#[non_exhaustive]
6885pub struct UpcomingAssignableParent {
6886    /// `id`.
6887    pub id: i64,
6888    /// `title`.
6889    pub title: String,
6890}
6891
6892/// The project an upcoming-schedule item belongs to: id and name only.
6893///
6894/// Both calendar partials write `json.(recording.bucket, :id, :name)`, so this
6895/// is TodoBucket minus `type`. That missing `type` is the first key a strict
6896/// decoder reaches on a populated response, ahead of any of the top-level
6897/// members the calendar entry partial drops.
6898#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
6899#[non_exhaustive]
6900pub struct UpcomingScheduleBucket {
6901    /// `id`.
6902    pub id: i64,
6903    /// `name`.
6904    pub name: String,
6905}
6906
6907/// One schedule entry as the upcoming-schedule report renders it.
6908///
6909/// This is NOT the ScheduleEntry projection. BC3 renders this report through
6910/// `app/views/api/schedules/calendar/_entry.json.jbuilder`, a purpose-built
6911/// calendar partial, while GetScheduleEntry, GetScheduleEntryOccurrence,
6912/// ListScheduleEntries, CreateScheduleEntry and ReplaceScheduleEntry all render
6913/// `schedules/entries/_entry.json.jbuilder` on top of the shared recording
6914/// partial. The calendar partial does not render `recordings/_recording` at
6915/// all — it writes its own keys — so relative to ScheduleEntry it drops
6916/// `created_at`, `updated_at`, `title`, `inherits_status`, `parent`,
6917/// `description_attachments`, `description`, `bookmark_url`,
6918/// `subscription_url`, `comments_url`, `join_url`, `highlighted`,
6919/// `boosts_count` and `boosts_url`, narrows `bucket` to id + name, and adds
6920/// `recurring`, which no other schedule-entry projection emits.
6921///
6922/// Every member here is @required because the partial emits every key
6923/// unconditionally: there is no `if` in it.
6924#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
6925#[non_exhaustive]
6926pub struct UpcomingScheduleEntry {
6927    /// `id`.
6928    pub id: i64,
6929    /// `status`.
6930    pub status: String,
6931    /// `visible_to_clients`.
6932    pub visible_to_clients: bool,
6933    /// The entry's own Basecamp API URL. Unlike the ScheduleEntry projection,
6934    /// this report never carries the entry's join link, so `url` here has no
6935    /// `join_url` sibling to be confused with.
6936    pub url: String,
6937    /// `app_url`.
6938    pub app_url: String,
6939    /// Always the literal string "ScheduleEntry" — the calendar partial hardcodes
6940    /// it rather than deriving it from the recordable, so an occurrence reads
6941    /// back as "ScheduleEntry" too, not "Schedule::Entry::Occurrence".
6942    pub r#type: String,
6943    /// `summary`.
6944    pub summary: String,
6945    /// Whether the entry occupies whole days rather than a time range.
6946    /// Discriminates the two renderings of starts_at/ends_at below.
6947    pub all_day: bool,
6948    /// Whether the entry repeats. Emitted only by this partial —
6949    /// `recording.schedule_entry.recurring?`, i.e. whether the entry carries a
6950    /// recurrence schedule.
6951    ///
6952    /// It also discriminates the two envelope arrays: BC3 selects
6953    /// `schedule_entries` with `recurrence_schedule: nil` and
6954    /// `recurring_schedule_entry_occurrences` with `recurrence_schedule` NOT
6955    /// NULL, so this reads false throughout the first array and true throughout
6956    /// the second.
6957    pub recurring: bool,
6958    /// A date for an all-day entry and a full timestamp for a timed one —
6959    /// `starts_at_date_or_time`, the same rendering ScheduleEntry documents.
6960    /// Treat it as opaque and round-trip it verbatim; the all_day sibling
6961    /// discriminates.
6962    pub starts_at: FlexibleTime,
6963    /// See starts_at for the date-vs-timestamp rendering.
6964    pub ends_at: FlexibleTime,
6965    /// `creator`.
6966    pub creator: UpcomingSchedulePerson,
6967    /// Everyone attending. Present and possibly empty, never absent.
6968    pub participants: Vec<UpcomingSchedulePerson>,
6969    /// `bucket`.
6970    pub bucket: UpcomingScheduleBucket,
6971    /// Comments on the entry — or, for an occurrence, on that occurrence.
6972    pub comments_count: i32,
6973}
6974
6975/// A person as the calendar partials render them: id, name and avatar only.
6976///
6977/// `schedules/calendar/_person.json.jbuilder` delegates to
6978/// `people/_person_minimal.json.jbuilder`, the same three-key partial that
6979/// MyAssignmentAssignee and OutOfOfficePerson already model separately from the
6980/// full Person projection. Reusing Person here would decode — its only
6981/// @required members are id and name — but would advertise two dozen members
6982/// this report never sends.
6983#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
6984#[non_exhaustive]
6985pub struct UpcomingSchedulePerson {
6986    /// `id`.
6987    pub id: i64,
6988    /// `name`.
6989    pub name: String,
6990    /// `avatar_url`.
6991    pub avatar_url: String,
6992}
6993
6994/// A raw byte payload, sent as the request body.
6995pub type UpdateAccountLogoInputPayload = Vec<u8>;
6996
6997/// The `UpdateAccountNameRequestContent` shape of the Basecamp API.
6998#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
6999pub struct UpdateAccountNameRequestContent {
7000    /// `name`.
7001    pub name: String,
7002}
7003
7004/// `UpdateAccountNameResponseContent`.
7005pub type UpdateAccountNameResponseContent = Account;
7006
7007/// The `UpdateBoostRequestContent` shape of the Basecamp API.
7008#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
7009pub struct UpdateBoostRequestContent {
7010    /// `content`.
7011    pub content: String,
7012}
7013
7014/// `UpdateBoostResponseContent`.
7015pub type UpdateBoostResponseContent = Boost;
7016
7017/// The `UpdateCalendarRequestContent` shape of the Basecamp API.
7018#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
7019pub struct UpdateCalendarRequestContent {
7020    /// `calendar`.
7021    pub calendar: CalendarAttributes,
7022}
7023
7024/// `UpdateCalendarResponseContent`.
7025pub type UpdateCalendarResponseContent = Calendar;
7026
7027/// The `UpdateCampfireLineRequestContent` shape of the Basecamp API.
7028#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
7029pub struct UpdateCampfireLineRequestContent {
7030    /// The new line content, interpreted as rich text (HTML)
7031    pub content: String,
7032}
7033
7034/// The `UpdateCardColumnRequestContent` shape of the Basecamp API.
7035#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
7036pub struct UpdateCardColumnRequestContent {
7037    /// `title`.
7038    #[serde(default, skip_serializing_if = "Option::is_none")]
7039    pub title: Option<String>,
7040    /// `description`.
7041    #[serde(default, skip_serializing_if = "Option::is_none")]
7042    pub description: Option<String>,
7043}
7044
7045/// `UpdateCardColumnResponseContent`.
7046pub type UpdateCardColumnResponseContent = CardColumn;
7047
7048/// The `UpdateCardRequestContent` shape of the Basecamp API.
7049#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
7050pub struct UpdateCardRequestContent {
7051    /// `title`.
7052    #[serde(default, skip_serializing_if = "Option::is_none")]
7053    pub title: Option<String>,
7054    /// `content`.
7055    #[serde(default, skip_serializing_if = "Option::is_none")]
7056    pub content: Option<String>,
7057    /// `due_on`.
7058    #[serde(default, skip_serializing_if = "Option::is_none")]
7059    pub due_on: Option<DateChange>,
7060    /// `assignee_ids`.
7061    #[serde(default, skip_serializing_if = "Option::is_none")]
7062    pub assignee_ids: Option<Vec<i64>>,
7063    /// Notify people newly assigned through assignee_ids in this same request.
7064    /// Off unless true, and has no effect without assignee_ids: people already
7065    /// assigned are not notified again.
7066    #[serde(default, skip_serializing_if = "Option::is_none")]
7067    pub notify: Option<bool>,
7068}
7069
7070/// `UpdateCardResponseContent`.
7071pub type UpdateCardResponseContent = Card;
7072
7073/// The `UpdateCardStepRequestContent` shape of the Basecamp API.
7074#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
7075pub struct UpdateCardStepRequestContent {
7076    /// `title`.
7077    #[serde(default, skip_serializing_if = "Option::is_none")]
7078    pub title: Option<String>,
7079    /// `due_on`.
7080    #[serde(default, skip_serializing_if = "Option::is_none")]
7081    pub due_on: Option<DateChange>,
7082    /// `assignee_ids`.
7083    #[serde(default, skip_serializing_if = "Option::is_none")]
7084    pub assignee_ids: Option<Vec<i64>>,
7085}
7086
7087/// `UpdateCardStepResponseContent`.
7088pub type UpdateCardStepResponseContent = Subtask;
7089
7090/// The `UpdateChatbotRequestContent` shape of the Basecamp API.
7091#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
7092pub struct UpdateChatbotRequestContent {
7093    /// `service_name`.
7094    pub service_name: String,
7095    /// `command_url`.
7096    #[serde(default, skip_serializing_if = "Option::is_none")]
7097    pub command_url: Option<String>,
7098}
7099
7100/// `UpdateChatbotResponseContent`.
7101pub type UpdateChatbotResponseContent = Chatbot;
7102
7103/// The `UpdateCloudFileRequestContent` shape of the Basecamp API.
7104#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
7105pub struct UpdateCloudFileRequestContent {
7106    /// `url`.
7107    pub url: String,
7108    /// Short identifier for the external service — "dropbox", "google_doc",
7109    /// "figma", "other", … Derived from the CloudFile::Service subclass name, so it
7110    /// is always present. `other` accepts any well-formed HTTPS URL.
7111    pub service: String,
7112    /// `title`.
7113    #[serde(default, skip_serializing_if = "Option::is_none")]
7114    pub title: Option<String>,
7115    /// `description`.
7116    #[serde(default, skip_serializing_if = "Option::is_none")]
7117    pub description: Option<String>,
7118    /// `subscriptions`.
7119    #[serde(default, skip_serializing_if = "Option::is_none")]
7120    pub subscriptions: Option<Vec<i64>>,
7121}
7122
7123/// `UpdateCloudFileResponseContent`.
7124pub type UpdateCloudFileResponseContent = CloudFile;
7125
7126/// The `UpdateCommentRequestContent` shape of the Basecamp API.
7127#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
7128pub struct UpdateCommentRequestContent {
7129    /// `content`.
7130    pub content: String,
7131}
7132
7133/// `UpdateCommentResponseContent`.
7134pub type UpdateCommentResponseContent = Comment;
7135
7136/// The `UpdateDoorPayload` shape of the Basecamp API.
7137#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
7138pub struct UpdateDoorPayload {
7139    /// Short identifier for the external service, as for CreateDoor.
7140    #[serde(default, skip_serializing_if = "Option::is_none")]
7141    pub service: Option<String>,
7142    /// The address the link points to.
7143    #[serde(default, skip_serializing_if = "Option::is_none")]
7144    pub url: Option<String>,
7145    /// Name shown in the External links section.
7146    #[serde(default, skip_serializing_if = "Option::is_none")]
7147    pub title: Option<String>,
7148    /// Rich-text (HTML) description shown beneath the title.
7149    #[serde(default, skip_serializing_if = "Option::is_none")]
7150    pub description: Option<String>,
7151}
7152
7153/// The `UpdateDoorRequestContent` shape of the Basecamp API.
7154#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
7155pub struct UpdateDoorRequestContent {
7156    /// `door`.
7157    #[serde(default, skip_serializing_if = "Option::is_none")]
7158    pub door: Option<UpdateDoorPayload>,
7159    /// Whether the project's clients can see the external link. Omitted keeps
7160    /// the current visibility.
7161    #[serde(default, skip_serializing_if = "Option::is_none")]
7162    pub visible_to_clients: Option<bool>,
7163}
7164
7165/// `UpdateDoorResponseContent`.
7166pub type UpdateDoorResponseContent = Door;
7167
7168/// The `UpdateFolderRequestContent` shape of the Basecamp API.
7169#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
7170pub struct UpdateFolderRequestContent {
7171    /// The folder's new name. Blank is rejected with 422 — unlike create, update
7172    /// does not fall back to a default name.
7173    pub name: String,
7174}
7175
7176/// `UpdateFolderResponseContent`.
7177pub type UpdateFolderResponseContent = FolderWithProjects;
7178
7179/// The `UpdateGaugeNeedleRequestContent` shape of the Basecamp API.
7180#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
7181pub struct UpdateGaugeNeedleRequestContent {
7182    /// `gauge_needle`.
7183    pub gauge_needle: GaugeNeedleUpdatePayload,
7184}
7185
7186/// `UpdateGaugeNeedleResponseContent`.
7187pub type UpdateGaugeNeedleResponseContent = GaugeNeedle;
7188
7189/// The `UpdateGoogleDocumentRequestContent` shape of the Basecamp API.
7190#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
7191pub struct UpdateGoogleDocumentRequestContent {
7192    /// `url`.
7193    pub url: String,
7194    /// One of "doc", "sheet", "slide", "other". Backed by a Rails enum, so an
7195    /// unrecognized value is rejected up front with a field-keyed 422
7196    /// ({"errors": {"document_type": \["is not a valid document type"\]}}) rather
7197    /// than reaching validation.
7198    pub document_type: String,
7199    /// `title`.
7200    #[serde(default, skip_serializing_if = "Option::is_none")]
7201    pub title: Option<String>,
7202    /// `description`.
7203    #[serde(default, skip_serializing_if = "Option::is_none")]
7204    pub description: Option<String>,
7205    /// active|drafted
7206    #[serde(default, skip_serializing_if = "Option::is_none")]
7207    pub status: Option<String>,
7208    /// `subscriptions`.
7209    #[serde(default, skip_serializing_if = "Option::is_none")]
7210    pub subscriptions: Option<Vec<i64>>,
7211}
7212
7213/// `UpdateGoogleDocumentResponseContent`.
7214pub type UpdateGoogleDocumentResponseContent = GoogleDocument;
7215
7216/// The `UpdateHillChartSettingsRequestContent` shape of the Basecamp API.
7217#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
7218pub struct UpdateHillChartSettingsRequestContent {
7219    /// `tracked`.
7220    #[serde(default, skip_serializing_if = "Option::is_none")]
7221    pub tracked: Option<Vec<i64>>,
7222    /// `untracked`.
7223    #[serde(default, skip_serializing_if = "Option::is_none")]
7224    pub untracked: Option<Vec<i64>>,
7225}
7226
7227/// `UpdateHillChartSettingsResponseContent`.
7228pub type UpdateHillChartSettingsResponseContent = HillChart;
7229
7230/// The `UpdateLineupMarkerRequestContent` shape of the Basecamp API.
7231#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
7232pub struct UpdateLineupMarkerRequestContent {
7233    /// `name`.
7234    #[serde(default, skip_serializing_if = "Option::is_none")]
7235    pub name: Option<String>,
7236    /// `date`.
7237    #[serde(default, skip_serializing_if = "Option::is_none")]
7238    pub date: Option<String>,
7239}
7240
7241/// `UpdateLineupMarkerResponseContent`.
7242pub type UpdateLineupMarkerResponseContent = LineupMarker;
7243
7244/// The `UpdateMessageRequestContent` shape of the Basecamp API.
7245#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
7246pub struct UpdateMessageRequestContent {
7247    /// `subject`.
7248    #[serde(default, skip_serializing_if = "Option::is_none")]
7249    pub subject: Option<String>,
7250    /// `content`.
7251    #[serde(default, skip_serializing_if = "Option::is_none")]
7252    pub content: Option<String>,
7253    /// active|drafted
7254    #[serde(default, skip_serializing_if = "Option::is_none")]
7255    pub status: Option<String>,
7256    /// `category_id`.
7257    #[serde(default, skip_serializing_if = "Option::is_none")]
7258    pub category_id: Option<i64>,
7259}
7260
7261/// `UpdateMessageResponseContent`.
7262pub type UpdateMessageResponseContent = Message;
7263
7264/// The `UpdateMessageTypeRequestContent` shape of the Basecamp API.
7265#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
7266pub struct UpdateMessageTypeRequestContent {
7267    /// `name`.
7268    #[serde(default, skip_serializing_if = "Option::is_none")]
7269    pub name: Option<String>,
7270    /// `icon`.
7271    #[serde(default, skip_serializing_if = "Option::is_none")]
7272    pub icon: Option<String>,
7273}
7274
7275/// `UpdateMessageTypeResponseContent`.
7276pub type UpdateMessageTypeResponseContent = MessageType;
7277
7278/// The `UpdateMyNoteRequestContent` shape of the Basecamp API.
7279#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
7280pub struct UpdateMyNoteRequestContent {
7281    /// `note`.
7282    pub note: MyNoteAttributes,
7283}
7284
7285/// `UpdateMyNoteResponseContent`.
7286pub type UpdateMyNoteResponseContent = MyNote;
7287
7288/// The `UpdateMyPreferencesRequestContent` shape of the Basecamp API.
7289#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
7290pub struct UpdateMyPreferencesRequestContent {
7291    /// `person`.
7292    pub person: PreferencesPayload,
7293}
7294
7295/// `UpdateMyPreferencesResponseContent`.
7296pub type UpdateMyPreferencesResponseContent = Preferences;
7297
7298/// The `UpdateMyProfileRequestContent` shape of the Basecamp API.
7299#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
7300pub struct UpdateMyProfileRequestContent {
7301    /// `name`.
7302    #[serde(default, skip_serializing_if = "Option::is_none")]
7303    pub name: Option<String>,
7304    /// `email_address`.
7305    #[serde(default, skip_serializing_if = "Option::is_none")]
7306    pub email_address: Option<String>,
7307    /// `title`.
7308    #[serde(default, skip_serializing_if = "Option::is_none")]
7309    pub title: Option<String>,
7310    /// `bio`.
7311    #[serde(default, skip_serializing_if = "Option::is_none")]
7312    pub bio: Option<String>,
7313    /// `location`.
7314    #[serde(default, skip_serializing_if = "Option::is_none")]
7315    pub location: Option<String>,
7316    /// `time_zone_name`.
7317    #[serde(default, skip_serializing_if = "Option::is_none")]
7318    pub time_zone_name: Option<String>,
7319    /// `first_week_day`.
7320    #[serde(default, skip_serializing_if = "Option::is_none")]
7321    pub first_week_day: Option<FirstWeekDay>,
7322    /// `time_format`.
7323    #[serde(default, skip_serializing_if = "Option::is_none")]
7324    pub time_format: Option<String>,
7325}
7326
7327/// The `UpdateProjectAccessRequestContent` shape of the Basecamp API.
7328#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
7329pub struct UpdateProjectAccessRequestContent {
7330    /// `grant`.
7331    #[serde(default, skip_serializing_if = "Option::is_none")]
7332    pub grant: Option<Vec<i64>>,
7333    /// `revoke`.
7334    #[serde(default, skip_serializing_if = "Option::is_none")]
7335    pub revoke: Option<Vec<i64>>,
7336    /// `create`.
7337    #[serde(default, skip_serializing_if = "Option::is_none")]
7338    pub create: Option<Vec<CreatePersonRequest>>,
7339}
7340
7341/// `UpdateProjectAccessResponseContent`.
7342pub type UpdateProjectAccessResponseContent = ProjectAccessResult;
7343
7344/// The `UpdateProjectClientAccessRequestContent` shape of the Basecamp API.
7345#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
7346pub struct UpdateProjectClientAccessRequestContent {
7347    /// Existing client people IDs to add to the project.
7348    #[serde(default, skip_serializing_if = "Option::is_none")]
7349    pub grant: Option<Vec<i64>>,
7350    /// Client people IDs to remove from the project.
7351    #[serde(default, skip_serializing_if = "Option::is_none")]
7352    pub revoke: Option<Vec<i64>>,
7353    /// New clients to invite by email.
7354    #[serde(default, skip_serializing_if = "Option::is_none")]
7355    pub create: Option<Vec<CreateClientRequest>>,
7356}
7357
7358/// `UpdateProjectClientAccessResponseContent`.
7359pub type UpdateProjectClientAccessResponseContent = ProjectAccessResult;
7360
7361/// A raw byte payload, sent as the request body.
7362pub type UpdateProjectLogoInputPayload = Vec<u8>;
7363
7364/// The `UpdateProjectRequestContent` shape of the Basecamp API.
7365#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
7366pub struct UpdateProjectRequestContent {
7367    /// `name`.
7368    pub name: String,
7369    /// `description`.
7370    #[serde(default, skip_serializing_if = "Option::is_none")]
7371    pub description: Option<String>,
7372    /// invite|employee|team
7373    #[serde(default, skip_serializing_if = "Option::is_none")]
7374    pub admissions: Option<String>,
7375    /// `schedule_attributes`.
7376    #[serde(default, skip_serializing_if = "Option::is_none")]
7377    pub schedule_attributes: Option<ScheduleAttributes>,
7378    /// How the project's wallpaper is laid out. Changes only the layout of a
7379    /// wallpaper already attached; UpdateProjectWallpaper uploads one.
7380    #[serde(default, skip_serializing_if = "Option::is_none")]
7381    pub wallpaper_mode: Option<String>,
7382    /// The project's color, used for it on calendars: white, red, orange,
7383    /// yellow, green, blue, aqua, purple, gray, pink or brown. An empty string clears
7384    /// it, and Basecamp derives one from the project's name again. A value
7385    /// outside the enum answers a server error, not a validation error. The
7386    /// `color` a project read returns is something else: the caller's own color
7387    /// for the project on their home screen, null unless they set one.
7388    #[serde(default, skip_serializing_if = "Option::is_none")]
7389    pub color: Option<String>,
7390    /// What kind of project it is: `topic` (a regular project), `team`, or
7391    /// `company_hq` (the account's Company HQ). Changing a `topic` to anything
7392    /// else deletes the project's start and end dates. An account has at most
7393    /// one `company_hq`; asking for a second answers 422. BC3's enum also has
7394    /// `guide`, which marks a project as a sample nobody can edit afterwards,
7395    /// so it isn't offered.
7396    #[serde(default, skip_serializing_if = "Option::is_none")]
7397    pub purpose: Option<String>,
7398    /// Turn the project's timesheet on or off. Basecamp ignores this when the
7399    /// caller can't use timesheets (the account lacks them, or the caller is a
7400    /// client).
7401    #[serde(default, skip_serializing_if = "Option::is_none")]
7402    pub timesheet_enabled: Option<bool>,
7403}
7404
7405/// `UpdateProjectResponseContent`.
7406pub type UpdateProjectResponseContent = Project;
7407
7408/// A raw byte payload, sent as the request body.
7409pub type UpdateProjectWallpaperInputPayload = Vec<u8>;
7410
7411/// The `UpdateQuestionNotificationSettingsRequestContent` shape of the Basecamp API.
7412#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
7413pub struct UpdateQuestionNotificationSettingsRequestContent {
7414    /// Whether the authenticated user is asked this question. Omit to leave it unchanged.
7415    /// Turning it on also subscribes the user unless `subscribed: false` is sent with it.
7416    #[serde(default, skip_serializing_if = "Option::is_none")]
7417    pub responding: Option<bool>,
7418    /// Whether the authenticated user is notified when someone answers. Omit to leave it unchanged.
7419    #[serde(default, skip_serializing_if = "Option::is_none")]
7420    pub subscribed: Option<bool>,
7421}
7422
7423/// The `UpdateQuestionNotificationSettingsResponseContent` shape of the Basecamp API.
7424#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
7425#[non_exhaustive]
7426pub struct UpdateQuestionNotificationSettingsResponseContent {
7427    /// `responding`.
7428    #[serde(default, skip_serializing_if = "Option::is_none")]
7429    pub responding: Option<bool>,
7430    /// `subscribed`.
7431    #[serde(default, skip_serializing_if = "Option::is_none")]
7432    pub subscribed: Option<bool>,
7433}
7434
7435/// The `UpdateQuestionRequestContent` shape of the Basecamp API.
7436#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
7437pub struct UpdateQuestionRequestContent {
7438    /// The question text. An update carries a title, a schedule or both.
7439    #[serde(default, skip_serializing_if = "Option::is_none")]
7440    pub title: Option<String>,
7441    /// `schedule`.
7442    #[serde(default, skip_serializing_if = "Option::is_none")]
7443    pub schedule: Option<QuestionScheduleInput>,
7444}
7445
7446/// `UpdateQuestionResponseContent`.
7447pub type UpdateQuestionResponseContent = Question;
7448
7449/// The `UpdateScheduleSettingsRequestContent` shape of the Basecamp API.
7450#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
7451pub struct UpdateScheduleSettingsRequestContent {
7452    /// `include_due_assignments`.
7453    pub include_due_assignments: bool,
7454}
7455
7456/// `UpdateScheduleSettingsResponseContent`.
7457pub type UpdateScheduleSettingsResponseContent = Schedule;
7458
7459/// The `UpdateSubscriptionRequestContent` shape of the Basecamp API.
7460#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
7461pub struct UpdateSubscriptionRequestContent {
7462    /// `subscriptions`.
7463    #[serde(default, skip_serializing_if = "Option::is_none")]
7464    pub subscriptions: Option<Vec<i64>>,
7465    /// `unsubscriptions`.
7466    #[serde(default, skip_serializing_if = "Option::is_none")]
7467    pub unsubscriptions: Option<Vec<i64>>,
7468}
7469
7470/// `UpdateSubscriptionResponseContent`.
7471pub type UpdateSubscriptionResponseContent = Subscription;
7472
7473/// The `UpdateSubtaskRequestContent` shape of the Basecamp API.
7474#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
7475pub struct UpdateSubtaskRequestContent {
7476    /// `title`.
7477    #[serde(default, skip_serializing_if = "Option::is_none")]
7478    pub title: Option<String>,
7479    /// `due_on`.
7480    #[serde(default, skip_serializing_if = "Option::is_none")]
7481    pub due_on: Option<DateChange>,
7482    /// `assignee_ids`.
7483    #[serde(default, skip_serializing_if = "Option::is_none")]
7484    pub assignee_ids: Option<Vec<i64>>,
7485}
7486
7487/// `UpdateSubtaskResponseContent`.
7488pub type UpdateSubtaskResponseContent = Subtask;
7489
7490/// The `UpdateTemplateRequestContent` shape of the Basecamp API.
7491#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
7492pub struct UpdateTemplateRequestContent {
7493    /// `name`.
7494    #[serde(default, skip_serializing_if = "Option::is_none")]
7495    pub name: Option<String>,
7496    /// `description`.
7497    #[serde(default, skip_serializing_if = "Option::is_none")]
7498    pub description: Option<String>,
7499}
7500
7501/// `UpdateTemplateResponseContent`.
7502pub type UpdateTemplateResponseContent = Template;
7503
7504/// The `UpdateTimesheetEntryRequestContent` shape of the Basecamp API.
7505#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
7506pub struct UpdateTimesheetEntryRequestContent {
7507    /// `date`.
7508    #[serde(default, skip_serializing_if = "Option::is_none")]
7509    pub date: Option<String>,
7510    /// `hours`.
7511    #[serde(default, skip_serializing_if = "Option::is_none")]
7512    pub hours: Option<String>,
7513    /// `description`.
7514    #[serde(default, skip_serializing_if = "Option::is_none")]
7515    pub description: Option<String>,
7516    /// `person_id`.
7517    #[serde(default, skip_serializing_if = "Option::is_none")]
7518    pub person_id: Option<i64>,
7519}
7520
7521/// `UpdateTimesheetEntryResponseContent`.
7522pub type UpdateTimesheetEntryResponseContent = TimesheetEntry;
7523
7524/// The `UpdateTodolistOrGroupRequestContent` shape of the Basecamp API.
7525#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
7526pub struct UpdateTodolistOrGroupRequestContent {
7527    /// Name (required for a to-do list and for a group alike) - presence-validated server-side, so omitting it is a 422, not a preserve
7528    pub name: String,
7529    /// Description (rich text HTML) - writable for a todolist group as well as a todolist, and omitting it clears it either way
7530    #[serde(default, skip_serializing_if = "Option::is_none")]
7531    pub description: Option<String>,
7532}
7533
7534/// `UpdateTodolistOrGroupResponseContent`.
7535pub type UpdateTodolistOrGroupResponseContent = Todolist;
7536
7537/// The `UpdateToolRequestContent` shape of the Basecamp API.
7538#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
7539pub struct UpdateToolRequestContent {
7540    /// `title`.
7541    pub title: String,
7542}
7543
7544/// `UpdateToolResponseContent`.
7545pub type UpdateToolResponseContent = Tool;
7546
7547/// The `UpdateUploadRequestContent` shape of the Basecamp API.
7548#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
7549pub struct UpdateUploadRequestContent {
7550    /// `description`.
7551    #[serde(default, skip_serializing_if = "Option::is_none")]
7552    pub description: Option<String>,
7553    /// `base_name`.
7554    #[serde(default, skip_serializing_if = "Option::is_none")]
7555    pub base_name: Option<String>,
7556}
7557
7558/// `UpdateUploadResponseContent`.
7559pub type UpdateUploadResponseContent = Upload;
7560
7561/// The `UpdateVaultRequestContent` shape of the Basecamp API.
7562#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
7563pub struct UpdateVaultRequestContent {
7564    /// `title`.
7565    #[serde(default, skip_serializing_if = "Option::is_none")]
7566    pub title: Option<String>,
7567}
7568
7569/// `UpdateVaultResponseContent`.
7570pub type UpdateVaultResponseContent = Vault;
7571
7572/// The `UpdateWebhookRequestContent` shape of the Basecamp API.
7573#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
7574pub struct UpdateWebhookRequestContent {
7575    /// `payload_url`.
7576    #[serde(default, skip_serializing_if = "Option::is_none")]
7577    pub payload_url: Option<String>,
7578    /// `types`.
7579    #[serde(default, skip_serializing_if = "Option::is_none")]
7580    pub types: Option<Vec<String>>,
7581    /// `active`.
7582    #[serde(default, skip_serializing_if = "Option::is_none")]
7583    pub active: Option<bool>,
7584}
7585
7586/// `UpdateWebhookResponseContent`.
7587pub type UpdateWebhookResponseContent = Webhook;
7588
7589/// The `UpdateWormholeRequestContent` shape of the Basecamp API.
7590#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
7591pub struct UpdateWormholeRequestContent {
7592    /// Id of the new destination column (on another accessible card table).
7593    pub destination_recording_id: i64,
7594}
7595
7596/// `UpdateWormholeResponseContent`.
7597pub type UpdateWormholeResponseContent = Wormhole;
7598
7599/// The `Upload` shape of the Basecamp API.
7600#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
7601#[non_exhaustive]
7602pub struct Upload {
7603    /// `id`.
7604    pub id: i64,
7605    /// `status`.
7606    pub status: String,
7607    /// `visible_to_clients`.
7608    pub visible_to_clients: bool,
7609    /// `created_at`.
7610    pub created_at: DateTime,
7611    /// `updated_at`.
7612    pub updated_at: DateTime,
7613    /// `title`.
7614    pub title: String,
7615    /// `inherits_status`.
7616    pub inherits_status: bool,
7617    /// `type`.
7618    pub r#type: String,
7619    /// `url`.
7620    pub url: String,
7621    /// `app_url`.
7622    pub app_url: String,
7623    /// `bookmark_url`.
7624    #[serde(default, skip_serializing_if = "Option::is_none")]
7625    pub bookmark_url: Option<String>,
7626    /// `subscription_url`.
7627    #[serde(default, skip_serializing_if = "Option::is_none")]
7628    pub subscription_url: Option<String>,
7629    /// `comments_count`.
7630    #[serde(default, skip_serializing_if = "Option::is_none")]
7631    pub comments_count: Option<i32>,
7632    /// `comments_url`.
7633    #[serde(default, skip_serializing_if = "Option::is_none")]
7634    pub comments_url: Option<String>,
7635    /// `position`.
7636    #[serde(default, skip_serializing_if = "Option::is_none")]
7637    pub position: Option<i32>,
7638    /// `parent`.
7639    pub parent: RecordingParent,
7640    /// `bucket`.
7641    pub bucket: TodoBucket,
7642    /// `creator`.
7643    pub creator: Person,
7644    /// `description`.
7645    #[serde(default, skip_serializing_if = "Option::is_none")]
7646    pub description: Option<String>,
7647    /// `description_attachments`.
7648    pub description_attachments: Vec<RichTextAttachment>,
7649    /// `content_type`.
7650    #[serde(default, skip_serializing_if = "Option::is_none")]
7651    pub content_type: Option<String>,
7652    /// `byte_size`.
7653    #[serde(default, skip_serializing_if = "Option::is_none")]
7654    pub byte_size: Option<i64>,
7655    /// `width`.
7656    #[serde(
7657        default,
7658        deserialize_with = "crate::types::flex_int::deserialize",
7659        skip_serializing_if = "Option::is_none"
7660    )]
7661    pub width: Option<i32>,
7662    /// `height`.
7663    #[serde(
7664        default,
7665        deserialize_with = "crate::types::flex_int::deserialize",
7666        skip_serializing_if = "Option::is_none"
7667    )]
7668    pub height: Option<i32>,
7669    /// `download_url`.
7670    #[serde(default, skip_serializing_if = "Option::is_none")]
7671    pub download_url: Option<AuthRoutableUrl>,
7672    /// `filename`.
7673    #[serde(default, skip_serializing_if = "Option::is_none")]
7674    pub filename: Option<String>,
7675    /// `boosts_count`.
7676    #[serde(default, skip_serializing_if = "Option::is_none")]
7677    pub boosts_count: Option<i32>,
7678    /// `boosts_url`.
7679    #[serde(default, skip_serializing_if = "Option::is_none")]
7680    pub boosts_url: Option<String>,
7681}
7682
7683/// A version event for an upload, from GET /uploads/{id}/versions.json.
7684///
7685/// `action` is one of `created`, `active` (the upload's publication) or `blob_changed`
7686/// (a file replacement). To list the file's PAST versions, select entries that carry
7687/// an `upload` whose `current` is false — the original file arrives as `created` or
7688/// `active`, never `blob_changed`, so filtering on that action drops the original
7689/// and keeps the current file instead. This is an Event plus the file it recorded, rendered by its own
7690/// partial rather than the shared event one, so upload fields don't leak onto todo,
7691/// message and card events.
7692#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
7693#[non_exhaustive]
7694pub struct UploadVersion {
7695    /// `id`.
7696    pub id: i64,
7697    /// `recording_id`.
7698    pub recording_id: i64,
7699    /// `action`.
7700    pub action: String,
7701    /// `details`.
7702    #[serde(default, skip_serializing_if = "Option::is_none")]
7703    pub details: Option<EventDetails>,
7704    /// `created_at`.
7705    pub created_at: DateTime,
7706    /// `creator`.
7707    pub creator: Person,
7708    /// `boosts_count`.
7709    #[serde(default, skip_serializing_if = "Option::is_none")]
7710    pub boosts_count: Option<i32>,
7711    /// `boosts_url`.
7712    #[serde(default, skip_serializing_if = "Option::is_none")]
7713    pub boosts_url: Option<String>,
7714    /// `upload`.
7715    #[serde(default, skip_serializing_if = "Option::is_none")]
7716    pub upload: Option<UploadVersionFile>,
7717}
7718
7719/// The file a version event recorded — a reduced projection, not an Upload.
7720#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
7721#[non_exhaustive]
7722pub struct UploadVersionFile {
7723    /// `content_type`.
7724    #[serde(default, skip_serializing_if = "Option::is_none")]
7725    pub content_type: Option<String>,
7726    /// `byte_size`.
7727    #[serde(default, skip_serializing_if = "Option::is_none")]
7728    pub byte_size: Option<i64>,
7729    /// `filename`.
7730    pub filename: String,
7731    /// Fetches THIS version's bytes. The upload's own download_url always serves the
7732    /// latest, which is the whole point of the feature.
7733    pub download_url: AuthRoutableUrl,
7734    /// `app_download_url`.
7735    pub app_download_url: String,
7736    /// True for the newest version *event*, and for exactly one element of any
7737    /// non-empty response. The renderer computes it positionally — `event ==
7738    /// @events.first` over a reverse-chronological list — so it is a property of
7739    /// ordering, not of what the upload currently points at, and it cannot be
7740    /// zero or plural.
7741    ///
7742    /// That distinction is the whole caveat: `current` does NOT mean "this is the
7743    /// file the upload's own download_url serves". A metadata-only PUT swaps in a
7744    /// recordable carrying the same blob and emits no event, so afterwards no
7745    /// event references the upload's current recordable — and this flag still
7746    /// marks exactly one element, the newest event. bc3 pins that case by name in
7747    /// "exactly one version is current after a metadata-only update".
7748    pub current: bool,
7749}
7750
7751/// The `ValidationErrorResponseContent` shape of the Basecamp API.
7752#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
7753#[non_exhaustive]
7754pub struct ValidationErrorResponseContent {
7755    /// `error`.
7756    pub error: String,
7757    /// `message`.
7758    #[serde(default, skip_serializing_if = "Option::is_none")]
7759    pub message: Option<String>,
7760}
7761
7762/// The `Vault` shape of the Basecamp API.
7763#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
7764#[non_exhaustive]
7765pub struct Vault {
7766    /// `id`.
7767    pub id: i64,
7768    /// `status`.
7769    pub status: String,
7770    /// `visible_to_clients`.
7771    pub visible_to_clients: bool,
7772    /// `created_at`.
7773    pub created_at: DateTime,
7774    /// `updated_at`.
7775    pub updated_at: DateTime,
7776    /// `title`.
7777    pub title: String,
7778    /// `inherits_status`.
7779    pub inherits_status: bool,
7780    /// `type`.
7781    pub r#type: String,
7782    /// `url`.
7783    pub url: String,
7784    /// `app_url`.
7785    pub app_url: String,
7786    /// `bookmark_url`.
7787    #[serde(default, skip_serializing_if = "Option::is_none")]
7788    pub bookmark_url: Option<String>,
7789    /// `position`.
7790    #[serde(default, skip_serializing_if = "Option::is_none")]
7791    pub position: Option<i32>,
7792    /// `parent`.
7793    #[serde(default, skip_serializing_if = "Option::is_none")]
7794    pub parent: Option<RecordingParent>,
7795    /// `bucket`.
7796    pub bucket: TodoBucket,
7797    /// `creator`.
7798    pub creator: Person,
7799    /// `documents_count`.
7800    #[serde(default, skip_serializing_if = "Option::is_none")]
7801    pub documents_count: Option<i32>,
7802    /// `documents_url`.
7803    #[serde(default, skip_serializing_if = "Option::is_none")]
7804    pub documents_url: Option<String>,
7805    /// `uploads_count`.
7806    #[serde(default, skip_serializing_if = "Option::is_none")]
7807    pub uploads_count: Option<i32>,
7808    /// `uploads_url`.
7809    #[serde(default, skip_serializing_if = "Option::is_none")]
7810    pub uploads_url: Option<String>,
7811    /// `vaults_count`.
7812    #[serde(default, skip_serializing_if = "Option::is_none")]
7813    pub vaults_count: Option<i32>,
7814    /// `vaults_url`.
7815    #[serde(default, skip_serializing_if = "Option::is_none")]
7816    pub vaults_url: Option<String>,
7817}
7818
7819/// The `Webhook` shape of the Basecamp API.
7820#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
7821#[non_exhaustive]
7822pub struct Webhook {
7823    /// `id`.
7824    pub id: i64,
7825    /// `active`.
7826    #[serde(default, skip_serializing_if = "Option::is_none")]
7827    pub active: Option<bool>,
7828    /// `created_at`.
7829    pub created_at: DateTime,
7830    /// `updated_at`.
7831    pub updated_at: DateTime,
7832    /// `payload_url`.
7833    pub payload_url: String,
7834    /// `types`.
7835    #[serde(default, skip_serializing_if = "Option::is_none")]
7836    pub types: Option<Vec<String>>,
7837    /// `url`.
7838    pub url: String,
7839    /// `app_url`.
7840    pub app_url: String,
7841    /// Up to the 25 most recent delivery exchanges, most recent first.
7842    /// Empty when the webhook hasn't delivered anything yet.
7843    #[serde(default, skip_serializing_if = "Option::is_none")]
7844    pub recent_deliveries: Option<Vec<WebhookDelivery>>,
7845}
7846
7847/// Reference to a copied/moved recording in copy events.
7848#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
7849#[non_exhaustive]
7850pub struct WebhookCopy {
7851    /// `id`.
7852    #[serde(default, skip_serializing_if = "Option::is_none")]
7853    pub id: Option<i64>,
7854    /// `url`.
7855    #[serde(default, skip_serializing_if = "Option::is_none")]
7856    pub url: Option<String>,
7857    /// `app_url`.
7858    #[serde(default, skip_serializing_if = "Option::is_none")]
7859    pub app_url: Option<String>,
7860    /// `bucket`.
7861    #[serde(default, skip_serializing_if = "Option::is_none")]
7862    pub bucket: Option<WebhookCopyBucket>,
7863}
7864
7865/// The `WebhookCopyBucket` shape of the Basecamp API.
7866#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
7867#[non_exhaustive]
7868pub struct WebhookCopyBucket {
7869    /// `id`.
7870    #[serde(default, skip_serializing_if = "Option::is_none")]
7871    pub id: Option<i64>,
7872}
7873
7874/// The `WebhookDelivery` shape of the Basecamp API.
7875#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
7876#[non_exhaustive]
7877pub struct WebhookDelivery {
7878    /// `id`.
7879    #[serde(default, skip_serializing_if = "Option::is_none")]
7880    pub id: Option<i64>,
7881    /// `created_at`.
7882    #[serde(default, skip_serializing_if = "Option::is_none")]
7883    pub created_at: Option<DateTime>,
7884    /// `request`.
7885    #[serde(default, skip_serializing_if = "Option::is_none")]
7886    pub request: Option<WebhookDeliveryRequest>,
7887    /// `response`.
7888    #[serde(default, skip_serializing_if = "Option::is_none")]
7889    pub response: Option<WebhookDeliveryResponse>,
7890}
7891
7892/// The `WebhookDeliveryRequest` shape of the Basecamp API.
7893#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
7894#[non_exhaustive]
7895pub struct WebhookDeliveryRequest {
7896    /// `headers`.
7897    #[serde(default, skip_serializing_if = "Option::is_none")]
7898    pub headers: Option<WebhookHeadersMap>,
7899    /// `body`.
7900    #[serde(default, skip_serializing_if = "Option::is_none")]
7901    pub body: Option<WebhookEvent>,
7902}
7903
7904/// The `WebhookDeliveryResponse` shape of the Basecamp API.
7905#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
7906#[non_exhaustive]
7907pub struct WebhookDeliveryResponse {
7908    /// `headers`.
7909    #[serde(default, skip_serializing_if = "Option::is_none")]
7910    pub headers: Option<WebhookHeadersMap>,
7911    /// `code`.
7912    #[serde(default, skip_serializing_if = "Option::is_none")]
7913    pub code: Option<i32>,
7914    /// `message`.
7915    #[serde(default, skip_serializing_if = "Option::is_none")]
7916    pub message: Option<String>,
7917}
7918
7919/// The event payload delivered to webhook URLs.
7920/// This is the body of an outbound webhook HTTP request.
7921/// Also appears as the body field in WebhookDelivery.request.
7922#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
7923#[non_exhaustive]
7924pub struct WebhookEvent {
7925    /// `id`.
7926    #[serde(default, skip_serializing_if = "Option::is_none")]
7927    pub id: Option<i64>,
7928    /// `kind`.
7929    #[serde(default, skip_serializing_if = "Option::is_none")]
7930    pub kind: Option<String>,
7931    /// `details`.
7932    #[serde(default, skip_serializing_if = "Option::is_none")]
7933    pub details: Option<serde_json::Value>,
7934    /// `created_at`.
7935    #[serde(default, skip_serializing_if = "Option::is_none")]
7936    pub created_at: Option<DateTime>,
7937    /// `recording`.
7938    #[serde(default, skip_serializing_if = "Option::is_none")]
7939    pub recording: Option<Recording>,
7940    /// `creator`.
7941    #[serde(default, skip_serializing_if = "Option::is_none")]
7942    pub creator: Option<Person>,
7943    /// `performed_by`.
7944    #[serde(default, skip_serializing_if = "Option::is_none")]
7945    pub performed_by: Option<Person>,
7946    /// `copy`.
7947    #[serde(default, skip_serializing_if = "Option::is_none")]
7948    pub copy: Option<WebhookCopy>,
7949}
7950
7951/// `WebhookHeadersMap`.
7952pub type WebhookHeadersMap = BTreeMap<String, String>;
7953
7954/// The `WebhookLimitErrorResponseContent` shape of the Basecamp API.
7955#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
7956#[non_exhaustive]
7957pub struct WebhookLimitErrorResponseContent {
7958    /// `error`.
7959    pub error: String,
7960    /// `message`.
7961    #[serde(default, skip_serializing_if = "Option::is_none")]
7962    pub message: Option<String>,
7963}
7964
7965/// A wormhole is a standing shortcut from this card table to a column on another
7966/// card table, usually in another project, and the only way to move a card across
7967/// projects. It carries the full recording representation
7968/// plus the destination-linkage fields. The wormhole's own `url`/`app_url`/`parent`
7969/// point at the *source* board; `destination_url` is the only field identifying
7970/// the destination column.
7971#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
7972#[non_exhaustive]
7973pub struct Wormhole {
7974    /// `id`.
7975    pub id: i64,
7976    /// `status`.
7977    pub status: String,
7978    /// `visible_to_clients`.
7979    pub visible_to_clients: bool,
7980    /// `created_at`.
7981    pub created_at: DateTime,
7982    /// `updated_at`.
7983    pub updated_at: DateTime,
7984    /// `title`.
7985    pub title: String,
7986    /// `inherits_status`.
7987    pub inherits_status: bool,
7988    /// `type`.
7989    pub r#type: String,
7990    /// `url`.
7991    pub url: String,
7992    /// `app_url`.
7993    pub app_url: String,
7994    /// `bookmark_url`.
7995    #[serde(default, skip_serializing_if = "Option::is_none")]
7996    pub bookmark_url: Option<String>,
7997    /// `parent`.
7998    pub parent: RecordingParent,
7999    /// `bucket`.
8000    pub bucket: TodoBucket,
8001    /// `creator`.
8002    pub creator: Person,
8003    /// Wormhole color; always emitted on the wire (`json.color recording.color`),
8004    /// `null` when unset. Like destination_url, `@required` models the presence and
8005    /// the nullability is layered on in the OpenAPI (smithy-build.json jsonAdd -\>
8006    /// type: \["string","null"\]). Go types it *string because the value is nullable,
8007    /// not because it is optional — the field is @required and carries no omitempty.
8008    #[serde(deserialize_with = "serde::Deserialize::deserialize")]
8009    pub color: Option<String>,
8010    /// True only while the destination column, its board, and its bucket are all
8011    /// active; false once the destination is unlinked. Always emitted.
8012    pub linked: bool,
8013    /// URL of the destination column; always present on the wire, `null` for an
8014    /// unlinked wormhole. `@required` models the presence; the nullability of the
8015    /// value is layered on in the OpenAPI (smithy-build.json jsonAdd -\> type:
8016    /// \["string","null"\]) since Smithy has no native
8017    /// required-and-nullable — exactly the SearchType.key treatment. SDKs model it
8018    /// as required-but-nullable (`string | null`, not `string | null | undefined`).
8019    #[serde(deserialize_with = "serde::Deserialize::deserialize")]
8020    pub destination_url: Option<String>,
8021}
8022
8023/// Deprecated: renamed to Subtask, the same Kanban::Step record.
8024#[deprecated(note = "renamed to Subtask, the same Kanban::Step record.")]
8025pub type CardStep = Subtask;