@vrplatform/api 1.3.1-stage.6173 → 1.3.1-stage.6184
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.
|
@@ -996,7 +996,7 @@ export interface paths {
|
|
|
996
996
|
get?: never;
|
|
997
997
|
put?: never;
|
|
998
998
|
/**
|
|
999
|
-
* @description Import a CSV after validating its importer against canonical app capabilities
|
|
999
|
+
* @description Import a CSV after validating its importer against canonical app capabilities. Mapped bank records require the reviewed preview, upload, and bank account; confirmation is rejected if the account beginning-balance date changed after preview.
|
|
1000
1000
|
*
|
|
1001
1001
|
* Required scope: integrations:import
|
|
1002
1002
|
*/
|
|
@@ -1017,7 +1017,7 @@ export interface paths {
|
|
|
1017
1017
|
get?: never;
|
|
1018
1018
|
put?: never;
|
|
1019
1019
|
/**
|
|
1020
|
-
* @description Start a bank-record CSV preview from this Connection's upload reference
|
|
1020
|
+
* @description Start a bank-record CSV preview for a tenant-scoped bank account from this Connection's upload reference. Rows before the account's beginning-balance date are returned as system exclusions.
|
|
1021
1021
|
*
|
|
1022
1022
|
* Required scope: integrations:import
|
|
1023
1023
|
*/
|
|
@@ -2684,7 +2684,7 @@ export interface paths {
|
|
|
2684
2684
|
cookie?: never;
|
|
2685
2685
|
};
|
|
2686
2686
|
/**
|
|
2687
|
-
* @description UI bootstrap call: the authenticated user plus the resolved team (embedded-session team, x-team-id header, or the oldest active membership), including placement, partner managed-team region discovery, membership, owner access, effective feature IDs, issue counts, and frontend setup context. Embedded identities use sub instead of email, so user.email is null for them.
|
|
2687
|
+
* @description UI bootstrap call: the authenticated user plus the resolved team (embedded-session team, x-team-id header, or the oldest active membership), including placement, partner managed-team region discovery, membership accessSource (direct or partnerDerived), effective permissions, owner access, effective feature IDs, issue counts, and frontend setup context. Embedded identities use sub instead of email, so user.email is null for them.
|
|
2688
2688
|
*
|
|
2689
2689
|
* Required scope: self:read
|
|
2690
2690
|
*/
|
|
@@ -2736,7 +2736,7 @@ export interface paths {
|
|
|
2736
2736
|
cookie?: never;
|
|
2737
2737
|
};
|
|
2738
2738
|
/**
|
|
2739
|
-
* @description List teams available to the authenticated user from the control plane. VRPlatform admins receive all teams regardless of membership.
|
|
2739
|
+
* @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.
|
|
2740
2740
|
*
|
|
2741
2741
|
* Required scope: self:read
|
|
2742
2742
|
*/
|
|
@@ -3350,7 +3350,7 @@ export interface paths {
|
|
|
3350
3350
|
cookie?: never;
|
|
3351
3351
|
};
|
|
3352
3352
|
/**
|
|
3353
|
-
* @description List members of the partner itself with
|
|
3353
|
+
* @description List members of the partner itself with partner permission bundles, managed-team access mode, role, status, invitation timestamp, and child-team memberships including their permission bundles
|
|
3354
3354
|
*
|
|
3355
3355
|
* Required scope: team-members:read
|
|
3356
3356
|
*/
|
|
@@ -3393,7 +3393,7 @@ export interface paths {
|
|
|
3393
3393
|
};
|
|
3394
3394
|
get?: never;
|
|
3395
3395
|
/**
|
|
3396
|
-
* @description
|
|
3396
|
+
* @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.
|
|
3397
3397
|
*
|
|
3398
3398
|
* Required scope: partner-memberships:manage
|
|
3399
3399
|
*/
|
|
@@ -5569,7 +5569,7 @@ export interface paths {
|
|
|
5569
5569
|
get?: never;
|
|
5570
5570
|
put?: never;
|
|
5571
5571
|
/**
|
|
5572
|
-
* @description Invite a property-manager member to the current team. Emails already used by owner accounts are rejected as bad requests. Provider-suppressed email addresses are rejected as bad requests with a copy-link alternative.
|
|
5572
|
+
* @description Invite a property-manager member to the current team. Re-inviting an existing membership with the same role preserves its complete permissionBundles array. Requesting a different role replaces the complete permissionBundles array with the compatibility defaults. The authoritative membership and authorization cache update before retryable email delivery begins. A delivery failure returns an error without rolling back the committed membership change. Emails already used by owner accounts are rejected as bad requests. Provider-suppressed email addresses are rejected as bad requests with a copy-link alternative.
|
|
5573
5573
|
*
|
|
5574
5574
|
* Required scope: team-members:manage
|
|
5575
5575
|
*/
|
|
@@ -5589,7 +5589,7 @@ export interface paths {
|
|
|
5589
5589
|
};
|
|
5590
5590
|
get?: never;
|
|
5591
5591
|
/**
|
|
5592
|
-
* @description Update a property-manager member legacy role and synchronized permission bundles for the current team. UI Permission Roles prevents demoting the last direct access manager.
|
|
5592
|
+
* @description Update a property-manager member legacy role and synchronized permission bundles for the current team. Submitting the member's existing role preserves the complete permissionBundles array. Changing the role replaces the complete permissionBundles array with the compatibility defaults. UI Permission Roles prevents demoting the last direct access manager.
|
|
5593
5593
|
*
|
|
5594
5594
|
* Required scope: team-member-roles:manage
|
|
5595
5595
|
*/
|
|
@@ -25767,6 +25767,10 @@ export interface operations {
|
|
|
25767
25767
|
fileUri?: string;
|
|
25768
25768
|
fileName?: string;
|
|
25769
25769
|
uploadRef?: string;
|
|
25770
|
+
/** Format: uuid */
|
|
25771
|
+
accountId?: string;
|
|
25772
|
+
/** Format: uuid */
|
|
25773
|
+
previewId?: string;
|
|
25770
25774
|
uniqueRef: string;
|
|
25771
25775
|
params?: {
|
|
25772
25776
|
[key: string]: unknown;
|
|
@@ -26071,6 +26075,8 @@ export interface operations {
|
|
|
26071
26075
|
requestBody?: {
|
|
26072
26076
|
content: {
|
|
26073
26077
|
"application/json": {
|
|
26078
|
+
/** Format: uuid */
|
|
26079
|
+
accountId: string;
|
|
26074
26080
|
uploadRef: string;
|
|
26075
26081
|
mapping?: {
|
|
26076
26082
|
/** @constant */
|
|
@@ -26177,7 +26183,13 @@ export interface operations {
|
|
|
26177
26183
|
Description: string;
|
|
26178
26184
|
Amount: number;
|
|
26179
26185
|
} | null;
|
|
26186
|
+
systemExclusion?: {
|
|
26187
|
+
/** @constant */
|
|
26188
|
+
code: "beforeBankRecordStartDate";
|
|
26189
|
+
bankRecordStartDate: string;
|
|
26190
|
+
};
|
|
26180
26191
|
}[];
|
|
26192
|
+
sampleRowsTruncated: boolean;
|
|
26181
26193
|
sourceHash: string;
|
|
26182
26194
|
totals: {
|
|
26183
26195
|
rows: number;
|
|
@@ -26513,7 +26525,13 @@ export interface operations {
|
|
|
26513
26525
|
Description: string;
|
|
26514
26526
|
Amount: number;
|
|
26515
26527
|
} | null;
|
|
26528
|
+
systemExclusion?: {
|
|
26529
|
+
/** @constant */
|
|
26530
|
+
code: "beforeBankRecordStartDate";
|
|
26531
|
+
bankRecordStartDate: string;
|
|
26532
|
+
};
|
|
26516
26533
|
}[];
|
|
26534
|
+
sampleRowsTruncated: boolean;
|
|
26517
26535
|
sourceHash: string;
|
|
26518
26536
|
totals: {
|
|
26519
26537
|
rows: number;
|
|
@@ -50171,6 +50189,8 @@ export interface operations {
|
|
|
50171
50189
|
membership?: {
|
|
50172
50190
|
/** Format: uuid */
|
|
50173
50191
|
tenantId: string;
|
|
50192
|
+
/** @enum {string} */
|
|
50193
|
+
managedTeamAccess?: "all" | "assigned";
|
|
50174
50194
|
/**
|
|
50175
50195
|
* @default user
|
|
50176
50196
|
* @enum {string}
|
|
@@ -50454,6 +50474,8 @@ export interface operations {
|
|
|
50454
50474
|
membership?: {
|
|
50455
50475
|
/** Format: uuid */
|
|
50456
50476
|
tenantId: string;
|
|
50477
|
+
/** @enum {string} */
|
|
50478
|
+
managedTeamAccess?: "all" | "assigned";
|
|
50457
50479
|
/**
|
|
50458
50480
|
* @default user
|
|
50459
50481
|
* @enum {string}
|
|
@@ -50985,6 +51007,8 @@ export interface operations {
|
|
|
50985
51007
|
"application/json": {
|
|
50986
51008
|
lastInvitedAt?: string | null;
|
|
50987
51009
|
/** @enum {string} */
|
|
51010
|
+
managedTeamAccess?: "all" | "assigned";
|
|
51011
|
+
/** @enum {string} */
|
|
50988
51012
|
role?: "admin" | "user" | "owner";
|
|
50989
51013
|
/** @enum {string} */
|
|
50990
51014
|
status?: "active" | "inactive" | "unconfirmed";
|
|
@@ -58355,6 +58379,8 @@ export interface operations {
|
|
|
58355
58379
|
cancelledAt: string | null;
|
|
58356
58380
|
} | null;
|
|
58357
58381
|
membership: {
|
|
58382
|
+
/** @enum {string} */
|
|
58383
|
+
accessSource: "direct" | "partnerDerived";
|
|
58358
58384
|
/** @enum {string} */
|
|
58359
58385
|
role: "admin" | "user" | "owner" | "partner";
|
|
58360
58386
|
permissionBundles: string[];
|
|
@@ -67549,6 +67575,9 @@ export interface operations {
|
|
|
67549
67575
|
/** Format: email */
|
|
67550
67576
|
email: string;
|
|
67551
67577
|
secondaryEmails: string[];
|
|
67578
|
+
permissionBundles: string[];
|
|
67579
|
+
/** @enum {string} */
|
|
67580
|
+
managedTeamAccess: "all" | "assigned";
|
|
67552
67581
|
/** @enum {string} */
|
|
67553
67582
|
role: "admin" | "user";
|
|
67554
67583
|
status: ("active" | "inactive" | "unconfirmed") | null;
|
|
@@ -67564,6 +67593,7 @@ export interface operations {
|
|
|
67564
67593
|
id: string;
|
|
67565
67594
|
name: string;
|
|
67566
67595
|
};
|
|
67596
|
+
permissionBundles: string[];
|
|
67567
67597
|
role?: string | null;
|
|
67568
67598
|
status?: string | null;
|
|
67569
67599
|
lastInvitedAt: string | null;
|
|
@@ -68063,6 +68093,11 @@ export interface operations {
|
|
|
68063
68093
|
requestBody?: {
|
|
68064
68094
|
content: {
|
|
68065
68095
|
"application/json": {
|
|
68096
|
+
/**
|
|
68097
|
+
* @description Partner-level child-team access mode. Omit to preserve the member's current mode.
|
|
68098
|
+
* @enum {string}
|
|
68099
|
+
*/
|
|
68100
|
+
managedTeamAccess?: "all" | "assigned";
|
|
68066
68101
|
/** @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. */
|
|
68067
68102
|
memberships: {
|
|
68068
68103
|
/** Format: uuid */
|
|
@@ -69456,6 +69491,11 @@ export interface operations {
|
|
|
69456
69491
|
requestBody?: {
|
|
69457
69492
|
content: {
|
|
69458
69493
|
"application/json": {
|
|
69494
|
+
/**
|
|
69495
|
+
* @description Partner-level child-team access mode. Omit to preserve the member's current mode.
|
|
69496
|
+
* @enum {string}
|
|
69497
|
+
*/
|
|
69498
|
+
managedTeamAccess?: "all" | "assigned";
|
|
69459
69499
|
/** @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. */
|
|
69460
69500
|
memberships: {
|
|
69461
69501
|
/** Format: uuid */
|