@vrplatform/api 1.3.1-stage.4724 → 1.3.1-stage.4736
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 +20 -570
- package/build/main/generated/v1.js.map +1 -1
- package/build/module/generated/v1.d.ts +20 -570
- package/build/module/generated/v1.js.map +1 -1
- package/package.json +1 -1
- package/src/generated/v1.ts +20 -570
package/src/generated/v1.ts
CHANGED
|
@@ -202,7 +202,7 @@ export interface paths {
|
|
|
202
202
|
/** @description List API token metadata for the current team without revealing token secrets. Requires an authenticated team admin. */
|
|
203
203
|
get: operations["getApiTokens"];
|
|
204
204
|
put?: never;
|
|
205
|
-
/** @description
|
|
205
|
+
/** @description Generate an API token for the current team and return its secret. Partner teams may provide capability bundles to restrict the token; omission grants unrestricted partner API access. An optional IP allowlist is enforced on every API-key request. Requires an authenticated team admin. The token secret is never written to audit records. */
|
|
206
206
|
post: operations["postApiTokens"];
|
|
207
207
|
delete?: never;
|
|
208
208
|
options?: never;
|
|
@@ -1417,9 +1417,9 @@ export interface paths {
|
|
|
1417
1417
|
path?: never;
|
|
1418
1418
|
cookie?: never;
|
|
1419
1419
|
};
|
|
1420
|
-
/** @description Retrieve opening trial balance */
|
|
1420
|
+
/** @description Retrieve active balance-sheet and equity opening trial balance rows. Operating is editable for non-bank ledger accounts, Trust is read-only, and Combined is calculated as Operating plus Trust. Bank rows are visible but cannot be edited or imported. Trust totals aggregate active Trust journal activity across all party attribution before the GL start date. */
|
|
1421
1421
|
get: operations["getGeneralLedgerOpeningTrialBalance"];
|
|
1422
|
-
/** @description Update the manual opening trial balance. Replaces
|
|
1422
|
+
/** @description Update the manual opening trial balance. Replaces Operating values for editable non-bank ledger rows. Trust-backed rows return importable=false but remain manually editable. Bank rows and existing journal activity after the go-live date are not changed. Supports dryRun. See https://docs.vrplatform.app/guides/integrate/opening-trial-balance. */
|
|
1423
1423
|
put: operations["putGeneralLedgerOpeningTrialBalance"];
|
|
1424
1424
|
post?: never;
|
|
1425
1425
|
delete?: never;
|
|
@@ -1793,57 +1793,6 @@ export interface paths {
|
|
|
1793
1793
|
patch?: never;
|
|
1794
1794
|
trace?: never;
|
|
1795
1795
|
};
|
|
1796
|
-
"/internal/partner-api-keys": {
|
|
1797
|
-
parameters: {
|
|
1798
|
-
query?: never;
|
|
1799
|
-
header?: never;
|
|
1800
|
-
path?: never;
|
|
1801
|
-
cookie?: never;
|
|
1802
|
-
};
|
|
1803
|
-
get?: never;
|
|
1804
|
-
put?: never;
|
|
1805
|
-
/** @description Create a scoped partner API key. The returned secret is shown only once. VRP-admin only. */
|
|
1806
|
-
post: operations["createPartnerApiKey"];
|
|
1807
|
-
delete?: never;
|
|
1808
|
-
options?: never;
|
|
1809
|
-
head?: never;
|
|
1810
|
-
patch?: never;
|
|
1811
|
-
trace?: never;
|
|
1812
|
-
};
|
|
1813
|
-
"/internal/partner-api-keys/{id}": {
|
|
1814
|
-
parameters: {
|
|
1815
|
-
query?: never;
|
|
1816
|
-
header?: never;
|
|
1817
|
-
path?: never;
|
|
1818
|
-
cookie?: never;
|
|
1819
|
-
};
|
|
1820
|
-
get?: never;
|
|
1821
|
-
put?: never;
|
|
1822
|
-
post?: never;
|
|
1823
|
-
/** @description Revoke a partner API key immediately. VRP-admin only. */
|
|
1824
|
-
delete: operations["revokePartnerApiKey"];
|
|
1825
|
-
options?: never;
|
|
1826
|
-
head?: never;
|
|
1827
|
-
patch?: never;
|
|
1828
|
-
trace?: never;
|
|
1829
|
-
};
|
|
1830
|
-
"/internal/partner-api-keys/{id}/rotate": {
|
|
1831
|
-
parameters: {
|
|
1832
|
-
query?: never;
|
|
1833
|
-
header?: never;
|
|
1834
|
-
path?: never;
|
|
1835
|
-
cookie?: never;
|
|
1836
|
-
};
|
|
1837
|
-
get?: never;
|
|
1838
|
-
put?: never;
|
|
1839
|
-
/** @description Replace a partner API key secret while preserving its grants. The new secret is shown only once. VRP-admin only. */
|
|
1840
|
-
post: operations["rotatePartnerApiKey"];
|
|
1841
|
-
delete?: never;
|
|
1842
|
-
options?: never;
|
|
1843
|
-
head?: never;
|
|
1844
|
-
patch?: never;
|
|
1845
|
-
trace?: never;
|
|
1846
|
-
};
|
|
1847
1796
|
"/internal/users": {
|
|
1848
1797
|
parameters: {
|
|
1849
1798
|
query?: never;
|
|
@@ -8285,6 +8234,8 @@ export interface operations {
|
|
|
8285
8234
|
content: {
|
|
8286
8235
|
"application/json": {
|
|
8287
8236
|
data: {
|
|
8237
|
+
allowedIpCidrs: string[];
|
|
8238
|
+
bundles: ("embed:exports:v1" | "embed:reports:v1" | "embed:statements:v1" | "partner:accounting-data:v1" | "partner:banking:v1" | "partner:onboarding:v1" | "partner:provisioning:v1" | "partner:reports:v1" | "partner:statements:v1" | "partner:webhooks:v1")[];
|
|
8288
8239
|
/** Format: uuid */
|
|
8289
8240
|
id: string;
|
|
8290
8241
|
/**
|
|
@@ -8296,6 +8247,7 @@ export interface operations {
|
|
|
8296
8247
|
hint: string | null;
|
|
8297
8248
|
role: string | null;
|
|
8298
8249
|
scope: string | null;
|
|
8250
|
+
scopes: ("self:read" | "partner:read" | "teams:read" | "teams:provision" | "teams:write" | "teams:delete" | "teams:initialize" | "embedded-sessions:issue" | "team-members:read" | "team-members:manage" | "partner-users:read" | "partner-users:manage" | "partner-memberships:manage" | "team-settings:read" | "team-settings:write" | "team-onboarding:read" | "team-onboarding:write" | "team-issues:read" | "books:close" | "listings:read" | "listings:write" | "listings:delete" | "listings:export" | "contacts:read" | "contacts:write" | "contacts:delete" | "contacts:export" | "ownerships:read" | "ownerships:write" | "ownerships:delete" | "reservations:read" | "reservations:write" | "reservations:delete" | "reservations:export" | "reservations:post-journals" | "transactions:read" | "transactions:write" | "transactions:delete" | "transactions:export" | "transactions:post-journals" | "transactions:pay" | "accounts:read" | "accounts:write" | "accounts:delete" | "accounts:export" | "accounts:recalculate" | "tax-rates:read" | "tax-rates:write" | "tax-rates:delete" | "reservation-mappings:read" | "reservation-mappings:write" | "transaction-mappings:read" | "transaction-mappings:write" | "statements:read" | "statements:write" | "statements:delete" | "statements:publish" | "statements:pay" | "statements:export" | "statement-layouts:read" | "reports:read" | "reports:export" | "metrics:read" | "bank-accounts:read" | "bank-accounts:write" | "bank-connections:manage" | "bank-records:read" | "bank-records:write" | "bank-records:delete" | "bank-records:export" | "bank-rules:read" | "bank-rules:write" | "bank-rules:delete" | "bank-rules:execute" | "webhooks:read" | "webhooks:manage" | "webhooks:replay")[];
|
|
8299
8251
|
}[];
|
|
8300
8252
|
pagination: {
|
|
8301
8253
|
/** @default 100 */
|
|
@@ -8453,8 +8405,10 @@ export interface operations {
|
|
|
8453
8405
|
requestBody?: {
|
|
8454
8406
|
content: {
|
|
8455
8407
|
"application/json": {
|
|
8456
|
-
/** @description
|
|
8457
|
-
|
|
8408
|
+
/** @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. */
|
|
8409
|
+
allowedIpCidrs?: string[];
|
|
8410
|
+
/** @description Optional capability restrictions for a partner-owned API token. Omit for unrestricted partner API access. Rejected for ordinary teams. */
|
|
8411
|
+
bundles?: ("embed:exports:v1" | "embed:reports:v1" | "embed:statements:v1" | "partner:accounting-data:v1" | "partner:banking:v1" | "partner:onboarding:v1" | "partner:provisioning:v1" | "partner:reports:v1" | "partner:statements:v1" | "partner:webhooks:v1")[];
|
|
8458
8412
|
};
|
|
8459
8413
|
};
|
|
8460
8414
|
};
|
|
@@ -8466,6 +8420,8 @@ export interface operations {
|
|
|
8466
8420
|
};
|
|
8467
8421
|
content: {
|
|
8468
8422
|
"application/json": {
|
|
8423
|
+
allowedIpCidrs: string[];
|
|
8424
|
+
bundles: ("embed:exports:v1" | "embed:reports:v1" | "embed:statements:v1" | "partner:accounting-data:v1" | "partner:banking:v1" | "partner:onboarding:v1" | "partner:provisioning:v1" | "partner:reports:v1" | "partner:statements:v1" | "partner:webhooks:v1")[];
|
|
8469
8425
|
/** Format: uuid */
|
|
8470
8426
|
id: string;
|
|
8471
8427
|
/**
|
|
@@ -8477,6 +8433,8 @@ export interface operations {
|
|
|
8477
8433
|
hint: string | null;
|
|
8478
8434
|
role: string | null;
|
|
8479
8435
|
scope: string | null;
|
|
8436
|
+
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")[];
|
|
8437
|
+
apiToken: string;
|
|
8480
8438
|
};
|
|
8481
8439
|
};
|
|
8482
8440
|
};
|
|
@@ -8632,6 +8590,8 @@ export interface operations {
|
|
|
8632
8590
|
};
|
|
8633
8591
|
content: {
|
|
8634
8592
|
"application/json": {
|
|
8593
|
+
allowedIpCidrs: string[];
|
|
8594
|
+
bundles: ("embed:exports:v1" | "embed:reports:v1" | "embed:statements:v1" | "partner:accounting-data:v1" | "partner:banking:v1" | "partner:onboarding:v1" | "partner:provisioning:v1" | "partner:reports:v1" | "partner:statements:v1" | "partner:webhooks:v1")[];
|
|
8635
8595
|
/** Format: uuid */
|
|
8636
8596
|
id: string;
|
|
8637
8597
|
/**
|
|
@@ -8643,6 +8603,7 @@ export interface operations {
|
|
|
8643
8603
|
hint: string | null;
|
|
8644
8604
|
role: string | null;
|
|
8645
8605
|
scope: string | null;
|
|
8606
|
+
scopes: ("self:read" | "partner:read" | "teams:read" | "teams:provision" | "teams:write" | "teams:delete" | "teams:initialize" | "embedded-sessions:issue" | "team-members:read" | "team-members:manage" | "partner-users:read" | "partner-users:manage" | "partner-memberships:manage" | "team-settings:read" | "team-settings:write" | "team-onboarding:read" | "team-onboarding:write" | "team-issues:read" | "books:close" | "listings:read" | "listings:write" | "listings:delete" | "listings:export" | "contacts:read" | "contacts:write" | "contacts:delete" | "contacts:export" | "ownerships:read" | "ownerships:write" | "ownerships:delete" | "reservations:read" | "reservations:write" | "reservations:delete" | "reservations:export" | "reservations:post-journals" | "transactions:read" | "transactions:write" | "transactions:delete" | "transactions:export" | "transactions:post-journals" | "transactions:pay" | "accounts:read" | "accounts:write" | "accounts:delete" | "accounts:export" | "accounts:recalculate" | "tax-rates:read" | "tax-rates:write" | "tax-rates:delete" | "reservation-mappings:read" | "reservation-mappings:write" | "transaction-mappings:read" | "transaction-mappings:write" | "statements:read" | "statements:write" | "statements:delete" | "statements:publish" | "statements:pay" | "statements:export" | "statement-layouts:read" | "reports:read" | "reports:export" | "metrics:read" | "bank-accounts:read" | "bank-accounts:write" | "bank-connections:manage" | "bank-records:read" | "bank-records:write" | "bank-records:delete" | "bank-records:export" | "bank-rules:read" | "bank-rules:write" | "bank-rules:delete" | "bank-rules:execute" | "webhooks:read" | "webhooks:manage" | "webhooks:replay")[];
|
|
8646
8607
|
apiToken: string;
|
|
8647
8608
|
};
|
|
8648
8609
|
};
|
|
@@ -26491,6 +26452,7 @@ export interface operations {
|
|
|
26491
26452
|
/** @description Value in cents (100 = 1€) */
|
|
26492
26453
|
operatingCentTotal: number;
|
|
26493
26454
|
editable: boolean;
|
|
26455
|
+
importable: boolean;
|
|
26494
26456
|
}[];
|
|
26495
26457
|
assignment: {
|
|
26496
26458
|
/** Format: uuid */
|
|
@@ -26503,12 +26465,6 @@ export interface operations {
|
|
|
26503
26465
|
/** @description Value in cents (100 = 1€) */
|
|
26504
26466
|
operatingCentTotal: number;
|
|
26505
26467
|
};
|
|
26506
|
-
trustReversal: {
|
|
26507
|
-
/** @enum {string} */
|
|
26508
|
-
status: "not_created" | "active" | "locked";
|
|
26509
|
-
journalEntryIds: string[];
|
|
26510
|
-
lastRefreshedAt?: string | null;
|
|
26511
|
-
};
|
|
26512
26468
|
};
|
|
26513
26469
|
};
|
|
26514
26470
|
};
|
|
@@ -26663,7 +26619,7 @@ export interface operations {
|
|
|
26663
26619
|
/** Format: uuid */
|
|
26664
26620
|
accountId: string;
|
|
26665
26621
|
/** @description Value in cents (100 = 1€) */
|
|
26666
|
-
|
|
26622
|
+
operatingCentTotal: number;
|
|
26667
26623
|
}[];
|
|
26668
26624
|
};
|
|
26669
26625
|
};
|
|
@@ -26703,6 +26659,7 @@ export interface operations {
|
|
|
26703
26659
|
/** @description Value in cents (100 = 1€) */
|
|
26704
26660
|
operatingCentTotal: number;
|
|
26705
26661
|
editable: boolean;
|
|
26662
|
+
importable: boolean;
|
|
26706
26663
|
}[];
|
|
26707
26664
|
assignment: {
|
|
26708
26665
|
/** Format: uuid */
|
|
@@ -26715,12 +26672,6 @@ export interface operations {
|
|
|
26715
26672
|
/** @description Value in cents (100 = 1€) */
|
|
26716
26673
|
operatingCentTotal: number;
|
|
26717
26674
|
};
|
|
26718
|
-
trustReversal: {
|
|
26719
|
-
/** @enum {string} */
|
|
26720
|
-
status: "not_created" | "active" | "locked";
|
|
26721
|
-
journalEntryIds: string[];
|
|
26722
|
-
lastRefreshedAt?: string | null;
|
|
26723
|
-
};
|
|
26724
26675
|
};
|
|
26725
26676
|
};
|
|
26726
26677
|
};
|
|
@@ -32313,507 +32264,6 @@ export interface operations {
|
|
|
32313
32264
|
};
|
|
32314
32265
|
};
|
|
32315
32266
|
};
|
|
32316
|
-
createPartnerApiKey: {
|
|
32317
|
-
parameters: {
|
|
32318
|
-
query?: never;
|
|
32319
|
-
header?: never;
|
|
32320
|
-
path?: never;
|
|
32321
|
-
cookie?: never;
|
|
32322
|
-
};
|
|
32323
|
-
requestBody?: {
|
|
32324
|
-
content: {
|
|
32325
|
-
"application/json": {
|
|
32326
|
-
/** @enum {string} */
|
|
32327
|
-
audience: "hostaway-production" | "hostaway-staging" | "vrplatform-production" | "vrplatform-staging";
|
|
32328
|
-
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")[];
|
|
32329
|
-
/** Format: uuid */
|
|
32330
|
-
partnerId: string;
|
|
32331
|
-
};
|
|
32332
|
-
};
|
|
32333
|
-
};
|
|
32334
|
-
responses: {
|
|
32335
|
-
/** @description Successful response */
|
|
32336
|
-
200: {
|
|
32337
|
-
headers: {
|
|
32338
|
-
[name: string]: unknown;
|
|
32339
|
-
};
|
|
32340
|
-
content: {
|
|
32341
|
-
"application/json": {
|
|
32342
|
-
/** @enum {string} */
|
|
32343
|
-
audience: "hostaway-production" | "hostaway-staging" | "vrplatform-production" | "vrplatform-staging";
|
|
32344
|
-
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")[];
|
|
32345
|
-
/** Format: uuid */
|
|
32346
|
-
id: string;
|
|
32347
|
-
/** Format: uuid */
|
|
32348
|
-
partnerId: string;
|
|
32349
|
-
secret: string;
|
|
32350
|
-
};
|
|
32351
|
-
};
|
|
32352
|
-
};
|
|
32353
|
-
/** @description Bad request */
|
|
32354
|
-
400: {
|
|
32355
|
-
headers: {
|
|
32356
|
-
[name: string]: unknown;
|
|
32357
|
-
};
|
|
32358
|
-
content: {
|
|
32359
|
-
"application/json": {
|
|
32360
|
-
code: string;
|
|
32361
|
-
message: string;
|
|
32362
|
-
links?: {
|
|
32363
|
-
docs: string;
|
|
32364
|
-
schema: string;
|
|
32365
|
-
};
|
|
32366
|
-
issues?: {
|
|
32367
|
-
message: string;
|
|
32368
|
-
path?: (string | number)[];
|
|
32369
|
-
schema?: string;
|
|
32370
|
-
}[];
|
|
32371
|
-
context?: unknown;
|
|
32372
|
-
};
|
|
32373
|
-
};
|
|
32374
|
-
};
|
|
32375
|
-
/** @description Unauthorized */
|
|
32376
|
-
401: {
|
|
32377
|
-
headers: {
|
|
32378
|
-
[name: string]: unknown;
|
|
32379
|
-
};
|
|
32380
|
-
content: {
|
|
32381
|
-
"application/json": {
|
|
32382
|
-
code: string;
|
|
32383
|
-
message: string;
|
|
32384
|
-
links?: {
|
|
32385
|
-
docs: string;
|
|
32386
|
-
schema: string;
|
|
32387
|
-
};
|
|
32388
|
-
issues?: {
|
|
32389
|
-
message: string;
|
|
32390
|
-
path?: (string | number)[];
|
|
32391
|
-
schema?: string;
|
|
32392
|
-
}[];
|
|
32393
|
-
context?: unknown;
|
|
32394
|
-
};
|
|
32395
|
-
};
|
|
32396
|
-
};
|
|
32397
|
-
/** @description Forbidden */
|
|
32398
|
-
403: {
|
|
32399
|
-
headers: {
|
|
32400
|
-
[name: string]: unknown;
|
|
32401
|
-
};
|
|
32402
|
-
content: {
|
|
32403
|
-
"application/json": {
|
|
32404
|
-
code: string;
|
|
32405
|
-
message: string;
|
|
32406
|
-
links?: {
|
|
32407
|
-
docs: string;
|
|
32408
|
-
schema: string;
|
|
32409
|
-
};
|
|
32410
|
-
issues?: {
|
|
32411
|
-
message: string;
|
|
32412
|
-
path?: (string | number)[];
|
|
32413
|
-
schema?: string;
|
|
32414
|
-
}[];
|
|
32415
|
-
context?: unknown;
|
|
32416
|
-
};
|
|
32417
|
-
};
|
|
32418
|
-
};
|
|
32419
|
-
/** @description Not found */
|
|
32420
|
-
404: {
|
|
32421
|
-
headers: {
|
|
32422
|
-
[name: string]: unknown;
|
|
32423
|
-
};
|
|
32424
|
-
content: {
|
|
32425
|
-
"application/json": {
|
|
32426
|
-
code: string;
|
|
32427
|
-
message: string;
|
|
32428
|
-
links?: {
|
|
32429
|
-
docs: string;
|
|
32430
|
-
schema: string;
|
|
32431
|
-
};
|
|
32432
|
-
issues?: {
|
|
32433
|
-
message: string;
|
|
32434
|
-
path?: (string | number)[];
|
|
32435
|
-
schema?: string;
|
|
32436
|
-
}[];
|
|
32437
|
-
context?: unknown;
|
|
32438
|
-
};
|
|
32439
|
-
};
|
|
32440
|
-
};
|
|
32441
|
-
/** @description Internal server error */
|
|
32442
|
-
500: {
|
|
32443
|
-
headers: {
|
|
32444
|
-
[name: string]: unknown;
|
|
32445
|
-
};
|
|
32446
|
-
content: {
|
|
32447
|
-
"application/json": {
|
|
32448
|
-
code: string;
|
|
32449
|
-
message: string;
|
|
32450
|
-
links?: {
|
|
32451
|
-
docs: string;
|
|
32452
|
-
schema: string;
|
|
32453
|
-
};
|
|
32454
|
-
issues?: {
|
|
32455
|
-
message: string;
|
|
32456
|
-
path?: (string | number)[];
|
|
32457
|
-
schema?: string;
|
|
32458
|
-
}[];
|
|
32459
|
-
context?: unknown;
|
|
32460
|
-
};
|
|
32461
|
-
};
|
|
32462
|
-
};
|
|
32463
|
-
/** @description Service unavailable */
|
|
32464
|
-
503: {
|
|
32465
|
-
headers: {
|
|
32466
|
-
[name: string]: unknown;
|
|
32467
|
-
};
|
|
32468
|
-
content: {
|
|
32469
|
-
"application/json": {
|
|
32470
|
-
code: string;
|
|
32471
|
-
message: string;
|
|
32472
|
-
links?: {
|
|
32473
|
-
docs: string;
|
|
32474
|
-
schema: string;
|
|
32475
|
-
};
|
|
32476
|
-
issues?: {
|
|
32477
|
-
message: string;
|
|
32478
|
-
path?: (string | number)[];
|
|
32479
|
-
schema?: string;
|
|
32480
|
-
}[];
|
|
32481
|
-
context?: unknown;
|
|
32482
|
-
};
|
|
32483
|
-
};
|
|
32484
|
-
};
|
|
32485
|
-
};
|
|
32486
|
-
};
|
|
32487
|
-
revokePartnerApiKey: {
|
|
32488
|
-
parameters: {
|
|
32489
|
-
query?: never;
|
|
32490
|
-
header?: never;
|
|
32491
|
-
path: {
|
|
32492
|
-
id: string;
|
|
32493
|
-
};
|
|
32494
|
-
cookie?: never;
|
|
32495
|
-
};
|
|
32496
|
-
requestBody?: {
|
|
32497
|
-
content: {
|
|
32498
|
-
"application/json": Record<string, never>;
|
|
32499
|
-
};
|
|
32500
|
-
};
|
|
32501
|
-
responses: {
|
|
32502
|
-
/** @description Successful response */
|
|
32503
|
-
200: {
|
|
32504
|
-
headers: {
|
|
32505
|
-
[name: string]: unknown;
|
|
32506
|
-
};
|
|
32507
|
-
content: {
|
|
32508
|
-
"application/json": {
|
|
32509
|
-
/** Format: uuid */
|
|
32510
|
-
id: string;
|
|
32511
|
-
/** @constant */
|
|
32512
|
-
status: "deleted";
|
|
32513
|
-
};
|
|
32514
|
-
};
|
|
32515
|
-
};
|
|
32516
|
-
/** @description Bad request */
|
|
32517
|
-
400: {
|
|
32518
|
-
headers: {
|
|
32519
|
-
[name: string]: unknown;
|
|
32520
|
-
};
|
|
32521
|
-
content: {
|
|
32522
|
-
"application/json": {
|
|
32523
|
-
code: string;
|
|
32524
|
-
message: string;
|
|
32525
|
-
links?: {
|
|
32526
|
-
docs: string;
|
|
32527
|
-
schema: string;
|
|
32528
|
-
};
|
|
32529
|
-
issues?: {
|
|
32530
|
-
message: string;
|
|
32531
|
-
path?: (string | number)[];
|
|
32532
|
-
schema?: string;
|
|
32533
|
-
}[];
|
|
32534
|
-
context?: unknown;
|
|
32535
|
-
};
|
|
32536
|
-
};
|
|
32537
|
-
};
|
|
32538
|
-
/** @description Unauthorized */
|
|
32539
|
-
401: {
|
|
32540
|
-
headers: {
|
|
32541
|
-
[name: string]: unknown;
|
|
32542
|
-
};
|
|
32543
|
-
content: {
|
|
32544
|
-
"application/json": {
|
|
32545
|
-
code: string;
|
|
32546
|
-
message: string;
|
|
32547
|
-
links?: {
|
|
32548
|
-
docs: string;
|
|
32549
|
-
schema: string;
|
|
32550
|
-
};
|
|
32551
|
-
issues?: {
|
|
32552
|
-
message: string;
|
|
32553
|
-
path?: (string | number)[];
|
|
32554
|
-
schema?: string;
|
|
32555
|
-
}[];
|
|
32556
|
-
context?: unknown;
|
|
32557
|
-
};
|
|
32558
|
-
};
|
|
32559
|
-
};
|
|
32560
|
-
/** @description Forbidden */
|
|
32561
|
-
403: {
|
|
32562
|
-
headers: {
|
|
32563
|
-
[name: string]: unknown;
|
|
32564
|
-
};
|
|
32565
|
-
content: {
|
|
32566
|
-
"application/json": {
|
|
32567
|
-
code: string;
|
|
32568
|
-
message: string;
|
|
32569
|
-
links?: {
|
|
32570
|
-
docs: string;
|
|
32571
|
-
schema: string;
|
|
32572
|
-
};
|
|
32573
|
-
issues?: {
|
|
32574
|
-
message: string;
|
|
32575
|
-
path?: (string | number)[];
|
|
32576
|
-
schema?: string;
|
|
32577
|
-
}[];
|
|
32578
|
-
context?: unknown;
|
|
32579
|
-
};
|
|
32580
|
-
};
|
|
32581
|
-
};
|
|
32582
|
-
/** @description Not found */
|
|
32583
|
-
404: {
|
|
32584
|
-
headers: {
|
|
32585
|
-
[name: string]: unknown;
|
|
32586
|
-
};
|
|
32587
|
-
content: {
|
|
32588
|
-
"application/json": {
|
|
32589
|
-
code: string;
|
|
32590
|
-
message: string;
|
|
32591
|
-
links?: {
|
|
32592
|
-
docs: string;
|
|
32593
|
-
schema: string;
|
|
32594
|
-
};
|
|
32595
|
-
issues?: {
|
|
32596
|
-
message: string;
|
|
32597
|
-
path?: (string | number)[];
|
|
32598
|
-
schema?: string;
|
|
32599
|
-
}[];
|
|
32600
|
-
context?: unknown;
|
|
32601
|
-
};
|
|
32602
|
-
};
|
|
32603
|
-
};
|
|
32604
|
-
/** @description Internal server error */
|
|
32605
|
-
500: {
|
|
32606
|
-
headers: {
|
|
32607
|
-
[name: string]: unknown;
|
|
32608
|
-
};
|
|
32609
|
-
content: {
|
|
32610
|
-
"application/json": {
|
|
32611
|
-
code: string;
|
|
32612
|
-
message: string;
|
|
32613
|
-
links?: {
|
|
32614
|
-
docs: string;
|
|
32615
|
-
schema: string;
|
|
32616
|
-
};
|
|
32617
|
-
issues?: {
|
|
32618
|
-
message: string;
|
|
32619
|
-
path?: (string | number)[];
|
|
32620
|
-
schema?: string;
|
|
32621
|
-
}[];
|
|
32622
|
-
context?: unknown;
|
|
32623
|
-
};
|
|
32624
|
-
};
|
|
32625
|
-
};
|
|
32626
|
-
/** @description Service unavailable */
|
|
32627
|
-
503: {
|
|
32628
|
-
headers: {
|
|
32629
|
-
[name: string]: unknown;
|
|
32630
|
-
};
|
|
32631
|
-
content: {
|
|
32632
|
-
"application/json": {
|
|
32633
|
-
code: string;
|
|
32634
|
-
message: string;
|
|
32635
|
-
links?: {
|
|
32636
|
-
docs: string;
|
|
32637
|
-
schema: string;
|
|
32638
|
-
};
|
|
32639
|
-
issues?: {
|
|
32640
|
-
message: string;
|
|
32641
|
-
path?: (string | number)[];
|
|
32642
|
-
schema?: string;
|
|
32643
|
-
}[];
|
|
32644
|
-
context?: unknown;
|
|
32645
|
-
};
|
|
32646
|
-
};
|
|
32647
|
-
};
|
|
32648
|
-
};
|
|
32649
|
-
};
|
|
32650
|
-
rotatePartnerApiKey: {
|
|
32651
|
-
parameters: {
|
|
32652
|
-
query?: never;
|
|
32653
|
-
header?: never;
|
|
32654
|
-
path: {
|
|
32655
|
-
id: string;
|
|
32656
|
-
};
|
|
32657
|
-
cookie?: never;
|
|
32658
|
-
};
|
|
32659
|
-
requestBody?: {
|
|
32660
|
-
content: {
|
|
32661
|
-
"application/json": Record<string, never>;
|
|
32662
|
-
};
|
|
32663
|
-
};
|
|
32664
|
-
responses: {
|
|
32665
|
-
/** @description Successful response */
|
|
32666
|
-
200: {
|
|
32667
|
-
headers: {
|
|
32668
|
-
[name: string]: unknown;
|
|
32669
|
-
};
|
|
32670
|
-
content: {
|
|
32671
|
-
"application/json": {
|
|
32672
|
-
/** @enum {string} */
|
|
32673
|
-
audience: "hostaway-production" | "hostaway-staging" | "vrplatform-production" | "vrplatform-staging";
|
|
32674
|
-
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")[];
|
|
32675
|
-
/** Format: uuid */
|
|
32676
|
-
id: string;
|
|
32677
|
-
/** Format: uuid */
|
|
32678
|
-
partnerId: string;
|
|
32679
|
-
secret: string;
|
|
32680
|
-
};
|
|
32681
|
-
};
|
|
32682
|
-
};
|
|
32683
|
-
/** @description Bad request */
|
|
32684
|
-
400: {
|
|
32685
|
-
headers: {
|
|
32686
|
-
[name: string]: unknown;
|
|
32687
|
-
};
|
|
32688
|
-
content: {
|
|
32689
|
-
"application/json": {
|
|
32690
|
-
code: string;
|
|
32691
|
-
message: string;
|
|
32692
|
-
links?: {
|
|
32693
|
-
docs: string;
|
|
32694
|
-
schema: string;
|
|
32695
|
-
};
|
|
32696
|
-
issues?: {
|
|
32697
|
-
message: string;
|
|
32698
|
-
path?: (string | number)[];
|
|
32699
|
-
schema?: string;
|
|
32700
|
-
}[];
|
|
32701
|
-
context?: unknown;
|
|
32702
|
-
};
|
|
32703
|
-
};
|
|
32704
|
-
};
|
|
32705
|
-
/** @description Unauthorized */
|
|
32706
|
-
401: {
|
|
32707
|
-
headers: {
|
|
32708
|
-
[name: string]: unknown;
|
|
32709
|
-
};
|
|
32710
|
-
content: {
|
|
32711
|
-
"application/json": {
|
|
32712
|
-
code: string;
|
|
32713
|
-
message: string;
|
|
32714
|
-
links?: {
|
|
32715
|
-
docs: string;
|
|
32716
|
-
schema: string;
|
|
32717
|
-
};
|
|
32718
|
-
issues?: {
|
|
32719
|
-
message: string;
|
|
32720
|
-
path?: (string | number)[];
|
|
32721
|
-
schema?: string;
|
|
32722
|
-
}[];
|
|
32723
|
-
context?: unknown;
|
|
32724
|
-
};
|
|
32725
|
-
};
|
|
32726
|
-
};
|
|
32727
|
-
/** @description Forbidden */
|
|
32728
|
-
403: {
|
|
32729
|
-
headers: {
|
|
32730
|
-
[name: string]: unknown;
|
|
32731
|
-
};
|
|
32732
|
-
content: {
|
|
32733
|
-
"application/json": {
|
|
32734
|
-
code: string;
|
|
32735
|
-
message: string;
|
|
32736
|
-
links?: {
|
|
32737
|
-
docs: string;
|
|
32738
|
-
schema: string;
|
|
32739
|
-
};
|
|
32740
|
-
issues?: {
|
|
32741
|
-
message: string;
|
|
32742
|
-
path?: (string | number)[];
|
|
32743
|
-
schema?: string;
|
|
32744
|
-
}[];
|
|
32745
|
-
context?: unknown;
|
|
32746
|
-
};
|
|
32747
|
-
};
|
|
32748
|
-
};
|
|
32749
|
-
/** @description Not found */
|
|
32750
|
-
404: {
|
|
32751
|
-
headers: {
|
|
32752
|
-
[name: string]: unknown;
|
|
32753
|
-
};
|
|
32754
|
-
content: {
|
|
32755
|
-
"application/json": {
|
|
32756
|
-
code: string;
|
|
32757
|
-
message: string;
|
|
32758
|
-
links?: {
|
|
32759
|
-
docs: string;
|
|
32760
|
-
schema: string;
|
|
32761
|
-
};
|
|
32762
|
-
issues?: {
|
|
32763
|
-
message: string;
|
|
32764
|
-
path?: (string | number)[];
|
|
32765
|
-
schema?: string;
|
|
32766
|
-
}[];
|
|
32767
|
-
context?: unknown;
|
|
32768
|
-
};
|
|
32769
|
-
};
|
|
32770
|
-
};
|
|
32771
|
-
/** @description Internal server error */
|
|
32772
|
-
500: {
|
|
32773
|
-
headers: {
|
|
32774
|
-
[name: string]: unknown;
|
|
32775
|
-
};
|
|
32776
|
-
content: {
|
|
32777
|
-
"application/json": {
|
|
32778
|
-
code: string;
|
|
32779
|
-
message: string;
|
|
32780
|
-
links?: {
|
|
32781
|
-
docs: string;
|
|
32782
|
-
schema: string;
|
|
32783
|
-
};
|
|
32784
|
-
issues?: {
|
|
32785
|
-
message: string;
|
|
32786
|
-
path?: (string | number)[];
|
|
32787
|
-
schema?: string;
|
|
32788
|
-
}[];
|
|
32789
|
-
context?: unknown;
|
|
32790
|
-
};
|
|
32791
|
-
};
|
|
32792
|
-
};
|
|
32793
|
-
/** @description Service unavailable */
|
|
32794
|
-
503: {
|
|
32795
|
-
headers: {
|
|
32796
|
-
[name: string]: unknown;
|
|
32797
|
-
};
|
|
32798
|
-
content: {
|
|
32799
|
-
"application/json": {
|
|
32800
|
-
code: string;
|
|
32801
|
-
message: string;
|
|
32802
|
-
links?: {
|
|
32803
|
-
docs: string;
|
|
32804
|
-
schema: string;
|
|
32805
|
-
};
|
|
32806
|
-
issues?: {
|
|
32807
|
-
message: string;
|
|
32808
|
-
path?: (string | number)[];
|
|
32809
|
-
schema?: string;
|
|
32810
|
-
}[];
|
|
32811
|
-
context?: unknown;
|
|
32812
|
-
};
|
|
32813
|
-
};
|
|
32814
|
-
};
|
|
32815
|
-
};
|
|
32816
|
-
};
|
|
32817
32267
|
getInternalUsers: {
|
|
32818
32268
|
parameters: {
|
|
32819
32269
|
query?: {
|