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