@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
|
@@ -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;
|
|
@@ -1416,9 +1416,9 @@ export interface paths {
|
|
|
1416
1416
|
path?: never;
|
|
1417
1417
|
cookie?: never;
|
|
1418
1418
|
};
|
|
1419
|
-
/** @description Retrieve opening trial balance */
|
|
1419
|
+
/** @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. */
|
|
1420
1420
|
get: operations["getGeneralLedgerOpeningTrialBalance"];
|
|
1421
|
-
/** @description Update the manual opening trial balance. Replaces
|
|
1421
|
+
/** @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. */
|
|
1422
1422
|
put: operations["putGeneralLedgerOpeningTrialBalance"];
|
|
1423
1423
|
post?: never;
|
|
1424
1424
|
delete?: 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;
|
|
@@ -8284,6 +8233,8 @@ export interface operations {
|
|
|
8284
8233
|
content: {
|
|
8285
8234
|
"application/json": {
|
|
8286
8235
|
data: {
|
|
8236
|
+
allowedIpCidrs: string[];
|
|
8237
|
+
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
8238
|
/** Format: uuid */
|
|
8288
8239
|
id: string;
|
|
8289
8240
|
/**
|
|
@@ -8295,6 +8246,7 @@ export interface operations {
|
|
|
8295
8246
|
hint: string | null;
|
|
8296
8247
|
role: string | null;
|
|
8297
8248
|
scope: string | null;
|
|
8249
|
+
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
8250
|
}[];
|
|
8299
8251
|
pagination: {
|
|
8300
8252
|
/** @default 100 */
|
|
@@ -8452,8 +8404,10 @@ export interface operations {
|
|
|
8452
8404
|
requestBody?: {
|
|
8453
8405
|
content: {
|
|
8454
8406
|
"application/json": {
|
|
8455
|
-
/** @description
|
|
8456
|
-
|
|
8407
|
+
/** @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. */
|
|
8408
|
+
allowedIpCidrs?: string[];
|
|
8409
|
+
/** @description Optional capability restrictions for a partner-owned API token. Omit for unrestricted partner API access. Rejected for ordinary teams. */
|
|
8410
|
+
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
8411
|
};
|
|
8458
8412
|
};
|
|
8459
8413
|
};
|
|
@@ -8465,6 +8419,8 @@ export interface operations {
|
|
|
8465
8419
|
};
|
|
8466
8420
|
content: {
|
|
8467
8421
|
"application/json": {
|
|
8422
|
+
allowedIpCidrs: string[];
|
|
8423
|
+
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
8424
|
/** Format: uuid */
|
|
8469
8425
|
id: string;
|
|
8470
8426
|
/**
|
|
@@ -8476,6 +8432,8 @@ export interface operations {
|
|
|
8476
8432
|
hint: string | null;
|
|
8477
8433
|
role: string | null;
|
|
8478
8434
|
scope: string | null;
|
|
8435
|
+
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")[];
|
|
8436
|
+
apiToken: string;
|
|
8479
8437
|
};
|
|
8480
8438
|
};
|
|
8481
8439
|
};
|
|
@@ -8631,6 +8589,8 @@ export interface operations {
|
|
|
8631
8589
|
};
|
|
8632
8590
|
content: {
|
|
8633
8591
|
"application/json": {
|
|
8592
|
+
allowedIpCidrs: string[];
|
|
8593
|
+
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
8594
|
/** Format: uuid */
|
|
8635
8595
|
id: string;
|
|
8636
8596
|
/**
|
|
@@ -8642,6 +8602,7 @@ export interface operations {
|
|
|
8642
8602
|
hint: string | null;
|
|
8643
8603
|
role: string | null;
|
|
8644
8604
|
scope: string | null;
|
|
8605
|
+
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
8606
|
apiToken: string;
|
|
8646
8607
|
};
|
|
8647
8608
|
};
|
|
@@ -26490,6 +26451,7 @@ export interface operations {
|
|
|
26490
26451
|
/** @description Value in cents (100 = 1€) */
|
|
26491
26452
|
operatingCentTotal: number;
|
|
26492
26453
|
editable: boolean;
|
|
26454
|
+
importable: boolean;
|
|
26493
26455
|
}[];
|
|
26494
26456
|
assignment: {
|
|
26495
26457
|
/** Format: uuid */
|
|
@@ -26502,12 +26464,6 @@ export interface operations {
|
|
|
26502
26464
|
/** @description Value in cents (100 = 1€) */
|
|
26503
26465
|
operatingCentTotal: number;
|
|
26504
26466
|
};
|
|
26505
|
-
trustReversal: {
|
|
26506
|
-
/** @enum {string} */
|
|
26507
|
-
status: "not_created" | "active" | "locked";
|
|
26508
|
-
journalEntryIds: string[];
|
|
26509
|
-
lastRefreshedAt?: string | null;
|
|
26510
|
-
};
|
|
26511
26467
|
};
|
|
26512
26468
|
};
|
|
26513
26469
|
};
|
|
@@ -26662,7 +26618,7 @@ export interface operations {
|
|
|
26662
26618
|
/** Format: uuid */
|
|
26663
26619
|
accountId: string;
|
|
26664
26620
|
/** @description Value in cents (100 = 1€) */
|
|
26665
|
-
|
|
26621
|
+
operatingCentTotal: number;
|
|
26666
26622
|
}[];
|
|
26667
26623
|
};
|
|
26668
26624
|
};
|
|
@@ -26702,6 +26658,7 @@ export interface operations {
|
|
|
26702
26658
|
/** @description Value in cents (100 = 1€) */
|
|
26703
26659
|
operatingCentTotal: number;
|
|
26704
26660
|
editable: boolean;
|
|
26661
|
+
importable: boolean;
|
|
26705
26662
|
}[];
|
|
26706
26663
|
assignment: {
|
|
26707
26664
|
/** Format: uuid */
|
|
@@ -26714,12 +26671,6 @@ export interface operations {
|
|
|
26714
26671
|
/** @description Value in cents (100 = 1€) */
|
|
26715
26672
|
operatingCentTotal: number;
|
|
26716
26673
|
};
|
|
26717
|
-
trustReversal: {
|
|
26718
|
-
/** @enum {string} */
|
|
26719
|
-
status: "not_created" | "active" | "locked";
|
|
26720
|
-
journalEntryIds: string[];
|
|
26721
|
-
lastRefreshedAt?: string | null;
|
|
26722
|
-
};
|
|
26723
26674
|
};
|
|
26724
26675
|
};
|
|
26725
26676
|
};
|
|
@@ -32312,507 +32263,6 @@ export interface operations {
|
|
|
32312
32263
|
};
|
|
32313
32264
|
};
|
|
32314
32265
|
};
|
|
32315
|
-
createPartnerApiKey: {
|
|
32316
|
-
parameters: {
|
|
32317
|
-
query?: never;
|
|
32318
|
-
header?: never;
|
|
32319
|
-
path?: never;
|
|
32320
|
-
cookie?: never;
|
|
32321
|
-
};
|
|
32322
|
-
requestBody?: {
|
|
32323
|
-
content: {
|
|
32324
|
-
"application/json": {
|
|
32325
|
-
/** @enum {string} */
|
|
32326
|
-
audience: "hostaway-production" | "hostaway-staging" | "vrplatform-production" | "vrplatform-staging";
|
|
32327
|
-
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")[];
|
|
32328
|
-
/** Format: uuid */
|
|
32329
|
-
partnerId: string;
|
|
32330
|
-
};
|
|
32331
|
-
};
|
|
32332
|
-
};
|
|
32333
|
-
responses: {
|
|
32334
|
-
/** @description Successful response */
|
|
32335
|
-
200: {
|
|
32336
|
-
headers: {
|
|
32337
|
-
[name: string]: unknown;
|
|
32338
|
-
};
|
|
32339
|
-
content: {
|
|
32340
|
-
"application/json": {
|
|
32341
|
-
/** @enum {string} */
|
|
32342
|
-
audience: "hostaway-production" | "hostaway-staging" | "vrplatform-production" | "vrplatform-staging";
|
|
32343
|
-
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")[];
|
|
32344
|
-
/** Format: uuid */
|
|
32345
|
-
id: string;
|
|
32346
|
-
/** Format: uuid */
|
|
32347
|
-
partnerId: string;
|
|
32348
|
-
secret: string;
|
|
32349
|
-
};
|
|
32350
|
-
};
|
|
32351
|
-
};
|
|
32352
|
-
/** @description Bad request */
|
|
32353
|
-
400: {
|
|
32354
|
-
headers: {
|
|
32355
|
-
[name: string]: unknown;
|
|
32356
|
-
};
|
|
32357
|
-
content: {
|
|
32358
|
-
"application/json": {
|
|
32359
|
-
code: string;
|
|
32360
|
-
message: string;
|
|
32361
|
-
links?: {
|
|
32362
|
-
docs: string;
|
|
32363
|
-
schema: string;
|
|
32364
|
-
};
|
|
32365
|
-
issues?: {
|
|
32366
|
-
message: string;
|
|
32367
|
-
path?: (string | number)[];
|
|
32368
|
-
schema?: string;
|
|
32369
|
-
}[];
|
|
32370
|
-
context?: unknown;
|
|
32371
|
-
};
|
|
32372
|
-
};
|
|
32373
|
-
};
|
|
32374
|
-
/** @description Unauthorized */
|
|
32375
|
-
401: {
|
|
32376
|
-
headers: {
|
|
32377
|
-
[name: string]: unknown;
|
|
32378
|
-
};
|
|
32379
|
-
content: {
|
|
32380
|
-
"application/json": {
|
|
32381
|
-
code: string;
|
|
32382
|
-
message: string;
|
|
32383
|
-
links?: {
|
|
32384
|
-
docs: string;
|
|
32385
|
-
schema: string;
|
|
32386
|
-
};
|
|
32387
|
-
issues?: {
|
|
32388
|
-
message: string;
|
|
32389
|
-
path?: (string | number)[];
|
|
32390
|
-
schema?: string;
|
|
32391
|
-
}[];
|
|
32392
|
-
context?: unknown;
|
|
32393
|
-
};
|
|
32394
|
-
};
|
|
32395
|
-
};
|
|
32396
|
-
/** @description Forbidden */
|
|
32397
|
-
403: {
|
|
32398
|
-
headers: {
|
|
32399
|
-
[name: string]: unknown;
|
|
32400
|
-
};
|
|
32401
|
-
content: {
|
|
32402
|
-
"application/json": {
|
|
32403
|
-
code: string;
|
|
32404
|
-
message: string;
|
|
32405
|
-
links?: {
|
|
32406
|
-
docs: string;
|
|
32407
|
-
schema: string;
|
|
32408
|
-
};
|
|
32409
|
-
issues?: {
|
|
32410
|
-
message: string;
|
|
32411
|
-
path?: (string | number)[];
|
|
32412
|
-
schema?: string;
|
|
32413
|
-
}[];
|
|
32414
|
-
context?: unknown;
|
|
32415
|
-
};
|
|
32416
|
-
};
|
|
32417
|
-
};
|
|
32418
|
-
/** @description Not found */
|
|
32419
|
-
404: {
|
|
32420
|
-
headers: {
|
|
32421
|
-
[name: string]: unknown;
|
|
32422
|
-
};
|
|
32423
|
-
content: {
|
|
32424
|
-
"application/json": {
|
|
32425
|
-
code: string;
|
|
32426
|
-
message: string;
|
|
32427
|
-
links?: {
|
|
32428
|
-
docs: string;
|
|
32429
|
-
schema: string;
|
|
32430
|
-
};
|
|
32431
|
-
issues?: {
|
|
32432
|
-
message: string;
|
|
32433
|
-
path?: (string | number)[];
|
|
32434
|
-
schema?: string;
|
|
32435
|
-
}[];
|
|
32436
|
-
context?: unknown;
|
|
32437
|
-
};
|
|
32438
|
-
};
|
|
32439
|
-
};
|
|
32440
|
-
/** @description Internal server error */
|
|
32441
|
-
500: {
|
|
32442
|
-
headers: {
|
|
32443
|
-
[name: string]: unknown;
|
|
32444
|
-
};
|
|
32445
|
-
content: {
|
|
32446
|
-
"application/json": {
|
|
32447
|
-
code: string;
|
|
32448
|
-
message: string;
|
|
32449
|
-
links?: {
|
|
32450
|
-
docs: string;
|
|
32451
|
-
schema: string;
|
|
32452
|
-
};
|
|
32453
|
-
issues?: {
|
|
32454
|
-
message: string;
|
|
32455
|
-
path?: (string | number)[];
|
|
32456
|
-
schema?: string;
|
|
32457
|
-
}[];
|
|
32458
|
-
context?: unknown;
|
|
32459
|
-
};
|
|
32460
|
-
};
|
|
32461
|
-
};
|
|
32462
|
-
/** @description Service unavailable */
|
|
32463
|
-
503: {
|
|
32464
|
-
headers: {
|
|
32465
|
-
[name: string]: unknown;
|
|
32466
|
-
};
|
|
32467
|
-
content: {
|
|
32468
|
-
"application/json": {
|
|
32469
|
-
code: string;
|
|
32470
|
-
message: string;
|
|
32471
|
-
links?: {
|
|
32472
|
-
docs: string;
|
|
32473
|
-
schema: string;
|
|
32474
|
-
};
|
|
32475
|
-
issues?: {
|
|
32476
|
-
message: string;
|
|
32477
|
-
path?: (string | number)[];
|
|
32478
|
-
schema?: string;
|
|
32479
|
-
}[];
|
|
32480
|
-
context?: unknown;
|
|
32481
|
-
};
|
|
32482
|
-
};
|
|
32483
|
-
};
|
|
32484
|
-
};
|
|
32485
|
-
};
|
|
32486
|
-
revokePartnerApiKey: {
|
|
32487
|
-
parameters: {
|
|
32488
|
-
query?: never;
|
|
32489
|
-
header?: never;
|
|
32490
|
-
path: {
|
|
32491
|
-
id: string;
|
|
32492
|
-
};
|
|
32493
|
-
cookie?: never;
|
|
32494
|
-
};
|
|
32495
|
-
requestBody?: {
|
|
32496
|
-
content: {
|
|
32497
|
-
"application/json": Record<string, never>;
|
|
32498
|
-
};
|
|
32499
|
-
};
|
|
32500
|
-
responses: {
|
|
32501
|
-
/** @description Successful response */
|
|
32502
|
-
200: {
|
|
32503
|
-
headers: {
|
|
32504
|
-
[name: string]: unknown;
|
|
32505
|
-
};
|
|
32506
|
-
content: {
|
|
32507
|
-
"application/json": {
|
|
32508
|
-
/** Format: uuid */
|
|
32509
|
-
id: string;
|
|
32510
|
-
/** @constant */
|
|
32511
|
-
status: "deleted";
|
|
32512
|
-
};
|
|
32513
|
-
};
|
|
32514
|
-
};
|
|
32515
|
-
/** @description Bad request */
|
|
32516
|
-
400: {
|
|
32517
|
-
headers: {
|
|
32518
|
-
[name: string]: unknown;
|
|
32519
|
-
};
|
|
32520
|
-
content: {
|
|
32521
|
-
"application/json": {
|
|
32522
|
-
code: string;
|
|
32523
|
-
message: string;
|
|
32524
|
-
links?: {
|
|
32525
|
-
docs: string;
|
|
32526
|
-
schema: string;
|
|
32527
|
-
};
|
|
32528
|
-
issues?: {
|
|
32529
|
-
message: string;
|
|
32530
|
-
path?: (string | number)[];
|
|
32531
|
-
schema?: string;
|
|
32532
|
-
}[];
|
|
32533
|
-
context?: unknown;
|
|
32534
|
-
};
|
|
32535
|
-
};
|
|
32536
|
-
};
|
|
32537
|
-
/** @description Unauthorized */
|
|
32538
|
-
401: {
|
|
32539
|
-
headers: {
|
|
32540
|
-
[name: string]: unknown;
|
|
32541
|
-
};
|
|
32542
|
-
content: {
|
|
32543
|
-
"application/json": {
|
|
32544
|
-
code: string;
|
|
32545
|
-
message: string;
|
|
32546
|
-
links?: {
|
|
32547
|
-
docs: string;
|
|
32548
|
-
schema: string;
|
|
32549
|
-
};
|
|
32550
|
-
issues?: {
|
|
32551
|
-
message: string;
|
|
32552
|
-
path?: (string | number)[];
|
|
32553
|
-
schema?: string;
|
|
32554
|
-
}[];
|
|
32555
|
-
context?: unknown;
|
|
32556
|
-
};
|
|
32557
|
-
};
|
|
32558
|
-
};
|
|
32559
|
-
/** @description Forbidden */
|
|
32560
|
-
403: {
|
|
32561
|
-
headers: {
|
|
32562
|
-
[name: string]: unknown;
|
|
32563
|
-
};
|
|
32564
|
-
content: {
|
|
32565
|
-
"application/json": {
|
|
32566
|
-
code: string;
|
|
32567
|
-
message: string;
|
|
32568
|
-
links?: {
|
|
32569
|
-
docs: string;
|
|
32570
|
-
schema: string;
|
|
32571
|
-
};
|
|
32572
|
-
issues?: {
|
|
32573
|
-
message: string;
|
|
32574
|
-
path?: (string | number)[];
|
|
32575
|
-
schema?: string;
|
|
32576
|
-
}[];
|
|
32577
|
-
context?: unknown;
|
|
32578
|
-
};
|
|
32579
|
-
};
|
|
32580
|
-
};
|
|
32581
|
-
/** @description Not found */
|
|
32582
|
-
404: {
|
|
32583
|
-
headers: {
|
|
32584
|
-
[name: string]: unknown;
|
|
32585
|
-
};
|
|
32586
|
-
content: {
|
|
32587
|
-
"application/json": {
|
|
32588
|
-
code: string;
|
|
32589
|
-
message: string;
|
|
32590
|
-
links?: {
|
|
32591
|
-
docs: string;
|
|
32592
|
-
schema: string;
|
|
32593
|
-
};
|
|
32594
|
-
issues?: {
|
|
32595
|
-
message: string;
|
|
32596
|
-
path?: (string | number)[];
|
|
32597
|
-
schema?: string;
|
|
32598
|
-
}[];
|
|
32599
|
-
context?: unknown;
|
|
32600
|
-
};
|
|
32601
|
-
};
|
|
32602
|
-
};
|
|
32603
|
-
/** @description Internal server error */
|
|
32604
|
-
500: {
|
|
32605
|
-
headers: {
|
|
32606
|
-
[name: string]: unknown;
|
|
32607
|
-
};
|
|
32608
|
-
content: {
|
|
32609
|
-
"application/json": {
|
|
32610
|
-
code: string;
|
|
32611
|
-
message: string;
|
|
32612
|
-
links?: {
|
|
32613
|
-
docs: string;
|
|
32614
|
-
schema: string;
|
|
32615
|
-
};
|
|
32616
|
-
issues?: {
|
|
32617
|
-
message: string;
|
|
32618
|
-
path?: (string | number)[];
|
|
32619
|
-
schema?: string;
|
|
32620
|
-
}[];
|
|
32621
|
-
context?: unknown;
|
|
32622
|
-
};
|
|
32623
|
-
};
|
|
32624
|
-
};
|
|
32625
|
-
/** @description Service unavailable */
|
|
32626
|
-
503: {
|
|
32627
|
-
headers: {
|
|
32628
|
-
[name: string]: unknown;
|
|
32629
|
-
};
|
|
32630
|
-
content: {
|
|
32631
|
-
"application/json": {
|
|
32632
|
-
code: string;
|
|
32633
|
-
message: string;
|
|
32634
|
-
links?: {
|
|
32635
|
-
docs: string;
|
|
32636
|
-
schema: string;
|
|
32637
|
-
};
|
|
32638
|
-
issues?: {
|
|
32639
|
-
message: string;
|
|
32640
|
-
path?: (string | number)[];
|
|
32641
|
-
schema?: string;
|
|
32642
|
-
}[];
|
|
32643
|
-
context?: unknown;
|
|
32644
|
-
};
|
|
32645
|
-
};
|
|
32646
|
-
};
|
|
32647
|
-
};
|
|
32648
|
-
};
|
|
32649
|
-
rotatePartnerApiKey: {
|
|
32650
|
-
parameters: {
|
|
32651
|
-
query?: never;
|
|
32652
|
-
header?: never;
|
|
32653
|
-
path: {
|
|
32654
|
-
id: string;
|
|
32655
|
-
};
|
|
32656
|
-
cookie?: never;
|
|
32657
|
-
};
|
|
32658
|
-
requestBody?: {
|
|
32659
|
-
content: {
|
|
32660
|
-
"application/json": Record<string, never>;
|
|
32661
|
-
};
|
|
32662
|
-
};
|
|
32663
|
-
responses: {
|
|
32664
|
-
/** @description Successful response */
|
|
32665
|
-
200: {
|
|
32666
|
-
headers: {
|
|
32667
|
-
[name: string]: unknown;
|
|
32668
|
-
};
|
|
32669
|
-
content: {
|
|
32670
|
-
"application/json": {
|
|
32671
|
-
/** @enum {string} */
|
|
32672
|
-
audience: "hostaway-production" | "hostaway-staging" | "vrplatform-production" | "vrplatform-staging";
|
|
32673
|
-
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")[];
|
|
32674
|
-
/** Format: uuid */
|
|
32675
|
-
id: string;
|
|
32676
|
-
/** Format: uuid */
|
|
32677
|
-
partnerId: string;
|
|
32678
|
-
secret: string;
|
|
32679
|
-
};
|
|
32680
|
-
};
|
|
32681
|
-
};
|
|
32682
|
-
/** @description Bad request */
|
|
32683
|
-
400: {
|
|
32684
|
-
headers: {
|
|
32685
|
-
[name: string]: unknown;
|
|
32686
|
-
};
|
|
32687
|
-
content: {
|
|
32688
|
-
"application/json": {
|
|
32689
|
-
code: string;
|
|
32690
|
-
message: string;
|
|
32691
|
-
links?: {
|
|
32692
|
-
docs: string;
|
|
32693
|
-
schema: string;
|
|
32694
|
-
};
|
|
32695
|
-
issues?: {
|
|
32696
|
-
message: string;
|
|
32697
|
-
path?: (string | number)[];
|
|
32698
|
-
schema?: string;
|
|
32699
|
-
}[];
|
|
32700
|
-
context?: unknown;
|
|
32701
|
-
};
|
|
32702
|
-
};
|
|
32703
|
-
};
|
|
32704
|
-
/** @description Unauthorized */
|
|
32705
|
-
401: {
|
|
32706
|
-
headers: {
|
|
32707
|
-
[name: string]: unknown;
|
|
32708
|
-
};
|
|
32709
|
-
content: {
|
|
32710
|
-
"application/json": {
|
|
32711
|
-
code: string;
|
|
32712
|
-
message: string;
|
|
32713
|
-
links?: {
|
|
32714
|
-
docs: string;
|
|
32715
|
-
schema: string;
|
|
32716
|
-
};
|
|
32717
|
-
issues?: {
|
|
32718
|
-
message: string;
|
|
32719
|
-
path?: (string | number)[];
|
|
32720
|
-
schema?: string;
|
|
32721
|
-
}[];
|
|
32722
|
-
context?: unknown;
|
|
32723
|
-
};
|
|
32724
|
-
};
|
|
32725
|
-
};
|
|
32726
|
-
/** @description Forbidden */
|
|
32727
|
-
403: {
|
|
32728
|
-
headers: {
|
|
32729
|
-
[name: string]: unknown;
|
|
32730
|
-
};
|
|
32731
|
-
content: {
|
|
32732
|
-
"application/json": {
|
|
32733
|
-
code: string;
|
|
32734
|
-
message: string;
|
|
32735
|
-
links?: {
|
|
32736
|
-
docs: string;
|
|
32737
|
-
schema: string;
|
|
32738
|
-
};
|
|
32739
|
-
issues?: {
|
|
32740
|
-
message: string;
|
|
32741
|
-
path?: (string | number)[];
|
|
32742
|
-
schema?: string;
|
|
32743
|
-
}[];
|
|
32744
|
-
context?: unknown;
|
|
32745
|
-
};
|
|
32746
|
-
};
|
|
32747
|
-
};
|
|
32748
|
-
/** @description Not found */
|
|
32749
|
-
404: {
|
|
32750
|
-
headers: {
|
|
32751
|
-
[name: string]: unknown;
|
|
32752
|
-
};
|
|
32753
|
-
content: {
|
|
32754
|
-
"application/json": {
|
|
32755
|
-
code: string;
|
|
32756
|
-
message: string;
|
|
32757
|
-
links?: {
|
|
32758
|
-
docs: string;
|
|
32759
|
-
schema: string;
|
|
32760
|
-
};
|
|
32761
|
-
issues?: {
|
|
32762
|
-
message: string;
|
|
32763
|
-
path?: (string | number)[];
|
|
32764
|
-
schema?: string;
|
|
32765
|
-
}[];
|
|
32766
|
-
context?: unknown;
|
|
32767
|
-
};
|
|
32768
|
-
};
|
|
32769
|
-
};
|
|
32770
|
-
/** @description Internal server error */
|
|
32771
|
-
500: {
|
|
32772
|
-
headers: {
|
|
32773
|
-
[name: string]: unknown;
|
|
32774
|
-
};
|
|
32775
|
-
content: {
|
|
32776
|
-
"application/json": {
|
|
32777
|
-
code: string;
|
|
32778
|
-
message: string;
|
|
32779
|
-
links?: {
|
|
32780
|
-
docs: string;
|
|
32781
|
-
schema: string;
|
|
32782
|
-
};
|
|
32783
|
-
issues?: {
|
|
32784
|
-
message: string;
|
|
32785
|
-
path?: (string | number)[];
|
|
32786
|
-
schema?: string;
|
|
32787
|
-
}[];
|
|
32788
|
-
context?: unknown;
|
|
32789
|
-
};
|
|
32790
|
-
};
|
|
32791
|
-
};
|
|
32792
|
-
/** @description Service unavailable */
|
|
32793
|
-
503: {
|
|
32794
|
-
headers: {
|
|
32795
|
-
[name: string]: unknown;
|
|
32796
|
-
};
|
|
32797
|
-
content: {
|
|
32798
|
-
"application/json": {
|
|
32799
|
-
code: string;
|
|
32800
|
-
message: string;
|
|
32801
|
-
links?: {
|
|
32802
|
-
docs: string;
|
|
32803
|
-
schema: string;
|
|
32804
|
-
};
|
|
32805
|
-
issues?: {
|
|
32806
|
-
message: string;
|
|
32807
|
-
path?: (string | number)[];
|
|
32808
|
-
schema?: string;
|
|
32809
|
-
}[];
|
|
32810
|
-
context?: unknown;
|
|
32811
|
-
};
|
|
32812
|
-
};
|
|
32813
|
-
};
|
|
32814
|
-
};
|
|
32815
|
-
};
|
|
32816
32266
|
getInternalUsers: {
|
|
32817
32267
|
parameters: {
|
|
32818
32268
|
query?: {
|