@vrplatform/api 1.3.1-stage.4736 → 1.3.1-stage.4741

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.4736",
6
+ "version": "1.3.1-stage.4741",
7
7
  "description": "",
8
8
  "main": "build/main/index.js",
9
9
  "module": "build/module/index.js",
@@ -1793,6 +1793,23 @@ export interface paths {
1793
1793
  patch?: never;
1794
1794
  trace?: never;
1795
1795
  };
1796
+ "/internal/teams/{tenantId}/billing-state": {
1797
+ parameters: {
1798
+ query?: never;
1799
+ header?: never;
1800
+ path?: never;
1801
+ cookie?: never;
1802
+ };
1803
+ get?: never;
1804
+ /** @description Apply the current external billing state to one team. Omitted fields remain unchanged and explicit null values clear nullable fields. The x-team-id routing header must match tenantId. */
1805
+ put: operations["putInternalTeamsByTenantIdBillingState"];
1806
+ post?: never;
1807
+ delete?: never;
1808
+ options?: never;
1809
+ head?: never;
1810
+ patch?: never;
1811
+ trace?: never;
1812
+ };
1796
1813
  "/internal/users": {
1797
1814
  parameters: {
1798
1815
  query?: never;
@@ -2585,7 +2602,7 @@ export interface paths {
2585
2602
  cookie?: never;
2586
2603
  };
2587
2604
  /**
2588
- * @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 per team, including deleted teams; the current month uses live active-listing counts. Filters run before deterministic sorting, totals, and pagination. Select the partition with x-data-region.
2605
+ * @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 legacy 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. 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.
2589
2606
  *
2590
2607
  * Required scope: teams:read
2591
2608
  */
@@ -2661,6 +2678,27 @@ export interface paths {
2661
2678
  patch?: never;
2662
2679
  trace?: never;
2663
2680
  };
2681
+ "/partner/listings": {
2682
+ parameters: {
2683
+ query?: never;
2684
+ header?: never;
2685
+ path?: never;
2686
+ cookie?: never;
2687
+ };
2688
+ /**
2689
+ * @description List active property-manager listings for the authorized partner portfolio in one regional partition. Team, company, lifecycle, accounting-partner, effective billing-partner, subscription, billing-plan, product, and feature filters run before totals and pagination. Rows are ordered deterministically by team name and calculated listing name and include structured and full addresses. Select the partition with x-data-region.
2690
+ *
2691
+ * Required scope: teams:read
2692
+ */
2693
+ get: operations["getPartnerListings"];
2694
+ put?: never;
2695
+ post?: never;
2696
+ delete?: never;
2697
+ options?: never;
2698
+ head?: never;
2699
+ patch?: never;
2700
+ trace?: never;
2701
+ };
2664
2702
  "/partner/members": {
2665
2703
  parameters: {
2666
2704
  query?: never;
@@ -31298,6 +31336,7 @@ export interface operations {
31298
31336
  id: string;
31299
31337
  name: string;
31300
31338
  } | null;
31339
+ billingPartnerId: string | null;
31301
31340
  companyName?: string | null;
31302
31341
  /** @enum {string} */
31303
31342
  type: "partner" | "admin" | "propertyManager";
@@ -31306,7 +31345,7 @@ export interface operations {
31306
31345
  billingSubscriptionStatus?: string | null;
31307
31346
  billingPlan?: string | null;
31308
31347
  billingPaymentMethodType?: string | null;
31309
- billingCustomerId?: string | null;
31348
+ billingCustomerId: string | null;
31310
31349
  colorPrimary?: string | null;
31311
31350
  createdAt?: string | null;
31312
31351
  updatedAt?: string | null;
@@ -31632,6 +31671,7 @@ export interface operations {
31632
31671
  id: string;
31633
31672
  name: string;
31634
31673
  } | null;
31674
+ billingPartnerId: string | null;
31635
31675
  companyName?: string | null;
31636
31676
  /** @enum {string} */
31637
31677
  type: "partner" | "admin" | "propertyManager";
@@ -31640,7 +31680,7 @@ export interface operations {
31640
31680
  billingSubscriptionStatus?: string | null;
31641
31681
  billingPlan?: string | null;
31642
31682
  billingPaymentMethodType?: string | null;
31643
- billingCustomerId?: string | null;
31683
+ billingCustomerId: string | null;
31644
31684
  colorPrimary?: string | null;
31645
31685
  createdAt?: string | null;
31646
31686
  updatedAt?: string | null;
@@ -32264,6 +32304,176 @@ export interface operations {
32264
32304
  };
32265
32305
  };
32266
32306
  };
32307
+ putInternalTeamsByTenantIdBillingState: {
32308
+ parameters: {
32309
+ query?: never;
32310
+ header?: never;
32311
+ path: {
32312
+ tenantId: string;
32313
+ };
32314
+ cookie?: never;
32315
+ };
32316
+ requestBody?: {
32317
+ content: {
32318
+ "application/json": {
32319
+ billingCustomerId?: string | null;
32320
+ billingPlan?: string | null;
32321
+ billingPaymentMethodType?: string | null;
32322
+ billingSubscriptionStatus?: string | null;
32323
+ trialUntil?: string | null;
32324
+ cancelledAt?: string | null;
32325
+ /** @enum {string} */
32326
+ status?: "active" | "inactive";
32327
+ };
32328
+ };
32329
+ };
32330
+ responses: {
32331
+ /** @description Successful response */
32332
+ 200: {
32333
+ headers: {
32334
+ [name: string]: unknown;
32335
+ };
32336
+ content: {
32337
+ "application/json": {
32338
+ /** Format: uuid */
32339
+ id: string;
32340
+ };
32341
+ };
32342
+ };
32343
+ /** @description Bad request */
32344
+ 400: {
32345
+ headers: {
32346
+ [name: string]: unknown;
32347
+ };
32348
+ content: {
32349
+ "application/json": {
32350
+ code: string;
32351
+ message: string;
32352
+ links?: {
32353
+ docs: string;
32354
+ schema: string;
32355
+ };
32356
+ issues?: {
32357
+ message: string;
32358
+ path?: (string | number)[];
32359
+ schema?: string;
32360
+ }[];
32361
+ context?: unknown;
32362
+ };
32363
+ };
32364
+ };
32365
+ /** @description Unauthorized */
32366
+ 401: {
32367
+ headers: {
32368
+ [name: string]: unknown;
32369
+ };
32370
+ content: {
32371
+ "application/json": {
32372
+ code: string;
32373
+ message: string;
32374
+ links?: {
32375
+ docs: string;
32376
+ schema: string;
32377
+ };
32378
+ issues?: {
32379
+ message: string;
32380
+ path?: (string | number)[];
32381
+ schema?: string;
32382
+ }[];
32383
+ context?: unknown;
32384
+ };
32385
+ };
32386
+ };
32387
+ /** @description Forbidden */
32388
+ 403: {
32389
+ headers: {
32390
+ [name: string]: unknown;
32391
+ };
32392
+ content: {
32393
+ "application/json": {
32394
+ code: string;
32395
+ message: string;
32396
+ links?: {
32397
+ docs: string;
32398
+ schema: string;
32399
+ };
32400
+ issues?: {
32401
+ message: string;
32402
+ path?: (string | number)[];
32403
+ schema?: string;
32404
+ }[];
32405
+ context?: unknown;
32406
+ };
32407
+ };
32408
+ };
32409
+ /** @description Not found */
32410
+ 404: {
32411
+ headers: {
32412
+ [name: string]: unknown;
32413
+ };
32414
+ content: {
32415
+ "application/json": {
32416
+ code: string;
32417
+ message: string;
32418
+ links?: {
32419
+ docs: string;
32420
+ schema: string;
32421
+ };
32422
+ issues?: {
32423
+ message: string;
32424
+ path?: (string | number)[];
32425
+ schema?: string;
32426
+ }[];
32427
+ context?: unknown;
32428
+ };
32429
+ };
32430
+ };
32431
+ /** @description Internal server error */
32432
+ 500: {
32433
+ headers: {
32434
+ [name: string]: unknown;
32435
+ };
32436
+ content: {
32437
+ "application/json": {
32438
+ code: string;
32439
+ message: string;
32440
+ links?: {
32441
+ docs: string;
32442
+ schema: string;
32443
+ };
32444
+ issues?: {
32445
+ message: string;
32446
+ path?: (string | number)[];
32447
+ schema?: string;
32448
+ }[];
32449
+ context?: unknown;
32450
+ };
32451
+ };
32452
+ };
32453
+ /** @description Service unavailable */
32454
+ 503: {
32455
+ headers: {
32456
+ [name: string]: unknown;
32457
+ };
32458
+ content: {
32459
+ "application/json": {
32460
+ code: string;
32461
+ message: string;
32462
+ links?: {
32463
+ docs: string;
32464
+ schema: string;
32465
+ };
32466
+ issues?: {
32467
+ message: string;
32468
+ path?: (string | number)[];
32469
+ schema?: string;
32470
+ }[];
32471
+ context?: unknown;
32472
+ };
32473
+ };
32474
+ };
32475
+ };
32476
+ };
32267
32477
  getInternalUsers: {
32268
32478
  parameters: {
32269
32479
  query?: {
@@ -42784,6 +42994,207 @@ export interface operations {
42784
42994
  };
42785
42995
  };
42786
42996
  };
42997
+ getPartnerListings: {
42998
+ parameters: {
42999
+ query?: {
43000
+ search?: string;
43001
+ partnerId?: string;
43002
+ billingPartnerId?: string;
43003
+ billingSubscriptionStatus?: "active" | "pending" | "paused" | "cancelled" | "pendingCancellation" | "draft" | "voided" | "errored" | "missing" | "viaPartner";
43004
+ billingPlan?: string;
43005
+ product?: "vrtrust" | "vrintegrations";
43006
+ /** @description Comma-separated team IDs. */
43007
+ ids?: string;
43008
+ status?: "active" | "inactive";
43009
+ /** @description Filter by team onboarding state. */
43010
+ isOnboarding?: boolean;
43011
+ /** @description Comma-separated enabled feature IDs. */
43012
+ featureIds?: string;
43013
+ limit?: number;
43014
+ page?: number;
43015
+ offset?: number;
43016
+ };
43017
+ header?: {
43018
+ /** @description Selects the regional data partition for this regional collection read. It does not change the authenticated team context. */
43019
+ "x-data-region"?: "ap" | "crunchy" | "eu" | "hostaway" | "us";
43020
+ };
43021
+ path?: never;
43022
+ cookie?: never;
43023
+ };
43024
+ requestBody?: never;
43025
+ responses: {
43026
+ /** @description Successful response */
43027
+ 200: {
43028
+ headers: {
43029
+ [name: string]: unknown;
43030
+ };
43031
+ content: {
43032
+ "application/json": {
43033
+ data: {
43034
+ /** Format: uuid */
43035
+ id: string;
43036
+ name: string;
43037
+ team: {
43038
+ /** Format: uuid */
43039
+ id: string;
43040
+ name: string;
43041
+ };
43042
+ address: {
43043
+ line1: string | null;
43044
+ line2: string | null;
43045
+ city: string | null;
43046
+ postcode: string | null;
43047
+ stateCode: string | null;
43048
+ countryCode: string | null;
43049
+ full: string | null;
43050
+ };
43051
+ }[];
43052
+ pagination: {
43053
+ /** @default 100 */
43054
+ limit: number;
43055
+ /** @default 1 */
43056
+ page: number;
43057
+ total: number;
43058
+ totalPage: number;
43059
+ nextPage?: number;
43060
+ };
43061
+ };
43062
+ };
43063
+ };
43064
+ /** @description Bad request */
43065
+ 400: {
43066
+ headers: {
43067
+ [name: string]: unknown;
43068
+ };
43069
+ content: {
43070
+ "application/json": {
43071
+ code: string;
43072
+ message: string;
43073
+ links?: {
43074
+ docs: string;
43075
+ schema: string;
43076
+ };
43077
+ issues?: {
43078
+ message: string;
43079
+ path?: (string | number)[];
43080
+ schema?: string;
43081
+ }[];
43082
+ context?: unknown;
43083
+ };
43084
+ };
43085
+ };
43086
+ /** @description Unauthorized */
43087
+ 401: {
43088
+ headers: {
43089
+ [name: string]: unknown;
43090
+ };
43091
+ content: {
43092
+ "application/json": {
43093
+ code: string;
43094
+ message: string;
43095
+ links?: {
43096
+ docs: string;
43097
+ schema: string;
43098
+ };
43099
+ issues?: {
43100
+ message: string;
43101
+ path?: (string | number)[];
43102
+ schema?: string;
43103
+ }[];
43104
+ context?: unknown;
43105
+ };
43106
+ };
43107
+ };
43108
+ /** @description Forbidden */
43109
+ 403: {
43110
+ headers: {
43111
+ [name: string]: unknown;
43112
+ };
43113
+ content: {
43114
+ "application/json": {
43115
+ code: string;
43116
+ message: string;
43117
+ links?: {
43118
+ docs: string;
43119
+ schema: string;
43120
+ };
43121
+ issues?: {
43122
+ message: string;
43123
+ path?: (string | number)[];
43124
+ schema?: string;
43125
+ }[];
43126
+ context?: unknown;
43127
+ };
43128
+ };
43129
+ };
43130
+ /** @description Not found */
43131
+ 404: {
43132
+ headers: {
43133
+ [name: string]: unknown;
43134
+ };
43135
+ content: {
43136
+ "application/json": {
43137
+ code: string;
43138
+ message: string;
43139
+ links?: {
43140
+ docs: string;
43141
+ schema: string;
43142
+ };
43143
+ issues?: {
43144
+ message: string;
43145
+ path?: (string | number)[];
43146
+ schema?: string;
43147
+ }[];
43148
+ context?: unknown;
43149
+ };
43150
+ };
43151
+ };
43152
+ /** @description Internal server error */
43153
+ 500: {
43154
+ headers: {
43155
+ [name: string]: unknown;
43156
+ };
43157
+ content: {
43158
+ "application/json": {
43159
+ code: string;
43160
+ message: string;
43161
+ links?: {
43162
+ docs: string;
43163
+ schema: string;
43164
+ };
43165
+ issues?: {
43166
+ message: string;
43167
+ path?: (string | number)[];
43168
+ schema?: string;
43169
+ }[];
43170
+ context?: unknown;
43171
+ };
43172
+ };
43173
+ };
43174
+ /** @description Service unavailable */
43175
+ 503: {
43176
+ headers: {
43177
+ [name: string]: unknown;
43178
+ };
43179
+ content: {
43180
+ "application/json": {
43181
+ code: string;
43182
+ message: string;
43183
+ links?: {
43184
+ docs: string;
43185
+ schema: string;
43186
+ };
43187
+ issues?: {
43188
+ message: string;
43189
+ path?: (string | number)[];
43190
+ schema?: string;
43191
+ }[];
43192
+ context?: unknown;
43193
+ };
43194
+ };
43195
+ };
43196
+ };
43197
+ };
42787
43198
  getPartnerMembers: {
42788
43199
  parameters: {
42789
43200
  query?: never;
@@ -78226,6 +78637,7 @@ export interface operations {
78226
78637
  id: string;
78227
78638
  name: string;
78228
78639
  } | null;
78640
+ billingPartnerId: string | null;
78229
78641
  companyName?: string | null;
78230
78642
  /** @enum {string} */
78231
78643
  type: "partner" | "admin" | "propertyManager";
@@ -78234,7 +78646,7 @@ export interface operations {
78234
78646
  billingSubscriptionStatus?: string | null;
78235
78647
  billingPlan?: string | null;
78236
78648
  billingPaymentMethodType?: string | null;
78237
- billingCustomerId?: string | null;
78649
+ billingCustomerId: string | null;
78238
78650
  colorPrimary?: string | null;
78239
78651
  createdAt?: string | null;
78240
78652
  updatedAt?: string | null;
@@ -78624,6 +79036,7 @@ export interface operations {
78624
79036
  id: string;
78625
79037
  name: string;
78626
79038
  } | null;
79039
+ billingPartnerId: string | null;
78627
79040
  companyName?: string | null;
78628
79041
  /** @enum {string} */
78629
79042
  type: "partner" | "admin" | "propertyManager";
@@ -78632,7 +79045,7 @@ export interface operations {
78632
79045
  billingSubscriptionStatus?: string | null;
78633
79046
  billingPlan?: string | null;
78634
79047
  billingPaymentMethodType?: string | null;
78635
- billingCustomerId?: string | null;
79048
+ billingCustomerId: string | null;
78636
79049
  colorPrimary?: string | null;
78637
79050
  createdAt?: string | null;
78638
79051
  updatedAt?: string | null;
@@ -79902,6 +80315,7 @@ export interface operations {
79902
80315
  id: string;
79903
80316
  name: string;
79904
80317
  } | null;
80318
+ billingPartnerId: string | null;
79905
80319
  companyName?: string | null;
79906
80320
  /** @enum {string} */
79907
80321
  type: "partner" | "admin" | "propertyManager";
@@ -79910,7 +80324,7 @@ export interface operations {
79910
80324
  billingSubscriptionStatus?: string | null;
79911
80325
  billingPlan?: string | null;
79912
80326
  billingPaymentMethodType?: string | null;
79913
- billingCustomerId?: string | null;
80327
+ billingCustomerId: string | null;
79914
80328
  colorPrimary?: string | null;
79915
80329
  createdAt?: string | null;
79916
80330
  updatedAt?: string | null;
@@ -81276,7 +81690,7 @@ export interface operations {
81276
81690
  billingSubscriptionStatus?: string | null;
81277
81691
  billingPlan?: string | null;
81278
81692
  billingPaymentMethodType?: string | null;
81279
- billingCustomerId?: string | null;
81693
+ billingCustomerId: string | null;
81280
81694
  colorPrimary?: string | null;
81281
81695
  createdAt?: string | null;
81282
81696
  updatedAt?: string | null;
@@ -81661,6 +82075,7 @@ export interface operations {
81661
82075
  id: string;
81662
82076
  name: string;
81663
82077
  } | null;
82078
+ billingPartnerId: string | null;
81664
82079
  companyName?: string | null;
81665
82080
  /** @enum {string} */
81666
82081
  type: "partner" | "admin" | "propertyManager";
@@ -81669,7 +82084,7 @@ export interface operations {
81669
82084
  billingSubscriptionStatus?: string | null;
81670
82085
  billingPlan?: string | null;
81671
82086
  billingPaymentMethodType?: string | null;
81672
- billingCustomerId?: string | null;
82087
+ billingCustomerId: string | null;
81673
82088
  colorPrimary?: string | null;
81674
82089
  createdAt?: string | null;
81675
82090
  updatedAt?: string | null;
@@ -82855,7 +83270,7 @@ export interface operations {
82855
83270
  billingSubscriptionStatus?: string | null;
82856
83271
  billingPlan?: string | null;
82857
83272
  billingPaymentMethodType?: string | null;
82858
- billingCustomerId?: string | null;
83273
+ billingCustomerId: string | null;
82859
83274
  colorPrimary?: string | null;
82860
83275
  createdAt?: string | null;
82861
83276
  updatedAt?: string | null;
@@ -83183,7 +83598,7 @@ export interface operations {
83183
83598
  billingSubscriptionStatus?: string | null;
83184
83599
  billingPlan?: string | null;
83185
83600
  billingPaymentMethodType?: string | null;
83186
- billingCustomerId?: string | null;
83601
+ billingCustomerId: string | null;
83187
83602
  colorPrimary?: string | null;
83188
83603
  createdAt?: string | null;
83189
83604
  updatedAt?: string | null;
@@ -83289,6 +83704,7 @@ export interface operations {
83289
83704
  };
83290
83705
  /** Format: uri */
83291
83706
  apiBaseUrl: string;
83707
+ billingPartnerId: string | null;
83292
83708
  };
83293
83709
  };
83294
83710
  };