@vrplatform/api 1.3.1-stage.5306 → 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.
package/package.json CHANGED
@@ -3,7 +3,7 @@
3
3
  "publishConfig": {
4
4
  "access": "public"
5
5
  },
6
- "version": "1.3.1-stage.5306",
6
+ "version": "1.3.1-stage.5312",
7
7
  "description": "",
8
8
  "main": "build/main/index.js",
9
9
  "module": "build/module/index.js",
@@ -3001,7 +3001,7 @@ export interface paths {
3001
3001
  cookie?: never;
3002
3002
  };
3003
3003
  /**
3004
- * @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.
3004
+ * @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.
3005
3005
  *
3006
3006
  * Required scope: teams:read
3007
3007
  */
@@ -5169,13 +5169,13 @@ export interface paths {
5169
5169
  cookie?: never;
5170
5170
  };
5171
5171
  /**
5172
- * @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.
5172
+ * @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.
5173
5173
  *
5174
5174
  * Required scope: teams:read
5175
5175
  */
5176
5176
  get: operations["getTeam"];
5177
5177
  /**
5178
- * @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.
5178
+ * @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.
5179
5179
  *
5180
5180
  * Required scope: teams:write
5181
5181
  */
@@ -5396,7 +5396,7 @@ export interface paths {
5396
5396
  cookie?: never;
5397
5397
  };
5398
5398
  /**
5399
- * @description List and filter accessible teams in one regional data partition. status is the administrative lifecycle state; effectiveStatus also 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
+ * @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.
5400
5400
  *
5401
5401
  * Required scope: teams:read
5402
5402
  */
@@ -5443,7 +5443,7 @@ export interface paths {
5443
5443
  cookie?: never;
5444
5444
  };
5445
5445
  /**
5446
- * @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.
5446
+ * @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.
5447
5447
  *
5448
5448
  * Required scope: teams:read
5449
5449
  */
@@ -5464,7 +5464,7 @@ export interface paths {
5464
5464
  cookie?: never;
5465
5465
  };
5466
5466
  /**
5467
- * @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.
5467
+ * @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.
5468
5468
  *
5469
5469
  * Required scope: teams:read
5470
5470
  */
@@ -62504,6 +62504,12 @@ export interface operations {
62504
62504
  logo: string | null;
62505
62505
  /** @enum {string} */
62506
62506
  status: "active" | "inactive" | "deleted";
62507
+ capabilities: {
62508
+ activate: {
62509
+ enabled: boolean;
62510
+ disabledReasons: ("teamBillingSubscriptionInactive" | "billingPartnerInactive")[];
62511
+ };
62512
+ };
62507
62513
  /** @constant */
62508
62514
  type: "propertyManager";
62509
62515
  isOnboarding: boolean;
@@ -66510,13 +66516,17 @@ export interface operations {
66510
66516
  companyName?: string | null;
66511
66517
  /** @enum {string} */
66512
66518
  type: "partner" | "admin" | "propertyManager";
66513
- /** @enum {string} */
66514
- status: "active" | "inactive";
66515
66519
  /**
66516
- * @description Effective status after applying the tenant and billing-partner subscription states
66520
+ * @description Lifecycle status derived from the team and billing-partner subscription states
66517
66521
  * @enum {string}
66518
66522
  */
66519
- effectiveStatus: "active" | "inactive";
66523
+ status: "active" | "inactive";
66524
+ capabilities: {
66525
+ activate: {
66526
+ enabled: boolean;
66527
+ disabledReasons: ("teamBillingSubscriptionInactive" | "billingPartnerInactive")[];
66528
+ };
66529
+ };
66520
66530
  billingSubscriptionStatus?: string | null;
66521
66531
  billingPlan?: string | null;
66522
66532
  billingPaymentMethodType?: string | null;
@@ -66951,13 +66961,17 @@ export interface operations {
66951
66961
  companyName?: string | null;
66952
66962
  /** @enum {string} */
66953
66963
  type: "partner" | "admin" | "propertyManager";
66954
- /** @enum {string} */
66955
- status: "active" | "inactive";
66956
66964
  /**
66957
- * @description Effective status after applying the tenant and billing-partner subscription states
66965
+ * @description Lifecycle status derived from the team and billing-partner subscription states
66958
66966
  * @enum {string}
66959
66967
  */
66960
- effectiveStatus: "active" | "inactive";
66968
+ status: "active" | "inactive";
66969
+ capabilities: {
66970
+ activate: {
66971
+ enabled: boolean;
66972
+ disabledReasons: ("teamBillingSubscriptionInactive" | "billingPartnerInactive")[];
66973
+ };
66974
+ };
66961
66975
  billingSubscriptionStatus?: string | null;
66962
66976
  billingPlan?: string | null;
66963
66977
  billingPaymentMethodType?: string | null;
@@ -112347,13 +112361,17 @@ export interface operations {
112347
112361
  companyName?: string | null;
112348
112362
  /** @enum {string} */
112349
112363
  type: "partner" | "admin" | "propertyManager";
112350
- /** @enum {string} */
112351
- status: "active" | "inactive";
112352
112364
  /**
112353
- * @description Effective status after applying the tenant and billing-partner subscription states
112365
+ * @description Lifecycle status derived from the team and billing-partner subscription states
112354
112366
  * @enum {string}
112355
112367
  */
112356
- effectiveStatus: "active" | "inactive";
112368
+ status: "active" | "inactive";
112369
+ capabilities: {
112370
+ activate: {
112371
+ enabled: boolean;
112372
+ disabledReasons: ("teamBillingSubscriptionInactive" | "billingPartnerInactive")[];
112373
+ };
112374
+ };
112357
112375
  billingSubscriptionStatus?: string | null;
112358
112376
  billingPlan?: string | null;
112359
112377
  billingPaymentMethodType?: string | null;
@@ -112849,13 +112867,17 @@ export interface operations {
112849
112867
  companyName?: string | null;
112850
112868
  /** @enum {string} */
112851
112869
  type: "partner" | "admin" | "propertyManager";
112852
- /** @enum {string} */
112853
- status: "active" | "inactive";
112854
112870
  /**
112855
- * @description Effective status after applying the tenant and billing-partner subscription states
112871
+ * @description Lifecycle status derived from the team and billing-partner subscription states
112856
112872
  * @enum {string}
112857
112873
  */
112858
- effectiveStatus: "active" | "inactive";
112874
+ status: "active" | "inactive";
112875
+ capabilities: {
112876
+ activate: {
112877
+ enabled: boolean;
112878
+ disabledReasons: ("teamBillingSubscriptionInactive" | "billingPartnerInactive")[];
112879
+ };
112880
+ };
112859
112881
  billingSubscriptionStatus?: string | null;
112860
112882
  billingPlan?: string | null;
112861
112883
  billingPaymentMethodType?: string | null;
@@ -114962,13 +114984,17 @@ export interface operations {
114962
114984
  companyName?: string | null;
114963
114985
  /** @enum {string} */
114964
114986
  type: "partner" | "admin" | "propertyManager";
114965
- /** @enum {string} */
114966
- status: "active" | "inactive";
114967
114987
  /**
114968
- * @description Effective status after applying the tenant and billing-partner subscription states
114988
+ * @description Lifecycle status derived from the team and billing-partner subscription states
114969
114989
  * @enum {string}
114970
114990
  */
114971
- effectiveStatus: "active" | "inactive";
114991
+ status: "active" | "inactive";
114992
+ capabilities: {
114993
+ activate: {
114994
+ enabled: boolean;
114995
+ disabledReasons: ("teamBillingSubscriptionInactive" | "billingPartnerInactive")[];
114996
+ };
114997
+ };
114972
114998
  billingSubscriptionStatus?: string | null;
114973
114999
  billingPlan?: string | null;
114974
115000
  billingPaymentMethodType?: string | null;
@@ -116893,9 +116919,8 @@ export interface operations {
116893
116919
  query?: {
116894
116920
  /** @description Comma-separated team IDs. */
116895
116921
  ids?: string;
116922
+ /** @description Filter by lifecycle status derived from the team and billing-partner subscription states. */
116896
116923
  status?: "active" | "inactive";
116897
- /** @description Filter by effective status after applying the tenant and billing-partner subscription states. */
116898
- effectiveStatus?: "active" | "inactive";
116899
116924
  /** @description Filter by onboarding state. */
116900
116925
  isOnboarding?: boolean;
116901
116926
  /** @description Exclude demo/test teams. */
@@ -116989,13 +117014,17 @@ export interface operations {
116989
117014
  companyName?: string | null;
116990
117015
  /** @enum {string} */
116991
117016
  type: "partner" | "admin" | "propertyManager";
116992
- /** @enum {string} */
116993
- status: "active" | "inactive";
116994
117017
  /**
116995
- * @description Effective status after applying the tenant and billing-partner subscription states
117018
+ * @description Lifecycle status derived from the team and billing-partner subscription states
116996
117019
  * @enum {string}
116997
117020
  */
116998
- effectiveStatus: "active" | "inactive";
117021
+ status: "active" | "inactive";
117022
+ capabilities: {
117023
+ activate: {
117024
+ enabled: boolean;
117025
+ disabledReasons: ("teamBillingSubscriptionInactive" | "billingPartnerInactive")[];
117026
+ };
117027
+ };
116999
117028
  billingSubscriptionStatus?: string | null;
117000
117029
  billingPlan?: string | null;
117001
117030
  billingPaymentMethodType?: string | null;
@@ -117389,7 +117418,10 @@ export interface operations {
117389
117418
  companyName?: string | null;
117390
117419
  /** @enum {string} */
117391
117420
  type?: "partner" | "admin" | "propertyManager";
117392
- /** @enum {string} */
117421
+ /**
117422
+ * @description Lifecycle status derived from the team and billing-partner subscription states
117423
+ * @enum {string}
117424
+ */
117393
117425
  status?: "active" | "inactive";
117394
117426
  billingSubscriptionStatus?: string | null;
117395
117427
  billingPlan?: string | null;
@@ -117486,13 +117518,17 @@ export interface operations {
117486
117518
  companyName?: string | null;
117487
117519
  /** @enum {string} */
117488
117520
  type: "partner" | "admin" | "propertyManager";
117489
- /** @enum {string} */
117490
- status: "active" | "inactive";
117491
117521
  /**
117492
- * @description Effective status after applying the tenant and billing-partner subscription states
117522
+ * @description Lifecycle status derived from the team and billing-partner subscription states
117493
117523
  * @enum {string}
117494
117524
  */
117495
- effectiveStatus: "active" | "inactive";
117525
+ status: "active" | "inactive";
117526
+ capabilities: {
117527
+ activate: {
117528
+ enabled: boolean;
117529
+ disabledReasons: ("teamBillingSubscriptionInactive" | "billingPartnerInactive")[];
117530
+ };
117531
+ };
117496
117532
  billingSubscriptionStatus?: string | null;
117497
117533
  billingPlan?: string | null;
117498
117534
  billingPaymentMethodType?: string | null;
@@ -118904,13 +118940,17 @@ export interface operations {
118904
118940
  companyName?: string | null;
118905
118941
  /** @enum {string} */
118906
118942
  type: "partner" | "admin" | "propertyManager";
118907
- /** @enum {string} */
118908
- status: "active" | "inactive";
118909
118943
  /**
118910
- * @description Effective status after applying the tenant and billing-partner subscription states
118944
+ * @description Lifecycle status derived from the team and billing-partner subscription states
118911
118945
  * @enum {string}
118912
118946
  */
118913
- effectiveStatus: "active" | "inactive";
118947
+ status: "active" | "inactive";
118948
+ capabilities: {
118949
+ activate: {
118950
+ enabled: boolean;
118951
+ disabledReasons: ("teamBillingSubscriptionInactive" | "billingPartnerInactive")[];
118952
+ };
118953
+ };
118914
118954
  billingSubscriptionStatus?: string | null;
118915
118955
  billingPlan?: string | null;
118916
118956
  billingPaymentMethodType?: string | null;
@@ -119331,13 +119371,17 @@ export interface operations {
119331
119371
  companyName?: string | null;
119332
119372
  /** @enum {string} */
119333
119373
  type: "partner" | "admin" | "propertyManager";
119334
- /** @enum {string} */
119335
- status: "active" | "inactive";
119336
119374
  /**
119337
- * @description Effective status after applying the tenant and billing-partner subscription states
119375
+ * @description Lifecycle status derived from the team and billing-partner subscription states
119338
119376
  * @enum {string}
119339
119377
  */
119340
- effectiveStatus: "active" | "inactive";
119378
+ status: "active" | "inactive";
119379
+ capabilities: {
119380
+ activate: {
119381
+ enabled: boolean;
119382
+ disabledReasons: ("teamBillingSubscriptionInactive" | "billingPartnerInactive")[];
119383
+ };
119384
+ };
119341
119385
  billingSubscriptionStatus?: string | null;
119342
119386
  billingPlan?: string | null;
119343
119387
  billingPaymentMethodType?: string | null;