@vrplatform/api 1.3.1-stage.5837 → 1.3.1-stage.5856
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/package.json
CHANGED
package/src/generated/v1.ts
CHANGED
|
@@ -181,7 +181,7 @@ export interface paths {
|
|
|
181
181
|
get?: never;
|
|
182
182
|
put?: never;
|
|
183
183
|
/**
|
|
184
|
-
* @description Atomically initialize banking and return the complete opening-balance transaction and feed checkpoint. Credit cards store a negative feed balance while the journal credits the liability.
|
|
184
|
+
* @description Atomically initialize banking and return the complete opening-balance transaction and feed checkpoint. Credit cards store a negative feed balance while the journal credits the liability. Initialization can run before the team has selected its statement start date.
|
|
185
185
|
*
|
|
186
186
|
* Required scope: bank-accounts:write
|
|
187
187
|
*/
|
|
@@ -803,7 +803,7 @@ export interface paths {
|
|
|
803
803
|
get?: never;
|
|
804
804
|
put?: never;
|
|
805
805
|
/**
|
|
806
|
-
* @description Connect an app and create the connection. OAuth defaults to https://portal.vrplatform.app/callback/ when redirectTo is omitted. The legacy production /callback path is normalized to /callback/. Provider integrations must return stable account identity. The built-in API app receives server-generated connection identity. PMS connections queue durable reservation line-mapping initialization. Hostaway webhook reconciliation runs after credentials are stored. Provider tasks may take up to 25 seconds. Tasks that exceed the limit return ERROR_TIMEOUT.
|
|
806
|
+
* @description Connect an app and create the connection. OAuth defaults to https://portal.vrplatform.app/callback/ when redirectTo is omitted. The legacy production /callback path is normalized to /callback/. Provider integrations must return stable account identity. The built-in API app receives server-generated connection identity. PMS connections queue durable reservation line-mapping initialization. Hostaway webhook reconciliation runs after credentials are stored. Ramp connections activate and run chart-of-accounts synchronization when autoExtract is enabled. Provider tasks may take up to 25 seconds. Tasks that exceed the limit return ERROR_TIMEOUT.
|
|
807
807
|
*
|
|
808
808
|
* Required scope: integrations:write
|
|
809
809
|
*/
|
|
@@ -960,7 +960,7 @@ export interface paths {
|
|
|
960
960
|
get?: never;
|
|
961
961
|
put?: never;
|
|
962
962
|
/**
|
|
963
|
-
* @description Reconnect an existing app connection. OAuth defaults to https://portal.vrplatform.app/callback/ when redirectTo is omitted. The legacy production /callback path is normalized to /callback/. The built-in API app preserves its existing server-generated identity. Provider identities owned by another connection are rejected before mutation. PMS reconnections queue durable reservation line-mapping initialization. Hostaway webhook reconciliation runs after credentials are stored. Provider tasks may take up to 25 seconds. Tasks that exceed the limit return ERROR_TIMEOUT.
|
|
963
|
+
* @description Reconnect an existing app connection. OAuth defaults to https://portal.vrplatform.app/callback/ when redirectTo is omitted. The legacy production /callback path is normalized to /callback/. The built-in API app preserves its existing server-generated identity. Provider identities owned by another connection are rejected before mutation. PMS reconnections queue durable reservation line-mapping initialization. Hostaway webhook reconciliation runs after credentials are stored. Ramp reconnections run chart-of-accounts synchronization unless that flow is explicitly inactive. Provider tasks may take up to 25 seconds. Tasks that exceed the limit return ERROR_TIMEOUT.
|
|
964
964
|
*
|
|
965
965
|
* Required scope: integrations:write
|
|
966
966
|
*/
|
|
@@ -1918,7 +1918,8 @@ export interface paths {
|
|
|
1918
1918
|
get: operations["getInternalBlobsByStore"];
|
|
1919
1919
|
put?: never;
|
|
1920
1920
|
post?: never;
|
|
1921
|
-
|
|
1921
|
+
/** @description Delete stored blobs by their self-describing r2:// refs. Every ref must belong to the store in the path and to the authenticated tenant. Missing objects are treated as deleted. */
|
|
1922
|
+
delete: operations["deleteInternalBlobsByStore"];
|
|
1922
1923
|
options?: never;
|
|
1923
1924
|
head?: never;
|
|
1924
1925
|
patch?: never;
|
|
@@ -3550,7 +3551,7 @@ export interface paths {
|
|
|
3550
3551
|
get?: never;
|
|
3551
3552
|
put?: never;
|
|
3552
3553
|
/**
|
|
3553
|
-
* @description Apply every required bank-account configuration for a Plaid connect session in one mutation, then create exactly one durable initial transaction sync. Connect decisions can reference an eligible existing GL bank account or create one using the normal account schema. Archive decisions make the external feed inactive. The earliest selected startDate controls history ingestion. Repeating a completed connectId returns the same sync. If eligibility changed after completion, a PLAID_CONNECT_CONFIGURATION_CHANGED conflict returns the refreshed screen model in context.result. See https://docs.vrplatform.app/guides/build/banking.
|
|
3554
|
+
* @description Apply every required bank-account configuration for a Plaid connect session in one mutation, then create exactly one durable initial transaction sync. Connect decisions can reference an eligible existing GL bank account or create one using the normal account schema. An explicit opening balance can be initialized before the team has selected its statement start date. Selecting an eligible GL account may transfer it from inactive predecessor feeds only while preserving historical bank-record ownership. Archive decisions make the external feed inactive. The earliest selected startDate controls history ingestion. Repeating a completed connectId returns the same sync. If eligibility or the active feed mapping changed after completion, a PLAID_CONNECT_CONFIGURATION_CHANGED conflict returns the refreshed screen model in context.result. See https://docs.vrplatform.app/guides/build/banking.
|
|
3554
3555
|
*
|
|
3555
3556
|
* Required scope: bank-connections:manage
|
|
3556
3557
|
*/
|
|
@@ -4462,7 +4463,7 @@ export interface paths {
|
|
|
4462
4463
|
get?: never;
|
|
4463
4464
|
put?: never;
|
|
4464
4465
|
/**
|
|
4465
|
-
* @description Regenerate reservation journal entries. Recomputes postings from the current reservation financials for the given ids (or the whole portfolio) and rewrites unlocked entries; lockPolicy controls how lock-flagged reservations are handled, while books-closed and owner-statement attachment locks always apply. bypassStatementPeriod is only supported for a single-reservation refresh. Generic dry run is unavailable because this operation needs a dedicated consequence preview for projected posting changes. See https://docs.vrplatform.app/guides/build/reservations.
|
|
4466
|
+
* @description Regenerate reservation journal entries. Recomputes postings from the current reservation financials for the given ids (or the whole portfolio) and rewrites unlocked entries; lockPolicy controls how lock-flagged reservations are handled, while books-closed and owner-statement attachment locks always apply. If applying only unlocked changes would split an otherwise balanced journal group, the refresh returns a structured journalEntries lock and writes nothing. bypassStatementPeriod is only supported for a single-reservation refresh. Generic dry run is unavailable because this operation needs a dedicated consequence preview for projected posting changes. See https://docs.vrplatform.app/guides/build/reservations.
|
|
4466
4467
|
*
|
|
4467
4468
|
* Required scope: reservations:post-journals
|
|
4468
4469
|
*/
|
|
@@ -22550,7 +22551,10 @@ export interface operations {
|
|
|
22550
22551
|
"application/json": {
|
|
22551
22552
|
appId?: string;
|
|
22552
22553
|
name?: string;
|
|
22553
|
-
/**
|
|
22554
|
+
/**
|
|
22555
|
+
* @description Start the provider synchronization after connecting. Ramp also activates and runs its chart-of-accounts push.
|
|
22556
|
+
* @default true
|
|
22557
|
+
*/
|
|
22554
22558
|
autoExtract?: boolean;
|
|
22555
22559
|
sessionKey?: string;
|
|
22556
22560
|
/** Format: uri */
|
|
@@ -25213,7 +25217,10 @@ export interface operations {
|
|
|
25213
25217
|
"application/json": {
|
|
25214
25218
|
appId?: string;
|
|
25215
25219
|
name?: string;
|
|
25216
|
-
/**
|
|
25220
|
+
/**
|
|
25221
|
+
* @description Start the provider synchronization after connecting. Ramp also activates and runs its chart-of-accounts push.
|
|
25222
|
+
* @default true
|
|
25223
|
+
*/
|
|
25217
25224
|
autoExtract?: boolean;
|
|
25218
25225
|
sessionKey?: string;
|
|
25219
25226
|
/** Format: uri */
|
|
@@ -41471,6 +41478,262 @@ export interface operations {
|
|
|
41471
41478
|
};
|
|
41472
41479
|
};
|
|
41473
41480
|
};
|
|
41481
|
+
deleteInternalBlobsByStore: {
|
|
41482
|
+
parameters: {
|
|
41483
|
+
query?: never;
|
|
41484
|
+
header?: never;
|
|
41485
|
+
path: {
|
|
41486
|
+
store: "api-attachments";
|
|
41487
|
+
};
|
|
41488
|
+
cookie?: never;
|
|
41489
|
+
};
|
|
41490
|
+
requestBody?: {
|
|
41491
|
+
content: {
|
|
41492
|
+
"application/json": {
|
|
41493
|
+
refs: string[];
|
|
41494
|
+
};
|
|
41495
|
+
};
|
|
41496
|
+
};
|
|
41497
|
+
responses: {
|
|
41498
|
+
/** @description Successful response */
|
|
41499
|
+
200: {
|
|
41500
|
+
headers: {
|
|
41501
|
+
[name: string]: unknown;
|
|
41502
|
+
};
|
|
41503
|
+
content: {
|
|
41504
|
+
"application/json": {
|
|
41505
|
+
/** @constant */
|
|
41506
|
+
status: "deleted";
|
|
41507
|
+
};
|
|
41508
|
+
};
|
|
41509
|
+
};
|
|
41510
|
+
/** @description Bad request */
|
|
41511
|
+
400: {
|
|
41512
|
+
headers: {
|
|
41513
|
+
/** @description Seconds to wait when retryable=true and the server supplies a delay. */
|
|
41514
|
+
"Retry-After"?: number;
|
|
41515
|
+
[name: string]: unknown;
|
|
41516
|
+
};
|
|
41517
|
+
content: {
|
|
41518
|
+
"application/json": {
|
|
41519
|
+
code: string;
|
|
41520
|
+
message: string;
|
|
41521
|
+
links?: {
|
|
41522
|
+
docs: string;
|
|
41523
|
+
schema: string;
|
|
41524
|
+
};
|
|
41525
|
+
issues?: {
|
|
41526
|
+
message: string;
|
|
41527
|
+
path?: (string | number)[];
|
|
41528
|
+
schema?: string;
|
|
41529
|
+
}[];
|
|
41530
|
+
retryable?: boolean;
|
|
41531
|
+
context?: unknown;
|
|
41532
|
+
};
|
|
41533
|
+
};
|
|
41534
|
+
};
|
|
41535
|
+
/** @description Unauthorized */
|
|
41536
|
+
401: {
|
|
41537
|
+
headers: {
|
|
41538
|
+
/** @description Seconds to wait when retryable=true and the server supplies a delay. */
|
|
41539
|
+
"Retry-After"?: number;
|
|
41540
|
+
[name: string]: unknown;
|
|
41541
|
+
};
|
|
41542
|
+
content: {
|
|
41543
|
+
"application/json": {
|
|
41544
|
+
code: string;
|
|
41545
|
+
message: string;
|
|
41546
|
+
links?: {
|
|
41547
|
+
docs: string;
|
|
41548
|
+
schema: string;
|
|
41549
|
+
};
|
|
41550
|
+
issues?: {
|
|
41551
|
+
message: string;
|
|
41552
|
+
path?: (string | number)[];
|
|
41553
|
+
schema?: string;
|
|
41554
|
+
}[];
|
|
41555
|
+
retryable?: boolean;
|
|
41556
|
+
context?: unknown;
|
|
41557
|
+
};
|
|
41558
|
+
};
|
|
41559
|
+
};
|
|
41560
|
+
/** @description Forbidden */
|
|
41561
|
+
403: {
|
|
41562
|
+
headers: {
|
|
41563
|
+
/** @description Seconds to wait when retryable=true and the server supplies a delay. */
|
|
41564
|
+
"Retry-After"?: number;
|
|
41565
|
+
[name: string]: unknown;
|
|
41566
|
+
};
|
|
41567
|
+
content: {
|
|
41568
|
+
"application/json": {
|
|
41569
|
+
code: string;
|
|
41570
|
+
message: string;
|
|
41571
|
+
links?: {
|
|
41572
|
+
docs: string;
|
|
41573
|
+
schema: string;
|
|
41574
|
+
};
|
|
41575
|
+
issues?: {
|
|
41576
|
+
message: string;
|
|
41577
|
+
path?: (string | number)[];
|
|
41578
|
+
schema?: string;
|
|
41579
|
+
}[];
|
|
41580
|
+
retryable?: boolean;
|
|
41581
|
+
context?: unknown;
|
|
41582
|
+
};
|
|
41583
|
+
};
|
|
41584
|
+
};
|
|
41585
|
+
/** @description Not found */
|
|
41586
|
+
404: {
|
|
41587
|
+
headers: {
|
|
41588
|
+
/** @description Seconds to wait when retryable=true and the server supplies a delay. */
|
|
41589
|
+
"Retry-After"?: number;
|
|
41590
|
+
[name: string]: unknown;
|
|
41591
|
+
};
|
|
41592
|
+
content: {
|
|
41593
|
+
"application/json": {
|
|
41594
|
+
code: string;
|
|
41595
|
+
message: string;
|
|
41596
|
+
links?: {
|
|
41597
|
+
docs: string;
|
|
41598
|
+
schema: string;
|
|
41599
|
+
};
|
|
41600
|
+
issues?: {
|
|
41601
|
+
message: string;
|
|
41602
|
+
path?: (string | number)[];
|
|
41603
|
+
schema?: string;
|
|
41604
|
+
}[];
|
|
41605
|
+
retryable?: boolean;
|
|
41606
|
+
context?: unknown;
|
|
41607
|
+
};
|
|
41608
|
+
};
|
|
41609
|
+
};
|
|
41610
|
+
/** @description Conflict */
|
|
41611
|
+
409: {
|
|
41612
|
+
headers: {
|
|
41613
|
+
/** @description Seconds to wait when retryable=true and the server supplies a delay. */
|
|
41614
|
+
"Retry-After"?: number;
|
|
41615
|
+
[name: string]: unknown;
|
|
41616
|
+
};
|
|
41617
|
+
content: {
|
|
41618
|
+
"application/json": {
|
|
41619
|
+
code: string;
|
|
41620
|
+
message: string;
|
|
41621
|
+
links?: {
|
|
41622
|
+
docs: string;
|
|
41623
|
+
schema: string;
|
|
41624
|
+
};
|
|
41625
|
+
issues?: {
|
|
41626
|
+
message: string;
|
|
41627
|
+
path?: (string | number)[];
|
|
41628
|
+
schema?: string;
|
|
41629
|
+
}[];
|
|
41630
|
+
retryable?: boolean;
|
|
41631
|
+
context?: unknown;
|
|
41632
|
+
};
|
|
41633
|
+
};
|
|
41634
|
+
};
|
|
41635
|
+
/** @description Gone */
|
|
41636
|
+
410: {
|
|
41637
|
+
headers: {
|
|
41638
|
+
/** @description Seconds to wait when retryable=true and the server supplies a delay. */
|
|
41639
|
+
"Retry-After"?: number;
|
|
41640
|
+
[name: string]: unknown;
|
|
41641
|
+
};
|
|
41642
|
+
content: {
|
|
41643
|
+
"application/json": {
|
|
41644
|
+
code: string;
|
|
41645
|
+
message: string;
|
|
41646
|
+
links?: {
|
|
41647
|
+
docs: string;
|
|
41648
|
+
schema: string;
|
|
41649
|
+
};
|
|
41650
|
+
issues?: {
|
|
41651
|
+
message: string;
|
|
41652
|
+
path?: (string | number)[];
|
|
41653
|
+
schema?: string;
|
|
41654
|
+
}[];
|
|
41655
|
+
retryable?: boolean;
|
|
41656
|
+
context?: unknown;
|
|
41657
|
+
};
|
|
41658
|
+
};
|
|
41659
|
+
};
|
|
41660
|
+
/** @description Unprocessable content */
|
|
41661
|
+
422: {
|
|
41662
|
+
headers: {
|
|
41663
|
+
/** @description Seconds to wait when retryable=true and the server supplies a delay. */
|
|
41664
|
+
"Retry-After"?: number;
|
|
41665
|
+
[name: string]: unknown;
|
|
41666
|
+
};
|
|
41667
|
+
content: {
|
|
41668
|
+
"application/json": {
|
|
41669
|
+
code: string;
|
|
41670
|
+
message: string;
|
|
41671
|
+
links?: {
|
|
41672
|
+
docs: string;
|
|
41673
|
+
schema: string;
|
|
41674
|
+
};
|
|
41675
|
+
issues?: {
|
|
41676
|
+
message: string;
|
|
41677
|
+
path?: (string | number)[];
|
|
41678
|
+
schema?: string;
|
|
41679
|
+
}[];
|
|
41680
|
+
retryable?: boolean;
|
|
41681
|
+
context?: unknown;
|
|
41682
|
+
};
|
|
41683
|
+
};
|
|
41684
|
+
};
|
|
41685
|
+
/** @description Internal server error */
|
|
41686
|
+
500: {
|
|
41687
|
+
headers: {
|
|
41688
|
+
/** @description Seconds to wait when retryable=true and the server supplies a delay. */
|
|
41689
|
+
"Retry-After"?: number;
|
|
41690
|
+
[name: string]: unknown;
|
|
41691
|
+
};
|
|
41692
|
+
content: {
|
|
41693
|
+
"application/json": {
|
|
41694
|
+
code: string;
|
|
41695
|
+
message: string;
|
|
41696
|
+
links?: {
|
|
41697
|
+
docs: string;
|
|
41698
|
+
schema: string;
|
|
41699
|
+
};
|
|
41700
|
+
issues?: {
|
|
41701
|
+
message: string;
|
|
41702
|
+
path?: (string | number)[];
|
|
41703
|
+
schema?: string;
|
|
41704
|
+
}[];
|
|
41705
|
+
retryable?: boolean;
|
|
41706
|
+
context?: unknown;
|
|
41707
|
+
};
|
|
41708
|
+
};
|
|
41709
|
+
};
|
|
41710
|
+
/** @description Service unavailable */
|
|
41711
|
+
503: {
|
|
41712
|
+
headers: {
|
|
41713
|
+
/** @description Seconds to wait when retryable=true and the server supplies a delay. */
|
|
41714
|
+
"Retry-After"?: number;
|
|
41715
|
+
[name: string]: unknown;
|
|
41716
|
+
};
|
|
41717
|
+
content: {
|
|
41718
|
+
"application/json": {
|
|
41719
|
+
code: string;
|
|
41720
|
+
message: string;
|
|
41721
|
+
links?: {
|
|
41722
|
+
docs: string;
|
|
41723
|
+
schema: string;
|
|
41724
|
+
};
|
|
41725
|
+
issues?: {
|
|
41726
|
+
message: string;
|
|
41727
|
+
path?: (string | number)[];
|
|
41728
|
+
schema?: string;
|
|
41729
|
+
}[];
|
|
41730
|
+
retryable?: boolean;
|
|
41731
|
+
context?: unknown;
|
|
41732
|
+
};
|
|
41733
|
+
};
|
|
41734
|
+
};
|
|
41735
|
+
};
|
|
41736
|
+
};
|
|
41474
41737
|
getInternalBookingChannels: {
|
|
41475
41738
|
parameters: {
|
|
41476
41739
|
query?: {
|