@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.
|
@@ -1006,7 +1006,11 @@ export interface paths {
|
|
|
1006
1006
|
path?: never;
|
|
1007
1007
|
cookie?: never;
|
|
1008
1008
|
};
|
|
1009
|
-
/**
|
|
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;
|
|
@@ -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
|
-
|
|
20244
|
-
|
|
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;
|
|
@@ -37784,6 +38017,7 @@ export interface operations {
|
|
|
37784
38017
|
reservationId: string | null;
|
|
37785
38018
|
hasPms: boolean;
|
|
37786
38019
|
activePmsConnectionId: string | null;
|
|
38020
|
+
hasOwnerBlockingConnection: boolean;
|
|
37787
38021
|
hasDeposit: boolean;
|
|
37788
38022
|
depositTransactionId: string | null;
|
|
37789
38023
|
hasListingNeedsReview: boolean;
|
|
@@ -77318,6 +77552,7 @@ export interface operations {
|
|
|
77318
77552
|
isOnboarding?: boolean | null;
|
|
77319
77553
|
isOpex?: boolean;
|
|
77320
77554
|
booksClosedAt?: string | null;
|
|
77555
|
+
/** @description Logo URL or data URI. Send null to clear it. */
|
|
77321
77556
|
logo?: string | null;
|
|
77322
77557
|
statementStartAt?: string | null;
|
|
77323
77558
|
effectiveStatementStartAt?: string | null;
|
|
@@ -77327,6 +77562,8 @@ export interface operations {
|
|
|
77327
77562
|
/** Format: email */
|
|
77328
77563
|
email?: string;
|
|
77329
77564
|
supportEmail?: string | null;
|
|
77565
|
+
/** @description Primary brand color. Send null to clear it. */
|
|
77566
|
+
colorPrimary?: string | null;
|
|
77330
77567
|
migratedFromTenantId?: string | null;
|
|
77331
77568
|
settings?: {
|
|
77332
77569
|
showVRPilotGuide?: boolean;
|