@vrplatform/api 1.3.1-stage.4728 → 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.
@@ -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 Create an API token for the current team. Requires an authenticated team admin. The token secret is never written to audit records. */
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;
@@ -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 Client-generated API token secret to store. */
8456
- apiToken: string;
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
  };
@@ -32302,507 +32263,6 @@ export interface operations {
32302
32263
  };
32303
32264
  };
32304
32265
  };
32305
- createPartnerApiKey: {
32306
- parameters: {
32307
- query?: never;
32308
- header?: never;
32309
- path?: never;
32310
- cookie?: never;
32311
- };
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
- };
32323
- responses: {
32324
- /** @description Successful response */
32325
- 200: {
32326
- headers: {
32327
- [name: string]: unknown;
32328
- };
32329
- content: {
32330
- "application/json": {
32331
- /** @enum {string} */
32332
- audience: "hostaway-production" | "hostaway-staging" | "vrplatform-production" | "vrplatform-staging";
32333
- 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")[];
32334
- /** Format: uuid */
32335
- id: string;
32336
- /** Format: uuid */
32337
- partnerId: string;
32338
- secret: string;
32339
- };
32340
- };
32341
- };
32342
- /** @description Bad request */
32343
- 400: {
32344
- headers: {
32345
- [name: string]: unknown;
32346
- };
32347
- content: {
32348
- "application/json": {
32349
- code: string;
32350
- message: string;
32351
- links?: {
32352
- docs: string;
32353
- schema: string;
32354
- };
32355
- issues?: {
32356
- message: string;
32357
- path?: (string | number)[];
32358
- schema?: string;
32359
- }[];
32360
- context?: unknown;
32361
- };
32362
- };
32363
- };
32364
- /** @description Unauthorized */
32365
- 401: {
32366
- headers: {
32367
- [name: string]: unknown;
32368
- };
32369
- content: {
32370
- "application/json": {
32371
- code: string;
32372
- message: string;
32373
- links?: {
32374
- docs: string;
32375
- schema: string;
32376
- };
32377
- issues?: {
32378
- message: string;
32379
- path?: (string | number)[];
32380
- schema?: string;
32381
- }[];
32382
- context?: unknown;
32383
- };
32384
- };
32385
- };
32386
- /** @description Forbidden */
32387
- 403: {
32388
- headers: {
32389
- [name: string]: unknown;
32390
- };
32391
- content: {
32392
- "application/json": {
32393
- code: string;
32394
- message: string;
32395
- links?: {
32396
- docs: string;
32397
- schema: string;
32398
- };
32399
- issues?: {
32400
- message: string;
32401
- path?: (string | number)[];
32402
- schema?: string;
32403
- }[];
32404
- context?: unknown;
32405
- };
32406
- };
32407
- };
32408
- /** @description Not found */
32409
- 404: {
32410
- headers: {
32411
- [name: string]: unknown;
32412
- };
32413
- content: {
32414
- "application/json": {
32415
- code: string;
32416
- message: string;
32417
- links?: {
32418
- docs: string;
32419
- schema: string;
32420
- };
32421
- issues?: {
32422
- message: string;
32423
- path?: (string | number)[];
32424
- schema?: string;
32425
- }[];
32426
- context?: unknown;
32427
- };
32428
- };
32429
- };
32430
- /** @description Internal server error */
32431
- 500: {
32432
- headers: {
32433
- [name: string]: unknown;
32434
- };
32435
- content: {
32436
- "application/json": {
32437
- code: string;
32438
- message: string;
32439
- links?: {
32440
- docs: string;
32441
- schema: string;
32442
- };
32443
- issues?: {
32444
- message: string;
32445
- path?: (string | number)[];
32446
- schema?: string;
32447
- }[];
32448
- context?: unknown;
32449
- };
32450
- };
32451
- };
32452
- /** @description Service unavailable */
32453
- 503: {
32454
- headers: {
32455
- [name: string]: unknown;
32456
- };
32457
- content: {
32458
- "application/json": {
32459
- code: string;
32460
- message: string;
32461
- links?: {
32462
- docs: string;
32463
- schema: string;
32464
- };
32465
- issues?: {
32466
- message: string;
32467
- path?: (string | number)[];
32468
- schema?: string;
32469
- }[];
32470
- context?: unknown;
32471
- };
32472
- };
32473
- };
32474
- };
32475
- };
32476
- revokePartnerApiKey: {
32477
- parameters: {
32478
- query?: never;
32479
- header?: never;
32480
- path: {
32481
- id: string;
32482
- };
32483
- cookie?: never;
32484
- };
32485
- requestBody?: {
32486
- content: {
32487
- "application/json": Record<string, never>;
32488
- };
32489
- };
32490
- responses: {
32491
- /** @description Successful response */
32492
- 200: {
32493
- headers: {
32494
- [name: string]: unknown;
32495
- };
32496
- content: {
32497
- "application/json": {
32498
- /** Format: uuid */
32499
- id: string;
32500
- /** @constant */
32501
- status: "deleted";
32502
- };
32503
- };
32504
- };
32505
- /** @description Bad request */
32506
- 400: {
32507
- headers: {
32508
- [name: string]: unknown;
32509
- };
32510
- content: {
32511
- "application/json": {
32512
- code: string;
32513
- message: string;
32514
- links?: {
32515
- docs: string;
32516
- schema: string;
32517
- };
32518
- issues?: {
32519
- message: string;
32520
- path?: (string | number)[];
32521
- schema?: string;
32522
- }[];
32523
- context?: unknown;
32524
- };
32525
- };
32526
- };
32527
- /** @description Unauthorized */
32528
- 401: {
32529
- headers: {
32530
- [name: string]: unknown;
32531
- };
32532
- content: {
32533
- "application/json": {
32534
- code: string;
32535
- message: string;
32536
- links?: {
32537
- docs: string;
32538
- schema: string;
32539
- };
32540
- issues?: {
32541
- message: string;
32542
- path?: (string | number)[];
32543
- schema?: string;
32544
- }[];
32545
- context?: unknown;
32546
- };
32547
- };
32548
- };
32549
- /** @description Forbidden */
32550
- 403: {
32551
- headers: {
32552
- [name: string]: unknown;
32553
- };
32554
- content: {
32555
- "application/json": {
32556
- code: string;
32557
- message: string;
32558
- links?: {
32559
- docs: string;
32560
- schema: string;
32561
- };
32562
- issues?: {
32563
- message: string;
32564
- path?: (string | number)[];
32565
- schema?: string;
32566
- }[];
32567
- context?: unknown;
32568
- };
32569
- };
32570
- };
32571
- /** @description Not found */
32572
- 404: {
32573
- headers: {
32574
- [name: string]: unknown;
32575
- };
32576
- content: {
32577
- "application/json": {
32578
- code: string;
32579
- message: string;
32580
- links?: {
32581
- docs: string;
32582
- schema: string;
32583
- };
32584
- issues?: {
32585
- message: string;
32586
- path?: (string | number)[];
32587
- schema?: string;
32588
- }[];
32589
- context?: unknown;
32590
- };
32591
- };
32592
- };
32593
- /** @description Internal server error */
32594
- 500: {
32595
- headers: {
32596
- [name: string]: unknown;
32597
- };
32598
- content: {
32599
- "application/json": {
32600
- code: string;
32601
- message: string;
32602
- links?: {
32603
- docs: string;
32604
- schema: string;
32605
- };
32606
- issues?: {
32607
- message: string;
32608
- path?: (string | number)[];
32609
- schema?: string;
32610
- }[];
32611
- context?: unknown;
32612
- };
32613
- };
32614
- };
32615
- /** @description Service unavailable */
32616
- 503: {
32617
- headers: {
32618
- [name: string]: unknown;
32619
- };
32620
- content: {
32621
- "application/json": {
32622
- code: string;
32623
- message: string;
32624
- links?: {
32625
- docs: string;
32626
- schema: string;
32627
- };
32628
- issues?: {
32629
- message: string;
32630
- path?: (string | number)[];
32631
- schema?: string;
32632
- }[];
32633
- context?: unknown;
32634
- };
32635
- };
32636
- };
32637
- };
32638
- };
32639
- rotatePartnerApiKey: {
32640
- parameters: {
32641
- query?: never;
32642
- header?: never;
32643
- path: {
32644
- id: string;
32645
- };
32646
- cookie?: never;
32647
- };
32648
- requestBody?: {
32649
- content: {
32650
- "application/json": Record<string, never>;
32651
- };
32652
- };
32653
- responses: {
32654
- /** @description Successful response */
32655
- 200: {
32656
- headers: {
32657
- [name: string]: unknown;
32658
- };
32659
- content: {
32660
- "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
- /** Format: uuid */
32665
- id: string;
32666
- /** Format: uuid */
32667
- partnerId: string;
32668
- secret: string;
32669
- };
32670
- };
32671
- };
32672
- /** @description Bad request */
32673
- 400: {
32674
- headers: {
32675
- [name: string]: unknown;
32676
- };
32677
- content: {
32678
- "application/json": {
32679
- code: string;
32680
- message: string;
32681
- links?: {
32682
- docs: string;
32683
- schema: string;
32684
- };
32685
- issues?: {
32686
- message: string;
32687
- path?: (string | number)[];
32688
- schema?: string;
32689
- }[];
32690
- context?: unknown;
32691
- };
32692
- };
32693
- };
32694
- /** @description Unauthorized */
32695
- 401: {
32696
- headers: {
32697
- [name: string]: unknown;
32698
- };
32699
- content: {
32700
- "application/json": {
32701
- code: string;
32702
- message: string;
32703
- links?: {
32704
- docs: string;
32705
- schema: string;
32706
- };
32707
- issues?: {
32708
- message: string;
32709
- path?: (string | number)[];
32710
- schema?: string;
32711
- }[];
32712
- context?: unknown;
32713
- };
32714
- };
32715
- };
32716
- /** @description Forbidden */
32717
- 403: {
32718
- headers: {
32719
- [name: string]: unknown;
32720
- };
32721
- content: {
32722
- "application/json": {
32723
- code: string;
32724
- message: string;
32725
- links?: {
32726
- docs: string;
32727
- schema: string;
32728
- };
32729
- issues?: {
32730
- message: string;
32731
- path?: (string | number)[];
32732
- schema?: string;
32733
- }[];
32734
- context?: unknown;
32735
- };
32736
- };
32737
- };
32738
- /** @description Not found */
32739
- 404: {
32740
- headers: {
32741
- [name: string]: unknown;
32742
- };
32743
- content: {
32744
- "application/json": {
32745
- code: string;
32746
- message: string;
32747
- links?: {
32748
- docs: string;
32749
- schema: string;
32750
- };
32751
- issues?: {
32752
- message: string;
32753
- path?: (string | number)[];
32754
- schema?: string;
32755
- }[];
32756
- context?: unknown;
32757
- };
32758
- };
32759
- };
32760
- /** @description Internal server error */
32761
- 500: {
32762
- headers: {
32763
- [name: string]: unknown;
32764
- };
32765
- content: {
32766
- "application/json": {
32767
- code: string;
32768
- message: string;
32769
- links?: {
32770
- docs: string;
32771
- schema: string;
32772
- };
32773
- issues?: {
32774
- message: string;
32775
- path?: (string | number)[];
32776
- schema?: string;
32777
- }[];
32778
- context?: unknown;
32779
- };
32780
- };
32781
- };
32782
- /** @description Service unavailable */
32783
- 503: {
32784
- headers: {
32785
- [name: string]: unknown;
32786
- };
32787
- content: {
32788
- "application/json": {
32789
- code: string;
32790
- message: string;
32791
- links?: {
32792
- docs: string;
32793
- schema: string;
32794
- };
32795
- issues?: {
32796
- message: string;
32797
- path?: (string | number)[];
32798
- schema?: string;
32799
- }[];
32800
- context?: unknown;
32801
- };
32802
- };
32803
- };
32804
- };
32805
- };
32806
32266
  getInternalUsers: {
32807
32267
  parameters: {
32808
32268
  query?: {