@vrplatform/api 1.3.1-stage.6252 → 1.3.1-stage.6265

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.
@@ -1242,7 +1242,7 @@ export interface paths {
1242
1242
  get?: never;
1243
1243
  put?: never;
1244
1244
  /**
1245
- * @description Send an Owner Portal invite. Team-member account conflicts and provider-suppressed email addresses return bad requests.
1245
+ * @description Send an Owner Portal invite. Existing identity conflicts and provider-suppressed email addresses return bad requests.
1246
1246
  *
1247
1247
  * Required scope: contacts:write
1248
1248
  */
@@ -1310,7 +1310,7 @@ export interface paths {
1310
1310
  get: operations["getContactsByIdViewers"];
1311
1311
  put?: never;
1312
1312
  /**
1313
- * @description Invite an owner viewer. Team-member account conflicts and provider-suppressed email addresses return bad requests.
1313
+ * @description Invite an owner viewer. Existing identity conflicts and provider-suppressed email addresses return bad requests.
1314
1314
  *
1315
1315
  * Required scope: contacts:write
1316
1316
  */
@@ -1352,7 +1352,7 @@ export interface paths {
1352
1352
  get?: never;
1353
1353
  put?: never;
1354
1354
  /**
1355
- * @description Reinvite an owner viewer. Team-member account conflicts and provider-suppressed email addresses return bad requests.
1355
+ * @description Reinvite an owner viewer. Existing identity conflicts and provider-suppressed email addresses return bad requests.
1356
1356
  *
1357
1357
  * Required scope: contacts:write
1358
1358
  */
@@ -2340,7 +2340,7 @@ export interface paths {
2340
2340
  /** @description List users in one regional data partition with their team memberships and owner accesses. Select the partition with x-data-region. */
2341
2341
  get: operations["getInternalUsers"];
2342
2342
  put?: never;
2343
- /** @description Create or update a global platform user by primary or secondary email, optionally granting an initial team membership. Existing identities and current-team membership ids are reused and projected into the selected team region, and returned memberships cover every region. Used by identity and invite workflows. An explicit conflicting user id is rejected as a user error. */
2343
+ /** @description Create or update a global platform user by primary or secondary email, optionally granting an initial team membership. Existing identities and current-team membership ids are reused and projected into the selected team region, and returned memberships cover every region. Used by identity and invite workflows. An explicit conflicting user id is rejected as a bad request with reason USER_EMAIL_CONFLICT. */
2344
2344
  post: operations["postInternalUsers"];
2345
2345
  delete?: never;
2346
2346
  options?: never;
@@ -2356,7 +2356,7 @@ export interface paths {
2356
2356
  cookie?: never;
2357
2357
  };
2358
2358
  get?: never;
2359
- /** @description Update a platform user by id. Used by the identity provider profile-update hooks. A duplicate email belonging to another user is rejected as a user error. */
2359
+ /** @description Update a platform user by id. Used by the identity provider profile-update hooks. A duplicate email belonging to another user is rejected as a bad request with reason USER_EMAIL_CONFLICT. */
2360
2360
  put: operations["putInternalUsersById"];
2361
2361
  post?: never;
2362
2362
  /** @description Delete a platform user and its team memberships/access rows. Used by identity provider and lifecycle cleanup flows. */
@@ -2757,7 +2757,7 @@ export interface paths {
2757
2757
  cookie?: never;
2758
2758
  };
2759
2759
  /**
2760
- * @description List teams available to the authenticated user from the control plane. VRPlatform admins receive all teams regardless of membership. Direct memberships are always included. When UI Permission Roles is enabled for a managed team, partner membership adds that team only when managedTeamAccess is all; assigned access requires a direct child-team membership. Legacy authorization mode retains broad partner-derived team access. Supports comma-separated team IDs, team-name search, lifecycle and type filters, deterministic sorting, and pagination across regions. ID filtering never expands the authenticated access scope.
2760
+ * @description List teams available to the authenticated user from the control plane. VRPlatform admins receive all teams regardless of membership. Direct memberships are always included. With UI Permission Roles enabled, partner membership adds all managed teams in all mode or the explicit partner-managed assignments in assigned mode. Legacy authorization mode retains broad partner-derived team access. Supports comma-separated team IDs, team-name search, lifecycle and type filters, deterministic sorting, and pagination across regions. ID filtering never expands the authenticated access scope.
2761
2761
  *
2762
2762
  * Required scope: self:read
2763
2763
  */
@@ -3395,7 +3395,7 @@ export interface paths {
3395
3395
  put?: never;
3396
3396
  post?: never;
3397
3397
  /**
3398
- * @description Remove a member from the authenticated partner tenant without deleting the underlying user
3398
+ * @description Remove a member from the authenticated partner tenant. With UI permissions enabled, this also revokes partner-managed child-team assignments without deleting the user or genuine direct memberships; legacy mode preserves child-team compatibility memberships.
3399
3399
  *
3400
3400
  * Required scope: team-members:manage
3401
3401
  */
@@ -3414,7 +3414,7 @@ export interface paths {
3414
3414
  };
3415
3415
  get?: never;
3416
3416
  /**
3417
- * @description Update a partner member's managed-team access mode and replace their explicit child-team assignments. Omitted managedTeamAccess preserves the current mode. Listed teams are upserted with the given compatibility role (admin | user), unlisted child-team memberships are removed, and partner/owner memberships are never touched. Assigned access may contain zero teams; all access makes every managed team available while preserving explicit assignments for a later switch back to assigned.
3417
+ * @description Update a partner member's managed-team access. With UI permissions enabled, managedTeamAccess and role-free teamIds atomically replace partner-managed assignments while genuine direct and owner memberships remain untouched. In legacy-role mode, the role-bearing memberships contract remains available.
3418
3418
  *
3419
3419
  * Required scope: partner-memberships:manage
3420
3420
  */
@@ -4903,7 +4903,7 @@ export interface paths {
4903
4903
  get?: never;
4904
4904
  put?: never;
4905
4905
  /**
4906
- * @description Import a historic owner statement with journal entries on the historical ledger; re-posting the same uniqueRef replaces the previous import
4906
+ * @description Import a historic owner statement with journal entries on the historical ledger. Lines can link an existing reservation by reservationId or matchReservationConfirmationCode; re-posting the same uniqueRef replaces the previous import.
4907
4907
  *
4908
4908
  * Required scope: general-ledger:import
4909
4909
  */
@@ -10041,7 +10041,6 @@ export interface operations {
10041
10041
  } | null;
10042
10042
  matchStatus?: string | null;
10043
10043
  appliedAmount?: {
10044
- taxBehavior?: ("excluded" | "included") | null;
10045
10044
  taxRate?: {
10046
10045
  id: string;
10047
10046
  name: string;
@@ -16786,7 +16785,6 @@ export interface operations {
16786
16785
  amount: number;
16787
16786
  appliedAmount?: {
16788
16787
  taxRateId?: string | null;
16789
- taxBehavior?: ("excluded" | "included") | null;
16790
16788
  } | null;
16791
16789
  markup?: {
16792
16790
  amount?: number | null;
@@ -17797,7 +17795,6 @@ export interface operations {
17797
17795
  amount: number;
17798
17796
  appliedAmount?: {
17799
17797
  taxRateId?: string | null;
17800
- taxBehavior?: ("excluded" | "included") | null;
17801
17798
  } | null;
17802
17799
  markup?: {
17803
17800
  amount?: number | null;
@@ -18666,7 +18663,6 @@ export interface operations {
18666
18663
  amount?: number | null;
18667
18664
  assignment?: "deposit_merchantFee" | null;
18668
18665
  party?: ("owners" | "manager") | null;
18669
- taxBehavior?: ("excluded" | "included") | null;
18670
18666
  descriptionOverride?: string | null;
18671
18667
  markup?: {
18672
18668
  amount?: number | null;
@@ -19002,7 +18998,6 @@ export interface operations {
19002
18998
  contactId?: string | null;
19003
18999
  party?: ("owners" | "manager") | null;
19004
19000
  taxRateId?: string | null;
19005
- taxBehavior?: ("excluded" | "included") | null;
19006
19001
  markup?: {
19007
19002
  amount?: number | null;
19008
19003
  taxRateId?: string | null;
@@ -19077,7 +19072,6 @@ export interface operations {
19077
19072
  amount?: number | null;
19078
19073
  assignment?: "deposit_merchantFee" | null;
19079
19074
  party?: ("owners" | "manager") | null;
19080
- taxBehavior?: ("excluded" | "included") | null;
19081
19075
  descriptionOverride?: string | null;
19082
19076
  markup?: {
19083
19077
  amount?: number | null;
@@ -19403,7 +19397,6 @@ export interface operations {
19403
19397
  contactId?: string | null;
19404
19398
  party?: ("owners" | "manager") | null;
19405
19399
  taxRateId?: string | null;
19406
- taxBehavior?: ("excluded" | "included") | null;
19407
19400
  markup?: {
19408
19401
  amount?: number | null;
19409
19402
  taxRateId?: string | null;
@@ -19459,7 +19452,6 @@ export interface operations {
19459
19452
  amount: number;
19460
19453
  appliedAmount?: {
19461
19454
  taxRateId?: string | null;
19462
- taxBehavior?: ("excluded" | "included") | null;
19463
19455
  } | null;
19464
19456
  markup?: {
19465
19457
  amount?: number | null;
@@ -19799,7 +19791,6 @@ export interface operations {
19799
19791
  amount?: number | null;
19800
19792
  assignment?: "deposit_merchantFee" | null;
19801
19793
  party?: ("owners" | "manager") | null;
19802
- taxBehavior?: ("excluded" | "included") | null;
19803
19794
  descriptionOverride?: string | null;
19804
19795
  markup?: {
19805
19796
  amount?: number | null;
@@ -20129,7 +20120,6 @@ export interface operations {
20129
20120
  contactId?: string | null;
20130
20121
  party?: ("owners" | "manager") | null;
20131
20122
  taxRateId?: string | null;
20132
- taxBehavior?: ("excluded" | "included") | null;
20133
20123
  markup?: {
20134
20124
  amount?: number | null;
20135
20125
  taxRateId?: string | null;
@@ -20204,7 +20194,6 @@ export interface operations {
20204
20194
  amount?: number | null;
20205
20195
  assignment?: "deposit_merchantFee" | null;
20206
20196
  party?: ("owners" | "manager") | null;
20207
- taxBehavior?: ("excluded" | "included") | null;
20208
20197
  descriptionOverride?: string | null;
20209
20198
  markup?: {
20210
20199
  amount?: number | null;
@@ -20814,7 +20803,6 @@ export interface operations {
20814
20803
  amount: number;
20815
20804
  appliedAmount?: {
20816
20805
  taxRateId?: string | null;
20817
- taxBehavior?: ("excluded" | "included") | null;
20818
20806
  } | null;
20819
20807
  markup?: {
20820
20808
  amount?: number | null;
@@ -50189,6 +50177,8 @@ export interface operations {
50189
50177
  lastSeen: string | null;
50190
50178
  createdAt: string | null;
50191
50179
  memberships: {
50180
+ /** @enum {string} */
50181
+ accessSource?: "direct" | "partnerManaged";
50192
50182
  /** Format: uuid */
50193
50183
  teamId: string;
50194
50184
  teamName: string;
@@ -67871,6 +67861,8 @@ export interface operations {
67871
67861
  lastName: string | null;
67872
67862
  lastSeen: string | null;
67873
67863
  memberships: {
67864
+ /** @enum {string} */
67865
+ accessSource: "direct" | "partnerManaged";
67874
67866
  tenant: {
67875
67867
  /** Format: uuid */
67876
67868
  id: string;
@@ -68376,18 +68368,15 @@ export interface operations {
68376
68368
  requestBody?: {
68377
68369
  content: {
68378
68370
  "application/json": {
68379
- /**
68380
- * @description Partner-level child-team access mode. Omit to preserve the member's current mode.
68381
- * @enum {string}
68382
- */
68371
+ /** @enum {string} */
68383
68372
  managedTeamAccess?: "all" | "assigned";
68384
- /** @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. */
68385
- memberships: {
68386
- /** Format: uuid */
68387
- teamId: string;
68373
+ memberships?: {
68388
68374
  /** @enum {string} */
68389
68375
  role: "admin" | "user";
68376
+ /** Format: uuid */
68377
+ teamId: string;
68390
68378
  }[];
68379
+ teamIds?: string[];
68391
68380
  };
68392
68381
  };
68393
68382
  };
@@ -68400,6 +68389,8 @@ export interface operations {
68400
68389
  content: {
68401
68390
  "application/json": {
68402
68391
  data: {
68392
+ /** @enum {string} */
68393
+ accessSource?: "direct" | "partnerManaged";
68403
68394
  /** Format: uuid */
68404
68395
  teamId: string;
68405
68396
  teamName: string;
@@ -68967,6 +68958,8 @@ export interface operations {
68967
68958
  lastSeen: string | null;
68968
68959
  createdAt: string | null;
68969
68960
  memberships: {
68961
+ /** @enum {string} */
68962
+ accessSource?: "direct" | "partnerManaged";
68970
68963
  /** Format: uuid */
68971
68964
  teamId: string;
68972
68965
  teamName: string;
@@ -69256,6 +69249,8 @@ export interface operations {
69256
69249
  lastSeen: string | null;
69257
69250
  createdAt: string | null;
69258
69251
  memberships: {
69252
+ /** @enum {string} */
69253
+ accessSource?: "direct" | "partnerManaged";
69259
69254
  /** Format: uuid */
69260
69255
  teamId: string;
69261
69256
  teamName: string;
@@ -69798,6 +69793,8 @@ export interface operations {
69798
69793
  content: {
69799
69794
  "application/json": {
69800
69795
  data: {
69796
+ /** @enum {string} */
69797
+ accessSource?: "direct" | "partnerManaged";
69801
69798
  /** Format: uuid */
69802
69799
  teamId: string;
69803
69800
  teamName: string;
@@ -103626,8 +103623,13 @@ export interface operations {
103626
103623
  description?: string;
103627
103624
  /** @description Posting date; defaults to the day before endAt */
103628
103625
  date?: string;
103629
- /** Format: uuid */
103626
+ /**
103627
+ * Format: uuid
103628
+ * @description Existing reservation UUID to render this line in its row
103629
+ */
103630
103630
  reservationId?: string;
103631
+ /** @description Existing reservation confirmation code on the statement listing; resolves reservationId so all lines with the same code collapse into one reservation row */
103632
+ matchReservationConfirmationCode?: string;
103631
103633
  /** Format: uuid */
103632
103634
  contactId?: string;
103633
103635
  }[];
@@ -106709,7 +106711,6 @@ export interface operations {
106709
106711
  } | null;
106710
106712
  matchStatus?: string | null;
106711
106713
  appliedAmount?: {
106712
- taxBehavior?: ("excluded" | "included") | null;
106713
106714
  taxRate?: {
106714
106715
  id: string;
106715
106716
  name: string;
@@ -119367,10 +119368,8 @@ export interface operations {
119367
119368
  content: {
119368
119369
  "application/json": {
119369
119370
  email: string;
119370
- /**
119371
- * @default user
119372
- * @enum {string}
119373
- */
119371
+ permissionBundles?: ("ui:team-admin:v1" | "ui:partner-admin:v1" | "ui:standard-member:v1" | "ui:operations:v1" | "ui:accounting:v1" | "ui:owner-statements:v1" | "ui:reports-viewer:v1" | "ui:read-only:v1" | "ui:ach-payer:v1")[];
119372
+ /** @enum {string} */
119374
119373
  role?: "admin" | "user";
119375
119374
  /** @default true */
119376
119375
  sendEmail?: boolean;
@@ -119385,7 +119384,14 @@ export interface operations {
119385
119384
  };
119386
119385
  content: {
119387
119386
  "application/json": {
119387
+ permissionBundles: ("ui:team-admin:v1" | "ui:partner-admin:v1" | "ui:standard-member:v1" | "ui:operations:v1" | "ui:accounting:v1" | "ui:owner-statements:v1" | "ui:reports-viewer:v1" | "ui:read-only:v1" | "ui:ach-payer:v1")[];
119388
+ /** @enum {string} */
119389
+ role: "admin" | "user";
119390
+ /** Format: uuid */
119391
+ tenantUserId: string;
119388
119392
  url: string;
119393
+ /** Format: uuid */
119394
+ userId: string;
119389
119395
  };
119390
119396
  };
119391
119397
  };
@@ -124861,7 +124867,6 @@ export interface operations {
124861
124867
  } | null;
124862
124868
  matchStatus?: string | null;
124863
124869
  appliedAmount?: {
124864
- taxBehavior?: ("excluded" | "included") | null;
124865
124870
  taxRate?: {
124866
124871
  id: string;
124867
124872
  name: string;
@@ -125386,7 +125391,6 @@ export interface operations {
125386
125391
  amount: number;
125387
125392
  appliedAmount?: {
125388
125393
  taxRateId?: string | null;
125389
- taxBehavior?: ("excluded" | "included") | null;
125390
125394
  } | null;
125391
125395
  markup?: {
125392
125396
  amount?: number | null;
@@ -125546,7 +125550,6 @@ export interface operations {
125546
125550
  } | null;
125547
125551
  matchStatus?: string | null;
125548
125552
  appliedAmount?: {
125549
- taxBehavior?: ("excluded" | "included") | null;
125550
125553
  taxRate?: {
125551
125554
  id: string;
125552
125555
  name: string;
@@ -127322,7 +127325,6 @@ export interface operations {
127322
127325
  amount: number;
127323
127326
  appliedAmount?: {
127324
127327
  taxRateId?: string | null;
127325
- taxBehavior?: ("excluded" | "included") | null;
127326
127328
  } | null;
127327
127329
  markup?: {
127328
127330
  amount?: number | null;
@@ -129112,7 +129114,6 @@ export interface operations {
129112
129114
  } | null;
129113
129115
  matchStatus?: string | null;
129114
129116
  appliedAmount?: {
129115
- taxBehavior?: ("excluded" | "included") | null;
129116
129117
  taxRate?: {
129117
129118
  id: string;
129118
129119
  name: string;
@@ -129465,6 +129466,9 @@ export interface operations {
129465
129466
  listingId?: string | null;
129466
129467
  party?: ("owners" | "manager") | null;
129467
129468
  contactId?: string | null;
129469
+ appliedAmount?: {
129470
+ taxRateId?: string | null;
129471
+ } | null;
129468
129472
  markup?: {
129469
129473
  amount?: number | null;
129470
129474
  taxRateId?: string | null;
@@ -129594,7 +129598,6 @@ export interface operations {
129594
129598
  } | null;
129595
129599
  matchStatus?: string | null;
129596
129600
  appliedAmount?: {
129597
- taxBehavior?: ("excluded" | "included") | null;
129598
129601
  taxRate?: {
129599
129602
  id: string;
129600
129603
  name: string;
@@ -130293,7 +130296,6 @@ export interface operations {
130293
130296
  } | null;
130294
130297
  matchStatus?: string | null;
130295
130298
  appliedAmount?: {
130296
- taxBehavior?: ("excluded" | "included") | null;
130297
130299
  taxRate?: {
130298
130300
  id: string;
130299
130301
  name: string;
@@ -130638,6 +130640,9 @@ export interface operations {
130638
130640
  listingId?: string | null;
130639
130641
  party?: ("owners" | "manager") | null;
130640
130642
  contactId?: string | null;
130643
+ appliedAmount?: {
130644
+ taxRateId?: string | null;
130645
+ } | null;
130641
130646
  markup?: {
130642
130647
  amount?: number | null;
130643
130648
  taxRateId?: string | null;
@@ -130768,7 +130773,6 @@ export interface operations {
130768
130773
  } | null;
130769
130774
  matchStatus?: string | null;
130770
130775
  appliedAmount?: {
130771
- taxBehavior?: ("excluded" | "included") | null;
130772
130776
  taxRate?: {
130773
130777
  id: string;
130774
130778
  name: string;
@@ -131436,7 +131440,6 @@ export interface operations {
131436
131440
  } | null;
131437
131441
  matchStatus?: string | null;
131438
131442
  appliedAmount?: {
131439
- taxBehavior?: ("excluded" | "included") | null;
131440
131443
  taxRate?: {
131441
131444
  id: string;
131442
131445
  name: string;
@@ -131978,7 +131981,6 @@ export interface operations {
131978
131981
  } | null;
131979
131982
  matchStatus?: string | null;
131980
131983
  appliedAmount?: {
131981
- taxBehavior?: ("excluded" | "included") | null;
131982
131984
  taxRate?: {
131983
131985
  id: string;
131984
131986
  name: string;
@@ -132546,7 +132548,6 @@ export interface operations {
132546
132548
  amount?: number;
132547
132549
  appliedAmount?: {
132548
132550
  taxRateId?: string | null;
132549
- taxBehavior?: ("excluded" | "included") | null;
132550
132551
  } | null;
132551
132552
  markup?: {
132552
132553
  amount?: number | null;
@@ -132581,7 +132582,6 @@ export interface operations {
132581
132582
  amount: number;
132582
132583
  appliedAmount?: {
132583
132584
  taxRateId?: string | null;
132584
- taxBehavior?: ("excluded" | "included") | null;
132585
132585
  } | null;
132586
132586
  markup?: {
132587
132587
  amount?: number | null;
@@ -132616,7 +132616,6 @@ export interface operations {
132616
132616
  amount?: number;
132617
132617
  appliedAmount?: {
132618
132618
  taxRateId?: string | null;
132619
- taxBehavior?: ("excluded" | "included") | null;
132620
132619
  } | null;
132621
132620
  markup?: {
132622
132621
  amount?: number | null;
@@ -132729,7 +132728,6 @@ export interface operations {
132729
132728
  } | null;
132730
132729
  matchStatus?: string | null;
132731
132730
  appliedAmount?: {
132732
- taxBehavior?: ("excluded" | "included") | null;
132733
132731
  taxRate?: {
132734
132732
  id: string;
132735
132733
  name: string;
@@ -134283,7 +134281,6 @@ export interface operations {
134283
134281
  amount?: number;
134284
134282
  appliedAmount?: {
134285
134283
  taxRateId?: string | null;
134286
- taxBehavior?: ("excluded" | "included") | null;
134287
134284
  } | null;
134288
134285
  markup?: {
134289
134286
  amount?: number | null;
@@ -134391,7 +134388,6 @@ export interface operations {
134391
134388
  } | null;
134392
134389
  matchStatus?: string | null;
134393
134390
  appliedAmount?: {
134394
- taxBehavior?: ("excluded" | "included") | null;
134395
134391
  taxRate?: {
134396
134392
  id: string;
134397
134393
  name: string;