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

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.
package/package.json CHANGED
@@ -3,7 +3,7 @@
3
3
  "publishConfig": {
4
4
  "access": "public"
5
5
  },
6
- "version": "1.3.1-stage.4477",
6
+ "version": "1.3.1-stage.4479",
7
7
  "description": "",
8
8
  "main": "build/main/index.js",
9
9
  "module": "build/module/index.js",
@@ -2368,7 +2368,7 @@ export interface paths {
2368
2368
  };
2369
2369
  get?: never;
2370
2370
  put?: never;
2371
- /** @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. */
2371
+ /** @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. */
2372
2372
  post: operations["completePlaidConnectSession"];
2373
2373
  delete?: never;
2374
2374
  options?: never;
@@ -2385,7 +2385,7 @@ export interface paths {
2385
2385
  };
2386
2386
  get?: never;
2387
2387
  put?: never;
2388
- /** @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. */
2388
+ /** @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. */
2389
2389
  post: operations["configurePlaidConnectSession"];
2390
2390
  delete?: never;
2391
2391
  options?: never;
@@ -11480,7 +11480,7 @@ export interface operations {
11480
11480
  sourceId?: string | null;
11481
11481
  message: string;
11482
11482
  /** @enum {string} */
11483
- 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";
11483
+ 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";
11484
11484
  context?: unknown;
11485
11485
  }[];
11486
11486
  };
@@ -12816,7 +12816,7 @@ export interface operations {
12816
12816
  sourceId?: string | null;
12817
12817
  message: string;
12818
12818
  /** @enum {string} */
12819
- 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";
12819
+ 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";
12820
12820
  context?: unknown;
12821
12821
  }[];
12822
12822
  };
@@ -22763,7 +22763,7 @@ export interface operations {
22763
22763
  sourceId?: string | null;
22764
22764
  message: string;
22765
22765
  /** @enum {string} */
22766
- 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";
22766
+ 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";
22767
22767
  context?: unknown;
22768
22768
  }[];
22769
22769
  };
@@ -42420,7 +42420,7 @@ export interface operations {
42420
42420
  sourceId?: string | null;
42421
42421
  message: string;
42422
42422
  /** @enum {string} */
42423
- 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";
42423
+ 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";
42424
42424
  context?: unknown;
42425
42425
  }[];
42426
42426
  };
@@ -44179,7 +44179,7 @@ export interface operations {
44179
44179
  sourceId?: string | null;
44180
44180
  message: string;
44181
44181
  /** @enum {string} */
44182
- 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";
44182
+ 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";
44183
44183
  context?: unknown;
44184
44184
  }[];
44185
44185
  };
@@ -57419,8 +57419,6 @@ export interface operations {
57419
57419
  "application/json": {
57420
57420
  /** Format: uuid */
57421
57421
  connectId: string;
57422
- /** @enum {string} */
57423
- status: "awaitingConfiguration" | "completed";
57424
57422
  connection: {
57425
57423
  /** Format: uuid */
57426
57424
  id: string;
@@ -57428,6 +57426,22 @@ export interface operations {
57428
57426
  /** @enum {string} */
57429
57427
  status: "active" | "inactive";
57430
57428
  };
57429
+ /** @description Eligible unconnected GL bank accounts */
57430
+ accounts: {
57431
+ id: string;
57432
+ name: string;
57433
+ uniqueRef?: string | null;
57434
+ /** @enum {string} */
57435
+ status: "active" | "inactive";
57436
+ banking: {
57437
+ category: ("trust" | "operating" | "external") | null;
57438
+ currency: string | null;
57439
+ last4: string | null;
57440
+ type: ("deposit" | "creditCard") | null;
57441
+ };
57442
+ }[];
57443
+ /** @description Categories allowed for this tenant */
57444
+ bankAccountCategories: ("trust" | "operating" | "external")[];
57431
57445
  bankAccounts: {
57432
57446
  /** Format: uuid */
57433
57447
  id: string;
@@ -57441,24 +57455,91 @@ export interface operations {
57441
57455
  /** @enum {string} */
57442
57456
  status: "active" | "inactive";
57443
57457
  startDate?: string | null;
57444
- account?: {
57458
+ account: {
57445
57459
  id: string;
57446
57460
  name: string;
57447
57461
  uniqueRef?: string | null;
57448
57462
  /** @enum {string} */
57449
57463
  status: "active" | "inactive";
57450
57464
  } | null;
57451
- reusable: boolean;
57452
- reusableReason?: ("alreadyConnected" | "inactive" | "deterministicDuplicate") | null;
57453
- possibleDuplicates: {
57454
- /** Format: uuid */
57455
- bankAccountId: string;
57456
- connectionId?: string | null;
57457
- name?: string | null;
57458
- lastDigits?: string | null;
57459
- }[];
57465
+ configuration: {
57466
+ /**
57467
+ * @description Whether this feed still needs a configuration decision
57468
+ * @enum {string}
57469
+ */
57470
+ status: "configured" | "required";
57471
+ /** @description Whether the connect action is currently valid */
57472
+ canConnect: boolean;
57473
+ /** @description Whether connect may create a new GL bank account */
57474
+ canCreateAccount: boolean;
57475
+ /** @description Unique eligible last-four match, when one exists */
57476
+ suggestedAccount: {
57477
+ id: string;
57478
+ name: string;
57479
+ uniqueRef?: string | null;
57480
+ /** @enum {string} */
57481
+ status: "active" | "inactive";
57482
+ } | null;
57483
+ /** @description Server-owned default category for the connect action */
57484
+ suggestedCategory: ("trust" | "operating" | "external") | null;
57485
+ /** @description Server-owned default history start date */
57486
+ suggestedStartDate: string | null;
57487
+ };
57488
+ issues: ({
57489
+ /** @constant */
57490
+ code: "deterministicDuplicate";
57491
+ /** @constant */
57492
+ severity: "error";
57493
+ context: {
57494
+ bankAccounts: {
57495
+ /** Format: uuid */
57496
+ bankAccountId: string;
57497
+ name: string | null;
57498
+ lastDigits: string | null;
57499
+ connection: {
57500
+ /** Format: uuid */
57501
+ id: string;
57502
+ name: string;
57503
+ } | null;
57504
+ account: {
57505
+ id: string;
57506
+ name: string;
57507
+ uniqueRef?: string | null;
57508
+ /** @enum {string} */
57509
+ status: "active" | "inactive";
57510
+ } | null;
57511
+ }[];
57512
+ };
57513
+ } | {
57514
+ /** @constant */
57515
+ code: "possibleDuplicate";
57516
+ /** @constant */
57517
+ severity: "warning";
57518
+ context: {
57519
+ bankAccounts: {
57520
+ /** Format: uuid */
57521
+ bankAccountId: string;
57522
+ name: string | null;
57523
+ lastDigits: string | null;
57524
+ connection: {
57525
+ /** Format: uuid */
57526
+ id: string;
57527
+ name: string;
57528
+ } | null;
57529
+ account: {
57530
+ id: string;
57531
+ name: string;
57532
+ uniqueRef?: string | null;
57533
+ /** @enum {string} */
57534
+ status: "active" | "inactive";
57535
+ } | null;
57536
+ }[];
57537
+ };
57538
+ })[];
57460
57539
  }[];
57461
- sync?: {
57540
+ /** @enum {string} */
57541
+ status: "awaitingConfiguration" | "completed";
57542
+ sync: {
57462
57543
  /** Format: uuid */
57463
57544
  id: string;
57464
57545
  /** @constant */
@@ -57730,7 +57811,8 @@ export interface operations {
57730
57811
  startDate: string;
57731
57812
  startingBalance?: {
57732
57813
  date: string;
57733
- amount: number;
57814
+ /** @description Opening balance in the smallest currency unit */
57815
+ centAmount: number;
57734
57816
  };
57735
57817
  /** @default false */
57736
57818
  confirmPossibleDuplicate?: boolean;
@@ -57738,7 +57820,7 @@ export interface operations {
57738
57820
  /** Format: uuid */
57739
57821
  bankAccountId: string;
57740
57822
  /** @constant */
57741
- action: "ignore";
57823
+ action: "archive";
57742
57824
  })[];
57743
57825
  };
57744
57826
  };
@@ -78002,7 +78084,7 @@ export interface operations {
78002
78084
  sourceId?: string | null;
78003
78085
  message: string;
78004
78086
  /** @enum {string} */
78005
- 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";
78087
+ 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";
78006
78088
  context?: unknown;
78007
78089
  }[];
78008
78090
  };
@@ -109939,7 +110021,7 @@ export interface operations {
109939
110021
  sourceId?: string | null;
109940
110022
  message: string;
109941
110023
  /** @enum {string} */
109942
- 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";
110024
+ 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";
109943
110025
  context?: unknown;
109944
110026
  }[];
109945
110027
  };