@vrplatform/api 1.3.1-stage.4667 → 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.
package/package.json CHANGED
@@ -3,7 +3,7 @@
3
3
  "publishConfig": {
4
4
  "access": "public"
5
5
  },
6
- "version": "1.3.1-stage.4667",
6
+ "version": "1.3.1-stage.4670",
7
7
  "description": "",
8
8
  "main": "build/main/index.js",
9
9
  "module": "build/module/index.js",
@@ -1007,7 +1007,11 @@ export interface paths {
1007
1007
  path?: never;
1008
1008
  cookie?: never;
1009
1009
  };
1010
- /** @description Get the current team email template for trigger-rendered emails. */
1010
+ /**
1011
+ * @description Get the current team email template for trigger-rendered emails.
1012
+ *
1013
+ * Required scope: team-settings:read
1014
+ */
1011
1015
  get: operations["getEmailTemplate"];
1012
1016
  put?: never;
1013
1017
  post?: never;
@@ -1017,6 +1021,27 @@ export interface paths {
1017
1021
  patch?: never;
1018
1022
  trace?: never;
1019
1023
  };
1024
+ "/email-templates/{type}": {
1025
+ parameters: {
1026
+ query?: never;
1027
+ header?: never;
1028
+ path?: never;
1029
+ cookie?: never;
1030
+ };
1031
+ get?: never;
1032
+ /**
1033
+ * @description Create or update an email template for the current team.
1034
+ *
1035
+ * Required scope: team-settings:write
1036
+ */
1037
+ put: operations["upsertEmailTemplate"];
1038
+ post?: never;
1039
+ delete?: never;
1040
+ options?: never;
1041
+ head?: never;
1042
+ patch?: never;
1043
+ trace?: never;
1044
+ };
1020
1045
  "/embed-sessions/exchange": {
1021
1046
  parameters: {
1022
1047
  query?: never;
@@ -4390,7 +4415,7 @@ export interface paths {
4390
4415
  */
4391
4416
  get: operations["getTeam"];
4392
4417
  /**
4393
- * @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.
4418
+ * @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.
4394
4419
  *
4395
4420
  * Required scope: teams:write
4396
4421
  */
@@ -20211,7 +20236,7 @@ export interface operations {
20211
20236
  parameters: {
20212
20237
  query: {
20213
20238
  /** @description Email template type to fetch. */
20214
- type: "ownerInvite" | "ownerStatementPublished" | "owner-invite" | "ownerStatement-published";
20239
+ type: "ownerInvite" | "ownerStatementPublished" | "invitePropertyManager" | "owner-invite" | "ownerStatement-published";
20215
20240
  };
20216
20241
  header?: never;
20217
20242
  path?: never;
@@ -20230,7 +20255,7 @@ export interface operations {
20230
20255
  /** Format: uuid */
20231
20256
  id: string;
20232
20257
  /** @enum {string} */
20233
- type: "ownerInvite" | "ownerStatementPublished";
20258
+ type: "ownerInvite" | "ownerStatementPublished" | "invitePropertyManager";
20234
20259
  data: {
20235
20260
  subject: string;
20236
20261
  shortDescription: string;
@@ -20241,8 +20266,18 @@ export interface operations {
20241
20266
  buttonText: string;
20242
20267
  href?: string | null;
20243
20268
  };
20244
- createdAt?: string | null;
20245
- updatedAt?: string | null;
20269
+ /**
20270
+ * Format: date-time
20271
+ * @description Timestamp string with date, time, milliseconds, and timezone.
20272
+ * @example 2024-01-15T12:30:00.000+00:00
20273
+ */
20274
+ createdAt: string;
20275
+ /**
20276
+ * Format: date-time
20277
+ * @description Timestamp string with date, time, milliseconds, and timezone.
20278
+ * @example 2024-01-15T12:30:00.000+00:00
20279
+ */
20280
+ updatedAt: string;
20246
20281
  } | null;
20247
20282
  };
20248
20283
  };
@@ -20381,6 +20416,204 @@ export interface operations {
20381
20416
  };
20382
20417
  };
20383
20418
  };
20419
+ upsertEmailTemplate: {
20420
+ parameters: {
20421
+ query?: never;
20422
+ header?: never;
20423
+ path: {
20424
+ /** @description Email template type to save. */
20425
+ type: "ownerInvite" | "ownerStatementPublished" | "invitePropertyManager";
20426
+ };
20427
+ cookie?: never;
20428
+ };
20429
+ requestBody?: {
20430
+ content: {
20431
+ "application/json": {
20432
+ /** @description Email template content to save. */
20433
+ data: {
20434
+ subject: string;
20435
+ shortDescription: string;
20436
+ banner?: string | null;
20437
+ header: string;
20438
+ bodyOne: string;
20439
+ bodyTwo: string;
20440
+ buttonText: string;
20441
+ href?: string | null;
20442
+ };
20443
+ };
20444
+ };
20445
+ };
20446
+ responses: {
20447
+ /** @description Successful response */
20448
+ 200: {
20449
+ headers: {
20450
+ [name: string]: unknown;
20451
+ };
20452
+ content: {
20453
+ "application/json": {
20454
+ /** Format: uuid */
20455
+ id: string;
20456
+ /** @enum {string} */
20457
+ type: "ownerInvite" | "ownerStatementPublished" | "invitePropertyManager";
20458
+ data: {
20459
+ subject: string;
20460
+ shortDescription: string;
20461
+ banner?: string | null;
20462
+ header: string;
20463
+ bodyOne: string;
20464
+ bodyTwo: string;
20465
+ buttonText: string;
20466
+ href?: string | null;
20467
+ };
20468
+ /**
20469
+ * Format: date-time
20470
+ * @description Timestamp string with date, time, milliseconds, and timezone.
20471
+ * @example 2024-01-15T12:30:00.000+00:00
20472
+ */
20473
+ createdAt: string;
20474
+ /**
20475
+ * Format: date-time
20476
+ * @description Timestamp string with date, time, milliseconds, and timezone.
20477
+ * @example 2024-01-15T12:30:00.000+00:00
20478
+ */
20479
+ updatedAt: string;
20480
+ };
20481
+ };
20482
+ };
20483
+ /** @description Bad request */
20484
+ 400: {
20485
+ headers: {
20486
+ [name: string]: unknown;
20487
+ };
20488
+ content: {
20489
+ "application/json": {
20490
+ code: string;
20491
+ message: string;
20492
+ links?: {
20493
+ docs: string;
20494
+ schema: string;
20495
+ };
20496
+ issues?: {
20497
+ message: string;
20498
+ path?: (string | number)[];
20499
+ schema?: string;
20500
+ }[];
20501
+ context?: unknown;
20502
+ };
20503
+ };
20504
+ };
20505
+ /** @description Unauthorized */
20506
+ 401: {
20507
+ headers: {
20508
+ [name: string]: unknown;
20509
+ };
20510
+ content: {
20511
+ "application/json": {
20512
+ code: string;
20513
+ message: string;
20514
+ links?: {
20515
+ docs: string;
20516
+ schema: string;
20517
+ };
20518
+ issues?: {
20519
+ message: string;
20520
+ path?: (string | number)[];
20521
+ schema?: string;
20522
+ }[];
20523
+ context?: unknown;
20524
+ };
20525
+ };
20526
+ };
20527
+ /** @description Forbidden */
20528
+ 403: {
20529
+ headers: {
20530
+ [name: string]: unknown;
20531
+ };
20532
+ content: {
20533
+ "application/json": {
20534
+ code: string;
20535
+ message: string;
20536
+ links?: {
20537
+ docs: string;
20538
+ schema: string;
20539
+ };
20540
+ issues?: {
20541
+ message: string;
20542
+ path?: (string | number)[];
20543
+ schema?: string;
20544
+ }[];
20545
+ context?: unknown;
20546
+ };
20547
+ };
20548
+ };
20549
+ /** @description Not found */
20550
+ 404: {
20551
+ headers: {
20552
+ [name: string]: unknown;
20553
+ };
20554
+ content: {
20555
+ "application/json": {
20556
+ code: string;
20557
+ message: string;
20558
+ links?: {
20559
+ docs: string;
20560
+ schema: string;
20561
+ };
20562
+ issues?: {
20563
+ message: string;
20564
+ path?: (string | number)[];
20565
+ schema?: string;
20566
+ }[];
20567
+ context?: unknown;
20568
+ };
20569
+ };
20570
+ };
20571
+ /** @description Internal server error */
20572
+ 500: {
20573
+ headers: {
20574
+ [name: string]: unknown;
20575
+ };
20576
+ content: {
20577
+ "application/json": {
20578
+ code: string;
20579
+ message: string;
20580
+ links?: {
20581
+ docs: string;
20582
+ schema: string;
20583
+ };
20584
+ issues?: {
20585
+ message: string;
20586
+ path?: (string | number)[];
20587
+ schema?: string;
20588
+ }[];
20589
+ context?: unknown;
20590
+ };
20591
+ };
20592
+ };
20593
+ /** @description Service unavailable */
20594
+ 503: {
20595
+ headers: {
20596
+ [name: string]: unknown;
20597
+ };
20598
+ content: {
20599
+ "application/json": {
20600
+ code: string;
20601
+ message: string;
20602
+ links?: {
20603
+ docs: string;
20604
+ schema: string;
20605
+ };
20606
+ issues?: {
20607
+ message: string;
20608
+ path?: (string | number)[];
20609
+ schema?: string;
20610
+ }[];
20611
+ context?: unknown;
20612
+ };
20613
+ };
20614
+ };
20615
+ };
20616
+ };
20384
20617
  exchangeEmbedSession: {
20385
20618
  parameters: {
20386
20619
  query?: never;
@@ -37785,6 +38018,7 @@ export interface operations {
37785
38018
  reservationId: string | null;
37786
38019
  hasPms: boolean;
37787
38020
  activePmsConnectionId: string | null;
38021
+ hasOwnerBlockingConnection: boolean;
37788
38022
  hasDeposit: boolean;
37789
38023
  depositTransactionId: string | null;
37790
38024
  hasListingNeedsReview: boolean;
@@ -77319,6 +77553,7 @@ export interface operations {
77319
77553
  isOnboarding?: boolean | null;
77320
77554
  isOpex?: boolean;
77321
77555
  booksClosedAt?: string | null;
77556
+ /** @description Logo URL or data URI. Send null to clear it. */
77322
77557
  logo?: string | null;
77323
77558
  statementStartAt?: string | null;
77324
77559
  effectiveStatementStartAt?: string | null;
@@ -77328,6 +77563,8 @@ export interface operations {
77328
77563
  /** Format: email */
77329
77564
  email?: string;
77330
77565
  supportEmail?: string | null;
77566
+ /** @description Primary brand color. Send null to clear it. */
77567
+ colorPrimary?: string | null;
77331
77568
  migratedFromTenantId?: string | null;
77332
77569
  settings?: {
77333
77570
  showVRPilotGuide?: boolean;