@vrplatform/api 1.3.1-preview.4549 → 1.3.1-preview.4560
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
package/src/generated/v1.ts
CHANGED
|
@@ -2314,7 +2314,7 @@ export interface paths {
|
|
|
2314
2314
|
path?: never;
|
|
2315
2315
|
cookie?: never;
|
|
2316
2316
|
};
|
|
2317
|
-
/** @description List members of the partner itself with their child-team memberships */
|
|
2317
|
+
/** @description List members of the partner itself with their partner-team role, status, invitation timestamp, and child-team memberships */
|
|
2318
2318
|
get: operations["getPartnerMembers"];
|
|
2319
2319
|
put?: never;
|
|
2320
2320
|
post?: never;
|
|
@@ -2358,6 +2358,23 @@ export interface paths {
|
|
|
2358
2358
|
patch?: never;
|
|
2359
2359
|
trace?: never;
|
|
2360
2360
|
};
|
|
2361
|
+
"/partner/owner-statements": {
|
|
2362
|
+
parameters: {
|
|
2363
|
+
query?: never;
|
|
2364
|
+
header?: never;
|
|
2365
|
+
path?: never;
|
|
2366
|
+
cookie?: never;
|
|
2367
|
+
};
|
|
2368
|
+
/** @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. */
|
|
2369
|
+
get: operations["getPartnerOwnerStatements"];
|
|
2370
|
+
put?: never;
|
|
2371
|
+
post?: never;
|
|
2372
|
+
delete?: never;
|
|
2373
|
+
options?: never;
|
|
2374
|
+
head?: never;
|
|
2375
|
+
patch?: never;
|
|
2376
|
+
trace?: never;
|
|
2377
|
+
};
|
|
2361
2378
|
"/partner/users": {
|
|
2362
2379
|
parameters: {
|
|
2363
2380
|
query?: never;
|
|
@@ -2365,7 +2382,7 @@ export interface paths {
|
|
|
2365
2382
|
path?: never;
|
|
2366
2383
|
cookie?: never;
|
|
2367
2384
|
};
|
|
2368
|
-
/** @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. */
|
|
2385
|
+
/** @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. */
|
|
2369
2386
|
get: operations["getPartnerUsers"];
|
|
2370
2387
|
put?: never;
|
|
2371
2388
|
post?: never;
|
|
@@ -2556,7 +2573,7 @@ export interface paths {
|
|
|
2556
2573
|
};
|
|
2557
2574
|
get?: never;
|
|
2558
2575
|
put?: never;
|
|
2559
|
-
/** @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
|
|
2576
|
+
/** @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. */
|
|
2560
2577
|
post: operations["createPlaidConnectSession"];
|
|
2561
2578
|
delete?: never;
|
|
2562
2579
|
options?: never;
|
|
@@ -56784,6 +56801,10 @@ export interface operations {
|
|
|
56784
56801
|
/** Format: email */
|
|
56785
56802
|
email: string;
|
|
56786
56803
|
secondaryEmails: string[];
|
|
56804
|
+
/** @enum {string} */
|
|
56805
|
+
role: "admin" | "user";
|
|
56806
|
+
status: ("active" | "inactive" | "unconfirmed") | null;
|
|
56807
|
+
lastInvitedAt: string | null;
|
|
56787
56808
|
partnerId: string | null;
|
|
56788
56809
|
name: string | null;
|
|
56789
56810
|
firstName: string | null;
|
|
@@ -57549,6 +57570,291 @@ export interface operations {
|
|
|
57549
57570
|
};
|
|
57550
57571
|
};
|
|
57551
57572
|
};
|
|
57573
|
+
getPartnerOwnerStatements: {
|
|
57574
|
+
parameters: {
|
|
57575
|
+
query?: {
|
|
57576
|
+
/** @description Filter by team name */
|
|
57577
|
+
search?: string;
|
|
57578
|
+
/** @description Owner statement status count to sort by */
|
|
57579
|
+
sortBy?: "draft" | "inReview" | "published";
|
|
57580
|
+
/** @description Sort direction, defaults to asc */
|
|
57581
|
+
sortDirection?: "asc" | "desc";
|
|
57582
|
+
limit?: number;
|
|
57583
|
+
page?: number;
|
|
57584
|
+
offset?: number;
|
|
57585
|
+
};
|
|
57586
|
+
header?: {
|
|
57587
|
+
/** @description Selects the regional data partition for this partner portfolio read. It does not change the authenticated team context. */
|
|
57588
|
+
"x-data-region"?: "ap" | "crunchy" | "eu" | "hostaway" | "us";
|
|
57589
|
+
};
|
|
57590
|
+
path?: never;
|
|
57591
|
+
cookie?: never;
|
|
57592
|
+
};
|
|
57593
|
+
requestBody?: never;
|
|
57594
|
+
responses: {
|
|
57595
|
+
/** @description Successful response */
|
|
57596
|
+
200: {
|
|
57597
|
+
headers: {
|
|
57598
|
+
[name: string]: unknown;
|
|
57599
|
+
};
|
|
57600
|
+
content: {
|
|
57601
|
+
"application/json": {
|
|
57602
|
+
data: {
|
|
57603
|
+
/** Format: uuid */
|
|
57604
|
+
id: string;
|
|
57605
|
+
name: string;
|
|
57606
|
+
logo?: string;
|
|
57607
|
+
/**
|
|
57608
|
+
* Format: date-time
|
|
57609
|
+
* @description Timestamp string with date, time, milliseconds, and timezone.
|
|
57610
|
+
* @example 2024-01-15T12:30:00.000+00:00
|
|
57611
|
+
*/
|
|
57612
|
+
createdAt: string;
|
|
57613
|
+
ownerStatements: {
|
|
57614
|
+
draft: number;
|
|
57615
|
+
inReview: number;
|
|
57616
|
+
published: number;
|
|
57617
|
+
};
|
|
57618
|
+
}[];
|
|
57619
|
+
pagination: {
|
|
57620
|
+
/** @default 100 */
|
|
57621
|
+
limit: number;
|
|
57622
|
+
/** @default 1 */
|
|
57623
|
+
page: number;
|
|
57624
|
+
total: number;
|
|
57625
|
+
totalPage: number;
|
|
57626
|
+
nextPage?: number;
|
|
57627
|
+
};
|
|
57628
|
+
};
|
|
57629
|
+
};
|
|
57630
|
+
};
|
|
57631
|
+
/** @description Bad request */
|
|
57632
|
+
400: {
|
|
57633
|
+
headers: {
|
|
57634
|
+
/** @description Seconds to wait when retryable=true and the server supplies a delay. */
|
|
57635
|
+
"Retry-After"?: number;
|
|
57636
|
+
[name: string]: unknown;
|
|
57637
|
+
};
|
|
57638
|
+
content: {
|
|
57639
|
+
"application/json": {
|
|
57640
|
+
code: string;
|
|
57641
|
+
message: string;
|
|
57642
|
+
links?: {
|
|
57643
|
+
docs: string;
|
|
57644
|
+
schema: string;
|
|
57645
|
+
};
|
|
57646
|
+
issues?: {
|
|
57647
|
+
message: string;
|
|
57648
|
+
path?: (string | number)[];
|
|
57649
|
+
schema?: string;
|
|
57650
|
+
}[];
|
|
57651
|
+
retryable?: boolean;
|
|
57652
|
+
context?: unknown;
|
|
57653
|
+
};
|
|
57654
|
+
};
|
|
57655
|
+
};
|
|
57656
|
+
/** @description Unauthorized */
|
|
57657
|
+
401: {
|
|
57658
|
+
headers: {
|
|
57659
|
+
/** @description Seconds to wait when retryable=true and the server supplies a delay. */
|
|
57660
|
+
"Retry-After"?: number;
|
|
57661
|
+
[name: string]: unknown;
|
|
57662
|
+
};
|
|
57663
|
+
content: {
|
|
57664
|
+
"application/json": {
|
|
57665
|
+
code: string;
|
|
57666
|
+
message: string;
|
|
57667
|
+
links?: {
|
|
57668
|
+
docs: string;
|
|
57669
|
+
schema: string;
|
|
57670
|
+
};
|
|
57671
|
+
issues?: {
|
|
57672
|
+
message: string;
|
|
57673
|
+
path?: (string | number)[];
|
|
57674
|
+
schema?: string;
|
|
57675
|
+
}[];
|
|
57676
|
+
retryable?: boolean;
|
|
57677
|
+
context?: unknown;
|
|
57678
|
+
};
|
|
57679
|
+
};
|
|
57680
|
+
};
|
|
57681
|
+
/** @description Forbidden */
|
|
57682
|
+
403: {
|
|
57683
|
+
headers: {
|
|
57684
|
+
/** @description Seconds to wait when retryable=true and the server supplies a delay. */
|
|
57685
|
+
"Retry-After"?: number;
|
|
57686
|
+
[name: string]: unknown;
|
|
57687
|
+
};
|
|
57688
|
+
content: {
|
|
57689
|
+
"application/json": {
|
|
57690
|
+
code: string;
|
|
57691
|
+
message: string;
|
|
57692
|
+
links?: {
|
|
57693
|
+
docs: string;
|
|
57694
|
+
schema: string;
|
|
57695
|
+
};
|
|
57696
|
+
issues?: {
|
|
57697
|
+
message: string;
|
|
57698
|
+
path?: (string | number)[];
|
|
57699
|
+
schema?: string;
|
|
57700
|
+
}[];
|
|
57701
|
+
retryable?: boolean;
|
|
57702
|
+
context?: unknown;
|
|
57703
|
+
};
|
|
57704
|
+
};
|
|
57705
|
+
};
|
|
57706
|
+
/** @description Not found */
|
|
57707
|
+
404: {
|
|
57708
|
+
headers: {
|
|
57709
|
+
/** @description Seconds to wait when retryable=true and the server supplies a delay. */
|
|
57710
|
+
"Retry-After"?: number;
|
|
57711
|
+
[name: string]: unknown;
|
|
57712
|
+
};
|
|
57713
|
+
content: {
|
|
57714
|
+
"application/json": {
|
|
57715
|
+
code: string;
|
|
57716
|
+
message: string;
|
|
57717
|
+
links?: {
|
|
57718
|
+
docs: string;
|
|
57719
|
+
schema: string;
|
|
57720
|
+
};
|
|
57721
|
+
issues?: {
|
|
57722
|
+
message: string;
|
|
57723
|
+
path?: (string | number)[];
|
|
57724
|
+
schema?: string;
|
|
57725
|
+
}[];
|
|
57726
|
+
retryable?: boolean;
|
|
57727
|
+
context?: unknown;
|
|
57728
|
+
};
|
|
57729
|
+
};
|
|
57730
|
+
};
|
|
57731
|
+
/** @description Conflict */
|
|
57732
|
+
409: {
|
|
57733
|
+
headers: {
|
|
57734
|
+
/** @description Seconds to wait when retryable=true and the server supplies a delay. */
|
|
57735
|
+
"Retry-After"?: number;
|
|
57736
|
+
[name: string]: unknown;
|
|
57737
|
+
};
|
|
57738
|
+
content: {
|
|
57739
|
+
"application/json": {
|
|
57740
|
+
code: string;
|
|
57741
|
+
message: string;
|
|
57742
|
+
links?: {
|
|
57743
|
+
docs: string;
|
|
57744
|
+
schema: string;
|
|
57745
|
+
};
|
|
57746
|
+
issues?: {
|
|
57747
|
+
message: string;
|
|
57748
|
+
path?: (string | number)[];
|
|
57749
|
+
schema?: string;
|
|
57750
|
+
}[];
|
|
57751
|
+
retryable?: boolean;
|
|
57752
|
+
context?: unknown;
|
|
57753
|
+
};
|
|
57754
|
+
};
|
|
57755
|
+
};
|
|
57756
|
+
/** @description Gone */
|
|
57757
|
+
410: {
|
|
57758
|
+
headers: {
|
|
57759
|
+
/** @description Seconds to wait when retryable=true and the server supplies a delay. */
|
|
57760
|
+
"Retry-After"?: number;
|
|
57761
|
+
[name: string]: unknown;
|
|
57762
|
+
};
|
|
57763
|
+
content: {
|
|
57764
|
+
"application/json": {
|
|
57765
|
+
code: string;
|
|
57766
|
+
message: string;
|
|
57767
|
+
links?: {
|
|
57768
|
+
docs: string;
|
|
57769
|
+
schema: string;
|
|
57770
|
+
};
|
|
57771
|
+
issues?: {
|
|
57772
|
+
message: string;
|
|
57773
|
+
path?: (string | number)[];
|
|
57774
|
+
schema?: string;
|
|
57775
|
+
}[];
|
|
57776
|
+
retryable?: boolean;
|
|
57777
|
+
context?: unknown;
|
|
57778
|
+
};
|
|
57779
|
+
};
|
|
57780
|
+
};
|
|
57781
|
+
/** @description Unprocessable content */
|
|
57782
|
+
422: {
|
|
57783
|
+
headers: {
|
|
57784
|
+
/** @description Seconds to wait when retryable=true and the server supplies a delay. */
|
|
57785
|
+
"Retry-After"?: number;
|
|
57786
|
+
[name: string]: unknown;
|
|
57787
|
+
};
|
|
57788
|
+
content: {
|
|
57789
|
+
"application/json": {
|
|
57790
|
+
code: string;
|
|
57791
|
+
message: string;
|
|
57792
|
+
links?: {
|
|
57793
|
+
docs: string;
|
|
57794
|
+
schema: string;
|
|
57795
|
+
};
|
|
57796
|
+
issues?: {
|
|
57797
|
+
message: string;
|
|
57798
|
+
path?: (string | number)[];
|
|
57799
|
+
schema?: string;
|
|
57800
|
+
}[];
|
|
57801
|
+
retryable?: boolean;
|
|
57802
|
+
context?: unknown;
|
|
57803
|
+
};
|
|
57804
|
+
};
|
|
57805
|
+
};
|
|
57806
|
+
/** @description Internal server error */
|
|
57807
|
+
500: {
|
|
57808
|
+
headers: {
|
|
57809
|
+
/** @description Seconds to wait when retryable=true and the server supplies a delay. */
|
|
57810
|
+
"Retry-After"?: number;
|
|
57811
|
+
[name: string]: unknown;
|
|
57812
|
+
};
|
|
57813
|
+
content: {
|
|
57814
|
+
"application/json": {
|
|
57815
|
+
code: string;
|
|
57816
|
+
message: string;
|
|
57817
|
+
links?: {
|
|
57818
|
+
docs: string;
|
|
57819
|
+
schema: string;
|
|
57820
|
+
};
|
|
57821
|
+
issues?: {
|
|
57822
|
+
message: string;
|
|
57823
|
+
path?: (string | number)[];
|
|
57824
|
+
schema?: string;
|
|
57825
|
+
}[];
|
|
57826
|
+
retryable?: boolean;
|
|
57827
|
+
context?: unknown;
|
|
57828
|
+
};
|
|
57829
|
+
};
|
|
57830
|
+
};
|
|
57831
|
+
/** @description Service unavailable */
|
|
57832
|
+
503: {
|
|
57833
|
+
headers: {
|
|
57834
|
+
/** @description Seconds to wait when retryable=true and the server supplies a delay. */
|
|
57835
|
+
"Retry-After"?: number;
|
|
57836
|
+
[name: string]: unknown;
|
|
57837
|
+
};
|
|
57838
|
+
content: {
|
|
57839
|
+
"application/json": {
|
|
57840
|
+
code: string;
|
|
57841
|
+
message: string;
|
|
57842
|
+
links?: {
|
|
57843
|
+
docs: string;
|
|
57844
|
+
schema: string;
|
|
57845
|
+
};
|
|
57846
|
+
issues?: {
|
|
57847
|
+
message: string;
|
|
57848
|
+
path?: (string | number)[];
|
|
57849
|
+
schema?: string;
|
|
57850
|
+
}[];
|
|
57851
|
+
retryable?: boolean;
|
|
57852
|
+
context?: unknown;
|
|
57853
|
+
};
|
|
57854
|
+
};
|
|
57855
|
+
};
|
|
57856
|
+
};
|
|
57857
|
+
};
|
|
57552
57858
|
getPartnerUsers: {
|
|
57553
57859
|
parameters: {
|
|
57554
57860
|
query?: {
|
|
@@ -61323,6 +61629,11 @@ export interface operations {
|
|
|
61323
61629
|
mode: "create" | "update" | "replace";
|
|
61324
61630
|
/** Format: uuid */
|
|
61325
61631
|
connectionId?: string;
|
|
61632
|
+
/**
|
|
61633
|
+
* @description Plaid environment for a new Item. Defaults to production. Existing reusable credentials retain their stored environment.
|
|
61634
|
+
* @enum {string}
|
|
61635
|
+
*/
|
|
61636
|
+
environment?: "sandbox" | "production";
|
|
61326
61637
|
};
|
|
61327
61638
|
};
|
|
61328
61639
|
};
|