@remit/api-http-client 0.0.56 → 0.0.58

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

@@ -335,6 +335,9 @@ export const mailboxOperationsCreateMailboxMutation = (options?: Partial<Options
     return mutationOptions;
 };
 
+/**
+ * Record a delete intent for a folder. The folder stays listed, marked as being deleted, until the mail server confirms it and its mail goes with it. Refused with 400 for INBOX, for a folder with folders inside it, and for a folder a filter or a canonical role is bound to — the message names each binding; with 409 when a mutation is already in flight on it.
+ */
 export const mailboxDetailOperationsDeleteMailboxMutation = (options?: Partial<Options<MailboxDetailOperationsDeleteMailboxData>>): UseMutationOptions<MailboxDetailOperationsDeleteMailboxResponse, MailboxDetailOperationsDeleteMailboxError, Options<MailboxDetailOperationsDeleteMailboxData>> => {
     const mutationOptions: UseMutationOptions<MailboxDetailOperationsDeleteMailboxResponse, MailboxDetailOperationsDeleteMailboxError, Options<MailboxDetailOperationsDeleteMailboxData>> = {
         mutationFn: async (fnOptions) => {
@@ -364,6 +367,9 @@ export const mailboxDetailOperationsGetMailboxOptions = (options: Options<Mailbo
     queryKey: mailboxDetailOperationsGetMailboxQueryKey(options)
 });
 
+/**
+ * Rename a folder, or dismiss a folder mutation that failed. `fullPath` records the rename target over the folder and everything under it; the folder keeps the path the mail server holds until the rename lands. A `fullPath` equal to the folder's current one is a dismissal: it clears a failed rename or delete and enqueues nothing. Refused with 400 for INBOX at either end, a name reserved for a system folder, and a name another folder already has; with 409 when a mutation is already in flight on the folder or on anything inside it.
+ */
 export const mailboxDetailOperationsRenameMailboxMutation = (options?: Partial<Options<MailboxDetailOperationsRenameMailboxData>>): UseMutationOptions<MailboxDetailOperationsRenameMailboxResponse, MailboxDetailOperationsRenameMailboxError, Options<MailboxDetailOperationsRenameMailboxData>> => {
     const mutationOptions: UseMutationOptions<MailboxDetailOperationsRenameMailboxResponse, MailboxDetailOperationsRenameMailboxError, Options<MailboxDetailOperationsRenameMailboxData>> = {
         mutationFn: async (fnOptions) => {

package/package.json

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

package/sdk.gen.ts

@@ -192,6 +192,9 @@ export const mailboxOperationsCreateMailbox = <ThrowOnError extends boolean = fa
     }
 });
 
+/**
+ * Record a delete intent for a folder. The folder stays listed, marked as being deleted, until the mail server confirms it and its mail goes with it. Refused with 400 for INBOX, for a folder with folders inside it, and for a folder a filter or a canonical role is bound to — the message names each binding; with 409 when a mutation is already in flight on it.
+ */
 export const mailboxDetailOperationsDeleteMailbox = <ThrowOnError extends boolean = false>(options: Options<MailboxDetailOperationsDeleteMailboxData, ThrowOnError>): RequestResult<MailboxDetailOperationsDeleteMailboxResponses, MailboxDetailOperationsDeleteMailboxErrors, ThrowOnError> => (options.client ?? client).delete<MailboxDetailOperationsDeleteMailboxResponses, MailboxDetailOperationsDeleteMailboxErrors, ThrowOnError>({
     security: [{ name: 'Authorization', type: 'apiKey' }],
     url: '/accounts/{accountId}/mailboxes/{mailboxId}',
@@ -204,6 +207,9 @@ export const mailboxDetailOperationsGetMailbox = <ThrowOnError extends boolean =
     ...options
 });
 
+/**
+ * Rename a folder, or dismiss a folder mutation that failed. `fullPath` records the rename target over the folder and everything under it; the folder keeps the path the mail server holds until the rename lands. A `fullPath` equal to the folder's current one is a dismissal: it clears a failed rename or delete and enqueues nothing. Refused with 400 for INBOX at either end, a name reserved for a system folder, and a name another folder already has; with 409 when a mutation is already in flight on the folder or on anything inside it.
+ */
 export const mailboxDetailOperationsRenameMailbox = <ThrowOnError extends boolean = false>(options: Options<MailboxDetailOperationsRenameMailboxData, ThrowOnError>): RequestResult<MailboxDetailOperationsRenameMailboxResponses, MailboxDetailOperationsRenameMailboxErrors, ThrowOnError> => (options.client ?? client).patch<MailboxDetailOperationsRenameMailboxResponses, MailboxDetailOperationsRenameMailboxErrors, ThrowOnError>({
     security: [{ name: 'Authorization', type: 'apiKey' }],
     url: '/accounts/{accountId}/mailboxes/{mailboxId}',

package/types.gen.ts

@@ -4298,6 +4298,14 @@ export type FilterOperationsCreateFilterErrors = {
      * Nothing answers to this address, or the caller may not learn that something does. `code` is `not_found`.
      */
     404: ApiError;
+    /**
+     * The write binds a durable reference — a role appointment, a filter's move target, a message's destination — to a folder whose own mutation has not settled, so the reference would point at something that may never exist.
+     *
+     * `code: "mailbox_not_settled"` — `details` carries `mailboxId` and `syncStatus`, one of `pending` (the mail server has not confirmed the folder yet), `deleting` (it is on its way out) or `failed` (its last rename or delete did not land, and the user has a retry or a dismissal to make first). Clearing a reference is never refused this way, and neither is moving mail *out of* such a folder.
+     *
+     * 422 rather than a second 409: 409 means somebody else is changing this folder right now and the client should refresh, which is different copy and a different remedy.
+     */
+    422: ApiError;
 };
 
 export type FilterOperationsCreateFilterError = FilterOperationsCreateFilterErrors[keyof FilterOperationsCreateFilterErrors];
@@ -4402,6 +4410,14 @@ export type FilterDetailOperationsUpdateFilterErrors = {
      * Nothing answers to this address, or the caller may not learn that something does. `code` is `not_found`.
      */
     404: ApiError;
+    /**
+     * The write binds a durable reference — a role appointment, a filter's move target, a message's destination — to a folder whose own mutation has not settled, so the reference would point at something that may never exist.
+     *
+     * `code: "mailbox_not_settled"` — `details` carries `mailboxId` and `syncStatus`, one of `pending` (the mail server has not confirmed the folder yet), `deleting` (it is on its way out) or `failed` (its last rename or delete did not land, and the user has a retry or a dismissal to make first). Clearing a reference is never refused this way, and neither is moving mail *out of* such a folder.
+     *
+     * 422 rather than a second 409: 409 means somebody else is changing this folder right now and the client should refresh, which is different copy and a different remedy.
+     */
+    422: ApiError;
 };
 
 export type FilterDetailOperationsUpdateFilterError = FilterDetailOperationsUpdateFilterErrors[keyof FilterDetailOperationsUpdateFilterErrors];
@@ -4439,13 +4455,19 @@ export type FolderRoleOperationsAppointFolderRoleErrors = {
      */
     404: ApiError;
     /**
-     * The same flat 409 body as `FolderRoleConflict`, with one code only this endpoint can answer with.
+     * The same flat 409 body as `FolderRoleConflict`, with the codes only this endpoint can answer with.
      *
      * `code: "folder_role_unresolved"` — as everywhere else, with `details` carrying `role`, `accountId` and `reason`.
-     *
-     * `code: "mailbox_not_settled"` — the mailbox being appointed is still being created or deleted on the mail server, so it cannot yet hold a role. `details` carries `mailboxId` and `syncStatus`. Clearing a role is never refused this way.
      */
     409: ApiError;
+    /**
+     * The write binds a durable reference — a role appointment, a filter's move target, a message's destination — to a folder whose own mutation has not settled, so the reference would point at something that may never exist.
+     *
+     * `code: "mailbox_not_settled"` — `details` carries `mailboxId` and `syncStatus`, one of `pending` (the mail server has not confirmed the folder yet), `deleting` (it is on its way out) or `failed` (its last rename or delete did not land, and the user has a retry or a dismissal to make first). Clearing a reference is never refused this way, and neither is moving mail *out of* such a folder.
+     *
+     * 422 rather than a second 409: 409 means somebody else is changing this folder right now and the client should refresh, which is different copy and a different remedy.
+     */
+    422: ApiError;
 };
 
 export type FolderRoleOperationsAppointFolderRoleError = FolderRoleOperationsAppointFolderRoleErrors[keyof FolderRoleOperationsAppointFolderRoleErrors];
@@ -4760,6 +4782,25 @@ export type MailboxDetailOperationsDeleteMailboxData = {
 };
 
 export type MailboxDetailOperationsDeleteMailboxErrors = {
+    /**
+     * The request was refused as malformed or contradictory. `code` is
+     * `invalid_request` where nothing more specific is known, and the refusal's own
+     * token where there is one.
+     *
+     * The calendar surface answers with the reason it read the request by:
+     * `invalid_window`, `invalid_scope`, `invalid_url_segment`, `url_segment_taken`,
+     * `unknown_time_zone` and `default_calendar_undeletable` on the collection and
+     * the query, and, for a VCALENDAR it could not accept,
+     * `malformed_icalendar`, `not_a_calendar`, `unsupported_component`, `no_event`,
+     * `no_master_event`, `multiple_master_events`, `missing_uid`, `mismatched_uid`,
+     * `missing_dt_start`, `backwards_end`, `invalid_date_time`,
+     * `invalid_recurrence_rule`, `missing_recurrence_id`, `not_recurring` and
+     * `unknown_occurrence`.
+     *
+     * `errors` is present only when the request failed schema validation before any
+     * handler ran, and names every field that was refused.
+     */
+    400: ValidationError;
     /**
      * The request carried no usable credential. `code` is `unauthorized`.
      */
@@ -4772,6 +4813,12 @@ export type MailboxDetailOperationsDeleteMailboxErrors = {
      * Nothing answers to this address, or the caller may not learn that something does. `code` is `not_found`.
      */
     404: ApiError;
+    /**
+     * The request contradicts the state the resource is in. `code` is `conflict`
+     * unless the refusal names its own — see `FolderRoleConflict`,
+     * `MessagePlacementConflict` and `ConfigImportConflict`.
+     */
+    409: ApiError;
 };
 
 export type MailboxDetailOperationsDeleteMailboxError = MailboxDetailOperationsDeleteMailboxErrors[keyof MailboxDetailOperationsDeleteMailboxErrors];
@@ -4828,6 +4875,25 @@ export type MailboxDetailOperationsRenameMailboxData = {
 };
 
 export type MailboxDetailOperationsRenameMailboxErrors = {
+    /**
+     * The request was refused as malformed or contradictory. `code` is
+     * `invalid_request` where nothing more specific is known, and the refusal's own
+     * token where there is one.
+     *
+     * The calendar surface answers with the reason it read the request by:
+     * `invalid_window`, `invalid_scope`, `invalid_url_segment`, `url_segment_taken`,
+     * `unknown_time_zone` and `default_calendar_undeletable` on the collection and
+     * the query, and, for a VCALENDAR it could not accept,
+     * `malformed_icalendar`, `not_a_calendar`, `unsupported_component`, `no_event`,
+     * `no_master_event`, `multiple_master_events`, `missing_uid`, `mismatched_uid`,
+     * `missing_dt_start`, `backwards_end`, `invalid_date_time`,
+     * `invalid_recurrence_rule`, `missing_recurrence_id`, `not_recurring` and
+     * `unknown_occurrence`.
+     *
+     * `errors` is present only when the request failed schema validation before any
+     * handler ran, and names every field that was refused.
+     */
+    400: ValidationError;
     /**
      * The request carried no usable credential. `code` is `unauthorized`.
      */
@@ -4840,6 +4906,12 @@ export type MailboxDetailOperationsRenameMailboxErrors = {
      * Nothing answers to this address, or the caller may not learn that something does. `code` is `not_found`.
      */
     404: ApiError;
+    /**
+     * The request contradicts the state the resource is in. `code` is `conflict`
+     * unless the refusal names its own — see `FolderRoleConflict`,
+     * `MessagePlacementConflict` and `ConfigImportConflict`.
+     */
+    409: ApiError;
 };
 
 export type MailboxDetailOperationsRenameMailboxError = MailboxDetailOperationsRenameMailboxErrors[keyof MailboxDetailOperationsRenameMailboxErrors];
@@ -6495,6 +6567,14 @@ export type MessageBulkOperationsCopyMessagesErrors = {
      * `code: "message_placement_unsettled"` — the message is mid-move, so its row names the destination folder while its uid still belongs to the source; acting on that pair would hit whatever the destination holds at that uid. `details` carries `accountId`, `messageId` and `reason`, one of: `in_flight` (the move is still running, and the same request succeeds once it confirms) or `unverified` (the move gave up without confirming, so where the message sits is unknown until the folder is resynced).
      */
     409: ApiError;
+    /**
+     * The write binds a durable reference — a role appointment, a filter's move target, a message's destination — to a folder whose own mutation has not settled, so the reference would point at something that may never exist.
+     *
+     * `code: "mailbox_not_settled"` — `details` carries `mailboxId` and `syncStatus`, one of `pending` (the mail server has not confirmed the folder yet), `deleting` (it is on its way out) or `failed` (its last rename or delete did not land, and the user has a retry or a dismissal to make first). Clearing a reference is never refused this way, and neither is moving mail *out of* such a folder.
+     *
+     * 422 rather than a second 409: 409 means somebody else is changing this folder right now and the client should refresh, which is different copy and a different remedy.
+     */
+    422: ApiError;
 };
 
 export type MessageBulkOperationsCopyMessagesError = MessageBulkOperationsCopyMessagesErrors[keyof MessageBulkOperationsCopyMessagesErrors];
@@ -6641,6 +6721,14 @@ export type MessageBulkOperationsMoveMessagesErrors = {
      * `code: "message_placement_unsettled"` — the message is mid-move, so its row names the destination folder while its uid still belongs to the source; acting on that pair would hit whatever the destination holds at that uid. `details` carries `accountId`, `messageId` and `reason`, one of: `in_flight` (the move is still running, and the same request succeeds once it confirms) or `unverified` (the move gave up without confirming, so where the message sits is unknown until the folder is resynced).
      */
     409: ApiError;
+    /**
+     * The write binds a durable reference — a role appointment, a filter's move target, a message's destination — to a folder whose own mutation has not settled, so the reference would point at something that may never exist.
+     *
+     * `code: "mailbox_not_settled"` — `details` carries `mailboxId` and `syncStatus`, one of `pending` (the mail server has not confirmed the folder yet), `deleting` (it is on its way out) or `failed` (its last rename or delete did not land, and the user has a retry or a dismissal to make first). Clearing a reference is never refused this way, and neither is moving mail *out of* such a folder.
+     *
+     * 422 rather than a second 409: 409 means somebody else is changing this folder right now and the client should refresh, which is different copy and a different remedy.
+     */
+    422: ApiError;
 };
 
 export type MessageBulkOperationsMoveMessagesError = MessageBulkOperationsMoveMessagesErrors[keyof MessageBulkOperationsMoveMessagesErrors];