@vrplatform/api 1.3.1-stage.5843 → 1.3.1-stage.5866
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
|
*/
|
|
@@ -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;
|
|
@@ -2088,7 +2089,7 @@ export interface paths {
|
|
|
2088
2089
|
};
|
|
2089
2090
|
get?: never;
|
|
2090
2091
|
put?: never;
|
|
2091
|
-
/** @description Queue one authenticated tracking event. Callers may provide a stable id to make retries idempotent. User-authenticated requests derive teamId and userId from the current context. First-party service-authenticated requests may provide teamId and userId as optional attribution. A provided teamId must match x-team-id. Existing users and historical team members retain attribution; missing or team-mismatched service user attribution is cleared without rejecting the event.
|
|
2092
|
+
/** @description Queue one authenticated tracking event. Callers may provide a stable id to make retries idempotent. User-authenticated requests derive teamId and userId from the current context. First-party service-authenticated requests may provide teamId and userId as optional attribution. A provided teamId must match x-team-id. Existing users and historical team members retain attribution; missing or team-mismatched service user attribution is cleared without rejecting the event. Event properties are preserved while undefined values are removed before enqueueing. */
|
|
2092
2093
|
post: operations["postInternalEvents"];
|
|
2093
2094
|
delete?: never;
|
|
2094
2095
|
options?: 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
|
*/
|
|
@@ -13147,7 +13148,7 @@ export interface operations {
|
|
|
13147
13148
|
endDate?: string;
|
|
13148
13149
|
actionType?: string;
|
|
13149
13150
|
entityId?: string;
|
|
13150
|
-
entityType?: "account" | "connection" | "journalEntry" | "listingOwnershipPeriod" | "ownerStatement" | "recurringFee" | "recurringTransactionTemplate" | "reservation" | "tenant" | "transaction" | "transactionAttachment";
|
|
13151
|
+
entityType?: "account" | "connection" | "journalEntry" | "listing" | "listingOwnershipPeriod" | "ownerStatement" | "recurringFee" | "recurringTransactionTemplate" | "reservation" | "tenant" | "tenantUser" | "transaction" | "transactionAttachment" | "user";
|
|
13151
13152
|
includeIfNoEffects?: boolean;
|
|
13152
13153
|
page?: number;
|
|
13153
13154
|
};
|
|
@@ -13732,9 +13733,9 @@ export interface operations {
|
|
|
13732
13733
|
offset?: number;
|
|
13733
13734
|
actionId?: string;
|
|
13734
13735
|
entityId?: string;
|
|
13735
|
-
entityType?: "account" | "connection" | "journalEntry" | "listingOwnershipPeriod" | "ownerStatement" | "recurringFee" | "recurringTransactionTemplate" | "reservation" | "tenant" | "transaction" | "transactionAttachment";
|
|
13736
|
+
entityType?: "account" | "connection" | "journalEntry" | "listing" | "listingOwnershipPeriod" | "ownerStatement" | "recurringFee" | "recurringTransactionTemplate" | "reservation" | "tenant" | "tenantUser" | "transaction" | "transactionAttachment" | "user";
|
|
13736
13737
|
status?: "pending" | "claimed" | "running" | "completed" | "failed" | "dead_letter";
|
|
13737
|
-
effectType?: "BANK_ACCOUNT_CREATED_TRACK" | "CALENDAR_UNBLOCK_ACTION" | "TRIGGER_CONNECTION_SYNC" | "CREATE_RECURRING_TRANSACTION_INSTANCE" | "JOURNAL_ENTRY_SET_ACTIVE" | "JOURNAL_ENTRY_SET_INACTIVE" | "LINK_JOURNAL_TO_OWNERSHIP_PERIOD" | "RECALCULATE_BANK_RECORD_BALANCES" | "REFRESH_RECURRING_FEE_RESERVATIONS" | "REFRESH_RESERVATION_JOURNAL" | "DELETE_TRANSACTION_ATTACHMENT_BLOB" | "MAP_DEPOSIT_TRANSACTIONS_BY_LAST4" | "REFRESH_TRANSACTION_JOURNAL" | "SEND_STATEMENT_NOTIFICATIONS" | "UPDATE_RESERVATION_LINKABLES" | "UPDATE_RESERVATION_PAYMENTS" | "TENANT_CLERK_ALLOWED_IDS_SYNC" | "DUPLICATE_TENANT" | "TENANT_HYPERLINE_SYNC" | "TENANT_INIT" | "TENANT_LINEAR_WEBHOOK" | "TENANT_STATUS_TRACK" | "TENANT_SUSPENSION_EMAIL";
|
|
13738
|
+
effectType?: "BANK_ACCOUNT_CREATED_TRACK" | "ANALYTICS_ENTITY_LIFECYCLE" | "CALENDAR_UNBLOCK_ACTION" | "TRIGGER_CONNECTION_SYNC" | "CREATE_RECURRING_TRANSACTION_INSTANCE" | "JOURNAL_ENTRY_SET_ACTIVE" | "JOURNAL_ENTRY_SET_INACTIVE" | "LINK_JOURNAL_TO_OWNERSHIP_PERIOD" | "RECALCULATE_BANK_RECORD_BALANCES" | "REFRESH_RECURRING_FEE_RESERVATIONS" | "REFRESH_RESERVATION_JOURNAL" | "DELETE_TRANSACTION_ATTACHMENT_BLOB" | "MAP_DEPOSIT_TRANSACTIONS_BY_LAST4" | "REFRESH_TRANSACTION_JOURNAL" | "SEND_STATEMENT_NOTIFICATIONS" | "UPDATE_RESERVATION_LINKABLES" | "UPDATE_RESERVATION_PAYMENTS" | "TENANT_CLERK_ALLOWED_IDS_SYNC" | "DUPLICATE_TENANT" | "TENANT_HYPERLINE_SYNC" | "TENANT_INIT" | "TENANT_LINEAR_WEBHOOK" | "TENANT_STATUS_TRACK" | "TENANT_SUSPENSION_EMAIL";
|
|
13738
13739
|
page?: number;
|
|
13739
13740
|
};
|
|
13740
13741
|
header?: never;
|
|
@@ -13772,7 +13773,7 @@ export interface operations {
|
|
|
13772
13773
|
rootEntityType: string | null;
|
|
13773
13774
|
rootEntityId: string | null;
|
|
13774
13775
|
/** @enum {string} */
|
|
13775
|
-
effectType: "BANK_ACCOUNT_CREATED_TRACK" | "CALENDAR_UNBLOCK_ACTION" | "TRIGGER_CONNECTION_SYNC" | "CREATE_RECURRING_TRANSACTION_INSTANCE" | "JOURNAL_ENTRY_SET_ACTIVE" | "JOURNAL_ENTRY_SET_INACTIVE" | "LINK_JOURNAL_TO_OWNERSHIP_PERIOD" | "RECALCULATE_BANK_RECORD_BALANCES" | "REFRESH_RECURRING_FEE_RESERVATIONS" | "REFRESH_RESERVATION_JOURNAL" | "DELETE_TRANSACTION_ATTACHMENT_BLOB" | "MAP_DEPOSIT_TRANSACTIONS_BY_LAST4" | "REFRESH_TRANSACTION_JOURNAL" | "SEND_STATEMENT_NOTIFICATIONS" | "UPDATE_RESERVATION_LINKABLES" | "UPDATE_RESERVATION_PAYMENTS" | "TENANT_CLERK_ALLOWED_IDS_SYNC" | "DUPLICATE_TENANT" | "TENANT_HYPERLINE_SYNC" | "TENANT_INIT" | "TENANT_LINEAR_WEBHOOK" | "TENANT_STATUS_TRACK" | "TENANT_SUSPENSION_EMAIL";
|
|
13776
|
+
effectType: "BANK_ACCOUNT_CREATED_TRACK" | "ANALYTICS_ENTITY_LIFECYCLE" | "CALENDAR_UNBLOCK_ACTION" | "TRIGGER_CONNECTION_SYNC" | "CREATE_RECURRING_TRANSACTION_INSTANCE" | "JOURNAL_ENTRY_SET_ACTIVE" | "JOURNAL_ENTRY_SET_INACTIVE" | "LINK_JOURNAL_TO_OWNERSHIP_PERIOD" | "RECALCULATE_BANK_RECORD_BALANCES" | "REFRESH_RECURRING_FEE_RESERVATIONS" | "REFRESH_RESERVATION_JOURNAL" | "DELETE_TRANSACTION_ATTACHMENT_BLOB" | "MAP_DEPOSIT_TRANSACTIONS_BY_LAST4" | "REFRESH_TRANSACTION_JOURNAL" | "SEND_STATEMENT_NOTIFICATIONS" | "UPDATE_RESERVATION_LINKABLES" | "UPDATE_RESERVATION_PAYMENTS" | "TENANT_CLERK_ALLOWED_IDS_SYNC" | "DUPLICATE_TENANT" | "TENANT_HYPERLINE_SYNC" | "TENANT_INIT" | "TENANT_LINEAR_WEBHOOK" | "TENANT_STATUS_TRACK" | "TENANT_SUSPENSION_EMAIL";
|
|
13776
13777
|
payload: unknown;
|
|
13777
13778
|
entity: ({
|
|
13778
13779
|
/** @constant */
|
|
@@ -41477,6 +41478,262 @@ export interface operations {
|
|
|
41477
41478
|
};
|
|
41478
41479
|
};
|
|
41479
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
|
+
};
|
|
41480
41737
|
getInternalBookingChannels: {
|
|
41481
41738
|
parameters: {
|
|
41482
41739
|
query?: {
|