@vrplatform/api 1.3.1-preview.4549 → 1.3.1-preview.4560

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

@@ -2313,7 +2313,7 @@ export interface paths {
             path?: never;
             cookie?: never;
         };
-        /** @description List members of the partner itself with their child-team memberships */
+        /** @description List members of the partner itself with their partner-team role, status, invitation timestamp, and child-team memberships */
         get: operations["getPartnerMembers"];
         put?: never;
         post?: never;
@@ -2357,6 +2357,23 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/partner/owner-statements": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** @description List VRT teams in one regional partition of the partner portfolio with owner statement counts by status. Supports team-name search, pagination, and ordering by each status count. Select the partition with x-data-region. */
+        get: operations["getPartnerOwnerStatements"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/partner/users": {
         parameters: {
             query?: never;
@@ -2364,7 +2381,7 @@ export interface paths {
             path?: never;
             cookie?: never;
         };
-        /** @description List users across one regional partition of the partner portfolio with their team memberships and owner accesses. Select the partition with x-data-region. */
+        /** @description List child-team users across one regional partition of the partner portfolio with their team memberships and owner accesses. Users who belong to the partner team itself are excluded. Select the partition with x-data-region. */
         get: operations["getPartnerUsers"];
         put?: never;
         post?: never;
@@ -2555,7 +2572,7 @@ export interface paths {
         };
         get?: never;
         put?: never;
-        /** @description Create a tenant-scoped Plaid Link session. Create mode forbids connectionId; update and replace require it. Update mode reuses the stored Item while replace creates a new Item for the existing connection. The server owns environment and product selection. Link tokens are short-lived; complete the returned connectId before expiresAt. PLAID_CONNECT_REQUIRES_NEW_LINK returns the only valid restart mode and any required tenant-scoped connectionId in context. See https://docs.vrplatform.app/guides/build/banking. */
+        /** @description Create a tenant-scoped Plaid Link session. Create mode forbids connectionId; update and replace require it. Update mode reuses the stored Item while replace creates a new Item for the existing connection. Environment is optional for a new Item and defaults to production; reusable credentials retain their stored environment. The session owns environment and product selection after start. Link tokens are short-lived; complete the returned connectId before expiresAt. PLAID_CONNECT_REQUIRES_NEW_LINK returns the only valid restart mode and any required tenant-scoped connectionId in context. See https://docs.vrplatform.app/guides/build/banking. */
         post: operations["createPlaidConnectSession"];
         delete?: never;
         options?: never;
@@ -56783,6 +56800,10 @@ export interface operations {
                             /** Format: email */
                             email: string;
                             secondaryEmails: string[];
+                            /** @enum {string} */
+                            role: "admin" | "user";
+                            status: ("active" | "inactive" | "unconfirmed") | null;
+                            lastInvitedAt: string | null;
                             partnerId: string | null;
                             name: string | null;
                             firstName: string | null;
@@ -57548,6 +57569,291 @@ export interface operations {
             };
         };
     };
+    getPartnerOwnerStatements: {
+        parameters: {
+            query?: {
+                /** @description Filter by team name */
+                search?: string;
+                /** @description Owner statement status count to sort by */
+                sortBy?: "draft" | "inReview" | "published";
+                /** @description Sort direction, defaults to asc */
+                sortDirection?: "asc" | "desc";
+                limit?: number;
+                page?: number;
+                offset?: number;
+            };
+            header?: {
+                /** @description Selects the regional data partition for this partner portfolio read. It does not change the authenticated team context. */
+                "x-data-region"?: "ap" | "crunchy" | "eu" | "hostaway" | "us";
+            };
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Successful response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        data: {
+                            /** Format: uuid */
+                            id: string;
+                            name: string;
+                            logo?: string;
+                            /**
+                             * Format: date-time
+                             * @description Timestamp string with date, time, milliseconds, and timezone.
+                             * @example 2024-01-15T12:30:00.000+00:00
+                             */
+                            createdAt: string;
+                            ownerStatements: {
+                                draft: number;
+                                inReview: number;
+                                published: number;
+                            };
+                        }[];
+                        pagination: {
+                            /** @default 100 */
+                            limit: number;
+                            /** @default 1 */
+                            page: number;
+                            total: number;
+                            totalPage: number;
+                            nextPage?: number;
+                        };
+                    };
+                };
+            };
+            /** @description Bad request */
+            400: {
+                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;
+                        message: string;
+                        links?: {
+                            docs: string;
+                            schema: string;
+                        };
+                        issues?: {
+                            message: string;
+                            path?: (string | number)[];
+                            schema?: string;
+                        }[];
+                        retryable?: boolean;
+                        context?: unknown;
+                    };
+                };
+            };
+            /** @description Unauthorized */
+            401: {
+                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;
+                        message: string;
+                        links?: {
+                            docs: string;
+                            schema: string;
+                        };
+                        issues?: {
+                            message: string;
+                            path?: (string | number)[];
+                            schema?: string;
+                        }[];
+                        retryable?: boolean;
+                        context?: unknown;
+                    };
+                };
+            };
+            /** @description Forbidden */
+            403: {
+                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;
+                        message: string;
+                        links?: {
+                            docs: string;
+                            schema: string;
+                        };
+                        issues?: {
+                            message: string;
+                            path?: (string | number)[];
+                            schema?: string;
+                        }[];
+                        retryable?: boolean;
+                        context?: unknown;
+                    };
+                };
+            };
+            /** @description Not found */
+            404: {
+                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;
+                        message: string;
+                        links?: {
+                            docs: string;
+                            schema: string;
+                        };
+                        issues?: {
+                            message: string;
+                            path?: (string | number)[];
+                            schema?: string;
+                        }[];
+                        retryable?: boolean;
+                        context?: unknown;
+                    };
+                };
+            };
+            /** @description Conflict */
+            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;
+                        message: string;
+                        links?: {
+                            docs: string;
+                            schema: string;
+                        };
+                        issues?: {
+                            message: string;
+                            path?: (string | number)[];
+                            schema?: string;
+                        }[];
+                        retryable?: boolean;
+                        context?: unknown;
+                    };
+                };
+            };
+            /** @description Gone */
+            410: {
+                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;
+                        message: string;
+                        links?: {
+                            docs: string;
+                            schema: string;
+                        };
+                        issues?: {
+                            message: string;
+                            path?: (string | number)[];
+                            schema?: string;
+                        }[];
+                        retryable?: boolean;
+                        context?: unknown;
+                    };
+                };
+            };
+            /** @description Unprocessable content */
+            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;
+                        message: string;
+                        links?: {
+                            docs: string;
+                            schema: string;
+                        };
+                        issues?: {
+                            message: string;
+                            path?: (string | number)[];
+                            schema?: string;
+                        }[];
+                        retryable?: boolean;
+                        context?: unknown;
+                    };
+                };
+            };
+            /** @description Internal server error */
+            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;
+                        message: string;
+                        links?: {
+                            docs: string;
+                            schema: string;
+                        };
+                        issues?: {
+                            message: string;
+                            path?: (string | number)[];
+                            schema?: string;
+                        }[];
+                        retryable?: boolean;
+                        context?: unknown;
+                    };
+                };
+            };
+            /** @description Service 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;
+                        message: string;
+                        links?: {
+                            docs: string;
+                            schema: string;
+                        };
+                        issues?: {
+                            message: string;
+                            path?: (string | number)[];
+                            schema?: string;
+                        }[];
+                        retryable?: boolean;
+                        context?: unknown;
+                    };
+                };
+            };
+        };
+    };
     getPartnerUsers: {
         parameters: {
             query?: {
@@ -61322,6 +61628,11 @@ export interface operations {
                     mode: "create" | "update" | "replace";
                     /** Format: uuid */
                     connectionId?: string;
+                    /**
+                     * @description Plaid environment for a new Item. Defaults to production. Existing reusable credentials retain their stored environment.
+                     * @enum {string}
+                     */
+                    environment?: "sandbox" | "production";
                 };
             };
         };