@vrplatform/api 1.3.1-stage.4667 → 1.3.1-stage.4683
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/build/main/generated/v1.d.ts +1610 -661
- package/build/main/generated/v1.js.map +1 -1
- package/build/module/generated/v1.d.ts +1610 -661
- package/build/module/generated/v1.js.map +1 -1
- package/package.json +1 -1
- package/src/generated/v1.ts +1610 -661
|
@@ -191,6 +191,42 @@ export interface paths {
|
|
|
191
191
|
patch?: never;
|
|
192
192
|
trace?: never;
|
|
193
193
|
};
|
|
194
|
+
"/api-tokens": {
|
|
195
|
+
parameters: {
|
|
196
|
+
query?: never;
|
|
197
|
+
header?: never;
|
|
198
|
+
path?: never;
|
|
199
|
+
cookie?: never;
|
|
200
|
+
};
|
|
201
|
+
/** @description List API token metadata for the current team without revealing token secrets. Requires an authenticated team admin. */
|
|
202
|
+
get: operations["getApiTokens"];
|
|
203
|
+
put?: never;
|
|
204
|
+
/** @description Create an API token for the current team. Requires an authenticated team admin. The token secret is never written to audit records. */
|
|
205
|
+
post: operations["postApiTokens"];
|
|
206
|
+
delete?: never;
|
|
207
|
+
options?: never;
|
|
208
|
+
head?: never;
|
|
209
|
+
patch?: never;
|
|
210
|
+
trace?: never;
|
|
211
|
+
};
|
|
212
|
+
"/api-tokens/{id}": {
|
|
213
|
+
parameters: {
|
|
214
|
+
query?: never;
|
|
215
|
+
header?: never;
|
|
216
|
+
path?: never;
|
|
217
|
+
cookie?: never;
|
|
218
|
+
};
|
|
219
|
+
/** @description Reveal one API token for the current team. Requires an authenticated team admin. */
|
|
220
|
+
get: operations["getApiTokensById"];
|
|
221
|
+
put?: never;
|
|
222
|
+
post?: never;
|
|
223
|
+
/** @description Revoke an API token for the current team immediately. Requires an authenticated team admin. */
|
|
224
|
+
delete: operations["deleteApiTokensById"];
|
|
225
|
+
options?: never;
|
|
226
|
+
head?: never;
|
|
227
|
+
patch?: never;
|
|
228
|
+
trace?: never;
|
|
229
|
+
};
|
|
194
230
|
"/apps": {
|
|
195
231
|
parameters: {
|
|
196
232
|
query?: never;
|
|
@@ -1006,7 +1042,11 @@ export interface paths {
|
|
|
1006
1042
|
path?: never;
|
|
1007
1043
|
cookie?: never;
|
|
1008
1044
|
};
|
|
1009
|
-
/**
|
|
1045
|
+
/**
|
|
1046
|
+
* @description Get the current team email template for trigger-rendered emails.
|
|
1047
|
+
*
|
|
1048
|
+
* Required scope: team-settings:read
|
|
1049
|
+
*/
|
|
1010
1050
|
get: operations["getEmailTemplate"];
|
|
1011
1051
|
put?: never;
|
|
1012
1052
|
post?: never;
|
|
@@ -1016,6 +1056,27 @@ export interface paths {
|
|
|
1016
1056
|
patch?: never;
|
|
1017
1057
|
trace?: never;
|
|
1018
1058
|
};
|
|
1059
|
+
"/email-templates/{type}": {
|
|
1060
|
+
parameters: {
|
|
1061
|
+
query?: never;
|
|
1062
|
+
header?: never;
|
|
1063
|
+
path?: never;
|
|
1064
|
+
cookie?: never;
|
|
1065
|
+
};
|
|
1066
|
+
get?: never;
|
|
1067
|
+
/**
|
|
1068
|
+
* @description Create or update an email template for the current team.
|
|
1069
|
+
*
|
|
1070
|
+
* Required scope: team-settings:write
|
|
1071
|
+
*/
|
|
1072
|
+
put: operations["upsertEmailTemplate"];
|
|
1073
|
+
post?: never;
|
|
1074
|
+
delete?: never;
|
|
1075
|
+
options?: never;
|
|
1076
|
+
head?: never;
|
|
1077
|
+
patch?: never;
|
|
1078
|
+
trace?: never;
|
|
1079
|
+
};
|
|
1019
1080
|
"/embed-sessions/exchange": {
|
|
1020
1081
|
parameters: {
|
|
1021
1082
|
query?: never;
|
|
@@ -1792,7 +1853,7 @@ export interface paths {
|
|
|
1792
1853
|
/** @description List users in one regional data partition with their team memberships and owner accesses. Select the partition with x-data-region. */
|
|
1793
1854
|
get: operations["getInternalUsers"];
|
|
1794
1855
|
put?: never;
|
|
1795
|
-
/** @description Create or update a platform user by email, optionally granting an initial team membership.
|
|
1856
|
+
/** @description Create or update a global platform user by primary or secondary email, optionally granting an initial team membership. Existing identities and current-team membership ids are reused and projected into the selected team region, and returned memberships cover every region. Used by identity and invite workflows. An explicit conflicting user id is rejected as a user error. */
|
|
1796
1857
|
post: operations["postInternalUsers"];
|
|
1797
1858
|
delete?: never;
|
|
1798
1859
|
options?: never;
|
|
@@ -4389,7 +4450,7 @@ export interface paths {
|
|
|
4389
4450
|
*/
|
|
4390
4451
|
get: operations["getTeam"];
|
|
4391
4452
|
/**
|
|
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.
|
|
4453
|
+
* @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
4454
|
*
|
|
4394
4455
|
* Required scope: teams:write
|
|
4395
4456
|
*/
|
|
@@ -8139,14 +8200,9 @@ export interface operations {
|
|
|
8139
8200
|
};
|
|
8140
8201
|
};
|
|
8141
8202
|
};
|
|
8142
|
-
|
|
8203
|
+
getApiTokens: {
|
|
8143
8204
|
parameters: {
|
|
8144
8205
|
query?: {
|
|
8145
|
-
search?: string;
|
|
8146
|
-
category?: string;
|
|
8147
|
-
type?: string;
|
|
8148
|
-
/** @description Filter by whether an app has a connection for the current team */
|
|
8149
|
-
hasConnection?: boolean;
|
|
8150
8206
|
limit?: number;
|
|
8151
8207
|
page?: number;
|
|
8152
8208
|
offset?: number;
|
|
@@ -8165,50 +8221,17 @@ export interface operations {
|
|
|
8165
8221
|
content: {
|
|
8166
8222
|
"application/json": {
|
|
8167
8223
|
data: {
|
|
8224
|
+
/** Format: uuid */
|
|
8168
8225
|
id: string;
|
|
8169
|
-
|
|
8170
|
-
|
|
8171
|
-
|
|
8172
|
-
|
|
8173
|
-
|
|
8174
|
-
|
|
8175
|
-
|
|
8176
|
-
|
|
8177
|
-
|
|
8178
|
-
/** @enum {string} */
|
|
8179
|
-
type: "push" | "pull";
|
|
8180
|
-
left: string;
|
|
8181
|
-
right: string;
|
|
8182
|
-
}[];
|
|
8183
|
-
extractors: {
|
|
8184
|
-
name: string;
|
|
8185
|
-
/** @constant */
|
|
8186
|
-
sync: "full";
|
|
8187
|
-
visible?: boolean;
|
|
8188
|
-
isDateRangeFetchable?: boolean;
|
|
8189
|
-
/** @enum {string} */
|
|
8190
|
-
dateRangeMethod?: "checkIn/checkOut" | "bookedAt" | "creationDate";
|
|
8191
|
-
params?: {
|
|
8192
|
-
/** @constant */
|
|
8193
|
-
type: "object";
|
|
8194
|
-
properties?: {
|
|
8195
|
-
uniqueRef?: {
|
|
8196
|
-
/** @constant */
|
|
8197
|
-
type: "string";
|
|
8198
|
-
};
|
|
8199
|
-
};
|
|
8200
|
-
/** @constant */
|
|
8201
|
-
additionalProperties: false;
|
|
8202
|
-
};
|
|
8203
|
-
urlExample?: string;
|
|
8204
|
-
allowConfirmationCode?: boolean;
|
|
8205
|
-
}[];
|
|
8206
|
-
importers: {
|
|
8207
|
-
docsLink?: string;
|
|
8208
|
-
uniqueRef: string;
|
|
8209
|
-
description: string;
|
|
8210
|
-
types?: string[];
|
|
8211
|
-
}[];
|
|
8226
|
+
/**
|
|
8227
|
+
* Format: date-time
|
|
8228
|
+
* @description Timestamp string with date, time, milliseconds, and timezone.
|
|
8229
|
+
* @example 2024-01-15T12:30:00.000+00:00
|
|
8230
|
+
*/
|
|
8231
|
+
createdAt: string;
|
|
8232
|
+
hint: string | null;
|
|
8233
|
+
role: string | null;
|
|
8234
|
+
scope: string | null;
|
|
8212
8235
|
}[];
|
|
8213
8236
|
pagination: {
|
|
8214
8237
|
/** @default 100 */
|
|
@@ -8356,16 +8379,21 @@ export interface operations {
|
|
|
8356
8379
|
};
|
|
8357
8380
|
};
|
|
8358
8381
|
};
|
|
8359
|
-
|
|
8382
|
+
postApiTokens: {
|
|
8360
8383
|
parameters: {
|
|
8361
8384
|
query?: never;
|
|
8362
8385
|
header?: never;
|
|
8363
|
-
path
|
|
8364
|
-
id: string;
|
|
8365
|
-
};
|
|
8386
|
+
path?: never;
|
|
8366
8387
|
cookie?: never;
|
|
8367
8388
|
};
|
|
8368
|
-
requestBody?:
|
|
8389
|
+
requestBody?: {
|
|
8390
|
+
content: {
|
|
8391
|
+
"application/json": {
|
|
8392
|
+
/** @description Client-generated API token secret to store. */
|
|
8393
|
+
apiToken: string;
|
|
8394
|
+
};
|
|
8395
|
+
};
|
|
8396
|
+
};
|
|
8369
8397
|
responses: {
|
|
8370
8398
|
/** @description Successful response */
|
|
8371
8399
|
200: {
|
|
@@ -8374,50 +8402,17 @@ export interface operations {
|
|
|
8374
8402
|
};
|
|
8375
8403
|
content: {
|
|
8376
8404
|
"application/json": {
|
|
8405
|
+
/** Format: uuid */
|
|
8377
8406
|
id: string;
|
|
8378
|
-
|
|
8379
|
-
|
|
8380
|
-
|
|
8381
|
-
|
|
8382
|
-
|
|
8383
|
-
|
|
8384
|
-
|
|
8385
|
-
|
|
8386
|
-
|
|
8387
|
-
/** @enum {string} */
|
|
8388
|
-
type: "push" | "pull";
|
|
8389
|
-
left: string;
|
|
8390
|
-
right: string;
|
|
8391
|
-
}[];
|
|
8392
|
-
extractors: {
|
|
8393
|
-
name: string;
|
|
8394
|
-
/** @constant */
|
|
8395
|
-
sync: "full";
|
|
8396
|
-
visible?: boolean;
|
|
8397
|
-
isDateRangeFetchable?: boolean;
|
|
8398
|
-
/** @enum {string} */
|
|
8399
|
-
dateRangeMethod?: "checkIn/checkOut" | "bookedAt" | "creationDate";
|
|
8400
|
-
params?: {
|
|
8401
|
-
/** @constant */
|
|
8402
|
-
type: "object";
|
|
8403
|
-
properties?: {
|
|
8404
|
-
uniqueRef?: {
|
|
8405
|
-
/** @constant */
|
|
8406
|
-
type: "string";
|
|
8407
|
-
};
|
|
8408
|
-
};
|
|
8409
|
-
/** @constant */
|
|
8410
|
-
additionalProperties: false;
|
|
8411
|
-
};
|
|
8412
|
-
urlExample?: string;
|
|
8413
|
-
allowConfirmationCode?: boolean;
|
|
8414
|
-
}[];
|
|
8415
|
-
importers: {
|
|
8416
|
-
docsLink?: string;
|
|
8417
|
-
uniqueRef: string;
|
|
8418
|
-
description: string;
|
|
8419
|
-
types?: string[];
|
|
8420
|
-
}[];
|
|
8407
|
+
/**
|
|
8408
|
+
* Format: date-time
|
|
8409
|
+
* @description Timestamp string with date, time, milliseconds, and timezone.
|
|
8410
|
+
* @example 2024-01-15T12:30:00.000+00:00
|
|
8411
|
+
*/
|
|
8412
|
+
createdAt: string;
|
|
8413
|
+
hint: string | null;
|
|
8414
|
+
role: string | null;
|
|
8415
|
+
scope: string | null;
|
|
8421
8416
|
};
|
|
8422
8417
|
};
|
|
8423
8418
|
};
|
|
@@ -8555,21 +8550,13 @@ export interface operations {
|
|
|
8555
8550
|
};
|
|
8556
8551
|
};
|
|
8557
8552
|
};
|
|
8558
|
-
|
|
8553
|
+
getApiTokensById: {
|
|
8559
8554
|
parameters: {
|
|
8560
|
-
query?:
|
|
8561
|
-
limit?: number;
|
|
8562
|
-
offset?: number;
|
|
8563
|
-
startDate?: string;
|
|
8564
|
-
endDate?: string;
|
|
8565
|
-
actionType?: string;
|
|
8566
|
-
entityId?: string;
|
|
8567
|
-
entityType?: "account" | "journalEntry" | "listingOwnershipPeriod" | "ownerStatement" | "recurringTransactionTemplate" | "reservation" | "tenant" | "transaction" | "transactionAttachment";
|
|
8568
|
-
includeIfNoEffects?: boolean;
|
|
8569
|
-
page?: number;
|
|
8570
|
-
};
|
|
8555
|
+
query?: never;
|
|
8571
8556
|
header?: never;
|
|
8572
|
-
path
|
|
8557
|
+
path: {
|
|
8558
|
+
id: string;
|
|
8559
|
+
};
|
|
8573
8560
|
cookie?: never;
|
|
8574
8561
|
};
|
|
8575
8562
|
requestBody?: never;
|
|
@@ -8581,53 +8568,18 @@ export interface operations {
|
|
|
8581
8568
|
};
|
|
8582
8569
|
content: {
|
|
8583
8570
|
"application/json": {
|
|
8584
|
-
|
|
8585
|
-
|
|
8586
|
-
|
|
8587
|
-
|
|
8588
|
-
|
|
8589
|
-
|
|
8590
|
-
|
|
8591
|
-
|
|
8592
|
-
|
|
8593
|
-
|
|
8594
|
-
|
|
8595
|
-
|
|
8596
|
-
id: string | null;
|
|
8597
|
-
type: string;
|
|
8598
|
-
name: string | null;
|
|
8599
|
-
email: string | null;
|
|
8600
|
-
};
|
|
8601
|
-
/**
|
|
8602
|
-
* Format: date-time
|
|
8603
|
-
* @description Timestamp string with date, time, milliseconds, and timezone.
|
|
8604
|
-
* @example 2024-01-15T12:30:00.000+00:00
|
|
8605
|
-
*/
|
|
8606
|
-
createdAt: string;
|
|
8607
|
-
source: string | null;
|
|
8608
|
-
apiVersion: string;
|
|
8609
|
-
requestId: string | null;
|
|
8610
|
-
traceId: string | null;
|
|
8611
|
-
parentActionId: string | null;
|
|
8612
|
-
effectCounts: {
|
|
8613
|
-
total: number;
|
|
8614
|
-
pending: number;
|
|
8615
|
-
claimed: number;
|
|
8616
|
-
running: number;
|
|
8617
|
-
completed: number;
|
|
8618
|
-
failed: number;
|
|
8619
|
-
deadLetter: number;
|
|
8620
|
-
};
|
|
8621
|
-
}[];
|
|
8622
|
-
pagination: {
|
|
8623
|
-
/** @default 100 */
|
|
8624
|
-
limit: number;
|
|
8625
|
-
/** @default 1 */
|
|
8626
|
-
page: number;
|
|
8627
|
-
total: number;
|
|
8628
|
-
totalPage: number;
|
|
8629
|
-
nextPage?: number;
|
|
8630
|
-
};
|
|
8571
|
+
/** Format: uuid */
|
|
8572
|
+
id: string;
|
|
8573
|
+
/**
|
|
8574
|
+
* Format: date-time
|
|
8575
|
+
* @description Timestamp string with date, time, milliseconds, and timezone.
|
|
8576
|
+
* @example 2024-01-15T12:30:00.000+00:00
|
|
8577
|
+
*/
|
|
8578
|
+
createdAt: string;
|
|
8579
|
+
hint: string | null;
|
|
8580
|
+
role: string | null;
|
|
8581
|
+
scope: string | null;
|
|
8582
|
+
apiToken: string;
|
|
8631
8583
|
};
|
|
8632
8584
|
};
|
|
8633
8585
|
};
|
|
@@ -8765,7 +8717,7 @@ export interface operations {
|
|
|
8765
8717
|
};
|
|
8766
8718
|
};
|
|
8767
8719
|
};
|
|
8768
|
-
|
|
8720
|
+
deleteApiTokensById: {
|
|
8769
8721
|
parameters: {
|
|
8770
8722
|
query?: never;
|
|
8771
8723
|
header?: never;
|
|
@@ -8785,40 +8737,825 @@ export interface operations {
|
|
|
8785
8737
|
"application/json": {
|
|
8786
8738
|
/** Format: uuid */
|
|
8787
8739
|
id: string;
|
|
8788
|
-
/**
|
|
8789
|
-
|
|
8790
|
-
|
|
8791
|
-
|
|
8792
|
-
|
|
8793
|
-
|
|
8794
|
-
|
|
8795
|
-
|
|
8796
|
-
|
|
8797
|
-
|
|
8798
|
-
|
|
8799
|
-
|
|
8800
|
-
|
|
8801
|
-
|
|
8802
|
-
|
|
8803
|
-
|
|
8804
|
-
|
|
8805
|
-
|
|
8806
|
-
|
|
8807
|
-
|
|
8808
|
-
|
|
8809
|
-
|
|
8810
|
-
|
|
8811
|
-
|
|
8812
|
-
|
|
8813
|
-
|
|
8814
|
-
|
|
8815
|
-
|
|
8816
|
-
|
|
8817
|
-
|
|
8818
|
-
|
|
8819
|
-
|
|
8820
|
-
|
|
8821
|
-
|
|
8740
|
+
/** @constant */
|
|
8741
|
+
status: "deleted";
|
|
8742
|
+
};
|
|
8743
|
+
};
|
|
8744
|
+
};
|
|
8745
|
+
/** @description Bad request */
|
|
8746
|
+
400: {
|
|
8747
|
+
headers: {
|
|
8748
|
+
[name: string]: unknown;
|
|
8749
|
+
};
|
|
8750
|
+
content: {
|
|
8751
|
+
"application/json": {
|
|
8752
|
+
code: string;
|
|
8753
|
+
message: string;
|
|
8754
|
+
links?: {
|
|
8755
|
+
docs: string;
|
|
8756
|
+
schema: string;
|
|
8757
|
+
};
|
|
8758
|
+
issues?: {
|
|
8759
|
+
message: string;
|
|
8760
|
+
path?: (string | number)[];
|
|
8761
|
+
schema?: string;
|
|
8762
|
+
}[];
|
|
8763
|
+
context?: unknown;
|
|
8764
|
+
};
|
|
8765
|
+
};
|
|
8766
|
+
};
|
|
8767
|
+
/** @description Unauthorized */
|
|
8768
|
+
401: {
|
|
8769
|
+
headers: {
|
|
8770
|
+
[name: string]: unknown;
|
|
8771
|
+
};
|
|
8772
|
+
content: {
|
|
8773
|
+
"application/json": {
|
|
8774
|
+
code: string;
|
|
8775
|
+
message: string;
|
|
8776
|
+
links?: {
|
|
8777
|
+
docs: string;
|
|
8778
|
+
schema: string;
|
|
8779
|
+
};
|
|
8780
|
+
issues?: {
|
|
8781
|
+
message: string;
|
|
8782
|
+
path?: (string | number)[];
|
|
8783
|
+
schema?: string;
|
|
8784
|
+
}[];
|
|
8785
|
+
context?: unknown;
|
|
8786
|
+
};
|
|
8787
|
+
};
|
|
8788
|
+
};
|
|
8789
|
+
/** @description Forbidden */
|
|
8790
|
+
403: {
|
|
8791
|
+
headers: {
|
|
8792
|
+
[name: string]: unknown;
|
|
8793
|
+
};
|
|
8794
|
+
content: {
|
|
8795
|
+
"application/json": {
|
|
8796
|
+
code: string;
|
|
8797
|
+
message: string;
|
|
8798
|
+
links?: {
|
|
8799
|
+
docs: string;
|
|
8800
|
+
schema: string;
|
|
8801
|
+
};
|
|
8802
|
+
issues?: {
|
|
8803
|
+
message: string;
|
|
8804
|
+
path?: (string | number)[];
|
|
8805
|
+
schema?: string;
|
|
8806
|
+
}[];
|
|
8807
|
+
context?: unknown;
|
|
8808
|
+
};
|
|
8809
|
+
};
|
|
8810
|
+
};
|
|
8811
|
+
/** @description Not found */
|
|
8812
|
+
404: {
|
|
8813
|
+
headers: {
|
|
8814
|
+
[name: string]: unknown;
|
|
8815
|
+
};
|
|
8816
|
+
content: {
|
|
8817
|
+
"application/json": {
|
|
8818
|
+
code: string;
|
|
8819
|
+
message: string;
|
|
8820
|
+
links?: {
|
|
8821
|
+
docs: string;
|
|
8822
|
+
schema: string;
|
|
8823
|
+
};
|
|
8824
|
+
issues?: {
|
|
8825
|
+
message: string;
|
|
8826
|
+
path?: (string | number)[];
|
|
8827
|
+
schema?: string;
|
|
8828
|
+
}[];
|
|
8829
|
+
context?: unknown;
|
|
8830
|
+
};
|
|
8831
|
+
};
|
|
8832
|
+
};
|
|
8833
|
+
/** @description Internal server error */
|
|
8834
|
+
500: {
|
|
8835
|
+
headers: {
|
|
8836
|
+
[name: string]: unknown;
|
|
8837
|
+
};
|
|
8838
|
+
content: {
|
|
8839
|
+
"application/json": {
|
|
8840
|
+
code: string;
|
|
8841
|
+
message: string;
|
|
8842
|
+
links?: {
|
|
8843
|
+
docs: string;
|
|
8844
|
+
schema: string;
|
|
8845
|
+
};
|
|
8846
|
+
issues?: {
|
|
8847
|
+
message: string;
|
|
8848
|
+
path?: (string | number)[];
|
|
8849
|
+
schema?: string;
|
|
8850
|
+
}[];
|
|
8851
|
+
context?: unknown;
|
|
8852
|
+
};
|
|
8853
|
+
};
|
|
8854
|
+
};
|
|
8855
|
+
/** @description Service unavailable */
|
|
8856
|
+
503: {
|
|
8857
|
+
headers: {
|
|
8858
|
+
[name: string]: unknown;
|
|
8859
|
+
};
|
|
8860
|
+
content: {
|
|
8861
|
+
"application/json": {
|
|
8862
|
+
code: string;
|
|
8863
|
+
message: string;
|
|
8864
|
+
links?: {
|
|
8865
|
+
docs: string;
|
|
8866
|
+
schema: string;
|
|
8867
|
+
};
|
|
8868
|
+
issues?: {
|
|
8869
|
+
message: string;
|
|
8870
|
+
path?: (string | number)[];
|
|
8871
|
+
schema?: string;
|
|
8872
|
+
}[];
|
|
8873
|
+
context?: unknown;
|
|
8874
|
+
};
|
|
8875
|
+
};
|
|
8876
|
+
};
|
|
8877
|
+
};
|
|
8878
|
+
};
|
|
8879
|
+
getApps: {
|
|
8880
|
+
parameters: {
|
|
8881
|
+
query?: {
|
|
8882
|
+
search?: string;
|
|
8883
|
+
category?: string;
|
|
8884
|
+
type?: string;
|
|
8885
|
+
/** @description Filter by whether an app has a connection for the current team */
|
|
8886
|
+
hasConnection?: boolean;
|
|
8887
|
+
limit?: number;
|
|
8888
|
+
page?: number;
|
|
8889
|
+
offset?: number;
|
|
8890
|
+
};
|
|
8891
|
+
header?: never;
|
|
8892
|
+
path?: never;
|
|
8893
|
+
cookie?: never;
|
|
8894
|
+
};
|
|
8895
|
+
requestBody?: never;
|
|
8896
|
+
responses: {
|
|
8897
|
+
/** @description Successful response */
|
|
8898
|
+
200: {
|
|
8899
|
+
headers: {
|
|
8900
|
+
[name: string]: unknown;
|
|
8901
|
+
};
|
|
8902
|
+
content: {
|
|
8903
|
+
"application/json": {
|
|
8904
|
+
data: {
|
|
8905
|
+
id: string;
|
|
8906
|
+
name: string;
|
|
8907
|
+
icon?: string;
|
|
8908
|
+
type: string;
|
|
8909
|
+
category: string;
|
|
8910
|
+
description?: string | null;
|
|
8911
|
+
flows: {
|
|
8912
|
+
/** Format: uuid */
|
|
8913
|
+
id: string;
|
|
8914
|
+
name: string;
|
|
8915
|
+
/** @enum {string} */
|
|
8916
|
+
type: "push" | "pull";
|
|
8917
|
+
left: string;
|
|
8918
|
+
right: string;
|
|
8919
|
+
}[];
|
|
8920
|
+
extractors: {
|
|
8921
|
+
name: string;
|
|
8922
|
+
/** @constant */
|
|
8923
|
+
sync: "full";
|
|
8924
|
+
visible?: boolean;
|
|
8925
|
+
isDateRangeFetchable?: boolean;
|
|
8926
|
+
/** @enum {string} */
|
|
8927
|
+
dateRangeMethod?: "checkIn/checkOut" | "bookedAt" | "creationDate";
|
|
8928
|
+
params?: {
|
|
8929
|
+
/** @constant */
|
|
8930
|
+
type: "object";
|
|
8931
|
+
properties?: {
|
|
8932
|
+
uniqueRef?: {
|
|
8933
|
+
/** @constant */
|
|
8934
|
+
type: "string";
|
|
8935
|
+
};
|
|
8936
|
+
};
|
|
8937
|
+
/** @constant */
|
|
8938
|
+
additionalProperties: false;
|
|
8939
|
+
};
|
|
8940
|
+
urlExample?: string;
|
|
8941
|
+
allowConfirmationCode?: boolean;
|
|
8942
|
+
}[];
|
|
8943
|
+
importers: {
|
|
8944
|
+
docsLink?: string;
|
|
8945
|
+
uniqueRef: string;
|
|
8946
|
+
description: string;
|
|
8947
|
+
types?: string[];
|
|
8948
|
+
}[];
|
|
8949
|
+
}[];
|
|
8950
|
+
pagination: {
|
|
8951
|
+
/** @default 100 */
|
|
8952
|
+
limit: number;
|
|
8953
|
+
/** @default 1 */
|
|
8954
|
+
page: number;
|
|
8955
|
+
total: number;
|
|
8956
|
+
totalPage: number;
|
|
8957
|
+
nextPage?: number;
|
|
8958
|
+
};
|
|
8959
|
+
};
|
|
8960
|
+
};
|
|
8961
|
+
};
|
|
8962
|
+
/** @description Bad request */
|
|
8963
|
+
400: {
|
|
8964
|
+
headers: {
|
|
8965
|
+
[name: string]: unknown;
|
|
8966
|
+
};
|
|
8967
|
+
content: {
|
|
8968
|
+
"application/json": {
|
|
8969
|
+
code: string;
|
|
8970
|
+
message: string;
|
|
8971
|
+
links?: {
|
|
8972
|
+
docs: string;
|
|
8973
|
+
schema: string;
|
|
8974
|
+
};
|
|
8975
|
+
issues?: {
|
|
8976
|
+
message: string;
|
|
8977
|
+
path?: (string | number)[];
|
|
8978
|
+
schema?: string;
|
|
8979
|
+
}[];
|
|
8980
|
+
context?: unknown;
|
|
8981
|
+
};
|
|
8982
|
+
};
|
|
8983
|
+
};
|
|
8984
|
+
/** @description Unauthorized */
|
|
8985
|
+
401: {
|
|
8986
|
+
headers: {
|
|
8987
|
+
[name: string]: unknown;
|
|
8988
|
+
};
|
|
8989
|
+
content: {
|
|
8990
|
+
"application/json": {
|
|
8991
|
+
code: string;
|
|
8992
|
+
message: string;
|
|
8993
|
+
links?: {
|
|
8994
|
+
docs: string;
|
|
8995
|
+
schema: string;
|
|
8996
|
+
};
|
|
8997
|
+
issues?: {
|
|
8998
|
+
message: string;
|
|
8999
|
+
path?: (string | number)[];
|
|
9000
|
+
schema?: string;
|
|
9001
|
+
}[];
|
|
9002
|
+
context?: unknown;
|
|
9003
|
+
};
|
|
9004
|
+
};
|
|
9005
|
+
};
|
|
9006
|
+
/** @description Forbidden */
|
|
9007
|
+
403: {
|
|
9008
|
+
headers: {
|
|
9009
|
+
[name: string]: unknown;
|
|
9010
|
+
};
|
|
9011
|
+
content: {
|
|
9012
|
+
"application/json": {
|
|
9013
|
+
code: string;
|
|
9014
|
+
message: string;
|
|
9015
|
+
links?: {
|
|
9016
|
+
docs: string;
|
|
9017
|
+
schema: string;
|
|
9018
|
+
};
|
|
9019
|
+
issues?: {
|
|
9020
|
+
message: string;
|
|
9021
|
+
path?: (string | number)[];
|
|
9022
|
+
schema?: string;
|
|
9023
|
+
}[];
|
|
9024
|
+
context?: unknown;
|
|
9025
|
+
};
|
|
9026
|
+
};
|
|
9027
|
+
};
|
|
9028
|
+
/** @description Not found */
|
|
9029
|
+
404: {
|
|
9030
|
+
headers: {
|
|
9031
|
+
[name: string]: unknown;
|
|
9032
|
+
};
|
|
9033
|
+
content: {
|
|
9034
|
+
"application/json": {
|
|
9035
|
+
code: string;
|
|
9036
|
+
message: string;
|
|
9037
|
+
links?: {
|
|
9038
|
+
docs: string;
|
|
9039
|
+
schema: string;
|
|
9040
|
+
};
|
|
9041
|
+
issues?: {
|
|
9042
|
+
message: string;
|
|
9043
|
+
path?: (string | number)[];
|
|
9044
|
+
schema?: string;
|
|
9045
|
+
}[];
|
|
9046
|
+
context?: unknown;
|
|
9047
|
+
};
|
|
9048
|
+
};
|
|
9049
|
+
};
|
|
9050
|
+
/** @description Internal server error */
|
|
9051
|
+
500: {
|
|
9052
|
+
headers: {
|
|
9053
|
+
[name: string]: unknown;
|
|
9054
|
+
};
|
|
9055
|
+
content: {
|
|
9056
|
+
"application/json": {
|
|
9057
|
+
code: string;
|
|
9058
|
+
message: string;
|
|
9059
|
+
links?: {
|
|
9060
|
+
docs: string;
|
|
9061
|
+
schema: string;
|
|
9062
|
+
};
|
|
9063
|
+
issues?: {
|
|
9064
|
+
message: string;
|
|
9065
|
+
path?: (string | number)[];
|
|
9066
|
+
schema?: string;
|
|
9067
|
+
}[];
|
|
9068
|
+
context?: unknown;
|
|
9069
|
+
};
|
|
9070
|
+
};
|
|
9071
|
+
};
|
|
9072
|
+
/** @description Service unavailable */
|
|
9073
|
+
503: {
|
|
9074
|
+
headers: {
|
|
9075
|
+
[name: string]: unknown;
|
|
9076
|
+
};
|
|
9077
|
+
content: {
|
|
9078
|
+
"application/json": {
|
|
9079
|
+
code: string;
|
|
9080
|
+
message: string;
|
|
9081
|
+
links?: {
|
|
9082
|
+
docs: string;
|
|
9083
|
+
schema: string;
|
|
9084
|
+
};
|
|
9085
|
+
issues?: {
|
|
9086
|
+
message: string;
|
|
9087
|
+
path?: (string | number)[];
|
|
9088
|
+
schema?: string;
|
|
9089
|
+
}[];
|
|
9090
|
+
context?: unknown;
|
|
9091
|
+
};
|
|
9092
|
+
};
|
|
9093
|
+
};
|
|
9094
|
+
};
|
|
9095
|
+
};
|
|
9096
|
+
getApp: {
|
|
9097
|
+
parameters: {
|
|
9098
|
+
query?: never;
|
|
9099
|
+
header?: never;
|
|
9100
|
+
path: {
|
|
9101
|
+
id: string;
|
|
9102
|
+
};
|
|
9103
|
+
cookie?: never;
|
|
9104
|
+
};
|
|
9105
|
+
requestBody?: never;
|
|
9106
|
+
responses: {
|
|
9107
|
+
/** @description Successful response */
|
|
9108
|
+
200: {
|
|
9109
|
+
headers: {
|
|
9110
|
+
[name: string]: unknown;
|
|
9111
|
+
};
|
|
9112
|
+
content: {
|
|
9113
|
+
"application/json": {
|
|
9114
|
+
id: string;
|
|
9115
|
+
name: string;
|
|
9116
|
+
icon?: string;
|
|
9117
|
+
type: string;
|
|
9118
|
+
category: string;
|
|
9119
|
+
description?: string | null;
|
|
9120
|
+
flows: {
|
|
9121
|
+
/** Format: uuid */
|
|
9122
|
+
id: string;
|
|
9123
|
+
name: string;
|
|
9124
|
+
/** @enum {string} */
|
|
9125
|
+
type: "push" | "pull";
|
|
9126
|
+
left: string;
|
|
9127
|
+
right: string;
|
|
9128
|
+
}[];
|
|
9129
|
+
extractors: {
|
|
9130
|
+
name: string;
|
|
9131
|
+
/** @constant */
|
|
9132
|
+
sync: "full";
|
|
9133
|
+
visible?: boolean;
|
|
9134
|
+
isDateRangeFetchable?: boolean;
|
|
9135
|
+
/** @enum {string} */
|
|
9136
|
+
dateRangeMethod?: "checkIn/checkOut" | "bookedAt" | "creationDate";
|
|
9137
|
+
params?: {
|
|
9138
|
+
/** @constant */
|
|
9139
|
+
type: "object";
|
|
9140
|
+
properties?: {
|
|
9141
|
+
uniqueRef?: {
|
|
9142
|
+
/** @constant */
|
|
9143
|
+
type: "string";
|
|
9144
|
+
};
|
|
9145
|
+
};
|
|
9146
|
+
/** @constant */
|
|
9147
|
+
additionalProperties: false;
|
|
9148
|
+
};
|
|
9149
|
+
urlExample?: string;
|
|
9150
|
+
allowConfirmationCode?: boolean;
|
|
9151
|
+
}[];
|
|
9152
|
+
importers: {
|
|
9153
|
+
docsLink?: string;
|
|
9154
|
+
uniqueRef: string;
|
|
9155
|
+
description: string;
|
|
9156
|
+
types?: string[];
|
|
9157
|
+
}[];
|
|
9158
|
+
};
|
|
9159
|
+
};
|
|
9160
|
+
};
|
|
9161
|
+
/** @description Bad request */
|
|
9162
|
+
400: {
|
|
9163
|
+
headers: {
|
|
9164
|
+
[name: string]: unknown;
|
|
9165
|
+
};
|
|
9166
|
+
content: {
|
|
9167
|
+
"application/json": {
|
|
9168
|
+
code: string;
|
|
9169
|
+
message: string;
|
|
9170
|
+
links?: {
|
|
9171
|
+
docs: string;
|
|
9172
|
+
schema: string;
|
|
9173
|
+
};
|
|
9174
|
+
issues?: {
|
|
9175
|
+
message: string;
|
|
9176
|
+
path?: (string | number)[];
|
|
9177
|
+
schema?: string;
|
|
9178
|
+
}[];
|
|
9179
|
+
context?: unknown;
|
|
9180
|
+
};
|
|
9181
|
+
};
|
|
9182
|
+
};
|
|
9183
|
+
/** @description Unauthorized */
|
|
9184
|
+
401: {
|
|
9185
|
+
headers: {
|
|
9186
|
+
[name: string]: unknown;
|
|
9187
|
+
};
|
|
9188
|
+
content: {
|
|
9189
|
+
"application/json": {
|
|
9190
|
+
code: string;
|
|
9191
|
+
message: string;
|
|
9192
|
+
links?: {
|
|
9193
|
+
docs: string;
|
|
9194
|
+
schema: string;
|
|
9195
|
+
};
|
|
9196
|
+
issues?: {
|
|
9197
|
+
message: string;
|
|
9198
|
+
path?: (string | number)[];
|
|
9199
|
+
schema?: string;
|
|
9200
|
+
}[];
|
|
9201
|
+
context?: unknown;
|
|
9202
|
+
};
|
|
9203
|
+
};
|
|
9204
|
+
};
|
|
9205
|
+
/** @description Forbidden */
|
|
9206
|
+
403: {
|
|
9207
|
+
headers: {
|
|
9208
|
+
[name: string]: unknown;
|
|
9209
|
+
};
|
|
9210
|
+
content: {
|
|
9211
|
+
"application/json": {
|
|
9212
|
+
code: string;
|
|
9213
|
+
message: string;
|
|
9214
|
+
links?: {
|
|
9215
|
+
docs: string;
|
|
9216
|
+
schema: string;
|
|
9217
|
+
};
|
|
9218
|
+
issues?: {
|
|
9219
|
+
message: string;
|
|
9220
|
+
path?: (string | number)[];
|
|
9221
|
+
schema?: string;
|
|
9222
|
+
}[];
|
|
9223
|
+
context?: unknown;
|
|
9224
|
+
};
|
|
9225
|
+
};
|
|
9226
|
+
};
|
|
9227
|
+
/** @description Not found */
|
|
9228
|
+
404: {
|
|
9229
|
+
headers: {
|
|
9230
|
+
[name: string]: unknown;
|
|
9231
|
+
};
|
|
9232
|
+
content: {
|
|
9233
|
+
"application/json": {
|
|
9234
|
+
code: string;
|
|
9235
|
+
message: string;
|
|
9236
|
+
links?: {
|
|
9237
|
+
docs: string;
|
|
9238
|
+
schema: string;
|
|
9239
|
+
};
|
|
9240
|
+
issues?: {
|
|
9241
|
+
message: string;
|
|
9242
|
+
path?: (string | number)[];
|
|
9243
|
+
schema?: string;
|
|
9244
|
+
}[];
|
|
9245
|
+
context?: unknown;
|
|
9246
|
+
};
|
|
9247
|
+
};
|
|
9248
|
+
};
|
|
9249
|
+
/** @description Internal server error */
|
|
9250
|
+
500: {
|
|
9251
|
+
headers: {
|
|
9252
|
+
[name: string]: unknown;
|
|
9253
|
+
};
|
|
9254
|
+
content: {
|
|
9255
|
+
"application/json": {
|
|
9256
|
+
code: string;
|
|
9257
|
+
message: string;
|
|
9258
|
+
links?: {
|
|
9259
|
+
docs: string;
|
|
9260
|
+
schema: string;
|
|
9261
|
+
};
|
|
9262
|
+
issues?: {
|
|
9263
|
+
message: string;
|
|
9264
|
+
path?: (string | number)[];
|
|
9265
|
+
schema?: string;
|
|
9266
|
+
}[];
|
|
9267
|
+
context?: unknown;
|
|
9268
|
+
};
|
|
9269
|
+
};
|
|
9270
|
+
};
|
|
9271
|
+
/** @description Service unavailable */
|
|
9272
|
+
503: {
|
|
9273
|
+
headers: {
|
|
9274
|
+
[name: string]: unknown;
|
|
9275
|
+
};
|
|
9276
|
+
content: {
|
|
9277
|
+
"application/json": {
|
|
9278
|
+
code: string;
|
|
9279
|
+
message: string;
|
|
9280
|
+
links?: {
|
|
9281
|
+
docs: string;
|
|
9282
|
+
schema: string;
|
|
9283
|
+
};
|
|
9284
|
+
issues?: {
|
|
9285
|
+
message: string;
|
|
9286
|
+
path?: (string | number)[];
|
|
9287
|
+
schema?: string;
|
|
9288
|
+
}[];
|
|
9289
|
+
context?: unknown;
|
|
9290
|
+
};
|
|
9291
|
+
};
|
|
9292
|
+
};
|
|
9293
|
+
};
|
|
9294
|
+
};
|
|
9295
|
+
getAuditActions: {
|
|
9296
|
+
parameters: {
|
|
9297
|
+
query?: {
|
|
9298
|
+
limit?: number;
|
|
9299
|
+
offset?: number;
|
|
9300
|
+
startDate?: string;
|
|
9301
|
+
endDate?: string;
|
|
9302
|
+
actionType?: string;
|
|
9303
|
+
entityId?: string;
|
|
9304
|
+
entityType?: "account" | "journalEntry" | "listingOwnershipPeriod" | "ownerStatement" | "recurringTransactionTemplate" | "reservation" | "tenant" | "transaction" | "transactionAttachment";
|
|
9305
|
+
includeIfNoEffects?: boolean;
|
|
9306
|
+
page?: number;
|
|
9307
|
+
};
|
|
9308
|
+
header?: never;
|
|
9309
|
+
path?: never;
|
|
9310
|
+
cookie?: never;
|
|
9311
|
+
};
|
|
9312
|
+
requestBody?: never;
|
|
9313
|
+
responses: {
|
|
9314
|
+
/** @description Successful response */
|
|
9315
|
+
200: {
|
|
9316
|
+
headers: {
|
|
9317
|
+
[name: string]: unknown;
|
|
9318
|
+
};
|
|
9319
|
+
content: {
|
|
9320
|
+
"application/json": {
|
|
9321
|
+
data: {
|
|
9322
|
+
/** Format: uuid */
|
|
9323
|
+
id: string;
|
|
9324
|
+
/** Format: uuid */
|
|
9325
|
+
tenantId: string;
|
|
9326
|
+
actionType: string;
|
|
9327
|
+
rootEntityType: string | null;
|
|
9328
|
+
rootEntityId: string | null;
|
|
9329
|
+
message: string | null;
|
|
9330
|
+
payload: unknown;
|
|
9331
|
+
userId: string | null;
|
|
9332
|
+
actor: {
|
|
9333
|
+
id: string | null;
|
|
9334
|
+
type: string;
|
|
9335
|
+
name: string | null;
|
|
9336
|
+
email: string | null;
|
|
9337
|
+
};
|
|
9338
|
+
/**
|
|
9339
|
+
* Format: date-time
|
|
9340
|
+
* @description Timestamp string with date, time, milliseconds, and timezone.
|
|
9341
|
+
* @example 2024-01-15T12:30:00.000+00:00
|
|
9342
|
+
*/
|
|
9343
|
+
createdAt: string;
|
|
9344
|
+
source: string | null;
|
|
9345
|
+
apiVersion: string;
|
|
9346
|
+
requestId: string | null;
|
|
9347
|
+
traceId: string | null;
|
|
9348
|
+
parentActionId: string | null;
|
|
9349
|
+
effectCounts: {
|
|
9350
|
+
total: number;
|
|
9351
|
+
pending: number;
|
|
9352
|
+
claimed: number;
|
|
9353
|
+
running: number;
|
|
9354
|
+
completed: number;
|
|
9355
|
+
failed: number;
|
|
9356
|
+
deadLetter: number;
|
|
9357
|
+
};
|
|
9358
|
+
}[];
|
|
9359
|
+
pagination: {
|
|
9360
|
+
/** @default 100 */
|
|
9361
|
+
limit: number;
|
|
9362
|
+
/** @default 1 */
|
|
9363
|
+
page: number;
|
|
9364
|
+
total: number;
|
|
9365
|
+
totalPage: number;
|
|
9366
|
+
nextPage?: number;
|
|
9367
|
+
};
|
|
9368
|
+
};
|
|
9369
|
+
};
|
|
9370
|
+
};
|
|
9371
|
+
/** @description Bad request */
|
|
9372
|
+
400: {
|
|
9373
|
+
headers: {
|
|
9374
|
+
[name: string]: unknown;
|
|
9375
|
+
};
|
|
9376
|
+
content: {
|
|
9377
|
+
"application/json": {
|
|
9378
|
+
code: string;
|
|
9379
|
+
message: string;
|
|
9380
|
+
links?: {
|
|
9381
|
+
docs: string;
|
|
9382
|
+
schema: string;
|
|
9383
|
+
};
|
|
9384
|
+
issues?: {
|
|
9385
|
+
message: string;
|
|
9386
|
+
path?: (string | number)[];
|
|
9387
|
+
schema?: string;
|
|
9388
|
+
}[];
|
|
9389
|
+
context?: unknown;
|
|
9390
|
+
};
|
|
9391
|
+
};
|
|
9392
|
+
};
|
|
9393
|
+
/** @description Unauthorized */
|
|
9394
|
+
401: {
|
|
9395
|
+
headers: {
|
|
9396
|
+
[name: string]: unknown;
|
|
9397
|
+
};
|
|
9398
|
+
content: {
|
|
9399
|
+
"application/json": {
|
|
9400
|
+
code: string;
|
|
9401
|
+
message: string;
|
|
9402
|
+
links?: {
|
|
9403
|
+
docs: string;
|
|
9404
|
+
schema: string;
|
|
9405
|
+
};
|
|
9406
|
+
issues?: {
|
|
9407
|
+
message: string;
|
|
9408
|
+
path?: (string | number)[];
|
|
9409
|
+
schema?: string;
|
|
9410
|
+
}[];
|
|
9411
|
+
context?: unknown;
|
|
9412
|
+
};
|
|
9413
|
+
};
|
|
9414
|
+
};
|
|
9415
|
+
/** @description Forbidden */
|
|
9416
|
+
403: {
|
|
9417
|
+
headers: {
|
|
9418
|
+
[name: string]: unknown;
|
|
9419
|
+
};
|
|
9420
|
+
content: {
|
|
9421
|
+
"application/json": {
|
|
9422
|
+
code: string;
|
|
9423
|
+
message: string;
|
|
9424
|
+
links?: {
|
|
9425
|
+
docs: string;
|
|
9426
|
+
schema: string;
|
|
9427
|
+
};
|
|
9428
|
+
issues?: {
|
|
9429
|
+
message: string;
|
|
9430
|
+
path?: (string | number)[];
|
|
9431
|
+
schema?: string;
|
|
9432
|
+
}[];
|
|
9433
|
+
context?: unknown;
|
|
9434
|
+
};
|
|
9435
|
+
};
|
|
9436
|
+
};
|
|
9437
|
+
/** @description Not found */
|
|
9438
|
+
404: {
|
|
9439
|
+
headers: {
|
|
9440
|
+
[name: string]: unknown;
|
|
9441
|
+
};
|
|
9442
|
+
content: {
|
|
9443
|
+
"application/json": {
|
|
9444
|
+
code: string;
|
|
9445
|
+
message: string;
|
|
9446
|
+
links?: {
|
|
9447
|
+
docs: string;
|
|
9448
|
+
schema: string;
|
|
9449
|
+
};
|
|
9450
|
+
issues?: {
|
|
9451
|
+
message: string;
|
|
9452
|
+
path?: (string | number)[];
|
|
9453
|
+
schema?: string;
|
|
9454
|
+
}[];
|
|
9455
|
+
context?: unknown;
|
|
9456
|
+
};
|
|
9457
|
+
};
|
|
9458
|
+
};
|
|
9459
|
+
/** @description Internal server error */
|
|
9460
|
+
500: {
|
|
9461
|
+
headers: {
|
|
9462
|
+
[name: string]: unknown;
|
|
9463
|
+
};
|
|
9464
|
+
content: {
|
|
9465
|
+
"application/json": {
|
|
9466
|
+
code: string;
|
|
9467
|
+
message: string;
|
|
9468
|
+
links?: {
|
|
9469
|
+
docs: string;
|
|
9470
|
+
schema: string;
|
|
9471
|
+
};
|
|
9472
|
+
issues?: {
|
|
9473
|
+
message: string;
|
|
9474
|
+
path?: (string | number)[];
|
|
9475
|
+
schema?: string;
|
|
9476
|
+
}[];
|
|
9477
|
+
context?: unknown;
|
|
9478
|
+
};
|
|
9479
|
+
};
|
|
9480
|
+
};
|
|
9481
|
+
/** @description Service unavailable */
|
|
9482
|
+
503: {
|
|
9483
|
+
headers: {
|
|
9484
|
+
[name: string]: unknown;
|
|
9485
|
+
};
|
|
9486
|
+
content: {
|
|
9487
|
+
"application/json": {
|
|
9488
|
+
code: string;
|
|
9489
|
+
message: string;
|
|
9490
|
+
links?: {
|
|
9491
|
+
docs: string;
|
|
9492
|
+
schema: string;
|
|
9493
|
+
};
|
|
9494
|
+
issues?: {
|
|
9495
|
+
message: string;
|
|
9496
|
+
path?: (string | number)[];
|
|
9497
|
+
schema?: string;
|
|
9498
|
+
}[];
|
|
9499
|
+
context?: unknown;
|
|
9500
|
+
};
|
|
9501
|
+
};
|
|
9502
|
+
};
|
|
9503
|
+
};
|
|
9504
|
+
};
|
|
9505
|
+
getAuditActionsById: {
|
|
9506
|
+
parameters: {
|
|
9507
|
+
query?: never;
|
|
9508
|
+
header?: never;
|
|
9509
|
+
path: {
|
|
9510
|
+
id: string;
|
|
9511
|
+
};
|
|
9512
|
+
cookie?: never;
|
|
9513
|
+
};
|
|
9514
|
+
requestBody?: never;
|
|
9515
|
+
responses: {
|
|
9516
|
+
/** @description Successful response */
|
|
9517
|
+
200: {
|
|
9518
|
+
headers: {
|
|
9519
|
+
[name: string]: unknown;
|
|
9520
|
+
};
|
|
9521
|
+
content: {
|
|
9522
|
+
"application/json": {
|
|
9523
|
+
/** Format: uuid */
|
|
9524
|
+
id: string;
|
|
9525
|
+
/** Format: uuid */
|
|
9526
|
+
tenantId: string;
|
|
9527
|
+
actionType: string;
|
|
9528
|
+
rootEntityType: string | null;
|
|
9529
|
+
rootEntityId: string | null;
|
|
9530
|
+
message: string | null;
|
|
9531
|
+
payload: unknown;
|
|
9532
|
+
userId: string | null;
|
|
9533
|
+
actor: {
|
|
9534
|
+
id: string | null;
|
|
9535
|
+
type: string;
|
|
9536
|
+
name: string | null;
|
|
9537
|
+
email: string | null;
|
|
9538
|
+
};
|
|
9539
|
+
/**
|
|
9540
|
+
* Format: date-time
|
|
9541
|
+
* @description Timestamp string with date, time, milliseconds, and timezone.
|
|
9542
|
+
* @example 2024-01-15T12:30:00.000+00:00
|
|
9543
|
+
*/
|
|
9544
|
+
createdAt: string;
|
|
9545
|
+
source: string | null;
|
|
9546
|
+
apiVersion: string;
|
|
9547
|
+
requestId: string | null;
|
|
9548
|
+
traceId: string | null;
|
|
9549
|
+
parentActionId: string | null;
|
|
9550
|
+
effectCounts: {
|
|
9551
|
+
total: number;
|
|
9552
|
+
pending: number;
|
|
9553
|
+
claimed: number;
|
|
9554
|
+
running: number;
|
|
9555
|
+
completed: number;
|
|
9556
|
+
failed: number;
|
|
9557
|
+
deadLetter: number;
|
|
9558
|
+
};
|
|
8822
9559
|
};
|
|
8823
9560
|
};
|
|
8824
9561
|
};
|
|
@@ -17953,7 +18690,254 @@ export interface operations {
|
|
|
17953
18690
|
};
|
|
17954
18691
|
};
|
|
17955
18692
|
};
|
|
17956
|
-
postContacts: {
|
|
18693
|
+
postContacts: {
|
|
18694
|
+
parameters: {
|
|
18695
|
+
query?: {
|
|
18696
|
+
/** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
|
|
18697
|
+
dryRun?: boolean;
|
|
18698
|
+
};
|
|
18699
|
+
header?: never;
|
|
18700
|
+
path?: never;
|
|
18701
|
+
cookie?: never;
|
|
18702
|
+
};
|
|
18703
|
+
requestBody?: {
|
|
18704
|
+
content: {
|
|
18705
|
+
"application/json": {
|
|
18706
|
+
address?: {
|
|
18707
|
+
full?: string | null;
|
|
18708
|
+
line1?: string | null;
|
|
18709
|
+
line2?: string | null;
|
|
18710
|
+
city?: string | null;
|
|
18711
|
+
/** @description Deprecated, use stateCode instead */
|
|
18712
|
+
state?: string | null;
|
|
18713
|
+
postalCode?: string | null;
|
|
18714
|
+
stateCode?: string | null;
|
|
18715
|
+
countryCode?: string | null;
|
|
18716
|
+
} | null;
|
|
18717
|
+
/** @enum {string} */
|
|
18718
|
+
type: "owner" | "vendor";
|
|
18719
|
+
email?: string | null;
|
|
18720
|
+
firstName?: string | null;
|
|
18721
|
+
name?: string | null;
|
|
18722
|
+
phone?: string | null;
|
|
18723
|
+
connectionId?: string | null;
|
|
18724
|
+
companyType?: ("c_corporation" | "limited_liability_company" | "partnership" | "s_corporation" | "trust_estate") | null;
|
|
18725
|
+
taxIdentifier?: string | null;
|
|
18726
|
+
sourceId?: string | null;
|
|
18727
|
+
uniqueRef?: string | null;
|
|
18728
|
+
status?: ("active" | "inactive") | null;
|
|
18729
|
+
payoutAccountId?: string | null;
|
|
18730
|
+
invite?: boolean | null;
|
|
18731
|
+
};
|
|
18732
|
+
};
|
|
18733
|
+
};
|
|
18734
|
+
responses: {
|
|
18735
|
+
/** @description Successful response */
|
|
18736
|
+
200: {
|
|
18737
|
+
headers: {
|
|
18738
|
+
[name: string]: unknown;
|
|
18739
|
+
};
|
|
18740
|
+
content: {
|
|
18741
|
+
"application/json": {
|
|
18742
|
+
address?: {
|
|
18743
|
+
full?: string | null;
|
|
18744
|
+
line1?: string | null;
|
|
18745
|
+
line2?: string | null;
|
|
18746
|
+
city?: string | null;
|
|
18747
|
+
/** @description Deprecated, use stateCode instead */
|
|
18748
|
+
state?: string | null;
|
|
18749
|
+
postalCode?: string | null;
|
|
18750
|
+
stateCode?: string | null;
|
|
18751
|
+
countryCode?: string | null;
|
|
18752
|
+
} | null;
|
|
18753
|
+
/** @enum {string} */
|
|
18754
|
+
type: "owner" | "vendor";
|
|
18755
|
+
email?: string | null;
|
|
18756
|
+
firstName?: string | null;
|
|
18757
|
+
name?: string | null;
|
|
18758
|
+
phone?: string | null;
|
|
18759
|
+
connectionId?: string | null;
|
|
18760
|
+
companyType?: ("c_corporation" | "limited_liability_company" | "partnership" | "s_corporation" | "trust_estate") | null;
|
|
18761
|
+
taxIdentifier?: string | null;
|
|
18762
|
+
uniqueRef?: string | null;
|
|
18763
|
+
/** @enum {string} */
|
|
18764
|
+
status: "active" | "inactive" | "pending";
|
|
18765
|
+
payoutAccountId?: string | null;
|
|
18766
|
+
/** Format: uuid */
|
|
18767
|
+
id: string;
|
|
18768
|
+
shortRef?: string | null;
|
|
18769
|
+
source?: {
|
|
18770
|
+
/** Format: uuid */
|
|
18771
|
+
id: string;
|
|
18772
|
+
type: string;
|
|
18773
|
+
status?: ("active" | "inactive") | null;
|
|
18774
|
+
appId?: string | null;
|
|
18775
|
+
appIcon?: string | null;
|
|
18776
|
+
} | null;
|
|
18777
|
+
pmsStatus?: ("active" | "inactive") | null;
|
|
18778
|
+
ownershipPeriods: {
|
|
18779
|
+
listingId: string;
|
|
18780
|
+
split: number;
|
|
18781
|
+
startAt?: string | null;
|
|
18782
|
+
endAt?: string | null;
|
|
18783
|
+
}[];
|
|
18784
|
+
activeOwnerships: {
|
|
18785
|
+
listingId: string;
|
|
18786
|
+
split: number;
|
|
18787
|
+
startAt?: string | null;
|
|
18788
|
+
endAt?: string | null;
|
|
18789
|
+
}[];
|
|
18790
|
+
access?: {
|
|
18791
|
+
/** Format: uuid */
|
|
18792
|
+
userId: string;
|
|
18793
|
+
/** Format: email */
|
|
18794
|
+
email: string;
|
|
18795
|
+
/** @enum {string} */
|
|
18796
|
+
status: "active" | "inactive" | "unconfirmed";
|
|
18797
|
+
lastSeen?: string | null;
|
|
18798
|
+
lastInvitedAt?: string | null;
|
|
18799
|
+
notifications: {
|
|
18800
|
+
ownerStatementPublished: boolean;
|
|
18801
|
+
};
|
|
18802
|
+
} | null;
|
|
18803
|
+
};
|
|
18804
|
+
};
|
|
18805
|
+
};
|
|
18806
|
+
/** @description Bad request */
|
|
18807
|
+
400: {
|
|
18808
|
+
headers: {
|
|
18809
|
+
[name: string]: unknown;
|
|
18810
|
+
};
|
|
18811
|
+
content: {
|
|
18812
|
+
"application/json": {
|
|
18813
|
+
code: string;
|
|
18814
|
+
message: string;
|
|
18815
|
+
links?: {
|
|
18816
|
+
docs: string;
|
|
18817
|
+
schema: string;
|
|
18818
|
+
};
|
|
18819
|
+
issues?: {
|
|
18820
|
+
message: string;
|
|
18821
|
+
path?: (string | number)[];
|
|
18822
|
+
schema?: string;
|
|
18823
|
+
}[];
|
|
18824
|
+
context?: unknown;
|
|
18825
|
+
};
|
|
18826
|
+
};
|
|
18827
|
+
};
|
|
18828
|
+
/** @description Unauthorized */
|
|
18829
|
+
401: {
|
|
18830
|
+
headers: {
|
|
18831
|
+
[name: string]: unknown;
|
|
18832
|
+
};
|
|
18833
|
+
content: {
|
|
18834
|
+
"application/json": {
|
|
18835
|
+
code: string;
|
|
18836
|
+
message: string;
|
|
18837
|
+
links?: {
|
|
18838
|
+
docs: string;
|
|
18839
|
+
schema: string;
|
|
18840
|
+
};
|
|
18841
|
+
issues?: {
|
|
18842
|
+
message: string;
|
|
18843
|
+
path?: (string | number)[];
|
|
18844
|
+
schema?: string;
|
|
18845
|
+
}[];
|
|
18846
|
+
context?: unknown;
|
|
18847
|
+
};
|
|
18848
|
+
};
|
|
18849
|
+
};
|
|
18850
|
+
/** @description Forbidden */
|
|
18851
|
+
403: {
|
|
18852
|
+
headers: {
|
|
18853
|
+
[name: string]: unknown;
|
|
18854
|
+
};
|
|
18855
|
+
content: {
|
|
18856
|
+
"application/json": {
|
|
18857
|
+
code: string;
|
|
18858
|
+
message: string;
|
|
18859
|
+
links?: {
|
|
18860
|
+
docs: string;
|
|
18861
|
+
schema: string;
|
|
18862
|
+
};
|
|
18863
|
+
issues?: {
|
|
18864
|
+
message: string;
|
|
18865
|
+
path?: (string | number)[];
|
|
18866
|
+
schema?: string;
|
|
18867
|
+
}[];
|
|
18868
|
+
context?: unknown;
|
|
18869
|
+
};
|
|
18870
|
+
};
|
|
18871
|
+
};
|
|
18872
|
+
/** @description Not found */
|
|
18873
|
+
404: {
|
|
18874
|
+
headers: {
|
|
18875
|
+
[name: string]: unknown;
|
|
18876
|
+
};
|
|
18877
|
+
content: {
|
|
18878
|
+
"application/json": {
|
|
18879
|
+
code: string;
|
|
18880
|
+
message: string;
|
|
18881
|
+
links?: {
|
|
18882
|
+
docs: string;
|
|
18883
|
+
schema: string;
|
|
18884
|
+
};
|
|
18885
|
+
issues?: {
|
|
18886
|
+
message: string;
|
|
18887
|
+
path?: (string | number)[];
|
|
18888
|
+
schema?: string;
|
|
18889
|
+
}[];
|
|
18890
|
+
context?: unknown;
|
|
18891
|
+
};
|
|
18892
|
+
};
|
|
18893
|
+
};
|
|
18894
|
+
/** @description Internal server error */
|
|
18895
|
+
500: {
|
|
18896
|
+
headers: {
|
|
18897
|
+
[name: string]: unknown;
|
|
18898
|
+
};
|
|
18899
|
+
content: {
|
|
18900
|
+
"application/json": {
|
|
18901
|
+
code: string;
|
|
18902
|
+
message: string;
|
|
18903
|
+
links?: {
|
|
18904
|
+
docs: string;
|
|
18905
|
+
schema: string;
|
|
18906
|
+
};
|
|
18907
|
+
issues?: {
|
|
18908
|
+
message: string;
|
|
18909
|
+
path?: (string | number)[];
|
|
18910
|
+
schema?: string;
|
|
18911
|
+
}[];
|
|
18912
|
+
context?: unknown;
|
|
18913
|
+
};
|
|
18914
|
+
};
|
|
18915
|
+
};
|
|
18916
|
+
/** @description Service unavailable */
|
|
18917
|
+
503: {
|
|
18918
|
+
headers: {
|
|
18919
|
+
[name: string]: unknown;
|
|
18920
|
+
};
|
|
18921
|
+
content: {
|
|
18922
|
+
"application/json": {
|
|
18923
|
+
code: string;
|
|
18924
|
+
message: string;
|
|
18925
|
+
links?: {
|
|
18926
|
+
docs: string;
|
|
18927
|
+
schema: string;
|
|
18928
|
+
};
|
|
18929
|
+
issues?: {
|
|
18930
|
+
message: string;
|
|
18931
|
+
path?: (string | number)[];
|
|
18932
|
+
schema?: string;
|
|
18933
|
+
}[];
|
|
18934
|
+
context?: unknown;
|
|
18935
|
+
};
|
|
18936
|
+
};
|
|
18937
|
+
};
|
|
18938
|
+
};
|
|
18939
|
+
};
|
|
18940
|
+
postContactsBatch: {
|
|
17957
18941
|
parameters: {
|
|
17958
18942
|
query?: {
|
|
17959
18943
|
/** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
|
|
@@ -17966,42 +18950,9 @@ export interface operations {
|
|
|
17966
18950
|
requestBody?: {
|
|
17967
18951
|
content: {
|
|
17968
18952
|
"application/json": {
|
|
17969
|
-
|
|
17970
|
-
|
|
17971
|
-
|
|
17972
|
-
line2?: string | null;
|
|
17973
|
-
city?: string | null;
|
|
17974
|
-
/** @description Deprecated, use stateCode instead */
|
|
17975
|
-
state?: string | null;
|
|
17976
|
-
postalCode?: string | null;
|
|
17977
|
-
stateCode?: string | null;
|
|
17978
|
-
countryCode?: string | null;
|
|
17979
|
-
} | null;
|
|
17980
|
-
/** @enum {string} */
|
|
17981
|
-
type: "owner" | "vendor";
|
|
17982
|
-
email?: string | null;
|
|
17983
|
-
firstName?: string | null;
|
|
17984
|
-
name?: string | null;
|
|
17985
|
-
phone?: string | null;
|
|
17986
|
-
connectionId?: string | null;
|
|
17987
|
-
companyType?: ("c_corporation" | "limited_liability_company" | "partnership" | "s_corporation" | "trust_estate") | null;
|
|
17988
|
-
taxIdentifier?: string | null;
|
|
17989
|
-
sourceId?: string | null;
|
|
17990
|
-
uniqueRef?: string | null;
|
|
17991
|
-
status?: ("active" | "inactive") | null;
|
|
17992
|
-
payoutAccountId?: string | null;
|
|
17993
|
-
invite?: boolean | null;
|
|
17994
|
-
};
|
|
17995
|
-
};
|
|
17996
|
-
};
|
|
17997
|
-
responses: {
|
|
17998
|
-
/** @description Successful response */
|
|
17999
|
-
200: {
|
|
18000
|
-
headers: {
|
|
18001
|
-
[name: string]: unknown;
|
|
18002
|
-
};
|
|
18003
|
-
content: {
|
|
18004
|
-
"application/json": {
|
|
18953
|
+
/** Format: uuid */
|
|
18954
|
+
connectionId: string;
|
|
18955
|
+
data: {
|
|
18005
18956
|
address?: {
|
|
18006
18957
|
full?: string | null;
|
|
18007
18958
|
line1?: string | null;
|
|
@@ -18015,54 +18966,44 @@ export interface operations {
|
|
|
18015
18966
|
} | null;
|
|
18016
18967
|
/** @enum {string} */
|
|
18017
18968
|
type: "owner" | "vendor";
|
|
18018
|
-
email?: string | null;
|
|
18019
18969
|
firstName?: string | null;
|
|
18020
18970
|
name?: string | null;
|
|
18021
18971
|
phone?: string | null;
|
|
18022
18972
|
connectionId?: string | null;
|
|
18023
18973
|
companyType?: ("c_corporation" | "limited_liability_company" | "partnership" | "s_corporation" | "trust_estate") | null;
|
|
18024
18974
|
taxIdentifier?: string | null;
|
|
18975
|
+
sourceId?: string | null;
|
|
18025
18976
|
uniqueRef?: string | null;
|
|
18026
|
-
|
|
18027
|
-
status: "active" | "inactive" | "pending";
|
|
18977
|
+
status?: ("active" | "inactive") | null;
|
|
18028
18978
|
payoutAccountId?: string | null;
|
|
18029
|
-
|
|
18030
|
-
|
|
18031
|
-
|
|
18032
|
-
|
|
18979
|
+
id?: string | null;
|
|
18980
|
+
email?: string | null;
|
|
18981
|
+
}[];
|
|
18982
|
+
};
|
|
18983
|
+
};
|
|
18984
|
+
};
|
|
18985
|
+
responses: {
|
|
18986
|
+
/** @description Successful response */
|
|
18987
|
+
200: {
|
|
18988
|
+
headers: {
|
|
18989
|
+
[name: string]: unknown;
|
|
18990
|
+
};
|
|
18991
|
+
content: {
|
|
18992
|
+
"application/json": {
|
|
18993
|
+
data: {
|
|
18033
18994
|
/** Format: uuid */
|
|
18034
18995
|
id: string;
|
|
18035
|
-
|
|
18036
|
-
|
|
18037
|
-
appId?: string | null;
|
|
18038
|
-
appIcon?: string | null;
|
|
18039
|
-
} | null;
|
|
18040
|
-
pmsStatus?: ("active" | "inactive") | null;
|
|
18041
|
-
ownershipPeriods: {
|
|
18042
|
-
listingId: string;
|
|
18043
|
-
split: number;
|
|
18044
|
-
startAt?: string | null;
|
|
18045
|
-
endAt?: string | null;
|
|
18046
|
-
}[];
|
|
18047
|
-
activeOwnerships: {
|
|
18048
|
-
listingId: string;
|
|
18049
|
-
split: number;
|
|
18050
|
-
startAt?: string | null;
|
|
18051
|
-
endAt?: string | null;
|
|
18996
|
+
uniqueRef?: string | null;
|
|
18997
|
+
sourceId?: string | null;
|
|
18052
18998
|
}[];
|
|
18053
|
-
|
|
18054
|
-
|
|
18055
|
-
|
|
18056
|
-
|
|
18057
|
-
email: string;
|
|
18999
|
+
issues: {
|
|
19000
|
+
ref: string;
|
|
19001
|
+
sourceId?: string | null;
|
|
19002
|
+
message: string;
|
|
18058
19003
|
/** @enum {string} */
|
|
18059
|
-
|
|
18060
|
-
|
|
18061
|
-
|
|
18062
|
-
notifications: {
|
|
18063
|
-
ownerStatementPublished: boolean;
|
|
18064
|
-
};
|
|
18065
|
-
} | null;
|
|
19004
|
+
code?: "USER_ERROR" | "NOT_FOUND" | "FORBIDDEN" | "CONFLICT" | "RATE_LIMITED" | "SERVICE_UNAVAILABLE" | "INTERNAL_VALIDATION_ERROR" | "INTERNAL_ERROR";
|
|
19005
|
+
context?: unknown;
|
|
19006
|
+
}[];
|
|
18066
19007
|
};
|
|
18067
19008
|
};
|
|
18068
19009
|
};
|
|
@@ -18200,51 +19141,26 @@ export interface operations {
|
|
|
18200
19141
|
};
|
|
18201
19142
|
};
|
|
18202
19143
|
};
|
|
18203
|
-
|
|
19144
|
+
getContactsCsv: {
|
|
18204
19145
|
parameters: {
|
|
18205
19146
|
query?: {
|
|
18206
|
-
|
|
18207
|
-
|
|
19147
|
+
search?: string;
|
|
19148
|
+
status?: "active" | "inactive" | "pending";
|
|
19149
|
+
type?: "owner" | "vendor";
|
|
19150
|
+
companyType?: "c_corporation" | "limited_liability_company" | "partnership" | "s_corporation" | "trust_estate";
|
|
19151
|
+
isIndividual?: boolean;
|
|
19152
|
+
/** @description Filter contacts by ownership period ID. */
|
|
19153
|
+
ownershipPeriodId?: string;
|
|
19154
|
+
/** @description comma separated contact short refs */
|
|
19155
|
+
shortRefs?: string;
|
|
19156
|
+
/** @description Comma-separated contact IDs. */
|
|
19157
|
+
ids?: string;
|
|
18208
19158
|
};
|
|
18209
19159
|
header?: never;
|
|
18210
19160
|
path?: never;
|
|
18211
19161
|
cookie?: never;
|
|
18212
19162
|
};
|
|
18213
|
-
requestBody?:
|
|
18214
|
-
content: {
|
|
18215
|
-
"application/json": {
|
|
18216
|
-
/** Format: uuid */
|
|
18217
|
-
connectionId: string;
|
|
18218
|
-
data: {
|
|
18219
|
-
address?: {
|
|
18220
|
-
full?: string | null;
|
|
18221
|
-
line1?: string | null;
|
|
18222
|
-
line2?: string | null;
|
|
18223
|
-
city?: string | null;
|
|
18224
|
-
/** @description Deprecated, use stateCode instead */
|
|
18225
|
-
state?: string | null;
|
|
18226
|
-
postalCode?: string | null;
|
|
18227
|
-
stateCode?: string | null;
|
|
18228
|
-
countryCode?: string | null;
|
|
18229
|
-
} | null;
|
|
18230
|
-
/** @enum {string} */
|
|
18231
|
-
type: "owner" | "vendor";
|
|
18232
|
-
firstName?: string | null;
|
|
18233
|
-
name?: string | null;
|
|
18234
|
-
phone?: string | null;
|
|
18235
|
-
connectionId?: string | null;
|
|
18236
|
-
companyType?: ("c_corporation" | "limited_liability_company" | "partnership" | "s_corporation" | "trust_estate") | null;
|
|
18237
|
-
taxIdentifier?: string | null;
|
|
18238
|
-
sourceId?: string | null;
|
|
18239
|
-
uniqueRef?: string | null;
|
|
18240
|
-
status?: ("active" | "inactive") | null;
|
|
18241
|
-
payoutAccountId?: string | null;
|
|
18242
|
-
id?: string | null;
|
|
18243
|
-
email?: string | null;
|
|
18244
|
-
}[];
|
|
18245
|
-
};
|
|
18246
|
-
};
|
|
18247
|
-
};
|
|
19163
|
+
requestBody?: never;
|
|
18248
19164
|
responses: {
|
|
18249
19165
|
/** @description Successful response */
|
|
18250
19166
|
200: {
|
|
@@ -18253,20 +19169,7 @@ export interface operations {
|
|
|
18253
19169
|
};
|
|
18254
19170
|
content: {
|
|
18255
19171
|
"application/json": {
|
|
18256
|
-
|
|
18257
|
-
/** Format: uuid */
|
|
18258
|
-
id: string;
|
|
18259
|
-
uniqueRef?: string | null;
|
|
18260
|
-
sourceId?: string | null;
|
|
18261
|
-
}[];
|
|
18262
|
-
issues: {
|
|
18263
|
-
ref: string;
|
|
18264
|
-
sourceId?: string | null;
|
|
18265
|
-
message: string;
|
|
18266
|
-
/** @enum {string} */
|
|
18267
|
-
code?: "USER_ERROR" | "NOT_FOUND" | "FORBIDDEN" | "CONFLICT" | "RATE_LIMITED" | "SERVICE_UNAVAILABLE" | "INTERNAL_VALIDATION_ERROR" | "INTERNAL_ERROR";
|
|
18268
|
-
context?: unknown;
|
|
18269
|
-
}[];
|
|
19172
|
+
url: string;
|
|
18270
19173
|
};
|
|
18271
19174
|
};
|
|
18272
19175
|
};
|
|
@@ -18404,23 +19307,13 @@ export interface operations {
|
|
|
18404
19307
|
};
|
|
18405
19308
|
};
|
|
18406
19309
|
};
|
|
18407
|
-
|
|
19310
|
+
getContactsById: {
|
|
18408
19311
|
parameters: {
|
|
18409
|
-
query?:
|
|
18410
|
-
search?: string;
|
|
18411
|
-
status?: "active" | "inactive" | "pending";
|
|
18412
|
-
type?: "owner" | "vendor";
|
|
18413
|
-
companyType?: "c_corporation" | "limited_liability_company" | "partnership" | "s_corporation" | "trust_estate";
|
|
18414
|
-
isIndividual?: boolean;
|
|
18415
|
-
/** @description Filter contacts by ownership period ID. */
|
|
18416
|
-
ownershipPeriodId?: string;
|
|
18417
|
-
/** @description comma separated contact short refs */
|
|
18418
|
-
shortRefs?: string;
|
|
18419
|
-
/** @description Comma-separated contact IDs. */
|
|
18420
|
-
ids?: string;
|
|
18421
|
-
};
|
|
19312
|
+
query?: never;
|
|
18422
19313
|
header?: never;
|
|
18423
|
-
path
|
|
19314
|
+
path: {
|
|
19315
|
+
id: string;
|
|
19316
|
+
};
|
|
18424
19317
|
cookie?: never;
|
|
18425
19318
|
};
|
|
18426
19319
|
requestBody?: never;
|
|
@@ -18432,7 +19325,67 @@ export interface operations {
|
|
|
18432
19325
|
};
|
|
18433
19326
|
content: {
|
|
18434
19327
|
"application/json": {
|
|
18435
|
-
|
|
19328
|
+
address?: {
|
|
19329
|
+
full?: string | null;
|
|
19330
|
+
line1?: string | null;
|
|
19331
|
+
line2?: string | null;
|
|
19332
|
+
city?: string | null;
|
|
19333
|
+
/** @description Deprecated, use stateCode instead */
|
|
19334
|
+
state?: string | null;
|
|
19335
|
+
postalCode?: string | null;
|
|
19336
|
+
stateCode?: string | null;
|
|
19337
|
+
countryCode?: string | null;
|
|
19338
|
+
} | null;
|
|
19339
|
+
/** @enum {string} */
|
|
19340
|
+
type: "owner" | "vendor";
|
|
19341
|
+
email?: string | null;
|
|
19342
|
+
firstName?: string | null;
|
|
19343
|
+
name?: string | null;
|
|
19344
|
+
phone?: string | null;
|
|
19345
|
+
connectionId?: string | null;
|
|
19346
|
+
companyType?: ("c_corporation" | "limited_liability_company" | "partnership" | "s_corporation" | "trust_estate") | null;
|
|
19347
|
+
taxIdentifier?: string | null;
|
|
19348
|
+
uniqueRef?: string | null;
|
|
19349
|
+
/** @enum {string} */
|
|
19350
|
+
status: "active" | "inactive" | "pending";
|
|
19351
|
+
payoutAccountId?: string | null;
|
|
19352
|
+
/** Format: uuid */
|
|
19353
|
+
id: string;
|
|
19354
|
+
shortRef?: string | null;
|
|
19355
|
+
source?: {
|
|
19356
|
+
/** Format: uuid */
|
|
19357
|
+
id: string;
|
|
19358
|
+
type: string;
|
|
19359
|
+
status?: ("active" | "inactive") | null;
|
|
19360
|
+
appId?: string | null;
|
|
19361
|
+
appIcon?: string | null;
|
|
19362
|
+
} | null;
|
|
19363
|
+
pmsStatus?: ("active" | "inactive") | null;
|
|
19364
|
+
ownershipPeriods: {
|
|
19365
|
+
listingId: string;
|
|
19366
|
+
split: number;
|
|
19367
|
+
startAt?: string | null;
|
|
19368
|
+
endAt?: string | null;
|
|
19369
|
+
}[];
|
|
19370
|
+
activeOwnerships: {
|
|
19371
|
+
listingId: string;
|
|
19372
|
+
split: number;
|
|
19373
|
+
startAt?: string | null;
|
|
19374
|
+
endAt?: string | null;
|
|
19375
|
+
}[];
|
|
19376
|
+
access?: {
|
|
19377
|
+
/** Format: uuid */
|
|
19378
|
+
userId: string;
|
|
19379
|
+
/** Format: email */
|
|
19380
|
+
email: string;
|
|
19381
|
+
/** @enum {string} */
|
|
19382
|
+
status: "active" | "inactive" | "unconfirmed";
|
|
19383
|
+
lastSeen?: string | null;
|
|
19384
|
+
lastInvitedAt?: string | null;
|
|
19385
|
+
notifications: {
|
|
19386
|
+
ownerStatementPublished: boolean;
|
|
19387
|
+
};
|
|
19388
|
+
} | null;
|
|
18436
19389
|
};
|
|
18437
19390
|
};
|
|
18438
19391
|
};
|
|
@@ -18570,16 +19523,48 @@ export interface operations {
|
|
|
18570
19523
|
};
|
|
18571
19524
|
};
|
|
18572
19525
|
};
|
|
18573
|
-
|
|
19526
|
+
putContactsById: {
|
|
18574
19527
|
parameters: {
|
|
18575
|
-
query?:
|
|
19528
|
+
query?: {
|
|
19529
|
+
/** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
|
|
19530
|
+
dryRun?: boolean;
|
|
19531
|
+
};
|
|
18576
19532
|
header?: never;
|
|
18577
19533
|
path: {
|
|
18578
19534
|
id: string;
|
|
18579
19535
|
};
|
|
18580
19536
|
cookie?: never;
|
|
18581
19537
|
};
|
|
18582
|
-
requestBody?:
|
|
19538
|
+
requestBody?: {
|
|
19539
|
+
content: {
|
|
19540
|
+
"application/json": {
|
|
19541
|
+
address?: {
|
|
19542
|
+
full?: string | null;
|
|
19543
|
+
line1?: string | null;
|
|
19544
|
+
line2?: string | null;
|
|
19545
|
+
city?: string | null;
|
|
19546
|
+
/** @description Deprecated, use stateCode instead */
|
|
19547
|
+
state?: string | null;
|
|
19548
|
+
postalCode?: string | null;
|
|
19549
|
+
stateCode?: string | null;
|
|
19550
|
+
countryCode?: string | null;
|
|
19551
|
+
} | null;
|
|
19552
|
+
/** @enum {string} */
|
|
19553
|
+
type?: "owner" | "vendor";
|
|
19554
|
+
email?: string | null;
|
|
19555
|
+
firstName?: string | null;
|
|
19556
|
+
name?: string | null;
|
|
19557
|
+
phone?: string | null;
|
|
19558
|
+
connectionId?: string | null;
|
|
19559
|
+
companyType?: ("c_corporation" | "limited_liability_company" | "partnership" | "s_corporation" | "trust_estate") | null;
|
|
19560
|
+
taxIdentifier?: string | null;
|
|
19561
|
+
sourceId?: string | null;
|
|
19562
|
+
uniqueRef?: string | null;
|
|
19563
|
+
status?: ("active" | "inactive") | null;
|
|
19564
|
+
payoutAccountId?: string | null;
|
|
19565
|
+
};
|
|
19566
|
+
};
|
|
19567
|
+
};
|
|
18583
19568
|
responses: {
|
|
18584
19569
|
/** @description Successful response */
|
|
18585
19570
|
200: {
|
|
@@ -18786,9 +19771,10 @@ export interface operations {
|
|
|
18786
19771
|
};
|
|
18787
19772
|
};
|
|
18788
19773
|
};
|
|
18789
|
-
|
|
19774
|
+
deleteContactsById: {
|
|
18790
19775
|
parameters: {
|
|
18791
19776
|
query?: {
|
|
19777
|
+
onLocked?: "error" | "archive";
|
|
18792
19778
|
/** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
|
|
18793
19779
|
dryRun?: boolean;
|
|
18794
19780
|
};
|
|
@@ -18800,32 +19786,7 @@ export interface operations {
|
|
|
18800
19786
|
};
|
|
18801
19787
|
requestBody?: {
|
|
18802
19788
|
content: {
|
|
18803
|
-
"application/json":
|
|
18804
|
-
address?: {
|
|
18805
|
-
full?: string | null;
|
|
18806
|
-
line1?: string | null;
|
|
18807
|
-
line2?: string | null;
|
|
18808
|
-
city?: string | null;
|
|
18809
|
-
/** @description Deprecated, use stateCode instead */
|
|
18810
|
-
state?: string | null;
|
|
18811
|
-
postalCode?: string | null;
|
|
18812
|
-
stateCode?: string | null;
|
|
18813
|
-
countryCode?: string | null;
|
|
18814
|
-
} | null;
|
|
18815
|
-
/** @enum {string} */
|
|
18816
|
-
type?: "owner" | "vendor";
|
|
18817
|
-
email?: string | null;
|
|
18818
|
-
firstName?: string | null;
|
|
18819
|
-
name?: string | null;
|
|
18820
|
-
phone?: string | null;
|
|
18821
|
-
connectionId?: string | null;
|
|
18822
|
-
companyType?: ("c_corporation" | "limited_liability_company" | "partnership" | "s_corporation" | "trust_estate") | null;
|
|
18823
|
-
taxIdentifier?: string | null;
|
|
18824
|
-
sourceId?: string | null;
|
|
18825
|
-
uniqueRef?: string | null;
|
|
18826
|
-
status?: ("active" | "inactive") | null;
|
|
18827
|
-
payoutAccountId?: string | null;
|
|
18828
|
-
};
|
|
19789
|
+
"application/json": Record<string, never>;
|
|
18829
19790
|
};
|
|
18830
19791
|
};
|
|
18831
19792
|
responses: {
|
|
@@ -18836,67 +19797,8 @@ export interface operations {
|
|
|
18836
19797
|
};
|
|
18837
19798
|
content: {
|
|
18838
19799
|
"application/json": {
|
|
18839
|
-
address?: {
|
|
18840
|
-
full?: string | null;
|
|
18841
|
-
line1?: string | null;
|
|
18842
|
-
line2?: string | null;
|
|
18843
|
-
city?: string | null;
|
|
18844
|
-
/** @description Deprecated, use stateCode instead */
|
|
18845
|
-
state?: string | null;
|
|
18846
|
-
postalCode?: string | null;
|
|
18847
|
-
stateCode?: string | null;
|
|
18848
|
-
countryCode?: string | null;
|
|
18849
|
-
} | null;
|
|
18850
|
-
/** @enum {string} */
|
|
18851
|
-
type: "owner" | "vendor";
|
|
18852
|
-
email?: string | null;
|
|
18853
|
-
firstName?: string | null;
|
|
18854
|
-
name?: string | null;
|
|
18855
|
-
phone?: string | null;
|
|
18856
|
-
connectionId?: string | null;
|
|
18857
|
-
companyType?: ("c_corporation" | "limited_liability_company" | "partnership" | "s_corporation" | "trust_estate") | null;
|
|
18858
|
-
taxIdentifier?: string | null;
|
|
18859
|
-
uniqueRef?: string | null;
|
|
18860
19800
|
/** @enum {string} */
|
|
18861
|
-
status: "
|
|
18862
|
-
payoutAccountId?: string | null;
|
|
18863
|
-
/** Format: uuid */
|
|
18864
|
-
id: string;
|
|
18865
|
-
shortRef?: string | null;
|
|
18866
|
-
source?: {
|
|
18867
|
-
/** Format: uuid */
|
|
18868
|
-
id: string;
|
|
18869
|
-
type: string;
|
|
18870
|
-
status?: ("active" | "inactive") | null;
|
|
18871
|
-
appId?: string | null;
|
|
18872
|
-
appIcon?: string | null;
|
|
18873
|
-
} | null;
|
|
18874
|
-
pmsStatus?: ("active" | "inactive") | null;
|
|
18875
|
-
ownershipPeriods: {
|
|
18876
|
-
listingId: string;
|
|
18877
|
-
split: number;
|
|
18878
|
-
startAt?: string | null;
|
|
18879
|
-
endAt?: string | null;
|
|
18880
|
-
}[];
|
|
18881
|
-
activeOwnerships: {
|
|
18882
|
-
listingId: string;
|
|
18883
|
-
split: number;
|
|
18884
|
-
startAt?: string | null;
|
|
18885
|
-
endAt?: string | null;
|
|
18886
|
-
}[];
|
|
18887
|
-
access?: {
|
|
18888
|
-
/** Format: uuid */
|
|
18889
|
-
userId: string;
|
|
18890
|
-
/** Format: email */
|
|
18891
|
-
email: string;
|
|
18892
|
-
/** @enum {string} */
|
|
18893
|
-
status: "active" | "inactive" | "unconfirmed";
|
|
18894
|
-
lastSeen?: string | null;
|
|
18895
|
-
lastInvitedAt?: string | null;
|
|
18896
|
-
notifications: {
|
|
18897
|
-
ownerStatementPublished: boolean;
|
|
18898
|
-
};
|
|
18899
|
-
} | null;
|
|
19801
|
+
status: "deleted" | "archived";
|
|
18900
19802
|
};
|
|
18901
19803
|
};
|
|
18902
19804
|
};
|
|
@@ -19034,13 +19936,9 @@ export interface operations {
|
|
|
19034
19936
|
};
|
|
19035
19937
|
};
|
|
19036
19938
|
};
|
|
19037
|
-
|
|
19939
|
+
postContactsByIdInvite: {
|
|
19038
19940
|
parameters: {
|
|
19039
|
-
query?:
|
|
19040
|
-
onLocked?: "error" | "archive";
|
|
19041
|
-
/** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
|
|
19042
|
-
dryRun?: boolean;
|
|
19043
|
-
};
|
|
19941
|
+
query?: never;
|
|
19044
19942
|
header?: never;
|
|
19045
19943
|
path: {
|
|
19046
19944
|
id: string;
|
|
@@ -19049,7 +19947,10 @@ export interface operations {
|
|
|
19049
19947
|
};
|
|
19050
19948
|
requestBody?: {
|
|
19051
19949
|
content: {
|
|
19052
|
-
"application/json":
|
|
19950
|
+
"application/json": {
|
|
19951
|
+
/** @default true */
|
|
19952
|
+
email?: boolean | null;
|
|
19953
|
+
};
|
|
19053
19954
|
};
|
|
19054
19955
|
};
|
|
19055
19956
|
responses: {
|
|
@@ -19060,8 +19961,7 @@ export interface operations {
|
|
|
19060
19961
|
};
|
|
19061
19962
|
content: {
|
|
19062
19963
|
"application/json": {
|
|
19063
|
-
|
|
19064
|
-
status: "deleted" | "archived";
|
|
19964
|
+
url: string;
|
|
19065
19965
|
};
|
|
19066
19966
|
};
|
|
19067
19967
|
};
|
|
@@ -19199,7 +20099,7 @@ export interface operations {
|
|
|
19199
20099
|
};
|
|
19200
20100
|
};
|
|
19201
20101
|
};
|
|
19202
|
-
|
|
20102
|
+
postContactsByIdRevokeAccess: {
|
|
19203
20103
|
parameters: {
|
|
19204
20104
|
query?: never;
|
|
19205
20105
|
header?: never;
|
|
@@ -19210,12 +20110,166 @@ export interface operations {
|
|
|
19210
20110
|
};
|
|
19211
20111
|
requestBody?: {
|
|
19212
20112
|
content: {
|
|
19213
|
-
"application/json":
|
|
19214
|
-
|
|
19215
|
-
|
|
20113
|
+
"application/json": Record<string, never>;
|
|
20114
|
+
};
|
|
20115
|
+
};
|
|
20116
|
+
responses: {
|
|
20117
|
+
/** @description Successful response */
|
|
20118
|
+
200: {
|
|
20119
|
+
headers: {
|
|
20120
|
+
[name: string]: unknown;
|
|
20121
|
+
};
|
|
20122
|
+
content: {
|
|
20123
|
+
"application/json": {
|
|
20124
|
+
deletedAccess: number;
|
|
20125
|
+
deletedUsers: number;
|
|
20126
|
+
};
|
|
20127
|
+
};
|
|
20128
|
+
};
|
|
20129
|
+
/** @description Bad request */
|
|
20130
|
+
400: {
|
|
20131
|
+
headers: {
|
|
20132
|
+
[name: string]: unknown;
|
|
20133
|
+
};
|
|
20134
|
+
content: {
|
|
20135
|
+
"application/json": {
|
|
20136
|
+
code: string;
|
|
20137
|
+
message: string;
|
|
20138
|
+
links?: {
|
|
20139
|
+
docs: string;
|
|
20140
|
+
schema: string;
|
|
20141
|
+
};
|
|
20142
|
+
issues?: {
|
|
20143
|
+
message: string;
|
|
20144
|
+
path?: (string | number)[];
|
|
20145
|
+
schema?: string;
|
|
20146
|
+
}[];
|
|
20147
|
+
context?: unknown;
|
|
20148
|
+
};
|
|
20149
|
+
};
|
|
20150
|
+
};
|
|
20151
|
+
/** @description Unauthorized */
|
|
20152
|
+
401: {
|
|
20153
|
+
headers: {
|
|
20154
|
+
[name: string]: unknown;
|
|
20155
|
+
};
|
|
20156
|
+
content: {
|
|
20157
|
+
"application/json": {
|
|
20158
|
+
code: string;
|
|
20159
|
+
message: string;
|
|
20160
|
+
links?: {
|
|
20161
|
+
docs: string;
|
|
20162
|
+
schema: string;
|
|
20163
|
+
};
|
|
20164
|
+
issues?: {
|
|
20165
|
+
message: string;
|
|
20166
|
+
path?: (string | number)[];
|
|
20167
|
+
schema?: string;
|
|
20168
|
+
}[];
|
|
20169
|
+
context?: unknown;
|
|
20170
|
+
};
|
|
20171
|
+
};
|
|
20172
|
+
};
|
|
20173
|
+
/** @description Forbidden */
|
|
20174
|
+
403: {
|
|
20175
|
+
headers: {
|
|
20176
|
+
[name: string]: unknown;
|
|
20177
|
+
};
|
|
20178
|
+
content: {
|
|
20179
|
+
"application/json": {
|
|
20180
|
+
code: string;
|
|
20181
|
+
message: string;
|
|
20182
|
+
links?: {
|
|
20183
|
+
docs: string;
|
|
20184
|
+
schema: string;
|
|
20185
|
+
};
|
|
20186
|
+
issues?: {
|
|
20187
|
+
message: string;
|
|
20188
|
+
path?: (string | number)[];
|
|
20189
|
+
schema?: string;
|
|
20190
|
+
}[];
|
|
20191
|
+
context?: unknown;
|
|
20192
|
+
};
|
|
20193
|
+
};
|
|
20194
|
+
};
|
|
20195
|
+
/** @description Not found */
|
|
20196
|
+
404: {
|
|
20197
|
+
headers: {
|
|
20198
|
+
[name: string]: unknown;
|
|
20199
|
+
};
|
|
20200
|
+
content: {
|
|
20201
|
+
"application/json": {
|
|
20202
|
+
code: string;
|
|
20203
|
+
message: string;
|
|
20204
|
+
links?: {
|
|
20205
|
+
docs: string;
|
|
20206
|
+
schema: string;
|
|
20207
|
+
};
|
|
20208
|
+
issues?: {
|
|
20209
|
+
message: string;
|
|
20210
|
+
path?: (string | number)[];
|
|
20211
|
+
schema?: string;
|
|
20212
|
+
}[];
|
|
20213
|
+
context?: unknown;
|
|
20214
|
+
};
|
|
20215
|
+
};
|
|
20216
|
+
};
|
|
20217
|
+
/** @description Internal server error */
|
|
20218
|
+
500: {
|
|
20219
|
+
headers: {
|
|
20220
|
+
[name: string]: unknown;
|
|
20221
|
+
};
|
|
20222
|
+
content: {
|
|
20223
|
+
"application/json": {
|
|
20224
|
+
code: string;
|
|
20225
|
+
message: string;
|
|
20226
|
+
links?: {
|
|
20227
|
+
docs: string;
|
|
20228
|
+
schema: string;
|
|
20229
|
+
};
|
|
20230
|
+
issues?: {
|
|
20231
|
+
message: string;
|
|
20232
|
+
path?: (string | number)[];
|
|
20233
|
+
schema?: string;
|
|
20234
|
+
}[];
|
|
20235
|
+
context?: unknown;
|
|
20236
|
+
};
|
|
20237
|
+
};
|
|
20238
|
+
};
|
|
20239
|
+
/** @description Service unavailable */
|
|
20240
|
+
503: {
|
|
20241
|
+
headers: {
|
|
20242
|
+
[name: string]: unknown;
|
|
20243
|
+
};
|
|
20244
|
+
content: {
|
|
20245
|
+
"application/json": {
|
|
20246
|
+
code: string;
|
|
20247
|
+
message: string;
|
|
20248
|
+
links?: {
|
|
20249
|
+
docs: string;
|
|
20250
|
+
schema: string;
|
|
20251
|
+
};
|
|
20252
|
+
issues?: {
|
|
20253
|
+
message: string;
|
|
20254
|
+
path?: (string | number)[];
|
|
20255
|
+
schema?: string;
|
|
20256
|
+
}[];
|
|
20257
|
+
context?: unknown;
|
|
20258
|
+
};
|
|
19216
20259
|
};
|
|
19217
20260
|
};
|
|
19218
20261
|
};
|
|
20262
|
+
};
|
|
20263
|
+
getContactsByIdViewers: {
|
|
20264
|
+
parameters: {
|
|
20265
|
+
query?: never;
|
|
20266
|
+
header?: never;
|
|
20267
|
+
path: {
|
|
20268
|
+
id: string;
|
|
20269
|
+
};
|
|
20270
|
+
cookie?: never;
|
|
20271
|
+
};
|
|
20272
|
+
requestBody?: never;
|
|
19219
20273
|
responses: {
|
|
19220
20274
|
/** @description Successful response */
|
|
19221
20275
|
200: {
|
|
@@ -19224,7 +20278,20 @@ export interface operations {
|
|
|
19224
20278
|
};
|
|
19225
20279
|
content: {
|
|
19226
20280
|
"application/json": {
|
|
19227
|
-
|
|
20281
|
+
data: {
|
|
20282
|
+
/** Format: uuid */
|
|
20283
|
+
userId: string;
|
|
20284
|
+
email: string;
|
|
20285
|
+
firstName: string | null;
|
|
20286
|
+
lastName: string | null;
|
|
20287
|
+
/** @enum {string} */
|
|
20288
|
+
status: "active" | "inactive" | "unconfirmed";
|
|
20289
|
+
lastInvitedAt: string | null;
|
|
20290
|
+
lastSeen: string | null;
|
|
20291
|
+
notifications: {
|
|
20292
|
+
ownerStatementPublished: boolean;
|
|
20293
|
+
};
|
|
20294
|
+
}[];
|
|
19228
20295
|
};
|
|
19229
20296
|
};
|
|
19230
20297
|
};
|
|
@@ -19362,7 +20429,7 @@ export interface operations {
|
|
|
19362
20429
|
};
|
|
19363
20430
|
};
|
|
19364
20431
|
};
|
|
19365
|
-
|
|
20432
|
+
postContactsByIdViewers: {
|
|
19366
20433
|
parameters: {
|
|
19367
20434
|
query?: never;
|
|
19368
20435
|
header?: never;
|
|
@@ -19373,7 +20440,11 @@ export interface operations {
|
|
|
19373
20440
|
};
|
|
19374
20441
|
requestBody?: {
|
|
19375
20442
|
content: {
|
|
19376
|
-
"application/json":
|
|
20443
|
+
"application/json": {
|
|
20444
|
+
email: string;
|
|
20445
|
+
/** @default true */
|
|
20446
|
+
sendEmail?: boolean;
|
|
20447
|
+
};
|
|
19377
20448
|
};
|
|
19378
20449
|
};
|
|
19379
20450
|
responses: {
|
|
@@ -19384,8 +20455,21 @@ export interface operations {
|
|
|
19384
20455
|
};
|
|
19385
20456
|
content: {
|
|
19386
20457
|
"application/json": {
|
|
19387
|
-
|
|
19388
|
-
|
|
20458
|
+
url: string;
|
|
20459
|
+
viewer: {
|
|
20460
|
+
/** Format: uuid */
|
|
20461
|
+
userId: string;
|
|
20462
|
+
email: string;
|
|
20463
|
+
firstName: string | null;
|
|
20464
|
+
lastName: string | null;
|
|
20465
|
+
/** @enum {string} */
|
|
20466
|
+
status: "active" | "inactive" | "unconfirmed";
|
|
20467
|
+
lastInvitedAt: string | null;
|
|
20468
|
+
lastSeen: string | null;
|
|
20469
|
+
notifications: {
|
|
20470
|
+
ownerStatementPublished: boolean;
|
|
20471
|
+
};
|
|
20472
|
+
};
|
|
19389
20473
|
};
|
|
19390
20474
|
};
|
|
19391
20475
|
};
|
|
@@ -19523,12 +20607,13 @@ export interface operations {
|
|
|
19523
20607
|
};
|
|
19524
20608
|
};
|
|
19525
20609
|
};
|
|
19526
|
-
|
|
20610
|
+
deleteContactsByIdViewersByUserId: {
|
|
19527
20611
|
parameters: {
|
|
19528
20612
|
query?: never;
|
|
19529
20613
|
header?: never;
|
|
19530
20614
|
path: {
|
|
19531
20615
|
id: string;
|
|
20616
|
+
userId: string;
|
|
19532
20617
|
};
|
|
19533
20618
|
cookie?: never;
|
|
19534
20619
|
};
|
|
@@ -19541,20 +20626,8 @@ export interface operations {
|
|
|
19541
20626
|
};
|
|
19542
20627
|
content: {
|
|
19543
20628
|
"application/json": {
|
|
19544
|
-
|
|
19545
|
-
|
|
19546
|
-
userId: string;
|
|
19547
|
-
email: string;
|
|
19548
|
-
firstName: string | null;
|
|
19549
|
-
lastName: string | null;
|
|
19550
|
-
/** @enum {string} */
|
|
19551
|
-
status: "active" | "inactive" | "unconfirmed";
|
|
19552
|
-
lastInvitedAt: string | null;
|
|
19553
|
-
lastSeen: string | null;
|
|
19554
|
-
notifications: {
|
|
19555
|
-
ownerStatementPublished: boolean;
|
|
19556
|
-
};
|
|
19557
|
-
}[];
|
|
20629
|
+
/** @constant */
|
|
20630
|
+
status: "deleted";
|
|
19558
20631
|
};
|
|
19559
20632
|
};
|
|
19560
20633
|
};
|
|
@@ -19692,19 +20765,19 @@ export interface operations {
|
|
|
19692
20765
|
};
|
|
19693
20766
|
};
|
|
19694
20767
|
};
|
|
19695
|
-
|
|
20768
|
+
postContactsByIdViewersByUserIdReinvite: {
|
|
19696
20769
|
parameters: {
|
|
19697
20770
|
query?: never;
|
|
19698
20771
|
header?: never;
|
|
19699
20772
|
path: {
|
|
19700
20773
|
id: string;
|
|
20774
|
+
userId: string;
|
|
19701
20775
|
};
|
|
19702
20776
|
cookie?: never;
|
|
19703
20777
|
};
|
|
19704
20778
|
requestBody?: {
|
|
19705
20779
|
content: {
|
|
19706
20780
|
"application/json": {
|
|
19707
|
-
email: string;
|
|
19708
20781
|
/** @default true */
|
|
19709
20782
|
sendEmail?: boolean;
|
|
19710
20783
|
};
|
|
@@ -19870,14 +20943,14 @@ export interface operations {
|
|
|
19870
20943
|
};
|
|
19871
20944
|
};
|
|
19872
20945
|
};
|
|
19873
|
-
|
|
20946
|
+
getEmailTemplate: {
|
|
19874
20947
|
parameters: {
|
|
19875
|
-
query
|
|
19876
|
-
|
|
19877
|
-
|
|
19878
|
-
id: string;
|
|
19879
|
-
userId: string;
|
|
20948
|
+
query: {
|
|
20949
|
+
/** @description Email template type to fetch. */
|
|
20950
|
+
type: "ownerInvite" | "ownerStatementPublished" | "invitePropertyManager" | "owner-invite" | "ownerStatement-published";
|
|
19880
20951
|
};
|
|
20952
|
+
header?: never;
|
|
20953
|
+
path?: never;
|
|
19881
20954
|
cookie?: never;
|
|
19882
20955
|
};
|
|
19883
20956
|
requestBody?: never;
|
|
@@ -19889,8 +20962,34 @@ export interface operations {
|
|
|
19889
20962
|
};
|
|
19890
20963
|
content: {
|
|
19891
20964
|
"application/json": {
|
|
19892
|
-
|
|
19893
|
-
|
|
20965
|
+
data: {
|
|
20966
|
+
/** Format: uuid */
|
|
20967
|
+
id: string;
|
|
20968
|
+
/** @enum {string} */
|
|
20969
|
+
type: "ownerInvite" | "ownerStatementPublished" | "invitePropertyManager";
|
|
20970
|
+
data: {
|
|
20971
|
+
subject: string;
|
|
20972
|
+
shortDescription: string;
|
|
20973
|
+
banner?: string | null;
|
|
20974
|
+
header: string;
|
|
20975
|
+
bodyOne: string;
|
|
20976
|
+
bodyTwo: string;
|
|
20977
|
+
buttonText: string;
|
|
20978
|
+
href?: string | null;
|
|
20979
|
+
};
|
|
20980
|
+
/**
|
|
20981
|
+
* Format: date-time
|
|
20982
|
+
* @description Timestamp string with date, time, milliseconds, and timezone.
|
|
20983
|
+
* @example 2024-01-15T12:30:00.000+00:00
|
|
20984
|
+
*/
|
|
20985
|
+
createdAt: string;
|
|
20986
|
+
/**
|
|
20987
|
+
* Format: date-time
|
|
20988
|
+
* @description Timestamp string with date, time, milliseconds, and timezone.
|
|
20989
|
+
* @example 2024-01-15T12:30:00.000+00:00
|
|
20990
|
+
*/
|
|
20991
|
+
updatedAt: string;
|
|
20992
|
+
} | null;
|
|
19894
20993
|
};
|
|
19895
20994
|
};
|
|
19896
20995
|
};
|
|
@@ -20028,195 +21127,33 @@ export interface operations {
|
|
|
20028
21127
|
};
|
|
20029
21128
|
};
|
|
20030
21129
|
};
|
|
20031
|
-
|
|
21130
|
+
upsertEmailTemplate: {
|
|
20032
21131
|
parameters: {
|
|
20033
21132
|
query?: never;
|
|
20034
21133
|
header?: never;
|
|
20035
21134
|
path: {
|
|
20036
|
-
|
|
20037
|
-
|
|
21135
|
+
/** @description Email template type to save. */
|
|
21136
|
+
type: "ownerInvite" | "ownerStatementPublished" | "invitePropertyManager";
|
|
20038
21137
|
};
|
|
20039
21138
|
cookie?: never;
|
|
20040
21139
|
};
|
|
20041
21140
|
requestBody?: {
|
|
20042
21141
|
content: {
|
|
20043
21142
|
"application/json": {
|
|
20044
|
-
/** @
|
|
20045
|
-
|
|
20046
|
-
|
|
20047
|
-
|
|
20048
|
-
|
|
20049
|
-
|
|
20050
|
-
|
|
20051
|
-
|
|
20052
|
-
|
|
20053
|
-
|
|
20054
|
-
};
|
|
20055
|
-
content: {
|
|
20056
|
-
"application/json": {
|
|
20057
|
-
url: string;
|
|
20058
|
-
viewer: {
|
|
20059
|
-
/** Format: uuid */
|
|
20060
|
-
userId: string;
|
|
20061
|
-
email: string;
|
|
20062
|
-
firstName: string | null;
|
|
20063
|
-
lastName: string | null;
|
|
20064
|
-
/** @enum {string} */
|
|
20065
|
-
status: "active" | "inactive" | "unconfirmed";
|
|
20066
|
-
lastInvitedAt: string | null;
|
|
20067
|
-
lastSeen: string | null;
|
|
20068
|
-
notifications: {
|
|
20069
|
-
ownerStatementPublished: boolean;
|
|
20070
|
-
};
|
|
20071
|
-
};
|
|
20072
|
-
};
|
|
20073
|
-
};
|
|
20074
|
-
};
|
|
20075
|
-
/** @description Bad request */
|
|
20076
|
-
400: {
|
|
20077
|
-
headers: {
|
|
20078
|
-
[name: string]: unknown;
|
|
20079
|
-
};
|
|
20080
|
-
content: {
|
|
20081
|
-
"application/json": {
|
|
20082
|
-
code: string;
|
|
20083
|
-
message: string;
|
|
20084
|
-
links?: {
|
|
20085
|
-
docs: string;
|
|
20086
|
-
schema: string;
|
|
20087
|
-
};
|
|
20088
|
-
issues?: {
|
|
20089
|
-
message: string;
|
|
20090
|
-
path?: (string | number)[];
|
|
20091
|
-
schema?: string;
|
|
20092
|
-
}[];
|
|
20093
|
-
context?: unknown;
|
|
20094
|
-
};
|
|
20095
|
-
};
|
|
20096
|
-
};
|
|
20097
|
-
/** @description Unauthorized */
|
|
20098
|
-
401: {
|
|
20099
|
-
headers: {
|
|
20100
|
-
[name: string]: unknown;
|
|
20101
|
-
};
|
|
20102
|
-
content: {
|
|
20103
|
-
"application/json": {
|
|
20104
|
-
code: string;
|
|
20105
|
-
message: string;
|
|
20106
|
-
links?: {
|
|
20107
|
-
docs: string;
|
|
20108
|
-
schema: string;
|
|
20109
|
-
};
|
|
20110
|
-
issues?: {
|
|
20111
|
-
message: string;
|
|
20112
|
-
path?: (string | number)[];
|
|
20113
|
-
schema?: string;
|
|
20114
|
-
}[];
|
|
20115
|
-
context?: unknown;
|
|
20116
|
-
};
|
|
20117
|
-
};
|
|
20118
|
-
};
|
|
20119
|
-
/** @description Forbidden */
|
|
20120
|
-
403: {
|
|
20121
|
-
headers: {
|
|
20122
|
-
[name: string]: unknown;
|
|
20123
|
-
};
|
|
20124
|
-
content: {
|
|
20125
|
-
"application/json": {
|
|
20126
|
-
code: string;
|
|
20127
|
-
message: string;
|
|
20128
|
-
links?: {
|
|
20129
|
-
docs: string;
|
|
20130
|
-
schema: string;
|
|
20131
|
-
};
|
|
20132
|
-
issues?: {
|
|
20133
|
-
message: string;
|
|
20134
|
-
path?: (string | number)[];
|
|
20135
|
-
schema?: string;
|
|
20136
|
-
}[];
|
|
20137
|
-
context?: unknown;
|
|
20138
|
-
};
|
|
20139
|
-
};
|
|
20140
|
-
};
|
|
20141
|
-
/** @description Not found */
|
|
20142
|
-
404: {
|
|
20143
|
-
headers: {
|
|
20144
|
-
[name: string]: unknown;
|
|
20145
|
-
};
|
|
20146
|
-
content: {
|
|
20147
|
-
"application/json": {
|
|
20148
|
-
code: string;
|
|
20149
|
-
message: string;
|
|
20150
|
-
links?: {
|
|
20151
|
-
docs: string;
|
|
20152
|
-
schema: string;
|
|
20153
|
-
};
|
|
20154
|
-
issues?: {
|
|
20155
|
-
message: string;
|
|
20156
|
-
path?: (string | number)[];
|
|
20157
|
-
schema?: string;
|
|
20158
|
-
}[];
|
|
20159
|
-
context?: unknown;
|
|
20160
|
-
};
|
|
20161
|
-
};
|
|
20162
|
-
};
|
|
20163
|
-
/** @description Internal server error */
|
|
20164
|
-
500: {
|
|
20165
|
-
headers: {
|
|
20166
|
-
[name: string]: unknown;
|
|
20167
|
-
};
|
|
20168
|
-
content: {
|
|
20169
|
-
"application/json": {
|
|
20170
|
-
code: string;
|
|
20171
|
-
message: string;
|
|
20172
|
-
links?: {
|
|
20173
|
-
docs: string;
|
|
20174
|
-
schema: string;
|
|
20175
|
-
};
|
|
20176
|
-
issues?: {
|
|
20177
|
-
message: string;
|
|
20178
|
-
path?: (string | number)[];
|
|
20179
|
-
schema?: string;
|
|
20180
|
-
}[];
|
|
20181
|
-
context?: unknown;
|
|
20182
|
-
};
|
|
20183
|
-
};
|
|
20184
|
-
};
|
|
20185
|
-
/** @description Service unavailable */
|
|
20186
|
-
503: {
|
|
20187
|
-
headers: {
|
|
20188
|
-
[name: string]: unknown;
|
|
20189
|
-
};
|
|
20190
|
-
content: {
|
|
20191
|
-
"application/json": {
|
|
20192
|
-
code: string;
|
|
20193
|
-
message: string;
|
|
20194
|
-
links?: {
|
|
20195
|
-
docs: string;
|
|
20196
|
-
schema: string;
|
|
20197
|
-
};
|
|
20198
|
-
issues?: {
|
|
20199
|
-
message: string;
|
|
20200
|
-
path?: (string | number)[];
|
|
20201
|
-
schema?: string;
|
|
20202
|
-
}[];
|
|
20203
|
-
context?: unknown;
|
|
21143
|
+
/** @description Email template content to save. */
|
|
21144
|
+
data: {
|
|
21145
|
+
subject: string;
|
|
21146
|
+
shortDescription: string;
|
|
21147
|
+
banner?: string | null;
|
|
21148
|
+
header: string;
|
|
21149
|
+
bodyOne: string;
|
|
21150
|
+
bodyTwo: string;
|
|
21151
|
+
buttonText: string;
|
|
21152
|
+
href?: string | null;
|
|
20204
21153
|
};
|
|
20205
21154
|
};
|
|
20206
21155
|
};
|
|
20207
21156
|
};
|
|
20208
|
-
};
|
|
20209
|
-
getEmailTemplate: {
|
|
20210
|
-
parameters: {
|
|
20211
|
-
query: {
|
|
20212
|
-
/** @description Email template type to fetch. */
|
|
20213
|
-
type: "ownerInvite" | "ownerStatementPublished" | "owner-invite" | "ownerStatement-published";
|
|
20214
|
-
};
|
|
20215
|
-
header?: never;
|
|
20216
|
-
path?: never;
|
|
20217
|
-
cookie?: never;
|
|
20218
|
-
};
|
|
20219
|
-
requestBody?: never;
|
|
20220
21157
|
responses: {
|
|
20221
21158
|
/** @description Successful response */
|
|
20222
21159
|
200: {
|
|
@@ -20225,24 +21162,32 @@ export interface operations {
|
|
|
20225
21162
|
};
|
|
20226
21163
|
content: {
|
|
20227
21164
|
"application/json": {
|
|
21165
|
+
/** Format: uuid */
|
|
21166
|
+
id: string;
|
|
21167
|
+
/** @enum {string} */
|
|
21168
|
+
type: "ownerInvite" | "ownerStatementPublished" | "invitePropertyManager";
|
|
20228
21169
|
data: {
|
|
20229
|
-
|
|
20230
|
-
|
|
20231
|
-
|
|
20232
|
-
|
|
20233
|
-
|
|
20234
|
-
|
|
20235
|
-
|
|
20236
|
-
|
|
20237
|
-
|
|
20238
|
-
|
|
20239
|
-
|
|
20240
|
-
|
|
20241
|
-
|
|
20242
|
-
|
|
20243
|
-
|
|
20244
|
-
|
|
20245
|
-
|
|
21170
|
+
subject: string;
|
|
21171
|
+
shortDescription: string;
|
|
21172
|
+
banner?: string | null;
|
|
21173
|
+
header: string;
|
|
21174
|
+
bodyOne: string;
|
|
21175
|
+
bodyTwo: string;
|
|
21176
|
+
buttonText: string;
|
|
21177
|
+
href?: string | null;
|
|
21178
|
+
};
|
|
21179
|
+
/**
|
|
21180
|
+
* Format: date-time
|
|
21181
|
+
* @description Timestamp string with date, time, milliseconds, and timezone.
|
|
21182
|
+
* @example 2024-01-15T12:30:00.000+00:00
|
|
21183
|
+
*/
|
|
21184
|
+
createdAt: string;
|
|
21185
|
+
/**
|
|
21186
|
+
* Format: date-time
|
|
21187
|
+
* @description Timestamp string with date, time, milliseconds, and timezone.
|
|
21188
|
+
* @example 2024-01-15T12:30:00.000+00:00
|
|
21189
|
+
*/
|
|
21190
|
+
updatedAt: string;
|
|
20246
21191
|
};
|
|
20247
21192
|
};
|
|
20248
21193
|
};
|
|
@@ -37784,6 +38729,7 @@ export interface operations {
|
|
|
37784
38729
|
reservationId: string | null;
|
|
37785
38730
|
hasPms: boolean;
|
|
37786
38731
|
activePmsConnectionId: string | null;
|
|
38732
|
+
hasOwnerBlockingConnection: boolean;
|
|
37787
38733
|
hasDeposit: boolean;
|
|
37788
38734
|
depositTransactionId: string | null;
|
|
37789
38735
|
hasListingNeedsReview: boolean;
|
|
@@ -77318,6 +78264,7 @@ export interface operations {
|
|
|
77318
78264
|
isOnboarding?: boolean | null;
|
|
77319
78265
|
isOpex?: boolean;
|
|
77320
78266
|
booksClosedAt?: string | null;
|
|
78267
|
+
/** @description Logo URL or data URI. Send null to clear it. */
|
|
77321
78268
|
logo?: string | null;
|
|
77322
78269
|
statementStartAt?: string | null;
|
|
77323
78270
|
effectiveStatementStartAt?: string | null;
|
|
@@ -77327,6 +78274,8 @@ export interface operations {
|
|
|
77327
78274
|
/** Format: email */
|
|
77328
78275
|
email?: string;
|
|
77329
78276
|
supportEmail?: string | null;
|
|
78277
|
+
/** @description Primary brand color. Send null to clear it. */
|
|
78278
|
+
colorPrimary?: string | null;
|
|
77330
78279
|
migratedFromTenantId?: string | null;
|
|
77331
78280
|
settings?: {
|
|
77332
78281
|
showVRPilotGuide?: boolean;
|