@remit/api-openapi-types 0.0.75 → 0.0.77

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/package.json +1 -1
  2. package/types.d.ts +80 -0
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@remit/api-openapi-types",
3
- "version": "0.0.75",
3
+ "version": "0.0.77",
4
4
  "type": "module",
5
5
  "main": "types.d.ts",
6
6
  "types": "types.d.ts",
package/types.d.ts CHANGED
@@ -304,6 +304,10 @@ distinguishable from a network failure without parsing prose.
304
304
  * Where in a message a suggestion was read from. It is what a card says to explain itself, and it is what separates a suggestion carrying real iCalendar from one inferred out of prose.
305
305
  */
306
306
  export type CalendarSuggestionSource = "IcalendarPart" | "IcalendarAttachment" | "TextHeuristic";
307
+ /**
308
+ * Whether an answered cancellation holds the calendar object this suggestion's answer wrote. A cancellation is terminal, so such an answer cannot be taken back.
309
+ */
310
+ export type CalendarAnswerOvertaken = "None" | "Cancellation";
307
311
  /**
308
312
  * The answer an invitation is added to a calendar with. It is written as the user's `ATTENDEE;PARTSTAT` on the stored event (RFC 5545 3.2.12) and becomes the suggestion's state.
309
313
  */
@@ -5492,6 +5496,10 @@ and no message may make that change without them.
5492
5496
  * The `CalendarObject` that accepting this suggestion wrote. `""` until it is accepted or answered tentatively — the named absent state, never a missing attribute — and the resource's id afterwards, so the card can link to the event it produced.
5493
5497
  */
5494
5498
  acceptedCalendarObjectId: string;
5499
+ /**
5500
+ * The message whose revision retired this one. `""` until it is `Superseded` — the named absent state, never a missing attribute — and the newer message's id afterwards, so the card can open the revision to answer.
5501
+ */
5502
+ supersededByMessageId: string;
5495
5503
  createdAt: number;
5496
5504
  updatedAt: number;
5497
5505
  }
@@ -5567,8 +5575,20 @@ and no message may make that change without them.
5567
5575
  * The `CalendarObject` that accepting this suggestion wrote. `""` until it is accepted or answered tentatively — the named absent state, never a missing attribute — and the resource's id afterwards, so the card can link to the event it produced.
5568
5576
  */
5569
5577
  acceptedCalendarObjectId: string;
5578
+ /**
5579
+ * The message whose revision retired this one. `""` until it is `Superseded` — the named absent state, never a missing attribute — and the newer message's id afterwards, so the card can open the revision to answer.
5580
+ */
5581
+ supersededByMessageId: string;
5570
5582
  createdAt: number;
5571
5583
  updatedAt: number;
5584
+ /**
5585
+ * The conversation holding `supersededByMessageId`, which is what the reading pane opens. `""` when this revision was not superseded, or when that message sits in no conversation any more.
5586
+ */
5587
+ supersededByThreadId: string;
5588
+ /**
5589
+ * Whether an answered cancellation holds the event this answer wrote. `Cancellation` means `reopen` answers 400.
5590
+ */
5591
+ answerOvertakenBy: CalendarAnswerOvertaken;
5572
5592
  }
5573
5593
  /**
5574
5594
  * Body of `POST /calendar-suggestions/{suggestionId}/accept`. Names the collection the event is written into; there is no default, because filing someone else's invitation into a calendar the user did not pick is a decision the server does not get to make.
@@ -7372,6 +7392,17 @@ declare namespace Paths {
7372
7392
  export type $401 = void;
7373
7393
  }
7374
7394
  }
7395
+ namespace ReopenCalendarSuggestion {
7396
+ export interface PathParameters {
7397
+ suggestionId: Components.Schemas.UUID;
7398
+ }
7399
+ namespace Responses {
7400
+ export type $200 = void;
7401
+ export type $400 = void;
7402
+ export type $404 = void;
7403
+ export type $401 = void;
7404
+ }
7405
+ }
7375
7406
  }
7376
7407
 
7377
7408
  export interface OperationMethods {
@@ -8143,6 +8174,29 @@ is answered `Tentative`, or when its iCalendar will not parse.
8143
8174
  data?: Paths.DismissCalendarSuggestion.RequestBody,
8144
8175
  config?: AxiosRequestConfig
8145
8176
  ): OperationResponse<Paths.DismissCalendarSuggestion.Responses.$200>;
8177
+ /**
8178
+ * reopenCalendarSuggestion - Take an answer back. An accepted, tentative, declined or dismissed
8179
+ suggestion returns to `Pending`, so the card asks again. One
8180
+ transaction: the suggestion is settled `Pending` with
8181
+ `acceptedCalendarObjectId: ""`, and the calendar object an accept or a
8182
+ maybe wrote is removed with its occurrences and every remainder a
8183
+ this-and-following edit split off it in that calendar, unless another
8184
+ suggestion is still answered into that object; then the object stays with
8185
+ that answer. A sender rule written by
8186
+ `dismiss{muteSender}` stays; it is a rule of its own, edited where rules
8187
+ are.
8188
+
8189
+ No mail is sent. Idempotent: a `Pending` suggestion is returned as it is.
8190
+
8191
+ 400 when the suggestion is `Superseded`, which a later revision retired,
8192
+ a `Cancel`, whose answer rewrote an event it cannot restore, or its
8193
+ `answerOvertakenBy` is `Cancellation`, because a cancellation is terminal.
8194
+ */
8195
+ 'reopenCalendarSuggestion'(
8196
+ parameters?: Parameters<Paths.ReopenCalendarSuggestion.PathParameters> | null,
8197
+ data?: any,
8198
+ config?: AxiosRequestConfig
8199
+ ): OperationResponse<Paths.ReopenCalendarSuggestion.Responses.$200>;
8146
8200
  }
8147
8201
 
8148
8202
  export interface PathsDictionary {
@@ -9036,6 +9090,31 @@ is answered `Tentative`, or when its iCalendar will not parse.
9036
9090
  config?: AxiosRequestConfig
9037
9091
  ): OperationResponse<Paths.DismissCalendarSuggestion.Responses.$200>;
9038
9092
  };
9093
+ ['/calendar-suggestions/{suggestionId}/reopen']: {
9094
+ /**
9095
+ * reopenCalendarSuggestion - Take an answer back. An accepted, tentative, declined or dismissed
9096
+ suggestion returns to `Pending`, so the card asks again. One
9097
+ transaction: the suggestion is settled `Pending` with
9098
+ `acceptedCalendarObjectId: ""`, and the calendar object an accept or a
9099
+ maybe wrote is removed with its occurrences and every remainder a
9100
+ this-and-following edit split off it in that calendar, unless another
9101
+ suggestion is still answered into that object; then the object stays with
9102
+ that answer. A sender rule written by
9103
+ `dismiss{muteSender}` stays; it is a rule of its own, edited where rules
9104
+ are.
9105
+
9106
+ No mail is sent. Idempotent: a `Pending` suggestion is returned as it is.
9107
+
9108
+ 400 when the suggestion is `Superseded`, which a later revision retired,
9109
+ a `Cancel`, whose answer rewrote an event it cannot restore, or its
9110
+ `answerOvertakenBy` is `Cancellation`, because a cancellation is terminal.
9111
+ */
9112
+ 'post'(
9113
+ parameters?: Parameters<Paths.ReopenCalendarSuggestion.PathParameters> | null,
9114
+ data?: any,
9115
+ config?: AxiosRequestConfig
9116
+ ): OperationResponse<Paths.ReopenCalendarSuggestion.Responses.$200>;
9117
+ };
9039
9118
  }
9040
9119
 
9041
9120
  export type Client = OpenAPIClient<OperationMethods, PathsDictionary>;
@@ -9288,6 +9367,7 @@ export type LabelAction = Components.Schemas.LabelAction;
9288
9367
  export type CalendarSuggestionState = Components.Schemas.CalendarSuggestionState;
9289
9368
  export type CalendarInviteMethod = Components.Schemas.CalendarInviteMethod;
9290
9369
  export type CalendarSuggestionSource = Components.Schemas.CalendarSuggestionSource;
9370
+ export type CalendarAnswerOvertaken = Components.Schemas.CalendarAnswerOvertaken;
9291
9371
  export type CalendarInviteAnswer = Components.Schemas.CalendarInviteAnswer;
9292
9372
  export type MessageSystemFlag = Components.Schemas.MessageSystemFlag;
9293
9373
  export type MessageKeywordFlag = Components.Schemas.MessageKeywordFlag;