@vrplatform/api 1.3.1-6224 → 1.3.1-6251

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.
@@ -819,7 +819,7 @@ export interface paths {
819
819
  get?: never;
820
820
  put?: never;
821
821
  /**
822
- * @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.
822
+ * @description Connect an app and create the connection. OAuth defaults to https://portal.vrplatform.app/callback/ when redirectTo is omitted. Legacy production /callback is normalized to /callback/, and legacy staging /callback to /connections/oauth-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.
823
823
  *
824
824
  * Required scope: integrations:write
825
825
  */
@@ -861,7 +861,7 @@ export interface paths {
861
861
  get?: never;
862
862
  put?: never;
863
863
  /**
864
- * @description Get a redirect URL to connect an app through OAuth2.0. Defaults to https://portal.vrplatform.app/callback/ when redirectTo is omitted. Normalizes the legacy production /callback path to /callback/.
864
+ * @description Get a redirect URL to connect an app through OAuth2.0. Defaults to https://portal.vrplatform.app/callback/ when redirectTo is omitted. Normalizes legacy production /callback to /callback/ and legacy staging /callback to /connections/oauth-callback.
865
865
  *
866
866
  * Required scope: integrations:write
867
867
  */
@@ -976,7 +976,7 @@ export interface paths {
976
976
  get?: never;
977
977
  put?: never;
978
978
  /**
979
- * @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.
979
+ * @description Reconnect an existing app connection. OAuth defaults to https://portal.vrplatform.app/callback/ when redirectTo is omitted. Legacy production /callback is normalized to /callback/, and legacy staging /callback to /connections/oauth-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.
980
980
  *
981
981
  * Required scope: integrations:write
982
982
  */
@@ -1060,7 +1060,7 @@ export interface paths {
1060
1060
  get?: never;
1061
1061
  put?: never;
1062
1062
  /**
1063
- * @description Create a size-bound CSV upload reference and raw PUT URL for this Connection
1063
+ * @description Create a 24-hour, size-bound CSV upload reference and regional raw PUT URL for this Connection for a file up to 100,000,000 bytes. PUT the original file with Content-Type text/csv (optional parameters are accepted) and Content-Length. Completed retries are idempotent.
1064
1064
  *
1065
1065
  * Required scope: integrations:import
1066
1066
  */
@@ -1080,7 +1080,7 @@ export interface paths {
1080
1080
  };
1081
1081
  get?: never;
1082
1082
  /**
1083
- * @description Stream the complete CSV body into regional storage using an issued upload reference
1083
+ * @description Stream the complete raw CSV body into regional storage using an issued upload reference. Content-Type must be text/csv (optional parameters are accepted), Content-Length is required, and the stored byte size must exactly match the create-upload request. A completed retry does not overwrite the stored object.
1084
1084
  *
1085
1085
  * Required scope: integrations:import
1086
1086
  */
@@ -1385,6 +1385,27 @@ export interface paths {
1385
1385
  patch?: never;
1386
1386
  trace?: never;
1387
1387
  };
1388
+ "/email-templates/test": {
1389
+ parameters: {
1390
+ query?: never;
1391
+ header?: never;
1392
+ path?: never;
1393
+ cookie?: never;
1394
+ };
1395
+ get?: never;
1396
+ put?: never;
1397
+ /**
1398
+ * @description Send unsaved email-template content to the authenticated user's email address through the API Trigger project. The recipient cannot be supplied by the caller.
1399
+ *
1400
+ * Required scope: team-settings:write
1401
+ */
1402
+ post: operations["sendTestEmail"];
1403
+ delete?: never;
1404
+ options?: never;
1405
+ head?: never;
1406
+ patch?: never;
1407
+ trace?: never;
1408
+ };
1388
1409
  "/email-templates/{type}": {
1389
1410
  parameters: {
1390
1411
  query?: never;
@@ -1455,7 +1476,7 @@ export interface paths {
1455
1476
  get: operations["getFiles"];
1456
1477
  put?: never;
1457
1478
  /**
1458
- * @description Upload a GL user file as multipart/form-data. Fields: file, optional filename, optional type (userUpload or historicalData or historicalOwnerStatement or ownerStatementExample or listingOwnerAssignment or listingFeeAssignment), optional startDate, optional endDate, and optional contactId. Type defaults to userUpload. The API derives team and user context from auth.
1479
+ * @description Create a size-bound upload reference and authenticated regional raw PUT URL for a GL user file up to 100,000,000 bytes. Send filename, contentType, fileSize, and optional type (userUpload or historicalData or historicalOwnerStatement or ownerStatementExample or listingOwnerAssignment or listingFeeAssignment), optional startDate, optional endDate, and optional contactId. Type defaults to userUpload. PUT the unmodified file body to uploadUrl with the declared Content-Type and Content-Length, then use fileId for the created file. Retrying the same completed upload is idempotent.
1459
1480
  *
1460
1481
  * Required scope: files:write
1461
1482
  */
@@ -1466,6 +1487,27 @@ export interface paths {
1466
1487
  patch?: never;
1467
1488
  trace?: never;
1468
1489
  };
1490
+ "/files/uploads/{uploadRef}": {
1491
+ parameters: {
1492
+ query?: never;
1493
+ header?: never;
1494
+ path?: never;
1495
+ cookie?: never;
1496
+ };
1497
+ get?: never;
1498
+ /**
1499
+ * @description Stream the complete raw file body into regional team storage using an issued upload reference. Content-Type and the stored byte size must exactly match the create-upload request, and Content-Length is required. The upload reference is single-file, team-scoped, valid for 24 hours, and safe to retry without overwriting a completed object.
1500
+ *
1501
+ * Required scope: files:write
1502
+ */
1503
+ put: operations["putFilesUploadsByUploadRef"];
1504
+ post?: never;
1505
+ delete?: never;
1506
+ options?: never;
1507
+ head?: never;
1508
+ patch?: never;
1509
+ trace?: never;
1510
+ };
1469
1511
  "/files/{id}": {
1470
1512
  parameters: {
1471
1513
  query?: never;
@@ -1482,7 +1524,7 @@ export interface paths {
1482
1524
  put: operations["putFilesById"];
1483
1525
  post?: never;
1484
1526
  /**
1485
- * @description Delete GL file metadata and its TEAM_STORAGE object.
1527
+ * @description Delete a GL file and its TEAM_STORAGE object. A still-valid upload reference cannot recreate it.
1486
1528
  *
1487
1529
  * Required scope: files:delete
1488
1530
  */
@@ -4480,7 +4522,7 @@ export interface paths {
4480
4522
  get: operations["getReservations"];
4481
4523
  put?: never;
4482
4524
  /**
4483
- * @description Create a reservation. Financial lines post journal entries inline against the listing ownership period covering the stay, so writes into books-closed or statement-locked months are rejected. Owner API keys cannot create reservations. Supports dryRun. See https://docs.vrplatform.app/guides/build/reservations.
4525
+ * @description Create a reservation. Financial lines post journal entries inline against the listing ownership period covering the stay, so writes into books-closed or statement-locked months are rejected. Creation rejects duplicates by connection and unique reference or by connection, resolved listing, and confirmation code. Owner API keys cannot create reservations. Supports dryRun. See https://docs.vrplatform.app/guides/build/reservations.
4484
4526
  *
4485
4527
  * Required scope: reservations:write
4486
4528
  */
@@ -5716,7 +5758,7 @@ export interface paths {
5716
5758
  get: operations["getTeams"];
5717
5759
  put?: never;
5718
5760
  /**
5719
- * @description Create team. The generic gateway forwards an explicit dataRegion to that regional cell; an omitted region uses the receiving cell. Partner provisioning requires a uniqueRef. An exact repeat of a completed provision fails with 409 and context.existingTeamId identifies the existing team; changed retry payloads fail without it. Fetch that team with GET /teams/lookup instead of creating it again. Retrying a provisioning request that failed before completing is safe. Generated and explicit slugs are checked against the global tenant registry before the regional tenant is written. defaultCurrency must exist in the target region currency catalog; unsupported values return 400 before creation.
5761
+ * @description Create team. The generic gateway forwards an explicit dataRegion to that regional cell; an omitted region uses the receiving cell. Partner provisioning requires a uniqueRef. An exact repeat of a completed provision fails with 409 and context.existingTeamId identifies the existing team; changed retry payloads fail without it. Fetch that team with GET /teams/lookup instead of creating it again. Retrying a provisioning request that failed before completing is safe. Generated and explicit slugs are checked against the global tenant registry before the regional tenant is written. defaultCurrency must exist in the target region currency catalog; unsupported values return 400 before creation. An explicit General Ledger copyFromTeamId must use the target data region; a mismatch returns 400 before either tenant registry is written.
5720
5762
  *
5721
5763
  * Required scope: teams:provision
5722
5764
  */
@@ -5805,7 +5847,7 @@ export interface paths {
5805
5847
  get: operations["getTransactions"];
5806
5848
  put?: never;
5807
5849
  /**
5808
- * @description Create a transaction. Journal entries post inline per line; creation into a books-closed month or a statement-locked listing period is rejected. The transaction uniqueRef and every line uniqueRef must be unique; duplicate line references are rejected before anything is inserted. Line party defaults and validity depend on transaction type, owner context, account assignment, and account category. See https://docs.vrplatform.app/guides/build/transactions#decision-table. For expense attachments, first upload each file with POST /transactions/attachments, then pass the returned ids in attachmentIds. Attachments are only supported for expense transactions.
5850
+ * @description Create a transaction. Journal entries post inline per line; creation into a books-closed month or a statement-locked listing period is rejected. The transaction uniqueRef and every line uniqueRef must be unique; duplicate line references are rejected before anything is inserted. Line party defaults and validity depend on transaction type, owner context, account assignment, and account category. See https://docs.vrplatform.app/guides/build/transactions#decision-table. For expense attachments, create an upload with POST /transactions/attachments, PUT the raw file to uploadUrl, then pass the returned attachmentId in attachmentIds. Attachments are only supported for expense transactions.
5809
5851
  *
5810
5852
  * Required scope: transactions:write
5811
5853
  */
@@ -5826,7 +5868,7 @@ export interface paths {
5826
5868
  get?: never;
5827
5869
  put?: never;
5828
5870
  /**
5829
- * @description Upload an expense attachment as multipart/form-data. The returned staged attachment id can be passed in attachmentIds when creating or updating an expense transaction.
5871
+ * @description Create a size-bound upload reference and authenticated regional raw PUT URL for an expense attachment up to 100,000,000 bytes. PUT the unmodified file body to uploadUrl with the declared Content-Type and Content-Length. After the PUT succeeds, pass the attachmentId returned here in attachmentIds when creating or updating an expense transaction. Retrying the same completed upload is idempotent.
5830
5872
  *
5831
5873
  * Required scope: transactions:write
5832
5874
  */
@@ -5837,6 +5879,27 @@ export interface paths {
5837
5879
  patch?: never;
5838
5880
  trace?: never;
5839
5881
  };
5882
+ "/transactions/attachments/uploads/{uploadRef}": {
5883
+ parameters: {
5884
+ query?: never;
5885
+ header?: never;
5886
+ path?: never;
5887
+ cookie?: never;
5888
+ };
5889
+ get?: never;
5890
+ /**
5891
+ * @description Stream the complete raw attachment body into regional storage using an issued upload reference. Content-Type and the stored byte size must exactly match the create-upload request, and Content-Length is required. The upload reference is single-file, team-scoped, valid for 24 hours, and safe to retry without overwriting a completed object.
5892
+ *
5893
+ * Required scope: transactions:write
5894
+ */
5895
+ put: operations["putTransactionsAttachmentsUploadsByUploadRef"];
5896
+ post?: never;
5897
+ delete?: never;
5898
+ options?: never;
5899
+ head?: never;
5900
+ patch?: never;
5901
+ trace?: never;
5902
+ };
5840
5903
  "/transactions/attachments/{id}": {
5841
5904
  parameters: {
5842
5905
  query?: never;
@@ -5853,7 +5916,7 @@ export interface paths {
5853
5916
  put: operations["putTransactionsAttachmentsById"];
5854
5917
  post?: never;
5855
5918
  /**
5856
- * @description Delete an expense attachment. This removes staged attachments and attachments already linked to expense transactions.
5919
+ * @description Delete an expense attachment. This removes staged attachments and attachments already linked to expense transactions. A still-valid upload reference cannot recreate it.
5857
5920
  *
5858
5921
  * Required scope: transactions:delete
5859
5922
  */
@@ -10037,7 +10100,7 @@ export interface operations {
10037
10100
  } | null;
10038
10101
  } | null;
10039
10102
  }[];
10040
- /** @description Expense attachment IDs returned by POST /transactions/attachments. Only expense transactions support attachments. Omit to leave existing attachments unchanged on update; send an array to replace the attached set. */
10103
+ /** @description Expense attachment IDs returned as attachmentId by POST /transactions/attachments after PUT to uploadUrl succeeds. Only expense transactions support attachments. Omit to leave existing attachments unchanged on update; send an array to replace the attached set. */
10041
10104
  attachmentIds?: string[] | null;
10042
10105
  recurringTemplateId?: string | null;
10043
10106
  matchBankAccountLast4?: string | null;
@@ -16745,7 +16808,7 @@ export interface operations {
16745
16808
  matchReservationProcessorBookingRef?: string | null;
16746
16809
  matchLineTypeClassification?: string | null;
16747
16810
  }[];
16748
- /** @description Expense attachment IDs returned by POST /transactions/attachments. Only expense transactions support attachments. Omit to leave existing attachments unchanged on update; send an array to replace the attached set. */
16811
+ /** @description Expense attachment IDs returned as attachmentId by POST /transactions/attachments after PUT to uploadUrl succeeds. Only expense transactions support attachments. Omit to leave existing attachments unchanged on update; send an array to replace the attached set. */
16749
16812
  attachmentIds?: string[] | null;
16750
16813
  payment?: {
16751
16814
  bankRecordIds: string[];
@@ -17756,7 +17819,7 @@ export interface operations {
17756
17819
  matchReservationProcessorBookingRef?: string | null;
17757
17820
  matchLineTypeClassification?: string | null;
17758
17821
  }[];
17759
- /** @description Expense attachment IDs returned by POST /transactions/attachments. Only expense transactions support attachments. Omit to leave existing attachments unchanged on update; send an array to replace the attached set. */
17822
+ /** @description Expense attachment IDs returned as attachmentId by POST /transactions/attachments after PUT to uploadUrl succeeds. Only expense transactions support attachments. Omit to leave existing attachments unchanged on update; send an array to replace the attached set. */
17760
17823
  attachmentIds?: string[] | null;
17761
17824
  payment?: {
17762
17825
  bankRecordIds: string[];
@@ -19418,7 +19481,7 @@ export interface operations {
19418
19481
  matchReservationProcessorBookingRef?: string | null;
19419
19482
  matchLineTypeClassification?: string | null;
19420
19483
  }[];
19421
- /** @description Expense attachment IDs returned by POST /transactions/attachments. Only expense transactions support attachments. Omit to leave existing attachments unchanged on update; send an array to replace the attached set. */
19484
+ /** @description Expense attachment IDs returned as attachmentId by POST /transactions/attachments after PUT to uploadUrl succeeds. Only expense transactions support attachments. Omit to leave existing attachments unchanged on update; send an array to replace the attached set. */
19422
19485
  attachmentIds?: string[] | null;
19423
19486
  payment?: {
19424
19487
  bankRecordIds: string[];
@@ -20773,7 +20836,7 @@ export interface operations {
20773
20836
  matchReservationProcessorBookingRef?: string | null;
20774
20837
  matchLineTypeClassification?: string | null;
20775
20838
  }[];
20776
- /** @description Expense attachment IDs returned by POST /transactions/attachments. Only expense transactions support attachments. Omit to leave existing attachments unchanged on update; send an array to replace the attached set. */
20839
+ /** @description Expense attachment IDs returned as attachmentId by POST /transactions/attachments after PUT to uploadUrl succeeds. Only expense transactions support attachments. Omit to leave existing attachments unchanged on update; send an array to replace the attached set. */
20777
20840
  attachmentIds?: string[] | null;
20778
20841
  payment?: {
20779
20842
  bankRecordIds: string[];
@@ -32094,30 +32157,19 @@ export interface operations {
32094
32157
  };
32095
32158
  };
32096
32159
  };
32097
- upsertEmailTemplate: {
32160
+ sendTestEmail: {
32098
32161
  parameters: {
32099
32162
  query?: never;
32100
32163
  header?: never;
32101
- path: {
32102
- /** @description Email template type to save. */
32103
- type: "ownerInvite" | "ownerStatementPublished" | "invitePropertyManager";
32104
- };
32164
+ path?: never;
32105
32165
  cookie?: never;
32106
32166
  };
32107
32167
  requestBody?: {
32108
32168
  content: {
32109
32169
  "application/json": {
32110
- /** @description Email template content to save. */
32111
- data: {
32112
- subject: string;
32113
- shortDescription: string;
32114
- banner?: string | null;
32115
- header: string;
32116
- bodyOne: string;
32117
- bodyTwo: string;
32118
- buttonText: string;
32119
- href?: string | null;
32120
- };
32170
+ html: string;
32171
+ subject: string;
32172
+ text: string;
32121
32173
  };
32122
32174
  };
32123
32175
  };
@@ -32129,32 +32181,8 @@ export interface operations {
32129
32181
  };
32130
32182
  content: {
32131
32183
  "application/json": {
32132
- /** Format: uuid */
32133
- id: string;
32134
- /** @enum {string} */
32135
- type: "ownerInvite" | "ownerStatementPublished" | "invitePropertyManager";
32136
- data: {
32137
- subject: string;
32138
- shortDescription: string;
32139
- banner?: string | null;
32140
- header: string;
32141
- bodyOne: string;
32142
- bodyTwo: string;
32143
- buttonText: string;
32144
- href?: string | null;
32145
- };
32146
- /**
32147
- * Format: date-time
32148
- * @description Timestamp string with date, time, milliseconds, and timezone.
32149
- * @example 2024-01-15T12:30:00.000+00:00
32150
- */
32151
- createdAt: string;
32152
- /**
32153
- * Format: date-time
32154
- * @description Timestamp string with date, time, milliseconds, and timezone.
32155
- * @example 2024-01-15T12:30:00.000+00:00
32156
- */
32157
- updatedAt: string;
32184
+ /** @constant */
32185
+ ok: true;
32158
32186
  };
32159
32187
  };
32160
32188
  };
@@ -32385,18 +32413,30 @@ export interface operations {
32385
32413
  };
32386
32414
  };
32387
32415
  };
32388
- exchangeEmbedSession: {
32416
+ upsertEmailTemplate: {
32389
32417
  parameters: {
32390
32418
  query?: never;
32391
32419
  header?: never;
32392
- path?: never;
32420
+ path: {
32421
+ /** @description Email template type to save. */
32422
+ type: "ownerInvite" | "ownerStatementPublished" | "invitePropertyManager";
32423
+ };
32393
32424
  cookie?: never;
32394
32425
  };
32395
32426
  requestBody?: {
32396
32427
  content: {
32397
32428
  "application/json": {
32398
- /** @description One-time code from the embed URL fragment. */
32399
- code: string;
32429
+ /** @description Email template content to save. */
32430
+ data: {
32431
+ subject: string;
32432
+ shortDescription: string;
32433
+ banner?: string | null;
32434
+ header: string;
32435
+ bodyOne: string;
32436
+ bodyTwo: string;
32437
+ buttonText: string;
32438
+ href?: string | null;
32439
+ };
32400
32440
  };
32401
32441
  };
32402
32442
  };
@@ -32404,46 +32444,36 @@ export interface operations {
32404
32444
  /** @description Successful response */
32405
32445
  200: {
32406
32446
  headers: {
32407
- /** @description Prevents storage of the embedded bearer token. */
32408
- "Cache-Control"?: "no-store";
32409
32447
  [name: string]: unknown;
32410
32448
  };
32411
32449
  content: {
32412
32450
  "application/json": {
32413
- /** @description Short-lived embedded bearer token. */
32414
- accessToken: string;
32415
- /** @description Embedded capability bundles granted to the session. */
32416
- bundles: ("embed:exports:v1" | "embed:reports:v1" | "embed:statements:v1")[];
32417
- /**
32418
- * Format: uuid
32419
- * @description Stable lifecycle channel ID for this iframe.
32420
- */
32421
- channelId: string;
32451
+ /** Format: uuid */
32452
+ id: string;
32453
+ /** @enum {string} */
32454
+ type: "ownerInvite" | "ownerStatementPublished" | "invitePropertyManager";
32455
+ data: {
32456
+ subject: string;
32457
+ shortDescription: string;
32458
+ banner?: string | null;
32459
+ header: string;
32460
+ bodyOne: string;
32461
+ bodyTwo: string;
32462
+ buttonText: string;
32463
+ href?: string | null;
32464
+ };
32422
32465
  /**
32423
32466
  * Format: date-time
32424
- * @description Bearer-token expiration timestamp.
32425
- */
32426
- expiresAt: string;
32427
- /**
32428
- * Format: uri
32429
- * @description Exact parent-page origin bound to the lifecycle channel.
32430
- */
32431
- parentOrigin: string;
32432
- /**
32433
- * Format: uuid
32434
- * @description Session ID created by the partner backend.
32435
- */
32436
- sessionId: string;
32437
- /**
32438
- * Format: uuid
32439
- * @description Team bound to the embedded session.
32467
+ * @description Timestamp string with date, time, milliseconds, and timezone.
32468
+ * @example 2024-01-15T12:30:00.000+00:00
32440
32469
  */
32441
- teamId: string;
32470
+ createdAt: string;
32442
32471
  /**
32443
- * Format: uuid
32444
- * @description VRPlatform user bound to the session.
32472
+ * Format: date-time
32473
+ * @description Timestamp string with date, time, milliseconds, and timezone.
32474
+ * @example 2024-01-15T12:30:00.000+00:00
32445
32475
  */
32446
- userId: string;
32476
+ updatedAt: string;
32447
32477
  };
32448
32478
  };
32449
32479
  };
@@ -32674,7 +32704,7 @@ export interface operations {
32674
32704
  };
32675
32705
  };
32676
32706
  };
32677
- getEmbedSessionFrameAncestorPolicy: {
32707
+ exchangeEmbedSession: {
32678
32708
  parameters: {
32679
32709
  query?: never;
32680
32710
  header?: never;
@@ -32684,8 +32714,8 @@ export interface operations {
32684
32714
  requestBody?: {
32685
32715
  content: {
32686
32716
  "application/json": {
32687
- /** @description Short-lived opaque policy token from the issued embed URL query. */
32688
- frameAncestorToken: string;
32717
+ /** @description One-time code from the embed URL fragment. */
32718
+ code: string;
32689
32719
  };
32690
32720
  };
32691
32721
  };
@@ -32693,22 +32723,46 @@ export interface operations {
32693
32723
  /** @description Successful response */
32694
32724
  200: {
32695
32725
  headers: {
32696
- /** @description Prevents storage of the short-lived ancestor policy. */
32726
+ /** @description Prevents storage of the embedded bearer token. */
32697
32727
  "Cache-Control"?: "no-store";
32698
32728
  [name: string]: unknown;
32699
32729
  };
32700
32730
  content: {
32701
32731
  "application/json": {
32732
+ /** @description Short-lived embedded bearer token. */
32733
+ accessToken: string;
32734
+ /** @description Embedded capability bundles granted to the session. */
32735
+ bundles: ("embed:exports:v1" | "embed:reports:v1" | "embed:statements:v1")[];
32702
32736
  /**
32703
- * Format: uri
32704
- * @description Exact embedded-application origin allowed to use this policy.
32737
+ * Format: uuid
32738
+ * @description Stable lifecycle channel ID for this iframe.
32705
32739
  */
32706
- embedOrigin: string;
32740
+ channelId: string;
32741
+ /**
32742
+ * Format: date-time
32743
+ * @description Bearer-token expiration timestamp.
32744
+ */
32745
+ expiresAt: string;
32707
32746
  /**
32708
32747
  * Format: uri
32709
- * @description Exact parent-page origin allowed to frame the embedded application.
32748
+ * @description Exact parent-page origin bound to the lifecycle channel.
32710
32749
  */
32711
32750
  parentOrigin: string;
32751
+ /**
32752
+ * Format: uuid
32753
+ * @description Session ID created by the partner backend.
32754
+ */
32755
+ sessionId: string;
32756
+ /**
32757
+ * Format: uuid
32758
+ * @description Team bound to the embedded session.
32759
+ */
32760
+ teamId: string;
32761
+ /**
32762
+ * Format: uuid
32763
+ * @description VRPlatform user bound to the session.
32764
+ */
32765
+ userId: string;
32712
32766
  };
32713
32767
  };
32714
32768
  };
@@ -32939,67 +32993,41 @@ export interface operations {
32939
32993
  };
32940
32994
  };
32941
32995
  };
32942
- getFiles: {
32996
+ getEmbedSessionFrameAncestorPolicy: {
32943
32997
  parameters: {
32944
- query?: {
32945
- /** @description Filter files by filename text match. */
32946
- search?: string;
32947
- /** @description Filter files by their upload purpose. */
32948
- type?: "userUpload" | "historicalData" | "historicalOwnerStatement" | "ownerStatementExample" | "listingOwnerAssignment" | "listingFeeAssignment";
32949
- /** @description Sort field; prefix with - for descending order. */
32950
- sort?: "filename" | "-filename" | "startDate" | "-startDate" | "endDate" | "-endDate" | "createdAt" | "-createdAt" | "contactName" | "-contactName";
32951
- limit?: number;
32952
- page?: number;
32953
- offset?: number;
32954
- };
32998
+ query?: never;
32955
32999
  header?: never;
32956
33000
  path?: never;
32957
33001
  cookie?: never;
32958
33002
  };
32959
- requestBody?: never;
33003
+ requestBody?: {
33004
+ content: {
33005
+ "application/json": {
33006
+ /** @description Short-lived opaque policy token from the issued embed URL query. */
33007
+ frameAncestorToken: string;
33008
+ };
33009
+ };
33010
+ };
32960
33011
  responses: {
32961
33012
  /** @description Successful response */
32962
33013
  200: {
32963
33014
  headers: {
33015
+ /** @description Prevents storage of the short-lived ancestor policy. */
33016
+ "Cache-Control"?: "no-store";
32964
33017
  [name: string]: unknown;
32965
33018
  };
32966
33019
  content: {
32967
33020
  "application/json": {
32968
- data: {
32969
- /** Format: uuid */
32970
- id: string;
32971
- filename: string;
32972
- /** @enum {string} */
32973
- type: "userUpload" | "historicalData" | "historicalOwnerStatement" | "ownerStatementExample" | "listingOwnerAssignment" | "listingFeeAssignment";
32974
- startDate: string | null;
32975
- endDate: string | null;
32976
- /**
32977
- * Format: date-time
32978
- * @description Timestamp string with date, time, milliseconds, and timezone.
32979
- * @example 2024-01-15T12:30:00.000+00:00
32980
- */
32981
- createdAt: string;
32982
- contact: {
32983
- /** Format: uuid */
32984
- id: string;
32985
- name?: string | null;
32986
- firstName?: string | null;
32987
- uniqueRef?: string | null;
32988
- shortRef?: string | null;
32989
- email?: string | null;
32990
- /** @enum {string} */
32991
- type: "owner" | "vendor";
32992
- } | null;
32993
- }[];
32994
- pagination: {
32995
- /** @default 100 */
32996
- limit: number;
32997
- /** @default 1 */
32998
- page: number;
32999
- total: number;
33000
- totalPage: number;
33001
- nextPage?: number;
33002
- };
33021
+ /**
33022
+ * Format: uri
33023
+ * @description Exact embedded-application origin allowed to use this policy.
33024
+ */
33025
+ embedOrigin: string;
33026
+ /**
33027
+ * Format: uri
33028
+ * @description Exact parent-page origin allowed to frame the embedded application.
33029
+ */
33030
+ parentOrigin: string;
33003
33031
  };
33004
33032
  };
33005
33033
  };
@@ -33230,9 +33258,19 @@ export interface operations {
33230
33258
  };
33231
33259
  };
33232
33260
  };
33233
- postFiles: {
33261
+ getFiles: {
33234
33262
  parameters: {
33235
- query?: never;
33263
+ query?: {
33264
+ /** @description Filter files by filename text match. */
33265
+ search?: string;
33266
+ /** @description Filter files by their upload purpose. */
33267
+ type?: "userUpload" | "historicalData" | "historicalOwnerStatement" | "ownerStatementExample" | "listingOwnerAssignment" | "listingFeeAssignment";
33268
+ /** @description Sort field; prefix with - for descending order. */
33269
+ sort?: "filename" | "-filename" | "startDate" | "-startDate" | "endDate" | "-endDate" | "createdAt" | "-createdAt" | "contactName" | "-contactName";
33270
+ limit?: number;
33271
+ page?: number;
33272
+ offset?: number;
33273
+ };
33236
33274
  header?: never;
33237
33275
  path?: never;
33238
33276
  cookie?: never;
@@ -33246,30 +33284,560 @@ export interface operations {
33246
33284
  };
33247
33285
  content: {
33248
33286
  "application/json": {
33249
- /** Format: uuid */
33250
- id: string;
33251
- filename: string;
33252
- /** @enum {string} */
33253
- type: "userUpload" | "historicalData" | "historicalOwnerStatement" | "ownerStatementExample" | "listingOwnerAssignment" | "listingFeeAssignment";
33254
- startDate: string | null;
33255
- endDate: string | null;
33256
- /**
33257
- * Format: date-time
33258
- * @description Timestamp string with date, time, milliseconds, and timezone.
33259
- * @example 2024-01-15T12:30:00.000+00:00
33260
- */
33261
- createdAt: string;
33262
- contact: {
33287
+ data: {
33263
33288
  /** Format: uuid */
33264
33289
  id: string;
33265
- name?: string | null;
33266
- firstName?: string | null;
33267
- uniqueRef?: string | null;
33268
- shortRef?: string | null;
33269
- email?: string | null;
33290
+ filename: string;
33270
33291
  /** @enum {string} */
33271
- type: "owner" | "vendor";
33272
- } | null;
33292
+ type: "userUpload" | "historicalData" | "historicalOwnerStatement" | "ownerStatementExample" | "listingOwnerAssignment" | "listingFeeAssignment";
33293
+ startDate: string | null;
33294
+ endDate: string | null;
33295
+ /**
33296
+ * Format: date-time
33297
+ * @description Timestamp string with date, time, milliseconds, and timezone.
33298
+ * @example 2024-01-15T12:30:00.000+00:00
33299
+ */
33300
+ createdAt: string;
33301
+ contact: {
33302
+ /** Format: uuid */
33303
+ id: string;
33304
+ name?: string | null;
33305
+ firstName?: string | null;
33306
+ uniqueRef?: string | null;
33307
+ shortRef?: string | null;
33308
+ email?: string | null;
33309
+ /** @enum {string} */
33310
+ type: "owner" | "vendor";
33311
+ } | null;
33312
+ }[];
33313
+ pagination: {
33314
+ /** @default 100 */
33315
+ limit: number;
33316
+ /** @default 1 */
33317
+ page: number;
33318
+ total: number;
33319
+ totalPage: number;
33320
+ nextPage?: number;
33321
+ };
33322
+ };
33323
+ };
33324
+ };
33325
+ /** @description Bad request */
33326
+ 400: {
33327
+ headers: {
33328
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
33329
+ "Retry-After"?: number;
33330
+ [name: string]: unknown;
33331
+ };
33332
+ content: {
33333
+ "application/json": {
33334
+ code: string;
33335
+ message: string;
33336
+ links?: {
33337
+ docs: string;
33338
+ schema: string;
33339
+ };
33340
+ issues?: {
33341
+ message: string;
33342
+ path?: (string | number)[];
33343
+ schema?: string;
33344
+ }[];
33345
+ retryable?: boolean;
33346
+ context?: unknown;
33347
+ };
33348
+ };
33349
+ };
33350
+ /** @description Unauthorized */
33351
+ 401: {
33352
+ headers: {
33353
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
33354
+ "Retry-After"?: number;
33355
+ [name: string]: unknown;
33356
+ };
33357
+ content: {
33358
+ "application/json": {
33359
+ code: string;
33360
+ message: string;
33361
+ links?: {
33362
+ docs: string;
33363
+ schema: string;
33364
+ };
33365
+ issues?: {
33366
+ message: string;
33367
+ path?: (string | number)[];
33368
+ schema?: string;
33369
+ }[];
33370
+ retryable?: boolean;
33371
+ context?: unknown;
33372
+ };
33373
+ };
33374
+ };
33375
+ /** @description Forbidden */
33376
+ 403: {
33377
+ headers: {
33378
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
33379
+ "Retry-After"?: number;
33380
+ [name: string]: unknown;
33381
+ };
33382
+ content: {
33383
+ "application/json": {
33384
+ code: string;
33385
+ message: string;
33386
+ links?: {
33387
+ docs: string;
33388
+ schema: string;
33389
+ };
33390
+ issues?: {
33391
+ message: string;
33392
+ path?: (string | number)[];
33393
+ schema?: string;
33394
+ }[];
33395
+ retryable?: boolean;
33396
+ context?: unknown;
33397
+ };
33398
+ };
33399
+ };
33400
+ /** @description Not found */
33401
+ 404: {
33402
+ headers: {
33403
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
33404
+ "Retry-After"?: number;
33405
+ [name: string]: unknown;
33406
+ };
33407
+ content: {
33408
+ "application/json": {
33409
+ code: string;
33410
+ message: string;
33411
+ links?: {
33412
+ docs: string;
33413
+ schema: string;
33414
+ };
33415
+ issues?: {
33416
+ message: string;
33417
+ path?: (string | number)[];
33418
+ schema?: string;
33419
+ }[];
33420
+ retryable?: boolean;
33421
+ context?: unknown;
33422
+ };
33423
+ };
33424
+ };
33425
+ /** @description Conflict */
33426
+ 409: {
33427
+ headers: {
33428
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
33429
+ "Retry-After"?: number;
33430
+ [name: string]: unknown;
33431
+ };
33432
+ content: {
33433
+ "application/json": {
33434
+ code: string;
33435
+ message: string;
33436
+ links?: {
33437
+ docs: string;
33438
+ schema: string;
33439
+ };
33440
+ issues?: {
33441
+ message: string;
33442
+ path?: (string | number)[];
33443
+ schema?: string;
33444
+ }[];
33445
+ retryable?: boolean;
33446
+ context?: unknown;
33447
+ };
33448
+ };
33449
+ };
33450
+ /** @description Gone */
33451
+ 410: {
33452
+ headers: {
33453
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
33454
+ "Retry-After"?: number;
33455
+ [name: string]: unknown;
33456
+ };
33457
+ content: {
33458
+ "application/json": {
33459
+ code: string;
33460
+ message: string;
33461
+ links?: {
33462
+ docs: string;
33463
+ schema: string;
33464
+ };
33465
+ issues?: {
33466
+ message: string;
33467
+ path?: (string | number)[];
33468
+ schema?: string;
33469
+ }[];
33470
+ retryable?: boolean;
33471
+ context?: unknown;
33472
+ };
33473
+ };
33474
+ };
33475
+ /** @description Unprocessable content */
33476
+ 422: {
33477
+ headers: {
33478
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
33479
+ "Retry-After"?: number;
33480
+ [name: string]: unknown;
33481
+ };
33482
+ content: {
33483
+ "application/json": {
33484
+ code: string;
33485
+ message: string;
33486
+ links?: {
33487
+ docs: string;
33488
+ schema: string;
33489
+ };
33490
+ issues?: {
33491
+ message: string;
33492
+ path?: (string | number)[];
33493
+ schema?: string;
33494
+ }[];
33495
+ retryable?: boolean;
33496
+ context?: unknown;
33497
+ };
33498
+ };
33499
+ };
33500
+ /** @description Internal server error */
33501
+ 500: {
33502
+ headers: {
33503
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
33504
+ "Retry-After"?: number;
33505
+ [name: string]: unknown;
33506
+ };
33507
+ content: {
33508
+ "application/json": {
33509
+ code: string;
33510
+ message: string;
33511
+ links?: {
33512
+ docs: string;
33513
+ schema: string;
33514
+ };
33515
+ issues?: {
33516
+ message: string;
33517
+ path?: (string | number)[];
33518
+ schema?: string;
33519
+ }[];
33520
+ retryable?: boolean;
33521
+ context?: unknown;
33522
+ };
33523
+ };
33524
+ };
33525
+ /** @description Service unavailable */
33526
+ 503: {
33527
+ headers: {
33528
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
33529
+ "Retry-After"?: number;
33530
+ [name: string]: unknown;
33531
+ };
33532
+ content: {
33533
+ "application/json": {
33534
+ code: string;
33535
+ message: string;
33536
+ links?: {
33537
+ docs: string;
33538
+ schema: string;
33539
+ };
33540
+ issues?: {
33541
+ message: string;
33542
+ path?: (string | number)[];
33543
+ schema?: string;
33544
+ }[];
33545
+ retryable?: boolean;
33546
+ context?: unknown;
33547
+ };
33548
+ };
33549
+ };
33550
+ };
33551
+ };
33552
+ postFiles: {
33553
+ parameters: {
33554
+ query?: never;
33555
+ header?: never;
33556
+ path?: never;
33557
+ cookie?: never;
33558
+ };
33559
+ requestBody?: {
33560
+ content: {
33561
+ "application/json": {
33562
+ filename: string;
33563
+ contentType: string;
33564
+ fileSize: number;
33565
+ /**
33566
+ * @default userUpload
33567
+ * @enum {string}
33568
+ */
33569
+ type?: "userUpload" | "historicalData" | "historicalOwnerStatement" | "ownerStatementExample" | "listingOwnerAssignment" | "listingFeeAssignment";
33570
+ startDate?: string | null;
33571
+ endDate?: string | null;
33572
+ contactId?: string | null;
33573
+ };
33574
+ };
33575
+ };
33576
+ responses: {
33577
+ /** @description Successful response */
33578
+ 200: {
33579
+ headers: {
33580
+ [name: string]: unknown;
33581
+ };
33582
+ content: {
33583
+ "application/json": {
33584
+ /** Format: date-time */
33585
+ expiresAt: string;
33586
+ /** Format: uuid */
33587
+ fileId: string;
33588
+ uploadRef: string;
33589
+ /** Format: uri */
33590
+ uploadUrl: string;
33591
+ };
33592
+ };
33593
+ };
33594
+ /** @description Bad request */
33595
+ 400: {
33596
+ headers: {
33597
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
33598
+ "Retry-After"?: number;
33599
+ [name: string]: unknown;
33600
+ };
33601
+ content: {
33602
+ "application/json": {
33603
+ code: string;
33604
+ message: string;
33605
+ links?: {
33606
+ docs: string;
33607
+ schema: string;
33608
+ };
33609
+ issues?: {
33610
+ message: string;
33611
+ path?: (string | number)[];
33612
+ schema?: string;
33613
+ }[];
33614
+ retryable?: boolean;
33615
+ context?: unknown;
33616
+ };
33617
+ };
33618
+ };
33619
+ /** @description Unauthorized */
33620
+ 401: {
33621
+ headers: {
33622
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
33623
+ "Retry-After"?: number;
33624
+ [name: string]: unknown;
33625
+ };
33626
+ content: {
33627
+ "application/json": {
33628
+ code: string;
33629
+ message: string;
33630
+ links?: {
33631
+ docs: string;
33632
+ schema: string;
33633
+ };
33634
+ issues?: {
33635
+ message: string;
33636
+ path?: (string | number)[];
33637
+ schema?: string;
33638
+ }[];
33639
+ retryable?: boolean;
33640
+ context?: unknown;
33641
+ };
33642
+ };
33643
+ };
33644
+ /** @description Forbidden */
33645
+ 403: {
33646
+ headers: {
33647
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
33648
+ "Retry-After"?: number;
33649
+ [name: string]: unknown;
33650
+ };
33651
+ content: {
33652
+ "application/json": {
33653
+ code: string;
33654
+ message: string;
33655
+ links?: {
33656
+ docs: string;
33657
+ schema: string;
33658
+ };
33659
+ issues?: {
33660
+ message: string;
33661
+ path?: (string | number)[];
33662
+ schema?: string;
33663
+ }[];
33664
+ retryable?: boolean;
33665
+ context?: unknown;
33666
+ };
33667
+ };
33668
+ };
33669
+ /** @description Not found */
33670
+ 404: {
33671
+ headers: {
33672
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
33673
+ "Retry-After"?: number;
33674
+ [name: string]: unknown;
33675
+ };
33676
+ content: {
33677
+ "application/json": {
33678
+ code: string;
33679
+ message: string;
33680
+ links?: {
33681
+ docs: string;
33682
+ schema: string;
33683
+ };
33684
+ issues?: {
33685
+ message: string;
33686
+ path?: (string | number)[];
33687
+ schema?: string;
33688
+ }[];
33689
+ retryable?: boolean;
33690
+ context?: unknown;
33691
+ };
33692
+ };
33693
+ };
33694
+ /** @description Conflict */
33695
+ 409: {
33696
+ headers: {
33697
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
33698
+ "Retry-After"?: number;
33699
+ [name: string]: unknown;
33700
+ };
33701
+ content: {
33702
+ "application/json": {
33703
+ code: string;
33704
+ message: string;
33705
+ links?: {
33706
+ docs: string;
33707
+ schema: string;
33708
+ };
33709
+ issues?: {
33710
+ message: string;
33711
+ path?: (string | number)[];
33712
+ schema?: string;
33713
+ }[];
33714
+ retryable?: boolean;
33715
+ context?: unknown;
33716
+ };
33717
+ };
33718
+ };
33719
+ /** @description Gone */
33720
+ 410: {
33721
+ headers: {
33722
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
33723
+ "Retry-After"?: number;
33724
+ [name: string]: unknown;
33725
+ };
33726
+ content: {
33727
+ "application/json": {
33728
+ code: string;
33729
+ message: string;
33730
+ links?: {
33731
+ docs: string;
33732
+ schema: string;
33733
+ };
33734
+ issues?: {
33735
+ message: string;
33736
+ path?: (string | number)[];
33737
+ schema?: string;
33738
+ }[];
33739
+ retryable?: boolean;
33740
+ context?: unknown;
33741
+ };
33742
+ };
33743
+ };
33744
+ /** @description Unprocessable content */
33745
+ 422: {
33746
+ headers: {
33747
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
33748
+ "Retry-After"?: number;
33749
+ [name: string]: unknown;
33750
+ };
33751
+ content: {
33752
+ "application/json": {
33753
+ code: string;
33754
+ message: string;
33755
+ links?: {
33756
+ docs: string;
33757
+ schema: string;
33758
+ };
33759
+ issues?: {
33760
+ message: string;
33761
+ path?: (string | number)[];
33762
+ schema?: string;
33763
+ }[];
33764
+ retryable?: boolean;
33765
+ context?: unknown;
33766
+ };
33767
+ };
33768
+ };
33769
+ /** @description Internal server error */
33770
+ 500: {
33771
+ headers: {
33772
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
33773
+ "Retry-After"?: number;
33774
+ [name: string]: unknown;
33775
+ };
33776
+ content: {
33777
+ "application/json": {
33778
+ code: string;
33779
+ message: string;
33780
+ links?: {
33781
+ docs: string;
33782
+ schema: string;
33783
+ };
33784
+ issues?: {
33785
+ message: string;
33786
+ path?: (string | number)[];
33787
+ schema?: string;
33788
+ }[];
33789
+ retryable?: boolean;
33790
+ context?: unknown;
33791
+ };
33792
+ };
33793
+ };
33794
+ /** @description Service unavailable */
33795
+ 503: {
33796
+ headers: {
33797
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
33798
+ "Retry-After"?: number;
33799
+ [name: string]: unknown;
33800
+ };
33801
+ content: {
33802
+ "application/json": {
33803
+ code: string;
33804
+ message: string;
33805
+ links?: {
33806
+ docs: string;
33807
+ schema: string;
33808
+ };
33809
+ issues?: {
33810
+ message: string;
33811
+ path?: (string | number)[];
33812
+ schema?: string;
33813
+ }[];
33814
+ retryable?: boolean;
33815
+ context?: unknown;
33816
+ };
33817
+ };
33818
+ };
33819
+ };
33820
+ };
33821
+ putFilesUploadsByUploadRef: {
33822
+ parameters: {
33823
+ query?: never;
33824
+ header?: never;
33825
+ path: {
33826
+ uploadRef: string;
33827
+ };
33828
+ cookie?: never;
33829
+ };
33830
+ requestBody?: never;
33831
+ responses: {
33832
+ /** @description Successful response */
33833
+ 200: {
33834
+ headers: {
33835
+ [name: string]: unknown;
33836
+ };
33837
+ content: {
33838
+ "application/json": {
33839
+ /** @constant */
33840
+ status: "uploaded";
33273
33841
  };
33274
33842
  };
33275
33843
  };
@@ -77491,6 +78059,7 @@ export interface operations {
77491
78059
  getGuestBalancesReport: {
77492
78060
  parameters: {
77493
78061
  query: {
78062
+ /** @description As-of date or date range. For a range, the inclusive end is used. */
77494
78063
  date: string;
77495
78064
  occupancyStatus: "departed" | "inHouse" | "upcoming" | "cancelled" | "unassigned" | "all";
77496
78065
  channels?: string;
@@ -77869,6 +78438,7 @@ export interface operations {
77869
78438
  getGuestBalancesReportCsv: {
77870
78439
  parameters: {
77871
78440
  query: {
78441
+ /** @description As-of date or date range. For a range, the inclusive end is used. */
77872
78442
  date: string;
77873
78443
  occupancyStatus: "departed" | "inHouse" | "upcoming" | "cancelled" | "unassigned" | "all";
77874
78444
  channels?: string;
@@ -78121,6 +78691,7 @@ export interface operations {
78121
78691
  getGuestBalancesReportAggregated: {
78122
78692
  parameters: {
78123
78693
  query: {
78694
+ /** @description As-of date or date range. For a range, the inclusive end is used. */
78124
78695
  date: string;
78125
78696
  channels?: string;
78126
78697
  };
@@ -106197,7 +106768,7 @@ export interface operations {
106197
106768
  } | null;
106198
106769
  } | null;
106199
106770
  }[];
106200
- /** @description Expense attachment IDs returned by POST /transactions/attachments. Only expense transactions support attachments. Omit to leave existing attachments unchanged on update; send an array to replace the attached set. */
106771
+ /** @description Expense attachment IDs returned as attachmentId by POST /transactions/attachments after PUT to uploadUrl succeeds. Only expense transactions support attachments. Omit to leave existing attachments unchanged on update; send an array to replace the attached set. */
106201
106772
  attachmentIds?: string[] | null;
106202
106773
  recurringTemplateId?: string | null;
106203
106774
  matchBankAccountLast4?: string | null;
@@ -124349,7 +124920,7 @@ export interface operations {
124349
124920
  } | null;
124350
124921
  } | null;
124351
124922
  }[];
124352
- /** @description Expense attachment IDs returned by POST /transactions/attachments. Only expense transactions support attachments. Omit to leave existing attachments unchanged on update; send an array to replace the attached set. */
124923
+ /** @description Expense attachment IDs returned as attachmentId by POST /transactions/attachments after PUT to uploadUrl succeeds. Only expense transactions support attachments. Omit to leave existing attachments unchanged on update; send an array to replace the attached set. */
124353
124924
  attachmentIds?: string[] | null;
124354
124925
  recurringTemplateId?: string | null;
124355
124926
  matchBankAccountLast4?: string | null;
@@ -124837,7 +125408,7 @@ export interface operations {
124837
125408
  matchReservationProcessorBookingRef?: string | null;
124838
125409
  matchLineTypeClassification?: string | null;
124839
125410
  }[];
124840
- /** @description Expense attachment IDs returned by POST /transactions/attachments. Only expense transactions support attachments. Omit to leave existing attachments unchanged on update; send an array to replace the attached set. */
125411
+ /** @description Expense attachment IDs returned as attachmentId by POST /transactions/attachments after PUT to uploadUrl succeeds. Only expense transactions support attachments. Omit to leave existing attachments unchanged on update; send an array to replace the attached set. */
124841
125412
  attachmentIds?: string[] | null;
124842
125413
  /** @description Expense payment and reconciliation state */
124843
125414
  payment?: {
@@ -125034,7 +125605,7 @@ export interface operations {
125034
125605
  } | null;
125035
125606
  } | null;
125036
125607
  }[];
125037
- /** @description Expense attachment IDs returned by POST /transactions/attachments. Only expense transactions support attachments. Omit to leave existing attachments unchanged on update; send an array to replace the attached set. */
125608
+ /** @description Expense attachment IDs returned as attachmentId by POST /transactions/attachments after PUT to uploadUrl succeeds. Only expense transactions support attachments. Omit to leave existing attachments unchanged on update; send an array to replace the attached set. */
125038
125609
  attachmentIds?: string[] | null;
125039
125610
  recurringTemplateId?: string | null;
125040
125611
  matchBankAccountLast4?: string | null;
@@ -125429,7 +126000,17 @@ export interface operations {
125429
126000
  path?: never;
125430
126001
  cookie?: never;
125431
126002
  };
125432
- requestBody?: never;
126003
+ requestBody?: {
126004
+ content: {
126005
+ "application/json": {
126006
+ filename: string;
126007
+ contentType: string;
126008
+ fileSize: number;
126009
+ /** @default false */
126010
+ isOwnerAccessible?: boolean;
126011
+ };
126012
+ };
126013
+ };
125433
126014
  responses: {
125434
126015
  /** @description Successful response */
125435
126016
  200: {
@@ -125439,19 +126020,262 @@ export interface operations {
125439
126020
  content: {
125440
126021
  "application/json": {
125441
126022
  /** Format: uuid */
125442
- id: string;
125443
- transactionId: string | null;
125444
- /**
125445
- * Format: date-time
125446
- * @description Timestamp string with date, time, milliseconds, and timezone.
125447
- * @example 2024-01-15T12:30:00.000+00:00
125448
- */
125449
- createdAt: string;
125450
- filename: string;
125451
- extension?: string | null;
125452
- contentType: string;
125453
- byteSize: number;
125454
- isOwnerAccessible: boolean;
126023
+ attachmentId: string;
126024
+ /** Format: date-time */
126025
+ expiresAt: string;
126026
+ uploadRef: string;
126027
+ /** Format: uri */
126028
+ uploadUrl: string;
126029
+ };
126030
+ };
126031
+ };
126032
+ /** @description Bad request */
126033
+ 400: {
126034
+ headers: {
126035
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
126036
+ "Retry-After"?: number;
126037
+ [name: string]: unknown;
126038
+ };
126039
+ content: {
126040
+ "application/json": {
126041
+ code: string;
126042
+ message: string;
126043
+ links?: {
126044
+ docs: string;
126045
+ schema: string;
126046
+ };
126047
+ issues?: {
126048
+ message: string;
126049
+ path?: (string | number)[];
126050
+ schema?: string;
126051
+ }[];
126052
+ retryable?: boolean;
126053
+ context?: unknown;
126054
+ };
126055
+ };
126056
+ };
126057
+ /** @description Unauthorized */
126058
+ 401: {
126059
+ headers: {
126060
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
126061
+ "Retry-After"?: number;
126062
+ [name: string]: unknown;
126063
+ };
126064
+ content: {
126065
+ "application/json": {
126066
+ code: string;
126067
+ message: string;
126068
+ links?: {
126069
+ docs: string;
126070
+ schema: string;
126071
+ };
126072
+ issues?: {
126073
+ message: string;
126074
+ path?: (string | number)[];
126075
+ schema?: string;
126076
+ }[];
126077
+ retryable?: boolean;
126078
+ context?: unknown;
126079
+ };
126080
+ };
126081
+ };
126082
+ /** @description Forbidden */
126083
+ 403: {
126084
+ headers: {
126085
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
126086
+ "Retry-After"?: number;
126087
+ [name: string]: unknown;
126088
+ };
126089
+ content: {
126090
+ "application/json": {
126091
+ code: string;
126092
+ message: string;
126093
+ links?: {
126094
+ docs: string;
126095
+ schema: string;
126096
+ };
126097
+ issues?: {
126098
+ message: string;
126099
+ path?: (string | number)[];
126100
+ schema?: string;
126101
+ }[];
126102
+ retryable?: boolean;
126103
+ context?: unknown;
126104
+ };
126105
+ };
126106
+ };
126107
+ /** @description Not found */
126108
+ 404: {
126109
+ headers: {
126110
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
126111
+ "Retry-After"?: number;
126112
+ [name: string]: unknown;
126113
+ };
126114
+ content: {
126115
+ "application/json": {
126116
+ code: string;
126117
+ message: string;
126118
+ links?: {
126119
+ docs: string;
126120
+ schema: string;
126121
+ };
126122
+ issues?: {
126123
+ message: string;
126124
+ path?: (string | number)[];
126125
+ schema?: string;
126126
+ }[];
126127
+ retryable?: boolean;
126128
+ context?: unknown;
126129
+ };
126130
+ };
126131
+ };
126132
+ /** @description Conflict */
126133
+ 409: {
126134
+ headers: {
126135
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
126136
+ "Retry-After"?: number;
126137
+ [name: string]: unknown;
126138
+ };
126139
+ content: {
126140
+ "application/json": {
126141
+ code: string;
126142
+ message: string;
126143
+ links?: {
126144
+ docs: string;
126145
+ schema: string;
126146
+ };
126147
+ issues?: {
126148
+ message: string;
126149
+ path?: (string | number)[];
126150
+ schema?: string;
126151
+ }[];
126152
+ retryable?: boolean;
126153
+ context?: unknown;
126154
+ };
126155
+ };
126156
+ };
126157
+ /** @description Gone */
126158
+ 410: {
126159
+ headers: {
126160
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
126161
+ "Retry-After"?: number;
126162
+ [name: string]: unknown;
126163
+ };
126164
+ content: {
126165
+ "application/json": {
126166
+ code: string;
126167
+ message: string;
126168
+ links?: {
126169
+ docs: string;
126170
+ schema: string;
126171
+ };
126172
+ issues?: {
126173
+ message: string;
126174
+ path?: (string | number)[];
126175
+ schema?: string;
126176
+ }[];
126177
+ retryable?: boolean;
126178
+ context?: unknown;
126179
+ };
126180
+ };
126181
+ };
126182
+ /** @description Unprocessable content */
126183
+ 422: {
126184
+ headers: {
126185
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
126186
+ "Retry-After"?: number;
126187
+ [name: string]: unknown;
126188
+ };
126189
+ content: {
126190
+ "application/json": {
126191
+ code: string;
126192
+ message: string;
126193
+ links?: {
126194
+ docs: string;
126195
+ schema: string;
126196
+ };
126197
+ issues?: {
126198
+ message: string;
126199
+ path?: (string | number)[];
126200
+ schema?: string;
126201
+ }[];
126202
+ retryable?: boolean;
126203
+ context?: unknown;
126204
+ };
126205
+ };
126206
+ };
126207
+ /** @description Internal server error */
126208
+ 500: {
126209
+ headers: {
126210
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
126211
+ "Retry-After"?: number;
126212
+ [name: string]: unknown;
126213
+ };
126214
+ content: {
126215
+ "application/json": {
126216
+ code: string;
126217
+ message: string;
126218
+ links?: {
126219
+ docs: string;
126220
+ schema: string;
126221
+ };
126222
+ issues?: {
126223
+ message: string;
126224
+ path?: (string | number)[];
126225
+ schema?: string;
126226
+ }[];
126227
+ retryable?: boolean;
126228
+ context?: unknown;
126229
+ };
126230
+ };
126231
+ };
126232
+ /** @description Service unavailable */
126233
+ 503: {
126234
+ headers: {
126235
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
126236
+ "Retry-After"?: number;
126237
+ [name: string]: unknown;
126238
+ };
126239
+ content: {
126240
+ "application/json": {
126241
+ code: string;
126242
+ message: string;
126243
+ links?: {
126244
+ docs: string;
126245
+ schema: string;
126246
+ };
126247
+ issues?: {
126248
+ message: string;
126249
+ path?: (string | number)[];
126250
+ schema?: string;
126251
+ }[];
126252
+ retryable?: boolean;
126253
+ context?: unknown;
126254
+ };
126255
+ };
126256
+ };
126257
+ };
126258
+ };
126259
+ putTransactionsAttachmentsUploadsByUploadRef: {
126260
+ parameters: {
126261
+ query?: never;
126262
+ header?: never;
126263
+ path: {
126264
+ uploadRef: string;
126265
+ };
126266
+ cookie?: never;
126267
+ };
126268
+ requestBody?: never;
126269
+ responses: {
126270
+ /** @description Successful response */
126271
+ 200: {
126272
+ headers: {
126273
+ [name: string]: unknown;
126274
+ };
126275
+ content: {
126276
+ "application/json": {
126277
+ /** @constant */
126278
+ status: "uploaded";
125455
126279
  };
125456
126280
  };
125457
126281
  };
@@ -126520,7 +127344,7 @@ export interface operations {
126520
127344
  matchReservationProcessorBookingRef?: string | null;
126521
127345
  matchLineTypeClassification?: string | null;
126522
127346
  }[];
126523
- /** @description Expense attachment IDs returned by POST /transactions/attachments. Only expense transactions support attachments. Omit to leave existing attachments unchanged on update; send an array to replace the attached set. */
127347
+ /** @description Expense attachment IDs returned as attachmentId by POST /transactions/attachments after PUT to uploadUrl succeeds. Only expense transactions support attachments. Omit to leave existing attachments unchanged on update; send an array to replace the attached set. */
126524
127348
  attachmentIds?: string[] | null;
126525
127349
  /** @description Expense payment and reconciliation state */
126526
127350
  payment?: {
@@ -130671,7 +131495,7 @@ export interface operations {
130671
131495
  } | null;
130672
131496
  } | null;
130673
131497
  }[];
130674
- /** @description Expense attachment IDs returned by POST /transactions/attachments. Only expense transactions support attachments. Omit to leave existing attachments unchanged on update; send an array to replace the attached set. */
131498
+ /** @description Expense attachment IDs returned as attachmentId by POST /transactions/attachments after PUT to uploadUrl succeeds. Only expense transactions support attachments. Omit to leave existing attachments unchanged on update; send an array to replace the attached set. */
130675
131499
  attachmentIds?: string[] | null;
130676
131500
  recurringTemplateId?: string | null;
130677
131501
  matchBankAccountLast4?: string | null;
@@ -131213,7 +132037,7 @@ export interface operations {
131213
132037
  } | null;
131214
132038
  } | null;
131215
132039
  }[];
131216
- /** @description Expense attachment IDs returned by POST /transactions/attachments. Only expense transactions support attachments. Omit to leave existing attachments unchanged on update; send an array to replace the attached set. */
132040
+ /** @description Expense attachment IDs returned as attachmentId by POST /transactions/attachments after PUT to uploadUrl succeeds. Only expense transactions support attachments. Omit to leave existing attachments unchanged on update; send an array to replace the attached set. */
131217
132041
  attachmentIds?: string[] | null;
131218
132042
  recurringTemplateId?: string | null;
131219
132043
  matchBankAccountLast4?: string | null;
@@ -131660,7 +132484,7 @@ export interface operations {
131660
132484
  type?: "deposit" | "expense" | "transfer" | "payout";
131661
132485
  date?: string;
131662
132486
  currency?: string | null;
131663
- /** @description Expense attachment IDs returned by POST /transactions/attachments. Only expense transactions support attachments. Omit to leave existing attachments unchanged on update; send an array to replace the attached set. */
132487
+ /** @description Expense attachment IDs returned as attachmentId by POST /transactions/attachments after PUT to uploadUrl succeeds. Only expense transactions support attachments. Omit to leave existing attachments unchanged on update; send an array to replace the attached set. */
131664
132488
  attachmentIds?: string[] | null;
131665
132489
  /** @description Expense payment and reconciliation state */
131666
132490
  payment?: {
@@ -131964,7 +132788,7 @@ export interface operations {
131964
132788
  } | null;
131965
132789
  } | null;
131966
132790
  }[];
131967
- /** @description Expense attachment IDs returned by POST /transactions/attachments. Only expense transactions support attachments. Omit to leave existing attachments unchanged on update; send an array to replace the attached set. */
132791
+ /** @description Expense attachment IDs returned as attachmentId by POST /transactions/attachments after PUT to uploadUrl succeeds. Only expense transactions support attachments. Omit to leave existing attachments unchanged on update; send an array to replace the attached set. */
131968
132792
  attachmentIds?: string[] | null;
131969
132793
  recurringTemplateId?: string | null;
131970
132794
  matchBankAccountLast4?: string | null;
@@ -133626,7 +134450,7 @@ export interface operations {
133626
134450
  } | null;
133627
134451
  } | null;
133628
134452
  }[];
133629
- /** @description Expense attachment IDs returned by POST /transactions/attachments. Only expense transactions support attachments. Omit to leave existing attachments unchanged on update; send an array to replace the attached set. */
134453
+ /** @description Expense attachment IDs returned as attachmentId by POST /transactions/attachments after PUT to uploadUrl succeeds. Only expense transactions support attachments. Omit to leave existing attachments unchanged on update; send an array to replace the attached set. */
133630
134454
  attachmentIds?: string[] | null;
133631
134455
  recurringTemplateId?: string | null;
133632
134456
  matchBankAccountLast4?: string | null;