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