@remit/api-openapi-types 0.0.70 → 0.0.71

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@remit/api-openapi-types",
-  "version": "0.0.70",
+  "version": "0.0.71",
   "type": "module",
   "main": "types.d.ts",
   "types": "types.d.ts",

package/types.d.ts

@@ -150,9 +150,9 @@ current enum emitter anyway, so the wire contract uses the bare form.
      */
     export type CalendarComponentSet = "VeventOnly";
     /**
-     * Where a calendar collection came from. `Default` is the one provisioned per account config on first use and is never deleted; `UserCreated` is one a person made; `MailDerived` is one populated from mail rather than by a person.
+     * Where a calendar collection came from. `Default` is the one provisioned per account config on first use and is never deleted; `UserCreated` is one a person made; `MailDerived` is one populated from mail rather than by a person; `Subscribed` is filled from a read-only iCalendar URL and refuses every write except its own refresh.
      */
-    export type CalendarSource = "Default" | "UserCreated" | "MailDerived";
+    export type CalendarSource = "Default" | "UserCreated" | "MailDerived" | "Subscribed";
     /**
      * Projection of a VEVENT's STATUS property (RFC 5545 3.8.1.11). A VEVENT with no STATUS projects as `Confirmed`, which is the value RFC 5545 gives an event whose status is unstated.
      */
@@ -2583,6 +2583,26 @@ and what `CalendarObject.bySyncSequence` pages by.
        * Monotonic change counter for this collection. Bumped by every write to one of its objects; the value stamped on `CalendarObject.syncSequence` is the value this counter held after that write.
        */
       syncSequence: number;
+      /**
+       * The read-only iCalendar URL a `Subscribed` collection is filled from, such as a Google Calendar secret address. For some providers the URL is the whole credential, so it never reaches a log line. `""` for every other source.
+       */
+      subscriptionUrl: String2048;
+      /**
+       * Whether the scheduled refresh re-reads `subscriptionUrl`. Turning it off stops the refresh and keeps every stored event. Always `false` on a collection that is not `Subscribed`.
+       */
+      subscriptionEnabled: boolean;
+      /**
+       * When the subscription was last fetched, whatever the outcome. `0` when it never was.
+       */
+      subscriptionCheckedAt: number;
+      /**
+       * When the subscription was last fetched and written. `0` when it never was.
+       */
+      subscriptionFetchedAt: number;
+      /**
+       * Why the last fetch failed, or which events in it could not be stored. `""` when the last fetch landed whole.
+       */
+      subscriptionError: String512;
       createdAt: number;
       updatedAt: number;
     }
@@ -2626,6 +2646,26 @@ and what `CalendarObject.bySyncSequence` pages by.
        * Monotonic change counter for this collection. Bumped by every write to one of its objects; the value stamped on `CalendarObject.syncSequence` is the value this counter held after that write.
        */
       syncSequence: number;
+      /**
+       * The read-only iCalendar URL a `Subscribed` collection is filled from, such as a Google Calendar secret address. For some providers the URL is the whole credential, so it never reaches a log line. `""` for every other source.
+       */
+      subscriptionUrl: String2048;
+      /**
+       * Whether the scheduled refresh re-reads `subscriptionUrl`. Turning it off stops the refresh and keeps every stored event. Always `false` on a collection that is not `Subscribed`.
+       */
+      subscriptionEnabled: boolean;
+      /**
+       * When the subscription was last fetched, whatever the outcome. `0` when it never was.
+       */
+      subscriptionCheckedAt: number;
+      /**
+       * When the subscription was last fetched and written. `0` when it never was.
+       */
+      subscriptionFetchedAt: number;
+      /**
+       * Why the last fetch failed, or which events in it could not be stored. `""` when the last fetch landed whole.
+       */
+      subscriptionError: String512;
       createdAt: number;
       updatedAt: number;
     }
@@ -2656,9 +2696,13 @@ mutable overlay; this is the address.
        * IANA time zone this collection's floating times are read in. Absent reads them as UTC.
        */
       timezone?: String64;
+      /**
+       * A read-only iCalendar URL to subscribe the collection to. `http`, `https` and `webcal` are accepted. The server fetches it once before creating anything and refuses with 400 when the fetch fails, so a mistyped address leaves no empty calendar behind. The collection is then `Subscribed`: it refuses event writes, and the scheduled refresh keeps it in step with the feed.
+       */
+      subscriptionUrl?: String2048;
     }
     /**
-     * Input for updating a calendar collection. The name, colour and timezone are the mutable overlay; `urlSegment` is not among them, because it is the collection's identity and the path a client has bookmarked.
+     * Input for updating a calendar collection. The name, colour and timezone are the mutable overlay, and `subscriptionEnabled` turns a subscribed collection's refresh off and on. `urlSegment` is not among them, because it is the collection's identity and the path a client has bookmarked.
      */
     export interface UpdateCalendarInput {
       /**
@@ -2673,6 +2717,10 @@ mutable overlay; this is the address.
        * IANA time zone this collection's floating times are read in, e.g. "Europe/Amsterdam". `""` when none is set, which reads as UTC.
        */
       timezone: String64;
+      /**
+       * Whether the scheduled refresh re-reads `subscriptionUrl`. Turning it off stops the refresh and keeps every stored event. Always `false` on a collection that is not `Subscribed`.
+       */
+      subscriptionEnabled: boolean;
     }
     /**
      * Nothing to return. The resource, or the occurrence, is gone.
@@ -7522,7 +7570,7 @@ export interface OperationMethods {
     config?: AxiosRequestConfig
   ): OperationResponse<Paths.ListCalendars.Responses.$200>;
   /**
-   * createCalendar - Create a calendar collection. Refused with 400 when `urlSegment` is empty or already taken in this account config — the segment is the collection's identity, so a second create under the same one would otherwise silently return the collection that already exists.
+   * createCalendar - Create a calendar collection. Refused with 400 when `urlSegment` is empty or already taken in this account config — the segment is the collection's identity, so a second create under the same one would otherwise silently return the collection that already exists. With `subscriptionUrl` the feed is fetched first and a fetch that fails is refused with 400 `subscription_unreachable`, naming why and never the URL.
    */
   'createCalendar'(
     parameters?: Parameters<UnknownParamsObject> | null,
@@ -7538,7 +7586,7 @@ export interface OperationMethods {
     config?: AxiosRequestConfig
   ): OperationResponse<Paths.GetCalendar.Responses.$200>;
   /**
-   * updateCalendar
+   * updateCalendar - Update a calendar collection. `subscriptionEnabled` is refused with 400 `not_subscribed` on a collection that is not `Subscribed`. Turning it off stops the refresh and removes nothing.
    */
   'updateCalendar'(
     parameters?: Parameters<Paths.UpdateCalendar.PathParameters> | null,
@@ -7622,7 +7670,7 @@ Refused with 400 when `from` and `to` are not ISO 8601 date-times, when
     config?: AxiosRequestConfig
   ): OperationResponse<Paths.ListCalendarEvents.Responses.$200>;
   /**
-   * createCalendarEvent - Create an event. The server builds the VEVENT and writes it through the single calendar write path — the same one an accepted invitation and a later CalDAV PUT go through — so the object, its expanded occurrences and the collection's sync sequence land together or not at all.
+   * createCalendarEvent - Create an event. The server builds the VEVENT and writes it through the single calendar write path — the same one an accepted invitation and a later CalDAV PUT go through — so the object, its expanded occurrences and the collection's sync sequence land together or not at all. Refused with 400 `read_only_calendar` for a `Subscribed` collection, whose events belong to the feed.
    */
   'createCalendarEvent'(
     parameters?: Parameters<UnknownParamsObject> | null,
@@ -7664,6 +7712,8 @@ rest of the series; `Following` truncates the series to end just before
 it.
 
 Same refusals and the same `If-Match` precondition as the update.
+An event in a `Subscribed` collection is refused with 400
+`read_only_calendar`, here and on the update.
    */
   'deleteCalendarEvent'(
     parameters?: Parameters<Paths.DeleteCalendarEvent.PathParameters & Paths.DeleteCalendarEvent.QueryParameters & Paths.DeleteCalendarEvent.HeaderParameters> | null,
@@ -8326,7 +8376,7 @@ export interface PathsDictionary {
       config?: AxiosRequestConfig
     ): OperationResponse<Paths.ListCalendars.Responses.$200>;
     /**
-     * createCalendar - Create a calendar collection. Refused with 400 when `urlSegment` is empty or already taken in this account config — the segment is the collection's identity, so a second create under the same one would otherwise silently return the collection that already exists.
+     * createCalendar - Create a calendar collection. Refused with 400 when `urlSegment` is empty or already taken in this account config — the segment is the collection's identity, so a second create under the same one would otherwise silently return the collection that already exists. With `subscriptionUrl` the feed is fetched first and a fetch that fails is refused with 400 `subscription_unreachable`, naming why and never the URL.
      */
     'post'(
       parameters?: Parameters<UnknownParamsObject> | null,
@@ -8344,7 +8394,7 @@ export interface PathsDictionary {
       config?: AxiosRequestConfig
     ): OperationResponse<Paths.GetCalendar.Responses.$200>;
     /**
-     * updateCalendar
+     * updateCalendar - Update a calendar collection. `subscriptionEnabled` is refused with 400 `not_subscribed` on a collection that is not `Subscribed`. Turning it off stops the refresh and removes nothing.
      */
     'patch'(
       parameters?: Parameters<Paths.UpdateCalendar.PathParameters> | null,
@@ -8434,7 +8484,7 @@ Refused with 400 when `from` and `to` are not ISO 8601 date-times, when
       config?: AxiosRequestConfig
     ): OperationResponse<Paths.ListCalendarEvents.Responses.$200>;
     /**
-     * createCalendarEvent - Create an event. The server builds the VEVENT and writes it through the single calendar write path — the same one an accepted invitation and a later CalDAV PUT go through — so the object, its expanded occurrences and the collection's sync sequence land together or not at all.
+     * createCalendarEvent - Create an event. The server builds the VEVENT and writes it through the single calendar write path — the same one an accepted invitation and a later CalDAV PUT go through — so the object, its expanded occurrences and the collection's sync sequence land together or not at all. Refused with 400 `read_only_calendar` for a `Subscribed` collection, whose events belong to the feed.
      */
     'post'(
       parameters?: Parameters<UnknownParamsObject> | null,
@@ -8478,6 +8528,8 @@ rest of the series; `Following` truncates the series to end just before
 it.
 
 Same refusals and the same `If-Match` precondition as the update.
+An event in a `Subscribed` collection is refused with 400
+`read_only_calendar`, here and on the update.
      */
     'delete'(
       parameters?: Parameters<Paths.DeleteCalendarEvent.PathParameters & Paths.DeleteCalendarEvent.QueryParameters> | null,