@vrplatform/api 1.3.1-6399 → 1.3.1-6410

package/build/main/generated/v1.d.ts

@@ -2816,7 +2816,7 @@ export interface paths {
          */
         get: operations["getListingsByIdOpeningBalance"];
         /**
-         * @description Update opening balance for listing
+         * @description Update a listing opening balance. Setting an existing balance to zero can cross a statement-period boundary; books closing and direct owner-statement attachments still apply.
          *
          *     Required scope: general-ledger:write
          */
@@ -3869,7 +3869,7 @@ export interface paths {
             cookie?: never;
         };
         /**
-         * @description Check Plaid health using an existing connection
+         * @description Check the current Plaid Item and institution health for an existing connection. Typed errors distinguish reconnect, replacement, retry, and support actions.
          *
          *     Required scope: bank-connections:manage
          */
@@ -77879,16 +77879,15 @@ export interface operations {
                     };
                 };
             };
-            /** @description Conflict */
+            /** @description The connection must be re-authenticated */
             409: {
                 headers: {
-                    /** @description Seconds to wait when retryable=true and the server supplies a delay. */
-                    "Retry-After"?: number;
                     [name: string]: unknown;
                 };
                 content: {
                     "application/json": {
-                        code: string;
+                        /** @constant */
+                        code: "CONNECTION_RECONNECT_REQUIRED";
                         message: string;
                         links?: {
                             docs: string;
@@ -77900,7 +77899,27 @@ export interface operations {
                             schema?: string;
                         }[];
                         retryable?: boolean;
-                        context?: unknown;
+                        context: {
+                            endpoint?: string;
+                            method?: string;
+                            plaidDisplayMessage?: string;
+                            plaidDocumentationUrl?: string;
+                            plaidErrorCode?: string;
+                            plaidErrorCodeReason?: string;
+                            plaidErrorMessage?: string;
+                            plaidErrorType?: string;
+                            plaidRequestId?: string;
+                            plaidSuggestedAction?: string;
+                            retryAfterSeconds?: number;
+                            status?: number;
+                            statusText?: string;
+                            /** @constant */
+                            action: "reconnect";
+                            /** Format: uuid */
+                            connectionId: string;
+                            connectionName: string | null;
+                            operation?: string;
+                        };
                     };
                 };
             };
@@ -77929,16 +77948,15 @@ export interface operations {
                     };
                 };
             };
-            /** @description Unprocessable content */
+            /** @description The Plaid Item must be replaced through Link */
             422: {
                 headers: {
-                    /** @description Seconds to wait when retryable=true and the server supplies a delay. */
-                    "Retry-After"?: number;
                     [name: string]: unknown;
                 };
                 content: {
                     "application/json": {
-                        code: string;
+                        /** @constant */
+                        code: "PLAID_CONNECT_REQUIRES_NEW_LINK";
                         message: string;
                         links?: {
                             docs: string;
@@ -77950,20 +77968,41 @@ export interface operations {
                             schema?: string;
                         }[];
                         retryable?: boolean;
-                        context?: unknown;
+                        context: {
+                            endpoint?: string;
+                            method?: string;
+                            plaidDisplayMessage?: string;
+                            plaidDocumentationUrl?: string;
+                            plaidErrorCode?: string;
+                            plaidErrorCodeReason?: string;
+                            plaidErrorMessage?: string;
+                            plaidErrorType?: string;
+                            plaidRequestId?: string;
+                            plaidSuggestedAction?: string;
+                            retryAfterSeconds?: number;
+                            status?: number;
+                            statusText?: string;
+                            /** @constant */
+                            action: "replace";
+                            /** Format: uuid */
+                            connectionId: string;
+                            connectionName: string | null;
+                            operation?: string;
+                            /** @constant */
+                            restartMode: "replace";
+                        };
                     };
                 };
             };
-            /** @description Internal server error */
+            /** @description The health request could not be completed */
             500: {
                 headers: {
-                    /** @description Seconds to wait when retryable=true and the server supplies a delay. */
-                    "Retry-After"?: number;
                     [name: string]: unknown;
                 };
                 content: {
                     "application/json": {
-                        code: string;
+                        /** @constant */
+                        code: "INTERNAL_SERVER_ERROR";
                         message: string;
                         links?: {
                             docs: string;
@@ -77975,20 +78014,39 @@ export interface operations {
                             schema?: string;
                         }[];
                         retryable?: boolean;
-                        context?: unknown;
+                        context: {
+                            endpoint?: string;
+                            method?: string;
+                            plaidDisplayMessage?: string;
+                            plaidDocumentationUrl?: string;
+                            plaidErrorCode?: string;
+                            plaidErrorCodeReason?: string;
+                            plaidErrorMessage?: string;
+                            plaidErrorType?: string;
+                            plaidRequestId?: string;
+                            plaidSuggestedAction?: string;
+                            retryAfterSeconds?: number;
+                            status?: number;
+                            statusText?: string;
+                            /** @constant */
+                            action: "contactSupport";
+                            /** Format: uuid */
+                            connectionId: string;
+                            connectionName: string | null;
+                            operation?: string;
+                        };
                     };
                 };
             };
-            /** @description Service unavailable */
+            /** @description Plaid is temporarily unavailable */
             503: {
                 headers: {
-                    /** @description Seconds to wait when retryable=true and the server supplies a delay. */
-                    "Retry-After"?: number;
                     [name: string]: unknown;
                 };
                 content: {
                     "application/json": {
-                        code: string;
+                        /** @constant */
+                        code: "PLAID_PROVIDER_UNAVAILABLE";
                         message: string;
                         links?: {
                             docs: string;
@@ -77999,8 +78057,29 @@ export interface operations {
                             path?: (string | number)[];
                             schema?: string;
                         }[];
-                        retryable?: boolean;
-                        context?: unknown;
+                        /** @constant */
+                        retryable: true;
+                        context: {
+                            endpoint?: string;
+                            method?: string;
+                            plaidDisplayMessage?: string;
+                            plaidDocumentationUrl?: string;
+                            plaidErrorCode?: string;
+                            plaidErrorCodeReason?: string;
+                            plaidErrorMessage?: string;
+                            plaidErrorType?: string;
+                            plaidRequestId?: string;
+                            plaidSuggestedAction?: string;
+                            retryAfterSeconds?: number;
+                            status?: number;
+                            statusText?: string;
+                            /** @constant */
+                            action: "retry";
+                            /** Format: uuid */
+                            connectionId: string;
+                            connectionName: string | null;
+                            operation?: string;
+                        };
                     };
                 };
             };