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