@vrplatform/api 1.3.1-stage.4728 → 1.3.1-stage.4738
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 +1137 -1455
- package/build/main/generated/v1.js.map +1 -1
- package/build/module/generated/v1.d.ts +1137 -1455
- package/build/module/generated/v1.js.map +1 -1
- package/package.json +1 -1
- package/src/generated/v1.ts +1137 -1455
package/src/generated/v1.ts
CHANGED
|
@@ -202,7 +202,7 @@ export interface paths {
|
|
|
202
202
|
/** @description List API token metadata for the current team without revealing token secrets. Requires an authenticated team admin. */
|
|
203
203
|
get: operations["getApiTokens"];
|
|
204
204
|
put?: never;
|
|
205
|
-
/** @description
|
|
205
|
+
/** @description Generate an API token for the current team and return its secret. Partner teams may provide capability bundles to restrict the token; omission grants unrestricted partner API access. An optional IP allowlist is enforced on every API-key request. Requires an authenticated team admin. The token secret is never written to audit records. */
|
|
206
206
|
post: operations["postApiTokens"];
|
|
207
207
|
delete?: never;
|
|
208
208
|
options?: never;
|
|
@@ -1793,57 +1793,6 @@ export interface paths {
|
|
|
1793
1793
|
patch?: never;
|
|
1794
1794
|
trace?: never;
|
|
1795
1795
|
};
|
|
1796
|
-
"/internal/partner-api-keys": {
|
|
1797
|
-
parameters: {
|
|
1798
|
-
query?: never;
|
|
1799
|
-
header?: never;
|
|
1800
|
-
path?: never;
|
|
1801
|
-
cookie?: never;
|
|
1802
|
-
};
|
|
1803
|
-
get?: never;
|
|
1804
|
-
put?: never;
|
|
1805
|
-
/** @description Create a scoped partner API key. The returned secret is shown only once. VRP-admin only. */
|
|
1806
|
-
post: operations["createPartnerApiKey"];
|
|
1807
|
-
delete?: never;
|
|
1808
|
-
options?: never;
|
|
1809
|
-
head?: never;
|
|
1810
|
-
patch?: never;
|
|
1811
|
-
trace?: never;
|
|
1812
|
-
};
|
|
1813
|
-
"/internal/partner-api-keys/{id}": {
|
|
1814
|
-
parameters: {
|
|
1815
|
-
query?: never;
|
|
1816
|
-
header?: never;
|
|
1817
|
-
path?: never;
|
|
1818
|
-
cookie?: never;
|
|
1819
|
-
};
|
|
1820
|
-
get?: never;
|
|
1821
|
-
put?: never;
|
|
1822
|
-
post?: never;
|
|
1823
|
-
/** @description Revoke a partner API key immediately. VRP-admin only. */
|
|
1824
|
-
delete: operations["revokePartnerApiKey"];
|
|
1825
|
-
options?: never;
|
|
1826
|
-
head?: never;
|
|
1827
|
-
patch?: never;
|
|
1828
|
-
trace?: never;
|
|
1829
|
-
};
|
|
1830
|
-
"/internal/partner-api-keys/{id}/rotate": {
|
|
1831
|
-
parameters: {
|
|
1832
|
-
query?: never;
|
|
1833
|
-
header?: never;
|
|
1834
|
-
path?: never;
|
|
1835
|
-
cookie?: never;
|
|
1836
|
-
};
|
|
1837
|
-
get?: never;
|
|
1838
|
-
put?: never;
|
|
1839
|
-
/** @description Replace a partner API key secret while preserving its grants. The new secret is shown only once. VRP-admin only. */
|
|
1840
|
-
post: operations["rotatePartnerApiKey"];
|
|
1841
|
-
delete?: never;
|
|
1842
|
-
options?: never;
|
|
1843
|
-
head?: never;
|
|
1844
|
-
patch?: never;
|
|
1845
|
-
trace?: never;
|
|
1846
|
-
};
|
|
1847
1796
|
"/internal/users": {
|
|
1848
1797
|
parameters: {
|
|
1849
1798
|
query?: never;
|
|
@@ -2636,7 +2585,7 @@ export interface paths {
|
|
|
2636
2585
|
cookie?: never;
|
|
2637
2586
|
};
|
|
2638
2587
|
/**
|
|
2639
|
-
* @description List property-manager teams billed by the authenticated partner for one month in a regional partition. Completed months use the latest retained listings_reported event
|
|
2588
|
+
* @description List property-manager teams billed by the authenticated partner for one month in a regional partition. Completed months use the latest retained listings_reported event explicitly attributed to the partner through the legacy date-only month-end cutoff. A currently billed team without an attributed event uses its live count only when it has another listing report in that historical window. Current months use live active-listing counts. Live non-GL counts use calculated listing status, while GL counts use ownership-period deactivation. Filters run before deterministic sorting, totals, and pagination. Select the partition with x-data-region.
|
|
2640
2589
|
*
|
|
2641
2590
|
* Required scope: teams:read
|
|
2642
2591
|
*/
|
|
@@ -2712,6 +2661,27 @@ export interface paths {
|
|
|
2712
2661
|
patch?: never;
|
|
2713
2662
|
trace?: never;
|
|
2714
2663
|
};
|
|
2664
|
+
"/partner/listings": {
|
|
2665
|
+
parameters: {
|
|
2666
|
+
query?: never;
|
|
2667
|
+
header?: never;
|
|
2668
|
+
path?: never;
|
|
2669
|
+
cookie?: never;
|
|
2670
|
+
};
|
|
2671
|
+
/**
|
|
2672
|
+
* @description List active property-manager listings for the authorized partner portfolio in one regional partition. Team, company, lifecycle, accounting-partner, effective billing-partner, subscription, billing-plan, product, and feature filters run before totals and pagination. Rows are ordered deterministically by team name and calculated listing name and include structured and full addresses. Select the partition with x-data-region.
|
|
2673
|
+
*
|
|
2674
|
+
* Required scope: teams:read
|
|
2675
|
+
*/
|
|
2676
|
+
get: operations["getPartnerListings"];
|
|
2677
|
+
put?: never;
|
|
2678
|
+
post?: never;
|
|
2679
|
+
delete?: never;
|
|
2680
|
+
options?: never;
|
|
2681
|
+
head?: never;
|
|
2682
|
+
patch?: never;
|
|
2683
|
+
trace?: never;
|
|
2684
|
+
};
|
|
2715
2685
|
"/partner/members": {
|
|
2716
2686
|
parameters: {
|
|
2717
2687
|
query?: never;
|
|
@@ -8285,6 +8255,8 @@ export interface operations {
|
|
|
8285
8255
|
content: {
|
|
8286
8256
|
"application/json": {
|
|
8287
8257
|
data: {
|
|
8258
|
+
allowedIpCidrs: string[];
|
|
8259
|
+
bundles: ("embed:exports:v1" | "embed:reports:v1" | "embed:statements:v1" | "partner:accounting-data:v1" | "partner:banking:v1" | "partner:onboarding:v1" | "partner:provisioning:v1" | "partner:reports:v1" | "partner:statements:v1" | "partner:webhooks:v1")[];
|
|
8288
8260
|
/** Format: uuid */
|
|
8289
8261
|
id: string;
|
|
8290
8262
|
/**
|
|
@@ -8296,6 +8268,7 @@ export interface operations {
|
|
|
8296
8268
|
hint: string | null;
|
|
8297
8269
|
role: string | null;
|
|
8298
8270
|
scope: string | null;
|
|
8271
|
+
scopes: ("self:read" | "partner:read" | "teams:read" | "teams:provision" | "teams:write" | "teams:delete" | "teams:initialize" | "embedded-sessions:issue" | "team-members:read" | "team-members:manage" | "partner-users:read" | "partner-users:manage" | "partner-memberships:manage" | "team-settings:read" | "team-settings:write" | "team-onboarding:read" | "team-onboarding:write" | "team-issues:read" | "books:close" | "listings:read" | "listings:write" | "listings:delete" | "listings:export" | "contacts:read" | "contacts:write" | "contacts:delete" | "contacts:export" | "ownerships:read" | "ownerships:write" | "ownerships:delete" | "reservations:read" | "reservations:write" | "reservations:delete" | "reservations:export" | "reservations:post-journals" | "transactions:read" | "transactions:write" | "transactions:delete" | "transactions:export" | "transactions:post-journals" | "transactions:pay" | "accounts:read" | "accounts:write" | "accounts:delete" | "accounts:export" | "accounts:recalculate" | "tax-rates:read" | "tax-rates:write" | "tax-rates:delete" | "reservation-mappings:read" | "reservation-mappings:write" | "transaction-mappings:read" | "transaction-mappings:write" | "statements:read" | "statements:write" | "statements:delete" | "statements:publish" | "statements:pay" | "statements:export" | "statement-layouts:read" | "reports:read" | "reports:export" | "metrics:read" | "bank-accounts:read" | "bank-accounts:write" | "bank-connections:manage" | "bank-records:read" | "bank-records:write" | "bank-records:delete" | "bank-records:export" | "bank-rules:read" | "bank-rules:write" | "bank-rules:delete" | "bank-rules:execute" | "webhooks:read" | "webhooks:manage" | "webhooks:replay")[];
|
|
8299
8272
|
}[];
|
|
8300
8273
|
pagination: {
|
|
8301
8274
|
/** @default 100 */
|
|
@@ -8453,8 +8426,10 @@ export interface operations {
|
|
|
8453
8426
|
requestBody?: {
|
|
8454
8427
|
content: {
|
|
8455
8428
|
"application/json": {
|
|
8456
|
-
/** @description
|
|
8457
|
-
|
|
8429
|
+
/** @description Optional IPv4 or IPv6 addresses and CIDRs allowed to use this token. Individual addresses are normalized to /32 or /128. Omit or send an empty array for no IP restriction. */
|
|
8430
|
+
allowedIpCidrs?: string[];
|
|
8431
|
+
/** @description Optional capability restrictions for a partner-owned API token. Omit for unrestricted partner API access. Rejected for ordinary teams. */
|
|
8432
|
+
bundles?: ("embed:exports:v1" | "embed:reports:v1" | "embed:statements:v1" | "partner:accounting-data:v1" | "partner:banking:v1" | "partner:onboarding:v1" | "partner:provisioning:v1" | "partner:reports:v1" | "partner:statements:v1" | "partner:webhooks:v1")[];
|
|
8458
8433
|
};
|
|
8459
8434
|
};
|
|
8460
8435
|
};
|
|
@@ -8466,6 +8441,8 @@ export interface operations {
|
|
|
8466
8441
|
};
|
|
8467
8442
|
content: {
|
|
8468
8443
|
"application/json": {
|
|
8444
|
+
allowedIpCidrs: string[];
|
|
8445
|
+
bundles: ("embed:exports:v1" | "embed:reports:v1" | "embed:statements:v1" | "partner:accounting-data:v1" | "partner:banking:v1" | "partner:onboarding:v1" | "partner:provisioning:v1" | "partner:reports:v1" | "partner:statements:v1" | "partner:webhooks:v1")[];
|
|
8469
8446
|
/** Format: uuid */
|
|
8470
8447
|
id: string;
|
|
8471
8448
|
/**
|
|
@@ -8477,6 +8454,8 @@ export interface operations {
|
|
|
8477
8454
|
hint: string | null;
|
|
8478
8455
|
role: string | null;
|
|
8479
8456
|
scope: string | null;
|
|
8457
|
+
scopes: ("self:read" | "partner:read" | "teams:read" | "teams:provision" | "teams:write" | "teams:delete" | "teams:initialize" | "embedded-sessions:issue" | "team-members:read" | "team-members:manage" | "partner-users:read" | "partner-users:manage" | "partner-memberships:manage" | "team-settings:read" | "team-settings:write" | "team-onboarding:read" | "team-onboarding:write" | "team-issues:read" | "books:close" | "listings:read" | "listings:write" | "listings:delete" | "listings:export" | "contacts:read" | "contacts:write" | "contacts:delete" | "contacts:export" | "ownerships:read" | "ownerships:write" | "ownerships:delete" | "reservations:read" | "reservations:write" | "reservations:delete" | "reservations:export" | "reservations:post-journals" | "transactions:read" | "transactions:write" | "transactions:delete" | "transactions:export" | "transactions:post-journals" | "transactions:pay" | "accounts:read" | "accounts:write" | "accounts:delete" | "accounts:export" | "accounts:recalculate" | "tax-rates:read" | "tax-rates:write" | "tax-rates:delete" | "reservation-mappings:read" | "reservation-mappings:write" | "transaction-mappings:read" | "transaction-mappings:write" | "statements:read" | "statements:write" | "statements:delete" | "statements:publish" | "statements:pay" | "statements:export" | "statement-layouts:read" | "reports:read" | "reports:export" | "metrics:read" | "bank-accounts:read" | "bank-accounts:write" | "bank-connections:manage" | "bank-records:read" | "bank-records:write" | "bank-records:delete" | "bank-records:export" | "bank-rules:read" | "bank-rules:write" | "bank-rules:delete" | "bank-rules:execute" | "webhooks:read" | "webhooks:manage" | "webhooks:replay")[];
|
|
8458
|
+
apiToken: string;
|
|
8480
8459
|
};
|
|
8481
8460
|
};
|
|
8482
8461
|
};
|
|
@@ -8632,6 +8611,8 @@ export interface operations {
|
|
|
8632
8611
|
};
|
|
8633
8612
|
content: {
|
|
8634
8613
|
"application/json": {
|
|
8614
|
+
allowedIpCidrs: string[];
|
|
8615
|
+
bundles: ("embed:exports:v1" | "embed:reports:v1" | "embed:statements:v1" | "partner:accounting-data:v1" | "partner:banking:v1" | "partner:onboarding:v1" | "partner:provisioning:v1" | "partner:reports:v1" | "partner:statements:v1" | "partner:webhooks:v1")[];
|
|
8635
8616
|
/** Format: uuid */
|
|
8636
8617
|
id: string;
|
|
8637
8618
|
/**
|
|
@@ -8643,6 +8624,7 @@ export interface operations {
|
|
|
8643
8624
|
hint: string | null;
|
|
8644
8625
|
role: string | null;
|
|
8645
8626
|
scope: string | null;
|
|
8627
|
+
scopes: ("self:read" | "partner:read" | "teams:read" | "teams:provision" | "teams:write" | "teams:delete" | "teams:initialize" | "embedded-sessions:issue" | "team-members:read" | "team-members:manage" | "partner-users:read" | "partner-users:manage" | "partner-memberships:manage" | "team-settings:read" | "team-settings:write" | "team-onboarding:read" | "team-onboarding:write" | "team-issues:read" | "books:close" | "listings:read" | "listings:write" | "listings:delete" | "listings:export" | "contacts:read" | "contacts:write" | "contacts:delete" | "contacts:export" | "ownerships:read" | "ownerships:write" | "ownerships:delete" | "reservations:read" | "reservations:write" | "reservations:delete" | "reservations:export" | "reservations:post-journals" | "transactions:read" | "transactions:write" | "transactions:delete" | "transactions:export" | "transactions:post-journals" | "transactions:pay" | "accounts:read" | "accounts:write" | "accounts:delete" | "accounts:export" | "accounts:recalculate" | "tax-rates:read" | "tax-rates:write" | "tax-rates:delete" | "reservation-mappings:read" | "reservation-mappings:write" | "transaction-mappings:read" | "transaction-mappings:write" | "statements:read" | "statements:write" | "statements:delete" | "statements:publish" | "statements:pay" | "statements:export" | "statement-layouts:read" | "reports:read" | "reports:export" | "metrics:read" | "bank-accounts:read" | "bank-accounts:write" | "bank-connections:manage" | "bank-records:read" | "bank-records:write" | "bank-records:delete" | "bank-records:export" | "bank-rules:read" | "bank-rules:write" | "bank-rules:delete" | "bank-rules:execute" | "webhooks:read" | "webhooks:manage" | "webhooks:replay")[];
|
|
8646
8628
|
apiToken: string;
|
|
8647
8629
|
};
|
|
8648
8630
|
};
|
|
@@ -32303,24 +32285,23 @@ export interface operations {
|
|
|
32303
32285
|
};
|
|
32304
32286
|
};
|
|
32305
32287
|
};
|
|
32306
|
-
|
|
32288
|
+
getInternalUsers: {
|
|
32307
32289
|
parameters: {
|
|
32308
|
-
query?:
|
|
32309
|
-
|
|
32290
|
+
query?: {
|
|
32291
|
+
/** @description Filter by email, secondary email, first name, last name, or full name */
|
|
32292
|
+
search?: string;
|
|
32293
|
+
limit?: number;
|
|
32294
|
+
page?: number;
|
|
32295
|
+
offset?: number;
|
|
32296
|
+
};
|
|
32297
|
+
header?: {
|
|
32298
|
+
/** @description Selects the regional data partition for this regional collection read. It does not change the authenticated team context. */
|
|
32299
|
+
"x-data-region"?: "ap" | "crunchy" | "eu" | "hostaway" | "us";
|
|
32300
|
+
};
|
|
32310
32301
|
path?: never;
|
|
32311
32302
|
cookie?: never;
|
|
32312
32303
|
};
|
|
32313
|
-
requestBody?:
|
|
32314
|
-
content: {
|
|
32315
|
-
"application/json": {
|
|
32316
|
-
/** @enum {string} */
|
|
32317
|
-
audience: "hostaway-production" | "hostaway-staging" | "vrplatform-production" | "vrplatform-staging";
|
|
32318
|
-
bundles: ("embed:exports:v1" | "embed:reports:v1" | "embed:statements:v1" | "partner:accounting-data:v1" | "partner:banking:v1" | "partner:onboarding:v1" | "partner:provisioning:v1" | "partner:reports:v1" | "partner:statements:v1" | "partner:webhooks:v1")[];
|
|
32319
|
-
/** Format: uuid */
|
|
32320
|
-
partnerId: string;
|
|
32321
|
-
};
|
|
32322
|
-
};
|
|
32323
|
-
};
|
|
32304
|
+
requestBody?: never;
|
|
32324
32305
|
responses: {
|
|
32325
32306
|
/** @description Successful response */
|
|
32326
32307
|
200: {
|
|
@@ -32329,14 +32310,45 @@ export interface operations {
|
|
|
32329
32310
|
};
|
|
32330
32311
|
content: {
|
|
32331
32312
|
"application/json": {
|
|
32332
|
-
|
|
32333
|
-
|
|
32334
|
-
|
|
32335
|
-
|
|
32336
|
-
|
|
32337
|
-
|
|
32338
|
-
|
|
32339
|
-
|
|
32313
|
+
data: {
|
|
32314
|
+
/** Format: uuid */
|
|
32315
|
+
id: string;
|
|
32316
|
+
firstName: string | null;
|
|
32317
|
+
lastName: string | null;
|
|
32318
|
+
/** Format: email */
|
|
32319
|
+
email: string;
|
|
32320
|
+
secondaryEmails: string[];
|
|
32321
|
+
/** @description User kind (e.g. user, owner) */
|
|
32322
|
+
type?: string | null;
|
|
32323
|
+
lastSeen: string | null;
|
|
32324
|
+
createdAt: string | null;
|
|
32325
|
+
memberships: {
|
|
32326
|
+
/** Format: uuid */
|
|
32327
|
+
teamId: string;
|
|
32328
|
+
teamName: string;
|
|
32329
|
+
role?: string | null;
|
|
32330
|
+
status?: string | null;
|
|
32331
|
+
lastInvitedAt: string | null;
|
|
32332
|
+
}[];
|
|
32333
|
+
ownerAccesses: {
|
|
32334
|
+
/** Format: uuid */
|
|
32335
|
+
teamId: string;
|
|
32336
|
+
contactId: string | null;
|
|
32337
|
+
ownerId: string | null;
|
|
32338
|
+
role?: string | null;
|
|
32339
|
+
/** @description Owner contact name */
|
|
32340
|
+
name?: string | null;
|
|
32341
|
+
}[];
|
|
32342
|
+
}[];
|
|
32343
|
+
pagination: {
|
|
32344
|
+
/** @default 100 */
|
|
32345
|
+
limit: number;
|
|
32346
|
+
/** @default 1 */
|
|
32347
|
+
page: number;
|
|
32348
|
+
total: number;
|
|
32349
|
+
totalPage: number;
|
|
32350
|
+
nextPage?: number;
|
|
32351
|
+
};
|
|
32340
32352
|
};
|
|
32341
32353
|
};
|
|
32342
32354
|
};
|
|
@@ -32474,18 +32486,38 @@ export interface operations {
|
|
|
32474
32486
|
};
|
|
32475
32487
|
};
|
|
32476
32488
|
};
|
|
32477
|
-
|
|
32489
|
+
postInternalUsers: {
|
|
32478
32490
|
parameters: {
|
|
32479
32491
|
query?: never;
|
|
32480
32492
|
header?: never;
|
|
32481
|
-
path
|
|
32482
|
-
id: string;
|
|
32483
|
-
};
|
|
32493
|
+
path?: never;
|
|
32484
32494
|
cookie?: never;
|
|
32485
32495
|
};
|
|
32486
32496
|
requestBody?: {
|
|
32487
32497
|
content: {
|
|
32488
|
-
"application/json":
|
|
32498
|
+
"application/json": {
|
|
32499
|
+
/** Format: uuid */
|
|
32500
|
+
id?: string;
|
|
32501
|
+
email: string;
|
|
32502
|
+
firstName?: string | null;
|
|
32503
|
+
lastName?: string | null;
|
|
32504
|
+
name?: string | null;
|
|
32505
|
+
/** @enum {string} */
|
|
32506
|
+
status?: "active" | "inactive" | "archived" | "unconfirmed";
|
|
32507
|
+
partnerId?: string | null;
|
|
32508
|
+
secondaryEmails?: string[];
|
|
32509
|
+
membership?: {
|
|
32510
|
+
/** Format: uuid */
|
|
32511
|
+
tenantId: string;
|
|
32512
|
+
/**
|
|
32513
|
+
* @default user
|
|
32514
|
+
* @enum {string}
|
|
32515
|
+
*/
|
|
32516
|
+
role?: "admin" | "user" | "owner";
|
|
32517
|
+
/** @enum {string} */
|
|
32518
|
+
status?: "active" | "inactive" | "unconfirmed";
|
|
32519
|
+
};
|
|
32520
|
+
};
|
|
32489
32521
|
};
|
|
32490
32522
|
};
|
|
32491
32523
|
responses: {
|
|
@@ -32498,8 +32530,15 @@ export interface operations {
|
|
|
32498
32530
|
"application/json": {
|
|
32499
32531
|
/** Format: uuid */
|
|
32500
32532
|
id: string;
|
|
32501
|
-
|
|
32502
|
-
|
|
32533
|
+
isAdmin: boolean;
|
|
32534
|
+
memberships: {
|
|
32535
|
+
/** Format: uuid */
|
|
32536
|
+
id: string;
|
|
32537
|
+
/** Format: uuid */
|
|
32538
|
+
tenantId: string;
|
|
32539
|
+
role: string | null;
|
|
32540
|
+
status: string | null;
|
|
32541
|
+
}[];
|
|
32503
32542
|
};
|
|
32504
32543
|
};
|
|
32505
32544
|
};
|
|
@@ -32637,7 +32676,7 @@ export interface operations {
|
|
|
32637
32676
|
};
|
|
32638
32677
|
};
|
|
32639
32678
|
};
|
|
32640
|
-
|
|
32679
|
+
putInternalUsersById: {
|
|
32641
32680
|
parameters: {
|
|
32642
32681
|
query?: never;
|
|
32643
32682
|
header?: never;
|
|
@@ -32648,7 +32687,27 @@ export interface operations {
|
|
|
32648
32687
|
};
|
|
32649
32688
|
requestBody?: {
|
|
32650
32689
|
content: {
|
|
32651
|
-
"application/json":
|
|
32690
|
+
"application/json": {
|
|
32691
|
+
email: string;
|
|
32692
|
+
firstName?: string | null;
|
|
32693
|
+
lastName?: string | null;
|
|
32694
|
+
name?: string | null;
|
|
32695
|
+
/** @enum {string} */
|
|
32696
|
+
status?: "active" | "inactive" | "archived" | "unconfirmed";
|
|
32697
|
+
partnerId?: string | null;
|
|
32698
|
+
secondaryEmails?: string[];
|
|
32699
|
+
membership?: {
|
|
32700
|
+
/** Format: uuid */
|
|
32701
|
+
tenantId: string;
|
|
32702
|
+
/**
|
|
32703
|
+
* @default user
|
|
32704
|
+
* @enum {string}
|
|
32705
|
+
*/
|
|
32706
|
+
role?: "admin" | "user" | "owner";
|
|
32707
|
+
/** @enum {string} */
|
|
32708
|
+
status?: "active" | "inactive" | "unconfirmed";
|
|
32709
|
+
};
|
|
32710
|
+
};
|
|
32652
32711
|
};
|
|
32653
32712
|
};
|
|
32654
32713
|
responses: {
|
|
@@ -32659,14 +32718,17 @@ export interface operations {
|
|
|
32659
32718
|
};
|
|
32660
32719
|
content: {
|
|
32661
32720
|
"application/json": {
|
|
32662
|
-
/** @enum {string} */
|
|
32663
|
-
audience: "hostaway-production" | "hostaway-staging" | "vrplatform-production" | "vrplatform-staging";
|
|
32664
|
-
bundles: ("embed:exports:v1" | "embed:reports:v1" | "embed:statements:v1" | "partner:accounting-data:v1" | "partner:banking:v1" | "partner:onboarding:v1" | "partner:provisioning:v1" | "partner:reports:v1" | "partner:statements:v1" | "partner:webhooks:v1")[];
|
|
32665
32721
|
/** Format: uuid */
|
|
32666
32722
|
id: string;
|
|
32667
|
-
|
|
32668
|
-
|
|
32669
|
-
|
|
32723
|
+
isAdmin: boolean;
|
|
32724
|
+
memberships: {
|
|
32725
|
+
/** Format: uuid */
|
|
32726
|
+
id: string;
|
|
32727
|
+
/** Format: uuid */
|
|
32728
|
+
tenantId: string;
|
|
32729
|
+
role: string | null;
|
|
32730
|
+
status: string | null;
|
|
32731
|
+
}[];
|
|
32670
32732
|
};
|
|
32671
32733
|
};
|
|
32672
32734
|
};
|
|
@@ -32804,20 +32866,13 @@ export interface operations {
|
|
|
32804
32866
|
};
|
|
32805
32867
|
};
|
|
32806
32868
|
};
|
|
32807
|
-
|
|
32869
|
+
deleteInternalUsersById: {
|
|
32808
32870
|
parameters: {
|
|
32809
|
-
query?:
|
|
32810
|
-
|
|
32811
|
-
|
|
32812
|
-
|
|
32813
|
-
page?: number;
|
|
32814
|
-
offset?: number;
|
|
32815
|
-
};
|
|
32816
|
-
header?: {
|
|
32817
|
-
/** @description Selects the regional data partition for this regional collection read. It does not change the authenticated team context. */
|
|
32818
|
-
"x-data-region"?: "ap" | "crunchy" | "eu" | "hostaway" | "us";
|
|
32871
|
+
query?: never;
|
|
32872
|
+
header?: never;
|
|
32873
|
+
path: {
|
|
32874
|
+
id: string;
|
|
32819
32875
|
};
|
|
32820
|
-
path?: never;
|
|
32821
32876
|
cookie?: never;
|
|
32822
32877
|
};
|
|
32823
32878
|
requestBody?: never;
|
|
@@ -32829,45 +32884,14 @@ export interface operations {
|
|
|
32829
32884
|
};
|
|
32830
32885
|
content: {
|
|
32831
32886
|
"application/json": {
|
|
32832
|
-
|
|
32833
|
-
|
|
32834
|
-
|
|
32835
|
-
|
|
32836
|
-
|
|
32837
|
-
|
|
32838
|
-
|
|
32839
|
-
|
|
32840
|
-
/** @description User kind (e.g. user, owner) */
|
|
32841
|
-
type?: string | null;
|
|
32842
|
-
lastSeen: string | null;
|
|
32843
|
-
createdAt: string | null;
|
|
32844
|
-
memberships: {
|
|
32845
|
-
/** Format: uuid */
|
|
32846
|
-
teamId: string;
|
|
32847
|
-
teamName: string;
|
|
32848
|
-
role?: string | null;
|
|
32849
|
-
status?: string | null;
|
|
32850
|
-
lastInvitedAt: string | null;
|
|
32851
|
-
}[];
|
|
32852
|
-
ownerAccesses: {
|
|
32853
|
-
/** Format: uuid */
|
|
32854
|
-
teamId: string;
|
|
32855
|
-
contactId: string | null;
|
|
32856
|
-
ownerId: string | null;
|
|
32857
|
-
role?: string | null;
|
|
32858
|
-
/** @description Owner contact name */
|
|
32859
|
-
name?: string | null;
|
|
32860
|
-
}[];
|
|
32861
|
-
}[];
|
|
32862
|
-
pagination: {
|
|
32863
|
-
/** @default 100 */
|
|
32864
|
-
limit: number;
|
|
32865
|
-
/** @default 1 */
|
|
32866
|
-
page: number;
|
|
32867
|
-
total: number;
|
|
32868
|
-
totalPage: number;
|
|
32869
|
-
nextPage?: number;
|
|
32870
|
-
};
|
|
32887
|
+
/** @enum {string} */
|
|
32888
|
+
status: "deleted";
|
|
32889
|
+
/** @description Deprecated: use status */
|
|
32890
|
+
deleted: boolean;
|
|
32891
|
+
files: number;
|
|
32892
|
+
memberships: number;
|
|
32893
|
+
ownerAccess: number;
|
|
32894
|
+
tokens: number;
|
|
32871
32895
|
};
|
|
32872
32896
|
};
|
|
32873
32897
|
};
|
|
@@ -33005,37 +33029,24 @@ export interface operations {
|
|
|
33005
33029
|
};
|
|
33006
33030
|
};
|
|
33007
33031
|
};
|
|
33008
|
-
|
|
33032
|
+
putInternalUsersByIdMembershipsByTenantId: {
|
|
33009
33033
|
parameters: {
|
|
33010
33034
|
query?: never;
|
|
33011
33035
|
header?: never;
|
|
33012
|
-
path
|
|
33036
|
+
path: {
|
|
33037
|
+
id: string;
|
|
33038
|
+
tenantId: string;
|
|
33039
|
+
};
|
|
33013
33040
|
cookie?: never;
|
|
33014
33041
|
};
|
|
33015
33042
|
requestBody?: {
|
|
33016
33043
|
content: {
|
|
33017
33044
|
"application/json": {
|
|
33018
|
-
|
|
33019
|
-
id?: string;
|
|
33020
|
-
email: string;
|
|
33021
|
-
firstName?: string | null;
|
|
33022
|
-
lastName?: string | null;
|
|
33023
|
-
name?: string | null;
|
|
33045
|
+
lastInvitedAt?: string | null;
|
|
33024
33046
|
/** @enum {string} */
|
|
33025
|
-
|
|
33026
|
-
|
|
33027
|
-
|
|
33028
|
-
membership?: {
|
|
33029
|
-
/** Format: uuid */
|
|
33030
|
-
tenantId: string;
|
|
33031
|
-
/**
|
|
33032
|
-
* @default user
|
|
33033
|
-
* @enum {string}
|
|
33034
|
-
*/
|
|
33035
|
-
role?: "admin" | "user" | "owner";
|
|
33036
|
-
/** @enum {string} */
|
|
33037
|
-
status?: "active" | "inactive" | "unconfirmed";
|
|
33038
|
-
};
|
|
33047
|
+
role?: "admin" | "user" | "owner";
|
|
33048
|
+
/** @enum {string} */
|
|
33049
|
+
status?: "active" | "inactive" | "unconfirmed";
|
|
33039
33050
|
};
|
|
33040
33051
|
};
|
|
33041
33052
|
};
|
|
@@ -33049,15 +33060,11 @@ export interface operations {
|
|
|
33049
33060
|
"application/json": {
|
|
33050
33061
|
/** Format: uuid */
|
|
33051
33062
|
id: string;
|
|
33052
|
-
|
|
33053
|
-
|
|
33054
|
-
|
|
33055
|
-
|
|
33056
|
-
|
|
33057
|
-
tenantId: string;
|
|
33058
|
-
role: string | null;
|
|
33059
|
-
status: string | null;
|
|
33060
|
-
}[];
|
|
33063
|
+
lastInvitedAt: string | null;
|
|
33064
|
+
status: ("active" | "inactive" | "unconfirmed") | null;
|
|
33065
|
+
/** Format: uuid */
|
|
33066
|
+
tenantId: string;
|
|
33067
|
+
role: string | null;
|
|
33061
33068
|
};
|
|
33062
33069
|
};
|
|
33063
33070
|
};
|
|
@@ -33195,40 +33202,17 @@ export interface operations {
|
|
|
33195
33202
|
};
|
|
33196
33203
|
};
|
|
33197
33204
|
};
|
|
33198
|
-
|
|
33205
|
+
deleteInternalUsersByIdMembershipsByTenantId: {
|
|
33199
33206
|
parameters: {
|
|
33200
33207
|
query?: never;
|
|
33201
33208
|
header?: never;
|
|
33202
33209
|
path: {
|
|
33203
33210
|
id: string;
|
|
33211
|
+
tenantId: string;
|
|
33204
33212
|
};
|
|
33205
33213
|
cookie?: never;
|
|
33206
33214
|
};
|
|
33207
|
-
requestBody?:
|
|
33208
|
-
content: {
|
|
33209
|
-
"application/json": {
|
|
33210
|
-
email: string;
|
|
33211
|
-
firstName?: string | null;
|
|
33212
|
-
lastName?: string | null;
|
|
33213
|
-
name?: string | null;
|
|
33214
|
-
/** @enum {string} */
|
|
33215
|
-
status?: "active" | "inactive" | "archived" | "unconfirmed";
|
|
33216
|
-
partnerId?: string | null;
|
|
33217
|
-
secondaryEmails?: string[];
|
|
33218
|
-
membership?: {
|
|
33219
|
-
/** Format: uuid */
|
|
33220
|
-
tenantId: string;
|
|
33221
|
-
/**
|
|
33222
|
-
* @default user
|
|
33223
|
-
* @enum {string}
|
|
33224
|
-
*/
|
|
33225
|
-
role?: "admin" | "user" | "owner";
|
|
33226
|
-
/** @enum {string} */
|
|
33227
|
-
status?: "active" | "inactive" | "unconfirmed";
|
|
33228
|
-
};
|
|
33229
|
-
};
|
|
33230
|
-
};
|
|
33231
|
-
};
|
|
33215
|
+
requestBody?: never;
|
|
33232
33216
|
responses: {
|
|
33233
33217
|
/** @description Successful response */
|
|
33234
33218
|
200: {
|
|
@@ -33237,17 +33221,10 @@ export interface operations {
|
|
|
33237
33221
|
};
|
|
33238
33222
|
content: {
|
|
33239
33223
|
"application/json": {
|
|
33240
|
-
/**
|
|
33241
|
-
|
|
33242
|
-
|
|
33243
|
-
|
|
33244
|
-
/** Format: uuid */
|
|
33245
|
-
id: string;
|
|
33246
|
-
/** Format: uuid */
|
|
33247
|
-
tenantId: string;
|
|
33248
|
-
role: string | null;
|
|
33249
|
-
status: string | null;
|
|
33250
|
-
}[];
|
|
33224
|
+
/** @enum {string} */
|
|
33225
|
+
status: "deleted";
|
|
33226
|
+
/** @description Deprecated: use status */
|
|
33227
|
+
deleted: boolean;
|
|
33251
33228
|
};
|
|
33252
33229
|
};
|
|
33253
33230
|
};
|
|
@@ -33385,16 +33362,54 @@ export interface operations {
|
|
|
33385
33362
|
};
|
|
33386
33363
|
};
|
|
33387
33364
|
};
|
|
33388
|
-
|
|
33365
|
+
batchPayments: {
|
|
33389
33366
|
parameters: {
|
|
33390
33367
|
query?: never;
|
|
33391
33368
|
header?: never;
|
|
33392
|
-
path
|
|
33393
|
-
id: string;
|
|
33394
|
-
};
|
|
33369
|
+
path?: never;
|
|
33395
33370
|
cookie?: never;
|
|
33396
33371
|
};
|
|
33397
|
-
requestBody?:
|
|
33372
|
+
requestBody?: {
|
|
33373
|
+
content: {
|
|
33374
|
+
"application/json": {
|
|
33375
|
+
connectionId: string;
|
|
33376
|
+
data: {
|
|
33377
|
+
id?: string | null;
|
|
33378
|
+
uniqueRef?: string | null;
|
|
33379
|
+
etaAt?: string | null;
|
|
33380
|
+
paidAt?: string | null;
|
|
33381
|
+
/** @description Currency in ISO 4217 format, will be converted to lowercase */
|
|
33382
|
+
currency: string;
|
|
33383
|
+
description?: string | null;
|
|
33384
|
+
metadata?: {
|
|
33385
|
+
[key: string]: unknown;
|
|
33386
|
+
} | null;
|
|
33387
|
+
userdata?: {
|
|
33388
|
+
[key: string]: unknown;
|
|
33389
|
+
} | null;
|
|
33390
|
+
sourceId?: string | null;
|
|
33391
|
+
lines: {
|
|
33392
|
+
id?: string | null;
|
|
33393
|
+
uniqueRef?: string | null;
|
|
33394
|
+
type: string;
|
|
33395
|
+
description?: string | null;
|
|
33396
|
+
reservationId?: string | null;
|
|
33397
|
+
reservationRef?: string | null;
|
|
33398
|
+
/** @description Value in cents (100 = 1€) */
|
|
33399
|
+
amount: number;
|
|
33400
|
+
accountId?: string | null;
|
|
33401
|
+
accountRef?: string | null;
|
|
33402
|
+
connectionId?: string | null;
|
|
33403
|
+
metadata?: {
|
|
33404
|
+
[key: string]: unknown;
|
|
33405
|
+
} | null;
|
|
33406
|
+
generalLedgerPostingAt?: string | null;
|
|
33407
|
+
}[];
|
|
33408
|
+
bankAccountRef?: string | null;
|
|
33409
|
+
}[];
|
|
33410
|
+
};
|
|
33411
|
+
};
|
|
33412
|
+
};
|
|
33398
33413
|
responses: {
|
|
33399
33414
|
/** @description Successful response */
|
|
33400
33415
|
200: {
|
|
@@ -33403,14 +33418,20 @@ export interface operations {
|
|
|
33403
33418
|
};
|
|
33404
33419
|
content: {
|
|
33405
33420
|
"application/json": {
|
|
33406
|
-
|
|
33407
|
-
|
|
33408
|
-
|
|
33409
|
-
|
|
33410
|
-
|
|
33411
|
-
|
|
33412
|
-
|
|
33413
|
-
|
|
33421
|
+
data: {
|
|
33422
|
+
/** Format: uuid */
|
|
33423
|
+
id: string;
|
|
33424
|
+
uniqueRef?: string | null;
|
|
33425
|
+
sourceId?: string | null;
|
|
33426
|
+
}[];
|
|
33427
|
+
issues: {
|
|
33428
|
+
ref: string;
|
|
33429
|
+
sourceId?: string | null;
|
|
33430
|
+
message: string;
|
|
33431
|
+
/** @enum {string} */
|
|
33432
|
+
code?: "USER_ERROR" | "NOT_FOUND" | "FORBIDDEN" | "CONFLICT" | "RATE_LIMITED" | "SERVICE_UNAVAILABLE" | "INTERNAL_VALIDATION_ERROR" | "INTERNAL_ERROR";
|
|
33433
|
+
context?: unknown;
|
|
33434
|
+
}[];
|
|
33414
33435
|
};
|
|
33415
33436
|
};
|
|
33416
33437
|
};
|
|
@@ -33548,27 +33569,22 @@ export interface operations {
|
|
|
33548
33569
|
};
|
|
33549
33570
|
};
|
|
33550
33571
|
};
|
|
33551
|
-
|
|
33572
|
+
getPaymentsDeprecated: {
|
|
33552
33573
|
parameters: {
|
|
33553
|
-
query?:
|
|
33554
|
-
|
|
33555
|
-
|
|
33556
|
-
|
|
33557
|
-
|
|
33574
|
+
query?: {
|
|
33575
|
+
pageSize?: number;
|
|
33576
|
+
page?: number;
|
|
33577
|
+
type?: string;
|
|
33578
|
+
date?: string;
|
|
33579
|
+
expand?: string;
|
|
33580
|
+
description?: string;
|
|
33581
|
+
amount?: number;
|
|
33558
33582
|
};
|
|
33583
|
+
header?: never;
|
|
33584
|
+
path?: never;
|
|
33559
33585
|
cookie?: never;
|
|
33560
33586
|
};
|
|
33561
|
-
requestBody?:
|
|
33562
|
-
content: {
|
|
33563
|
-
"application/json": {
|
|
33564
|
-
lastInvitedAt?: string | null;
|
|
33565
|
-
/** @enum {string} */
|
|
33566
|
-
role?: "admin" | "user" | "owner";
|
|
33567
|
-
/** @enum {string} */
|
|
33568
|
-
status?: "active" | "inactive" | "unconfirmed";
|
|
33569
|
-
};
|
|
33570
|
-
};
|
|
33571
|
-
};
|
|
33587
|
+
requestBody?: never;
|
|
33572
33588
|
responses: {
|
|
33573
33589
|
/** @description Successful response */
|
|
33574
33590
|
200: {
|
|
@@ -33577,13 +33593,55 @@ export interface operations {
|
|
|
33577
33593
|
};
|
|
33578
33594
|
content: {
|
|
33579
33595
|
"application/json": {
|
|
33580
|
-
|
|
33581
|
-
|
|
33582
|
-
|
|
33583
|
-
|
|
33584
|
-
|
|
33585
|
-
|
|
33586
|
-
|
|
33596
|
+
results: number;
|
|
33597
|
+
totalResults: number;
|
|
33598
|
+
page: number;
|
|
33599
|
+
totalPages: number;
|
|
33600
|
+
filters?: {
|
|
33601
|
+
[key: string]: unknown;
|
|
33602
|
+
};
|
|
33603
|
+
data: {
|
|
33604
|
+
/** Format: uuid */
|
|
33605
|
+
id: string;
|
|
33606
|
+
amount: number;
|
|
33607
|
+
currency?: string | null;
|
|
33608
|
+
description?: string | null;
|
|
33609
|
+
date?: string | null;
|
|
33610
|
+
uniqueRef?: string | null;
|
|
33611
|
+
isReconciled?: boolean | null;
|
|
33612
|
+
metadata?: {
|
|
33613
|
+
[key: string]: unknown;
|
|
33614
|
+
};
|
|
33615
|
+
status?: string | null;
|
|
33616
|
+
type?: string | null;
|
|
33617
|
+
lines: {
|
|
33618
|
+
/** Format: uuid */
|
|
33619
|
+
id: string;
|
|
33620
|
+
uniqueRef?: string | null;
|
|
33621
|
+
type?: string | null;
|
|
33622
|
+
uniqueType?: string | null;
|
|
33623
|
+
description?: string | null;
|
|
33624
|
+
amount: number;
|
|
33625
|
+
originalAmount?: number | null;
|
|
33626
|
+
originalCurrency?: string | null;
|
|
33627
|
+
reservationId?: string | null;
|
|
33628
|
+
paymentId?: string | null;
|
|
33629
|
+
metadata?: {
|
|
33630
|
+
[key: string]: unknown;
|
|
33631
|
+
};
|
|
33632
|
+
listingId?: string | null;
|
|
33633
|
+
listing?: unknown;
|
|
33634
|
+
reservation?: unknown;
|
|
33635
|
+
}[];
|
|
33636
|
+
connection?: {
|
|
33637
|
+
/** Format: uuid */
|
|
33638
|
+
id: string;
|
|
33639
|
+
name?: string | null;
|
|
33640
|
+
type?: string | null;
|
|
33641
|
+
appId?: string | null;
|
|
33642
|
+
status?: string | null;
|
|
33643
|
+
} | null;
|
|
33644
|
+
}[];
|
|
33587
33645
|
};
|
|
33588
33646
|
};
|
|
33589
33647
|
};
|
|
@@ -33721,13 +33779,12 @@ export interface operations {
|
|
|
33721
33779
|
};
|
|
33722
33780
|
};
|
|
33723
33781
|
};
|
|
33724
|
-
|
|
33782
|
+
getPaymentDeprecated: {
|
|
33725
33783
|
parameters: {
|
|
33726
33784
|
query?: never;
|
|
33727
33785
|
header?: never;
|
|
33728
33786
|
path: {
|
|
33729
33787
|
id: string;
|
|
33730
|
-
tenantId: string;
|
|
33731
33788
|
};
|
|
33732
33789
|
cookie?: never;
|
|
33733
33790
|
};
|
|
@@ -33740,622 +33797,46 @@ export interface operations {
|
|
|
33740
33797
|
};
|
|
33741
33798
|
content: {
|
|
33742
33799
|
"application/json": {
|
|
33743
|
-
/**
|
|
33744
|
-
|
|
33745
|
-
|
|
33746
|
-
|
|
33747
|
-
|
|
33748
|
-
|
|
33749
|
-
|
|
33750
|
-
|
|
33751
|
-
|
|
33752
|
-
|
|
33753
|
-
|
|
33754
|
-
|
|
33755
|
-
|
|
33756
|
-
|
|
33757
|
-
|
|
33758
|
-
|
|
33759
|
-
|
|
33760
|
-
|
|
33761
|
-
|
|
33762
|
-
|
|
33763
|
-
|
|
33764
|
-
|
|
33765
|
-
|
|
33766
|
-
|
|
33767
|
-
|
|
33768
|
-
|
|
33769
|
-
|
|
33770
|
-
|
|
33771
|
-
|
|
33772
|
-
|
|
33773
|
-
|
|
33774
|
-
|
|
33775
|
-
|
|
33776
|
-
|
|
33777
|
-
|
|
33778
|
-
|
|
33779
|
-
|
|
33780
|
-
|
|
33781
|
-
|
|
33782
|
-
|
|
33783
|
-
schema: string;
|
|
33784
|
-
};
|
|
33785
|
-
issues?: {
|
|
33786
|
-
message: string;
|
|
33787
|
-
path?: (string | number)[];
|
|
33788
|
-
schema?: string;
|
|
33789
|
-
}[];
|
|
33790
|
-
context?: unknown;
|
|
33791
|
-
};
|
|
33792
|
-
};
|
|
33793
|
-
};
|
|
33794
|
-
/** @description Forbidden */
|
|
33795
|
-
403: {
|
|
33796
|
-
headers: {
|
|
33797
|
-
[name: string]: unknown;
|
|
33798
|
-
};
|
|
33799
|
-
content: {
|
|
33800
|
-
"application/json": {
|
|
33801
|
-
code: string;
|
|
33802
|
-
message: string;
|
|
33803
|
-
links?: {
|
|
33804
|
-
docs: string;
|
|
33805
|
-
schema: string;
|
|
33806
|
-
};
|
|
33807
|
-
issues?: {
|
|
33808
|
-
message: string;
|
|
33809
|
-
path?: (string | number)[];
|
|
33810
|
-
schema?: string;
|
|
33811
|
-
}[];
|
|
33812
|
-
context?: unknown;
|
|
33813
|
-
};
|
|
33814
|
-
};
|
|
33815
|
-
};
|
|
33816
|
-
/** @description Not found */
|
|
33817
|
-
404: {
|
|
33818
|
-
headers: {
|
|
33819
|
-
[name: string]: unknown;
|
|
33820
|
-
};
|
|
33821
|
-
content: {
|
|
33822
|
-
"application/json": {
|
|
33823
|
-
code: string;
|
|
33824
|
-
message: string;
|
|
33825
|
-
links?: {
|
|
33826
|
-
docs: string;
|
|
33827
|
-
schema: string;
|
|
33828
|
-
};
|
|
33829
|
-
issues?: {
|
|
33830
|
-
message: string;
|
|
33831
|
-
path?: (string | number)[];
|
|
33832
|
-
schema?: string;
|
|
33833
|
-
}[];
|
|
33834
|
-
context?: unknown;
|
|
33835
|
-
};
|
|
33836
|
-
};
|
|
33837
|
-
};
|
|
33838
|
-
/** @description Internal server error */
|
|
33839
|
-
500: {
|
|
33840
|
-
headers: {
|
|
33841
|
-
[name: string]: unknown;
|
|
33842
|
-
};
|
|
33843
|
-
content: {
|
|
33844
|
-
"application/json": {
|
|
33845
|
-
code: string;
|
|
33846
|
-
message: string;
|
|
33847
|
-
links?: {
|
|
33848
|
-
docs: string;
|
|
33849
|
-
schema: string;
|
|
33850
|
-
};
|
|
33851
|
-
issues?: {
|
|
33852
|
-
message: string;
|
|
33853
|
-
path?: (string | number)[];
|
|
33854
|
-
schema?: string;
|
|
33855
|
-
}[];
|
|
33856
|
-
context?: unknown;
|
|
33857
|
-
};
|
|
33858
|
-
};
|
|
33859
|
-
};
|
|
33860
|
-
/** @description Service unavailable */
|
|
33861
|
-
503: {
|
|
33862
|
-
headers: {
|
|
33863
|
-
[name: string]: unknown;
|
|
33864
|
-
};
|
|
33865
|
-
content: {
|
|
33866
|
-
"application/json": {
|
|
33867
|
-
code: string;
|
|
33868
|
-
message: string;
|
|
33869
|
-
links?: {
|
|
33870
|
-
docs: string;
|
|
33871
|
-
schema: string;
|
|
33872
|
-
};
|
|
33873
|
-
issues?: {
|
|
33874
|
-
message: string;
|
|
33875
|
-
path?: (string | number)[];
|
|
33876
|
-
schema?: string;
|
|
33877
|
-
}[];
|
|
33878
|
-
context?: unknown;
|
|
33879
|
-
};
|
|
33880
|
-
};
|
|
33881
|
-
};
|
|
33882
|
-
};
|
|
33883
|
-
};
|
|
33884
|
-
batchPayments: {
|
|
33885
|
-
parameters: {
|
|
33886
|
-
query?: never;
|
|
33887
|
-
header?: never;
|
|
33888
|
-
path?: never;
|
|
33889
|
-
cookie?: never;
|
|
33890
|
-
};
|
|
33891
|
-
requestBody?: {
|
|
33892
|
-
content: {
|
|
33893
|
-
"application/json": {
|
|
33894
|
-
connectionId: string;
|
|
33895
|
-
data: {
|
|
33896
|
-
id?: string | null;
|
|
33897
|
-
uniqueRef?: string | null;
|
|
33898
|
-
etaAt?: string | null;
|
|
33899
|
-
paidAt?: string | null;
|
|
33900
|
-
/** @description Currency in ISO 4217 format, will be converted to lowercase */
|
|
33901
|
-
currency: string;
|
|
33902
|
-
description?: string | null;
|
|
33903
|
-
metadata?: {
|
|
33904
|
-
[key: string]: unknown;
|
|
33905
|
-
} | null;
|
|
33906
|
-
userdata?: {
|
|
33907
|
-
[key: string]: unknown;
|
|
33908
|
-
} | null;
|
|
33909
|
-
sourceId?: string | null;
|
|
33910
|
-
lines: {
|
|
33911
|
-
id?: string | null;
|
|
33912
|
-
uniqueRef?: string | null;
|
|
33913
|
-
type: string;
|
|
33914
|
-
description?: string | null;
|
|
33915
|
-
reservationId?: string | null;
|
|
33916
|
-
reservationRef?: string | null;
|
|
33917
|
-
/** @description Value in cents (100 = 1€) */
|
|
33918
|
-
amount: number;
|
|
33919
|
-
accountId?: string | null;
|
|
33920
|
-
accountRef?: string | null;
|
|
33921
|
-
connectionId?: string | null;
|
|
33922
|
-
metadata?: {
|
|
33923
|
-
[key: string]: unknown;
|
|
33924
|
-
} | null;
|
|
33925
|
-
generalLedgerPostingAt?: string | null;
|
|
33926
|
-
}[];
|
|
33927
|
-
bankAccountRef?: string | null;
|
|
33928
|
-
}[];
|
|
33929
|
-
};
|
|
33930
|
-
};
|
|
33931
|
-
};
|
|
33932
|
-
responses: {
|
|
33933
|
-
/** @description Successful response */
|
|
33934
|
-
200: {
|
|
33935
|
-
headers: {
|
|
33936
|
-
[name: string]: unknown;
|
|
33937
|
-
};
|
|
33938
|
-
content: {
|
|
33939
|
-
"application/json": {
|
|
33940
|
-
data: {
|
|
33941
|
-
/** Format: uuid */
|
|
33942
|
-
id: string;
|
|
33943
|
-
uniqueRef?: string | null;
|
|
33944
|
-
sourceId?: string | null;
|
|
33945
|
-
}[];
|
|
33946
|
-
issues: {
|
|
33947
|
-
ref: string;
|
|
33948
|
-
sourceId?: string | null;
|
|
33949
|
-
message: string;
|
|
33950
|
-
/** @enum {string} */
|
|
33951
|
-
code?: "USER_ERROR" | "NOT_FOUND" | "FORBIDDEN" | "CONFLICT" | "RATE_LIMITED" | "SERVICE_UNAVAILABLE" | "INTERNAL_VALIDATION_ERROR" | "INTERNAL_ERROR";
|
|
33952
|
-
context?: unknown;
|
|
33953
|
-
}[];
|
|
33954
|
-
};
|
|
33955
|
-
};
|
|
33956
|
-
};
|
|
33957
|
-
/** @description Bad request */
|
|
33958
|
-
400: {
|
|
33959
|
-
headers: {
|
|
33960
|
-
[name: string]: unknown;
|
|
33961
|
-
};
|
|
33962
|
-
content: {
|
|
33963
|
-
"application/json": {
|
|
33964
|
-
code: string;
|
|
33965
|
-
message: string;
|
|
33966
|
-
links?: {
|
|
33967
|
-
docs: string;
|
|
33968
|
-
schema: string;
|
|
33969
|
-
};
|
|
33970
|
-
issues?: {
|
|
33971
|
-
message: string;
|
|
33972
|
-
path?: (string | number)[];
|
|
33973
|
-
schema?: string;
|
|
33974
|
-
}[];
|
|
33975
|
-
context?: unknown;
|
|
33976
|
-
};
|
|
33977
|
-
};
|
|
33978
|
-
};
|
|
33979
|
-
/** @description Unauthorized */
|
|
33980
|
-
401: {
|
|
33981
|
-
headers: {
|
|
33982
|
-
[name: string]: unknown;
|
|
33983
|
-
};
|
|
33984
|
-
content: {
|
|
33985
|
-
"application/json": {
|
|
33986
|
-
code: string;
|
|
33987
|
-
message: string;
|
|
33988
|
-
links?: {
|
|
33989
|
-
docs: string;
|
|
33990
|
-
schema: string;
|
|
33991
|
-
};
|
|
33992
|
-
issues?: {
|
|
33993
|
-
message: string;
|
|
33994
|
-
path?: (string | number)[];
|
|
33995
|
-
schema?: string;
|
|
33996
|
-
}[];
|
|
33997
|
-
context?: unknown;
|
|
33998
|
-
};
|
|
33999
|
-
};
|
|
34000
|
-
};
|
|
34001
|
-
/** @description Forbidden */
|
|
34002
|
-
403: {
|
|
34003
|
-
headers: {
|
|
34004
|
-
[name: string]: unknown;
|
|
34005
|
-
};
|
|
34006
|
-
content: {
|
|
34007
|
-
"application/json": {
|
|
34008
|
-
code: string;
|
|
34009
|
-
message: string;
|
|
34010
|
-
links?: {
|
|
34011
|
-
docs: string;
|
|
34012
|
-
schema: string;
|
|
34013
|
-
};
|
|
34014
|
-
issues?: {
|
|
34015
|
-
message: string;
|
|
34016
|
-
path?: (string | number)[];
|
|
34017
|
-
schema?: string;
|
|
34018
|
-
}[];
|
|
34019
|
-
context?: unknown;
|
|
34020
|
-
};
|
|
34021
|
-
};
|
|
34022
|
-
};
|
|
34023
|
-
/** @description Not found */
|
|
34024
|
-
404: {
|
|
34025
|
-
headers: {
|
|
34026
|
-
[name: string]: unknown;
|
|
34027
|
-
};
|
|
34028
|
-
content: {
|
|
34029
|
-
"application/json": {
|
|
34030
|
-
code: string;
|
|
34031
|
-
message: string;
|
|
34032
|
-
links?: {
|
|
34033
|
-
docs: string;
|
|
34034
|
-
schema: string;
|
|
34035
|
-
};
|
|
34036
|
-
issues?: {
|
|
34037
|
-
message: string;
|
|
34038
|
-
path?: (string | number)[];
|
|
34039
|
-
schema?: string;
|
|
34040
|
-
}[];
|
|
34041
|
-
context?: unknown;
|
|
34042
|
-
};
|
|
34043
|
-
};
|
|
34044
|
-
};
|
|
34045
|
-
/** @description Internal server error */
|
|
34046
|
-
500: {
|
|
34047
|
-
headers: {
|
|
34048
|
-
[name: string]: unknown;
|
|
34049
|
-
};
|
|
34050
|
-
content: {
|
|
34051
|
-
"application/json": {
|
|
34052
|
-
code: string;
|
|
34053
|
-
message: string;
|
|
34054
|
-
links?: {
|
|
34055
|
-
docs: string;
|
|
34056
|
-
schema: string;
|
|
34057
|
-
};
|
|
34058
|
-
issues?: {
|
|
34059
|
-
message: string;
|
|
34060
|
-
path?: (string | number)[];
|
|
34061
|
-
schema?: string;
|
|
34062
|
-
}[];
|
|
34063
|
-
context?: unknown;
|
|
34064
|
-
};
|
|
34065
|
-
};
|
|
34066
|
-
};
|
|
34067
|
-
/** @description Service unavailable */
|
|
34068
|
-
503: {
|
|
34069
|
-
headers: {
|
|
34070
|
-
[name: string]: unknown;
|
|
34071
|
-
};
|
|
34072
|
-
content: {
|
|
34073
|
-
"application/json": {
|
|
34074
|
-
code: string;
|
|
34075
|
-
message: string;
|
|
34076
|
-
links?: {
|
|
34077
|
-
docs: string;
|
|
34078
|
-
schema: string;
|
|
34079
|
-
};
|
|
34080
|
-
issues?: {
|
|
34081
|
-
message: string;
|
|
34082
|
-
path?: (string | number)[];
|
|
34083
|
-
schema?: string;
|
|
34084
|
-
}[];
|
|
34085
|
-
context?: unknown;
|
|
34086
|
-
};
|
|
34087
|
-
};
|
|
34088
|
-
};
|
|
34089
|
-
};
|
|
34090
|
-
};
|
|
34091
|
-
getPaymentsDeprecated: {
|
|
34092
|
-
parameters: {
|
|
34093
|
-
query?: {
|
|
34094
|
-
pageSize?: number;
|
|
34095
|
-
page?: number;
|
|
34096
|
-
type?: string;
|
|
34097
|
-
date?: string;
|
|
34098
|
-
expand?: string;
|
|
34099
|
-
description?: string;
|
|
34100
|
-
amount?: number;
|
|
34101
|
-
};
|
|
34102
|
-
header?: never;
|
|
34103
|
-
path?: never;
|
|
34104
|
-
cookie?: never;
|
|
34105
|
-
};
|
|
34106
|
-
requestBody?: never;
|
|
34107
|
-
responses: {
|
|
34108
|
-
/** @description Successful response */
|
|
34109
|
-
200: {
|
|
34110
|
-
headers: {
|
|
34111
|
-
[name: string]: unknown;
|
|
34112
|
-
};
|
|
34113
|
-
content: {
|
|
34114
|
-
"application/json": {
|
|
34115
|
-
results: number;
|
|
34116
|
-
totalResults: number;
|
|
34117
|
-
page: number;
|
|
34118
|
-
totalPages: number;
|
|
34119
|
-
filters?: {
|
|
34120
|
-
[key: string]: unknown;
|
|
34121
|
-
};
|
|
34122
|
-
data: {
|
|
34123
|
-
/** Format: uuid */
|
|
34124
|
-
id: string;
|
|
34125
|
-
amount: number;
|
|
34126
|
-
currency?: string | null;
|
|
34127
|
-
description?: string | null;
|
|
34128
|
-
date?: string | null;
|
|
34129
|
-
uniqueRef?: string | null;
|
|
34130
|
-
isReconciled?: boolean | null;
|
|
34131
|
-
metadata?: {
|
|
34132
|
-
[key: string]: unknown;
|
|
34133
|
-
};
|
|
34134
|
-
status?: string | null;
|
|
34135
|
-
type?: string | null;
|
|
34136
|
-
lines: {
|
|
34137
|
-
/** Format: uuid */
|
|
34138
|
-
id: string;
|
|
34139
|
-
uniqueRef?: string | null;
|
|
34140
|
-
type?: string | null;
|
|
34141
|
-
uniqueType?: string | null;
|
|
34142
|
-
description?: string | null;
|
|
34143
|
-
amount: number;
|
|
34144
|
-
originalAmount?: number | null;
|
|
34145
|
-
originalCurrency?: string | null;
|
|
34146
|
-
reservationId?: string | null;
|
|
34147
|
-
paymentId?: string | null;
|
|
34148
|
-
metadata?: {
|
|
34149
|
-
[key: string]: unknown;
|
|
34150
|
-
};
|
|
34151
|
-
listingId?: string | null;
|
|
34152
|
-
listing?: unknown;
|
|
34153
|
-
reservation?: unknown;
|
|
34154
|
-
}[];
|
|
34155
|
-
connection?: {
|
|
34156
|
-
/** Format: uuid */
|
|
34157
|
-
id: string;
|
|
34158
|
-
name?: string | null;
|
|
34159
|
-
type?: string | null;
|
|
34160
|
-
appId?: string | null;
|
|
34161
|
-
status?: string | null;
|
|
34162
|
-
} | null;
|
|
34163
|
-
}[];
|
|
34164
|
-
};
|
|
34165
|
-
};
|
|
34166
|
-
};
|
|
34167
|
-
/** @description Bad request */
|
|
34168
|
-
400: {
|
|
34169
|
-
headers: {
|
|
34170
|
-
[name: string]: unknown;
|
|
34171
|
-
};
|
|
34172
|
-
content: {
|
|
34173
|
-
"application/json": {
|
|
34174
|
-
code: string;
|
|
34175
|
-
message: string;
|
|
34176
|
-
links?: {
|
|
34177
|
-
docs: string;
|
|
34178
|
-
schema: string;
|
|
34179
|
-
};
|
|
34180
|
-
issues?: {
|
|
34181
|
-
message: string;
|
|
34182
|
-
path?: (string | number)[];
|
|
34183
|
-
schema?: string;
|
|
34184
|
-
}[];
|
|
34185
|
-
context?: unknown;
|
|
34186
|
-
};
|
|
34187
|
-
};
|
|
34188
|
-
};
|
|
34189
|
-
/** @description Unauthorized */
|
|
34190
|
-
401: {
|
|
34191
|
-
headers: {
|
|
34192
|
-
[name: string]: unknown;
|
|
34193
|
-
};
|
|
34194
|
-
content: {
|
|
34195
|
-
"application/json": {
|
|
34196
|
-
code: string;
|
|
34197
|
-
message: string;
|
|
34198
|
-
links?: {
|
|
34199
|
-
docs: string;
|
|
34200
|
-
schema: string;
|
|
34201
|
-
};
|
|
34202
|
-
issues?: {
|
|
34203
|
-
message: string;
|
|
34204
|
-
path?: (string | number)[];
|
|
34205
|
-
schema?: string;
|
|
34206
|
-
}[];
|
|
34207
|
-
context?: unknown;
|
|
34208
|
-
};
|
|
34209
|
-
};
|
|
34210
|
-
};
|
|
34211
|
-
/** @description Forbidden */
|
|
34212
|
-
403: {
|
|
34213
|
-
headers: {
|
|
34214
|
-
[name: string]: unknown;
|
|
34215
|
-
};
|
|
34216
|
-
content: {
|
|
34217
|
-
"application/json": {
|
|
34218
|
-
code: string;
|
|
34219
|
-
message: string;
|
|
34220
|
-
links?: {
|
|
34221
|
-
docs: string;
|
|
34222
|
-
schema: string;
|
|
34223
|
-
};
|
|
34224
|
-
issues?: {
|
|
34225
|
-
message: string;
|
|
34226
|
-
path?: (string | number)[];
|
|
34227
|
-
schema?: string;
|
|
34228
|
-
}[];
|
|
34229
|
-
context?: unknown;
|
|
34230
|
-
};
|
|
34231
|
-
};
|
|
34232
|
-
};
|
|
34233
|
-
/** @description Not found */
|
|
34234
|
-
404: {
|
|
34235
|
-
headers: {
|
|
34236
|
-
[name: string]: unknown;
|
|
34237
|
-
};
|
|
34238
|
-
content: {
|
|
34239
|
-
"application/json": {
|
|
34240
|
-
code: string;
|
|
34241
|
-
message: string;
|
|
34242
|
-
links?: {
|
|
34243
|
-
docs: string;
|
|
34244
|
-
schema: string;
|
|
34245
|
-
};
|
|
34246
|
-
issues?: {
|
|
34247
|
-
message: string;
|
|
34248
|
-
path?: (string | number)[];
|
|
34249
|
-
schema?: string;
|
|
34250
|
-
}[];
|
|
34251
|
-
context?: unknown;
|
|
34252
|
-
};
|
|
34253
|
-
};
|
|
34254
|
-
};
|
|
34255
|
-
/** @description Internal server error */
|
|
34256
|
-
500: {
|
|
34257
|
-
headers: {
|
|
34258
|
-
[name: string]: unknown;
|
|
34259
|
-
};
|
|
34260
|
-
content: {
|
|
34261
|
-
"application/json": {
|
|
34262
|
-
code: string;
|
|
34263
|
-
message: string;
|
|
34264
|
-
links?: {
|
|
34265
|
-
docs: string;
|
|
34266
|
-
schema: string;
|
|
34267
|
-
};
|
|
34268
|
-
issues?: {
|
|
34269
|
-
message: string;
|
|
34270
|
-
path?: (string | number)[];
|
|
34271
|
-
schema?: string;
|
|
34272
|
-
}[];
|
|
34273
|
-
context?: unknown;
|
|
34274
|
-
};
|
|
34275
|
-
};
|
|
34276
|
-
};
|
|
34277
|
-
/** @description Service unavailable */
|
|
34278
|
-
503: {
|
|
34279
|
-
headers: {
|
|
34280
|
-
[name: string]: unknown;
|
|
34281
|
-
};
|
|
34282
|
-
content: {
|
|
34283
|
-
"application/json": {
|
|
34284
|
-
code: string;
|
|
34285
|
-
message: string;
|
|
34286
|
-
links?: {
|
|
34287
|
-
docs: string;
|
|
34288
|
-
schema: string;
|
|
34289
|
-
};
|
|
34290
|
-
issues?: {
|
|
34291
|
-
message: string;
|
|
34292
|
-
path?: (string | number)[];
|
|
34293
|
-
schema?: string;
|
|
34294
|
-
}[];
|
|
34295
|
-
context?: unknown;
|
|
34296
|
-
};
|
|
34297
|
-
};
|
|
34298
|
-
};
|
|
34299
|
-
};
|
|
34300
|
-
};
|
|
34301
|
-
getPaymentDeprecated: {
|
|
34302
|
-
parameters: {
|
|
34303
|
-
query?: never;
|
|
34304
|
-
header?: never;
|
|
34305
|
-
path: {
|
|
34306
|
-
id: string;
|
|
34307
|
-
};
|
|
34308
|
-
cookie?: never;
|
|
34309
|
-
};
|
|
34310
|
-
requestBody?: never;
|
|
34311
|
-
responses: {
|
|
34312
|
-
/** @description Successful response */
|
|
34313
|
-
200: {
|
|
34314
|
-
headers: {
|
|
34315
|
-
[name: string]: unknown;
|
|
34316
|
-
};
|
|
34317
|
-
content: {
|
|
34318
|
-
"application/json": {
|
|
34319
|
-
/** Format: uuid */
|
|
34320
|
-
id: string;
|
|
34321
|
-
amount: number;
|
|
34322
|
-
currency?: string | null;
|
|
34323
|
-
description?: string | null;
|
|
34324
|
-
date?: string | null;
|
|
34325
|
-
uniqueRef?: string | null;
|
|
34326
|
-
isReconciled?: boolean | null;
|
|
34327
|
-
metadata?: {
|
|
34328
|
-
[key: string]: unknown;
|
|
34329
|
-
};
|
|
34330
|
-
status?: string | null;
|
|
34331
|
-
type?: string | null;
|
|
34332
|
-
lines: {
|
|
34333
|
-
/** Format: uuid */
|
|
34334
|
-
id: string;
|
|
34335
|
-
uniqueRef?: string | null;
|
|
34336
|
-
type?: string | null;
|
|
34337
|
-
uniqueType?: string | null;
|
|
34338
|
-
description?: string | null;
|
|
34339
|
-
amount: number;
|
|
34340
|
-
originalAmount?: number | null;
|
|
34341
|
-
originalCurrency?: string | null;
|
|
34342
|
-
reservationId?: string | null;
|
|
34343
|
-
paymentId?: string | null;
|
|
34344
|
-
metadata?: {
|
|
34345
|
-
[key: string]: unknown;
|
|
34346
|
-
};
|
|
34347
|
-
listingId?: string | null;
|
|
34348
|
-
listing?: unknown;
|
|
34349
|
-
reservation?: unknown;
|
|
34350
|
-
}[];
|
|
34351
|
-
connection?: {
|
|
34352
|
-
/** Format: uuid */
|
|
34353
|
-
id: string;
|
|
34354
|
-
name?: string | null;
|
|
34355
|
-
type?: string | null;
|
|
34356
|
-
appId?: string | null;
|
|
34357
|
-
status?: string | null;
|
|
34358
|
-
} | null;
|
|
33800
|
+
/** Format: uuid */
|
|
33801
|
+
id: string;
|
|
33802
|
+
amount: number;
|
|
33803
|
+
currency?: string | null;
|
|
33804
|
+
description?: string | null;
|
|
33805
|
+
date?: string | null;
|
|
33806
|
+
uniqueRef?: string | null;
|
|
33807
|
+
isReconciled?: boolean | null;
|
|
33808
|
+
metadata?: {
|
|
33809
|
+
[key: string]: unknown;
|
|
33810
|
+
};
|
|
33811
|
+
status?: string | null;
|
|
33812
|
+
type?: string | null;
|
|
33813
|
+
lines: {
|
|
33814
|
+
/** Format: uuid */
|
|
33815
|
+
id: string;
|
|
33816
|
+
uniqueRef?: string | null;
|
|
33817
|
+
type?: string | null;
|
|
33818
|
+
uniqueType?: string | null;
|
|
33819
|
+
description?: string | null;
|
|
33820
|
+
amount: number;
|
|
33821
|
+
originalAmount?: number | null;
|
|
33822
|
+
originalCurrency?: string | null;
|
|
33823
|
+
reservationId?: string | null;
|
|
33824
|
+
paymentId?: string | null;
|
|
33825
|
+
metadata?: {
|
|
33826
|
+
[key: string]: unknown;
|
|
33827
|
+
};
|
|
33828
|
+
listingId?: string | null;
|
|
33829
|
+
listing?: unknown;
|
|
33830
|
+
reservation?: unknown;
|
|
33831
|
+
}[];
|
|
33832
|
+
connection?: {
|
|
33833
|
+
/** Format: uuid */
|
|
33834
|
+
id: string;
|
|
33835
|
+
name?: string | null;
|
|
33836
|
+
type?: string | null;
|
|
33837
|
+
appId?: string | null;
|
|
33838
|
+
status?: string | null;
|
|
33839
|
+
} | null;
|
|
34359
33840
|
};
|
|
34360
33841
|
};
|
|
34361
33842
|
};
|
|
@@ -38696,11 +38177,454 @@ export interface operations {
|
|
|
38696
38177
|
};
|
|
38697
38178
|
};
|
|
38698
38179
|
};
|
|
38699
|
-
getMe: {
|
|
38180
|
+
getMe: {
|
|
38181
|
+
parameters: {
|
|
38182
|
+
query?: {
|
|
38183
|
+
/** @description When the requested team is not accessible (membership removed, team deleted), resolve the default team instead of failing */
|
|
38184
|
+
allowTeamFallback?: boolean;
|
|
38185
|
+
};
|
|
38186
|
+
header?: never;
|
|
38187
|
+
path?: never;
|
|
38188
|
+
cookie?: never;
|
|
38189
|
+
};
|
|
38190
|
+
requestBody?: never;
|
|
38191
|
+
responses: {
|
|
38192
|
+
/** @description Successful response */
|
|
38193
|
+
200: {
|
|
38194
|
+
headers: {
|
|
38195
|
+
[name: string]: unknown;
|
|
38196
|
+
};
|
|
38197
|
+
content: {
|
|
38198
|
+
"application/json": {
|
|
38199
|
+
user: {
|
|
38200
|
+
/** Format: uuid */
|
|
38201
|
+
id: string;
|
|
38202
|
+
/** @enum {string} */
|
|
38203
|
+
type: "admin" | "user" | "owner";
|
|
38204
|
+
firstName?: string;
|
|
38205
|
+
lastName?: string;
|
|
38206
|
+
email: string | null;
|
|
38207
|
+
secondaryEmails: string[];
|
|
38208
|
+
phone?: string;
|
|
38209
|
+
/** Format: uuid */
|
|
38210
|
+
partnerId?: string;
|
|
38211
|
+
/**
|
|
38212
|
+
* Format: date-time
|
|
38213
|
+
* @description Timestamp string with date, time, milliseconds, and timezone.
|
|
38214
|
+
* @example 2024-01-15T12:30:00.000+00:00
|
|
38215
|
+
*/
|
|
38216
|
+
createdAt: string;
|
|
38217
|
+
};
|
|
38218
|
+
team: {
|
|
38219
|
+
/** Format: uuid */
|
|
38220
|
+
id: string;
|
|
38221
|
+
name: string | null;
|
|
38222
|
+
slug: string;
|
|
38223
|
+
/** @enum {string} */
|
|
38224
|
+
dataRegion: "ap" | "crunchy" | "eu" | "hostaway" | "us";
|
|
38225
|
+
/** Format: uri */
|
|
38226
|
+
apiBaseUrl: string;
|
|
38227
|
+
/** @enum {string} */
|
|
38228
|
+
type: "propertyManager" | "partner";
|
|
38229
|
+
partnerId: string | null;
|
|
38230
|
+
isGeneralLedger: boolean;
|
|
38231
|
+
/** @enum {string} */
|
|
38232
|
+
status: "active" | "inactive";
|
|
38233
|
+
isOnboarding: boolean;
|
|
38234
|
+
/**
|
|
38235
|
+
* Format: date-time
|
|
38236
|
+
* @description Timestamp string with date, time, milliseconds, and timezone.
|
|
38237
|
+
* @example 2024-01-15T12:30:00.000+00:00
|
|
38238
|
+
*/
|
|
38239
|
+
createdAt: string;
|
|
38240
|
+
/** @description Currency in ISO 4217 format, will be converted to lowercase */
|
|
38241
|
+
defaultCurrency: string;
|
|
38242
|
+
statementStartAt: string | null;
|
|
38243
|
+
effectiveStatementStartAt: string | null;
|
|
38244
|
+
booksClosedAt: string | null;
|
|
38245
|
+
defaultRevenueRecognition: ("checkIn" | "checkOut" | "bookedAt" | "proRata") | null;
|
|
38246
|
+
longTermStayNights: number | null;
|
|
38247
|
+
colorPrimary: string | null;
|
|
38248
|
+
logo: string | null;
|
|
38249
|
+
settings: {
|
|
38250
|
+
showVRPilotGuide: boolean;
|
|
38251
|
+
showReservations: boolean;
|
|
38252
|
+
showCancelledReservations: boolean;
|
|
38253
|
+
showReservationTotal: boolean;
|
|
38254
|
+
showOwnerCalendarBlocking: boolean;
|
|
38255
|
+
showTaxStatements: boolean;
|
|
38256
|
+
showTwoFactorAuth: boolean;
|
|
38257
|
+
};
|
|
38258
|
+
billingPartnerId: string | null;
|
|
38259
|
+
billingSubscriptionStatus: string | null;
|
|
38260
|
+
billingPaymentMethodType: string | null;
|
|
38261
|
+
trialUntil: string | null;
|
|
38262
|
+
cancelledAt: string | null;
|
|
38263
|
+
} | null;
|
|
38264
|
+
membership: {
|
|
38265
|
+
/** @enum {string} */
|
|
38266
|
+
role: "admin" | "user" | "owner" | "partner";
|
|
38267
|
+
notifications: {
|
|
38268
|
+
ownerStatementInReview: boolean;
|
|
38269
|
+
ownerStatementPublished: boolean;
|
|
38270
|
+
ownerInvited: boolean;
|
|
38271
|
+
memberInvited: boolean;
|
|
38272
|
+
};
|
|
38273
|
+
} | null;
|
|
38274
|
+
ownerAccess: {
|
|
38275
|
+
/** Format: uuid */
|
|
38276
|
+
contactId?: string;
|
|
38277
|
+
/** Format: uuid */
|
|
38278
|
+
ownerId?: string;
|
|
38279
|
+
/** @enum {string} */
|
|
38280
|
+
role: "admin" | "viewer";
|
|
38281
|
+
}[];
|
|
38282
|
+
features: string[];
|
|
38283
|
+
issues: {
|
|
38284
|
+
code: string;
|
|
38285
|
+
count: number;
|
|
38286
|
+
}[];
|
|
38287
|
+
frontendContext: {
|
|
38288
|
+
hasReservations: boolean;
|
|
38289
|
+
reservationId: string | null;
|
|
38290
|
+
hasPms: boolean;
|
|
38291
|
+
activePmsConnectionId: string | null;
|
|
38292
|
+
hasOwnerBlockingConnection: boolean;
|
|
38293
|
+
hasDeposit: boolean;
|
|
38294
|
+
depositTransactionId: string | null;
|
|
38295
|
+
hasListingNeedsReview: boolean;
|
|
38296
|
+
listingNeedsReviewId: string | null;
|
|
38297
|
+
hasOwners: boolean;
|
|
38298
|
+
hasOwnerNeedsReview: boolean;
|
|
38299
|
+
ownerNeedsReviewId: string | null;
|
|
38300
|
+
guideOnboardingStatus: ("skipped" | "completed") | null;
|
|
38301
|
+
} | null;
|
|
38302
|
+
partnerContext: {
|
|
38303
|
+
managedTeamRegions: {
|
|
38304
|
+
/** @enum {string} */
|
|
38305
|
+
dataRegion: "ap" | "crunchy" | "eu" | "hostaway" | "us";
|
|
38306
|
+
/** Format: uri */
|
|
38307
|
+
apiBaseUrl: string;
|
|
38308
|
+
counts: {
|
|
38309
|
+
active: number;
|
|
38310
|
+
inactive: number;
|
|
38311
|
+
};
|
|
38312
|
+
}[];
|
|
38313
|
+
} | null;
|
|
38314
|
+
};
|
|
38315
|
+
};
|
|
38316
|
+
};
|
|
38317
|
+
/** @description Bad request */
|
|
38318
|
+
400: {
|
|
38319
|
+
headers: {
|
|
38320
|
+
[name: string]: unknown;
|
|
38321
|
+
};
|
|
38322
|
+
content: {
|
|
38323
|
+
"application/json": {
|
|
38324
|
+
code: string;
|
|
38325
|
+
message: string;
|
|
38326
|
+
links?: {
|
|
38327
|
+
docs: string;
|
|
38328
|
+
schema: string;
|
|
38329
|
+
};
|
|
38330
|
+
issues?: {
|
|
38331
|
+
message: string;
|
|
38332
|
+
path?: (string | number)[];
|
|
38333
|
+
schema?: string;
|
|
38334
|
+
}[];
|
|
38335
|
+
context?: unknown;
|
|
38336
|
+
};
|
|
38337
|
+
};
|
|
38338
|
+
};
|
|
38339
|
+
/** @description Unauthorized */
|
|
38340
|
+
401: {
|
|
38341
|
+
headers: {
|
|
38342
|
+
[name: string]: unknown;
|
|
38343
|
+
};
|
|
38344
|
+
content: {
|
|
38345
|
+
"application/json": {
|
|
38346
|
+
code: string;
|
|
38347
|
+
message: string;
|
|
38348
|
+
links?: {
|
|
38349
|
+
docs: string;
|
|
38350
|
+
schema: string;
|
|
38351
|
+
};
|
|
38352
|
+
issues?: {
|
|
38353
|
+
message: string;
|
|
38354
|
+
path?: (string | number)[];
|
|
38355
|
+
schema?: string;
|
|
38356
|
+
}[];
|
|
38357
|
+
context?: unknown;
|
|
38358
|
+
};
|
|
38359
|
+
};
|
|
38360
|
+
};
|
|
38361
|
+
/** @description Forbidden */
|
|
38362
|
+
403: {
|
|
38363
|
+
headers: {
|
|
38364
|
+
[name: string]: unknown;
|
|
38365
|
+
};
|
|
38366
|
+
content: {
|
|
38367
|
+
"application/json": {
|
|
38368
|
+
code: string;
|
|
38369
|
+
message: string;
|
|
38370
|
+
links?: {
|
|
38371
|
+
docs: string;
|
|
38372
|
+
schema: string;
|
|
38373
|
+
};
|
|
38374
|
+
issues?: {
|
|
38375
|
+
message: string;
|
|
38376
|
+
path?: (string | number)[];
|
|
38377
|
+
schema?: string;
|
|
38378
|
+
}[];
|
|
38379
|
+
context?: unknown;
|
|
38380
|
+
};
|
|
38381
|
+
};
|
|
38382
|
+
};
|
|
38383
|
+
/** @description Not found */
|
|
38384
|
+
404: {
|
|
38385
|
+
headers: {
|
|
38386
|
+
[name: string]: unknown;
|
|
38387
|
+
};
|
|
38388
|
+
content: {
|
|
38389
|
+
"application/json": {
|
|
38390
|
+
code: string;
|
|
38391
|
+
message: string;
|
|
38392
|
+
links?: {
|
|
38393
|
+
docs: string;
|
|
38394
|
+
schema: string;
|
|
38395
|
+
};
|
|
38396
|
+
issues?: {
|
|
38397
|
+
message: string;
|
|
38398
|
+
path?: (string | number)[];
|
|
38399
|
+
schema?: string;
|
|
38400
|
+
}[];
|
|
38401
|
+
context?: unknown;
|
|
38402
|
+
};
|
|
38403
|
+
};
|
|
38404
|
+
};
|
|
38405
|
+
/** @description Internal server error */
|
|
38406
|
+
500: {
|
|
38407
|
+
headers: {
|
|
38408
|
+
[name: string]: unknown;
|
|
38409
|
+
};
|
|
38410
|
+
content: {
|
|
38411
|
+
"application/json": {
|
|
38412
|
+
code: string;
|
|
38413
|
+
message: string;
|
|
38414
|
+
links?: {
|
|
38415
|
+
docs: string;
|
|
38416
|
+
schema: string;
|
|
38417
|
+
};
|
|
38418
|
+
issues?: {
|
|
38419
|
+
message: string;
|
|
38420
|
+
path?: (string | number)[];
|
|
38421
|
+
schema?: string;
|
|
38422
|
+
}[];
|
|
38423
|
+
context?: unknown;
|
|
38424
|
+
};
|
|
38425
|
+
};
|
|
38426
|
+
};
|
|
38427
|
+
/** @description Service unavailable */
|
|
38428
|
+
503: {
|
|
38429
|
+
headers: {
|
|
38430
|
+
[name: string]: unknown;
|
|
38431
|
+
};
|
|
38432
|
+
content: {
|
|
38433
|
+
"application/json": {
|
|
38434
|
+
code: string;
|
|
38435
|
+
message: string;
|
|
38436
|
+
links?: {
|
|
38437
|
+
docs: string;
|
|
38438
|
+
schema: string;
|
|
38439
|
+
};
|
|
38440
|
+
issues?: {
|
|
38441
|
+
message: string;
|
|
38442
|
+
path?: (string | number)[];
|
|
38443
|
+
schema?: string;
|
|
38444
|
+
}[];
|
|
38445
|
+
context?: unknown;
|
|
38446
|
+
};
|
|
38447
|
+
};
|
|
38448
|
+
};
|
|
38449
|
+
};
|
|
38450
|
+
};
|
|
38451
|
+
updateMeNotifications: {
|
|
38452
|
+
parameters: {
|
|
38453
|
+
query?: never;
|
|
38454
|
+
header?: never;
|
|
38455
|
+
path?: never;
|
|
38456
|
+
cookie?: never;
|
|
38457
|
+
};
|
|
38458
|
+
requestBody?: {
|
|
38459
|
+
content: {
|
|
38460
|
+
"application/json": {
|
|
38461
|
+
ownerStatementInReview?: boolean;
|
|
38462
|
+
ownerStatementPublished?: boolean;
|
|
38463
|
+
ownerInvited?: boolean;
|
|
38464
|
+
memberInvited?: boolean;
|
|
38465
|
+
};
|
|
38466
|
+
};
|
|
38467
|
+
};
|
|
38468
|
+
responses: {
|
|
38469
|
+
/** @description Successful response */
|
|
38470
|
+
200: {
|
|
38471
|
+
headers: {
|
|
38472
|
+
[name: string]: unknown;
|
|
38473
|
+
};
|
|
38474
|
+
content: {
|
|
38475
|
+
"application/json": {
|
|
38476
|
+
ownerStatementInReview: boolean;
|
|
38477
|
+
ownerStatementPublished: boolean;
|
|
38478
|
+
ownerInvited: boolean;
|
|
38479
|
+
memberInvited: boolean;
|
|
38480
|
+
};
|
|
38481
|
+
};
|
|
38482
|
+
};
|
|
38483
|
+
/** @description Bad request */
|
|
38484
|
+
400: {
|
|
38485
|
+
headers: {
|
|
38486
|
+
[name: string]: unknown;
|
|
38487
|
+
};
|
|
38488
|
+
content: {
|
|
38489
|
+
"application/json": {
|
|
38490
|
+
code: string;
|
|
38491
|
+
message: string;
|
|
38492
|
+
links?: {
|
|
38493
|
+
docs: string;
|
|
38494
|
+
schema: string;
|
|
38495
|
+
};
|
|
38496
|
+
issues?: {
|
|
38497
|
+
message: string;
|
|
38498
|
+
path?: (string | number)[];
|
|
38499
|
+
schema?: string;
|
|
38500
|
+
}[];
|
|
38501
|
+
context?: unknown;
|
|
38502
|
+
};
|
|
38503
|
+
};
|
|
38504
|
+
};
|
|
38505
|
+
/** @description Unauthorized */
|
|
38506
|
+
401: {
|
|
38507
|
+
headers: {
|
|
38508
|
+
[name: string]: unknown;
|
|
38509
|
+
};
|
|
38510
|
+
content: {
|
|
38511
|
+
"application/json": {
|
|
38512
|
+
code: string;
|
|
38513
|
+
message: string;
|
|
38514
|
+
links?: {
|
|
38515
|
+
docs: string;
|
|
38516
|
+
schema: string;
|
|
38517
|
+
};
|
|
38518
|
+
issues?: {
|
|
38519
|
+
message: string;
|
|
38520
|
+
path?: (string | number)[];
|
|
38521
|
+
schema?: string;
|
|
38522
|
+
}[];
|
|
38523
|
+
context?: unknown;
|
|
38524
|
+
};
|
|
38525
|
+
};
|
|
38526
|
+
};
|
|
38527
|
+
/** @description Forbidden */
|
|
38528
|
+
403: {
|
|
38529
|
+
headers: {
|
|
38530
|
+
[name: string]: unknown;
|
|
38531
|
+
};
|
|
38532
|
+
content: {
|
|
38533
|
+
"application/json": {
|
|
38534
|
+
code: string;
|
|
38535
|
+
message: string;
|
|
38536
|
+
links?: {
|
|
38537
|
+
docs: string;
|
|
38538
|
+
schema: string;
|
|
38539
|
+
};
|
|
38540
|
+
issues?: {
|
|
38541
|
+
message: string;
|
|
38542
|
+
path?: (string | number)[];
|
|
38543
|
+
schema?: string;
|
|
38544
|
+
}[];
|
|
38545
|
+
context?: unknown;
|
|
38546
|
+
};
|
|
38547
|
+
};
|
|
38548
|
+
};
|
|
38549
|
+
/** @description Not found */
|
|
38550
|
+
404: {
|
|
38551
|
+
headers: {
|
|
38552
|
+
[name: string]: unknown;
|
|
38553
|
+
};
|
|
38554
|
+
content: {
|
|
38555
|
+
"application/json": {
|
|
38556
|
+
code: string;
|
|
38557
|
+
message: string;
|
|
38558
|
+
links?: {
|
|
38559
|
+
docs: string;
|
|
38560
|
+
schema: string;
|
|
38561
|
+
};
|
|
38562
|
+
issues?: {
|
|
38563
|
+
message: string;
|
|
38564
|
+
path?: (string | number)[];
|
|
38565
|
+
schema?: string;
|
|
38566
|
+
}[];
|
|
38567
|
+
context?: unknown;
|
|
38568
|
+
};
|
|
38569
|
+
};
|
|
38570
|
+
};
|
|
38571
|
+
/** @description Internal server error */
|
|
38572
|
+
500: {
|
|
38573
|
+
headers: {
|
|
38574
|
+
[name: string]: unknown;
|
|
38575
|
+
};
|
|
38576
|
+
content: {
|
|
38577
|
+
"application/json": {
|
|
38578
|
+
code: string;
|
|
38579
|
+
message: string;
|
|
38580
|
+
links?: {
|
|
38581
|
+
docs: string;
|
|
38582
|
+
schema: string;
|
|
38583
|
+
};
|
|
38584
|
+
issues?: {
|
|
38585
|
+
message: string;
|
|
38586
|
+
path?: (string | number)[];
|
|
38587
|
+
schema?: string;
|
|
38588
|
+
}[];
|
|
38589
|
+
context?: unknown;
|
|
38590
|
+
};
|
|
38591
|
+
};
|
|
38592
|
+
};
|
|
38593
|
+
/** @description Service unavailable */
|
|
38594
|
+
503: {
|
|
38595
|
+
headers: {
|
|
38596
|
+
[name: string]: unknown;
|
|
38597
|
+
};
|
|
38598
|
+
content: {
|
|
38599
|
+
"application/json": {
|
|
38600
|
+
code: string;
|
|
38601
|
+
message: string;
|
|
38602
|
+
links?: {
|
|
38603
|
+
docs: string;
|
|
38604
|
+
schema: string;
|
|
38605
|
+
};
|
|
38606
|
+
issues?: {
|
|
38607
|
+
message: string;
|
|
38608
|
+
path?: (string | number)[];
|
|
38609
|
+
schema?: string;
|
|
38610
|
+
}[];
|
|
38611
|
+
context?: unknown;
|
|
38612
|
+
};
|
|
38613
|
+
};
|
|
38614
|
+
};
|
|
38615
|
+
};
|
|
38616
|
+
};
|
|
38617
|
+
getMetricActiveListings: {
|
|
38700
38618
|
parameters: {
|
|
38701
38619
|
query?: {
|
|
38702
|
-
/** @description
|
|
38703
|
-
|
|
38620
|
+
/** @description Date boundary string. Accepted syntax: `YYYY`, `YYYY-MM`, or `YYYY-MM-DD`. Deprecated: use dateRange instead. */
|
|
38621
|
+
startDate?: string;
|
|
38622
|
+
/** @description Date boundary string. Accepted syntax: `YYYY`, `YYYY-MM`, or `YYYY-MM-DD`. Deprecated: use dateRange instead. */
|
|
38623
|
+
endDate?: string;
|
|
38624
|
+
/** @description Date range string. Accepted syntax: `YYYY`, `YYYY-MM`, `YYYY-MM-DD`, or range `YYYY-MM-DD...YYYY-MM-DD`. Single values expand to the full year, month, or day. */
|
|
38625
|
+
dateRange?: string;
|
|
38626
|
+
/** @description Whether the end date in `dateRange` or `paidAtRange` is treated as inclusive (`true`) or exclusive (`false`). */
|
|
38627
|
+
isDateRangeEndInclusive?: boolean;
|
|
38704
38628
|
};
|
|
38705
38629
|
header?: never;
|
|
38706
38630
|
path?: never;
|
|
@@ -38715,287 +38639,12 @@ export interface operations {
|
|
|
38715
38639
|
};
|
|
38716
38640
|
content: {
|
|
38717
38641
|
"application/json": {
|
|
38718
|
-
|
|
38719
|
-
|
|
38720
|
-
|
|
38721
|
-
|
|
38722
|
-
|
|
38723
|
-
firstName?: string;
|
|
38724
|
-
lastName?: string;
|
|
38725
|
-
email: string | null;
|
|
38726
|
-
secondaryEmails: string[];
|
|
38727
|
-
phone?: string;
|
|
38728
|
-
/** Format: uuid */
|
|
38729
|
-
partnerId?: string;
|
|
38730
|
-
/**
|
|
38731
|
-
* Format: date-time
|
|
38732
|
-
* @description Timestamp string with date, time, milliseconds, and timezone.
|
|
38733
|
-
* @example 2024-01-15T12:30:00.000+00:00
|
|
38734
|
-
*/
|
|
38735
|
-
createdAt: string;
|
|
38736
|
-
};
|
|
38737
|
-
team: {
|
|
38738
|
-
/** Format: uuid */
|
|
38739
|
-
id: string;
|
|
38740
|
-
name: string | null;
|
|
38741
|
-
slug: string;
|
|
38742
|
-
/** @enum {string} */
|
|
38743
|
-
dataRegion: "ap" | "crunchy" | "eu" | "hostaway" | "us";
|
|
38744
|
-
/** Format: uri */
|
|
38745
|
-
apiBaseUrl: string;
|
|
38746
|
-
/** @enum {string} */
|
|
38747
|
-
type: "propertyManager" | "partner";
|
|
38748
|
-
partnerId: string | null;
|
|
38749
|
-
isGeneralLedger: boolean;
|
|
38750
|
-
/** @enum {string} */
|
|
38751
|
-
status: "active" | "inactive";
|
|
38752
|
-
isOnboarding: boolean;
|
|
38753
|
-
/**
|
|
38754
|
-
* Format: date-time
|
|
38755
|
-
* @description Timestamp string with date, time, milliseconds, and timezone.
|
|
38756
|
-
* @example 2024-01-15T12:30:00.000+00:00
|
|
38757
|
-
*/
|
|
38758
|
-
createdAt: string;
|
|
38759
|
-
/** @description Currency in ISO 4217 format, will be converted to lowercase */
|
|
38760
|
-
defaultCurrency: string;
|
|
38761
|
-
statementStartAt: string | null;
|
|
38762
|
-
effectiveStatementStartAt: string | null;
|
|
38763
|
-
booksClosedAt: string | null;
|
|
38764
|
-
defaultRevenueRecognition: ("checkIn" | "checkOut" | "bookedAt" | "proRata") | null;
|
|
38765
|
-
longTermStayNights: number | null;
|
|
38766
|
-
colorPrimary: string | null;
|
|
38767
|
-
logo: string | null;
|
|
38768
|
-
settings: {
|
|
38769
|
-
showVRPilotGuide: boolean;
|
|
38770
|
-
showReservations: boolean;
|
|
38771
|
-
showCancelledReservations: boolean;
|
|
38772
|
-
showReservationTotal: boolean;
|
|
38773
|
-
showOwnerCalendarBlocking: boolean;
|
|
38774
|
-
showTaxStatements: boolean;
|
|
38775
|
-
showTwoFactorAuth: boolean;
|
|
38776
|
-
};
|
|
38777
|
-
billingPartnerId: string | null;
|
|
38778
|
-
billingSubscriptionStatus: string | null;
|
|
38779
|
-
billingPaymentMethodType: string | null;
|
|
38780
|
-
trialUntil: string | null;
|
|
38781
|
-
cancelledAt: string | null;
|
|
38782
|
-
} | null;
|
|
38783
|
-
membership: {
|
|
38784
|
-
/** @enum {string} */
|
|
38785
|
-
role: "admin" | "user" | "owner" | "partner";
|
|
38786
|
-
notifications: {
|
|
38787
|
-
ownerStatementInReview: boolean;
|
|
38788
|
-
ownerStatementPublished: boolean;
|
|
38789
|
-
ownerInvited: boolean;
|
|
38790
|
-
memberInvited: boolean;
|
|
38791
|
-
};
|
|
38792
|
-
} | null;
|
|
38793
|
-
ownerAccess: {
|
|
38794
|
-
/** Format: uuid */
|
|
38795
|
-
contactId?: string;
|
|
38796
|
-
/** Format: uuid */
|
|
38797
|
-
ownerId?: string;
|
|
38798
|
-
/** @enum {string} */
|
|
38799
|
-
role: "admin" | "viewer";
|
|
38800
|
-
}[];
|
|
38801
|
-
features: string[];
|
|
38802
|
-
issues: {
|
|
38803
|
-
code: string;
|
|
38804
|
-
count: number;
|
|
38805
|
-
}[];
|
|
38806
|
-
frontendContext: {
|
|
38807
|
-
hasReservations: boolean;
|
|
38808
|
-
reservationId: string | null;
|
|
38809
|
-
hasPms: boolean;
|
|
38810
|
-
activePmsConnectionId: string | null;
|
|
38811
|
-
hasOwnerBlockingConnection: boolean;
|
|
38812
|
-
hasDeposit: boolean;
|
|
38813
|
-
depositTransactionId: string | null;
|
|
38814
|
-
hasListingNeedsReview: boolean;
|
|
38815
|
-
listingNeedsReviewId: string | null;
|
|
38816
|
-
hasOwners: boolean;
|
|
38817
|
-
hasOwnerNeedsReview: boolean;
|
|
38818
|
-
ownerNeedsReviewId: string | null;
|
|
38819
|
-
guideOnboardingStatus: ("skipped" | "completed") | null;
|
|
38820
|
-
} | null;
|
|
38821
|
-
partnerContext: {
|
|
38822
|
-
managedTeamRegions: {
|
|
38823
|
-
/** @enum {string} */
|
|
38824
|
-
dataRegion: "ap" | "crunchy" | "eu" | "hostaway" | "us";
|
|
38825
|
-
/** Format: uri */
|
|
38826
|
-
apiBaseUrl: string;
|
|
38827
|
-
counts: {
|
|
38828
|
-
active: number;
|
|
38829
|
-
inactive: number;
|
|
38830
|
-
};
|
|
38831
|
-
}[];
|
|
38832
|
-
} | null;
|
|
38833
|
-
};
|
|
38834
|
-
};
|
|
38835
|
-
};
|
|
38836
|
-
/** @description Bad request */
|
|
38837
|
-
400: {
|
|
38838
|
-
headers: {
|
|
38839
|
-
[name: string]: unknown;
|
|
38840
|
-
};
|
|
38841
|
-
content: {
|
|
38842
|
-
"application/json": {
|
|
38843
|
-
code: string;
|
|
38844
|
-
message: string;
|
|
38845
|
-
links?: {
|
|
38846
|
-
docs: string;
|
|
38847
|
-
schema: string;
|
|
38848
|
-
};
|
|
38849
|
-
issues?: {
|
|
38850
|
-
message: string;
|
|
38851
|
-
path?: (string | number)[];
|
|
38852
|
-
schema?: string;
|
|
38853
|
-
}[];
|
|
38854
|
-
context?: unknown;
|
|
38855
|
-
};
|
|
38856
|
-
};
|
|
38857
|
-
};
|
|
38858
|
-
/** @description Unauthorized */
|
|
38859
|
-
401: {
|
|
38860
|
-
headers: {
|
|
38861
|
-
[name: string]: unknown;
|
|
38862
|
-
};
|
|
38863
|
-
content: {
|
|
38864
|
-
"application/json": {
|
|
38865
|
-
code: string;
|
|
38866
|
-
message: string;
|
|
38867
|
-
links?: {
|
|
38868
|
-
docs: string;
|
|
38869
|
-
schema: string;
|
|
38870
|
-
};
|
|
38871
|
-
issues?: {
|
|
38872
|
-
message: string;
|
|
38873
|
-
path?: (string | number)[];
|
|
38874
|
-
schema?: string;
|
|
38875
|
-
}[];
|
|
38876
|
-
context?: unknown;
|
|
38877
|
-
};
|
|
38878
|
-
};
|
|
38879
|
-
};
|
|
38880
|
-
/** @description Forbidden */
|
|
38881
|
-
403: {
|
|
38882
|
-
headers: {
|
|
38883
|
-
[name: string]: unknown;
|
|
38884
|
-
};
|
|
38885
|
-
content: {
|
|
38886
|
-
"application/json": {
|
|
38887
|
-
code: string;
|
|
38888
|
-
message: string;
|
|
38889
|
-
links?: {
|
|
38890
|
-
docs: string;
|
|
38891
|
-
schema: string;
|
|
38892
|
-
};
|
|
38893
|
-
issues?: {
|
|
38894
|
-
message: string;
|
|
38895
|
-
path?: (string | number)[];
|
|
38896
|
-
schema?: string;
|
|
38897
|
-
}[];
|
|
38898
|
-
context?: unknown;
|
|
38899
|
-
};
|
|
38900
|
-
};
|
|
38901
|
-
};
|
|
38902
|
-
/** @description Not found */
|
|
38903
|
-
404: {
|
|
38904
|
-
headers: {
|
|
38905
|
-
[name: string]: unknown;
|
|
38906
|
-
};
|
|
38907
|
-
content: {
|
|
38908
|
-
"application/json": {
|
|
38909
|
-
code: string;
|
|
38910
|
-
message: string;
|
|
38911
|
-
links?: {
|
|
38912
|
-
docs: string;
|
|
38913
|
-
schema: string;
|
|
38914
|
-
};
|
|
38915
|
-
issues?: {
|
|
38916
|
-
message: string;
|
|
38917
|
-
path?: (string | number)[];
|
|
38918
|
-
schema?: string;
|
|
38919
|
-
}[];
|
|
38920
|
-
context?: unknown;
|
|
38921
|
-
};
|
|
38922
|
-
};
|
|
38923
|
-
};
|
|
38924
|
-
/** @description Internal server error */
|
|
38925
|
-
500: {
|
|
38926
|
-
headers: {
|
|
38927
|
-
[name: string]: unknown;
|
|
38928
|
-
};
|
|
38929
|
-
content: {
|
|
38930
|
-
"application/json": {
|
|
38931
|
-
code: string;
|
|
38932
|
-
message: string;
|
|
38933
|
-
links?: {
|
|
38934
|
-
docs: string;
|
|
38935
|
-
schema: string;
|
|
38936
|
-
};
|
|
38937
|
-
issues?: {
|
|
38938
|
-
message: string;
|
|
38939
|
-
path?: (string | number)[];
|
|
38940
|
-
schema?: string;
|
|
38941
|
-
}[];
|
|
38942
|
-
context?: unknown;
|
|
38943
|
-
};
|
|
38944
|
-
};
|
|
38945
|
-
};
|
|
38946
|
-
/** @description Service unavailable */
|
|
38947
|
-
503: {
|
|
38948
|
-
headers: {
|
|
38949
|
-
[name: string]: unknown;
|
|
38950
|
-
};
|
|
38951
|
-
content: {
|
|
38952
|
-
"application/json": {
|
|
38953
|
-
code: string;
|
|
38954
|
-
message: string;
|
|
38955
|
-
links?: {
|
|
38956
|
-
docs: string;
|
|
38957
|
-
schema: string;
|
|
38958
|
-
};
|
|
38959
|
-
issues?: {
|
|
38960
|
-
message: string;
|
|
38961
|
-
path?: (string | number)[];
|
|
38962
|
-
schema?: string;
|
|
38642
|
+
data: {
|
|
38643
|
+
current: number;
|
|
38644
|
+
previous: number;
|
|
38645
|
+
delta: number;
|
|
38646
|
+
deltaPercentage: number | null;
|
|
38963
38647
|
}[];
|
|
38964
|
-
context?: unknown;
|
|
38965
|
-
};
|
|
38966
|
-
};
|
|
38967
|
-
};
|
|
38968
|
-
};
|
|
38969
|
-
};
|
|
38970
|
-
updateMeNotifications: {
|
|
38971
|
-
parameters: {
|
|
38972
|
-
query?: never;
|
|
38973
|
-
header?: never;
|
|
38974
|
-
path?: never;
|
|
38975
|
-
cookie?: never;
|
|
38976
|
-
};
|
|
38977
|
-
requestBody?: {
|
|
38978
|
-
content: {
|
|
38979
|
-
"application/json": {
|
|
38980
|
-
ownerStatementInReview?: boolean;
|
|
38981
|
-
ownerStatementPublished?: boolean;
|
|
38982
|
-
ownerInvited?: boolean;
|
|
38983
|
-
memberInvited?: boolean;
|
|
38984
|
-
};
|
|
38985
|
-
};
|
|
38986
|
-
};
|
|
38987
|
-
responses: {
|
|
38988
|
-
/** @description Successful response */
|
|
38989
|
-
200: {
|
|
38990
|
-
headers: {
|
|
38991
|
-
[name: string]: unknown;
|
|
38992
|
-
};
|
|
38993
|
-
content: {
|
|
38994
|
-
"application/json": {
|
|
38995
|
-
ownerStatementInReview: boolean;
|
|
38996
|
-
ownerStatementPublished: boolean;
|
|
38997
|
-
ownerInvited: boolean;
|
|
38998
|
-
memberInvited: boolean;
|
|
38999
38648
|
};
|
|
39000
38649
|
};
|
|
39001
38650
|
};
|
|
@@ -39133,7 +38782,7 @@ export interface operations {
|
|
|
39133
38782
|
};
|
|
39134
38783
|
};
|
|
39135
38784
|
};
|
|
39136
|
-
|
|
38785
|
+
getMetricAverageDailyRate: {
|
|
39137
38786
|
parameters: {
|
|
39138
38787
|
query?: {
|
|
39139
38788
|
/** @description Date boundary string. Accepted syntax: `YYYY`, `YYYY-MM`, or `YYYY-MM-DD`. Deprecated: use dateRange instead. */
|
|
@@ -39301,9 +38950,12 @@ export interface operations {
|
|
|
39301
38950
|
};
|
|
39302
38951
|
};
|
|
39303
38952
|
};
|
|
39304
|
-
|
|
38953
|
+
getMetricCashFlow: {
|
|
39305
38954
|
parameters: {
|
|
39306
38955
|
query?: {
|
|
38956
|
+
interval?: "month" | "week" | "day" | "year";
|
|
38957
|
+
/** @description Deprecated: use interval */
|
|
38958
|
+
dimension?: "month" | "week" | "day" | "year";
|
|
39307
38959
|
/** @description Date boundary string. Accepted syntax: `YYYY`, `YYYY-MM`, or `YYYY-MM-DD`. Deprecated: use dateRange instead. */
|
|
39308
38960
|
startDate?: string;
|
|
39309
38961
|
/** @description Date boundary string. Accepted syntax: `YYYY`, `YYYY-MM`, or `YYYY-MM-DD`. Deprecated: use dateRange instead. */
|
|
@@ -39327,10 +38979,10 @@ export interface operations {
|
|
|
39327
38979
|
content: {
|
|
39328
38980
|
"application/json": {
|
|
39329
38981
|
data: {
|
|
39330
|
-
|
|
39331
|
-
|
|
39332
|
-
|
|
39333
|
-
|
|
38982
|
+
date: string;
|
|
38983
|
+
inflow: number;
|
|
38984
|
+
outflow: number;
|
|
38985
|
+
netCashFlow: number;
|
|
39334
38986
|
}[];
|
|
39335
38987
|
};
|
|
39336
38988
|
};
|
|
@@ -39469,12 +39121,9 @@ export interface operations {
|
|
|
39469
39121
|
};
|
|
39470
39122
|
};
|
|
39471
39123
|
};
|
|
39472
|
-
|
|
39124
|
+
getMetricCheckinCounts: {
|
|
39473
39125
|
parameters: {
|
|
39474
39126
|
query?: {
|
|
39475
|
-
interval?: "month" | "week" | "day" | "year";
|
|
39476
|
-
/** @description Deprecated: use interval */
|
|
39477
|
-
dimension?: "month" | "week" | "day" | "year";
|
|
39478
39127
|
/** @description Date boundary string. Accepted syntax: `YYYY`, `YYYY-MM`, or `YYYY-MM-DD`. Deprecated: use dateRange instead. */
|
|
39479
39128
|
startDate?: string;
|
|
39480
39129
|
/** @description Date boundary string. Accepted syntax: `YYYY`, `YYYY-MM`, or `YYYY-MM-DD`. Deprecated: use dateRange instead. */
|
|
@@ -39498,10 +39147,10 @@ export interface operations {
|
|
|
39498
39147
|
content: {
|
|
39499
39148
|
"application/json": {
|
|
39500
39149
|
data: {
|
|
39501
|
-
|
|
39502
|
-
|
|
39503
|
-
|
|
39504
|
-
|
|
39150
|
+
current: number;
|
|
39151
|
+
previous: number;
|
|
39152
|
+
delta: number;
|
|
39153
|
+
deltaPercentage: number | null;
|
|
39505
39154
|
}[];
|
|
39506
39155
|
};
|
|
39507
39156
|
};
|
|
@@ -39640,9 +39289,12 @@ export interface operations {
|
|
|
39640
39289
|
};
|
|
39641
39290
|
};
|
|
39642
39291
|
};
|
|
39643
|
-
|
|
39292
|
+
getMetricFutureBookedRevenue: {
|
|
39644
39293
|
parameters: {
|
|
39645
39294
|
query?: {
|
|
39295
|
+
interval?: "month" | "week" | "day" | "year";
|
|
39296
|
+
/** @description Deprecated: use interval */
|
|
39297
|
+
dimension?: "month" | "week" | "day" | "year";
|
|
39646
39298
|
/** @description Date boundary string. Accepted syntax: `YYYY`, `YYYY-MM`, or `YYYY-MM-DD`. Deprecated: use dateRange instead. */
|
|
39647
39299
|
startDate?: string;
|
|
39648
39300
|
/** @description Date boundary string. Accepted syntax: `YYYY`, `YYYY-MM`, or `YYYY-MM-DD`. Deprecated: use dateRange instead. */
|
|
@@ -39666,10 +39318,9 @@ export interface operations {
|
|
|
39666
39318
|
content: {
|
|
39667
39319
|
"application/json": {
|
|
39668
39320
|
data: {
|
|
39669
|
-
|
|
39670
|
-
|
|
39671
|
-
|
|
39672
|
-
deltaPercentage: number | null;
|
|
39321
|
+
date: string;
|
|
39322
|
+
futureRevenue: number;
|
|
39323
|
+
bookedRevenue: number;
|
|
39673
39324
|
}[];
|
|
39674
39325
|
};
|
|
39675
39326
|
};
|
|
@@ -39808,9 +39459,10 @@ export interface operations {
|
|
|
39808
39459
|
};
|
|
39809
39460
|
};
|
|
39810
39461
|
};
|
|
39811
|
-
|
|
39462
|
+
getMetricJournalEntryTotalsByRecurringFee: {
|
|
39812
39463
|
parameters: {
|
|
39813
|
-
query
|
|
39464
|
+
query: {
|
|
39465
|
+
recurringFeeId: string;
|
|
39814
39466
|
interval?: "month" | "week" | "day" | "year";
|
|
39815
39467
|
/** @description Deprecated: use interval */
|
|
39816
39468
|
dimension?: "month" | "week" | "day" | "year";
|
|
@@ -39838,8 +39490,8 @@ export interface operations {
|
|
|
39838
39490
|
"application/json": {
|
|
39839
39491
|
data: {
|
|
39840
39492
|
date: string;
|
|
39841
|
-
|
|
39842
|
-
|
|
39493
|
+
count: number;
|
|
39494
|
+
amount: number;
|
|
39843
39495
|
}[];
|
|
39844
39496
|
};
|
|
39845
39497
|
};
|
|
@@ -39978,10 +39630,9 @@ export interface operations {
|
|
|
39978
39630
|
};
|
|
39979
39631
|
};
|
|
39980
39632
|
};
|
|
39981
|
-
|
|
39633
|
+
getMetricLegacyActiveListingCreated: {
|
|
39982
39634
|
parameters: {
|
|
39983
|
-
query
|
|
39984
|
-
recurringFeeId: string;
|
|
39635
|
+
query?: {
|
|
39985
39636
|
interval?: "month" | "week" | "day" | "year";
|
|
39986
39637
|
/** @description Deprecated: use interval */
|
|
39987
39638
|
dimension?: "month" | "week" | "day" | "year";
|
|
@@ -40009,8 +39660,7 @@ export interface operations {
|
|
|
40009
39660
|
"application/json": {
|
|
40010
39661
|
data: {
|
|
40011
39662
|
date: string;
|
|
40012
|
-
|
|
40013
|
-
amount: number;
|
|
39663
|
+
created: number;
|
|
40014
39664
|
}[];
|
|
40015
39665
|
};
|
|
40016
39666
|
};
|
|
@@ -40149,12 +39799,9 @@ export interface operations {
|
|
|
40149
39799
|
};
|
|
40150
39800
|
};
|
|
40151
39801
|
};
|
|
40152
|
-
|
|
39802
|
+
getMetricLegacyCurrencies: {
|
|
40153
39803
|
parameters: {
|
|
40154
39804
|
query?: {
|
|
40155
|
-
interval?: "month" | "week" | "day" | "year";
|
|
40156
|
-
/** @description Deprecated: use interval */
|
|
40157
|
-
dimension?: "month" | "week" | "day" | "year";
|
|
40158
39805
|
/** @description Date boundary string. Accepted syntax: `YYYY`, `YYYY-MM`, or `YYYY-MM-DD`. Deprecated: use dateRange instead. */
|
|
40159
39806
|
startDate?: string;
|
|
40160
39807
|
/** @description Date boundary string. Accepted syntax: `YYYY`, `YYYY-MM`, or `YYYY-MM-DD`. Deprecated: use dateRange instead. */
|
|
@@ -40178,8 +39825,7 @@ export interface operations {
|
|
|
40178
39825
|
content: {
|
|
40179
39826
|
"application/json": {
|
|
40180
39827
|
data: {
|
|
40181
|
-
|
|
40182
|
-
created: number;
|
|
39828
|
+
currency: string | null;
|
|
40183
39829
|
}[];
|
|
40184
39830
|
};
|
|
40185
39831
|
};
|
|
@@ -40318,9 +39964,12 @@ export interface operations {
|
|
|
40318
39964
|
};
|
|
40319
39965
|
};
|
|
40320
39966
|
};
|
|
40321
|
-
|
|
39967
|
+
getMetricLegacyPaymentVolume: {
|
|
40322
39968
|
parameters: {
|
|
40323
39969
|
query?: {
|
|
39970
|
+
interval?: "month" | "week" | "day" | "year";
|
|
39971
|
+
/** @description Deprecated: use interval */
|
|
39972
|
+
dimension?: "month" | "week" | "day" | "year";
|
|
40324
39973
|
/** @description Date boundary string. Accepted syntax: `YYYY`, `YYYY-MM`, or `YYYY-MM-DD`. Deprecated: use dateRange instead. */
|
|
40325
39974
|
startDate?: string;
|
|
40326
39975
|
/** @description Date boundary string. Accepted syntax: `YYYY`, `YYYY-MM`, or `YYYY-MM-DD`. Deprecated: use dateRange instead. */
|
|
@@ -40344,6 +39993,9 @@ export interface operations {
|
|
|
40344
39993
|
content: {
|
|
40345
39994
|
"application/json": {
|
|
40346
39995
|
data: {
|
|
39996
|
+
date: string;
|
|
39997
|
+
/** @description Decimal value in dollars (major currency units) */
|
|
39998
|
+
total: number;
|
|
40347
39999
|
currency: string | null;
|
|
40348
40000
|
}[];
|
|
40349
40001
|
};
|
|
@@ -40483,7 +40135,7 @@ export interface operations {
|
|
|
40483
40135
|
};
|
|
40484
40136
|
};
|
|
40485
40137
|
};
|
|
40486
|
-
|
|
40138
|
+
getMetricLegacyReservationDailyRate: {
|
|
40487
40139
|
parameters: {
|
|
40488
40140
|
query?: {
|
|
40489
40141
|
interval?: "month" | "week" | "day" | "year";
|
|
@@ -40513,8 +40165,7 @@ export interface operations {
|
|
|
40513
40165
|
"application/json": {
|
|
40514
40166
|
data: {
|
|
40515
40167
|
date: string;
|
|
40516
|
-
|
|
40517
|
-
total: number;
|
|
40168
|
+
rate: number;
|
|
40518
40169
|
currency: string | null;
|
|
40519
40170
|
}[];
|
|
40520
40171
|
};
|
|
@@ -40654,7 +40305,7 @@ export interface operations {
|
|
|
40654
40305
|
};
|
|
40655
40306
|
};
|
|
40656
40307
|
};
|
|
40657
|
-
|
|
40308
|
+
getMetricLegacyReservationVolume: {
|
|
40658
40309
|
parameters: {
|
|
40659
40310
|
query?: {
|
|
40660
40311
|
interval?: "month" | "week" | "day" | "year";
|
|
@@ -40684,7 +40335,8 @@ export interface operations {
|
|
|
40684
40335
|
"application/json": {
|
|
40685
40336
|
data: {
|
|
40686
40337
|
date: string;
|
|
40687
|
-
|
|
40338
|
+
/** @description Decimal value in dollars (major currency units) */
|
|
40339
|
+
total: number;
|
|
40688
40340
|
currency: string | null;
|
|
40689
40341
|
}[];
|
|
40690
40342
|
};
|
|
@@ -40824,9 +40476,11 @@ export interface operations {
|
|
|
40824
40476
|
};
|
|
40825
40477
|
};
|
|
40826
40478
|
};
|
|
40827
|
-
|
|
40479
|
+
getMetricListingRevenue: {
|
|
40828
40480
|
parameters: {
|
|
40829
|
-
query
|
|
40481
|
+
query: {
|
|
40482
|
+
listingId: string;
|
|
40483
|
+
party: "owners" | "manager";
|
|
40830
40484
|
interval?: "month" | "week" | "day" | "year";
|
|
40831
40485
|
/** @description Deprecated: use interval */
|
|
40832
40486
|
dimension?: "month" | "week" | "day" | "year";
|
|
@@ -40854,9 +40508,10 @@ export interface operations {
|
|
|
40854
40508
|
"application/json": {
|
|
40855
40509
|
data: {
|
|
40856
40510
|
date: string;
|
|
40857
|
-
|
|
40858
|
-
|
|
40859
|
-
|
|
40511
|
+
lockedRevenue?: number;
|
|
40512
|
+
unlockedRevenue: number;
|
|
40513
|
+
/** @description Currency in ISO 4217 format, will be converted to lowercase */
|
|
40514
|
+
currency: string;
|
|
40860
40515
|
}[];
|
|
40861
40516
|
};
|
|
40862
40517
|
};
|
|
@@ -40995,11 +40650,9 @@ export interface operations {
|
|
|
40995
40650
|
};
|
|
40996
40651
|
};
|
|
40997
40652
|
};
|
|
40998
|
-
|
|
40653
|
+
getMetricOccupancyRateOverTime: {
|
|
40999
40654
|
parameters: {
|
|
41000
|
-
query
|
|
41001
|
-
listingId: string;
|
|
41002
|
-
party: "owners" | "manager";
|
|
40655
|
+
query?: {
|
|
41003
40656
|
interval?: "month" | "week" | "day" | "year";
|
|
41004
40657
|
/** @description Deprecated: use interval */
|
|
41005
40658
|
dimension?: "month" | "week" | "day" | "year";
|
|
@@ -41027,10 +40680,9 @@ export interface operations {
|
|
|
41027
40680
|
"application/json": {
|
|
41028
40681
|
data: {
|
|
41029
40682
|
date: string;
|
|
41030
|
-
|
|
41031
|
-
|
|
41032
|
-
|
|
41033
|
-
currency: string;
|
|
40683
|
+
occupiedNights: number;
|
|
40684
|
+
availableNights: number;
|
|
40685
|
+
occupancyRate: number;
|
|
41034
40686
|
}[];
|
|
41035
40687
|
};
|
|
41036
40688
|
};
|
|
@@ -41169,12 +40821,10 @@ export interface operations {
|
|
|
41169
40821
|
};
|
|
41170
40822
|
};
|
|
41171
40823
|
};
|
|
41172
|
-
|
|
40824
|
+
getMetricOwnerRevenue: {
|
|
41173
40825
|
parameters: {
|
|
41174
|
-
query
|
|
41175
|
-
|
|
41176
|
-
/** @description Deprecated: use interval */
|
|
41177
|
-
dimension?: "month" | "week" | "day" | "year";
|
|
40826
|
+
query: {
|
|
40827
|
+
ownerId: string;
|
|
41178
40828
|
/** @description Date boundary string. Accepted syntax: `YYYY`, `YYYY-MM`, or `YYYY-MM-DD`. Deprecated: use dateRange instead. */
|
|
41179
40829
|
startDate?: string;
|
|
41180
40830
|
/** @description Date boundary string. Accepted syntax: `YYYY`, `YYYY-MM`, or `YYYY-MM-DD`. Deprecated: use dateRange instead. */
|
|
@@ -41183,6 +40833,8 @@ export interface operations {
|
|
|
41183
40833
|
dateRange?: string;
|
|
41184
40834
|
/** @description Whether the end date in `dateRange` or `paidAtRange` is treated as inclusive (`true`) or exclusive (`false`). */
|
|
41185
40835
|
isDateRangeEndInclusive?: boolean;
|
|
40836
|
+
/** @description Currency in ISO 4217 format, will be converted to lowercase */
|
|
40837
|
+
currency?: string;
|
|
41186
40838
|
};
|
|
41187
40839
|
header?: never;
|
|
41188
40840
|
path?: never;
|
|
@@ -41199,9 +40851,8 @@ export interface operations {
|
|
|
41199
40851
|
"application/json": {
|
|
41200
40852
|
data: {
|
|
41201
40853
|
date: string;
|
|
41202
|
-
|
|
41203
|
-
|
|
41204
|
-
occupancyRate: number;
|
|
40854
|
+
lockedRevenue: number;
|
|
40855
|
+
unlockedRevenue: number;
|
|
41205
40856
|
}[];
|
|
41206
40857
|
};
|
|
41207
40858
|
};
|
|
@@ -41340,10 +40991,9 @@ export interface operations {
|
|
|
41340
40991
|
};
|
|
41341
40992
|
};
|
|
41342
40993
|
};
|
|
41343
|
-
|
|
40994
|
+
getMetricReservationCount: {
|
|
41344
40995
|
parameters: {
|
|
41345
|
-
query
|
|
41346
|
-
ownerId: string;
|
|
40996
|
+
query?: {
|
|
41347
40997
|
/** @description Date boundary string. Accepted syntax: `YYYY`, `YYYY-MM`, or `YYYY-MM-DD`. Deprecated: use dateRange instead. */
|
|
41348
40998
|
startDate?: string;
|
|
41349
40999
|
/** @description Date boundary string. Accepted syntax: `YYYY`, `YYYY-MM`, or `YYYY-MM-DD`. Deprecated: use dateRange instead. */
|
|
@@ -41352,8 +41002,6 @@ export interface operations {
|
|
|
41352
41002
|
dateRange?: string;
|
|
41353
41003
|
/** @description Whether the end date in `dateRange` or `paidAtRange` is treated as inclusive (`true`) or exclusive (`false`). */
|
|
41354
41004
|
isDateRangeEndInclusive?: boolean;
|
|
41355
|
-
/** @description Currency in ISO 4217 format, will be converted to lowercase */
|
|
41356
|
-
currency?: string;
|
|
41357
41005
|
};
|
|
41358
41006
|
header?: never;
|
|
41359
41007
|
path?: never;
|
|
@@ -41369,9 +41017,10 @@ export interface operations {
|
|
|
41369
41017
|
content: {
|
|
41370
41018
|
"application/json": {
|
|
41371
41019
|
data: {
|
|
41372
|
-
|
|
41373
|
-
|
|
41374
|
-
|
|
41020
|
+
current: number;
|
|
41021
|
+
previous: number;
|
|
41022
|
+
delta: number;
|
|
41023
|
+
deltaPercentage: number | null;
|
|
41375
41024
|
}[];
|
|
41376
41025
|
};
|
|
41377
41026
|
};
|
|
@@ -41510,13 +41159,12 @@ export interface operations {
|
|
|
41510
41159
|
};
|
|
41511
41160
|
};
|
|
41512
41161
|
};
|
|
41513
|
-
|
|
41162
|
+
getMetricReservationVolume: {
|
|
41514
41163
|
parameters: {
|
|
41515
41164
|
query?: {
|
|
41516
|
-
|
|
41517
|
-
|
|
41518
|
-
|
|
41519
|
-
endDate?: string;
|
|
41165
|
+
interval?: "month" | "week" | "day" | "year";
|
|
41166
|
+
/** @description Deprecated: use interval */
|
|
41167
|
+
dimension?: "month" | "week" | "day" | "year";
|
|
41520
41168
|
/** @description Date range string. Accepted syntax: `YYYY`, `YYYY-MM`, `YYYY-MM-DD`, or range `YYYY-MM-DD...YYYY-MM-DD`. Single values expand to the full year, month, or day. */
|
|
41521
41169
|
dateRange?: string;
|
|
41522
41170
|
/** @description Whether the end date in `dateRange` or `paidAtRange` is treated as inclusive (`true`) or exclusive (`false`). */
|
|
@@ -41536,10 +41184,10 @@ export interface operations {
|
|
|
41536
41184
|
content: {
|
|
41537
41185
|
"application/json": {
|
|
41538
41186
|
data: {
|
|
41539
|
-
|
|
41540
|
-
|
|
41541
|
-
|
|
41542
|
-
|
|
41187
|
+
currency: string | null;
|
|
41188
|
+
date: string;
|
|
41189
|
+
/** @description Decimal value in dollars (major currency units) */
|
|
41190
|
+
amount: number;
|
|
41543
41191
|
}[];
|
|
41544
41192
|
};
|
|
41545
41193
|
};
|
|
@@ -41678,12 +41326,16 @@ export interface operations {
|
|
|
41678
41326
|
};
|
|
41679
41327
|
};
|
|
41680
41328
|
};
|
|
41681
|
-
|
|
41329
|
+
getMetricRevenue: {
|
|
41682
41330
|
parameters: {
|
|
41683
41331
|
query?: {
|
|
41684
41332
|
interval?: "month" | "week" | "day" | "year";
|
|
41685
41333
|
/** @description Deprecated: use interval */
|
|
41686
41334
|
dimension?: "month" | "week" | "day" | "year";
|
|
41335
|
+
/** @description Date boundary string. Accepted syntax: `YYYY`, `YYYY-MM`, or `YYYY-MM-DD`. Deprecated: use dateRange instead. */
|
|
41336
|
+
startDate?: string;
|
|
41337
|
+
/** @description Date boundary string. Accepted syntax: `YYYY`, `YYYY-MM`, or `YYYY-MM-DD`. Deprecated: use dateRange instead. */
|
|
41338
|
+
endDate?: string;
|
|
41687
41339
|
/** @description Date range string. Accepted syntax: `YYYY`, `YYYY-MM`, `YYYY-MM-DD`, or range `YYYY-MM-DD...YYYY-MM-DD`. Single values expand to the full year, month, or day. */
|
|
41688
41340
|
dateRange?: string;
|
|
41689
41341
|
/** @description Whether the end date in `dateRange` or `paidAtRange` is treated as inclusive (`true`) or exclusive (`false`). */
|
|
@@ -41703,10 +41355,9 @@ export interface operations {
|
|
|
41703
41355
|
content: {
|
|
41704
41356
|
"application/json": {
|
|
41705
41357
|
data: {
|
|
41706
|
-
currency: string | null;
|
|
41707
41358
|
date: string;
|
|
41708
|
-
|
|
41709
|
-
|
|
41359
|
+
grossGuestRevenue: number;
|
|
41360
|
+
pmRevenue: number;
|
|
41710
41361
|
}[];
|
|
41711
41362
|
};
|
|
41712
41363
|
};
|
|
@@ -41845,16 +41496,14 @@ export interface operations {
|
|
|
41845
41496
|
};
|
|
41846
41497
|
};
|
|
41847
41498
|
};
|
|
41848
|
-
|
|
41499
|
+
getSyncMetricsByStatus: {
|
|
41849
41500
|
parameters: {
|
|
41850
|
-
query
|
|
41501
|
+
query: {
|
|
41851
41502
|
interval?: "month" | "week" | "day" | "year";
|
|
41852
41503
|
/** @description Deprecated: use interval */
|
|
41853
41504
|
dimension?: "month" | "week" | "day" | "year";
|
|
41854
|
-
|
|
41855
|
-
|
|
41856
|
-
/** @description Date boundary string. Accepted syntax: `YYYY`, `YYYY-MM`, or `YYYY-MM-DD`. Deprecated: use dateRange instead. */
|
|
41857
|
-
endDate?: string;
|
|
41505
|
+
connectionId: string;
|
|
41506
|
+
view: "automate" | "extract";
|
|
41858
41507
|
/** @description Date range string. Accepted syntax: `YYYY`, `YYYY-MM`, `YYYY-MM-DD`, or range `YYYY-MM-DD...YYYY-MM-DD`. Single values expand to the full year, month, or day. */
|
|
41859
41508
|
dateRange?: string;
|
|
41860
41509
|
/** @description Whether the end date in `dateRange` or `paidAtRange` is treated as inclusive (`true`) or exclusive (`false`). */
|
|
@@ -41875,8 +41524,21 @@ export interface operations {
|
|
|
41875
41524
|
"application/json": {
|
|
41876
41525
|
data: {
|
|
41877
41526
|
date: string;
|
|
41878
|
-
|
|
41879
|
-
|
|
41527
|
+
total: number;
|
|
41528
|
+
changes: {
|
|
41529
|
+
completed?: {
|
|
41530
|
+
[key: string]: number;
|
|
41531
|
+
};
|
|
41532
|
+
skipped?: {
|
|
41533
|
+
[key: string]: number;
|
|
41534
|
+
};
|
|
41535
|
+
failed?: {
|
|
41536
|
+
[key: string]: number;
|
|
41537
|
+
};
|
|
41538
|
+
queued?: {
|
|
41539
|
+
[key: string]: number;
|
|
41540
|
+
};
|
|
41541
|
+
};
|
|
41880
41542
|
}[];
|
|
41881
41543
|
};
|
|
41882
41544
|
};
|
|
@@ -42015,14 +41677,16 @@ export interface operations {
|
|
|
42015
41677
|
};
|
|
42016
41678
|
};
|
|
42017
41679
|
};
|
|
42018
|
-
|
|
41680
|
+
getMetricTakeRate: {
|
|
42019
41681
|
parameters: {
|
|
42020
|
-
query
|
|
41682
|
+
query?: {
|
|
42021
41683
|
interval?: "month" | "week" | "day" | "year";
|
|
42022
41684
|
/** @description Deprecated: use interval */
|
|
42023
41685
|
dimension?: "month" | "week" | "day" | "year";
|
|
42024
|
-
|
|
42025
|
-
|
|
41686
|
+
/** @description Date boundary string. Accepted syntax: `YYYY`, `YYYY-MM`, or `YYYY-MM-DD`. Deprecated: use dateRange instead. */
|
|
41687
|
+
startDate?: string;
|
|
41688
|
+
/** @description Date boundary string. Accepted syntax: `YYYY`, `YYYY-MM`, or `YYYY-MM-DD`. Deprecated: use dateRange instead. */
|
|
41689
|
+
endDate?: string;
|
|
42026
41690
|
/** @description Date range string. Accepted syntax: `YYYY`, `YYYY-MM`, `YYYY-MM-DD`, or range `YYYY-MM-DD...YYYY-MM-DD`. Single values expand to the full year, month, or day. */
|
|
42027
41691
|
dateRange?: string;
|
|
42028
41692
|
/** @description Whether the end date in `dateRange` or `paidAtRange` is treated as inclusive (`true`) or exclusive (`false`). */
|
|
@@ -42043,21 +41707,9 @@ export interface operations {
|
|
|
42043
41707
|
"application/json": {
|
|
42044
41708
|
data: {
|
|
42045
41709
|
date: string;
|
|
42046
|
-
|
|
42047
|
-
|
|
42048
|
-
|
|
42049
|
-
[key: string]: number;
|
|
42050
|
-
};
|
|
42051
|
-
skipped?: {
|
|
42052
|
-
[key: string]: number;
|
|
42053
|
-
};
|
|
42054
|
-
failed?: {
|
|
42055
|
-
[key: string]: number;
|
|
42056
|
-
};
|
|
42057
|
-
queued?: {
|
|
42058
|
-
[key: string]: number;
|
|
42059
|
-
};
|
|
42060
|
-
};
|
|
41710
|
+
grossGuestRevenue: number;
|
|
41711
|
+
pmRevenue: number;
|
|
41712
|
+
takeRate: number;
|
|
42061
41713
|
}[];
|
|
42062
41714
|
};
|
|
42063
41715
|
};
|
|
@@ -42196,21 +41848,9 @@ export interface operations {
|
|
|
42196
41848
|
};
|
|
42197
41849
|
};
|
|
42198
41850
|
};
|
|
42199
|
-
|
|
41851
|
+
getPartner: {
|
|
42200
41852
|
parameters: {
|
|
42201
|
-
query?:
|
|
42202
|
-
interval?: "month" | "week" | "day" | "year";
|
|
42203
|
-
/** @description Deprecated: use interval */
|
|
42204
|
-
dimension?: "month" | "week" | "day" | "year";
|
|
42205
|
-
/** @description Date boundary string. Accepted syntax: `YYYY`, `YYYY-MM`, or `YYYY-MM-DD`. Deprecated: use dateRange instead. */
|
|
42206
|
-
startDate?: string;
|
|
42207
|
-
/** @description Date boundary string. Accepted syntax: `YYYY`, `YYYY-MM`, or `YYYY-MM-DD`. Deprecated: use dateRange instead. */
|
|
42208
|
-
endDate?: string;
|
|
42209
|
-
/** @description Date range string. Accepted syntax: `YYYY`, `YYYY-MM`, `YYYY-MM-DD`, or range `YYYY-MM-DD...YYYY-MM-DD`. Single values expand to the full year, month, or day. */
|
|
42210
|
-
dateRange?: string;
|
|
42211
|
-
/** @description Whether the end date in `dateRange` or `paidAtRange` is treated as inclusive (`true`) or exclusive (`false`). */
|
|
42212
|
-
isDateRangeEndInclusive?: boolean;
|
|
42213
|
-
};
|
|
41853
|
+
query?: never;
|
|
42214
41854
|
header?: never;
|
|
42215
41855
|
path?: never;
|
|
42216
41856
|
cookie?: never;
|
|
@@ -42224,12 +41864,11 @@ export interface operations {
|
|
|
42224
41864
|
};
|
|
42225
41865
|
content: {
|
|
42226
41866
|
"application/json": {
|
|
42227
|
-
|
|
42228
|
-
|
|
42229
|
-
|
|
42230
|
-
|
|
42231
|
-
|
|
42232
|
-
}[];
|
|
41867
|
+
/** Format: uuid */
|
|
41868
|
+
id: string;
|
|
41869
|
+
name: string;
|
|
41870
|
+
/** @constant */
|
|
41871
|
+
type: "partner";
|
|
42233
41872
|
};
|
|
42234
41873
|
};
|
|
42235
41874
|
};
|
|
@@ -42367,10 +42006,27 @@ export interface operations {
|
|
|
42367
42006
|
};
|
|
42368
42007
|
};
|
|
42369
42008
|
};
|
|
42370
|
-
|
|
42009
|
+
getPartnerBilling: {
|
|
42371
42010
|
parameters: {
|
|
42372
|
-
query
|
|
42373
|
-
|
|
42011
|
+
query: {
|
|
42012
|
+
/** @description Month string in format `YYYY-MM`. */
|
|
42013
|
+
month: string;
|
|
42014
|
+
/** @description Filter by team or company name */
|
|
42015
|
+
search?: string;
|
|
42016
|
+
status?: "active" | "inactive" | "onboarding";
|
|
42017
|
+
partnerId?: string;
|
|
42018
|
+
product?: "vrtrust" | "vrintegrations";
|
|
42019
|
+
billingPlan?: string;
|
|
42020
|
+
/** @description Sort field; prefix with - for descending order */
|
|
42021
|
+
sort?: "name" | "-name" | "created" | "-created" | "partnerName" | "-partnerName" | "product" | "-product" | "activeListings" | "-activeListings" | "billingPlan" | "-billingPlan";
|
|
42022
|
+
limit?: number;
|
|
42023
|
+
page?: number;
|
|
42024
|
+
offset?: number;
|
|
42025
|
+
};
|
|
42026
|
+
header?: {
|
|
42027
|
+
/** @description Selects the regional data partition for this regional collection read. It does not change the authenticated team context. */
|
|
42028
|
+
"x-data-region"?: "ap" | "crunchy" | "eu" | "hostaway" | "us";
|
|
42029
|
+
};
|
|
42374
42030
|
path?: never;
|
|
42375
42031
|
cookie?: never;
|
|
42376
42032
|
};
|
|
@@ -42383,11 +42039,46 @@ export interface operations {
|
|
|
42383
42039
|
};
|
|
42384
42040
|
content: {
|
|
42385
42041
|
"application/json": {
|
|
42386
|
-
|
|
42387
|
-
|
|
42388
|
-
|
|
42389
|
-
|
|
42390
|
-
|
|
42042
|
+
data: {
|
|
42043
|
+
/** Format: uuid */
|
|
42044
|
+
id: string;
|
|
42045
|
+
name: string | null;
|
|
42046
|
+
logo: string | null;
|
|
42047
|
+
/** @enum {string} */
|
|
42048
|
+
status: "active" | "inactive" | "deleted";
|
|
42049
|
+
/** @constant */
|
|
42050
|
+
type: "propertyManager";
|
|
42051
|
+
isOnboarding: boolean;
|
|
42052
|
+
isBillable: boolean | null;
|
|
42053
|
+
isGeneralLedger: boolean | null;
|
|
42054
|
+
partner: {
|
|
42055
|
+
/** Format: uuid */
|
|
42056
|
+
id: string;
|
|
42057
|
+
name: string;
|
|
42058
|
+
} | null;
|
|
42059
|
+
billingPartner: {
|
|
42060
|
+
/** Format: uuid */
|
|
42061
|
+
id: string;
|
|
42062
|
+
name: string;
|
|
42063
|
+
} | null;
|
|
42064
|
+
billingCustomerId: string | null;
|
|
42065
|
+
billingSubscriptionStatus: string | null;
|
|
42066
|
+
intercomId: string | null;
|
|
42067
|
+
billingPlan: string | null;
|
|
42068
|
+
migratedFromTenantId: string | null;
|
|
42069
|
+
createdAt: string | null;
|
|
42070
|
+
cancelledAt: string | null;
|
|
42071
|
+
activeListings: number;
|
|
42072
|
+
}[];
|
|
42073
|
+
pagination: {
|
|
42074
|
+
/** @default 100 */
|
|
42075
|
+
limit: number;
|
|
42076
|
+
/** @default 1 */
|
|
42077
|
+
page: number;
|
|
42078
|
+
total: number;
|
|
42079
|
+
totalPage: number;
|
|
42080
|
+
nextPage?: number;
|
|
42081
|
+
};
|
|
42391
42082
|
};
|
|
42392
42083
|
};
|
|
42393
42084
|
};
|
|
@@ -42525,19 +42216,18 @@ export interface operations {
|
|
|
42525
42216
|
};
|
|
42526
42217
|
};
|
|
42527
42218
|
};
|
|
42528
|
-
|
|
42219
|
+
getPartnerConnections: {
|
|
42529
42220
|
parameters: {
|
|
42530
|
-
query
|
|
42531
|
-
/** @description Month string in format `YYYY-MM`. */
|
|
42532
|
-
month: string;
|
|
42221
|
+
query?: {
|
|
42533
42222
|
/** @description Filter by team or company name */
|
|
42534
42223
|
search?: string;
|
|
42535
42224
|
status?: "active" | "inactive" | "onboarding";
|
|
42536
|
-
|
|
42537
|
-
|
|
42538
|
-
|
|
42225
|
+
/** @description Filter teams with an active connection to this app */
|
|
42226
|
+
appId?: string;
|
|
42227
|
+
/** @description Filter teams by whether an active connection is in error */
|
|
42228
|
+
isErrorState?: boolean;
|
|
42539
42229
|
/** @description Sort field; prefix with - for descending order */
|
|
42540
|
-
sort?: "name" | "-name" | "
|
|
42230
|
+
sort?: "name" | "-name" | "createdAt" | "-createdAt";
|
|
42541
42231
|
limit?: number;
|
|
42542
42232
|
page?: number;
|
|
42543
42233
|
offset?: number;
|
|
@@ -42561,33 +42251,47 @@ export interface operations {
|
|
|
42561
42251
|
data: {
|
|
42562
42252
|
/** Format: uuid */
|
|
42563
42253
|
id: string;
|
|
42564
|
-
name: string
|
|
42565
|
-
logo
|
|
42254
|
+
name: string;
|
|
42255
|
+
logo?: string;
|
|
42256
|
+
/**
|
|
42257
|
+
* Format: date-time
|
|
42258
|
+
* @description Timestamp string with date, time, milliseconds, and timezone.
|
|
42259
|
+
* @example 2024-01-15T12:30:00.000+00:00
|
|
42260
|
+
*/
|
|
42261
|
+
createdAt: string;
|
|
42566
42262
|
/** @enum {string} */
|
|
42567
|
-
status: "active" | "inactive"
|
|
42568
|
-
/** @constant */
|
|
42569
|
-
type: "propertyManager";
|
|
42263
|
+
status: "active" | "inactive";
|
|
42570
42264
|
isOnboarding: boolean;
|
|
42571
|
-
|
|
42572
|
-
isGeneralLedger: boolean | null;
|
|
42573
|
-
partner: {
|
|
42574
|
-
/** Format: uuid */
|
|
42575
|
-
id: string;
|
|
42576
|
-
name: string;
|
|
42577
|
-
} | null;
|
|
42578
|
-
billingPartner: {
|
|
42265
|
+
connections: {
|
|
42579
42266
|
/** Format: uuid */
|
|
42580
42267
|
id: string;
|
|
42581
42268
|
name: string;
|
|
42582
|
-
|
|
42583
|
-
|
|
42584
|
-
|
|
42585
|
-
|
|
42586
|
-
|
|
42587
|
-
|
|
42588
|
-
|
|
42589
|
-
|
|
42590
|
-
|
|
42269
|
+
isErrorState: boolean;
|
|
42270
|
+
app: {
|
|
42271
|
+
id: string;
|
|
42272
|
+
name: string;
|
|
42273
|
+
icon: string | null;
|
|
42274
|
+
/** @enum {string} */
|
|
42275
|
+
category: "paymentGateway" | "accountingPlatform" | "propertyManagementSystem" | "bookingChannel" | "service";
|
|
42276
|
+
};
|
|
42277
|
+
currentSync: {
|
|
42278
|
+
/** @enum {string} */
|
|
42279
|
+
status: "queued" | "started" | "completed" | "failed" | "canceled";
|
|
42280
|
+
/**
|
|
42281
|
+
* Format: date-time
|
|
42282
|
+
* @description Timestamp string with date, time, milliseconds, and timezone.
|
|
42283
|
+
* @example 2024-01-15T12:30:00.000+00:00
|
|
42284
|
+
*/
|
|
42285
|
+
createdAt: string;
|
|
42286
|
+
/**
|
|
42287
|
+
* Format: date-time
|
|
42288
|
+
* @description Timestamp string with date, time, milliseconds, and timezone.
|
|
42289
|
+
* @example 2024-01-15T12:30:00.000+00:00
|
|
42290
|
+
*/
|
|
42291
|
+
updatedAt: string;
|
|
42292
|
+
message?: string | null;
|
|
42293
|
+
} | null;
|
|
42294
|
+
}[];
|
|
42591
42295
|
}[];
|
|
42592
42296
|
pagination: {
|
|
42593
42297
|
/** @default 100 */
|
|
@@ -42735,92 +42439,75 @@ export interface operations {
|
|
|
42735
42439
|
};
|
|
42736
42440
|
};
|
|
42737
42441
|
};
|
|
42738
|
-
|
|
42442
|
+
createEmbedSession: {
|
|
42739
42443
|
parameters: {
|
|
42740
|
-
query?:
|
|
42741
|
-
|
|
42742
|
-
search?: string;
|
|
42743
|
-
status?: "active" | "inactive" | "onboarding";
|
|
42744
|
-
/** @description Filter teams with an active connection to this app */
|
|
42745
|
-
appId?: string;
|
|
42746
|
-
/** @description Filter teams by whether an active connection is in error */
|
|
42747
|
-
isErrorState?: boolean;
|
|
42748
|
-
/** @description Sort field; prefix with - for descending order */
|
|
42749
|
-
sort?: "name" | "-name" | "createdAt" | "-createdAt";
|
|
42750
|
-
limit?: number;
|
|
42751
|
-
page?: number;
|
|
42752
|
-
offset?: number;
|
|
42753
|
-
};
|
|
42754
|
-
header?: {
|
|
42755
|
-
/** @description Selects the regional data partition for this regional collection read. It does not change the authenticated team context. */
|
|
42756
|
-
"x-data-region"?: "ap" | "crunchy" | "eu" | "hostaway" | "us";
|
|
42757
|
-
};
|
|
42444
|
+
query?: never;
|
|
42445
|
+
header?: never;
|
|
42758
42446
|
path?: never;
|
|
42759
42447
|
cookie?: never;
|
|
42760
42448
|
};
|
|
42761
|
-
requestBody?:
|
|
42449
|
+
requestBody?: {
|
|
42450
|
+
content: {
|
|
42451
|
+
"application/json": {
|
|
42452
|
+
/**
|
|
42453
|
+
* @description Create the embedded user and team membership on first use instead of failing when they do not exist.
|
|
42454
|
+
* @default false
|
|
42455
|
+
*/
|
|
42456
|
+
autoProvision?: boolean;
|
|
42457
|
+
/** @description Embedded capability bundles granted to the session. */
|
|
42458
|
+
bundles: ("embed:exports:v1" | "embed:reports:v1" | "embed:statements:v1")[];
|
|
42459
|
+
/** @description Stable external user identifier in the partner system. */
|
|
42460
|
+
sub: string;
|
|
42461
|
+
/**
|
|
42462
|
+
* Format: uuid
|
|
42463
|
+
* @description The team to bind the embedded session to.
|
|
42464
|
+
*/
|
|
42465
|
+
teamId: string;
|
|
42466
|
+
/** @description Relative reports or statements URL to open in the embedded application. */
|
|
42467
|
+
viewPath: string;
|
|
42468
|
+
};
|
|
42469
|
+
};
|
|
42470
|
+
};
|
|
42762
42471
|
responses: {
|
|
42763
42472
|
/** @description Successful response */
|
|
42764
42473
|
200: {
|
|
42765
42474
|
headers: {
|
|
42475
|
+
/** @description Prevents storage of the bootstrap URL and one-time code. */
|
|
42476
|
+
"Cache-Control"?: "no-store";
|
|
42766
42477
|
[name: string]: unknown;
|
|
42767
42478
|
};
|
|
42768
42479
|
content: {
|
|
42769
42480
|
"application/json": {
|
|
42770
|
-
|
|
42771
|
-
|
|
42772
|
-
|
|
42773
|
-
|
|
42774
|
-
|
|
42775
|
-
|
|
42776
|
-
|
|
42777
|
-
|
|
42778
|
-
|
|
42779
|
-
|
|
42780
|
-
|
|
42781
|
-
|
|
42782
|
-
|
|
42783
|
-
|
|
42784
|
-
|
|
42785
|
-
|
|
42786
|
-
|
|
42787
|
-
|
|
42788
|
-
|
|
42789
|
-
|
|
42790
|
-
|
|
42791
|
-
|
|
42792
|
-
|
|
42793
|
-
|
|
42794
|
-
|
|
42795
|
-
|
|
42796
|
-
|
|
42797
|
-
|
|
42798
|
-
|
|
42799
|
-
|
|
42800
|
-
* Format: date-time
|
|
42801
|
-
* @description Timestamp string with date, time, milliseconds, and timezone.
|
|
42802
|
-
* @example 2024-01-15T12:30:00.000+00:00
|
|
42803
|
-
*/
|
|
42804
|
-
createdAt: string;
|
|
42805
|
-
/**
|
|
42806
|
-
* Format: date-time
|
|
42807
|
-
* @description Timestamp string with date, time, milliseconds, and timezone.
|
|
42808
|
-
* @example 2024-01-15T12:30:00.000+00:00
|
|
42809
|
-
*/
|
|
42810
|
-
updatedAt: string;
|
|
42811
|
-
message?: string | null;
|
|
42812
|
-
} | null;
|
|
42813
|
-
}[];
|
|
42814
|
-
}[];
|
|
42815
|
-
pagination: {
|
|
42816
|
-
/** @default 100 */
|
|
42817
|
-
limit: number;
|
|
42818
|
-
/** @default 1 */
|
|
42819
|
-
page: number;
|
|
42820
|
-
total: number;
|
|
42821
|
-
totalPage: number;
|
|
42822
|
-
nextPage?: number;
|
|
42823
|
-
};
|
|
42481
|
+
/**
|
|
42482
|
+
* Format: date-time
|
|
42483
|
+
* @description Deadline for exchanging the one-time bootstrap code.
|
|
42484
|
+
*/
|
|
42485
|
+
bootstrapExpiresAt: string;
|
|
42486
|
+
/**
|
|
42487
|
+
* Format: uri
|
|
42488
|
+
* @description Ready-to-mount embedded application URL.
|
|
42489
|
+
*/
|
|
42490
|
+
embedUrl: string;
|
|
42491
|
+
/**
|
|
42492
|
+
* Format: uuid
|
|
42493
|
+
* @description Session ID used for explicit revocation.
|
|
42494
|
+
*/
|
|
42495
|
+
id: string;
|
|
42496
|
+
/**
|
|
42497
|
+
* @description Bearer-session lifetime, starting when the code is exchanged.
|
|
42498
|
+
* @constant
|
|
42499
|
+
*/
|
|
42500
|
+
sessionTtlSeconds: 900;
|
|
42501
|
+
/**
|
|
42502
|
+
* Format: uuid
|
|
42503
|
+
* @description Team bound to the embedded session.
|
|
42504
|
+
*/
|
|
42505
|
+
teamId: string;
|
|
42506
|
+
/**
|
|
42507
|
+
* Format: uuid
|
|
42508
|
+
* @description VRPlatform user bound to the session.
|
|
42509
|
+
*/
|
|
42510
|
+
userId: string;
|
|
42824
42511
|
};
|
|
42825
42512
|
};
|
|
42826
42513
|
};
|
|
@@ -42958,75 +42645,29 @@ export interface operations {
|
|
|
42958
42645
|
};
|
|
42959
42646
|
};
|
|
42960
42647
|
};
|
|
42961
|
-
|
|
42648
|
+
revokeEmbedSession: {
|
|
42962
42649
|
parameters: {
|
|
42963
42650
|
query?: never;
|
|
42964
42651
|
header?: never;
|
|
42965
|
-
path
|
|
42966
|
-
|
|
42967
|
-
|
|
42968
|
-
requestBody?: {
|
|
42969
|
-
content: {
|
|
42970
|
-
"application/json": {
|
|
42971
|
-
/**
|
|
42972
|
-
* @description Create the embedded user and team membership on first use instead of failing when they do not exist.
|
|
42973
|
-
* @default false
|
|
42974
|
-
*/
|
|
42975
|
-
autoProvision?: boolean;
|
|
42976
|
-
/** @description Embedded capability bundles granted to the session. */
|
|
42977
|
-
bundles: ("embed:exports:v1" | "embed:reports:v1" | "embed:statements:v1")[];
|
|
42978
|
-
/** @description Stable external user identifier in the partner system. */
|
|
42979
|
-
sub: string;
|
|
42980
|
-
/**
|
|
42981
|
-
* Format: uuid
|
|
42982
|
-
* @description The team to bind the embedded session to.
|
|
42983
|
-
*/
|
|
42984
|
-
teamId: string;
|
|
42985
|
-
/** @description Relative reports or statements URL to open in the embedded application. */
|
|
42986
|
-
viewPath: string;
|
|
42987
|
-
};
|
|
42652
|
+
path: {
|
|
42653
|
+
/** @description Session ID returned when the embed URL was issued. */
|
|
42654
|
+
id: string;
|
|
42988
42655
|
};
|
|
42656
|
+
cookie?: never;
|
|
42989
42657
|
};
|
|
42658
|
+
requestBody?: never;
|
|
42990
42659
|
responses: {
|
|
42991
42660
|
/** @description Successful response */
|
|
42992
42661
|
200: {
|
|
42993
42662
|
headers: {
|
|
42994
|
-
/** @description Prevents storage of the bootstrap URL and one-time code. */
|
|
42995
|
-
"Cache-Control"?: "no-store";
|
|
42996
42663
|
[name: string]: unknown;
|
|
42997
42664
|
};
|
|
42998
42665
|
content: {
|
|
42999
42666
|
"application/json": {
|
|
43000
|
-
/**
|
|
43001
|
-
* Format: date-time
|
|
43002
|
-
* @description Deadline for exchanging the one-time bootstrap code.
|
|
43003
|
-
*/
|
|
43004
|
-
bootstrapExpiresAt: string;
|
|
43005
|
-
/**
|
|
43006
|
-
* Format: uri
|
|
43007
|
-
* @description Ready-to-mount embedded application URL.
|
|
43008
|
-
*/
|
|
43009
|
-
embedUrl: string;
|
|
43010
|
-
/**
|
|
43011
|
-
* Format: uuid
|
|
43012
|
-
* @description Session ID used for explicit revocation.
|
|
43013
|
-
*/
|
|
42667
|
+
/** Format: uuid */
|
|
43014
42668
|
id: string;
|
|
43015
|
-
/**
|
|
43016
|
-
|
|
43017
|
-
* @constant
|
|
43018
|
-
*/
|
|
43019
|
-
sessionTtlSeconds: 900;
|
|
43020
|
-
/**
|
|
43021
|
-
* Format: uuid
|
|
43022
|
-
* @description Team bound to the embedded session.
|
|
43023
|
-
*/
|
|
43024
|
-
teamId: string;
|
|
43025
|
-
/**
|
|
43026
|
-
* Format: uuid
|
|
43027
|
-
* @description VRPlatform user bound to the session.
|
|
43028
|
-
*/
|
|
43029
|
-
userId: string;
|
|
42669
|
+
/** @constant */
|
|
42670
|
+
status: "deleted";
|
|
43030
42671
|
};
|
|
43031
42672
|
};
|
|
43032
42673
|
};
|
|
@@ -43164,14 +42805,31 @@ export interface operations {
|
|
|
43164
42805
|
};
|
|
43165
42806
|
};
|
|
43166
42807
|
};
|
|
43167
|
-
|
|
42808
|
+
getPartnerListings: {
|
|
43168
42809
|
parameters: {
|
|
43169
|
-
query?:
|
|
43170
|
-
|
|
43171
|
-
|
|
43172
|
-
|
|
43173
|
-
|
|
42810
|
+
query?: {
|
|
42811
|
+
search?: string;
|
|
42812
|
+
partnerId?: string;
|
|
42813
|
+
billingPartnerId?: string;
|
|
42814
|
+
billingSubscriptionStatus?: "active" | "pending" | "paused" | "cancelled" | "pendingCancellation" | "draft" | "voided" | "errored" | "missing" | "viaPartner";
|
|
42815
|
+
billingPlan?: string;
|
|
42816
|
+
product?: "vrtrust" | "vrintegrations";
|
|
42817
|
+
/** @description Comma-separated team IDs. */
|
|
42818
|
+
ids?: string;
|
|
42819
|
+
status?: "active" | "inactive";
|
|
42820
|
+
/** @description Filter by team onboarding state. */
|
|
42821
|
+
isOnboarding?: boolean;
|
|
42822
|
+
/** @description Comma-separated enabled feature IDs. */
|
|
42823
|
+
featureIds?: string;
|
|
42824
|
+
limit?: number;
|
|
42825
|
+
page?: number;
|
|
42826
|
+
offset?: number;
|
|
43174
42827
|
};
|
|
42828
|
+
header?: {
|
|
42829
|
+
/** @description Selects the regional data partition for this regional collection read. It does not change the authenticated team context. */
|
|
42830
|
+
"x-data-region"?: "ap" | "crunchy" | "eu" | "hostaway" | "us";
|
|
42831
|
+
};
|
|
42832
|
+
path?: never;
|
|
43175
42833
|
cookie?: never;
|
|
43176
42834
|
};
|
|
43177
42835
|
requestBody?: never;
|
|
@@ -43183,10 +42841,34 @@ export interface operations {
|
|
|
43183
42841
|
};
|
|
43184
42842
|
content: {
|
|
43185
42843
|
"application/json": {
|
|
43186
|
-
|
|
43187
|
-
|
|
43188
|
-
|
|
43189
|
-
|
|
42844
|
+
data: {
|
|
42845
|
+
/** Format: uuid */
|
|
42846
|
+
id: string;
|
|
42847
|
+
name: string;
|
|
42848
|
+
team: {
|
|
42849
|
+
/** Format: uuid */
|
|
42850
|
+
id: string;
|
|
42851
|
+
name: string;
|
|
42852
|
+
};
|
|
42853
|
+
address: {
|
|
42854
|
+
line1: string | null;
|
|
42855
|
+
line2: string | null;
|
|
42856
|
+
city: string | null;
|
|
42857
|
+
postcode: string | null;
|
|
42858
|
+
stateCode: string | null;
|
|
42859
|
+
countryCode: string | null;
|
|
42860
|
+
full: string | null;
|
|
42861
|
+
};
|
|
42862
|
+
}[];
|
|
42863
|
+
pagination: {
|
|
42864
|
+
/** @default 100 */
|
|
42865
|
+
limit: number;
|
|
42866
|
+
/** @default 1 */
|
|
42867
|
+
page: number;
|
|
42868
|
+
total: number;
|
|
42869
|
+
totalPage: number;
|
|
42870
|
+
nextPage?: number;
|
|
42871
|
+
};
|
|
43190
42872
|
};
|
|
43191
42873
|
};
|
|
43192
42874
|
};
|