@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.
@@ -180,7 +180,7 @@ export interface paths {
180
180
  get?: never;
181
181
  put?: never;
182
182
  /**
183
- * @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.
183
+ * @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.
184
184
  *
185
185
  * Required scope: bank-accounts:write
186
186
  */
@@ -1917,7 +1917,8 @@ export interface paths {
1917
1917
  get: operations["getInternalBlobsByStore"];
1918
1918
  put?: never;
1919
1919
  post?: never;
1920
- delete?: never;
1920
+ /** @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. */
1921
+ delete: operations["deleteInternalBlobsByStore"];
1921
1922
  options?: never;
1922
1923
  head?: never;
1923
1924
  patch?: never;
@@ -2087,7 +2088,7 @@ export interface paths {
2087
2088
  };
2088
2089
  get?: never;
2089
2090
  put?: never;
2090
- /** @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. Obvious name and email properties are removed recursively before enqueueing. */
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. Event properties are preserved while undefined values are removed before enqueueing. */
2091
2092
  post: operations["postInternalEvents"];
2092
2093
  delete?: never;
2093
2094
  options?: never;
@@ -3549,7 +3550,7 @@ export interface paths {
3549
3550
  get?: never;
3550
3551
  put?: never;
3551
3552
  /**
3552
- * @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.
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. 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.
3553
3554
  *
3554
3555
  * Required scope: bank-connections:manage
3555
3556
  */
@@ -4461,7 +4462,7 @@ export interface paths {
4461
4462
  get?: never;
4462
4463
  put?: never;
4463
4464
  /**
4464
- * @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.
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. 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.
4465
4466
  *
4466
4467
  * Required scope: reservations:post-journals
4467
4468
  */
@@ -13146,7 +13147,7 @@ export interface operations {
13146
13147
  endDate?: string;
13147
13148
  actionType?: string;
13148
13149
  entityId?: string;
13149
- entityType?: "account" | "connection" | "journalEntry" | "listingOwnershipPeriod" | "ownerStatement" | "recurringFee" | "recurringTransactionTemplate" | "reservation" | "tenant" | "transaction" | "transactionAttachment";
13150
+ entityType?: "account" | "connection" | "journalEntry" | "listing" | "listingOwnershipPeriod" | "ownerStatement" | "recurringFee" | "recurringTransactionTemplate" | "reservation" | "tenant" | "tenantUser" | "transaction" | "transactionAttachment" | "user";
13150
13151
  includeIfNoEffects?: boolean;
13151
13152
  page?: number;
13152
13153
  };
@@ -13731,9 +13732,9 @@ export interface operations {
13731
13732
  offset?: number;
13732
13733
  actionId?: string;
13733
13734
  entityId?: string;
13734
- entityType?: "account" | "connection" | "journalEntry" | "listingOwnershipPeriod" | "ownerStatement" | "recurringFee" | "recurringTransactionTemplate" | "reservation" | "tenant" | "transaction" | "transactionAttachment";
13735
+ entityType?: "account" | "connection" | "journalEntry" | "listing" | "listingOwnershipPeriod" | "ownerStatement" | "recurringFee" | "recurringTransactionTemplate" | "reservation" | "tenant" | "tenantUser" | "transaction" | "transactionAttachment" | "user";
13735
13736
  status?: "pending" | "claimed" | "running" | "completed" | "failed" | "dead_letter";
13736
- 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";
13737
+ 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";
13737
13738
  page?: number;
13738
13739
  };
13739
13740
  header?: never;
@@ -13771,7 +13772,7 @@ export interface operations {
13771
13772
  rootEntityType: string | null;
13772
13773
  rootEntityId: string | null;
13773
13774
  /** @enum {string} */
13774
- 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";
13775
+ 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";
13775
13776
  payload: unknown;
13776
13777
  entity: ({
13777
13778
  /** @constant */
@@ -41476,6 +41477,262 @@ export interface operations {
41476
41477
  };
41477
41478
  };
41478
41479
  };
41480
+ deleteInternalBlobsByStore: {
41481
+ parameters: {
41482
+ query?: never;
41483
+ header?: never;
41484
+ path: {
41485
+ store: "api-attachments";
41486
+ };
41487
+ cookie?: never;
41488
+ };
41489
+ requestBody?: {
41490
+ content: {
41491
+ "application/json": {
41492
+ refs: string[];
41493
+ };
41494
+ };
41495
+ };
41496
+ responses: {
41497
+ /** @description Successful response */
41498
+ 200: {
41499
+ headers: {
41500
+ [name: string]: unknown;
41501
+ };
41502
+ content: {
41503
+ "application/json": {
41504
+ /** @constant */
41505
+ status: "deleted";
41506
+ };
41507
+ };
41508
+ };
41509
+ /** @description Bad request */
41510
+ 400: {
41511
+ headers: {
41512
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
41513
+ "Retry-After"?: number;
41514
+ [name: string]: unknown;
41515
+ };
41516
+ content: {
41517
+ "application/json": {
41518
+ code: string;
41519
+ message: string;
41520
+ links?: {
41521
+ docs: string;
41522
+ schema: string;
41523
+ };
41524
+ issues?: {
41525
+ message: string;
41526
+ path?: (string | number)[];
41527
+ schema?: string;
41528
+ }[];
41529
+ retryable?: boolean;
41530
+ context?: unknown;
41531
+ };
41532
+ };
41533
+ };
41534
+ /** @description Unauthorized */
41535
+ 401: {
41536
+ headers: {
41537
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
41538
+ "Retry-After"?: number;
41539
+ [name: string]: unknown;
41540
+ };
41541
+ content: {
41542
+ "application/json": {
41543
+ code: string;
41544
+ message: string;
41545
+ links?: {
41546
+ docs: string;
41547
+ schema: string;
41548
+ };
41549
+ issues?: {
41550
+ message: string;
41551
+ path?: (string | number)[];
41552
+ schema?: string;
41553
+ }[];
41554
+ retryable?: boolean;
41555
+ context?: unknown;
41556
+ };
41557
+ };
41558
+ };
41559
+ /** @description Forbidden */
41560
+ 403: {
41561
+ headers: {
41562
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
41563
+ "Retry-After"?: number;
41564
+ [name: string]: unknown;
41565
+ };
41566
+ content: {
41567
+ "application/json": {
41568
+ code: string;
41569
+ message: string;
41570
+ links?: {
41571
+ docs: string;
41572
+ schema: string;
41573
+ };
41574
+ issues?: {
41575
+ message: string;
41576
+ path?: (string | number)[];
41577
+ schema?: string;
41578
+ }[];
41579
+ retryable?: boolean;
41580
+ context?: unknown;
41581
+ };
41582
+ };
41583
+ };
41584
+ /** @description Not found */
41585
+ 404: {
41586
+ headers: {
41587
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
41588
+ "Retry-After"?: number;
41589
+ [name: string]: unknown;
41590
+ };
41591
+ content: {
41592
+ "application/json": {
41593
+ code: string;
41594
+ message: string;
41595
+ links?: {
41596
+ docs: string;
41597
+ schema: string;
41598
+ };
41599
+ issues?: {
41600
+ message: string;
41601
+ path?: (string | number)[];
41602
+ schema?: string;
41603
+ }[];
41604
+ retryable?: boolean;
41605
+ context?: unknown;
41606
+ };
41607
+ };
41608
+ };
41609
+ /** @description Conflict */
41610
+ 409: {
41611
+ headers: {
41612
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
41613
+ "Retry-After"?: number;
41614
+ [name: string]: unknown;
41615
+ };
41616
+ content: {
41617
+ "application/json": {
41618
+ code: string;
41619
+ message: string;
41620
+ links?: {
41621
+ docs: string;
41622
+ schema: string;
41623
+ };
41624
+ issues?: {
41625
+ message: string;
41626
+ path?: (string | number)[];
41627
+ schema?: string;
41628
+ }[];
41629
+ retryable?: boolean;
41630
+ context?: unknown;
41631
+ };
41632
+ };
41633
+ };
41634
+ /** @description Gone */
41635
+ 410: {
41636
+ headers: {
41637
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
41638
+ "Retry-After"?: number;
41639
+ [name: string]: unknown;
41640
+ };
41641
+ content: {
41642
+ "application/json": {
41643
+ code: string;
41644
+ message: string;
41645
+ links?: {
41646
+ docs: string;
41647
+ schema: string;
41648
+ };
41649
+ issues?: {
41650
+ message: string;
41651
+ path?: (string | number)[];
41652
+ schema?: string;
41653
+ }[];
41654
+ retryable?: boolean;
41655
+ context?: unknown;
41656
+ };
41657
+ };
41658
+ };
41659
+ /** @description Unprocessable content */
41660
+ 422: {
41661
+ headers: {
41662
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
41663
+ "Retry-After"?: number;
41664
+ [name: string]: unknown;
41665
+ };
41666
+ content: {
41667
+ "application/json": {
41668
+ code: string;
41669
+ message: string;
41670
+ links?: {
41671
+ docs: string;
41672
+ schema: string;
41673
+ };
41674
+ issues?: {
41675
+ message: string;
41676
+ path?: (string | number)[];
41677
+ schema?: string;
41678
+ }[];
41679
+ retryable?: boolean;
41680
+ context?: unknown;
41681
+ };
41682
+ };
41683
+ };
41684
+ /** @description Internal server error */
41685
+ 500: {
41686
+ headers: {
41687
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
41688
+ "Retry-After"?: number;
41689
+ [name: string]: unknown;
41690
+ };
41691
+ content: {
41692
+ "application/json": {
41693
+ code: string;
41694
+ message: string;
41695
+ links?: {
41696
+ docs: string;
41697
+ schema: string;
41698
+ };
41699
+ issues?: {
41700
+ message: string;
41701
+ path?: (string | number)[];
41702
+ schema?: string;
41703
+ }[];
41704
+ retryable?: boolean;
41705
+ context?: unknown;
41706
+ };
41707
+ };
41708
+ };
41709
+ /** @description Service unavailable */
41710
+ 503: {
41711
+ headers: {
41712
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
41713
+ "Retry-After"?: number;
41714
+ [name: string]: unknown;
41715
+ };
41716
+ content: {
41717
+ "application/json": {
41718
+ code: string;
41719
+ message: string;
41720
+ links?: {
41721
+ docs: string;
41722
+ schema: string;
41723
+ };
41724
+ issues?: {
41725
+ message: string;
41726
+ path?: (string | number)[];
41727
+ schema?: string;
41728
+ }[];
41729
+ retryable?: boolean;
41730
+ context?: unknown;
41731
+ };
41732
+ };
41733
+ };
41734
+ };
41735
+ };
41479
41736
  getInternalBookingChannels: {
41480
41737
  parameters: {
41481
41738
  query?: {