io_msgraph/v1/rest/users/
events.rs

1//! Microsoft Graph events (`users.events`): list, get, create, update,
2//! delete, the instances of a series, the calendar view and its delta.
3//!
4//! A recurring series is one `seriesMaster` event carrying the
5//! recurrence; its `occurrence`s are computed, and an occurrence edited on
6//! its own becomes an `exception`, both pointing at the master through
7//! `seriesMasterId`. The events listing returns masters and lone events,
8//! the calendar view and the instances listing expand occurrences.
9//!
10//! <https://learn.microsoft.com/en-us/graph/api/resources/event>
11
12use alloc::{string::String, vec::Vec};
13
14use serde::{Deserialize, Serialize};
15
16use crate::v1::{
17    field::MsgraphField,
18    rest::users::{
19        contacts::{MsgraphPhysicalAddress, MsgraphSingleValueExtendedProperty},
20        messages::{MsgraphEmailAddress, MsgraphImportance, MsgraphItemBody, MsgraphRecipient},
21    },
22};
23
24pub mod calendar_view;
25pub mod create;
26pub mod delete;
27pub mod delta;
28pub mod get;
29#[cfg(feature = "ical")]
30pub mod ical;
31pub mod instances;
32pub mod list;
33pub mod update;
34
35/// An event of a calendar. Doubles as the create/update body.
36///
37/// Unset fields are left out (an update preserves them), null fields are
38/// serialized as explicit nulls (an update clears them), and a set empty
39/// collection clears the collection.
40#[derive(Debug, Clone, Default, Deserialize, Serialize, Eq, PartialEq)]
41#[serde(rename_all = "camelCase")]
42pub struct MsgraphEvent {
43    /// The unique identifier of the event.
44    #[serde(default, skip_serializing_if = "String::is_empty")]
45    pub id: String,
46    /// The iCalendar UID shared by every event of a series across
47    /// calendars, read-only.
48    #[serde(default, rename = "iCalUId", skip_serializing_if = "Option::is_none")]
49    pub ical_uid: Option<String>,
50    /// The version of the event, changing with every edit, read-only.
51    #[serde(default, skip_serializing_if = "Option::is_none")]
52    pub change_key: Option<String>,
53    /// When the event was created, read-only.
54    #[serde(default, skip_serializing_if = "Option::is_none")]
55    pub created_date_time: Option<String>,
56    /// When the event was last modified, read-only.
57    #[serde(default, skip_serializing_if = "Option::is_none")]
58    pub last_modified_date_time: Option<String>,
59    /// The kind of event: lone, series master, occurrence or exception,
60    /// read-only.
61    #[serde(default, rename = "type", skip_serializing_if = "Option::is_none")]
62    pub event_type: Option<MsgraphEventType>,
63    /// The series master of an occurrence or exception, read-only.
64    #[serde(default, skip_serializing_if = "Option::is_none")]
65    pub series_master_id: Option<String>,
66    /// The start the occurrence had in its series, for an occurrence or
67    /// an exception, read-only.
68    #[serde(default, skip_serializing_if = "Option::is_none")]
69    pub original_start: Option<String>,
70    /// The zone the event's start was created in, read-only.
71    #[serde(default, skip_serializing_if = "Option::is_none")]
72    pub original_start_time_zone: Option<String>,
73    /// The zone the event's end was created in, read-only.
74    #[serde(default, skip_serializing_if = "Option::is_none")]
75    pub original_end_time_zone: Option<String>,
76    /// The subject.
77    #[serde(default, skip_serializing_if = "MsgraphField::is_unset")]
78    pub subject: MsgraphField<String>,
79    /// The body.
80    #[serde(default, skip_serializing_if = "MsgraphField::is_unset")]
81    pub body: MsgraphField<MsgraphItemBody>,
82    /// The start, a wall time in a zone.
83    #[serde(default, skip_serializing_if = "MsgraphField::is_unset")]
84    pub start: MsgraphField<MsgraphDateTimeTimeZone>,
85    /// The end, a wall time in a zone.
86    #[serde(default, skip_serializing_if = "MsgraphField::is_unset")]
87    pub end: MsgraphField<MsgraphDateTimeTimeZone>,
88    /// Whether the event lasts whole days, its start and end then being
89    /// midnights.
90    #[serde(default, skip_serializing_if = "MsgraphField::is_unset")]
91    pub is_all_day: MsgraphField<bool>,
92    /// The location.
93    #[serde(default, skip_serializing_if = "MsgraphField::is_unset")]
94    pub location: MsgraphField<MsgraphLocation>,
95    /// The recurrence of a series master.
96    #[serde(default, skip_serializing_if = "MsgraphField::is_unset")]
97    pub recurrence: MsgraphField<MsgraphPatternedRecurrence>,
98    /// The attendees.
99    #[serde(default, skip_serializing_if = "MsgraphField::is_unset")]
100    pub attendees: MsgraphField<Vec<MsgraphAttendee>>,
101    /// The organizer, read-only once the event exists.
102    #[serde(default, skip_serializing_if = "MsgraphField::is_unset")]
103    pub organizer: MsgraphField<MsgraphRecipient>,
104    /// The categories.
105    #[serde(default, skip_serializing_if = "MsgraphField::is_unset")]
106    pub categories: MsgraphField<Vec<String>>,
107    /// How the event shows in the user's free/busy time.
108    #[serde(default, skip_serializing_if = "MsgraphField::is_unset")]
109    pub show_as: MsgraphField<MsgraphFreeBusyStatus>,
110    /// The sensitivity.
111    #[serde(default, skip_serializing_if = "MsgraphField::is_unset")]
112    pub sensitivity: MsgraphField<MsgraphSensitivity>,
113    /// The importance.
114    #[serde(default, skip_serializing_if = "MsgraphField::is_unset")]
115    pub importance: MsgraphField<MsgraphImportance>,
116    /// Whether a reminder is set.
117    #[serde(default, skip_serializing_if = "MsgraphField::is_unset")]
118    pub is_reminder_on: MsgraphField<bool>,
119    /// How long before the start the reminder fires, in minutes.
120    #[serde(default, skip_serializing_if = "MsgraphField::is_unset")]
121    pub reminder_minutes_before_start: MsgraphField<u32>,
122    /// Whether the event was cancelled, read-only.
123    #[serde(default, skip_serializing_if = "Option::is_none")]
124    pub is_cancelled: Option<bool>,
125    /// Whether the user organizes the event, read-only.
126    #[serde(default, skip_serializing_if = "Option::is_none")]
127    pub is_organizer: Option<bool>,
128    /// The user's own response, read-only.
129    #[serde(default, skip_serializing_if = "Option::is_none")]
130    pub response_status: Option<MsgraphResponseStatus>,
131    /// The Outlook web link, read-only.
132    #[serde(default, skip_serializing_if = "Option::is_none")]
133    pub web_link: Option<String>,
134    /// The details to join an online meeting (Teams), read-only.
135    #[serde(default, skip_serializing_if = "Option::is_none")]
136    pub online_meeting: Option<MsgraphOnlineMeetingInfo>,
137    /// The occurrence ids (`OID.{seriesMasterId}.{date}`) of a series'
138    /// cancelled occurrences, on a series master, read-only.
139    #[serde(default, skip_serializing_if = "Vec::is_empty")]
140    pub cancelled_occurrences: Vec<String>,
141    /// Single-value extended properties, returned only when expanded.
142    #[serde(default, skip_serializing_if = "MsgraphField::is_unset")]
143    pub single_value_extended_properties: MsgraphField<Vec<MsgraphSingleValueExtendedProperty>>,
144}
145
146/// A wall time in a named zone, Graph's time representation.
147///
148/// The zone is a Windows name (`Romance Standard Time`) or an IANA one,
149/// depending on how the event was created, and `UTC` for a UTC time.
150#[derive(Debug, Clone, Default, Deserialize, Serialize, Eq, PartialEq)]
151#[serde(rename_all = "camelCase")]
152pub struct MsgraphDateTimeTimeZone {
153    /// The wall time, `YYYY-MM-DDTHH:MM:SS` with optional fractional
154    /// seconds.
155    pub date_time: String,
156    /// The zone the wall time is read in.
157    #[serde(default, skip_serializing_if = "Option::is_none")]
158    pub time_zone: Option<String>,
159}
160
161/// The details to join an online meeting, read-only.
162#[derive(Debug, Clone, Default, Deserialize, Serialize, Eq, PartialEq)]
163#[serde(rename_all = "camelCase")]
164pub struct MsgraphOnlineMeetingInfo {
165    /// The link to join the meeting.
166    #[serde(default, skip_serializing_if = "Option::is_none")]
167    pub join_url: Option<String>,
168}
169
170/// An event location.
171#[derive(Debug, Clone, Default, Deserialize, Serialize, Eq, PartialEq)]
172#[serde(rename_all = "camelCase")]
173pub struct MsgraphLocation {
174    /// The name shown for the location.
175    #[serde(default, skip_serializing_if = "Option::is_none")]
176    pub display_name: Option<String>,
177    /// A URI for the location.
178    #[serde(default, skip_serializing_if = "Option::is_none")]
179    pub location_uri: Option<String>,
180    /// The street address.
181    #[serde(default, skip_serializing_if = "Option::is_none")]
182    pub address: Option<MsgraphPhysicalAddress>,
183}
184
185/// The recurrence of a series: a pattern and the range it repeats over.
186#[derive(Debug, Clone, Default, Deserialize, Serialize, Eq, PartialEq)]
187#[serde(rename_all = "camelCase")]
188pub struct MsgraphPatternedRecurrence {
189    /// How often the event repeats.
190    pub pattern: MsgraphRecurrencePattern,
191    /// When the repetition starts and stops.
192    pub range: MsgraphRecurrenceRange,
193}
194
195/// How often a series repeats.
196#[derive(Debug, Clone, Default, Deserialize, Serialize, Eq, PartialEq)]
197#[serde(rename_all = "camelCase")]
198pub struct MsgraphRecurrencePattern {
199    /// The kind of pattern.
200    #[serde(default, rename = "type", skip_serializing_if = "Option::is_none")]
201    pub pattern_type: Option<MsgraphRecurrencePatternType>,
202    /// The number of units between occurrences.
203    #[serde(default, skip_serializing_if = "Option::is_none")]
204    pub interval: Option<u32>,
205    /// The month of a yearly pattern, 1 to 12.
206    #[serde(default, skip_serializing_if = "Option::is_none")]
207    pub month: Option<u32>,
208    /// The day of an absolute monthly or yearly pattern.
209    #[serde(default, skip_serializing_if = "Option::is_none")]
210    pub day_of_month: Option<u32>,
211    /// The weekdays of a weekly or relative pattern.
212    #[serde(default, skip_serializing_if = "Vec::is_empty")]
213    pub days_of_week: Vec<MsgraphDayOfWeek>,
214    /// The first day of the week of a weekly pattern.
215    #[serde(default, skip_serializing_if = "Option::is_none")]
216    pub first_day_of_week: Option<MsgraphDayOfWeek>,
217    /// Which week of the month a relative pattern names.
218    #[serde(default, skip_serializing_if = "Option::is_none")]
219    pub index: Option<MsgraphWeekIndex>,
220}
221
222/// When a series starts and stops repeating.
223#[derive(Debug, Clone, Default, Deserialize, Serialize, Eq, PartialEq)]
224#[serde(rename_all = "camelCase")]
225pub struct MsgraphRecurrenceRange {
226    /// How the range ends.
227    #[serde(default, rename = "type", skip_serializing_if = "Option::is_none")]
228    pub range_type: Option<MsgraphRecurrenceRangeType>,
229    /// The first date of the series, `YYYY-MM-DD`.
230    #[serde(default, skip_serializing_if = "Option::is_none")]
231    pub start_date: Option<String>,
232    /// The last date of an `endDate` range, `YYYY-MM-DD`.
233    #[serde(default, skip_serializing_if = "Option::is_none")]
234    pub end_date: Option<String>,
235    /// The zone the dates are read in.
236    #[serde(default, skip_serializing_if = "Option::is_none")]
237    pub recurrence_time_zone: Option<String>,
238    /// The number of occurrences of a `numbered` range.
239    #[serde(default, skip_serializing_if = "Option::is_none")]
240    pub number_of_occurrences: Option<u32>,
241}
242
243/// An event attendee.
244#[derive(Debug, Clone, Default, Deserialize, Serialize, Eq, PartialEq)]
245#[serde(rename_all = "camelCase")]
246pub struct MsgraphAttendee {
247    /// Whether the attendee is required, optional or a resource.
248    #[serde(default, rename = "type", skip_serializing_if = "Option::is_none")]
249    pub attendee_type: Option<MsgraphAttendeeType>,
250    /// The attendee's response.
251    #[serde(default, skip_serializing_if = "Option::is_none")]
252    pub status: Option<MsgraphResponseStatus>,
253    /// The attendee's name and address.
254    #[serde(default, skip_serializing_if = "Option::is_none")]
255    pub email_address: Option<MsgraphEmailAddress>,
256}
257
258/// A response to an invitation.
259#[derive(Debug, Clone, Default, Deserialize, Serialize, Eq, PartialEq)]
260#[serde(rename_all = "camelCase")]
261pub struct MsgraphResponseStatus {
262    /// The response.
263    #[serde(default, skip_serializing_if = "Option::is_none")]
264    pub response: Option<MsgraphResponseType>,
265    /// When it was given.
266    #[serde(default, skip_serializing_if = "Option::is_none")]
267    pub time: Option<String>,
268}
269
270/// The kind of an event within a series.
271#[derive(Debug, Clone, Copy, Deserialize, Serialize, Eq, PartialEq)]
272#[serde(rename_all = "camelCase")]
273pub enum MsgraphEventType {
274    /// A lone event.
275    SingleInstance,
276    /// An occurrence of a series, computed from its recurrence.
277    Occurrence,
278    /// An occurrence edited on its own.
279    Exception,
280    /// The event carrying a series' recurrence.
281    SeriesMaster,
282}
283
284/// How an event shows in free/busy time.
285#[derive(Debug, Clone, Copy, Deserialize, Serialize, Eq, PartialEq)]
286#[serde(rename_all = "camelCase")]
287pub enum MsgraphFreeBusyStatus {
288    /// Unknown status.
289    Unknown,
290    /// Free.
291    Free,
292    /// Tentative.
293    Tentative,
294    /// Busy.
295    Busy,
296    /// Out of office.
297    Oof,
298    /// Working elsewhere.
299    WorkingElsewhere,
300}
301
302/// How private an event is.
303#[derive(Debug, Clone, Copy, Deserialize, Serialize, Eq, PartialEq)]
304#[serde(rename_all = "camelCase")]
305pub enum MsgraphSensitivity {
306    /// Normal.
307    Normal,
308    /// Personal.
309    Personal,
310    /// Private.
311    Private,
312    /// Confidential.
313    Confidential,
314}
315
316/// A response to an invitation.
317#[derive(Debug, Clone, Copy, Deserialize, Serialize, Eq, PartialEq)]
318#[serde(rename_all = "camelCase")]
319pub enum MsgraphResponseType {
320    /// No response.
321    None,
322    /// The organizer, who does not respond.
323    Organizer,
324    /// Tentatively accepted.
325    TentativelyAccepted,
326    /// Accepted.
327    Accepted,
328    /// Declined.
329    Declined,
330    /// Not responded yet.
331    NotResponded,
332}
333
334/// The role of an attendee.
335#[derive(Debug, Clone, Copy, Deserialize, Serialize, Eq, PartialEq)]
336#[serde(rename_all = "camelCase")]
337pub enum MsgraphAttendeeType {
338    /// A required attendee.
339    Required,
340    /// An optional attendee.
341    Optional,
342    /// A resource, a room or equipment.
343    Resource,
344}
345
346/// The kind of a recurrence pattern.
347#[derive(Debug, Clone, Copy, Deserialize, Serialize, Eq, PartialEq)]
348#[serde(rename_all = "camelCase")]
349pub enum MsgraphRecurrencePatternType {
350    /// Every `interval` days.
351    Daily,
352    /// On `daysOfWeek`, every `interval` weeks.
353    Weekly,
354    /// On `dayOfMonth`, every `interval` months.
355    AbsoluteMonthly,
356    /// On the `index` weekday of `daysOfWeek`, every `interval` months.
357    RelativeMonthly,
358    /// On `dayOfMonth` of `month`, every `interval` years.
359    AbsoluteYearly,
360    /// On the `index` weekday of `daysOfWeek` in `month`, every
361    /// `interval` years.
362    RelativeYearly,
363}
364
365/// How a recurrence range ends.
366#[derive(Debug, Clone, Copy, Deserialize, Serialize, Eq, PartialEq)]
367#[serde(rename_all = "camelCase")]
368pub enum MsgraphRecurrenceRangeType {
369    /// On `endDate`.
370    EndDate,
371    /// Never.
372    NoEnd,
373    /// After `numberOfOccurrences`.
374    Numbered,
375}
376
377/// A day of the week.
378#[derive(Debug, Clone, Copy, Deserialize, Serialize, Eq, PartialEq)]
379#[serde(rename_all = "camelCase")]
380pub enum MsgraphDayOfWeek {
381    /// Sunday.
382    Sunday,
383    /// Monday.
384    Monday,
385    /// Tuesday.
386    Tuesday,
387    /// Wednesday.
388    Wednesday,
389    /// Thursday.
390    Thursday,
391    /// Friday.
392    Friday,
393    /// Saturday.
394    Saturday,
395}
396
397/// Which week of the month a relative pattern names.
398#[derive(Debug, Clone, Copy, Deserialize, Serialize, Eq, PartialEq)]
399#[serde(rename_all = "camelCase")]
400pub enum MsgraphWeekIndex {
401    /// The first.
402    First,
403    /// The second.
404    Second,
405    /// The third.
406    Third,
407    /// The fourth.
408    Fourth,
409    /// The last.
410    Last,
411}
io_msgraph/v1/rest/users/events.rs

io_msgraph/v1/rest/users/
events.rs
