@vrplatform/api 1.3.1-stage.4666 → 1.3.1-stage.4670

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.
@@ -1006,7 +1006,11 @@ export interface paths {
1006
1006
  path?: never;
1007
1007
  cookie?: never;
1008
1008
  };
1009
- /** @description Get the current team email template for trigger-rendered emails. */
1009
+ /**
1010
+ * @description Get the current team email template for trigger-rendered emails.
1011
+ *
1012
+ * Required scope: team-settings:read
1013
+ */
1010
1014
  get: operations["getEmailTemplate"];
1011
1015
  put?: never;
1012
1016
  post?: never;
@@ -1016,6 +1020,27 @@ export interface paths {
1016
1020
  patch?: never;
1017
1021
  trace?: never;
1018
1022
  };
1023
+ "/email-templates/{type}": {
1024
+ parameters: {
1025
+ query?: never;
1026
+ header?: never;
1027
+ path?: never;
1028
+ cookie?: never;
1029
+ };
1030
+ get?: never;
1031
+ /**
1032
+ * @description Create or update an email template for the current team.
1033
+ *
1034
+ * Required scope: team-settings:write
1035
+ */
1036
+ put: operations["upsertEmailTemplate"];
1037
+ post?: never;
1038
+ delete?: never;
1039
+ options?: never;
1040
+ head?: never;
1041
+ patch?: never;
1042
+ trace?: never;
1043
+ };
1019
1044
  "/embed-sessions/exchange": {
1020
1045
  parameters: {
1021
1046
  query?: never;
@@ -1562,7 +1587,7 @@ export interface paths {
1562
1587
  path?: never;
1563
1588
  cookie?: never;
1564
1589
  };
1565
- /** @description List feature flags across all teams, with enabled-team and tester counts. VRP-admin only. */
1590
+ /** @description List feature flags with team and user assignments. Omitted status returns testing and ready flags. Sorting defaults to createdAt desc. VRP-admin only. */
1566
1591
  get: operations["getInternalFeatureFlags"];
1567
1592
  put?: never;
1568
1593
  /** @description Create a feature flag. Team enablement and testers are managed via the teams and users sub-resources. VRP-admin only. */
@@ -1598,9 +1623,9 @@ export interface paths {
1598
1623
  path?: never;
1599
1624
  cookie?: never;
1600
1625
  };
1601
- /** @description List teams a feature flag is enabled on. Status 'all' enables the flag for every team member; 'partially' only for users approved on the flag. VRP-admin only. */
1626
+ /** @description List team assignments for a feature flag. Status 'all' enables the flag for every team member; 'partially' only for users approved on the flag; 'disabled' explicitly denies access. VRP-admin only. */
1602
1627
  get: operations["getInternalFeatureFlagsByIdTeams"];
1603
- /** @description Replace the set of teams a feature flag is enabled on. Status 'all' enables the flag for every team member; 'partially' only for users approved on the flag. Teams served from another data region are rejected. VRP-admin only. */
1628
+ /** @description Replace the set of teams a feature flag is enabled on. Status 'all' enables the flag for every team member; 'partially' only for users approved on the flag; 'disabled' explicitly denies access. Teams served from another data region are rejected. VRP-admin only. */
1604
1629
  put: operations["putInternalFeatureFlagsByIdTeams"];
1605
1630
  post?: never;
1606
1631
  delete?: never;
@@ -1616,9 +1641,9 @@ export interface paths {
1616
1641
  path?: never;
1617
1642
  cookie?: never;
1618
1643
  };
1619
- /** @description List testers approved on a feature flag. Status 'all' means the user sees the flag everywhere; 'partially' only on teams where the flag is 'partially' enabled. VRP-admin only. */
1644
+ /** @description List user assignments for a feature flag. Status 'all' means the user sees the flag everywhere; 'partially' only on teams where the flag is 'partially' enabled; 'disabled' explicitly denies access. VRP-admin only. */
1620
1645
  get: operations["getInternalFeatureFlagsByIdUsers"];
1621
- /** @description Replace the set of testers approved on a feature flag. Status 'all' means the user sees the flag everywhere; 'partially' only on teams where the flag is 'partially' enabled. VRP-admin only. */
1646
+ /** @description Replace the set of testers approved on a feature flag. Status 'all' means the user sees the flag everywhere; 'partially' only on teams where the flag is 'partially' enabled; 'disabled' explicitly denies access. VRP-admin only. */
1622
1647
  put: operations["putInternalFeatureFlagsByIdUsers"];
1623
1648
  post?: never;
1624
1649
  delete?: never;
@@ -4389,7 +4414,7 @@ export interface paths {
4389
4414
  */
4390
4415
  get: operations["getTeam"];
4391
4416
  /**
4392
- * @description Update the current team (singleton: the team in scope via the x-team-id header). Setting statementStartAt reclassifies unlocked journals around the first live GL date while explicit opening-balance journals remain active.
4417
+ * @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. Setting statementStartAt reclassifies unlocked journals around the first live GL date while explicit opening-balance journals remain active.
4393
4418
  *
4394
4419
  * Required scope: teams:write
4395
4420
  */
@@ -20210,7 +20235,7 @@ export interface operations {
20210
20235
  parameters: {
20211
20236
  query: {
20212
20237
  /** @description Email template type to fetch. */
20213
- type: "ownerInvite" | "ownerStatementPublished" | "owner-invite" | "ownerStatement-published";
20238
+ type: "ownerInvite" | "ownerStatementPublished" | "invitePropertyManager" | "owner-invite" | "ownerStatement-published";
20214
20239
  };
20215
20240
  header?: never;
20216
20241
  path?: never;
@@ -20229,7 +20254,7 @@ export interface operations {
20229
20254
  /** Format: uuid */
20230
20255
  id: string;
20231
20256
  /** @enum {string} */
20232
- type: "ownerInvite" | "ownerStatementPublished";
20257
+ type: "ownerInvite" | "ownerStatementPublished" | "invitePropertyManager";
20233
20258
  data: {
20234
20259
  subject: string;
20235
20260
  shortDescription: string;
@@ -20240,8 +20265,18 @@ export interface operations {
20240
20265
  buttonText: string;
20241
20266
  href?: string | null;
20242
20267
  };
20243
- createdAt?: string | null;
20244
- updatedAt?: string | null;
20268
+ /**
20269
+ * Format: date-time
20270
+ * @description Timestamp string with date, time, milliseconds, and timezone.
20271
+ * @example 2024-01-15T12:30:00.000+00:00
20272
+ */
20273
+ createdAt: string;
20274
+ /**
20275
+ * Format: date-time
20276
+ * @description Timestamp string with date, time, milliseconds, and timezone.
20277
+ * @example 2024-01-15T12:30:00.000+00:00
20278
+ */
20279
+ updatedAt: string;
20245
20280
  } | null;
20246
20281
  };
20247
20282
  };
@@ -20380,6 +20415,204 @@ export interface operations {
20380
20415
  };
20381
20416
  };
20382
20417
  };
20418
+ upsertEmailTemplate: {
20419
+ parameters: {
20420
+ query?: never;
20421
+ header?: never;
20422
+ path: {
20423
+ /** @description Email template type to save. */
20424
+ type: "ownerInvite" | "ownerStatementPublished" | "invitePropertyManager";
20425
+ };
20426
+ cookie?: never;
20427
+ };
20428
+ requestBody?: {
20429
+ content: {
20430
+ "application/json": {
20431
+ /** @description Email template content to save. */
20432
+ data: {
20433
+ subject: string;
20434
+ shortDescription: string;
20435
+ banner?: string | null;
20436
+ header: string;
20437
+ bodyOne: string;
20438
+ bodyTwo: string;
20439
+ buttonText: string;
20440
+ href?: string | null;
20441
+ };
20442
+ };
20443
+ };
20444
+ };
20445
+ responses: {
20446
+ /** @description Successful response */
20447
+ 200: {
20448
+ headers: {
20449
+ [name: string]: unknown;
20450
+ };
20451
+ content: {
20452
+ "application/json": {
20453
+ /** Format: uuid */
20454
+ id: string;
20455
+ /** @enum {string} */
20456
+ type: "ownerInvite" | "ownerStatementPublished" | "invitePropertyManager";
20457
+ data: {
20458
+ subject: string;
20459
+ shortDescription: string;
20460
+ banner?: string | null;
20461
+ header: string;
20462
+ bodyOne: string;
20463
+ bodyTwo: string;
20464
+ buttonText: string;
20465
+ href?: string | null;
20466
+ };
20467
+ /**
20468
+ * Format: date-time
20469
+ * @description Timestamp string with date, time, milliseconds, and timezone.
20470
+ * @example 2024-01-15T12:30:00.000+00:00
20471
+ */
20472
+ createdAt: string;
20473
+ /**
20474
+ * Format: date-time
20475
+ * @description Timestamp string with date, time, milliseconds, and timezone.
20476
+ * @example 2024-01-15T12:30:00.000+00:00
20477
+ */
20478
+ updatedAt: string;
20479
+ };
20480
+ };
20481
+ };
20482
+ /** @description Bad request */
20483
+ 400: {
20484
+ headers: {
20485
+ [name: string]: unknown;
20486
+ };
20487
+ content: {
20488
+ "application/json": {
20489
+ code: string;
20490
+ message: string;
20491
+ links?: {
20492
+ docs: string;
20493
+ schema: string;
20494
+ };
20495
+ issues?: {
20496
+ message: string;
20497
+ path?: (string | number)[];
20498
+ schema?: string;
20499
+ }[];
20500
+ context?: unknown;
20501
+ };
20502
+ };
20503
+ };
20504
+ /** @description Unauthorized */
20505
+ 401: {
20506
+ headers: {
20507
+ [name: string]: unknown;
20508
+ };
20509
+ content: {
20510
+ "application/json": {
20511
+ code: string;
20512
+ message: string;
20513
+ links?: {
20514
+ docs: string;
20515
+ schema: string;
20516
+ };
20517
+ issues?: {
20518
+ message: string;
20519
+ path?: (string | number)[];
20520
+ schema?: string;
20521
+ }[];
20522
+ context?: unknown;
20523
+ };
20524
+ };
20525
+ };
20526
+ /** @description Forbidden */
20527
+ 403: {
20528
+ headers: {
20529
+ [name: string]: unknown;
20530
+ };
20531
+ content: {
20532
+ "application/json": {
20533
+ code: string;
20534
+ message: string;
20535
+ links?: {
20536
+ docs: string;
20537
+ schema: string;
20538
+ };
20539
+ issues?: {
20540
+ message: string;
20541
+ path?: (string | number)[];
20542
+ schema?: string;
20543
+ }[];
20544
+ context?: unknown;
20545
+ };
20546
+ };
20547
+ };
20548
+ /** @description Not found */
20549
+ 404: {
20550
+ headers: {
20551
+ [name: string]: unknown;
20552
+ };
20553
+ content: {
20554
+ "application/json": {
20555
+ code: string;
20556
+ message: string;
20557
+ links?: {
20558
+ docs: string;
20559
+ schema: string;
20560
+ };
20561
+ issues?: {
20562
+ message: string;
20563
+ path?: (string | number)[];
20564
+ schema?: string;
20565
+ }[];
20566
+ context?: unknown;
20567
+ };
20568
+ };
20569
+ };
20570
+ /** @description Internal server error */
20571
+ 500: {
20572
+ headers: {
20573
+ [name: string]: unknown;
20574
+ };
20575
+ content: {
20576
+ "application/json": {
20577
+ code: string;
20578
+ message: string;
20579
+ links?: {
20580
+ docs: string;
20581
+ schema: string;
20582
+ };
20583
+ issues?: {
20584
+ message: string;
20585
+ path?: (string | number)[];
20586
+ schema?: string;
20587
+ }[];
20588
+ context?: unknown;
20589
+ };
20590
+ };
20591
+ };
20592
+ /** @description Service unavailable */
20593
+ 503: {
20594
+ headers: {
20595
+ [name: string]: unknown;
20596
+ };
20597
+ content: {
20598
+ "application/json": {
20599
+ code: string;
20600
+ message: string;
20601
+ links?: {
20602
+ docs: string;
20603
+ schema: string;
20604
+ };
20605
+ issues?: {
20606
+ message: string;
20607
+ path?: (string | number)[];
20608
+ schema?: string;
20609
+ }[];
20610
+ context?: unknown;
20611
+ };
20612
+ };
20613
+ };
20614
+ };
20615
+ };
20383
20616
  exchangeEmbedSession: {
20384
20617
  parameters: {
20385
20618
  query?: never;
@@ -28107,6 +28340,9 @@ export interface operations {
28107
28340
  parameters: {
28108
28341
  query?: {
28109
28342
  search?: string;
28343
+ status?: "testing" | "ready" | "deployed";
28344
+ sortBy?: "createdAt" | "title";
28345
+ sortDirection?: "asc" | "desc";
28110
28346
  limit?: number;
28111
28347
  page?: number;
28112
28348
  offset?: number;
@@ -28131,10 +28367,32 @@ export interface operations {
28131
28367
  description: string | null;
28132
28368
  url: string | null;
28133
28369
  issueUrl: string | null;
28134
- /** @description Catalog status of the flag itself (e.g. 'testing'). */
28135
- status: string | null;
28370
+ /** @description Catalog status of the flag itself. */
28371
+ status: ("testing" | "ready" | "deployed") | null;
28136
28372
  /** @description User ids required to approve this feature. */
28137
28373
  requiredApprovals: string[];
28374
+ teams: {
28375
+ /** Format: uuid */
28376
+ id: string;
28377
+ name: string | null;
28378
+ /**
28379
+ * @description 'all' enables the flag for every team member; 'partially' only for users approved on the flag; 'disabled' explicitly denies access.
28380
+ * @enum {string}
28381
+ */
28382
+ status: "all" | "partially" | "disabled";
28383
+ }[];
28384
+ users: {
28385
+ /** Format: uuid */
28386
+ id: string;
28387
+ email: string | null;
28388
+ firstName: string | null;
28389
+ lastName: string | null;
28390
+ /**
28391
+ * @description 'all' enables the flag for every team member; 'partially' only for users approved on the flag; 'disabled' explicitly denies access.
28392
+ * @enum {string}
28393
+ */
28394
+ status: "all" | "partially" | "disabled";
28395
+ }[];
28138
28396
  enabledTeamsCount: number;
28139
28397
  testersCount: number;
28140
28398
  /**
@@ -28310,7 +28568,7 @@ export interface operations {
28310
28568
  description?: string | null;
28311
28569
  url?: string | null;
28312
28570
  issueUrl?: string | null;
28313
- status?: string | null;
28571
+ status?: ("testing" | "ready" | "deployed") | null;
28314
28572
  requiredApprovals?: string[];
28315
28573
  };
28316
28574
  };
@@ -28329,10 +28587,32 @@ export interface operations {
28329
28587
  description: string | null;
28330
28588
  url: string | null;
28331
28589
  issueUrl: string | null;
28332
- /** @description Catalog status of the flag itself (e.g. 'testing'). */
28333
- status: string | null;
28590
+ /** @description Catalog status of the flag itself. */
28591
+ status: ("testing" | "ready" | "deployed") | null;
28334
28592
  /** @description User ids required to approve this feature. */
28335
28593
  requiredApprovals: string[];
28594
+ teams: {
28595
+ /** Format: uuid */
28596
+ id: string;
28597
+ name: string | null;
28598
+ /**
28599
+ * @description 'all' enables the flag for every team member; 'partially' only for users approved on the flag; 'disabled' explicitly denies access.
28600
+ * @enum {string}
28601
+ */
28602
+ status: "all" | "partially" | "disabled";
28603
+ }[];
28604
+ users: {
28605
+ /** Format: uuid */
28606
+ id: string;
28607
+ email: string | null;
28608
+ firstName: string | null;
28609
+ lastName: string | null;
28610
+ /**
28611
+ * @description 'all' enables the flag for every team member; 'partially' only for users approved on the flag; 'disabled' explicitly denies access.
28612
+ * @enum {string}
28613
+ */
28614
+ status: "all" | "partially" | "disabled";
28615
+ }[];
28336
28616
  enabledTeamsCount: number;
28337
28617
  testersCount: number;
28338
28618
  /**
@@ -28500,7 +28780,7 @@ export interface operations {
28500
28780
  description?: string | null;
28501
28781
  url?: string | null;
28502
28782
  issueUrl?: string | null;
28503
- status?: string | null;
28783
+ status?: ("testing" | "ready" | "deployed") | null;
28504
28784
  requiredApprovals?: string[];
28505
28785
  };
28506
28786
  };
@@ -28519,10 +28799,32 @@ export interface operations {
28519
28799
  description: string | null;
28520
28800
  url: string | null;
28521
28801
  issueUrl: string | null;
28522
- /** @description Catalog status of the flag itself (e.g. 'testing'). */
28523
- status: string | null;
28802
+ /** @description Catalog status of the flag itself. */
28803
+ status: ("testing" | "ready" | "deployed") | null;
28524
28804
  /** @description User ids required to approve this feature. */
28525
28805
  requiredApprovals: string[];
28806
+ teams: {
28807
+ /** Format: uuid */
28808
+ id: string;
28809
+ name: string | null;
28810
+ /**
28811
+ * @description 'all' enables the flag for every team member; 'partially' only for users approved on the flag; 'disabled' explicitly denies access.
28812
+ * @enum {string}
28813
+ */
28814
+ status: "all" | "partially" | "disabled";
28815
+ }[];
28816
+ users: {
28817
+ /** Format: uuid */
28818
+ id: string;
28819
+ email: string | null;
28820
+ firstName: string | null;
28821
+ lastName: string | null;
28822
+ /**
28823
+ * @description 'all' enables the flag for every team member; 'partially' only for users approved on the flag; 'disabled' explicitly denies access.
28824
+ * @enum {string}
28825
+ */
28826
+ status: "all" | "partially" | "disabled";
28827
+ }[];
28526
28828
  enabledTeamsCount: number;
28527
28829
  testersCount: number;
28528
28830
  /**
@@ -28851,13 +29153,13 @@ export interface operations {
28851
29153
  "application/json": {
28852
29154
  data: {
28853
29155
  /** Format: uuid */
28854
- teamId: string;
28855
- teamName: string | null;
29156
+ id: string;
29157
+ name: string | null;
28856
29158
  /**
28857
- * @description 'all' enables the flag for every team member; 'partially' only for users approved on the flag.
29159
+ * @description 'all' enables the flag for every team member; 'partially' only for users approved on the flag; 'disabled' explicitly denies access.
28858
29160
  * @enum {string}
28859
29161
  */
28860
- status: "all" | "partially";
29162
+ status: "all" | "partially" | "disabled";
28861
29163
  }[];
28862
29164
  };
28863
29165
  };
@@ -29010,12 +29312,12 @@ export interface operations {
29010
29312
  "application/json": {
29011
29313
  teams: {
29012
29314
  /** Format: uuid */
29013
- teamId: string;
29315
+ id: string;
29014
29316
  /**
29015
- * @description 'all' enables the flag for every team member; 'partially' only for users approved on the flag.
29317
+ * @description 'all' enables the flag for every team member; 'partially' only for users approved on the flag; 'disabled' explicitly denies access.
29016
29318
  * @enum {string}
29017
29319
  */
29018
- status: "all" | "partially";
29320
+ status: "all" | "partially" | "disabled";
29019
29321
  }[];
29020
29322
  };
29021
29323
  };
@@ -29030,13 +29332,13 @@ export interface operations {
29030
29332
  "application/json": {
29031
29333
  data: {
29032
29334
  /** Format: uuid */
29033
- teamId: string;
29034
- teamName: string | null;
29335
+ id: string;
29336
+ name: string | null;
29035
29337
  /**
29036
- * @description 'all' enables the flag for every team member; 'partially' only for users approved on the flag.
29338
+ * @description 'all' enables the flag for every team member; 'partially' only for users approved on the flag; 'disabled' explicitly denies access.
29037
29339
  * @enum {string}
29038
29340
  */
29039
- status: "all" | "partially";
29341
+ status: "all" | "partially" | "disabled";
29040
29342
  }[];
29041
29343
  };
29042
29344
  };
@@ -29195,14 +29497,15 @@ export interface operations {
29195
29497
  "application/json": {
29196
29498
  data: {
29197
29499
  /** Format: uuid */
29198
- userId: string;
29500
+ id: string;
29199
29501
  email: string | null;
29200
- name: string | null;
29502
+ firstName: string | null;
29503
+ lastName: string | null;
29201
29504
  /**
29202
- * @description 'all' enables the flag for every team member; 'partially' only for users approved on the flag.
29505
+ * @description 'all' enables the flag for every team member; 'partially' only for users approved on the flag; 'disabled' explicitly denies access.
29203
29506
  * @enum {string}
29204
29507
  */
29205
- status: "all" | "partially";
29508
+ status: "all" | "partially" | "disabled";
29206
29509
  }[];
29207
29510
  };
29208
29511
  };
@@ -29355,12 +29658,12 @@ export interface operations {
29355
29658
  "application/json": {
29356
29659
  users: {
29357
29660
  /** Format: uuid */
29358
- userId: string;
29661
+ id: string;
29359
29662
  /**
29360
- * @description 'all' enables the flag for every team member; 'partially' only for users approved on the flag.
29663
+ * @description 'all' enables the flag for every team member; 'partially' only for users approved on the flag; 'disabled' explicitly denies access.
29361
29664
  * @enum {string}
29362
29665
  */
29363
- status: "all" | "partially";
29666
+ status: "all" | "partially" | "disabled";
29364
29667
  }[];
29365
29668
  };
29366
29669
  };
@@ -29375,14 +29678,15 @@ export interface operations {
29375
29678
  "application/json": {
29376
29679
  data: {
29377
29680
  /** Format: uuid */
29378
- userId: string;
29681
+ id: string;
29379
29682
  email: string | null;
29380
- name: string | null;
29683
+ firstName: string | null;
29684
+ lastName: string | null;
29381
29685
  /**
29382
- * @description 'all' enables the flag for every team member; 'partially' only for users approved on the flag.
29686
+ * @description 'all' enables the flag for every team member; 'partially' only for users approved on the flag; 'disabled' explicitly denies access.
29383
29687
  * @enum {string}
29384
29688
  */
29385
- status: "all" | "partially";
29689
+ status: "all" | "partially" | "disabled";
29386
29690
  }[];
29387
29691
  };
29388
29692
  };
@@ -37713,6 +38017,7 @@ export interface operations {
37713
38017
  reservationId: string | null;
37714
38018
  hasPms: boolean;
37715
38019
  activePmsConnectionId: string | null;
38020
+ hasOwnerBlockingConnection: boolean;
37716
38021
  hasDeposit: boolean;
37717
38022
  depositTransactionId: string | null;
37718
38023
  hasListingNeedsReview: boolean;
@@ -77247,6 +77552,7 @@ export interface operations {
77247
77552
  isOnboarding?: boolean | null;
77248
77553
  isOpex?: boolean;
77249
77554
  booksClosedAt?: string | null;
77555
+ /** @description Logo URL or data URI. Send null to clear it. */
77250
77556
  logo?: string | null;
77251
77557
  statementStartAt?: string | null;
77252
77558
  effectiveStatementStartAt?: string | null;
@@ -77256,6 +77562,8 @@ export interface operations {
77256
77562
  /** Format: email */
77257
77563
  email?: string;
77258
77564
  supportEmail?: string | null;
77565
+ /** @description Primary brand color. Send null to clear it. */
77566
+ colorPrimary?: string | null;
77259
77567
  migratedFromTenantId?: string | null;
77260
77568
  settings?: {
77261
77569
  showVRPilotGuide?: boolean;