@enfuce/nextgen-sdk 0.0.1 → 0.0.3

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 (222) hide show
  1. package/README.md +44 -0
  2. package/dist/authorisation-control/api.d.ts +0 -302
  3. package/dist/authorisation-control/api.js +10 -28
  4. package/dist/authorisation-control/base.d.ts +0 -24
  5. package/dist/authorisation-control/base.js +0 -19
  6. package/dist/authorisation-control/common.d.ts +4 -35
  7. package/dist/authorisation-control/common.js +16 -38
  8. package/dist/authorisation-control/configuration.d.ts +24 -17
  9. package/dist/authorisation-control/configuration.js +3 -3
  10. package/dist/card/api.d.ts +41 -740
  11. package/dist/card/api.js +38 -105
  12. package/dist/card/base.d.ts +0 -24
  13. package/dist/card/base.js +0 -19
  14. package/dist/card/common.d.ts +4 -35
  15. package/dist/card/common.js +16 -38
  16. package/dist/card/configuration.d.ts +24 -17
  17. package/dist/card/configuration.js +3 -3
  18. package/dist/cardholder/api.d.ts +959 -686
  19. package/dist/cardholder/api.js +783 -73
  20. package/dist/cardholder/base.d.ts +0 -24
  21. package/dist/cardholder/base.js +0 -19
  22. package/dist/cardholder/common.d.ts +4 -35
  23. package/dist/cardholder/common.js +16 -38
  24. package/dist/cardholder/configuration.d.ts +24 -17
  25. package/dist/cardholder/configuration.js +3 -3
  26. package/dist/cards/api.d.ts +0 -7
  27. package/dist/cards/api.js +2 -9
  28. package/dist/cards/base.d.ts +0 -24
  29. package/dist/cards/base.js +0 -19
  30. package/dist/cards/common.d.ts +4 -35
  31. package/dist/cards/common.js +16 -38
  32. package/dist/cards/configuration.d.ts +24 -17
  33. package/dist/cards/configuration.js +3 -3
  34. package/dist/clearing-file-copy/api.d.ts +0 -497
  35. package/dist/clearing-file-copy/api.js +12 -26
  36. package/dist/clearing-file-copy/base.d.ts +0 -24
  37. package/dist/clearing-file-copy/base.js +0 -19
  38. package/dist/clearing-file-copy/common.d.ts +4 -35
  39. package/dist/clearing-file-copy/common.js +16 -38
  40. package/dist/clearing-file-copy/configuration.d.ts +24 -17
  41. package/dist/clearing-file-copy/configuration.js +3 -3
  42. package/dist/esm/authorisation-control/api.d.ts +0 -302
  43. package/dist/esm/authorisation-control/api.js +10 -28
  44. package/dist/esm/authorisation-control/base.d.ts +0 -24
  45. package/dist/esm/authorisation-control/base.js +0 -19
  46. package/dist/esm/authorisation-control/common.d.ts +4 -35
  47. package/dist/esm/authorisation-control/common.js +14 -37
  48. package/dist/esm/authorisation-control/configuration.d.ts +24 -17
  49. package/dist/esm/authorisation-control/configuration.js +3 -3
  50. package/dist/esm/card/api.d.ts +41 -740
  51. package/dist/esm/card/api.js +38 -105
  52. package/dist/esm/card/base.d.ts +0 -24
  53. package/dist/esm/card/base.js +0 -19
  54. package/dist/esm/card/common.d.ts +4 -35
  55. package/dist/esm/card/common.js +14 -37
  56. package/dist/esm/card/configuration.d.ts +24 -17
  57. package/dist/esm/card/configuration.js +3 -3
  58. package/dist/esm/cardholder/api.d.ts +959 -686
  59. package/dist/esm/cardholder/api.js +782 -72
  60. package/dist/esm/cardholder/base.d.ts +0 -24
  61. package/dist/esm/cardholder/base.js +0 -19
  62. package/dist/esm/cardholder/common.d.ts +4 -35
  63. package/dist/esm/cardholder/common.js +14 -37
  64. package/dist/esm/cardholder/configuration.d.ts +24 -17
  65. package/dist/esm/cardholder/configuration.js +3 -3
  66. package/dist/esm/cards/api.d.ts +0 -7
  67. package/dist/esm/cards/api.js +2 -9
  68. package/dist/esm/cards/base.d.ts +0 -24
  69. package/dist/esm/cards/base.js +0 -19
  70. package/dist/esm/cards/common.d.ts +4 -35
  71. package/dist/esm/cards/common.js +14 -37
  72. package/dist/esm/cards/configuration.d.ts +24 -17
  73. package/dist/esm/cards/configuration.js +3 -3
  74. package/dist/esm/clearing-file-copy/api.d.ts +0 -497
  75. package/dist/esm/clearing-file-copy/api.js +12 -26
  76. package/dist/esm/clearing-file-copy/base.d.ts +0 -24
  77. package/dist/esm/clearing-file-copy/base.js +0 -19
  78. package/dist/esm/clearing-file-copy/common.d.ts +4 -35
  79. package/dist/esm/clearing-file-copy/common.js +14 -37
  80. package/dist/esm/clearing-file-copy/configuration.d.ts +24 -17
  81. package/dist/esm/clearing-file-copy/configuration.js +3 -3
  82. package/dist/esm/issuer-events/api.d.ts +639 -601
  83. package/dist/esm/issuer-events/api.js +520 -54
  84. package/dist/esm/issuer-events/base.d.ts +0 -24
  85. package/dist/esm/issuer-events/base.js +0 -19
  86. package/dist/esm/issuer-events/common.d.ts +4 -35
  87. package/dist/esm/issuer-events/common.js +14 -37
  88. package/dist/esm/issuer-events/configuration.d.ts +24 -17
  89. package/dist/esm/issuer-events/configuration.js +3 -3
  90. package/dist/esm/pin/api.d.ts +0 -76
  91. package/dist/esm/pin/api.js +3 -15
  92. package/dist/esm/pin/base.d.ts +0 -24
  93. package/dist/esm/pin/base.js +0 -19
  94. package/dist/esm/pin/common.d.ts +4 -35
  95. package/dist/esm/pin/common.js +14 -37
  96. package/dist/esm/pin/configuration.d.ts +24 -17
  97. package/dist/esm/pin/configuration.js +3 -3
  98. package/dist/esm/threeds/api.d.ts +0 -18
  99. package/dist/esm/threeds/api.js +1 -8
  100. package/dist/esm/threeds/base.d.ts +0 -24
  101. package/dist/esm/threeds/base.js +0 -19
  102. package/dist/esm/threeds/common.d.ts +4 -35
  103. package/dist/esm/threeds/common.js +14 -37
  104. package/dist/esm/threeds/configuration.d.ts +24 -17
  105. package/dist/esm/threeds/configuration.js +3 -3
  106. package/dist/esm/threeds-oob/api.d.ts +0 -90
  107. package/dist/esm/threeds-oob/api.js +2 -9
  108. package/dist/esm/threeds-oob/base.d.ts +0 -24
  109. package/dist/esm/threeds-oob/base.js +0 -19
  110. package/dist/esm/threeds-oob/common.d.ts +4 -35
  111. package/dist/esm/threeds-oob/common.js +14 -37
  112. package/dist/esm/threeds-oob/configuration.d.ts +24 -17
  113. package/dist/esm/threeds-oob/configuration.js +3 -3
  114. package/dist/esm/transaction-event/api.d.ts +2 -453
  115. package/dist/esm/transaction-event/api.js +13 -28
  116. package/dist/esm/transaction-event/base.d.ts +0 -24
  117. package/dist/esm/transaction-event/base.js +0 -19
  118. package/dist/esm/transaction-event/common.d.ts +4 -35
  119. package/dist/esm/transaction-event/common.js +14 -37
  120. package/dist/esm/transaction-event/configuration.d.ts +24 -17
  121. package/dist/esm/transaction-event/configuration.js +3 -3
  122. package/dist/esm/wallet/api.d.ts +0 -342
  123. package/dist/esm/wallet/api.js +29 -83
  124. package/dist/esm/wallet/base.d.ts +0 -24
  125. package/dist/esm/wallet/base.js +0 -19
  126. package/dist/esm/wallet/common.d.ts +4 -35
  127. package/dist/esm/wallet/common.js +14 -37
  128. package/dist/esm/wallet/configuration.d.ts +24 -17
  129. package/dist/esm/wallet/configuration.js +3 -3
  130. package/dist/issuer-events/api.d.ts +639 -601
  131. package/dist/issuer-events/api.js +521 -55
  132. package/dist/issuer-events/base.d.ts +0 -24
  133. package/dist/issuer-events/base.js +0 -19
  134. package/dist/issuer-events/common.d.ts +4 -35
  135. package/dist/issuer-events/common.js +16 -38
  136. package/dist/issuer-events/configuration.d.ts +24 -17
  137. package/dist/issuer-events/configuration.js +3 -3
  138. package/dist/pin/api.d.ts +0 -76
  139. package/dist/pin/api.js +3 -15
  140. package/dist/pin/base.d.ts +0 -24
  141. package/dist/pin/base.js +0 -19
  142. package/dist/pin/common.d.ts +4 -35
  143. package/dist/pin/common.js +16 -38
  144. package/dist/pin/configuration.d.ts +24 -17
  145. package/dist/pin/configuration.js +3 -3
  146. package/dist/threeds/api.d.ts +0 -18
  147. package/dist/threeds/api.js +1 -8
  148. package/dist/threeds/base.d.ts +0 -24
  149. package/dist/threeds/base.js +0 -19
  150. package/dist/threeds/common.d.ts +4 -35
  151. package/dist/threeds/common.js +16 -38
  152. package/dist/threeds/configuration.d.ts +24 -17
  153. package/dist/threeds/configuration.js +3 -3
  154. package/dist/threeds-oob/api.d.ts +0 -90
  155. package/dist/threeds-oob/api.js +2 -9
  156. package/dist/threeds-oob/base.d.ts +0 -24
  157. package/dist/threeds-oob/base.js +0 -19
  158. package/dist/threeds-oob/common.d.ts +4 -35
  159. package/dist/threeds-oob/common.js +16 -38
  160. package/dist/threeds-oob/configuration.d.ts +24 -17
  161. package/dist/threeds-oob/configuration.js +3 -3
  162. package/dist/transaction-event/api.d.ts +2 -453
  163. package/dist/transaction-event/api.js +13 -28
  164. package/dist/transaction-event/base.d.ts +0 -24
  165. package/dist/transaction-event/base.js +0 -19
  166. package/dist/transaction-event/common.d.ts +4 -35
  167. package/dist/transaction-event/common.js +16 -38
  168. package/dist/transaction-event/configuration.d.ts +24 -17
  169. package/dist/transaction-event/configuration.js +3 -3
  170. package/dist/wallet/api.d.ts +0 -342
  171. package/dist/wallet/api.js +29 -83
  172. package/dist/wallet/base.d.ts +0 -24
  173. package/dist/wallet/base.js +0 -19
  174. package/dist/wallet/common.d.ts +4 -35
  175. package/dist/wallet/common.js +16 -38
  176. package/dist/wallet/configuration.d.ts +24 -17
  177. package/dist/wallet/configuration.js +3 -3
  178. package/package.json +5 -2
  179. package/src/authorisation-control/api.ts +11 -314
  180. package/src/authorisation-control/base.ts +0 -24
  181. package/src/authorisation-control/common.ts +15 -38
  182. package/src/authorisation-control/configuration.ts +26 -20
  183. package/src/card/api.ts +80 -786
  184. package/src/card/base.ts +0 -24
  185. package/src/card/common.ts +15 -38
  186. package/src/card/configuration.ts +26 -20
  187. package/src/cardholder/api.ts +987 -714
  188. package/src/cardholder/base.ts +0 -24
  189. package/src/cardholder/common.ts +15 -38
  190. package/src/cardholder/configuration.ts +26 -20
  191. package/src/cards/api.ts +3 -11
  192. package/src/cards/base.ts +0 -24
  193. package/src/cards/common.ts +15 -38
  194. package/src/cards/configuration.ts +26 -20
  195. package/src/clearing-file-copy/api.ts +13 -510
  196. package/src/clearing-file-copy/base.ts +0 -24
  197. package/src/clearing-file-copy/common.ts +15 -38
  198. package/src/clearing-file-copy/configuration.ts +26 -20
  199. package/src/issuer-events/api.ts +661 -628
  200. package/src/issuer-events/base.ts +0 -24
  201. package/src/issuer-events/common.ts +15 -38
  202. package/src/issuer-events/configuration.ts +26 -20
  203. package/src/pin/api.ts +4 -83
  204. package/src/pin/base.ts +0 -24
  205. package/src/pin/common.ts +15 -38
  206. package/src/pin/configuration.ts +26 -20
  207. package/src/threeds/api.ts +2 -22
  208. package/src/threeds/base.ts +0 -24
  209. package/src/threeds/common.ts +15 -38
  210. package/src/threeds/configuration.ts +26 -20
  211. package/src/threeds-oob/api.ts +3 -95
  212. package/src/threeds-oob/base.ts +0 -24
  213. package/src/threeds-oob/common.ts +15 -38
  214. package/src/threeds-oob/configuration.ts +26 -20
  215. package/src/transaction-event/api.ts +14 -465
  216. package/src/transaction-event/base.ts +0 -24
  217. package/src/transaction-event/common.ts +15 -38
  218. package/src/transaction-event/configuration.ts +26 -20
  219. package/src/wallet/api.ts +30 -377
  220. package/src/wallet/base.ts +0 -24
  221. package/src/wallet/common.ts +15 -38
  222. package/src/wallet/configuration.ts +26 -20
@@ -18,220 +18,104 @@ import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
18
18
  import globalAxios from 'axios';
19
19
  // Some imports not used depending on template conditions
20
20
  // @ts-ignore
21
- import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from './common';
21
+ import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction, replaceWithSerializableTypeIfNeeded } from './common';
22
22
  import type { RequestArgs } from './base';
23
23
  // @ts-ignore
24
24
  import { BASE_PATH, COLLECTION_FORMATS, BaseAPI, RequiredError, operationServerMap } from './base';
25
25
 
26
- /**
27
- *
28
- * @export
29
- * @interface Account
30
- */
31
26
  export interface Account {
32
27
  /**
33
28
  * Available amount before this transaction has been processed.
34
- * @type {Money}
35
- * @memberof Account
36
29
  */
37
30
  'availableAmount': Money;
38
31
  }
39
- /**
40
- *
41
- * @export
42
- * @interface ApprovedTransaction
43
- */
44
32
  export interface ApprovedTransaction {
45
33
  /**
46
34
  * Enfuce generated code/number (6-digits)— returned to the merchant when authorisation is approved. In case of scheme advices, this is generated and transmitted by the scheme.
47
- * @type {string}
48
- * @memberof ApprovedTransaction
49
35
  */
50
36
  'authCode'?: string;
51
37
  /**
52
38
  * Number of days the authorisation is valid (applicable when merchants requests for extended authorisation period, longer than the default 7 days).
53
- * @type {number}
54
- * @memberof ApprovedTransaction
55
39
  */
56
40
  'authValidity'?: number;
57
41
  /**
58
42
  * Transaction amount in the currency of the ledger account (associated with the card). If any issuer transaction fee is applied (see the issuerTransactionFees field), the billingAmount also includes those fees.
59
- * @type {Money}
60
- * @memberof ApprovedTransaction
61
43
  */
62
44
  'billingAmount'?: Money;
63
45
  /**
64
46
  * The transaction amount in the local currency of the acquirer or the merchant, where the transaction occurred.
65
- * @type {Money}
66
- * @memberof ApprovedTransaction
67
47
  */
68
48
  'transactionAmount'?: Money;
69
49
  /**
70
50
  * The amount of funds transferred between the acquirer and the issuer, equal to the `transactionAmount`, in the settlement currency.
71
- * @type {Money}
72
- * @memberof ApprovedTransaction
73
51
  */
74
52
  'settlementAmount'?: Money;
75
53
  /**
76
54
  * Fee charged (for example, by the acquirer) for transaction activity.
77
- * @type {Money}
78
- * @memberof ApprovedTransaction
79
55
  */
80
56
  'acquirerTransactionFeeAmount'?: Money;
81
- /**
82
- *
83
- * @type {Array<TransactionFee>}
84
- * @memberof ApprovedTransaction
85
- */
86
57
  'issuerTransactionFees'?: Array<TransactionFee>;
87
- /**
88
- *
89
- * @type {Array<CardholderVerificationMethod>}
90
- * @memberof ApprovedTransaction
91
- */
92
58
  'cardholderVerificationMethods'?: Array<CardholderVerificationMethod>;
93
59
  /**
94
60
  * Merchant/acquirer generated transaction reference number.
95
- * @type {string}
96
- * @memberof ApprovedTransaction
97
61
  */
98
62
  'retrievalReferenceNumber'?: string;
99
- /**
100
- *
101
- * @type {CardEntryMode}
102
- * @memberof ApprovedTransaction
103
- */
104
63
  'cardEntryMode'?: CardEntryMode;
105
64
  /**
106
65
  * Indicates whether the cardholder is physically present during transaction.
107
- * @type {boolean}
108
- * @memberof ApprovedTransaction
109
66
  */
110
67
  'cardholderPresent'?: boolean;
111
68
  /**
112
69
  * Indicates whether the card is present at the point of service.
113
- * @type {boolean}
114
- * @memberof ApprovedTransaction
115
70
  */
116
71
  'cardPresent'?: boolean;
117
72
  /**
118
73
  * Indicates whether the transaction is a recurring payment or merchant initiated. This implies whether the cardholder has approved the merchant initiated transaction.
119
- * @type {boolean}
120
- * @memberof ApprovedTransaction
121
74
  */
122
75
  'merchantInitiated'?: boolean;
123
76
  /**
124
77
  * Date and time in the time zone where the transaction occurred.
125
- * @type {string}
126
- * @memberof ApprovedTransaction
127
78
  */
128
79
  'transactionDateTime'?: string;
129
80
  /**
130
81
  * This value is present only for recurring transaction, and it\'s value is first original authorisation request in the chain.
131
- * @type {string}
132
- * @memberof ApprovedTransaction
133
82
  */
134
83
  'originalTransactionId'?: string;
135
- /**
136
- *
137
- * @type {TransactionType}
138
- * @memberof ApprovedTransaction
139
- */
140
84
  'transactionType'?: TransactionType;
141
85
  /**
142
86
  * Amount approved at the current payment processing stage; the amount might be further reduced in the subsequent stages, when the Ledger performs additional validations. If any issuer transaction fee is applied (see the issuerTransactionFees field), the approvedAmount also includes those fees.
143
- * @type {Money}
144
- * @memberof ApprovedTransaction
145
87
  */
146
88
  'approvedAmount'?: Money;
147
89
  /**
148
90
  * Time when processed by Enfuce.
149
- * @type {string}
150
- * @memberof ApprovedTransaction
151
91
  */
152
92
  'processedDateTime'?: string;
153
93
  }
154
94
 
155
95
 
156
- /**
157
- *
158
- * @export
159
- * @interface AuthRequestBody
160
- */
161
96
  export interface AuthRequestBody {
162
97
  /**
163
98
  * Unique system generated ID assigned to each event in the payment processing workflow. For example, an ID assigned to the initial authorisation event.
164
- * @type {string}
165
- * @memberof AuthRequestBody
166
99
  */
167
100
  'id'?: string;
168
101
  /**
169
102
  * Enfuce generated unique ID assigned to each card transaction. Transaction events for the same card payment includes the same `transactionId`. For example, authorisation, incremental authorisation, and adjustment for the same transaction includes the same `transactionID`.
170
- * @type {string}
171
- * @memberof AuthRequestBody
172
103
  */
173
104
  'transactionId'?: string;
174
- /**
175
- *
176
- * @type {MessageCategoryAuthorization}
177
- * @memberof AuthRequestBody
178
- */
179
105
  'messageCategory'?: MessageCategoryAuthorization;
180
- /**
181
- *
182
- * @type {MessageFunctionAuthorization}
183
- * @memberof AuthRequestBody
184
- */
185
106
  'messageFunction'?: MessageFunctionAuthorization;
186
- /**
187
- *
188
- * @type {Token}
189
- * @memberof AuthRequestBody
190
- */
191
107
  'token'?: Token;
192
- /**
193
- *
194
- * @type {Card}
195
- * @memberof AuthRequestBody
196
- */
197
108
  'card': Card;
198
- /**
199
- *
200
- * @type {Merchant}
201
- * @memberof AuthRequestBody
202
- */
203
109
  'merchant': Merchant;
204
- /**
205
- *
206
- * @type {ApprovedTransaction}
207
- * @memberof AuthRequestBody
208
- */
209
110
  'transaction': ApprovedTransaction;
210
111
  }
211
112
 
212
113
 
213
- /**
214
- *
215
- * @export
216
- * @interface AuthResponseBody
217
- */
218
114
  export interface AuthResponseBody {
219
- /**
220
- *
221
- * @type {AuthResponseCode}
222
- * @memberof AuthResponseBody
223
- */
224
115
  'authResponseCode': AuthResponseCode;
225
- /**
226
- *
227
- * @type {Account}
228
- * @memberof AuthResponseBody
229
- */
230
116
  'account'?: Account;
231
117
  /**
232
118
  * Return when there is a partial approval. When the balance is less than the transaction amount, return the available amount that you authorise. Return this attribute only when in the request `merchant.partialApprovalCapable` is true (i.e. the merchant approves that a smaller amount than the full transaction amount is authorised), and `authResponseCode` should be `PARTIALLY_APPROVED`.
233
- * @type {Money}
234
- * @memberof AuthResponseBody
235
119
  */
236
120
  'partialApprovalAmount'?: Money;
237
121
  }
@@ -239,8 +123,6 @@ export interface AuthResponseBody {
239
123
 
240
124
  /**
241
125
  * Indicates whether the authorisation request is approved or declined. Possible enums: * `APPROVED` - Approved * `PARTIALLY_APPROVED` - Approved for partial amount * `DO_NOT_HONOR` - Do not honor (**Note**: Card schemes recommend to use this only when other options do not apply) * `NOT_SUFFICIENT_FUNDS` - Inadequate funds * `NOT_PERMITTED` - Transaction not permitted to cardholder * `EXCEEDS_AMOUNT_LIMIT` - Exceeds approval amount limit * `RESTRICTED_CARD` - Restricted card (card invalid in region or country) * `EXCEEDS_WITHDRAWAL_FREQUENCY_LIMIT` - Exceeds withdrawal frequency limit * `SYSTEM_ERROR` - System malfunction
242
- * @export
243
- * @enum {string}
244
126
  */
245
127
 
246
128
  export const AuthResponseCode = {
@@ -252,106 +134,69 @@ export const AuthResponseCode = {
252
134
  ExceedsAmountLimit: 'EXCEEDS_AMOUNT_LIMIT',
253
135
  RestrictedCard: 'RESTRICTED_CARD',
254
136
  ExceedsWithdrawalFrequencyLimit: 'EXCEEDS_WITHDRAWAL_FREQUENCY_LIMIT',
255
- SystemError: 'SYSTEM_ERROR'
137
+ SystemError: 'SYSTEM_ERROR',
256
138
  } as const;
257
139
 
258
140
  export type AuthResponseCode = typeof AuthResponseCode[keyof typeof AuthResponseCode];
259
141
 
260
142
 
261
- /**
262
- *
263
- * @export
264
- * @interface AuthorizationMetadata
265
- */
266
143
  export interface AuthorizationMetadata {
267
144
  /**
268
145
  * Unique system generated ID assigned to each event in the payment processing workflow. For example, an ID assigned to the initial authorisation event.
269
- * @type {string}
270
- * @memberof AuthorizationMetadata
271
146
  */
272
147
  'id'?: string;
273
148
  /**
274
149
  * Enfuce generated unique ID assigned to each card transaction. Transaction events for the same card payment includes the same `transactionId`. For example, authorisation, incremental authorisation, and adjustment for the same transaction includes the same `transactionID`.
275
- * @type {string}
276
- * @memberof AuthorizationMetadata
277
150
  */
278
151
  'transactionId'?: string;
279
- /**
280
- *
281
- * @type {MessageCategoryAuthorization}
282
- * @memberof AuthorizationMetadata
283
- */
284
152
  'messageCategory'?: MessageCategoryAuthorization;
285
- /**
286
- *
287
- * @type {MessageFunctionAuthorization}
288
- * @memberof AuthorizationMetadata
289
- */
290
153
  'messageFunction'?: MessageFunctionAuthorization;
291
154
  }
292
155
 
293
156
 
294
157
  /**
295
158
  * Information about the card used for the payment.
296
- * @export
297
- * @interface Card
298
159
  */
299
160
  export interface Card {
300
161
  /**
301
162
  * Enfuce generated unique ID assigned to each card used — enables you to identify the card that you must authorise.
302
- * @type {string}
303
- * @memberof Card
304
163
  */
305
164
  'id'?: string;
306
165
  /**
307
166
  * Card expiration date as received in the scheme message.
308
- * @type {Expiration}
309
- * @memberof Card
310
167
  */
311
168
  'expirationDate'?: Expiration;
312
169
  /**
313
170
  * Card sequence number as received in the scheme message.
314
- * @type {number}
315
- * @memberof Card
316
171
  */
317
172
  'sequenceNumber'?: number;
318
173
  /**
319
174
  * Ledger provided account ID associated with the card.
320
- * @type {string}
321
- * @memberof Card
322
175
  */
323
176
  'accountId'?: string;
324
177
  /**
325
178
  * Unique ID of the cardholder associated with the card.
326
- * @type {string}
327
- * @memberof Card
328
179
  */
329
180
  'cardholderId'?: string;
330
181
  /**
331
182
  * Information about any parent card group associated with the card.
332
- * @type {Array<CardGroupsInner>}
333
- * @memberof Card
334
183
  */
335
184
  'groups'?: Array<CardGroupsInner>;
336
185
  /**
337
186
  * The type of card application used for the transaction.
338
- * @type {string}
339
- * @memberof Card
340
187
  */
341
188
  'applicationSelection'?: CardApplicationSelectionEnum;
342
189
  }
343
190
 
344
191
  export const CardApplicationSelectionEnum = {
345
192
  Debit: 'DEBIT',
346
- Credit: 'CREDIT'
193
+ Credit: 'CREDIT',
347
194
  } as const;
348
195
 
349
196
  export type CardApplicationSelectionEnum = typeof CardApplicationSelectionEnum[keyof typeof CardApplicationSelectionEnum];
350
197
 
351
198
  /**
352
199
  * Describes how the card credentials were captured.
353
- * @export
354
- * @enum {string}
355
200
  */
356
201
 
357
202
  export const CardEntryMode = {
@@ -363,29 +208,20 @@ export const CardEntryMode = {
363
208
  Ecommerce: 'ECOMMERCE',
364
209
  WalletEcommerce: 'WALLET_ECOMMERCE',
365
210
  CredentialsOnFile: 'CREDENTIALS_ON_FILE',
366
- Unknown: 'UNKNOWN'
211
+ Unknown: 'UNKNOWN',
367
212
  } as const;
368
213
 
369
214
  export type CardEntryMode = typeof CardEntryMode[keyof typeof CardEntryMode];
370
215
 
371
216
 
372
- /**
373
- *
374
- * @export
375
- * @interface CardGroupsInner
376
- */
377
217
  export interface CardGroupsInner {
378
218
  /**
379
219
  * Unique ID assigned to the parent card group.
380
- * @type {string}
381
- * @memberof CardGroupsInner
382
220
  */
383
221
  'groupId': string;
384
222
  }
385
223
  /**
386
224
  * The method used for verifying the cardholder: - PIN_VERIFIED_BY_CARD: The card\'s PIN is verified. - PIN_VERIFIED_BY_ISSUER: The card\'s PIN is verified by issuer. - WALLET: The cardholder is verified by the digital wallet. - THREE_DS: The cardholder is 3DS authenticated. - BIOMETRIC: The cardholder is verified by biometrics data. - SIGNATURE: The cardholder\'s signature verified. - NO_VERIFICATION: No verification is performed.
387
- * @export
388
- * @enum {string}
389
225
  */
390
226
 
391
227
  export const CardholderVerificationMethod = {
@@ -395,152 +231,96 @@ export const CardholderVerificationMethod = {
395
231
  ThreeDs: 'THREE_DS',
396
232
  Biometric: 'BIOMETRIC',
397
233
  Signature: 'SIGNATURE',
398
- NoVerification: 'NO_VERIFICATION'
234
+ NoVerification: 'NO_VERIFICATION',
399
235
  } as const;
400
236
 
401
237
  export type CardholderVerificationMethod = typeof CardholderVerificationMethod[keyof typeof CardholderVerificationMethod];
402
238
 
403
239
 
404
- /**
405
- *
406
- * @export
407
- * @interface Expiration
408
- */
409
240
  export interface Expiration {
410
241
  /**
411
242
  * Expiration year in YYYY format.
412
- * @type {number}
413
- * @memberof Expiration
414
243
  */
415
244
  'year': number;
416
245
  /**
417
246
  * Expiration month in MM format.
418
- * @type {number}
419
- * @memberof Expiration
420
247
  */
421
248
  'month': number;
422
249
  }
423
- /**
424
- *
425
- * @export
426
- * @interface Merchant
427
- */
428
250
  export interface Merchant {
429
251
  /**
430
252
  * ID assigned code each card acceptor, i.e. a merchant or a bank.
431
- * @type {string}
432
- * @memberof Merchant
433
253
  */
434
254
  'id'?: string;
435
255
  /**
436
256
  * Merchant name as received from the card scheme. For ATMs, this can be a street address or a bank branch number.
437
- * @type {string}
438
- * @memberof Merchant
439
257
  */
440
258
  'name'?: string;
441
259
  /**
442
260
  * The city where the transaction/withdrawal has occurred or where the merchant is registered.
443
- * @type {string}
444
- * @memberof Merchant
445
261
  */
446
262
  'city'?: string;
447
263
  /**
448
264
  * The country where the transaction/withdrawal has occurred or where the merchant is registered.
449
- * @type {string}
450
- * @memberof Merchant
451
265
  */
452
266
  'country'?: string;
453
267
  /**
454
268
  * The merchant\'s postal code.
455
- * @type {string}
456
- * @memberof Merchant
457
269
  */
458
270
  'zipCode'?: string;
459
271
  /**
460
272
  * Contains the merchant\'s street address.
461
- * @type {string}
462
- * @memberof Merchant
463
273
  */
464
274
  'address'?: string;
465
- /**
466
- *
467
- * @type {MerchantCategory}
468
- * @memberof Merchant
469
- */
470
275
  'category'?: MerchantCategory;
471
276
  /**
472
277
  * Uniquely ID assigned to each terminal used by the merchant.
473
- * @type {string}
474
- * @memberof Merchant
475
278
  */
476
279
  'terminalId'?: string;
477
280
  /**
478
281
  * The sub-merchant ID is used when merchant ID is not adequate to identify the merchant. Used when a merchant uses a payment facilitator.
479
- * @type {string}
480
- * @memberof Merchant
481
282
  */
482
283
  'subMerchantId'?: string;
483
284
  /**
484
285
  * Indicates whether the merchant is capable of accepting partial approval of an amount: - TRUE: Specifies `TRUE` if the merchant accepts partial approval. - FALSE: Specifies `FALSE` if the merchant does not accept partial approval.
485
- * @type {boolean}
486
- * @memberof Merchant
487
286
  */
488
287
  'partialApprovalCapable'?: boolean;
489
288
  /**
490
289
  * Unique ID assigned to the financial institution acting as the merchant\'s acquirer.
491
- * @type {string}
492
- * @memberof Merchant
493
290
  */
494
291
  'acquirerId'?: string;
495
292
  /**
496
293
  * The country of the merchant\'s acquirer — mention the ISO-3166-1 alpha-3 country code.
497
- * @type {string}
498
- * @memberof Merchant
499
294
  */
500
295
  'acquirerCountry'?: string;
501
296
  /**
502
297
  * Data an acquirer supplies in an acquirer-originated message, might be required for the issuer to return to the acquirer in a subsequent message.
503
- * @type {string}
504
- * @memberof Merchant
505
298
  */
506
299
  'acquirerReferenceData'?: string;
507
300
  }
508
- /**
509
- *
510
- * @export
511
- * @interface MerchantCategory
512
- */
513
301
  export interface MerchantCategory {
514
302
  /**
515
303
  * Merchant category code as per the card scheme classification. Categorisation is done based on the type of business or service the merchant provides.
516
- * @type {string}
517
- * @memberof MerchantCategory
518
304
  */
519
305
  'code'?: string;
520
306
  /**
521
307
  * Description of the Merchant Category Code (MCC).
522
- * @type {string}
523
- * @memberof MerchantCategory
524
308
  */
525
309
  'description'?: string;
526
310
  /**
527
311
  * Merchant Category Code (MCC) group as received from the scheme.
528
- * @type {string}
529
- * @memberof MerchantCategory
530
312
  */
531
313
  'group'?: string;
532
314
  }
533
315
  /**
534
316
  * Message category sent in the authorisation control webhook. Possible enums: - INITIAL_AUTHORIZATION: Initial authorisation of the card payment. - INCREMENTAL_AUTHORIZATION: Additional authorisation for a previously authorised transaction. - BALANCE_INQUIRY: Enquiring about the current balance of the funding account from the external application. - PIN_MANAGEMENT: Request to change the card PIN.
535
- * @export
536
- * @enum {string}
537
317
  */
538
318
 
539
319
  export const MessageCategoryAuthorization = {
540
320
  InitialAuthorization: 'INITIAL_AUTHORIZATION',
541
321
  IncrementalAuthorization: 'INCREMENTAL_AUTHORIZATION',
542
322
  BalanceInquiry: 'BALANCE_INQUIRY',
543
- PinManagement: 'PIN_MANAGEMENT'
323
+ PinManagement: 'PIN_MANAGEMENT',
544
324
  } as const;
545
325
 
546
326
  export type MessageCategoryAuthorization = typeof MessageCategoryAuthorization[keyof typeof MessageCategoryAuthorization];
@@ -548,12 +328,10 @@ export type MessageCategoryAuthorization = typeof MessageCategoryAuthorization[k
548
328
 
549
329
  /**
550
330
  * Identifies the message function of the authorisation request.
551
- * @export
552
- * @enum {string}
553
331
  */
554
332
 
555
333
  export const MessageFunctionAuthorization = {
556
- Request: 'REQUEST'
334
+ Request: 'REQUEST',
557
335
  } as const;
558
336
 
559
337
  export type MessageFunctionAuthorization = typeof MessageFunctionAuthorization[keyof typeof MessageFunctionAuthorization];
@@ -561,39 +339,21 @@ export type MessageFunctionAuthorization = typeof MessageFunctionAuthorization[k
561
339
 
562
340
  /**
563
341
  * Amount including currency.
564
- * @export
565
- * @interface Money
566
342
  */
567
343
  export interface Money {
568
- /**
569
- *
570
- * @type {number}
571
- * @memberof Money
572
- */
573
344
  'amount': number;
574
345
  /**
575
346
  * A valid ISO 4217 currency code
576
- * @type {string}
577
- * @memberof Money
578
347
  */
579
348
  'currency': string;
580
349
  }
581
350
  /**
582
351
  * Information about the token associated with the card.
583
- * @export
584
- * @interface Token
585
352
  */
586
353
  export interface Token {
587
- /**
588
- *
589
- * @type {string}
590
- * @memberof Token
591
- */
592
354
  'id'?: string;
593
355
  /**
594
356
  * Identifies the specific digital wallet.
595
- * @type {string}
596
- * @memberof Token
597
357
  */
598
358
  'walletIdentifier'?: TokenWalletIdentifierEnum;
599
359
  }
@@ -603,126 +363,73 @@ export const TokenWalletIdentifierEnum = {
603
363
  ApplePay: 'APPLE_PAY',
604
364
  GooglePay: 'GOOGLE_PAY',
605
365
  SamsungPay: 'SAMSUNG_PAY',
606
- RemoteCommercePrograms: 'REMOTE_COMMERCE_PROGRAMS'
366
+ RemoteCommercePrograms: 'REMOTE_COMMERCE_PROGRAMS',
607
367
  } as const;
608
368
 
609
369
  export type TokenWalletIdentifierEnum = typeof TokenWalletIdentifierEnum[keyof typeof TokenWalletIdentifierEnum];
610
370
 
611
- /**
612
- *
613
- * @export
614
- * @interface Transaction
615
- */
616
371
  export interface Transaction {
617
372
  /**
618
373
  * Enfuce generated code/number (6-digits)— returned to the merchant when authorisation is approved. In case of scheme advices, this is generated and transmitted by the scheme.
619
- * @type {string}
620
- * @memberof Transaction
621
374
  */
622
375
  'authCode'?: string;
623
376
  /**
624
377
  * Number of days the authorisation is valid (applicable when merchants requests for extended authorisation period, longer than the default 7 days).
625
- * @type {number}
626
- * @memberof Transaction
627
378
  */
628
379
  'authValidity'?: number;
629
380
  /**
630
381
  * Transaction amount in the currency of the ledger account (associated with the card). If any issuer transaction fee is applied (see the issuerTransactionFees field), the billingAmount also includes those fees.
631
- * @type {Money}
632
- * @memberof Transaction
633
382
  */
634
383
  'billingAmount'?: Money;
635
384
  /**
636
385
  * The transaction amount in the local currency of the acquirer or the merchant, where the transaction occurred.
637
- * @type {Money}
638
- * @memberof Transaction
639
386
  */
640
387
  'transactionAmount'?: Money;
641
388
  /**
642
389
  * The amount of funds transferred between the acquirer and the issuer, equal to the `transactionAmount`, in the settlement currency.
643
- * @type {Money}
644
- * @memberof Transaction
645
390
  */
646
391
  'settlementAmount'?: Money;
647
392
  /**
648
393
  * Fee charged (for example, by the acquirer) for transaction activity.
649
- * @type {Money}
650
- * @memberof Transaction
651
394
  */
652
395
  'acquirerTransactionFeeAmount'?: Money;
653
- /**
654
- *
655
- * @type {Array<TransactionFee>}
656
- * @memberof Transaction
657
- */
658
396
  'issuerTransactionFees'?: Array<TransactionFee>;
659
- /**
660
- *
661
- * @type {Array<CardholderVerificationMethod>}
662
- * @memberof Transaction
663
- */
664
397
  'cardholderVerificationMethods'?: Array<CardholderVerificationMethod>;
665
398
  /**
666
399
  * Merchant/acquirer generated transaction reference number.
667
- * @type {string}
668
- * @memberof Transaction
669
400
  */
670
401
  'retrievalReferenceNumber'?: string;
671
- /**
672
- *
673
- * @type {CardEntryMode}
674
- * @memberof Transaction
675
- */
676
402
  'cardEntryMode'?: CardEntryMode;
677
403
  /**
678
404
  * Indicates whether the cardholder is physically present during transaction.
679
- * @type {boolean}
680
- * @memberof Transaction
681
405
  */
682
406
  'cardholderPresent'?: boolean;
683
407
  /**
684
408
  * Indicates whether the card is present at the point of service.
685
- * @type {boolean}
686
- * @memberof Transaction
687
409
  */
688
410
  'cardPresent'?: boolean;
689
411
  /**
690
412
  * Indicates whether the transaction is a recurring payment or merchant initiated. This implies whether the cardholder has approved the merchant initiated transaction.
691
- * @type {boolean}
692
- * @memberof Transaction
693
413
  */
694
414
  'merchantInitiated'?: boolean;
695
415
  /**
696
416
  * Date and time in the time zone where the transaction occurred.
697
- * @type {string}
698
- * @memberof Transaction
699
417
  */
700
418
  'transactionDateTime'?: string;
701
419
  /**
702
420
  * This value is present only for recurring transaction, and it\'s value is first original authorisation request in the chain.
703
- * @type {string}
704
- * @memberof Transaction
705
421
  */
706
422
  'originalTransactionId'?: string;
707
423
  }
708
424
 
709
425
 
710
- /**
711
- *
712
- * @export
713
- * @interface TransactionFee
714
- */
715
426
  export interface TransactionFee {
716
427
  /**
717
428
  * Type of Issuer generated transaction fee in cardholder billing currency. Transaction based fees that are additional fees charged on top of the transaction.
718
- * @type {string}
719
- * @memberof TransactionFee
720
429
  */
721
430
  'type'?: TransactionFeeTypeEnum;
722
431
  /**
723
432
  * Transaction fee amount in cardholder billing currency.
724
- * @type {Money}
725
- * @memberof TransactionFee
726
433
  */
727
434
  'amount'?: Money;
728
435
  }
@@ -730,15 +437,13 @@ export interface TransactionFee {
730
437
  export const TransactionFeeTypeEnum = {
731
438
  CashFee: 'CASH_FEE',
732
439
  AtmFee: 'ATM_FEE',
733
- MarkupFee: 'MARKUP_FEE'
440
+ MarkupFee: 'MARKUP_FEE',
734
441
  } as const;
735
442
 
736
443
  export type TransactionFeeTypeEnum = typeof TransactionFeeTypeEnum[keyof typeof TransactionFeeTypeEnum];
737
444
 
738
445
  /**
739
446
  * The transaction Type
740
- * @export
741
- * @enum {string}
742
447
  */
743
448
 
744
449
  export const TransactionType = {
@@ -757,7 +462,7 @@ export const TransactionType = {
757
462
  ConvenienceCheck: 'CONVENIENCE_CHECK',
758
463
  BalanceTransfer: 'BALANCE_TRANSFER',
759
464
  Reversal: 'REVERSAL',
760
- Aft: 'AFT'
465
+ Aft: 'AFT',
761
466
  } as const;
762
467
 
763
468
  export type TransactionType = typeof TransactionType[keyof typeof TransactionType];
@@ -766,7 +471,6 @@ export type TransactionType = typeof TransactionType[keyof typeof TransactionTyp
766
471
 
767
472
  /**
768
473
  * AuthorisationRequestAPIApi - axios parameter creator
769
- * @export
770
474
  */
771
475
  export const AuthorisationRequestAPIApiAxiosParamCreator = function (configuration?: Configuration) {
772
476
  return {
@@ -792,9 +496,8 @@ export const AuthorisationRequestAPIApiAxiosParamCreator = function (configurati
792
496
  const localVarHeaderParameter = {} as any;
793
497
  const localVarQueryParameter = {} as any;
794
498
 
795
-
796
-
797
499
  localVarHeaderParameter['Content-Type'] = 'application/json';
500
+ localVarHeaderParameter['Accept'] = 'application/json';
798
501
 
799
502
  setSearchParams(localVarUrlObj, localVarQueryParameter);
800
503
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
@@ -811,7 +514,6 @@ export const AuthorisationRequestAPIApiAxiosParamCreator = function (configurati
811
514
 
812
515
  /**
813
516
  * AuthorisationRequestAPIApi - functional programming interface
814
- * @export
815
517
  */
816
518
  export const AuthorisationRequestAPIApiFp = function(configuration?: Configuration) {
817
519
  const localVarAxiosParamCreator = AuthorisationRequestAPIApiAxiosParamCreator(configuration)
@@ -834,7 +536,6 @@ export const AuthorisationRequestAPIApiFp = function(configuration?: Configurati
834
536
 
835
537
  /**
836
538
  * AuthorisationRequestAPIApi - factory interface
837
- * @export
838
539
  */
839
540
  export const AuthorisationRequestAPIApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
840
541
  const localVarFp = AuthorisationRequestAPIApiFp(configuration)
@@ -854,9 +555,6 @@ export const AuthorisationRequestAPIApiFactory = function (configuration?: Confi
854
555
 
855
556
  /**
856
557
  * AuthorisationRequestAPIApi - object-oriented interface
857
- * @export
858
- * @class AuthorisationRequestAPIApi
859
- * @extends {BaseAPI}
860
558
  */
861
559
  export class AuthorisationRequestAPIApi extends BaseAPI {
862
560
  /**
@@ -865,7 +563,6 @@ export class AuthorisationRequestAPIApi extends BaseAPI {
865
563
  * @param {AuthRequestBody} authRequestBody
866
564
  * @param {*} [options] Override http request option.
867
565
  * @throws {RequiredError}
868
- * @memberof AuthorisationRequestAPIApi
869
566
  */
870
567
  public authPost(authRequestBody: AuthRequestBody, options?: RawAxiosRequestConfig) {
871
568
  return AuthorisationRequestAPIApiFp(this.configuration).authPost(authRequestBody, options).then((request) => request(this.axios, this.basePath));