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