@remit/api-http-client 0.0.67 → 0.0.68

package/@tanstack/react-query.gen.ts

@@ -553,7 +553,7 @@ export const calendarEventOperationsListCalendarEventsOptions = (options: Option
 });
 
 /**
- * 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.
+ * 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.
  */
 export const calendarEventOperationsCreateCalendarEventMutation = (options?: Partial<Options<CalendarEventOperationsCreateCalendarEventData>>): UseMutationOptions<CalendarEventOperationsCreateCalendarEventResponse, CalendarEventOperationsCreateCalendarEventError, Options<CalendarEventOperationsCreateCalendarEventData>> => {
     const mutationOptions: UseMutationOptions<CalendarEventOperationsCreateCalendarEventResponse, CalendarEventOperationsCreateCalendarEventError, Options<CalendarEventOperationsCreateCalendarEventData>> = {
@@ -576,6 +576,8 @@ export const calendarEventOperationsCreateCalendarEventMutation = (options?: Par
  * 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.
  */
 export const calendarEventDetailOperationsDeleteCalendarEventMutation = (options?: Partial<Options<CalendarEventDetailOperationsDeleteCalendarEventData>>): UseMutationOptions<CalendarEventDetailOperationsDeleteCalendarEventResponse, CalendarEventDetailOperationsDeleteCalendarEventError, Options<CalendarEventDetailOperationsDeleteCalendarEventData>> => {
     const mutationOptions: UseMutationOptions<CalendarEventDetailOperationsDeleteCalendarEventResponse, CalendarEventDetailOperationsDeleteCalendarEventError, Options<CalendarEventDetailOperationsDeleteCalendarEventData>> = {
@@ -759,7 +761,7 @@ export const calendarOperationsListCalendarsOptions = (options?: Options<Calenda
 });
 
 /**
- * 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.
+ * 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.
  */
 export const calendarOperationsCreateCalendarMutation = (options?: Partial<Options<CalendarOperationsCreateCalendarData>>): UseMutationOptions<CalendarOperationsCreateCalendarResponse, CalendarOperationsCreateCalendarError, Options<CalendarOperationsCreateCalendarData>> => {
     const mutationOptions: UseMutationOptions<CalendarOperationsCreateCalendarResponse, CalendarOperationsCreateCalendarError, Options<CalendarOperationsCreateCalendarData>> = {
@@ -807,6 +809,9 @@ export const calendarDetailOperationsGetCalendarOptions = (options: Options<Cale
     queryKey: calendarDetailOperationsGetCalendarQueryKey(options)
 });
 
+/**
+ * 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.
+ */
 export const calendarDetailOperationsUpdateCalendarMutation = (options?: Partial<Options<CalendarDetailOperationsUpdateCalendarData>>): UseMutationOptions<CalendarDetailOperationsUpdateCalendarResponse, CalendarDetailOperationsUpdateCalendarError, Options<CalendarDetailOperationsUpdateCalendarData>> => {
     const mutationOptions: UseMutationOptions<CalendarDetailOperationsUpdateCalendarResponse, CalendarDetailOperationsUpdateCalendarError, Options<CalendarDetailOperationsUpdateCalendarData>> = {
         mutationFn: async (fnOptions) => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@remit/api-http-client",
-  "version": "0.0.67",
+  "version": "0.0.68",
   "type": "module",
   "exports": {
     ".": "./index.ts",

package/sdk.gen.ts

@@ -325,7 +325,7 @@ export const calendarEventOperationsListCalendarEvents = <ThrowOnError extends b
 });
 
 /**
- * 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.
+ * 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.
  */
 export const calendarEventOperationsCreateCalendarEvent = <ThrowOnError extends boolean = false>(options: Options<CalendarEventOperationsCreateCalendarEventData, ThrowOnError>): RequestResult<CalendarEventOperationsCreateCalendarEventResponses, CalendarEventOperationsCreateCalendarEventErrors, ThrowOnError> => (options.client ?? client).post<CalendarEventOperationsCreateCalendarEventResponses, CalendarEventOperationsCreateCalendarEventErrors, ThrowOnError>({
     security: [{ name: 'Authorization', type: 'apiKey' }],
@@ -344,6 +344,8 @@ export const calendarEventOperationsCreateCalendarEvent = <ThrowOnError extends
  * 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.
  */
 export const calendarEventDetailOperationsDeleteCalendarEvent = <ThrowOnError extends boolean = false>(options: Options<CalendarEventDetailOperationsDeleteCalendarEventData, ThrowOnError>): RequestResult<CalendarEventDetailOperationsDeleteCalendarEventResponses, CalendarEventDetailOperationsDeleteCalendarEventErrors, ThrowOnError> => (options.client ?? client).delete<CalendarEventDetailOperationsDeleteCalendarEventResponses, CalendarEventDetailOperationsDeleteCalendarEventErrors, ThrowOnError>({
     security: [{ name: 'Authorization', type: 'apiKey' }],
@@ -463,7 +465,7 @@ export const calendarOperationsListCalendars = <ThrowOnError extends boolean = f
 });
 
 /**
- * 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.
+ * 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.
  */
 export const calendarOperationsCreateCalendar = <ThrowOnError extends boolean = false>(options: Options<CalendarOperationsCreateCalendarData, ThrowOnError>): RequestResult<CalendarOperationsCreateCalendarResponses, CalendarOperationsCreateCalendarErrors, ThrowOnError> => (options.client ?? client).post<CalendarOperationsCreateCalendarResponses, CalendarOperationsCreateCalendarErrors, ThrowOnError>({
     security: [{ name: 'Authorization', type: 'apiKey' }],
@@ -490,6 +492,9 @@ export const calendarDetailOperationsGetCalendar = <ThrowOnError extends boolean
     ...options
 });
 
+/**
+ * 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.
+ */
 export const calendarDetailOperationsUpdateCalendar = <ThrowOnError extends boolean = false>(options: Options<CalendarDetailOperationsUpdateCalendarData, ThrowOnError>): RequestResult<CalendarDetailOperationsUpdateCalendarResponses, CalendarDetailOperationsUpdateCalendarErrors, ThrowOnError> => (options.client ?? client).patch<CalendarDetailOperationsUpdateCalendarResponses, CalendarDetailOperationsUpdateCalendarErrors, ThrowOnError>({
     security: [{ name: 'Authorization', type: 'apiKey' }],
     url: '/calendars/{calendarId}',

package/types.gen.ts

@@ -885,14 +885,34 @@ export type RemitImapCalendarResponse = {
      * 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.
      */
     readonly 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.
+     */
+    readonly subscriptionCheckedAt: number;
+    /**
+     * When the subscription was last fetched and written. `0` when it never was.
+     */
+    readonly subscriptionFetchedAt: number;
+    /**
+     * Why the last fetch failed, or which events in it could not be stored. `""` when the last fetch landed whole.
+     */
+    subscriptionError: String512;
     readonly createdAt: number;
     readonly updatedAt: number;
 };
 
 /**
- * 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 RemitImapCalendarSource = 'Default' | 'UserCreated' | 'MailDerived';
+export type RemitImapCalendarSource = 'Default' | 'UserCreated' | 'MailDerived' | 'Subscribed';
 
 /**
  * A suggestion as the API returns it. The raw `icalData` is not surfaced: a client renders the projected fields, and the bytes exist so that accepting can write them into a calendar unchanged.
@@ -1296,6 +1316,10 @@ export type RemitImapCreateCalendarInput = {
      * 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;
 };
 
 /**
@@ -3392,7 +3416,7 @@ export type RemitImapUpdateCalendarEventInput = {
 };
 
 /**
- * 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 type RemitImapUpdateCalendarInput = {
     /**
@@ -3407,6 +3431,10 @@ export type RemitImapUpdateCalendarInput = {
      * 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;
 };
 
 /**
@@ -3774,6 +3802,10 @@ export type RemitImapCalendarResponseWritable = {
      * 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;
 };
 
 /**