@vrplatform/api 1.3.1-stage.5307 → 1.3.1-stage.5312
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.
|
@@ -3000,7 +3000,7 @@ export interface paths {
|
|
|
3000
3000
|
cookie?: never;
|
|
3001
3001
|
};
|
|
3002
3002
|
/**
|
|
3003
|
-
* @description List property-manager teams billed by the authenticated partner for one month in a regional partition. Completed months use the latest retained listings_reported event explicitly attributed to the partner through the existing date-only month-end cutoff. A currently billed team without an attributed event uses its live count only when it has another listing report in that historical window. Events and their historical rows are removed when a team is deleted. Current months use live active-listing counts. Live non-GL counts use calculated listing status, while GL counts use ownership-period deactivation. Filters run before deterministic sorting, totals, and pagination. Select the partition with x-data-region.
|
|
3003
|
+
* @description List property-manager teams billed by the authenticated partner for one month in a regional partition. status is effective after applying team and billing-partner subscription state, and capabilities.activate explains whether the team can be activated. Completed months use the latest retained listings_reported event explicitly attributed to the partner through the existing date-only month-end cutoff. A currently billed team without an attributed event uses its live count only when it has another listing report in that historical window. Events and their historical rows are removed when a team is deleted. Current months use live active-listing counts. Live non-GL counts use calculated listing status, while GL counts use ownership-period deactivation. Filters run before deterministic sorting, totals, and pagination. Select the partition with x-data-region.
|
|
3004
3004
|
*
|
|
3005
3005
|
* Required scope: teams:read
|
|
3006
3006
|
*/
|
|
@@ -5168,13 +5168,13 @@ export interface paths {
|
|
|
5168
5168
|
cookie?: never;
|
|
5169
5169
|
};
|
|
5170
5170
|
/**
|
|
5171
|
-
* @description Get the current team and its dashboard aggregates (singleton: the team in scope via the x-team-id header). Effective partner identity and status resolve through the control plane when the partner is homed in another region. Cross-team access uses the plural /teams collection.
|
|
5171
|
+
* @description Get the current team and its dashboard aggregates (singleton: the team in scope via the x-team-id header). The returned status combines the team and billing-partner subscription states, and capabilities.activate explains whether the team can be activated. Effective partner identity and status resolve through the control plane when the partner is homed in another region. Cross-team access uses the plural /teams collection.
|
|
5172
5172
|
*
|
|
5173
5173
|
* Required scope: teams:read
|
|
5174
5174
|
*/
|
|
5175
5175
|
get: operations["getTeam"];
|
|
5176
5176
|
/**
|
|
5177
|
-
* @description Update the current team (singleton: the team in scope via the x-team-id header). Send null for logo or colorPrimary to clear that branding value. Changing statementStartAt reclassifies unlocked journals around the first live GL date while explicit opening-balance journals remain active. Reapplying the current date only restores explicit opening-balance journals inactivated by the GL boundary.
|
|
5177
|
+
* @description Update the current team (singleton: the team in scope via the x-team-id header). status requests the administrative state. Before requesting active, check capabilities.activate; the API rejects activation when subscription or effective billing-partner state prevents the response from becoming active. Send null for logo or colorPrimary to clear that branding value. Changing statementStartAt reclassifies unlocked journals around the first live GL date while explicit opening-balance journals remain active. Reapplying the current date only restores explicit opening-balance journals inactivated by the GL boundary.
|
|
5178
5178
|
*
|
|
5179
5179
|
* Required scope: teams:write
|
|
5180
5180
|
*/
|
|
@@ -5395,7 +5395,7 @@ export interface paths {
|
|
|
5395
5395
|
cookie?: never;
|
|
5396
5396
|
};
|
|
5397
5397
|
/**
|
|
5398
|
-
* @description List and filter accessible teams in one regional data partition. status
|
|
5398
|
+
* @description List and filter accessible teams in one regional data partition. status applies the tenant and billing-partner subscription states. Billability is always present; includeAggregates opt-in adds partner-dashboard counts. Partner callers can select the partition with x-data-region.
|
|
5399
5399
|
*
|
|
5400
5400
|
* Required scope: teams:read
|
|
5401
5401
|
*/
|
|
@@ -5442,7 +5442,7 @@ export interface paths {
|
|
|
5442
5442
|
cookie?: never;
|
|
5443
5443
|
};
|
|
5444
5444
|
/**
|
|
5445
|
-
* @description Look up accessible teams by name in one regional data partition before selecting a team. The x-team-id header is optional. Partner callers can select the partition with x-data-region.
|
|
5445
|
+
* @description Look up accessible teams by name in one regional data partition before selecting a team. The x-team-id header is optional. status filters by the combined team and billing-partner subscription state. Partner callers can select the partition with x-data-region.
|
|
5446
5446
|
*
|
|
5447
5447
|
* Required scope: teams:read
|
|
5448
5448
|
*/
|
|
@@ -5463,7 +5463,7 @@ export interface paths {
|
|
|
5463
5463
|
cookie?: never;
|
|
5464
5464
|
};
|
|
5465
5465
|
/**
|
|
5466
|
-
* @description Resolve a team by slug, connection, or tenant-scoped auth. Effective partner identity and status resolve through the control plane when the partner is homed in another region.
|
|
5466
|
+
* @description Resolve a team by slug, connection, or tenant-scoped auth. The returned status combines the team and billing-partner subscription states, and capabilities.activate explains whether the team can be activated. Effective partner identity and status resolve through the control plane when the partner is homed in another region.
|
|
5467
5467
|
*
|
|
5468
5468
|
* Required scope: teams:read
|
|
5469
5469
|
*/
|
|
@@ -62503,6 +62503,12 @@ export interface operations {
|
|
|
62503
62503
|
logo: string | null;
|
|
62504
62504
|
/** @enum {string} */
|
|
62505
62505
|
status: "active" | "inactive" | "deleted";
|
|
62506
|
+
capabilities: {
|
|
62507
|
+
activate: {
|
|
62508
|
+
enabled: boolean;
|
|
62509
|
+
disabledReasons: ("teamBillingSubscriptionInactive" | "billingPartnerInactive")[];
|
|
62510
|
+
};
|
|
62511
|
+
};
|
|
62506
62512
|
/** @constant */
|
|
62507
62513
|
type: "propertyManager";
|
|
62508
62514
|
isOnboarding: boolean;
|
|
@@ -66509,13 +66515,17 @@ export interface operations {
|
|
|
66509
66515
|
companyName?: string | null;
|
|
66510
66516
|
/** @enum {string} */
|
|
66511
66517
|
type: "partner" | "admin" | "propertyManager";
|
|
66512
|
-
/** @enum {string} */
|
|
66513
|
-
status: "active" | "inactive";
|
|
66514
66518
|
/**
|
|
66515
|
-
* @description
|
|
66519
|
+
* @description Lifecycle status derived from the team and billing-partner subscription states
|
|
66516
66520
|
* @enum {string}
|
|
66517
66521
|
*/
|
|
66518
|
-
|
|
66522
|
+
status: "active" | "inactive";
|
|
66523
|
+
capabilities: {
|
|
66524
|
+
activate: {
|
|
66525
|
+
enabled: boolean;
|
|
66526
|
+
disabledReasons: ("teamBillingSubscriptionInactive" | "billingPartnerInactive")[];
|
|
66527
|
+
};
|
|
66528
|
+
};
|
|
66519
66529
|
billingSubscriptionStatus?: string | null;
|
|
66520
66530
|
billingPlan?: string | null;
|
|
66521
66531
|
billingPaymentMethodType?: string | null;
|
|
@@ -66950,13 +66960,17 @@ export interface operations {
|
|
|
66950
66960
|
companyName?: string | null;
|
|
66951
66961
|
/** @enum {string} */
|
|
66952
66962
|
type: "partner" | "admin" | "propertyManager";
|
|
66953
|
-
/** @enum {string} */
|
|
66954
|
-
status: "active" | "inactive";
|
|
66955
66963
|
/**
|
|
66956
|
-
* @description
|
|
66964
|
+
* @description Lifecycle status derived from the team and billing-partner subscription states
|
|
66957
66965
|
* @enum {string}
|
|
66958
66966
|
*/
|
|
66959
|
-
|
|
66967
|
+
status: "active" | "inactive";
|
|
66968
|
+
capabilities: {
|
|
66969
|
+
activate: {
|
|
66970
|
+
enabled: boolean;
|
|
66971
|
+
disabledReasons: ("teamBillingSubscriptionInactive" | "billingPartnerInactive")[];
|
|
66972
|
+
};
|
|
66973
|
+
};
|
|
66960
66974
|
billingSubscriptionStatus?: string | null;
|
|
66961
66975
|
billingPlan?: string | null;
|
|
66962
66976
|
billingPaymentMethodType?: string | null;
|
|
@@ -112346,13 +112360,17 @@ export interface operations {
|
|
|
112346
112360
|
companyName?: string | null;
|
|
112347
112361
|
/** @enum {string} */
|
|
112348
112362
|
type: "partner" | "admin" | "propertyManager";
|
|
112349
|
-
/** @enum {string} */
|
|
112350
|
-
status: "active" | "inactive";
|
|
112351
112363
|
/**
|
|
112352
|
-
* @description
|
|
112364
|
+
* @description Lifecycle status derived from the team and billing-partner subscription states
|
|
112353
112365
|
* @enum {string}
|
|
112354
112366
|
*/
|
|
112355
|
-
|
|
112367
|
+
status: "active" | "inactive";
|
|
112368
|
+
capabilities: {
|
|
112369
|
+
activate: {
|
|
112370
|
+
enabled: boolean;
|
|
112371
|
+
disabledReasons: ("teamBillingSubscriptionInactive" | "billingPartnerInactive")[];
|
|
112372
|
+
};
|
|
112373
|
+
};
|
|
112356
112374
|
billingSubscriptionStatus?: string | null;
|
|
112357
112375
|
billingPlan?: string | null;
|
|
112358
112376
|
billingPaymentMethodType?: string | null;
|
|
@@ -112848,13 +112866,17 @@ export interface operations {
|
|
|
112848
112866
|
companyName?: string | null;
|
|
112849
112867
|
/** @enum {string} */
|
|
112850
112868
|
type: "partner" | "admin" | "propertyManager";
|
|
112851
|
-
/** @enum {string} */
|
|
112852
|
-
status: "active" | "inactive";
|
|
112853
112869
|
/**
|
|
112854
|
-
* @description
|
|
112870
|
+
* @description Lifecycle status derived from the team and billing-partner subscription states
|
|
112855
112871
|
* @enum {string}
|
|
112856
112872
|
*/
|
|
112857
|
-
|
|
112873
|
+
status: "active" | "inactive";
|
|
112874
|
+
capabilities: {
|
|
112875
|
+
activate: {
|
|
112876
|
+
enabled: boolean;
|
|
112877
|
+
disabledReasons: ("teamBillingSubscriptionInactive" | "billingPartnerInactive")[];
|
|
112878
|
+
};
|
|
112879
|
+
};
|
|
112858
112880
|
billingSubscriptionStatus?: string | null;
|
|
112859
112881
|
billingPlan?: string | null;
|
|
112860
112882
|
billingPaymentMethodType?: string | null;
|
|
@@ -114961,13 +114983,17 @@ export interface operations {
|
|
|
114961
114983
|
companyName?: string | null;
|
|
114962
114984
|
/** @enum {string} */
|
|
114963
114985
|
type: "partner" | "admin" | "propertyManager";
|
|
114964
|
-
/** @enum {string} */
|
|
114965
|
-
status: "active" | "inactive";
|
|
114966
114986
|
/**
|
|
114967
|
-
* @description
|
|
114987
|
+
* @description Lifecycle status derived from the team and billing-partner subscription states
|
|
114968
114988
|
* @enum {string}
|
|
114969
114989
|
*/
|
|
114970
|
-
|
|
114990
|
+
status: "active" | "inactive";
|
|
114991
|
+
capabilities: {
|
|
114992
|
+
activate: {
|
|
114993
|
+
enabled: boolean;
|
|
114994
|
+
disabledReasons: ("teamBillingSubscriptionInactive" | "billingPartnerInactive")[];
|
|
114995
|
+
};
|
|
114996
|
+
};
|
|
114971
114997
|
billingSubscriptionStatus?: string | null;
|
|
114972
114998
|
billingPlan?: string | null;
|
|
114973
114999
|
billingPaymentMethodType?: string | null;
|
|
@@ -116892,9 +116918,8 @@ export interface operations {
|
|
|
116892
116918
|
query?: {
|
|
116893
116919
|
/** @description Comma-separated team IDs. */
|
|
116894
116920
|
ids?: string;
|
|
116921
|
+
/** @description Filter by lifecycle status derived from the team and billing-partner subscription states. */
|
|
116895
116922
|
status?: "active" | "inactive";
|
|
116896
|
-
/** @description Filter by effective status after applying the tenant and billing-partner subscription states. */
|
|
116897
|
-
effectiveStatus?: "active" | "inactive";
|
|
116898
116923
|
/** @description Filter by onboarding state. */
|
|
116899
116924
|
isOnboarding?: boolean;
|
|
116900
116925
|
/** @description Exclude demo/test teams. */
|
|
@@ -116988,13 +117013,17 @@ export interface operations {
|
|
|
116988
117013
|
companyName?: string | null;
|
|
116989
117014
|
/** @enum {string} */
|
|
116990
117015
|
type: "partner" | "admin" | "propertyManager";
|
|
116991
|
-
/** @enum {string} */
|
|
116992
|
-
status: "active" | "inactive";
|
|
116993
117016
|
/**
|
|
116994
|
-
* @description
|
|
117017
|
+
* @description Lifecycle status derived from the team and billing-partner subscription states
|
|
116995
117018
|
* @enum {string}
|
|
116996
117019
|
*/
|
|
116997
|
-
|
|
117020
|
+
status: "active" | "inactive";
|
|
117021
|
+
capabilities: {
|
|
117022
|
+
activate: {
|
|
117023
|
+
enabled: boolean;
|
|
117024
|
+
disabledReasons: ("teamBillingSubscriptionInactive" | "billingPartnerInactive")[];
|
|
117025
|
+
};
|
|
117026
|
+
};
|
|
116998
117027
|
billingSubscriptionStatus?: string | null;
|
|
116999
117028
|
billingPlan?: string | null;
|
|
117000
117029
|
billingPaymentMethodType?: string | null;
|
|
@@ -117388,7 +117417,10 @@ export interface operations {
|
|
|
117388
117417
|
companyName?: string | null;
|
|
117389
117418
|
/** @enum {string} */
|
|
117390
117419
|
type?: "partner" | "admin" | "propertyManager";
|
|
117391
|
-
/**
|
|
117420
|
+
/**
|
|
117421
|
+
* @description Lifecycle status derived from the team and billing-partner subscription states
|
|
117422
|
+
* @enum {string}
|
|
117423
|
+
*/
|
|
117392
117424
|
status?: "active" | "inactive";
|
|
117393
117425
|
billingSubscriptionStatus?: string | null;
|
|
117394
117426
|
billingPlan?: string | null;
|
|
@@ -117485,13 +117517,17 @@ export interface operations {
|
|
|
117485
117517
|
companyName?: string | null;
|
|
117486
117518
|
/** @enum {string} */
|
|
117487
117519
|
type: "partner" | "admin" | "propertyManager";
|
|
117488
|
-
/** @enum {string} */
|
|
117489
|
-
status: "active" | "inactive";
|
|
117490
117520
|
/**
|
|
117491
|
-
* @description
|
|
117521
|
+
* @description Lifecycle status derived from the team and billing-partner subscription states
|
|
117492
117522
|
* @enum {string}
|
|
117493
117523
|
*/
|
|
117494
|
-
|
|
117524
|
+
status: "active" | "inactive";
|
|
117525
|
+
capabilities: {
|
|
117526
|
+
activate: {
|
|
117527
|
+
enabled: boolean;
|
|
117528
|
+
disabledReasons: ("teamBillingSubscriptionInactive" | "billingPartnerInactive")[];
|
|
117529
|
+
};
|
|
117530
|
+
};
|
|
117495
117531
|
billingSubscriptionStatus?: string | null;
|
|
117496
117532
|
billingPlan?: string | null;
|
|
117497
117533
|
billingPaymentMethodType?: string | null;
|
|
@@ -118903,13 +118939,17 @@ export interface operations {
|
|
|
118903
118939
|
companyName?: string | null;
|
|
118904
118940
|
/** @enum {string} */
|
|
118905
118941
|
type: "partner" | "admin" | "propertyManager";
|
|
118906
|
-
/** @enum {string} */
|
|
118907
|
-
status: "active" | "inactive";
|
|
118908
118942
|
/**
|
|
118909
|
-
* @description
|
|
118943
|
+
* @description Lifecycle status derived from the team and billing-partner subscription states
|
|
118910
118944
|
* @enum {string}
|
|
118911
118945
|
*/
|
|
118912
|
-
|
|
118946
|
+
status: "active" | "inactive";
|
|
118947
|
+
capabilities: {
|
|
118948
|
+
activate: {
|
|
118949
|
+
enabled: boolean;
|
|
118950
|
+
disabledReasons: ("teamBillingSubscriptionInactive" | "billingPartnerInactive")[];
|
|
118951
|
+
};
|
|
118952
|
+
};
|
|
118913
118953
|
billingSubscriptionStatus?: string | null;
|
|
118914
118954
|
billingPlan?: string | null;
|
|
118915
118955
|
billingPaymentMethodType?: string | null;
|
|
@@ -119330,13 +119370,17 @@ export interface operations {
|
|
|
119330
119370
|
companyName?: string | null;
|
|
119331
119371
|
/** @enum {string} */
|
|
119332
119372
|
type: "partner" | "admin" | "propertyManager";
|
|
119333
|
-
/** @enum {string} */
|
|
119334
|
-
status: "active" | "inactive";
|
|
119335
119373
|
/**
|
|
119336
|
-
* @description
|
|
119374
|
+
* @description Lifecycle status derived from the team and billing-partner subscription states
|
|
119337
119375
|
* @enum {string}
|
|
119338
119376
|
*/
|
|
119339
|
-
|
|
119377
|
+
status: "active" | "inactive";
|
|
119378
|
+
capabilities: {
|
|
119379
|
+
activate: {
|
|
119380
|
+
enabled: boolean;
|
|
119381
|
+
disabledReasons: ("teamBillingSubscriptionInactive" | "billingPartnerInactive")[];
|
|
119382
|
+
};
|
|
119383
|
+
};
|
|
119340
119384
|
billingSubscriptionStatus?: string | null;
|
|
119341
119385
|
billingPlan?: string | null;
|
|
119342
119386
|
billingPaymentMethodType?: string | null;
|