@vrplatform/api 1.3.1-stage.6285 → 1.3.1-stage.6295

package/package.json

@@ -3,7 +3,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "1.3.1-stage.6285",
+  "version": "1.3.1-stage.6295",
   "description": "",
   "main": "build/main/index.js",
   "module": "build/module/index.js",

package/src/generated/v1.ts

@@ -1142,7 +1142,7 @@ export interface paths {
             cookie?: never;
         };
         /**
-         * @description List contacts, including linked owner secondary-email search and embedded report filter options. Owner access is limited to directly owned contacts.
+         * @description List contacts with masked ACH state, including hasInFlightPayment for requested or processing Ramp payments, linked owner secondary-email search, and embedded report filter options. Owner access is limited to directly owned contacts.
          *
          *     Required scope: contacts:read
          */
@@ -1202,6 +1202,27 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/contacts/{contactId}/payouts": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * @description List the selected contact's active payout transactions newest first. Authenticated owners may request only contact IDs in their server-derived owner access; unauthorized contacts return an opaque not-found response. Property managers and owner-preview sessions may request a selected team contact. The response is an owner-facing projection with the latest provider-payment state, including requested payments, and excludes bank, reconciliation, journal, connection, and internal provider fields.
+         *
+         *     Required scope: transactions:read
+         */
+        get: operations["getContactsByContactIdPayouts"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/contacts/{id}": {
         parameters: {
             query?: never;
@@ -1210,7 +1231,7 @@ export interface paths {
             cookie?: never;
         };
         /**
-         * @description Get contact by ID
+         * @description Get a contact by ID with masked ACH state. hasInFlightPayment identifies requested or processing Ramp payments so clients can warn that bank changes affect future payments only.
          *
          *     Required scope: contacts:read
          */
@@ -1264,7 +1285,7 @@ export interface paths {
         get?: never;
         put?: never;
         /**
-         * @description Send owner ACH details to the single eligible Ramp push-vendor flow for verification. This action requires ach-payment-methods:write rather than general contact write access. The server resolves the connection; clients do not select one. First use activates a flow that has never been configured, while an explicitly inactive flow remains unavailable. Raw routing and account numbers are write-only and are never stored by VRPlatform. The contact becomes ready only after Ramp confirms the account.
+         * @description Send owner ACH details to the single eligible Ramp push-vendor flow for verification. This action requires ach-payment-methods:write rather than general contact write access. The server resolves the connection; clients do not select one. First use activates a flow that has never been configured, while an explicitly inactive flow remains unavailable. Raw routing and account numbers are write-only and are never stored by VRPlatform. The contact becomes ready only after Ramp confirms the account. Requested and processing payments remain bound to their scheduled destination, so an update affects future payments only.
          *
          *     Required scope: ach-payment-methods:write
          */
@@ -28028,6 +28049,8 @@ export interface operations {
                                     last4: string | null;
                                     /** @enum {string} */
                                     status: "notConfigured" | "pending" | "ready" | "failed";
+                                    /** @description True when a Ramp payment is requested or processing. Bank changes remain allowed and affect future payments only. */
+                                    hasInFlightPayment: boolean;
                                 };
                             };
                         }[];
@@ -29167,6 +29190,311 @@ export interface operations {
             };
         };
     };
+    getContactsByContactIdPayouts: {
+        parameters: {
+            query?: {
+                limit?: number;
+                page?: number;
+                offset?: number;
+            };
+            header?: never;
+            path: {
+                contactId: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Successful response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        data: {
+                            /** Format: uuid */
+                            id: string;
+                            uniqueRef: string | null;
+                            shortRef: string | null;
+                            date: string;
+                            description: string;
+                            /** @description Value in cents (100 = 1€) */
+                            amount: number;
+                            /** @description Currency in ISO 4217 format, will be converted to lowercase */
+                            currency: string;
+                            ownerStatement: {
+                                /** Format: uuid */
+                                id: string;
+                                uniqueRef: string | null;
+                                /**
+                                 * Format: vrp-month
+                                 * @description Month string in format `YYYY-MM`.
+                                 * @example 2024-01
+                                 */
+                                month: string;
+                            } | null;
+                            providerPayment: {
+                                /** Format: uuid */
+                                id: string;
+                                /** @constant */
+                                provider: "ramp";
+                                /** @enum {string} */
+                                status: "requested" | "processing" | "paid" | "failed" | "returned" | "canceled";
+                                failureReason: string | null;
+                                /**
+                                 * Format: date-time
+                                 * @description Timestamp string with date, time, milliseconds, and timezone.
+                                 * @example 2024-01-15T12:30:00.000+00:00
+                                 */
+                                createdAt: string;
+                                /**
+                                 * Format: date-time
+                                 * @description Timestamp string with date, time, milliseconds, and timezone.
+                                 * @example 2024-01-15T12:30:00.000+00:00
+                                 */
+                                updatedAt: string;
+                            } | null;
+                        }[];
+                        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;
+                    };
+                };
+            };
+        };
+    };
     getContactsById: {
         parameters: {
             query?: never;
@@ -29255,6 +29583,8 @@ export interface operations {
                                 last4: string | null;
                                 /** @enum {string} */
                                 status: "notConfigured" | "pending" | "ready" | "failed";
+                                /** @description True when a Ramp payment is requested or processing. Bank changes remain allowed and affect future payments only. */
+                                hasInFlightPayment: boolean;
                             };
                         };
                     };