@vrplatform/api 1.3.1-stage.4477 → 1.3.1-stage.4480

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (6) hide show
  1. package/build/main/generated/v1.d.ts +106 -24
  2. package/build/main/generated/v1.js.map +1 -1
  3. package/build/module/generated/v1.d.ts +106 -24
  4. package/build/module/generated/v1.js.map +1 -1
  5. package/package.json +1 -1
  6. package/src/generated/v1.ts +106 -24
package/build/main/generated/v1.d.ts CHANGED
@@ -2367,7 +2367,7 @@ export interface paths {
2367
2367
  };
2368
2368
  get?: never;
2369
2369
  put?: never;
2370
- /** @description Complete Plaid Link, persist credentials, discover accounts synchronously, and return them without polling. Create and replace require publicToken; update forbids it and reuses stored credentials. Transaction history is never awaited. Retrying the same connectId resumes after the last durable state. Plaid Link errors such as INVALID_UPDATED_USERNAME are handled in Link before this operation; start replace mode when Link cannot repair an Item. See https://docs.vrplatform.app/guides/build/banking. */
2370
+ /** @description Complete Plaid Link, persist credentials, discover accounts synchronously, and return one screen-ready configuration model without polling or secondary account requests. The response includes every discovered feed, eligible GL bank accounts, allowed categories, server-owned suggestions, action capabilities, and typed duplicate issues. Create and replace require publicToken; update forbids it and reuses stored credentials. Transaction history is never awaited. Retrying the same connectId resumes after the last durable state. Plaid Link errors such as INVALID_UPDATED_USERNAME are handled in Link before this operation; start replace mode when Link cannot repair an Item. See https://docs.vrplatform.app/guides/build/banking. */
2371
2371
  post: operations["completePlaidConnectSession"];
2372
2372
  delete?: never;
2373
2373
  options?: never;
@@ -2384,7 +2384,7 @@ export interface paths {
2384
2384
  };
2385
2385
  get?: never;
2386
2386
  put?: never;
2387
- /** @description Apply every active unlinked account decision for a Plaid connect session in one mutation, then create exactly one durable initial transaction sync. Connect decisions can reference an existing GL bank account or create one using the normal account schema. Ignore decisions archive the external feed. The earliest selected startDate controls history ingestion. Repeating a completed connectId returns the same sync. See https://docs.vrplatform.app/guides/build/banking. */
2387
+ /** @description Apply every required bank-account configuration for a Plaid connect session in one mutation, then create exactly one durable initial transaction sync. Connect decisions can reference an eligible existing GL bank account or create one using the normal account schema. Archive decisions make the external feed inactive. The earliest selected startDate controls history ingestion. Repeating a completed connectId returns the same sync. If eligibility changed after completion, a PLAID_CONNECT_CONFIGURATION_CHANGED conflict returns the refreshed screen model in context.result. See https://docs.vrplatform.app/guides/build/banking. */
2388
2388
  post: operations["configurePlaidConnectSession"];
2389
2389
  delete?: never;
2390
2390
  options?: never;
@@ -11479,7 +11479,7 @@ export interface operations {
11479
11479
  sourceId?: string | null;
11480
11480
  message: string;
11481
11481
  /** @enum {string} */
11482
- code?: "USER_ERROR" | "NOT_FOUND" | "FORBIDDEN" | "CONFLICT" | "RATE_LIMITED" | "SERVICE_UNAVAILABLE" | "INTERNAL_VALIDATION_ERROR" | "INTERNAL_ERROR" | "INVALID_PLAID_CONNECT_MODE" | "PLAID_CONNECTION_NOT_FOUND" | "PLAID_CONNECT_IN_PROGRESS" | "PLAID_ACCOUNT_NO_LONGER_REUSABLE" | "PLAID_CONNECT_EXPIRED" | "PLAID_CONNECT_REQUIRES_NEW_LINK" | "PLAID_PROVIDER_UNAVAILABLE";
11482
+ code?: "USER_ERROR" | "NOT_FOUND" | "FORBIDDEN" | "CONFLICT" | "RATE_LIMITED" | "SERVICE_UNAVAILABLE" | "INTERNAL_VALIDATION_ERROR" | "INTERNAL_ERROR" | "INVALID_PLAID_CONNECT_MODE" | "PLAID_CONNECTION_NOT_FOUND" | "PLAID_CONNECT_IN_PROGRESS" | "PLAID_CONNECT_CONFIGURATION_CHANGED" | "PLAID_CONNECT_EXPIRED" | "PLAID_CONNECT_REQUIRES_NEW_LINK" | "PLAID_PROVIDER_UNAVAILABLE";
11483
11483
  context?: unknown;
11484
11484
  }[];
11485
11485
  };
@@ -12815,7 +12815,7 @@ export interface operations {
12815
12815
  sourceId?: string | null;
12816
12816
  message: string;
12817
12817
  /** @enum {string} */
12818
- code?: "USER_ERROR" | "NOT_FOUND" | "FORBIDDEN" | "CONFLICT" | "RATE_LIMITED" | "SERVICE_UNAVAILABLE" | "INTERNAL_VALIDATION_ERROR" | "INTERNAL_ERROR" | "INVALID_PLAID_CONNECT_MODE" | "PLAID_CONNECTION_NOT_FOUND" | "PLAID_CONNECT_IN_PROGRESS" | "PLAID_ACCOUNT_NO_LONGER_REUSABLE" | "PLAID_CONNECT_EXPIRED" | "PLAID_CONNECT_REQUIRES_NEW_LINK" | "PLAID_PROVIDER_UNAVAILABLE";
12818
+ code?: "USER_ERROR" | "NOT_FOUND" | "FORBIDDEN" | "CONFLICT" | "RATE_LIMITED" | "SERVICE_UNAVAILABLE" | "INTERNAL_VALIDATION_ERROR" | "INTERNAL_ERROR" | "INVALID_PLAID_CONNECT_MODE" | "PLAID_CONNECTION_NOT_FOUND" | "PLAID_CONNECT_IN_PROGRESS" | "PLAID_CONNECT_CONFIGURATION_CHANGED" | "PLAID_CONNECT_EXPIRED" | "PLAID_CONNECT_REQUIRES_NEW_LINK" | "PLAID_PROVIDER_UNAVAILABLE";
12819
12819
  context?: unknown;
12820
12820
  }[];
12821
12821
  };
@@ -22762,7 +22762,7 @@ export interface operations {
22762
22762
  sourceId?: string | null;
22763
22763
  message: string;
22764
22764
  /** @enum {string} */
22765
- code?: "USER_ERROR" | "NOT_FOUND" | "FORBIDDEN" | "CONFLICT" | "RATE_LIMITED" | "SERVICE_UNAVAILABLE" | "INTERNAL_VALIDATION_ERROR" | "INTERNAL_ERROR" | "INVALID_PLAID_CONNECT_MODE" | "PLAID_CONNECTION_NOT_FOUND" | "PLAID_CONNECT_IN_PROGRESS" | "PLAID_ACCOUNT_NO_LONGER_REUSABLE" | "PLAID_CONNECT_EXPIRED" | "PLAID_CONNECT_REQUIRES_NEW_LINK" | "PLAID_PROVIDER_UNAVAILABLE";
22765
+ code?: "USER_ERROR" | "NOT_FOUND" | "FORBIDDEN" | "CONFLICT" | "RATE_LIMITED" | "SERVICE_UNAVAILABLE" | "INTERNAL_VALIDATION_ERROR" | "INTERNAL_ERROR" | "INVALID_PLAID_CONNECT_MODE" | "PLAID_CONNECTION_NOT_FOUND" | "PLAID_CONNECT_IN_PROGRESS" | "PLAID_CONNECT_CONFIGURATION_CHANGED" | "PLAID_CONNECT_EXPIRED" | "PLAID_CONNECT_REQUIRES_NEW_LINK" | "PLAID_PROVIDER_UNAVAILABLE";
22766
22766
  context?: unknown;
22767
22767
  }[];
22768
22768
  };
@@ -42419,7 +42419,7 @@ export interface operations {
42419
42419
  sourceId?: string | null;
42420
42420
  message: string;
42421
42421
  /** @enum {string} */
42422
- code?: "USER_ERROR" | "NOT_FOUND" | "FORBIDDEN" | "CONFLICT" | "RATE_LIMITED" | "SERVICE_UNAVAILABLE" | "INTERNAL_VALIDATION_ERROR" | "INTERNAL_ERROR" | "INVALID_PLAID_CONNECT_MODE" | "PLAID_CONNECTION_NOT_FOUND" | "PLAID_CONNECT_IN_PROGRESS" | "PLAID_ACCOUNT_NO_LONGER_REUSABLE" | "PLAID_CONNECT_EXPIRED" | "PLAID_CONNECT_REQUIRES_NEW_LINK" | "PLAID_PROVIDER_UNAVAILABLE";
42422
+ code?: "USER_ERROR" | "NOT_FOUND" | "FORBIDDEN" | "CONFLICT" | "RATE_LIMITED" | "SERVICE_UNAVAILABLE" | "INTERNAL_VALIDATION_ERROR" | "INTERNAL_ERROR" | "INVALID_PLAID_CONNECT_MODE" | "PLAID_CONNECTION_NOT_FOUND" | "PLAID_CONNECT_IN_PROGRESS" | "PLAID_CONNECT_CONFIGURATION_CHANGED" | "PLAID_CONNECT_EXPIRED" | "PLAID_CONNECT_REQUIRES_NEW_LINK" | "PLAID_PROVIDER_UNAVAILABLE";
42423
42423
  context?: unknown;
42424
42424
  }[];
42425
42425
  };
@@ -44178,7 +44178,7 @@ export interface operations {
44178
44178
  sourceId?: string | null;
44179
44179
  message: string;
44180
44180
  /** @enum {string} */
44181
- code?: "USER_ERROR" | "NOT_FOUND" | "FORBIDDEN" | "CONFLICT" | "RATE_LIMITED" | "SERVICE_UNAVAILABLE" | "INTERNAL_VALIDATION_ERROR" | "INTERNAL_ERROR" | "INVALID_PLAID_CONNECT_MODE" | "PLAID_CONNECTION_NOT_FOUND" | "PLAID_CONNECT_IN_PROGRESS" | "PLAID_ACCOUNT_NO_LONGER_REUSABLE" | "PLAID_CONNECT_EXPIRED" | "PLAID_CONNECT_REQUIRES_NEW_LINK" | "PLAID_PROVIDER_UNAVAILABLE";
44181
+ code?: "USER_ERROR" | "NOT_FOUND" | "FORBIDDEN" | "CONFLICT" | "RATE_LIMITED" | "SERVICE_UNAVAILABLE" | "INTERNAL_VALIDATION_ERROR" | "INTERNAL_ERROR" | "INVALID_PLAID_CONNECT_MODE" | "PLAID_CONNECTION_NOT_FOUND" | "PLAID_CONNECT_IN_PROGRESS" | "PLAID_CONNECT_CONFIGURATION_CHANGED" | "PLAID_CONNECT_EXPIRED" | "PLAID_CONNECT_REQUIRES_NEW_LINK" | "PLAID_PROVIDER_UNAVAILABLE";
44182
44182
  context?: unknown;
44183
44183
  }[];
44184
44184
  };
@@ -57418,8 +57418,6 @@ export interface operations {
57418
57418
  "application/json": {
57419
57419
  /** Format: uuid */
57420
57420
  connectId: string;
57421
- /** @enum {string} */
57422
- status: "awaitingConfiguration" | "completed";
57423
57421
  connection: {
57424
57422
  /** Format: uuid */
57425
57423
  id: string;
@@ -57427,6 +57425,22 @@ export interface operations {
57427
57425
  /** @enum {string} */
57428
57426
  status: "active" | "inactive";
57429
57427
  };
57428
+ /** @description Eligible unconnected GL bank accounts */
57429
+ accounts: {
57430
+ id: string;
57431
+ name: string;
57432
+ uniqueRef?: string | null;
57433
+ /** @enum {string} */
57434
+ status: "active" | "inactive";
57435
+ banking: {
57436
+ category: ("trust" | "operating" | "external") | null;
57437
+ currency: string | null;
57438
+ last4: string | null;
57439
+ type: ("deposit" | "creditCard") | null;
57440
+ };
57441
+ }[];
57442
+ /** @description Categories allowed for this tenant */
57443
+ bankAccountCategories: ("trust" | "operating" | "external")[];
57430
57444
  bankAccounts: {
57431
57445
  /** Format: uuid */
57432
57446
  id: string;
@@ -57440,24 +57454,91 @@ export interface operations {
57440
57454
  /** @enum {string} */
57441
57455
  status: "active" | "inactive";
57442
57456
  startDate?: string | null;
57443
- account?: {
57457
+ account: {
57444
57458
  id: string;
57445
57459
  name: string;
57446
57460
  uniqueRef?: string | null;
57447
57461
  /** @enum {string} */
57448
57462
  status: "active" | "inactive";
57449
57463
  } | null;
57450
- reusable: boolean;
57451
- reusableReason?: ("alreadyConnected" | "inactive" | "deterministicDuplicate") | null;
57452
- possibleDuplicates: {
57453
- /** Format: uuid */
57454
- bankAccountId: string;
57455
- connectionId?: string | null;
57456
- name?: string | null;
57457
- lastDigits?: string | null;
57458
- }[];
57464
+ configuration: {
57465
+ /**
57466
+ * @description Whether this feed still needs a configuration decision
57467
+ * @enum {string}
57468
+ */
57469
+ status: "configured" | "required";
57470
+ /** @description Whether the connect action is currently valid */
57471
+ canConnect: boolean;
57472
+ /** @description Whether connect may create a new GL bank account */
57473
+ canCreateAccount: boolean;
57474
+ /** @description Unique eligible last-four match, when one exists */
57475
+ suggestedAccount: {
57476
+ id: string;
57477
+ name: string;
57478
+ uniqueRef?: string | null;
57479
+ /** @enum {string} */
57480
+ status: "active" | "inactive";
57481
+ } | null;
57482
+ /** @description Server-owned default category for the connect action */
57483
+ suggestedCategory: ("trust" | "operating" | "external") | null;
57484
+ /** @description Server-owned default history start date */
57485
+ suggestedStartDate: string | null;
57486
+ };
57487
+ issues: ({
57488
+ /** @constant */
57489
+ code: "deterministicDuplicate";
57490
+ /** @constant */
57491
+ severity: "error";
57492
+ context: {
57493
+ bankAccounts: {
57494
+ /** Format: uuid */
57495
+ bankAccountId: string;
57496
+ name: string | null;
57497
+ lastDigits: string | null;
57498
+ connection: {
57499
+ /** Format: uuid */
57500
+ id: string;
57501
+ name: string;
57502
+ } | null;
57503
+ account: {
57504
+ id: string;
57505
+ name: string;
57506
+ uniqueRef?: string | null;
57507
+ /** @enum {string} */
57508
+ status: "active" | "inactive";
57509
+ } | null;
57510
+ }[];
57511
+ };
57512
+ } | {
57513
+ /** @constant */
57514
+ code: "possibleDuplicate";
57515
+ /** @constant */
57516
+ severity: "warning";
57517
+ context: {
57518
+ bankAccounts: {
57519
+ /** Format: uuid */
57520
+ bankAccountId: string;
57521
+ name: string | null;
57522
+ lastDigits: string | null;
57523
+ connection: {
57524
+ /** Format: uuid */
57525
+ id: string;
57526
+ name: string;
57527
+ } | null;
57528
+ account: {
57529
+ id: string;
57530
+ name: string;
57531
+ uniqueRef?: string | null;
57532
+ /** @enum {string} */
57533
+ status: "active" | "inactive";
57534
+ } | null;
57535
+ }[];
57536
+ };
57537
+ })[];
57459
57538
  }[];
57460
- sync?: {
57539
+ /** @enum {string} */
57540
+ status: "awaitingConfiguration" | "completed";
57541
+ sync: {
57461
57542
  /** Format: uuid */
57462
57543
  id: string;
57463
57544
  /** @constant */
@@ -57729,7 +57810,8 @@ export interface operations {
57729
57810
  startDate: string;
57730
57811
  startingBalance?: {
57731
57812
  date: string;
57732
- amount: number;
57813
+ /** @description Opening balance in the smallest currency unit */
57814
+ centAmount: number;
57733
57815
  };
57734
57816
  /** @default false */
57735
57817
  confirmPossibleDuplicate?: boolean;
@@ -57737,7 +57819,7 @@ export interface operations {
57737
57819
  /** Format: uuid */
57738
57820
  bankAccountId: string;
57739
57821
  /** @constant */
57740
- action: "ignore";
57822
+ action: "archive";
57741
57823
  })[];
57742
57824
  };
57743
57825
  };
@@ -78001,7 +78083,7 @@ export interface operations {
78001
78083
  sourceId?: string | null;
78002
78084
  message: string;
78003
78085
  /** @enum {string} */
78004
- code?: "USER_ERROR" | "NOT_FOUND" | "FORBIDDEN" | "CONFLICT" | "RATE_LIMITED" | "SERVICE_UNAVAILABLE" | "INTERNAL_VALIDATION_ERROR" | "INTERNAL_ERROR" | "INVALID_PLAID_CONNECT_MODE" | "PLAID_CONNECTION_NOT_FOUND" | "PLAID_CONNECT_IN_PROGRESS" | "PLAID_ACCOUNT_NO_LONGER_REUSABLE" | "PLAID_CONNECT_EXPIRED" | "PLAID_CONNECT_REQUIRES_NEW_LINK" | "PLAID_PROVIDER_UNAVAILABLE";
78086
+ code?: "USER_ERROR" | "NOT_FOUND" | "FORBIDDEN" | "CONFLICT" | "RATE_LIMITED" | "SERVICE_UNAVAILABLE" | "INTERNAL_VALIDATION_ERROR" | "INTERNAL_ERROR" | "INVALID_PLAID_CONNECT_MODE" | "PLAID_CONNECTION_NOT_FOUND" | "PLAID_CONNECT_IN_PROGRESS" | "PLAID_CONNECT_CONFIGURATION_CHANGED" | "PLAID_CONNECT_EXPIRED" | "PLAID_CONNECT_REQUIRES_NEW_LINK" | "PLAID_PROVIDER_UNAVAILABLE";
78005
78087
  context?: unknown;
78006
78088
  }[];
78007
78089
  };
@@ -109938,7 +110020,7 @@ export interface operations {
109938
110020
  sourceId?: string | null;
109939
110021
  message: string;
109940
110022
  /** @enum {string} */
109941
- code?: "USER_ERROR" | "NOT_FOUND" | "FORBIDDEN" | "CONFLICT" | "RATE_LIMITED" | "SERVICE_UNAVAILABLE" | "INTERNAL_VALIDATION_ERROR" | "INTERNAL_ERROR" | "INVALID_PLAID_CONNECT_MODE" | "PLAID_CONNECTION_NOT_FOUND" | "PLAID_CONNECT_IN_PROGRESS" | "PLAID_ACCOUNT_NO_LONGER_REUSABLE" | "PLAID_CONNECT_EXPIRED" | "PLAID_CONNECT_REQUIRES_NEW_LINK" | "PLAID_PROVIDER_UNAVAILABLE";
110023
+ code?: "USER_ERROR" | "NOT_FOUND" | "FORBIDDEN" | "CONFLICT" | "RATE_LIMITED" | "SERVICE_UNAVAILABLE" | "INTERNAL_VALIDATION_ERROR" | "INTERNAL_ERROR" | "INVALID_PLAID_CONNECT_MODE" | "PLAID_CONNECTION_NOT_FOUND" | "PLAID_CONNECT_IN_PROGRESS" | "PLAID_CONNECT_CONFIGURATION_CHANGED" | "PLAID_CONNECT_EXPIRED" | "PLAID_CONNECT_REQUIRES_NEW_LINK" | "PLAID_PROVIDER_UNAVAILABLE";
109942
110024
  context?: unknown;
109943
110025
  }[];
109944
110026
  };