increase 0.8.0 → 0.8.1

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.
Files changed (219) hide show
  1. package/CHANGELOG.md +40 -0
  2. package/README.md +8 -4
  3. package/_shims/ReadableStream.d.ts +38 -0
  4. package/_shims/ReadableStream.js +5 -0
  5. package/_shims/ReadableStream.mjs +7 -0
  6. package/_shims/ReadableStream.node.d.ts +6 -0
  7. package/_shims/ReadableStream.node.d.ts.map +1 -0
  8. package/_shims/ReadableStream.node.js +14 -0
  9. package/_shims/ReadableStream.node.js.map +1 -0
  10. package/_shims/ReadableStream.node.mjs +3 -0
  11. package/_shims/ReadableStream.node.mjs.map +1 -0
  12. package/core.d.ts +10 -0
  13. package/core.d.ts.map +1 -1
  14. package/core.js +96 -2
  15. package/core.js.map +1 -1
  16. package/core.mjs +86 -2
  17. package/core.mjs.map +1 -1
  18. package/error.d.ts +1 -0
  19. package/error.d.ts.map +1 -1
  20. package/error.js +12 -3
  21. package/error.js.map +1 -1
  22. package/error.mjs +12 -3
  23. package/error.mjs.map +1 -1
  24. package/index.d.mts +6 -1
  25. package/index.d.ts +6 -1
  26. package/index.d.ts.map +1 -1
  27. package/index.js +11 -8
  28. package/index.js.map +1 -1
  29. package/index.mjs +11 -8
  30. package/index.mjs.map +1 -1
  31. package/package.json +1 -1
  32. package/resources/account-numbers.d.ts.map +1 -1
  33. package/resources/account-statements.d.ts.map +1 -1
  34. package/resources/account-transfers.d.ts.map +1 -1
  35. package/resources/accounts.d.ts.map +1 -1
  36. package/resources/ach-prenotifications.d.ts.map +1 -1
  37. package/resources/ach-transfers.d.ts.map +1 -1
  38. package/resources/balance-lookups.d.ts.map +1 -1
  39. package/resources/bookkeeping-accounts.d.ts.map +1 -1
  40. package/resources/bookkeeping-entries.d.ts.map +1 -1
  41. package/resources/bookkeeping-entry-sets.d.ts.map +1 -1
  42. package/resources/card-disputes.d.ts.map +1 -1
  43. package/resources/card-profiles.d.ts +17 -4
  44. package/resources/card-profiles.d.ts.map +1 -1
  45. package/resources/card-profiles.js.map +1 -1
  46. package/resources/card-profiles.mjs.map +1 -1
  47. package/resources/card-purchase-supplements.d.ts +270 -0
  48. package/resources/card-purchase-supplements.d.ts.map +1 -0
  49. package/resources/card-purchase-supplements.js +28 -0
  50. package/resources/card-purchase-supplements.js.map +1 -0
  51. package/resources/card-purchase-supplements.mjs +21 -0
  52. package/resources/card-purchase-supplements.mjs.map +1 -0
  53. package/resources/cards.d.ts.map +1 -1
  54. package/resources/check-deposits.d.ts.map +1 -1
  55. package/resources/check-transfers.d.ts +3 -1
  56. package/resources/check-transfers.d.ts.map +1 -1
  57. package/resources/check-transfers.js.map +1 -1
  58. package/resources/check-transfers.mjs.map +1 -1
  59. package/resources/declined-transactions.d.ts.map +1 -1
  60. package/resources/digital-wallet-tokens.d.ts.map +1 -1
  61. package/resources/documents.d.ts.map +1 -1
  62. package/resources/entities/beneficial-owners.d.ts +219 -0
  63. package/resources/entities/beneficial-owners.d.ts.map +1 -0
  64. package/resources/entities/beneficial-owners.js +18 -0
  65. package/resources/entities/beneficial-owners.js.map +1 -0
  66. package/resources/entities/beneficial-owners.mjs +12 -0
  67. package/resources/entities/beneficial-owners.mjs.map +1 -0
  68. package/resources/entities/entities.d.ts +4 -0
  69. package/resources/entities/entities.d.ts.map +1 -1
  70. package/resources/entities/entities.js +3 -0
  71. package/resources/entities/entities.js.map +1 -1
  72. package/resources/entities/entities.mjs +3 -0
  73. package/resources/entities/entities.mjs.map +1 -1
  74. package/resources/entities/index.d.ts +1 -0
  75. package/resources/entities/index.d.ts.map +1 -1
  76. package/resources/entities/index.js +8 -0
  77. package/resources/entities/index.js.map +1 -1
  78. package/resources/entities/index.mjs +1 -0
  79. package/resources/entities/index.mjs.map +1 -1
  80. package/resources/entities/supplemental-documents.d.ts.map +1 -1
  81. package/resources/event-subscriptions.d.ts.map +1 -1
  82. package/resources/events.d.ts.map +1 -1
  83. package/resources/exports.d.ts.map +1 -1
  84. package/resources/external-accounts.d.ts.map +1 -1
  85. package/resources/files.d.ts.map +1 -1
  86. package/resources/groups.d.ts.map +1 -1
  87. package/resources/inbound-ach-transfer-returns.d.ts.map +1 -1
  88. package/resources/inbound-wire-drawdown-requests.d.ts.map +1 -1
  89. package/resources/index.d.ts +6 -0
  90. package/resources/index.d.ts.map +1 -1
  91. package/resources/index.js +18 -3
  92. package/resources/index.js.map +1 -1
  93. package/resources/index.mjs +1 -0
  94. package/resources/index.mjs.map +1 -1
  95. package/resources/limits.d.ts.map +1 -1
  96. package/resources/oauth-connections.d.ts.map +1 -1
  97. package/resources/pending-transactions.d.ts +4 -0
  98. package/resources/pending-transactions.d.ts.map +1 -1
  99. package/resources/pending-transactions.js.map +1 -1
  100. package/resources/pending-transactions.mjs.map +1 -1
  101. package/resources/programs.d.ts.map +1 -1
  102. package/resources/real-time-decisions.d.ts.map +1 -1
  103. package/resources/real-time-payments-transfers.d.ts.map +1 -1
  104. package/resources/routing-numbers.d.ts.map +1 -1
  105. package/resources/simulations/account-statements.d.ts.map +1 -1
  106. package/resources/simulations/ach-transfers.d.ts +939 -19
  107. package/resources/simulations/ach-transfers.d.ts.map +1 -1
  108. package/resources/simulations/ach-transfers.js.map +1 -1
  109. package/resources/simulations/ach-transfers.mjs.map +1 -1
  110. package/resources/simulations/card-disputes.d.ts.map +1 -1
  111. package/resources/simulations/card-refunds.d.ts.map +1 -1
  112. package/resources/simulations/cards.d.ts +4 -0
  113. package/resources/simulations/cards.d.ts.map +1 -1
  114. package/resources/simulations/cards.js.map +1 -1
  115. package/resources/simulations/cards.mjs.map +1 -1
  116. package/resources/simulations/digital-wallet-token-requests.d.ts.map +1 -1
  117. package/resources/simulations/documents.d.ts.map +1 -1
  118. package/resources/simulations/inbound-funds-holds.d.ts +4 -0
  119. package/resources/simulations/inbound-funds-holds.d.ts.map +1 -1
  120. package/resources/simulations/inbound-funds-holds.js.map +1 -1
  121. package/resources/simulations/inbound-funds-holds.mjs.map +1 -1
  122. package/resources/simulations/inbound-wire-drawdown-requests.d.ts.map +1 -1
  123. package/resources/simulations/interest-payments.d.ts +947 -19
  124. package/resources/simulations/interest-payments.d.ts.map +1 -1
  125. package/resources/simulations/interest-payments.js.map +1 -1
  126. package/resources/simulations/interest-payments.mjs.map +1 -1
  127. package/resources/simulations/programs.d.ts.map +1 -1
  128. package/resources/simulations/real-time-payments-transfers.d.ts +939 -19
  129. package/resources/simulations/real-time-payments-transfers.d.ts.map +1 -1
  130. package/resources/simulations/real-time-payments-transfers.js.map +1 -1
  131. package/resources/simulations/real-time-payments-transfers.mjs.map +1 -1
  132. package/resources/simulations/simulations.d.ts.map +1 -1
  133. package/resources/simulations/simulations.js.map +1 -1
  134. package/resources/simulations/wire-transfers.d.ts +939 -19
  135. package/resources/simulations/wire-transfers.d.ts.map +1 -1
  136. package/resources/simulations/wire-transfers.js.map +1 -1
  137. package/resources/simulations/wire-transfers.mjs.map +1 -1
  138. package/resources/transactions.d.ts +939 -20
  139. package/resources/transactions.d.ts.map +1 -1
  140. package/resources/transactions.js.map +1 -1
  141. package/resources/transactions.mjs.map +1 -1
  142. package/resources/wire-drawdown-requests.d.ts.map +1 -1
  143. package/resources/wire-transfers.d.ts.map +1 -1
  144. package/src/_shims/ReadableStream.d.ts +38 -0
  145. package/src/_shims/ReadableStream.js +5 -0
  146. package/src/_shims/ReadableStream.mjs +7 -0
  147. package/src/_shims/ReadableStream.node.ts +6 -0
  148. package/src/_shims/fetch.deno.ts +23 -0
  149. package/src/_shims/formdata.deno.ts +16 -0
  150. package/src/core.ts +103 -4
  151. package/src/error.ts +11 -1
  152. package/src/index.ts +16 -9
  153. package/src/resources/account-numbers.ts +1 -1
  154. package/src/resources/account-statements.ts +1 -1
  155. package/src/resources/account-transfers.ts +1 -1
  156. package/src/resources/accounts.ts +1 -1
  157. package/src/resources/ach-prenotifications.ts +1 -1
  158. package/src/resources/ach-transfers.ts +1 -1
  159. package/src/resources/balance-lookups.ts +1 -1
  160. package/src/resources/bookkeeping-accounts.ts +1 -1
  161. package/src/resources/bookkeeping-entries.ts +1 -1
  162. package/src/resources/bookkeeping-entry-sets.ts +1 -1
  163. package/src/resources/card-disputes.ts +1 -1
  164. package/src/resources/card-profiles.ts +19 -5
  165. package/src/resources/card-purchase-supplements.ts +331 -0
  166. package/src/resources/cards.ts +1 -1
  167. package/src/resources/check-deposits.ts +1 -1
  168. package/src/resources/check-transfers.ts +4 -2
  169. package/src/resources/declined-transactions.ts +1 -1
  170. package/src/resources/digital-wallet-tokens.ts +1 -1
  171. package/src/resources/documents.ts +1 -1
  172. package/src/resources/entities/beneficial-owners.ts +255 -0
  173. package/src/resources/entities/entities.ts +6 -1
  174. package/src/resources/entities/index.ts +1 -0
  175. package/src/resources/entities/supplemental-documents.ts +1 -1
  176. package/src/resources/event-subscriptions.ts +1 -1
  177. package/src/resources/events.ts +1 -1
  178. package/src/resources/exports.ts +1 -1
  179. package/src/resources/external-accounts.ts +1 -1
  180. package/src/resources/files.ts +1 -1
  181. package/src/resources/groups.ts +1 -1
  182. package/src/resources/inbound-ach-transfer-returns.ts +1 -1
  183. package/src/resources/inbound-wire-drawdown-requests.ts +1 -1
  184. package/src/resources/index.ts +6 -0
  185. package/src/resources/limits.ts +1 -1
  186. package/src/resources/oauth-connections.ts +1 -1
  187. package/src/resources/pending-transactions.ts +6 -1
  188. package/src/resources/programs.ts +1 -1
  189. package/src/resources/real-time-decisions.ts +1 -1
  190. package/src/resources/real-time-payments-transfers.ts +1 -1
  191. package/src/resources/routing-numbers.ts +1 -1
  192. package/src/resources/simulations/account-statements.ts +1 -1
  193. package/src/resources/simulations/ach-transfers.ts +1076 -22
  194. package/src/resources/simulations/card-disputes.ts +1 -1
  195. package/src/resources/simulations/card-refunds.ts +1 -1
  196. package/src/resources/simulations/cards.ts +6 -1
  197. package/src/resources/simulations/digital-wallet-token-requests.ts +1 -1
  198. package/src/resources/simulations/documents.ts +1 -1
  199. package/src/resources/simulations/inbound-funds-holds.ts +6 -1
  200. package/src/resources/simulations/inbound-wire-drawdown-requests.ts +1 -1
  201. package/src/resources/simulations/interest-payments.ts +1086 -22
  202. package/src/resources/simulations/programs.ts +1 -1
  203. package/src/resources/simulations/real-time-payments-transfers.ts +1076 -22
  204. package/src/resources/simulations/simulations.ts +1 -1
  205. package/src/resources/simulations/wire-transfers.ts +1076 -22
  206. package/src/resources/transactions.ts +1076 -23
  207. package/src/resources/wire-drawdown-requests.ts +1 -1
  208. package/src/resources/wire-transfers.ts +1 -1
  209. package/src/uploads.ts +7 -6
  210. package/src/version.ts +1 -1
  211. package/uploads.d.ts +5 -4
  212. package/uploads.d.ts.map +1 -1
  213. package/uploads.js +2 -2
  214. package/uploads.js.map +1 -1
  215. package/uploads.mjs +2 -2
  216. package/uploads.mjs.map +1 -1
  217. package/version.d.ts +1 -1
  218. package/version.js +1 -1
  219. package/version.mjs +1 -1
@@ -2,7 +2,7 @@
2
2
 
3
3
  import * as Core from '../../core';
4
4
  import { APIResource } from '../../resource';
5
- import * as API from '.';
5
+ import * as API from './index';
6
6
 
7
7
  export class WireTransfers extends APIResource {
8
8
  /**
@@ -200,8 +200,6 @@ export namespace WireTransferSimulation {
200
200
  * Deposit object. Details will be under the `check_transfer_deposit` object.
201
201
  * - `check_transfer_intention` - The Transaction was created by a Check Transfer
202
202
  * Intention object. Details will be under the `check_transfer_intention` object.
203
- * - `check_transfer_rejection` - The Transaction was created by a Check Transfer
204
- * Rejection object. Details will be under the `check_transfer_rejection` object.
205
203
  * - `check_transfer_stop_payment_request` - The Transaction was created by a Check
206
204
  * Transfer Stop Payment Request object. Details will be under the
207
205
  * `check_transfer_stop_payment_request` object.
@@ -258,7 +256,6 @@ export namespace WireTransferSimulation {
258
256
  | 'check_deposit_return'
259
257
  | 'check_transfer_deposit'
260
258
  | 'check_transfer_intention'
261
- | 'check_transfer_rejection'
262
259
  | 'check_transfer_stop_payment_request'
263
260
  | 'fee_payment'
264
261
  | 'inbound_ach_transfer'
@@ -302,12 +299,6 @@ export namespace WireTransferSimulation {
302
299
  */
303
300
  check_transfer_intention: Source.CheckTransferIntention | null;
304
301
 
305
- /**
306
- * A Check Transfer Rejection object. This field will be present in the JSON
307
- * response if and only if `category` is equal to `check_transfer_rejection`.
308
- */
309
- check_transfer_rejection: Source.CheckTransferRejection | null;
310
-
311
302
  /**
312
303
  * A Check Transfer Stop Payment Request object. This field will be present in the
313
304
  * JSON response if and only if `category` is equal to
@@ -820,6 +811,12 @@ export namespace WireTransferSimulation {
820
811
  */
821
812
  merchant_state: string | null;
822
813
 
814
+ /**
815
+ * Additional details about the card purchase, such as tax and industry-specific
816
+ * fields.
817
+ */
818
+ purchase_details: CardRefund.PurchaseDetails | null;
819
+
823
820
  /**
824
821
  * The identifier of the Transaction associated with this Transaction.
825
822
  */
@@ -832,6 +829,535 @@ export namespace WireTransferSimulation {
832
829
  type: 'card_refund';
833
830
  }
834
831
 
832
+ export namespace CardRefund {
833
+ /**
834
+ * Additional details about the card purchase, such as tax and industry-specific
835
+ * fields.
836
+ */
837
+ export interface PurchaseDetails {
838
+ /**
839
+ * Fields specific to car rentals.
840
+ */
841
+ car_rental: PurchaseDetails.CarRental | null;
842
+
843
+ /**
844
+ * An identifier from the merchant for the customer or consumer.
845
+ */
846
+ customer_reference_identifier: string | null;
847
+
848
+ /**
849
+ * The state or provincial tax amount in minor units.
850
+ */
851
+ local_tax_amount: number | null;
852
+
853
+ /**
854
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the local tax
855
+ * assessed.
856
+ */
857
+ local_tax_currency: string | null;
858
+
859
+ /**
860
+ * Fields specific to lodging.
861
+ */
862
+ lodging: PurchaseDetails.Lodging | null;
863
+
864
+ /**
865
+ * The national tax amount in minor units.
866
+ */
867
+ national_tax_amount: number | null;
868
+
869
+ /**
870
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the local tax
871
+ * assessed.
872
+ */
873
+ national_tax_currency: string | null;
874
+
875
+ /**
876
+ * An identifier from the merchant for the purchase to the issuer and cardholder.
877
+ */
878
+ purchase_identifier: string | null;
879
+
880
+ /**
881
+ * The format of the purchase identifier.
882
+ *
883
+ * - `free_text` - Free text
884
+ * - `order_number` - Order number
885
+ * - `rental_agreement_number` - Rental agreement number
886
+ * - `hotel_folio_number` - Hotel folio number
887
+ * - `invoice_number` - Invoice number
888
+ */
889
+ purchase_identifier_format:
890
+ | 'free_text'
891
+ | 'order_number'
892
+ | 'rental_agreement_number'
893
+ | 'hotel_folio_number'
894
+ | 'invoice_number'
895
+ | null;
896
+
897
+ /**
898
+ * Fields specific to travel.
899
+ */
900
+ travel: PurchaseDetails.Travel | null;
901
+ }
902
+
903
+ export namespace PurchaseDetails {
904
+ /**
905
+ * Fields specific to car rentals.
906
+ */
907
+ export interface CarRental {
908
+ /**
909
+ * Code indicating the vehicle's class.
910
+ */
911
+ car_class_code: string | null;
912
+
913
+ /**
914
+ * Date the customer picked up the car or, in the case of a no-show or pre-pay
915
+ * transaction, the scheduled pick up date.
916
+ */
917
+ checkout_date: string | null;
918
+
919
+ /**
920
+ * Daily rate being charged for the vehicle.
921
+ */
922
+ daily_rental_rate_amount: number | null;
923
+
924
+ /**
925
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the daily rental
926
+ * rate.
927
+ */
928
+ daily_rental_rate_currency: string | null;
929
+
930
+ /**
931
+ * Number of days the vehicle was rented.
932
+ */
933
+ days_rented: number | null;
934
+
935
+ /**
936
+ * Additional charges (gas, late fee, etc.) being billed.
937
+ *
938
+ * - `no_extra_charge` - No extra charge
939
+ * - `gas` - Gas
940
+ * - `extra_mileage` - Extra mileage
941
+ * - `late_return` - Late return
942
+ * - `one_way_service_fee` - One way service fee
943
+ * - `parking_violation` - Parking violation
944
+ */
945
+ extra_charges:
946
+ | 'no_extra_charge'
947
+ | 'gas'
948
+ | 'extra_mileage'
949
+ | 'late_return'
950
+ | 'one_way_service_fee'
951
+ | 'parking_violation'
952
+ | null;
953
+
954
+ /**
955
+ * Fuel charges for the vehicle.
956
+ */
957
+ fuel_charges_amount: number | null;
958
+
959
+ /**
960
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the fuel charges
961
+ * assessed.
962
+ */
963
+ fuel_charges_currency: string | null;
964
+
965
+ /**
966
+ * Any insurance being charged for the vehicle.
967
+ */
968
+ insurance_charges_amount: number | null;
969
+
970
+ /**
971
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the insurance
972
+ * charges assessed.
973
+ */
974
+ insurance_charges_currency: string | null;
975
+
976
+ /**
977
+ * An indicator that the cardholder is being billed for a reserved vehicle that was
978
+ * not actually rented (that is, a "no-show" charge).
979
+ *
980
+ * - `not_applicable` - Not applicable
981
+ * - `no_show_for_specialized_vehicle` - No show for specialized vehicle
982
+ */
983
+ no_show_indicator: 'not_applicable' | 'no_show_for_specialized_vehicle' | null;
984
+
985
+ /**
986
+ * Charges for returning the vehicle at a different location than where it was
987
+ * picked up.
988
+ */
989
+ one_way_drop_off_charges_amount: number | null;
990
+
991
+ /**
992
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the one-way
993
+ * drop-off charges assessed.
994
+ */
995
+ one_way_drop_off_charges_currency: string | null;
996
+
997
+ /**
998
+ * Name of the person renting the vehicle.
999
+ */
1000
+ renter_name: string | null;
1001
+
1002
+ /**
1003
+ * Weekly rate being charged for the vehicle.
1004
+ */
1005
+ weekly_rental_rate_amount: number | null;
1006
+
1007
+ /**
1008
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the weekly
1009
+ * rental rate.
1010
+ */
1011
+ weekly_rental_rate_currency: string | null;
1012
+ }
1013
+
1014
+ /**
1015
+ * Fields specific to lodging.
1016
+ */
1017
+ export interface Lodging {
1018
+ /**
1019
+ * Date the customer checked in.
1020
+ */
1021
+ check_in_date: string | null;
1022
+
1023
+ /**
1024
+ * Daily rate being charged for the room.
1025
+ */
1026
+ daily_room_rate_amount: number | null;
1027
+
1028
+ /**
1029
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the daily room
1030
+ * rate.
1031
+ */
1032
+ daily_room_rate_currency: string | null;
1033
+
1034
+ /**
1035
+ * Additional charges (phone, late check-out, etc.) being billed.
1036
+ *
1037
+ * - `no_extra_charge` - No extra charge
1038
+ * - `restaurant` - Restaurant
1039
+ * - `gift_shop` - Gift shop
1040
+ * - `mini_bar` - Mini bar
1041
+ * - `telephone` - Telephone
1042
+ * - `other` - Other
1043
+ * - `laundry` - Laundry
1044
+ */
1045
+ extra_charges:
1046
+ | 'no_extra_charge'
1047
+ | 'restaurant'
1048
+ | 'gift_shop'
1049
+ | 'mini_bar'
1050
+ | 'telephone'
1051
+ | 'other'
1052
+ | 'laundry'
1053
+ | null;
1054
+
1055
+ /**
1056
+ * Folio cash advances for the room.
1057
+ */
1058
+ folio_cash_advances_amount: number | null;
1059
+
1060
+ /**
1061
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the folio cash
1062
+ * advances.
1063
+ */
1064
+ folio_cash_advances_currency: string | null;
1065
+
1066
+ /**
1067
+ * Food and beverage charges for the room.
1068
+ */
1069
+ food_beverage_charges_amount: number | null;
1070
+
1071
+ /**
1072
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the foor and
1073
+ * beverage charges.
1074
+ */
1075
+ food_beverage_charges_currency: string | null;
1076
+
1077
+ /**
1078
+ * Indicator that the cardholder is being billed for a reserved room that was not
1079
+ * actually used.
1080
+ *
1081
+ * - `not_applicable` - Not applicable
1082
+ * - `no_show` - No show
1083
+ */
1084
+ no_show_indicator: 'not_applicable' | 'no_show' | null;
1085
+
1086
+ /**
1087
+ * Prepaid expenses being charged for the room.
1088
+ */
1089
+ prepaid_expenses_amount: number | null;
1090
+
1091
+ /**
1092
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the prepaid
1093
+ * expenses.
1094
+ */
1095
+ prepaid_expenses_currency: string | null;
1096
+
1097
+ /**
1098
+ * Number of nights the room was rented.
1099
+ */
1100
+ room_nights: number | null;
1101
+
1102
+ /**
1103
+ * Total room tax being charged.
1104
+ */
1105
+ total_room_tax_amount: number | null;
1106
+
1107
+ /**
1108
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the total room
1109
+ * tax.
1110
+ */
1111
+ total_room_tax_currency: string | null;
1112
+
1113
+ /**
1114
+ * Total tax being charged for the room.
1115
+ */
1116
+ total_tax_amount: number | null;
1117
+
1118
+ /**
1119
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the total tax
1120
+ * assessed.
1121
+ */
1122
+ total_tax_currency: string | null;
1123
+ }
1124
+
1125
+ /**
1126
+ * Fields specific to travel.
1127
+ */
1128
+ export interface Travel {
1129
+ /**
1130
+ * Ancillary purchases in addition to the airfare.
1131
+ */
1132
+ ancillary: Travel.Ancillary | null;
1133
+
1134
+ /**
1135
+ * Indicates the computerized reservation system used to book the ticket.
1136
+ */
1137
+ computerized_reservation_system: string | null;
1138
+
1139
+ /**
1140
+ * Indicates the reason for a credit to the cardholder.
1141
+ *
1142
+ * - `no_credit` - No credit
1143
+ * - `passenger_transport_ancillary_purchase_cancellation` - Passenger transport
1144
+ * ancillary purchase cancellation
1145
+ * - `airline_ticket_and_passenger_transport_ancillary_purchase_cancellation` -
1146
+ * Airline ticket and passenger transport ancillary purchase cancellation
1147
+ * - `airline_ticket_cancellation` - Airline ticket cancellation
1148
+ * - `other` - Other
1149
+ * - `partial_refund_of_airline_ticket` - Partial refund of airline ticket
1150
+ */
1151
+ credit_reason_indicator:
1152
+ | 'no_credit'
1153
+ | 'passenger_transport_ancillary_purchase_cancellation'
1154
+ | 'airline_ticket_and_passenger_transport_ancillary_purchase_cancellation'
1155
+ | 'airline_ticket_cancellation'
1156
+ | 'other'
1157
+ | 'partial_refund_of_airline_ticket'
1158
+ | null;
1159
+
1160
+ /**
1161
+ * Date of departure.
1162
+ */
1163
+ departure_date: string | null;
1164
+
1165
+ /**
1166
+ * Code for the originating city or airport.
1167
+ */
1168
+ origination_city_airport_code: string | null;
1169
+
1170
+ /**
1171
+ * Name of the passenger.
1172
+ */
1173
+ passenger_name: string | null;
1174
+
1175
+ /**
1176
+ * Indicates whether this ticket is non-refundable.
1177
+ *
1178
+ * - `no_restrictions` - No restrictions
1179
+ * - `restricted_non_refundable_ticket` - Restricted non-refundable ticket
1180
+ */
1181
+ restricted_ticket_indicator: 'no_restrictions' | 'restricted_non_refundable_ticket' | null;
1182
+
1183
+ /**
1184
+ * Indicates why a ticket was changed.
1185
+ *
1186
+ * - `none` - None
1187
+ * - `change_to_existing_ticket` - Change to existing ticket
1188
+ * - `new_ticket` - New ticket
1189
+ */
1190
+ ticket_change_indicator: 'none' | 'change_to_existing_ticket' | 'new_ticket' | null;
1191
+
1192
+ /**
1193
+ * Ticket number.
1194
+ */
1195
+ ticket_number: string | null;
1196
+
1197
+ /**
1198
+ * Code for the travel agency if the ticket was issued by a travel agency.
1199
+ */
1200
+ travel_agency_code: string | null;
1201
+
1202
+ /**
1203
+ * Name of the travel agency if the ticket was issued by a travel agency.
1204
+ */
1205
+ travel_agency_name: string | null;
1206
+
1207
+ /**
1208
+ * Fields specific to each leg of the journey.
1209
+ */
1210
+ trip_legs: Array<Travel.TripLeg> | null;
1211
+ }
1212
+
1213
+ export namespace Travel {
1214
+ /**
1215
+ * Ancillary purchases in addition to the airfare.
1216
+ */
1217
+ export interface Ancillary {
1218
+ /**
1219
+ * If this purchase has a connection or relationship to another purchase, such as a
1220
+ * baggage fee for a passenger transport ticket, this field should contain the
1221
+ * ticket document number for the other purchase.
1222
+ */
1223
+ connected_ticket_document_number: string | null;
1224
+
1225
+ /**
1226
+ * Indicates the reason for a credit to the cardholder.
1227
+ *
1228
+ * - `no_credit` - No credit
1229
+ * - `passenger_transport_ancillary_purchase_cancellation` - Passenger transport
1230
+ * ancillary purchase cancellation
1231
+ * - `airline_ticket_and_passenger_transport_ancillary_purchase_cancellation` -
1232
+ * Airline ticket and passenger transport ancillary purchase cancellation
1233
+ * - `other` - Other
1234
+ */
1235
+ credit_reason_indicator:
1236
+ | 'no_credit'
1237
+ | 'passenger_transport_ancillary_purchase_cancellation'
1238
+ | 'airline_ticket_and_passenger_transport_ancillary_purchase_cancellation'
1239
+ | 'other'
1240
+ | null;
1241
+
1242
+ /**
1243
+ * Name of the passenger or description of the ancillary purchase.
1244
+ */
1245
+ passenger_name_or_description: string | null;
1246
+
1247
+ /**
1248
+ * Additional travel charges, such as baggage fees.
1249
+ */
1250
+ services: Array<Ancillary.Service>;
1251
+
1252
+ /**
1253
+ * Ticket document number.
1254
+ */
1255
+ ticket_document_number: string | null;
1256
+ }
1257
+
1258
+ export namespace Ancillary {
1259
+ export interface Service {
1260
+ /**
1261
+ * Category of the ancillary service.
1262
+ *
1263
+ * - `none` - None
1264
+ * - `bundled_service` - Bundled service
1265
+ * - `baggage_fee` - Baggage fee
1266
+ * - `change_fee` - Change fee
1267
+ * - `cargo` - Cargo
1268
+ * - `carbon_offset` - Carbon offset
1269
+ * - `frequent_flyer` - Frequent flyer
1270
+ * - `gift_card` - Gift card
1271
+ * - `ground_transport` - Ground transport
1272
+ * - `in_flight_entertainment` - In-flight entertainment
1273
+ * - `lounge` - Lounge
1274
+ * - `medical` - Medical
1275
+ * - `meal_beverage` - Meal beverage
1276
+ * - `other` - Other
1277
+ * - `passenger_assist_fee` - Passenger assist fee
1278
+ * - `pets` - Pets
1279
+ * - `seat_fees` - Seat fees
1280
+ * - `standby` - Standby
1281
+ * - `service_fee` - Service fee
1282
+ * - `store` - Store
1283
+ * - `travel_service` - Travel service
1284
+ * - `unaccompanied_travel` - Unaccompanied travel
1285
+ * - `upgrades` - Upgrades
1286
+ * - `wifi` - Wi-fi
1287
+ */
1288
+ category:
1289
+ | 'none'
1290
+ | 'bundled_service'
1291
+ | 'baggage_fee'
1292
+ | 'change_fee'
1293
+ | 'cargo'
1294
+ | 'carbon_offset'
1295
+ | 'frequent_flyer'
1296
+ | 'gift_card'
1297
+ | 'ground_transport'
1298
+ | 'in_flight_entertainment'
1299
+ | 'lounge'
1300
+ | 'medical'
1301
+ | 'meal_beverage'
1302
+ | 'other'
1303
+ | 'passenger_assist_fee'
1304
+ | 'pets'
1305
+ | 'seat_fees'
1306
+ | 'standby'
1307
+ | 'service_fee'
1308
+ | 'store'
1309
+ | 'travel_service'
1310
+ | 'unaccompanied_travel'
1311
+ | 'upgrades'
1312
+ | 'wifi'
1313
+ | null;
1314
+
1315
+ /**
1316
+ * Sub-category of the ancillary service, free-form.
1317
+ */
1318
+ sub_category: string | null;
1319
+ }
1320
+ }
1321
+
1322
+ export interface TripLeg {
1323
+ /**
1324
+ * Carrier code (e.g., United Airlines, Jet Blue, etc.).
1325
+ */
1326
+ carrier_code: string | null;
1327
+
1328
+ /**
1329
+ * Code for the destination city or airport.
1330
+ */
1331
+ destination_city_airport_code: string | null;
1332
+
1333
+ /**
1334
+ * Fare basis code.
1335
+ */
1336
+ fare_basis_code: string | null;
1337
+
1338
+ /**
1339
+ * Flight number.
1340
+ */
1341
+ flight_number: string | null;
1342
+
1343
+ /**
1344
+ * Service class (e.g., first class, business class, etc.).
1345
+ */
1346
+ service_class: string | null;
1347
+
1348
+ /**
1349
+ * Indicates whether a stopover is allowed on this ticket.
1350
+ *
1351
+ * - `none` - None
1352
+ * - `stop_over_allowed` - Stop over allowed
1353
+ * - `stop_over_not_allowed` - Stop over not allowed
1354
+ */
1355
+ stop_over_code: 'none' | 'stop_over_allowed' | 'stop_over_not_allowed' | null;
1356
+ }
1357
+ }
1358
+ }
1359
+ }
1360
+
835
1361
  /**
836
1362
  * A Card Revenue Payment object. This field will be present in the JSON response
837
1363
  * if and only if `category` is equal to `card_revenue_payment`.
@@ -954,6 +1480,12 @@ export namespace WireTransferSimulation {
954
1480
  */
955
1481
  presentment_currency: string;
956
1482
 
1483
+ /**
1484
+ * Additional details about the card purchase, such as tax and industry-specific
1485
+ * fields.
1486
+ */
1487
+ purchase_details: CardSettlement.PurchaseDetails | null;
1488
+
957
1489
  /**
958
1490
  * The identifier of the Transaction associated with this Transaction.
959
1491
  */
@@ -966,6 +1498,535 @@ export namespace WireTransferSimulation {
966
1498
  type: 'card_settlement';
967
1499
  }
968
1500
 
1501
+ export namespace CardSettlement {
1502
+ /**
1503
+ * Additional details about the card purchase, such as tax and industry-specific
1504
+ * fields.
1505
+ */
1506
+ export interface PurchaseDetails {
1507
+ /**
1508
+ * Fields specific to car rentals.
1509
+ */
1510
+ car_rental: PurchaseDetails.CarRental | null;
1511
+
1512
+ /**
1513
+ * An identifier from the merchant for the customer or consumer.
1514
+ */
1515
+ customer_reference_identifier: string | null;
1516
+
1517
+ /**
1518
+ * The state or provincial tax amount in minor units.
1519
+ */
1520
+ local_tax_amount: number | null;
1521
+
1522
+ /**
1523
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the local tax
1524
+ * assessed.
1525
+ */
1526
+ local_tax_currency: string | null;
1527
+
1528
+ /**
1529
+ * Fields specific to lodging.
1530
+ */
1531
+ lodging: PurchaseDetails.Lodging | null;
1532
+
1533
+ /**
1534
+ * The national tax amount in minor units.
1535
+ */
1536
+ national_tax_amount: number | null;
1537
+
1538
+ /**
1539
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the local tax
1540
+ * assessed.
1541
+ */
1542
+ national_tax_currency: string | null;
1543
+
1544
+ /**
1545
+ * An identifier from the merchant for the purchase to the issuer and cardholder.
1546
+ */
1547
+ purchase_identifier: string | null;
1548
+
1549
+ /**
1550
+ * The format of the purchase identifier.
1551
+ *
1552
+ * - `free_text` - Free text
1553
+ * - `order_number` - Order number
1554
+ * - `rental_agreement_number` - Rental agreement number
1555
+ * - `hotel_folio_number` - Hotel folio number
1556
+ * - `invoice_number` - Invoice number
1557
+ */
1558
+ purchase_identifier_format:
1559
+ | 'free_text'
1560
+ | 'order_number'
1561
+ | 'rental_agreement_number'
1562
+ | 'hotel_folio_number'
1563
+ | 'invoice_number'
1564
+ | null;
1565
+
1566
+ /**
1567
+ * Fields specific to travel.
1568
+ */
1569
+ travel: PurchaseDetails.Travel | null;
1570
+ }
1571
+
1572
+ export namespace PurchaseDetails {
1573
+ /**
1574
+ * Fields specific to car rentals.
1575
+ */
1576
+ export interface CarRental {
1577
+ /**
1578
+ * Code indicating the vehicle's class.
1579
+ */
1580
+ car_class_code: string | null;
1581
+
1582
+ /**
1583
+ * Date the customer picked up the car or, in the case of a no-show or pre-pay
1584
+ * transaction, the scheduled pick up date.
1585
+ */
1586
+ checkout_date: string | null;
1587
+
1588
+ /**
1589
+ * Daily rate being charged for the vehicle.
1590
+ */
1591
+ daily_rental_rate_amount: number | null;
1592
+
1593
+ /**
1594
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the daily rental
1595
+ * rate.
1596
+ */
1597
+ daily_rental_rate_currency: string | null;
1598
+
1599
+ /**
1600
+ * Number of days the vehicle was rented.
1601
+ */
1602
+ days_rented: number | null;
1603
+
1604
+ /**
1605
+ * Additional charges (gas, late fee, etc.) being billed.
1606
+ *
1607
+ * - `no_extra_charge` - No extra charge
1608
+ * - `gas` - Gas
1609
+ * - `extra_mileage` - Extra mileage
1610
+ * - `late_return` - Late return
1611
+ * - `one_way_service_fee` - One way service fee
1612
+ * - `parking_violation` - Parking violation
1613
+ */
1614
+ extra_charges:
1615
+ | 'no_extra_charge'
1616
+ | 'gas'
1617
+ | 'extra_mileage'
1618
+ | 'late_return'
1619
+ | 'one_way_service_fee'
1620
+ | 'parking_violation'
1621
+ | null;
1622
+
1623
+ /**
1624
+ * Fuel charges for the vehicle.
1625
+ */
1626
+ fuel_charges_amount: number | null;
1627
+
1628
+ /**
1629
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the fuel charges
1630
+ * assessed.
1631
+ */
1632
+ fuel_charges_currency: string | null;
1633
+
1634
+ /**
1635
+ * Any insurance being charged for the vehicle.
1636
+ */
1637
+ insurance_charges_amount: number | null;
1638
+
1639
+ /**
1640
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the insurance
1641
+ * charges assessed.
1642
+ */
1643
+ insurance_charges_currency: string | null;
1644
+
1645
+ /**
1646
+ * An indicator that the cardholder is being billed for a reserved vehicle that was
1647
+ * not actually rented (that is, a "no-show" charge).
1648
+ *
1649
+ * - `not_applicable` - Not applicable
1650
+ * - `no_show_for_specialized_vehicle` - No show for specialized vehicle
1651
+ */
1652
+ no_show_indicator: 'not_applicable' | 'no_show_for_specialized_vehicle' | null;
1653
+
1654
+ /**
1655
+ * Charges for returning the vehicle at a different location than where it was
1656
+ * picked up.
1657
+ */
1658
+ one_way_drop_off_charges_amount: number | null;
1659
+
1660
+ /**
1661
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the one-way
1662
+ * drop-off charges assessed.
1663
+ */
1664
+ one_way_drop_off_charges_currency: string | null;
1665
+
1666
+ /**
1667
+ * Name of the person renting the vehicle.
1668
+ */
1669
+ renter_name: string | null;
1670
+
1671
+ /**
1672
+ * Weekly rate being charged for the vehicle.
1673
+ */
1674
+ weekly_rental_rate_amount: number | null;
1675
+
1676
+ /**
1677
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the weekly
1678
+ * rental rate.
1679
+ */
1680
+ weekly_rental_rate_currency: string | null;
1681
+ }
1682
+
1683
+ /**
1684
+ * Fields specific to lodging.
1685
+ */
1686
+ export interface Lodging {
1687
+ /**
1688
+ * Date the customer checked in.
1689
+ */
1690
+ check_in_date: string | null;
1691
+
1692
+ /**
1693
+ * Daily rate being charged for the room.
1694
+ */
1695
+ daily_room_rate_amount: number | null;
1696
+
1697
+ /**
1698
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the daily room
1699
+ * rate.
1700
+ */
1701
+ daily_room_rate_currency: string | null;
1702
+
1703
+ /**
1704
+ * Additional charges (phone, late check-out, etc.) being billed.
1705
+ *
1706
+ * - `no_extra_charge` - No extra charge
1707
+ * - `restaurant` - Restaurant
1708
+ * - `gift_shop` - Gift shop
1709
+ * - `mini_bar` - Mini bar
1710
+ * - `telephone` - Telephone
1711
+ * - `other` - Other
1712
+ * - `laundry` - Laundry
1713
+ */
1714
+ extra_charges:
1715
+ | 'no_extra_charge'
1716
+ | 'restaurant'
1717
+ | 'gift_shop'
1718
+ | 'mini_bar'
1719
+ | 'telephone'
1720
+ | 'other'
1721
+ | 'laundry'
1722
+ | null;
1723
+
1724
+ /**
1725
+ * Folio cash advances for the room.
1726
+ */
1727
+ folio_cash_advances_amount: number | null;
1728
+
1729
+ /**
1730
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the folio cash
1731
+ * advances.
1732
+ */
1733
+ folio_cash_advances_currency: string | null;
1734
+
1735
+ /**
1736
+ * Food and beverage charges for the room.
1737
+ */
1738
+ food_beverage_charges_amount: number | null;
1739
+
1740
+ /**
1741
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the foor and
1742
+ * beverage charges.
1743
+ */
1744
+ food_beverage_charges_currency: string | null;
1745
+
1746
+ /**
1747
+ * Indicator that the cardholder is being billed for a reserved room that was not
1748
+ * actually used.
1749
+ *
1750
+ * - `not_applicable` - Not applicable
1751
+ * - `no_show` - No show
1752
+ */
1753
+ no_show_indicator: 'not_applicable' | 'no_show' | null;
1754
+
1755
+ /**
1756
+ * Prepaid expenses being charged for the room.
1757
+ */
1758
+ prepaid_expenses_amount: number | null;
1759
+
1760
+ /**
1761
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the prepaid
1762
+ * expenses.
1763
+ */
1764
+ prepaid_expenses_currency: string | null;
1765
+
1766
+ /**
1767
+ * Number of nights the room was rented.
1768
+ */
1769
+ room_nights: number | null;
1770
+
1771
+ /**
1772
+ * Total room tax being charged.
1773
+ */
1774
+ total_room_tax_amount: number | null;
1775
+
1776
+ /**
1777
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the total room
1778
+ * tax.
1779
+ */
1780
+ total_room_tax_currency: string | null;
1781
+
1782
+ /**
1783
+ * Total tax being charged for the room.
1784
+ */
1785
+ total_tax_amount: number | null;
1786
+
1787
+ /**
1788
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the total tax
1789
+ * assessed.
1790
+ */
1791
+ total_tax_currency: string | null;
1792
+ }
1793
+
1794
+ /**
1795
+ * Fields specific to travel.
1796
+ */
1797
+ export interface Travel {
1798
+ /**
1799
+ * Ancillary purchases in addition to the airfare.
1800
+ */
1801
+ ancillary: Travel.Ancillary | null;
1802
+
1803
+ /**
1804
+ * Indicates the computerized reservation system used to book the ticket.
1805
+ */
1806
+ computerized_reservation_system: string | null;
1807
+
1808
+ /**
1809
+ * Indicates the reason for a credit to the cardholder.
1810
+ *
1811
+ * - `no_credit` - No credit
1812
+ * - `passenger_transport_ancillary_purchase_cancellation` - Passenger transport
1813
+ * ancillary purchase cancellation
1814
+ * - `airline_ticket_and_passenger_transport_ancillary_purchase_cancellation` -
1815
+ * Airline ticket and passenger transport ancillary purchase cancellation
1816
+ * - `airline_ticket_cancellation` - Airline ticket cancellation
1817
+ * - `other` - Other
1818
+ * - `partial_refund_of_airline_ticket` - Partial refund of airline ticket
1819
+ */
1820
+ credit_reason_indicator:
1821
+ | 'no_credit'
1822
+ | 'passenger_transport_ancillary_purchase_cancellation'
1823
+ | 'airline_ticket_and_passenger_transport_ancillary_purchase_cancellation'
1824
+ | 'airline_ticket_cancellation'
1825
+ | 'other'
1826
+ | 'partial_refund_of_airline_ticket'
1827
+ | null;
1828
+
1829
+ /**
1830
+ * Date of departure.
1831
+ */
1832
+ departure_date: string | null;
1833
+
1834
+ /**
1835
+ * Code for the originating city or airport.
1836
+ */
1837
+ origination_city_airport_code: string | null;
1838
+
1839
+ /**
1840
+ * Name of the passenger.
1841
+ */
1842
+ passenger_name: string | null;
1843
+
1844
+ /**
1845
+ * Indicates whether this ticket is non-refundable.
1846
+ *
1847
+ * - `no_restrictions` - No restrictions
1848
+ * - `restricted_non_refundable_ticket` - Restricted non-refundable ticket
1849
+ */
1850
+ restricted_ticket_indicator: 'no_restrictions' | 'restricted_non_refundable_ticket' | null;
1851
+
1852
+ /**
1853
+ * Indicates why a ticket was changed.
1854
+ *
1855
+ * - `none` - None
1856
+ * - `change_to_existing_ticket` - Change to existing ticket
1857
+ * - `new_ticket` - New ticket
1858
+ */
1859
+ ticket_change_indicator: 'none' | 'change_to_existing_ticket' | 'new_ticket' | null;
1860
+
1861
+ /**
1862
+ * Ticket number.
1863
+ */
1864
+ ticket_number: string | null;
1865
+
1866
+ /**
1867
+ * Code for the travel agency if the ticket was issued by a travel agency.
1868
+ */
1869
+ travel_agency_code: string | null;
1870
+
1871
+ /**
1872
+ * Name of the travel agency if the ticket was issued by a travel agency.
1873
+ */
1874
+ travel_agency_name: string | null;
1875
+
1876
+ /**
1877
+ * Fields specific to each leg of the journey.
1878
+ */
1879
+ trip_legs: Array<Travel.TripLeg> | null;
1880
+ }
1881
+
1882
+ export namespace Travel {
1883
+ /**
1884
+ * Ancillary purchases in addition to the airfare.
1885
+ */
1886
+ export interface Ancillary {
1887
+ /**
1888
+ * If this purchase has a connection or relationship to another purchase, such as a
1889
+ * baggage fee for a passenger transport ticket, this field should contain the
1890
+ * ticket document number for the other purchase.
1891
+ */
1892
+ connected_ticket_document_number: string | null;
1893
+
1894
+ /**
1895
+ * Indicates the reason for a credit to the cardholder.
1896
+ *
1897
+ * - `no_credit` - No credit
1898
+ * - `passenger_transport_ancillary_purchase_cancellation` - Passenger transport
1899
+ * ancillary purchase cancellation
1900
+ * - `airline_ticket_and_passenger_transport_ancillary_purchase_cancellation` -
1901
+ * Airline ticket and passenger transport ancillary purchase cancellation
1902
+ * - `other` - Other
1903
+ */
1904
+ credit_reason_indicator:
1905
+ | 'no_credit'
1906
+ | 'passenger_transport_ancillary_purchase_cancellation'
1907
+ | 'airline_ticket_and_passenger_transport_ancillary_purchase_cancellation'
1908
+ | 'other'
1909
+ | null;
1910
+
1911
+ /**
1912
+ * Name of the passenger or description of the ancillary purchase.
1913
+ */
1914
+ passenger_name_or_description: string | null;
1915
+
1916
+ /**
1917
+ * Additional travel charges, such as baggage fees.
1918
+ */
1919
+ services: Array<Ancillary.Service>;
1920
+
1921
+ /**
1922
+ * Ticket document number.
1923
+ */
1924
+ ticket_document_number: string | null;
1925
+ }
1926
+
1927
+ export namespace Ancillary {
1928
+ export interface Service {
1929
+ /**
1930
+ * Category of the ancillary service.
1931
+ *
1932
+ * - `none` - None
1933
+ * - `bundled_service` - Bundled service
1934
+ * - `baggage_fee` - Baggage fee
1935
+ * - `change_fee` - Change fee
1936
+ * - `cargo` - Cargo
1937
+ * - `carbon_offset` - Carbon offset
1938
+ * - `frequent_flyer` - Frequent flyer
1939
+ * - `gift_card` - Gift card
1940
+ * - `ground_transport` - Ground transport
1941
+ * - `in_flight_entertainment` - In-flight entertainment
1942
+ * - `lounge` - Lounge
1943
+ * - `medical` - Medical
1944
+ * - `meal_beverage` - Meal beverage
1945
+ * - `other` - Other
1946
+ * - `passenger_assist_fee` - Passenger assist fee
1947
+ * - `pets` - Pets
1948
+ * - `seat_fees` - Seat fees
1949
+ * - `standby` - Standby
1950
+ * - `service_fee` - Service fee
1951
+ * - `store` - Store
1952
+ * - `travel_service` - Travel service
1953
+ * - `unaccompanied_travel` - Unaccompanied travel
1954
+ * - `upgrades` - Upgrades
1955
+ * - `wifi` - Wi-fi
1956
+ */
1957
+ category:
1958
+ | 'none'
1959
+ | 'bundled_service'
1960
+ | 'baggage_fee'
1961
+ | 'change_fee'
1962
+ | 'cargo'
1963
+ | 'carbon_offset'
1964
+ | 'frequent_flyer'
1965
+ | 'gift_card'
1966
+ | 'ground_transport'
1967
+ | 'in_flight_entertainment'
1968
+ | 'lounge'
1969
+ | 'medical'
1970
+ | 'meal_beverage'
1971
+ | 'other'
1972
+ | 'passenger_assist_fee'
1973
+ | 'pets'
1974
+ | 'seat_fees'
1975
+ | 'standby'
1976
+ | 'service_fee'
1977
+ | 'store'
1978
+ | 'travel_service'
1979
+ | 'unaccompanied_travel'
1980
+ | 'upgrades'
1981
+ | 'wifi'
1982
+ | null;
1983
+
1984
+ /**
1985
+ * Sub-category of the ancillary service, free-form.
1986
+ */
1987
+ sub_category: string | null;
1988
+ }
1989
+ }
1990
+
1991
+ export interface TripLeg {
1992
+ /**
1993
+ * Carrier code (e.g., United Airlines, Jet Blue, etc.).
1994
+ */
1995
+ carrier_code: string | null;
1996
+
1997
+ /**
1998
+ * Code for the destination city or airport.
1999
+ */
2000
+ destination_city_airport_code: string | null;
2001
+
2002
+ /**
2003
+ * Fare basis code.
2004
+ */
2005
+ fare_basis_code: string | null;
2006
+
2007
+ /**
2008
+ * Flight number.
2009
+ */
2010
+ flight_number: string | null;
2011
+
2012
+ /**
2013
+ * Service class (e.g., first class, business class, etc.).
2014
+ */
2015
+ service_class: string | null;
2016
+
2017
+ /**
2018
+ * Indicates whether a stopover is allowed on this ticket.
2019
+ *
2020
+ * - `none` - None
2021
+ * - `stop_over_allowed` - Stop over allowed
2022
+ * - `stop_over_not_allowed` - Stop over not allowed
2023
+ */
2024
+ stop_over_code: 'none' | 'stop_over_allowed' | 'stop_over_not_allowed' | null;
2025
+ }
2026
+ }
2027
+ }
2028
+ }
2029
+
969
2030
  /**
970
2031
  * A Check Deposit Acceptance object. This field will be present in the JSON
971
2032
  * response if and only if `category` is equal to `check_deposit_acceptance`.
@@ -1181,17 +2242,6 @@ export namespace WireTransferSimulation {
1181
2242
  transfer_id: string;
1182
2243
  }
1183
2244
 
1184
- /**
1185
- * A Check Transfer Rejection object. This field will be present in the JSON
1186
- * response if and only if `category` is equal to `check_transfer_rejection`.
1187
- */
1188
- export interface CheckTransferRejection {
1189
- /**
1190
- * The identifier of the Check Transfer that led to this Transaction.
1191
- */
1192
- transfer_id: string;
1193
- }
1194
-
1195
2245
  /**
1196
2246
  * A Check Transfer Stop Payment Request object. This field will be present in the
1197
2247
  * JSON response if and only if `category` is equal to
@@ -1202,9 +2252,11 @@ export namespace WireTransferSimulation {
1202
2252
  * The reason why this transfer was stopped.
1203
2253
  *
1204
2254
  * - `mail_delivery_failed` - The check could not be delivered.
2255
+ * - `rejected_by_increase` - The check was cancelled by an Increase operator who
2256
+ * will provide details out-of-band.
1205
2257
  * - `unknown` - The check was stopped for another reason.
1206
2258
  */
1207
- reason: 'mail_delivery_failed' | 'unknown';
2259
+ reason: 'mail_delivery_failed' | 'rejected_by_increase' | 'unknown';
1208
2260
 
1209
2261
  /**
1210
2262
  * The time the stop-payment was requested.
@@ -1739,6 +2791,7 @@ export namespace WireTransferSimulation {
1739
2791
  * - `account_closure` - Account closure
1740
2792
  * - `bank_migration` - Bank migration
1741
2793
  * - `cashback` - Cashback
2794
+ * - `check_adjustment` - Check adjustment
1742
2795
  * - `collection_receivable` - Collection receivable
1743
2796
  * - `empyreal_adjustment` - Empyreal adjustment
1744
2797
  * - `error` - Error
@@ -1753,6 +2806,7 @@ export namespace WireTransferSimulation {
1753
2806
  | 'account_closure'
1754
2807
  | 'bank_migration'
1755
2808
  | 'cashback'
2809
+ | 'check_adjustment'
1756
2810
  | 'collection_receivable'
1757
2811
  | 'empyreal_adjustment'
1758
2812
  | 'error'