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

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.
@@ -1626,7 +1626,8 @@ export interface paths {
1626
1626
  path?: never;
1627
1627
  cookie?: never;
1628
1628
  };
1629
- get?: never;
1629
+ /** @description List users in one regional data partition with their team memberships and owner accesses. Select the partition with x-data-region. */
1630
+ get: operations["getInternalUsers"];
1630
1631
  put?: never;
1631
1632
  /** @description Create or update a platform user by email, optionally granting an initial team membership. Used by the identity provider signup hooks. A duplicate email belonging to another user is rejected as a user error. */
1632
1633
  post: operations["postInternalUsers"];
@@ -2314,7 +2315,7 @@ export interface paths {
2314
2315
  path?: never;
2315
2316
  cookie?: never;
2316
2317
  };
2317
- /** @description List members of the partner itself with their child-team memberships */
2318
+ /** @description List members of the partner itself with their partner-team role, status, invitation timestamp, and child-team memberships */
2318
2319
  get: operations["getPartnerMembers"];
2319
2320
  put?: never;
2320
2321
  post?: never;
@@ -2358,6 +2359,23 @@ export interface paths {
2358
2359
  patch?: never;
2359
2360
  trace?: never;
2360
2361
  };
2362
+ "/partner/owner-statements": {
2363
+ parameters: {
2364
+ query?: never;
2365
+ header?: never;
2366
+ path?: never;
2367
+ cookie?: never;
2368
+ };
2369
+ /** @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. */
2370
+ get: operations["getPartnerOwnerStatements"];
2371
+ put?: never;
2372
+ post?: never;
2373
+ delete?: never;
2374
+ options?: never;
2375
+ head?: never;
2376
+ patch?: never;
2377
+ trace?: never;
2378
+ };
2361
2379
  "/partner/users": {
2362
2380
  parameters: {
2363
2381
  query?: never;
@@ -2365,7 +2383,7 @@ export interface paths {
2365
2383
  path?: never;
2366
2384
  cookie?: never;
2367
2385
  };
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. */
2386
+ /** @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
2387
  get: operations["getPartnerUsers"];
2370
2388
  put?: never;
2371
2389
  post?: never;
@@ -2556,7 +2574,7 @@ export interface paths {
2556
2574
  };
2557
2575
  get?: never;
2558
2576
  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 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. */
2577
+ /** @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
2578
  post: operations["createPlaidConnectSession"];
2561
2579
  delete?: never;
2562
2580
  options?: never;
@@ -42507,6 +42525,300 @@ export interface operations {
42507
42525
  };
42508
42526
  };
42509
42527
  };
42528
+ getInternalUsers: {
42529
+ parameters: {
42530
+ query?: {
42531
+ /** @description Filter by email, secondary email, first name, last name, or full name */
42532
+ search?: string;
42533
+ limit?: number;
42534
+ page?: number;
42535
+ offset?: number;
42536
+ };
42537
+ header?: {
42538
+ /** @description Selects the regional data partition for this regional collection read. It does not change the authenticated team context. */
42539
+ "x-data-region"?: "ap" | "crunchy" | "eu" | "hostaway" | "us";
42540
+ };
42541
+ path?: never;
42542
+ cookie?: never;
42543
+ };
42544
+ requestBody?: never;
42545
+ responses: {
42546
+ /** @description Successful response */
42547
+ 200: {
42548
+ headers: {
42549
+ [name: string]: unknown;
42550
+ };
42551
+ content: {
42552
+ "application/json": {
42553
+ data: {
42554
+ /** Format: uuid */
42555
+ id: string;
42556
+ firstName: string | null;
42557
+ lastName: string | null;
42558
+ /** Format: email */
42559
+ email: string;
42560
+ secondaryEmails: string[];
42561
+ /** @description User kind (e.g. user, owner) */
42562
+ type?: string | null;
42563
+ lastSeen: string | null;
42564
+ createdAt: string | null;
42565
+ memberships: {
42566
+ /** Format: uuid */
42567
+ teamId: string;
42568
+ teamName: string;
42569
+ role?: string | null;
42570
+ status?: string | null;
42571
+ lastInvitedAt: string | null;
42572
+ }[];
42573
+ ownerAccesses: {
42574
+ /** Format: uuid */
42575
+ teamId: string;
42576
+ contactId: string | null;
42577
+ ownerId: string | null;
42578
+ role?: string | null;
42579
+ /** @description Owner contact name */
42580
+ name?: string | null;
42581
+ }[];
42582
+ }[];
42583
+ pagination: {
42584
+ /** @default 100 */
42585
+ limit: number;
42586
+ /** @default 1 */
42587
+ page: number;
42588
+ total: number;
42589
+ totalPage: number;
42590
+ nextPage?: number;
42591
+ };
42592
+ };
42593
+ };
42594
+ };
42595
+ /** @description Bad request */
42596
+ 400: {
42597
+ headers: {
42598
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
42599
+ "Retry-After"?: number;
42600
+ [name: string]: unknown;
42601
+ };
42602
+ content: {
42603
+ "application/json": {
42604
+ code: string;
42605
+ message: string;
42606
+ links?: {
42607
+ docs: string;
42608
+ schema: string;
42609
+ };
42610
+ issues?: {
42611
+ message: string;
42612
+ path?: (string | number)[];
42613
+ schema?: string;
42614
+ }[];
42615
+ retryable?: boolean;
42616
+ context?: unknown;
42617
+ };
42618
+ };
42619
+ };
42620
+ /** @description Unauthorized */
42621
+ 401: {
42622
+ headers: {
42623
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
42624
+ "Retry-After"?: number;
42625
+ [name: string]: unknown;
42626
+ };
42627
+ content: {
42628
+ "application/json": {
42629
+ code: string;
42630
+ message: string;
42631
+ links?: {
42632
+ docs: string;
42633
+ schema: string;
42634
+ };
42635
+ issues?: {
42636
+ message: string;
42637
+ path?: (string | number)[];
42638
+ schema?: string;
42639
+ }[];
42640
+ retryable?: boolean;
42641
+ context?: unknown;
42642
+ };
42643
+ };
42644
+ };
42645
+ /** @description Forbidden */
42646
+ 403: {
42647
+ headers: {
42648
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
42649
+ "Retry-After"?: number;
42650
+ [name: string]: unknown;
42651
+ };
42652
+ content: {
42653
+ "application/json": {
42654
+ code: string;
42655
+ message: string;
42656
+ links?: {
42657
+ docs: string;
42658
+ schema: string;
42659
+ };
42660
+ issues?: {
42661
+ message: string;
42662
+ path?: (string | number)[];
42663
+ schema?: string;
42664
+ }[];
42665
+ retryable?: boolean;
42666
+ context?: unknown;
42667
+ };
42668
+ };
42669
+ };
42670
+ /** @description Not found */
42671
+ 404: {
42672
+ headers: {
42673
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
42674
+ "Retry-After"?: number;
42675
+ [name: string]: unknown;
42676
+ };
42677
+ content: {
42678
+ "application/json": {
42679
+ code: string;
42680
+ message: string;
42681
+ links?: {
42682
+ docs: string;
42683
+ schema: string;
42684
+ };
42685
+ issues?: {
42686
+ message: string;
42687
+ path?: (string | number)[];
42688
+ schema?: string;
42689
+ }[];
42690
+ retryable?: boolean;
42691
+ context?: unknown;
42692
+ };
42693
+ };
42694
+ };
42695
+ /** @description Conflict */
42696
+ 409: {
42697
+ headers: {
42698
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
42699
+ "Retry-After"?: number;
42700
+ [name: string]: unknown;
42701
+ };
42702
+ content: {
42703
+ "application/json": {
42704
+ code: string;
42705
+ message: string;
42706
+ links?: {
42707
+ docs: string;
42708
+ schema: string;
42709
+ };
42710
+ issues?: {
42711
+ message: string;
42712
+ path?: (string | number)[];
42713
+ schema?: string;
42714
+ }[];
42715
+ retryable?: boolean;
42716
+ context?: unknown;
42717
+ };
42718
+ };
42719
+ };
42720
+ /** @description Gone */
42721
+ 410: {
42722
+ headers: {
42723
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
42724
+ "Retry-After"?: number;
42725
+ [name: string]: unknown;
42726
+ };
42727
+ content: {
42728
+ "application/json": {
42729
+ code: string;
42730
+ message: string;
42731
+ links?: {
42732
+ docs: string;
42733
+ schema: string;
42734
+ };
42735
+ issues?: {
42736
+ message: string;
42737
+ path?: (string | number)[];
42738
+ schema?: string;
42739
+ }[];
42740
+ retryable?: boolean;
42741
+ context?: unknown;
42742
+ };
42743
+ };
42744
+ };
42745
+ /** @description Unprocessable content */
42746
+ 422: {
42747
+ headers: {
42748
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
42749
+ "Retry-After"?: number;
42750
+ [name: string]: unknown;
42751
+ };
42752
+ content: {
42753
+ "application/json": {
42754
+ code: string;
42755
+ message: string;
42756
+ links?: {
42757
+ docs: string;
42758
+ schema: string;
42759
+ };
42760
+ issues?: {
42761
+ message: string;
42762
+ path?: (string | number)[];
42763
+ schema?: string;
42764
+ }[];
42765
+ retryable?: boolean;
42766
+ context?: unknown;
42767
+ };
42768
+ };
42769
+ };
42770
+ /** @description Internal server error */
42771
+ 500: {
42772
+ headers: {
42773
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
42774
+ "Retry-After"?: number;
42775
+ [name: string]: unknown;
42776
+ };
42777
+ content: {
42778
+ "application/json": {
42779
+ code: string;
42780
+ message: string;
42781
+ links?: {
42782
+ docs: string;
42783
+ schema: string;
42784
+ };
42785
+ issues?: {
42786
+ message: string;
42787
+ path?: (string | number)[];
42788
+ schema?: string;
42789
+ }[];
42790
+ retryable?: boolean;
42791
+ context?: unknown;
42792
+ };
42793
+ };
42794
+ };
42795
+ /** @description Service unavailable */
42796
+ 503: {
42797
+ headers: {
42798
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
42799
+ "Retry-After"?: number;
42800
+ [name: string]: unknown;
42801
+ };
42802
+ content: {
42803
+ "application/json": {
42804
+ code: string;
42805
+ message: string;
42806
+ links?: {
42807
+ docs: string;
42808
+ schema: string;
42809
+ };
42810
+ issues?: {
42811
+ message: string;
42812
+ path?: (string | number)[];
42813
+ schema?: string;
42814
+ }[];
42815
+ retryable?: boolean;
42816
+ context?: unknown;
42817
+ };
42818
+ };
42819
+ };
42820
+ };
42821
+ };
42510
42822
  postInternalUsers: {
42511
42823
  parameters: {
42512
42824
  query?: never;
@@ -55701,14 +56013,290 @@ export interface operations {
55701
56013
  };
55702
56014
  };
55703
56015
  };
55704
- getSyncMetricsByStatus: {
56016
+ getSyncMetricsByStatus: {
56017
+ parameters: {
56018
+ query: {
56019
+ interval?: "month" | "week" | "day" | "year";
56020
+ /** @description Deprecated: use interval */
56021
+ dimension?: "month" | "week" | "day" | "year";
56022
+ connectionId: string;
56023
+ view: "automate" | "extract";
56024
+ /** @description Date range string. Accepted syntax: `YYYY`, `YYYY-MM`, `YYYY-MM-DD`, or range `YYYY-MM-DD...YYYY-MM-DD`. Single values expand to the full year, month, or day. */
56025
+ dateRange?: string;
56026
+ /** @description Whether the end date in `dateRange` or `paidAtRange` is treated as inclusive (`true`) or exclusive (`false`). */
56027
+ isDateRangeEndInclusive?: boolean;
56028
+ };
56029
+ header?: never;
56030
+ path?: never;
56031
+ cookie?: never;
56032
+ };
56033
+ requestBody?: never;
56034
+ responses: {
56035
+ /** @description Successful response */
56036
+ 200: {
56037
+ headers: {
56038
+ [name: string]: unknown;
56039
+ };
56040
+ content: {
56041
+ "application/json": {
56042
+ data: {
56043
+ date: string;
56044
+ total: number;
56045
+ changes: {
56046
+ completed?: {
56047
+ [key: string]: number;
56048
+ };
56049
+ skipped?: {
56050
+ [key: string]: number;
56051
+ };
56052
+ failed?: {
56053
+ [key: string]: number;
56054
+ };
56055
+ queued?: {
56056
+ [key: string]: number;
56057
+ };
56058
+ };
56059
+ }[];
56060
+ };
56061
+ };
56062
+ };
56063
+ /** @description Bad request */
56064
+ 400: {
56065
+ headers: {
56066
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
56067
+ "Retry-After"?: number;
56068
+ [name: string]: unknown;
56069
+ };
56070
+ content: {
56071
+ "application/json": {
56072
+ code: string;
56073
+ message: string;
56074
+ links?: {
56075
+ docs: string;
56076
+ schema: string;
56077
+ };
56078
+ issues?: {
56079
+ message: string;
56080
+ path?: (string | number)[];
56081
+ schema?: string;
56082
+ }[];
56083
+ retryable?: boolean;
56084
+ context?: unknown;
56085
+ };
56086
+ };
56087
+ };
56088
+ /** @description Unauthorized */
56089
+ 401: {
56090
+ headers: {
56091
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
56092
+ "Retry-After"?: number;
56093
+ [name: string]: unknown;
56094
+ };
56095
+ content: {
56096
+ "application/json": {
56097
+ code: string;
56098
+ message: string;
56099
+ links?: {
56100
+ docs: string;
56101
+ schema: string;
56102
+ };
56103
+ issues?: {
56104
+ message: string;
56105
+ path?: (string | number)[];
56106
+ schema?: string;
56107
+ }[];
56108
+ retryable?: boolean;
56109
+ context?: unknown;
56110
+ };
56111
+ };
56112
+ };
56113
+ /** @description Forbidden */
56114
+ 403: {
56115
+ headers: {
56116
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
56117
+ "Retry-After"?: number;
56118
+ [name: string]: unknown;
56119
+ };
56120
+ content: {
56121
+ "application/json": {
56122
+ code: string;
56123
+ message: string;
56124
+ links?: {
56125
+ docs: string;
56126
+ schema: string;
56127
+ };
56128
+ issues?: {
56129
+ message: string;
56130
+ path?: (string | number)[];
56131
+ schema?: string;
56132
+ }[];
56133
+ retryable?: boolean;
56134
+ context?: unknown;
56135
+ };
56136
+ };
56137
+ };
56138
+ /** @description Not found */
56139
+ 404: {
56140
+ headers: {
56141
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
56142
+ "Retry-After"?: number;
56143
+ [name: string]: unknown;
56144
+ };
56145
+ content: {
56146
+ "application/json": {
56147
+ code: string;
56148
+ message: string;
56149
+ links?: {
56150
+ docs: string;
56151
+ schema: string;
56152
+ };
56153
+ issues?: {
56154
+ message: string;
56155
+ path?: (string | number)[];
56156
+ schema?: string;
56157
+ }[];
56158
+ retryable?: boolean;
56159
+ context?: unknown;
56160
+ };
56161
+ };
56162
+ };
56163
+ /** @description Conflict */
56164
+ 409: {
56165
+ headers: {
56166
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
56167
+ "Retry-After"?: number;
56168
+ [name: string]: unknown;
56169
+ };
56170
+ content: {
56171
+ "application/json": {
56172
+ code: string;
56173
+ message: string;
56174
+ links?: {
56175
+ docs: string;
56176
+ schema: string;
56177
+ };
56178
+ issues?: {
56179
+ message: string;
56180
+ path?: (string | number)[];
56181
+ schema?: string;
56182
+ }[];
56183
+ retryable?: boolean;
56184
+ context?: unknown;
56185
+ };
56186
+ };
56187
+ };
56188
+ /** @description Gone */
56189
+ 410: {
56190
+ headers: {
56191
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
56192
+ "Retry-After"?: number;
56193
+ [name: string]: unknown;
56194
+ };
56195
+ content: {
56196
+ "application/json": {
56197
+ code: string;
56198
+ message: string;
56199
+ links?: {
56200
+ docs: string;
56201
+ schema: string;
56202
+ };
56203
+ issues?: {
56204
+ message: string;
56205
+ path?: (string | number)[];
56206
+ schema?: string;
56207
+ }[];
56208
+ retryable?: boolean;
56209
+ context?: unknown;
56210
+ };
56211
+ };
56212
+ };
56213
+ /** @description Unprocessable content */
56214
+ 422: {
56215
+ headers: {
56216
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
56217
+ "Retry-After"?: number;
56218
+ [name: string]: unknown;
56219
+ };
56220
+ content: {
56221
+ "application/json": {
56222
+ code: string;
56223
+ message: string;
56224
+ links?: {
56225
+ docs: string;
56226
+ schema: string;
56227
+ };
56228
+ issues?: {
56229
+ message: string;
56230
+ path?: (string | number)[];
56231
+ schema?: string;
56232
+ }[];
56233
+ retryable?: boolean;
56234
+ context?: unknown;
56235
+ };
56236
+ };
56237
+ };
56238
+ /** @description Internal server error */
56239
+ 500: {
56240
+ headers: {
56241
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
56242
+ "Retry-After"?: number;
56243
+ [name: string]: unknown;
56244
+ };
56245
+ content: {
56246
+ "application/json": {
56247
+ code: string;
56248
+ message: string;
56249
+ links?: {
56250
+ docs: string;
56251
+ schema: string;
56252
+ };
56253
+ issues?: {
56254
+ message: string;
56255
+ path?: (string | number)[];
56256
+ schema?: string;
56257
+ }[];
56258
+ retryable?: boolean;
56259
+ context?: unknown;
56260
+ };
56261
+ };
56262
+ };
56263
+ /** @description Service unavailable */
56264
+ 503: {
56265
+ headers: {
56266
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
56267
+ "Retry-After"?: number;
56268
+ [name: string]: unknown;
56269
+ };
56270
+ content: {
56271
+ "application/json": {
56272
+ code: string;
56273
+ message: string;
56274
+ links?: {
56275
+ docs: string;
56276
+ schema: string;
56277
+ };
56278
+ issues?: {
56279
+ message: string;
56280
+ path?: (string | number)[];
56281
+ schema?: string;
56282
+ }[];
56283
+ retryable?: boolean;
56284
+ context?: unknown;
56285
+ };
56286
+ };
56287
+ };
56288
+ };
56289
+ };
56290
+ getMetricTakeRate: {
55705
56291
  parameters: {
55706
- query: {
56292
+ query?: {
55707
56293
  interval?: "month" | "week" | "day" | "year";
55708
56294
  /** @description Deprecated: use interval */
55709
56295
  dimension?: "month" | "week" | "day" | "year";
55710
- connectionId: string;
55711
- view: "automate" | "extract";
56296
+ /** @description Date boundary string. Accepted syntax: `YYYY`, `YYYY-MM`, or `YYYY-MM-DD`. Deprecated: use dateRange instead. */
56297
+ startDate?: string;
56298
+ /** @description Date boundary string. Accepted syntax: `YYYY`, `YYYY-MM`, or `YYYY-MM-DD`. Deprecated: use dateRange instead. */
56299
+ endDate?: string;
55712
56300
  /** @description Date range string. Accepted syntax: `YYYY`, `YYYY-MM`, `YYYY-MM-DD`, or range `YYYY-MM-DD...YYYY-MM-DD`. Single values expand to the full year, month, or day. */
55713
56301
  dateRange?: string;
55714
56302
  /** @description Whether the end date in `dateRange` or `paidAtRange` is treated as inclusive (`true`) or exclusive (`false`). */
@@ -55729,21 +56317,9 @@ export interface operations {
55729
56317
  "application/json": {
55730
56318
  data: {
55731
56319
  date: string;
55732
- total: number;
55733
- changes: {
55734
- completed?: {
55735
- [key: string]: number;
55736
- };
55737
- skipped?: {
55738
- [key: string]: number;
55739
- };
55740
- failed?: {
55741
- [key: string]: number;
55742
- };
55743
- queued?: {
55744
- [key: string]: number;
55745
- };
55746
- };
56320
+ grossGuestRevenue: number;
56321
+ pmRevenue: number;
56322
+ takeRate: number;
55747
56323
  }[];
55748
56324
  };
55749
56325
  };
@@ -55975,21 +56551,9 @@ export interface operations {
55975
56551
  };
55976
56552
  };
55977
56553
  };
55978
- getMetricTakeRate: {
56554
+ getPartner: {
55979
56555
  parameters: {
55980
- query?: {
55981
- interval?: "month" | "week" | "day" | "year";
55982
- /** @description Deprecated: use interval */
55983
- dimension?: "month" | "week" | "day" | "year";
55984
- /** @description Date boundary string. Accepted syntax: `YYYY`, `YYYY-MM`, or `YYYY-MM-DD`. Deprecated: use dateRange instead. */
55985
- startDate?: string;
55986
- /** @description Date boundary string. Accepted syntax: `YYYY`, `YYYY-MM`, or `YYYY-MM-DD`. Deprecated: use dateRange instead. */
55987
- endDate?: string;
55988
- /** @description Date range string. Accepted syntax: `YYYY`, `YYYY-MM`, `YYYY-MM-DD`, or range `YYYY-MM-DD...YYYY-MM-DD`. Single values expand to the full year, month, or day. */
55989
- dateRange?: string;
55990
- /** @description Whether the end date in `dateRange` or `paidAtRange` is treated as inclusive (`true`) or exclusive (`false`). */
55991
- isDateRangeEndInclusive?: boolean;
55992
- };
56556
+ query?: never;
55993
56557
  header?: never;
55994
56558
  path?: never;
55995
56559
  cookie?: never;
@@ -56003,12 +56567,11 @@ export interface operations {
56003
56567
  };
56004
56568
  content: {
56005
56569
  "application/json": {
56006
- data: {
56007
- date: string;
56008
- grossGuestRevenue: number;
56009
- pmRevenue: number;
56010
- takeRate: number;
56011
- }[];
56570
+ /** Format: uuid */
56571
+ id: string;
56572
+ name: string;
56573
+ /** @constant */
56574
+ type: "partner";
56012
56575
  };
56013
56576
  };
56014
56577
  };
@@ -56239,14 +56802,34 @@ export interface operations {
56239
56802
  };
56240
56803
  };
56241
56804
  };
56242
- getPartner: {
56805
+ createEmbedSession: {
56243
56806
  parameters: {
56244
- query?: never;
56807
+ query?: {
56808
+ /** @description Create the embedded user and team membership on first use instead of failing when they do not exist. */
56809
+ autoProvision?: boolean;
56810
+ };
56245
56811
  header?: never;
56246
56812
  path?: never;
56247
56813
  cookie?: never;
56248
56814
  };
56249
- requestBody?: never;
56815
+ requestBody?: {
56816
+ content: {
56817
+ "application/json": {
56818
+ sub: string;
56819
+ /**
56820
+ * Format: uuid
56821
+ * @description The team to bind the embedded session to.
56822
+ */
56823
+ teamId?: string;
56824
+ /**
56825
+ * Format: uuid
56826
+ * @description Deprecated: use teamId
56827
+ */
56828
+ tenantId?: string;
56829
+ ttlMinutes?: number;
56830
+ };
56831
+ };
56832
+ };
56250
56833
  responses: {
56251
56834
  /** @description Successful response */
56252
56835
  200: {
@@ -56255,11 +56838,12 @@ export interface operations {
56255
56838
  };
56256
56839
  content: {
56257
56840
  "application/json": {
56841
+ accessToken: string;
56842
+ expiresAt: string;
56258
56843
  /** Format: uuid */
56259
- id: string;
56260
- name: string;
56261
- /** @constant */
56262
- type: "partner";
56844
+ teamId: string;
56845
+ /** Format: uuid */
56846
+ userId: string;
56263
56847
  };
56264
56848
  };
56265
56849
  };
@@ -56490,34 +57074,14 @@ export interface operations {
56490
57074
  };
56491
57075
  };
56492
57076
  };
56493
- createEmbedSession: {
57077
+ getPartnerMembers: {
56494
57078
  parameters: {
56495
- query?: {
56496
- /** @description Create the embedded user and team membership on first use instead of failing when they do not exist. */
56497
- autoProvision?: boolean;
56498
- };
57079
+ query?: never;
56499
57080
  header?: never;
56500
57081
  path?: never;
56501
57082
  cookie?: never;
56502
57083
  };
56503
- requestBody?: {
56504
- content: {
56505
- "application/json": {
56506
- sub: string;
56507
- /**
56508
- * Format: uuid
56509
- * @description The team to bind the embedded session to.
56510
- */
56511
- teamId?: string;
56512
- /**
56513
- * Format: uuid
56514
- * @description Deprecated: use teamId
56515
- */
56516
- tenantId?: string;
56517
- ttlMinutes?: number;
56518
- };
56519
- };
56520
- };
57084
+ requestBody?: never;
56521
57085
  responses: {
56522
57086
  /** @description Successful response */
56523
57087
  200: {
@@ -56526,12 +57090,32 @@ export interface operations {
56526
57090
  };
56527
57091
  content: {
56528
57092
  "application/json": {
56529
- accessToken: string;
56530
- expiresAt: string;
56531
- /** Format: uuid */
56532
- teamId: string;
56533
- /** Format: uuid */
56534
- userId: string;
57093
+ data: {
57094
+ /** Format: uuid */
57095
+ id: string;
57096
+ /** Format: email */
57097
+ email: string;
57098
+ secondaryEmails: string[];
57099
+ /** @enum {string} */
57100
+ role: "admin" | "user";
57101
+ status: ("active" | "inactive" | "unconfirmed") | null;
57102
+ lastInvitedAt: string | null;
57103
+ partnerId: string | null;
57104
+ name: string | null;
57105
+ firstName: string | null;
57106
+ lastName: string | null;
57107
+ lastSeen: string | null;
57108
+ memberships: {
57109
+ tenant: {
57110
+ /** Format: uuid */
57111
+ id: string;
57112
+ name: string;
57113
+ };
57114
+ role?: string | null;
57115
+ status?: string | null;
57116
+ lastInvitedAt: string | null;
57117
+ }[];
57118
+ }[];
56535
57119
  };
56536
57120
  };
56537
57121
  };
@@ -56762,11 +57346,13 @@ export interface operations {
56762
57346
  };
56763
57347
  };
56764
57348
  };
56765
- getPartnerMembers: {
57349
+ deletePartnerMember: {
56766
57350
  parameters: {
56767
57351
  query?: never;
56768
57352
  header?: never;
56769
- path?: never;
57353
+ path: {
57354
+ userId: string;
57355
+ };
56770
57356
  cookie?: never;
56771
57357
  };
56772
57358
  requestBody?: never;
@@ -56778,28 +57364,10 @@ export interface operations {
56778
57364
  };
56779
57365
  content: {
56780
57366
  "application/json": {
56781
- data: {
56782
- /** Format: uuid */
56783
- id: string;
56784
- /** Format: email */
56785
- email: string;
56786
- secondaryEmails: string[];
56787
- partnerId: string | null;
56788
- name: string | null;
56789
- firstName: string | null;
56790
- lastName: string | null;
56791
- lastSeen: string | null;
56792
- memberships: {
56793
- tenant: {
56794
- /** Format: uuid */
56795
- id: string;
56796
- name: string;
56797
- };
56798
- role?: string | null;
56799
- status?: string | null;
56800
- lastInvitedAt: string | null;
56801
- }[];
56802
- }[];
57367
+ /** @enum {string} */
57368
+ status: "deleted";
57369
+ /** @description Deprecated: use status */
57370
+ deleted: boolean;
56803
57371
  };
56804
57372
  };
56805
57373
  };
@@ -57030,7 +57598,7 @@ export interface operations {
57030
57598
  };
57031
57599
  };
57032
57600
  };
57033
- deletePartnerMember: {
57601
+ updatePartnerMemberMemberships: {
57034
57602
  parameters: {
57035
57603
  query?: never;
57036
57604
  header?: never;
@@ -57039,7 +57607,19 @@ export interface operations {
57039
57607
  };
57040
57608
  cookie?: never;
57041
57609
  };
57042
- requestBody?: never;
57610
+ requestBody?: {
57611
+ content: {
57612
+ "application/json": {
57613
+ /** @description Replace semantics across the partner CHILD teams: listed teams are upserted with the given role, unlisted child-team memberships are removed. The partner-tenant membership itself and owner-role memberships are never touched. */
57614
+ memberships: {
57615
+ /** Format: uuid */
57616
+ teamId: string;
57617
+ /** @enum {string} */
57618
+ role: "admin" | "user";
57619
+ }[];
57620
+ };
57621
+ };
57622
+ };
57043
57623
  responses: {
57044
57624
  /** @description Successful response */
57045
57625
  200: {
@@ -57048,10 +57628,13 @@ export interface operations {
57048
57628
  };
57049
57629
  content: {
57050
57630
  "application/json": {
57051
- /** @enum {string} */
57052
- status: "deleted";
57053
- /** @description Deprecated: use status */
57054
- deleted: boolean;
57631
+ data: {
57632
+ /** Format: uuid */
57633
+ teamId: string;
57634
+ teamName: string;
57635
+ role?: string | null;
57636
+ status?: string | null;
57637
+ }[];
57055
57638
  };
57056
57639
  };
57057
57640
  };
@@ -57282,28 +57865,27 @@ export interface operations {
57282
57865
  };
57283
57866
  };
57284
57867
  };
57285
- updatePartnerMemberMemberships: {
57868
+ getPartnerOwnerStatements: {
57286
57869
  parameters: {
57287
- query?: never;
57288
- header?: never;
57289
- path: {
57290
- userId: string;
57870
+ query?: {
57871
+ /** @description Filter by team name */
57872
+ search?: string;
57873
+ /** @description Owner statement status count to sort by */
57874
+ sortBy?: "draft" | "inReview" | "published";
57875
+ /** @description Sort direction, defaults to asc */
57876
+ sortDirection?: "asc" | "desc";
57877
+ limit?: number;
57878
+ page?: number;
57879
+ offset?: number;
57291
57880
  };
57292
- cookie?: never;
57293
- };
57294
- requestBody?: {
57295
- content: {
57296
- "application/json": {
57297
- /** @description Replace semantics across the partner CHILD teams: listed teams are upserted with the given role, unlisted child-team memberships are removed. The partner-tenant membership itself and owner-role memberships are never touched. */
57298
- memberships: {
57299
- /** Format: uuid */
57300
- teamId: string;
57301
- /** @enum {string} */
57302
- role: "admin" | "user";
57303
- }[];
57304
- };
57881
+ header?: {
57882
+ /** @description Selects the regional data partition for this regional collection read. It does not change the authenticated team context. */
57883
+ "x-data-region"?: "ap" | "crunchy" | "eu" | "hostaway" | "us";
57305
57884
  };
57885
+ path?: never;
57886
+ cookie?: never;
57306
57887
  };
57888
+ requestBody?: never;
57307
57889
  responses: {
57308
57890
  /** @description Successful response */
57309
57891
  200: {
@@ -57314,11 +57896,30 @@ export interface operations {
57314
57896
  "application/json": {
57315
57897
  data: {
57316
57898
  /** Format: uuid */
57317
- teamId: string;
57318
- teamName: string;
57319
- role?: string | null;
57320
- status?: string | null;
57899
+ id: string;
57900
+ name: string;
57901
+ logo?: string;
57902
+ /**
57903
+ * Format: date-time
57904
+ * @description Timestamp string with date, time, milliseconds, and timezone.
57905
+ * @example 2024-01-15T12:30:00.000+00:00
57906
+ */
57907
+ createdAt: string;
57908
+ ownerStatements: {
57909
+ draft: number;
57910
+ inReview: number;
57911
+ published: number;
57912
+ };
57321
57913
  }[];
57914
+ pagination: {
57915
+ /** @default 100 */
57916
+ limit: number;
57917
+ /** @default 1 */
57918
+ page: number;
57919
+ total: number;
57920
+ totalPage: number;
57921
+ nextPage?: number;
57922
+ };
57322
57923
  };
57323
57924
  };
57324
57925
  };
@@ -57569,7 +58170,7 @@ export interface operations {
57569
58170
  offset?: number;
57570
58171
  };
57571
58172
  header?: {
57572
- /** @description Selects the regional data partition for this partner portfolio read. It does not change the authenticated team context. */
58173
+ /** @description Selects the regional data partition for this regional collection read. It does not change the authenticated team context. */
57573
58174
  "x-data-region"?: "ap" | "crunchy" | "eu" | "hostaway" | "us";
57574
58175
  };
57575
58176
  path?: never;
@@ -57857,7 +58458,7 @@ export interface operations {
57857
58458
  parameters: {
57858
58459
  query?: never;
57859
58460
  header?: {
57860
- /** @description Selects the regional data partition for this partner portfolio read. It does not change the authenticated team context. */
58461
+ /** @description Selects the regional data partition for this regional collection read. It does not change the authenticated team context. */
57861
58462
  "x-data-region"?: "ap" | "crunchy" | "eu" | "hostaway" | "us";
57862
58463
  };
57863
58464
  path: {
@@ -61323,6 +61924,11 @@ export interface operations {
61323
61924
  mode: "create" | "update" | "replace";
61324
61925
  /** Format: uuid */
61325
61926
  connectionId?: string;
61927
+ /**
61928
+ * @description Plaid environment for a new Item. Defaults to production. Existing reusable credentials retain their stored environment.
61929
+ * @enum {string}
61930
+ */
61931
+ environment?: "sandbox" | "production";
61326
61932
  };
61327
61933
  };
61328
61934
  };
@@ -110315,7 +110921,7 @@ export interface operations {
110315
110921
  offset?: number;
110316
110922
  };
110317
110923
  header?: {
110318
- /** @description Selects the regional data partition for this partner portfolio read. It does not change the authenticated team context. */
110924
+ /** @description Selects the regional data partition for this regional collection read. It does not change the authenticated team context. */
110319
110925
  "x-data-region"?: "ap" | "crunchy" | "eu" | "hostaway" | "us";
110320
110926
  };
110321
110927
  path?: never;
@@ -111206,7 +111812,7 @@ export interface operations {
111206
111812
  cursor?: string;
111207
111813
  };
111208
111814
  header?: {
111209
- /** @description Selects the regional data partition for this partner portfolio read. It does not change the authenticated team context. */
111815
+ /** @description Selects the regional data partition for this regional collection read. It does not change the authenticated team context. */
111210
111816
  "x-data-region"?: "ap" | "crunchy" | "eu" | "hostaway" | "us";
111211
111817
  };
111212
111818
  path?: never;
@@ -112154,7 +112760,7 @@ export interface operations {
112154
112760
  offset?: number;
112155
112761
  };
112156
112762
  header?: {
112157
- /** @description Selects the regional data partition for this partner portfolio read. It does not change the authenticated team context. */
112763
+ /** @description Selects the regional data partition for this regional collection read. It does not change the authenticated team context. */
112158
112764
  "x-data-region"?: "ap" | "crunchy" | "eu" | "hostaway" | "us";
112159
112765
  };
112160
112766
  path?: never;