@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.
package/package.json CHANGED
@@ -3,7 +3,7 @@
3
3
  "publishConfig": {
4
4
  "access": "public"
5
5
  },
6
- "version": "1.3.1-stage.2484",
6
+ "version": "1.3.1-stage.2487",
7
7
  "description": "",
8
8
  "main": "build/main/index.js",
9
9
  "module": "build/module/index.js",
@@ -3108,7 +3108,7 @@ export interface paths {
3108
3108
  };
3109
3109
  get?: never;
3110
3110
  put?: never;
3111
- /** @description Upload an expense attachment (staged) */
3111
+ /** @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. */
3112
3112
  post: operations["postTransactionAttachments"];
3113
3113
  delete?: never;
3114
3114
  options?: never;
@@ -3126,11 +3126,11 @@ export interface paths {
3126
3126
  get?: never;
3127
3127
  put?: never;
3128
3128
  post?: never;
3129
- /** @description Delete an expense attachment */
3129
+ /** @description Delete an expense attachment. This removes staged attachments and attachments already linked to expense transactions. */
3130
3130
  delete: operations["deleteTransactionAttachmentsByAttachmentId"];
3131
3131
  options?: never;
3132
3132
  head?: never;
3133
- /** @description Update an expense attachment */
3133
+ /** @description Update attachment visibility. isOwnerAccessible controls whether owners can see the file on owner statement details. */
3134
3134
  patch: operations["patchTransactionAttachmentsByAttachmentId"];
3135
3135
  trace?: never;
3136
3136
  };
@@ -3161,7 +3161,7 @@ export interface paths {
3161
3161
  /** @description Transactions List */
3162
3162
  get: operations["getTransactions"];
3163
3163
  put?: never;
3164
- /** @description Create an transaction */
3164
+ /** @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. */
3165
3165
  post: operations["postTransactions"];
3166
3166
  delete?: never;
3167
3167
  options?: never;
@@ -3419,7 +3419,7 @@ export interface paths {
3419
3419
  };
3420
3420
  /** @description Transactions List */
3421
3421
  get: operations["getTransactionsById"];
3422
- /** @description Update an transaction by ID */
3422
+ /** @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. */
3423
3423
  put: operations["putTransactionsById"];
3424
3424
  post?: never;
3425
3425
  /** @description Delete an transaction by ID */
@@ -4753,6 +4753,7 @@ export interface operations {
4753
4753
  } | null;
4754
4754
  } | null;
4755
4755
  }[];
4756
+ /** @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. */
4756
4757
  attachmentIds?: string[] | null;
4757
4758
  recurringTemplateId?: string | null;
4758
4759
  matchBankAccountLast4?: string | null;
@@ -7712,6 +7713,7 @@ export interface operations {
7712
7713
  matchReservationStripeGuestRef?: string | null;
7713
7714
  matchLineTypeClassification?: string | null;
7714
7715
  }[];
7716
+ /** @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. */
7715
7717
  attachmentIds?: string[] | null;
7716
7718
  payment?: {
7717
7719
  bankRecordIds: string[];
@@ -8261,6 +8263,7 @@ export interface operations {
8261
8263
  matchReservationStripeGuestRef?: string | null;
8262
8264
  matchLineTypeClassification?: string | null;
8263
8265
  }[];
8266
+ /** @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. */
8264
8267
  attachmentIds?: string[] | null;
8265
8268
  payment?: {
8266
8269
  bankRecordIds: string[];
@@ -9074,6 +9077,7 @@ export interface operations {
9074
9077
  matchReservationStripeGuestRef?: string | null;
9075
9078
  matchLineTypeClassification?: string | null;
9076
9079
  }[];
9080
+ /** @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. */
9077
9081
  attachmentIds?: string[] | null;
9078
9082
  payment?: {
9079
9083
  bankRecordIds: string[];
@@ -9832,6 +9836,7 @@ export interface operations {
9832
9836
  matchReservationStripeGuestRef?: string | null;
9833
9837
  matchLineTypeClassification?: string | null;
9834
9838
  }[];
9839
+ /** @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. */
9835
9840
  attachmentIds?: string[] | null;
9836
9841
  payment?: {
9837
9842
  bankRecordIds: string[];
@@ -35053,6 +35058,7 @@ export interface operations {
35053
35058
  } | null;
35054
35059
  } | null;
35055
35060
  }[];
35061
+ /** @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. */
35056
35062
  attachmentIds?: string[] | null;
35057
35063
  recurringTemplateId?: string | null;
35058
35064
  matchBankAccountLast4?: string | null;
@@ -43591,6 +43597,7 @@ export interface operations {
43591
43597
  } | null;
43592
43598
  } | null;
43593
43599
  }[];
43600
+ /** @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. */
43594
43601
  attachmentIds?: string[] | null;
43595
43602
  recurringTemplateId?: string | null;
43596
43603
  matchBankAccountLast4?: string | null;
@@ -43858,6 +43865,7 @@ export interface operations {
43858
43865
  matchReservationStripeGuestRef?: string | null;
43859
43866
  matchLineTypeClassification?: string | null;
43860
43867
  }[];
43868
+ /** @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. */
43861
43869
  attachmentIds?: string[] | null;
43862
43870
  payment?: {
43863
43871
  bankRecordIds?: string[];
@@ -44018,6 +44026,7 @@ export interface operations {
44018
44026
  } | null;
44019
44027
  } | null;
44020
44028
  }[];
44029
+ /** @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. */
44021
44030
  attachmentIds?: string[] | null;
44022
44031
  recurringTemplateId?: string | null;
44023
44032
  matchBankAccountLast4?: string | null;
@@ -44276,6 +44285,7 @@ export interface operations {
44276
44285
  matchReservationStripeGuestRef?: string | null;
44277
44286
  matchLineTypeClassification?: string | null;
44278
44287
  }[];
44288
+ /** @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. */
44279
44289
  attachmentIds?: string[] | null;
44280
44290
  payment?: {
44281
44291
  bankRecordIds?: string[];
@@ -46964,6 +46974,7 @@ export interface operations {
46964
46974
  } | null;
46965
46975
  } | null;
46966
46976
  }[];
46977
+ /** @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. */
46967
46978
  attachmentIds?: string[] | null;
46968
46979
  recurringTemplateId?: string | null;
46969
46980
  matchBankAccountLast4?: string | null;
@@ -47444,6 +47455,7 @@ export interface operations {
47444
47455
  } | null;
47445
47456
  } | null;
47446
47457
  }[];
47458
+ /** @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. */
47447
47459
  attachmentIds?: string[] | null;
47448
47460
  recurringTemplateId?: string | null;
47449
47461
  matchBankAccountLast4?: string | null;
@@ -47677,6 +47689,7 @@ export interface operations {
47677
47689
  type?: "deposit" | "expense" | "transfer" | "payout";
47678
47690
  date?: string;
47679
47691
  currency?: string | null;
47692
+ /** @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. */
47680
47693
  attachmentIds?: string[] | null;
47681
47694
  payment?: {
47682
47695
  bankRecordIds?: string[];
@@ -47923,6 +47936,7 @@ export interface operations {
47923
47936
  } | null;
47924
47937
  } | null;
47925
47938
  }[];
47939
+ /** @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. */
47926
47940
  attachmentIds?: string[] | null;
47927
47941
  recurringTemplateId?: string | null;
47928
47942
  matchBankAccountLast4?: string | null;
@@ -48409,6 +48423,7 @@ export interface operations {
48409
48423
  } | null;
48410
48424
  } | null;
48411
48425
  }[];
48426
+ /** @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. */
48412
48427
  attachmentIds?: string[] | null;
48413
48428
  recurringTemplateId?: string | null;
48414
48429
  matchBankAccountLast4?: string | null;