@vrplatform/api 1.3.1-stage.2484 → 1.3.1-stage.2487

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.
@@ -3107,7 +3107,7 @@ export interface paths {
3107
3107
  };
3108
3108
  get?: never;
3109
3109
  put?: never;
3110
- /** @description Upload an expense attachment (staged) */
3110
+ /** @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. */
3111
3111
  post: operations["postTransactionAttachments"];
3112
3112
  delete?: never;
3113
3113
  options?: never;
@@ -3125,11 +3125,11 @@ export interface paths {
3125
3125
  get?: never;
3126
3126
  put?: never;
3127
3127
  post?: never;
3128
- /** @description Delete an expense attachment */
3128
+ /** @description Delete an expense attachment. This removes staged attachments and attachments already linked to expense transactions. */
3129
3129
  delete: operations["deleteTransactionAttachmentsByAttachmentId"];
3130
3130
  options?: never;
3131
3131
  head?: never;
3132
- /** @description Update an expense attachment */
3132
+ /** @description Update attachment visibility. isOwnerAccessible controls whether owners can see the file on owner statement details. */
3133
3133
  patch: operations["patchTransactionAttachmentsByAttachmentId"];
3134
3134
  trace?: never;
3135
3135
  };
@@ -3160,7 +3160,7 @@ export interface paths {
3160
3160
  /** @description Transactions List */
3161
3161
  get: operations["getTransactions"];
3162
3162
  put?: never;
3163
- /** @description Create an transaction */
3163
+ /** @description Create a transaction. For expense attachments, first upload each file with POST /transaction-attachments, then pass the returned ids in attachmentIds. Attachments are only supported for expense transactions. */
3164
3164
  post: operations["postTransactions"];
3165
3165
  delete?: never;
3166
3166
  options?: never;
@@ -3418,7 +3418,7 @@ export interface paths {
3418
3418
  };
3419
3419
  /** @description Transactions List */
3420
3420
  get: operations["getTransactionsById"];
3421
- /** @description Update an transaction by ID */
3421
+ /** @description Update a transaction by ID. For expense attachments, pass attachmentIds to replace the attached set. Omit attachmentIds to keep current attachments. Attachments are only supported for expense transactions. */
3422
3422
  put: operations["putTransactionsById"];
3423
3423
  post?: never;
3424
3424
  /** @description Delete an transaction by ID */
@@ -4752,6 +4752,7 @@ export interface operations {
4752
4752
  } | null;
4753
4753
  } | null;
4754
4754
  }[];
4755
+ /** @description Expense attachment IDs returned by POST /transaction-attachments. Only expense transactions support attachments. Omit to leave existing attachments unchanged on update; send an array to replace the attached set. */
4755
4756
  attachmentIds?: string[] | null;
4756
4757
  recurringTemplateId?: string | null;
4757
4758
  matchBankAccountLast4?: string | null;
@@ -7711,6 +7712,7 @@ export interface operations {
7711
7712
  matchReservationStripeGuestRef?: string | null;
7712
7713
  matchLineTypeClassification?: string | null;
7713
7714
  }[];
7715
+ /** @description Expense attachment IDs returned by POST /transaction-attachments. Only expense transactions support attachments. Omit to leave existing attachments unchanged on update; send an array to replace the attached set. */
7714
7716
  attachmentIds?: string[] | null;
7715
7717
  payment?: {
7716
7718
  bankRecordIds: string[];
@@ -8260,6 +8262,7 @@ export interface operations {
8260
8262
  matchReservationStripeGuestRef?: string | null;
8261
8263
  matchLineTypeClassification?: string | null;
8262
8264
  }[];
8265
+ /** @description Expense attachment IDs returned by POST /transaction-attachments. Only expense transactions support attachments. Omit to leave existing attachments unchanged on update; send an array to replace the attached set. */
8263
8266
  attachmentIds?: string[] | null;
8264
8267
  payment?: {
8265
8268
  bankRecordIds: string[];
@@ -9073,6 +9076,7 @@ export interface operations {
9073
9076
  matchReservationStripeGuestRef?: string | null;
9074
9077
  matchLineTypeClassification?: string | null;
9075
9078
  }[];
9079
+ /** @description Expense attachment IDs returned by POST /transaction-attachments. Only expense transactions support attachments. Omit to leave existing attachments unchanged on update; send an array to replace the attached set. */
9076
9080
  attachmentIds?: string[] | null;
9077
9081
  payment?: {
9078
9082
  bankRecordIds: string[];
@@ -9831,6 +9835,7 @@ export interface operations {
9831
9835
  matchReservationStripeGuestRef?: string | null;
9832
9836
  matchLineTypeClassification?: string | null;
9833
9837
  }[];
9838
+ /** @description Expense attachment IDs returned by POST /transaction-attachments. Only expense transactions support attachments. Omit to leave existing attachments unchanged on update; send an array to replace the attached set. */
9834
9839
  attachmentIds?: string[] | null;
9835
9840
  payment?: {
9836
9841
  bankRecordIds: string[];
@@ -35052,6 +35057,7 @@ export interface operations {
35052
35057
  } | null;
35053
35058
  } | null;
35054
35059
  }[];
35060
+ /** @description Expense attachment IDs returned by POST /transaction-attachments. Only expense transactions support attachments. Omit to leave existing attachments unchanged on update; send an array to replace the attached set. */
35055
35061
  attachmentIds?: string[] | null;
35056
35062
  recurringTemplateId?: string | null;
35057
35063
  matchBankAccountLast4?: string | null;
@@ -43590,6 +43596,7 @@ export interface operations {
43590
43596
  } | null;
43591
43597
  } | null;
43592
43598
  }[];
43599
+ /** @description Expense attachment IDs returned by POST /transaction-attachments. Only expense transactions support attachments. Omit to leave existing attachments unchanged on update; send an array to replace the attached set. */
43593
43600
  attachmentIds?: string[] | null;
43594
43601
  recurringTemplateId?: string | null;
43595
43602
  matchBankAccountLast4?: string | null;
@@ -43857,6 +43864,7 @@ export interface operations {
43857
43864
  matchReservationStripeGuestRef?: string | null;
43858
43865
  matchLineTypeClassification?: string | null;
43859
43866
  }[];
43867
+ /** @description Expense attachment IDs returned by POST /transaction-attachments. Only expense transactions support attachments. Omit to leave existing attachments unchanged on update; send an array to replace the attached set. */
43860
43868
  attachmentIds?: string[] | null;
43861
43869
  payment?: {
43862
43870
  bankRecordIds?: string[];
@@ -44017,6 +44025,7 @@ export interface operations {
44017
44025
  } | null;
44018
44026
  } | null;
44019
44027
  }[];
44028
+ /** @description Expense attachment IDs returned by POST /transaction-attachments. Only expense transactions support attachments. Omit to leave existing attachments unchanged on update; send an array to replace the attached set. */
44020
44029
  attachmentIds?: string[] | null;
44021
44030
  recurringTemplateId?: string | null;
44022
44031
  matchBankAccountLast4?: string | null;
@@ -44275,6 +44284,7 @@ export interface operations {
44275
44284
  matchReservationStripeGuestRef?: string | null;
44276
44285
  matchLineTypeClassification?: string | null;
44277
44286
  }[];
44287
+ /** @description Expense attachment IDs returned by POST /transaction-attachments. Only expense transactions support attachments. Omit to leave existing attachments unchanged on update; send an array to replace the attached set. */
44278
44288
  attachmentIds?: string[] | null;
44279
44289
  payment?: {
44280
44290
  bankRecordIds?: string[];
@@ -46963,6 +46973,7 @@ export interface operations {
46963
46973
  } | null;
46964
46974
  } | null;
46965
46975
  }[];
46976
+ /** @description Expense attachment IDs returned by POST /transaction-attachments. Only expense transactions support attachments. Omit to leave existing attachments unchanged on update; send an array to replace the attached set. */
46966
46977
  attachmentIds?: string[] | null;
46967
46978
  recurringTemplateId?: string | null;
46968
46979
  matchBankAccountLast4?: string | null;
@@ -47443,6 +47454,7 @@ export interface operations {
47443
47454
  } | null;
47444
47455
  } | null;
47445
47456
  }[];
47457
+ /** @description Expense attachment IDs returned by POST /transaction-attachments. Only expense transactions support attachments. Omit to leave existing attachments unchanged on update; send an array to replace the attached set. */
47446
47458
  attachmentIds?: string[] | null;
47447
47459
  recurringTemplateId?: string | null;
47448
47460
  matchBankAccountLast4?: string | null;
@@ -47676,6 +47688,7 @@ export interface operations {
47676
47688
  type?: "deposit" | "expense" | "transfer" | "payout";
47677
47689
  date?: string;
47678
47690
  currency?: string | null;
47691
+ /** @description Expense attachment IDs returned by POST /transaction-attachments. Only expense transactions support attachments. Omit to leave existing attachments unchanged on update; send an array to replace the attached set. */
47679
47692
  attachmentIds?: string[] | null;
47680
47693
  payment?: {
47681
47694
  bankRecordIds?: string[];
@@ -47922,6 +47935,7 @@ export interface operations {
47922
47935
  } | null;
47923
47936
  } | null;
47924
47937
  }[];
47938
+ /** @description Expense attachment IDs returned by POST /transaction-attachments. Only expense transactions support attachments. Omit to leave existing attachments unchanged on update; send an array to replace the attached set. */
47925
47939
  attachmentIds?: string[] | null;
47926
47940
  recurringTemplateId?: string | null;
47927
47941
  matchBankAccountLast4?: string | null;
@@ -48408,6 +48422,7 @@ export interface operations {
48408
48422
  } | null;
48409
48423
  } | null;
48410
48424
  }[];
48425
+ /** @description Expense attachment IDs returned by POST /transaction-attachments. Only expense transactions support attachments. Omit to leave existing attachments unchanged on update; send an array to replace the attached set. */
48411
48426
  attachmentIds?: string[] | null;
48412
48427
  recurringTemplateId?: string | null;
48413
48428
  matchBankAccountLast4?: string | null;