@enfuce/nextgen-sdk 0.0.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 (313) hide show
  1. package/dist/authorisation-control/api.d.ts +771 -0
  2. package/dist/authorisation-control/api.js +240 -0
  3. package/dist/authorisation-control/base.d.ts +66 -0
  4. package/dist/authorisation-control/base.js +65 -0
  5. package/dist/authorisation-control/common.d.ts +65 -0
  6. package/dist/authorisation-control/common.js +161 -0
  7. package/dist/authorisation-control/configuration.d.ts +91 -0
  8. package/dist/authorisation-control/configuration.js +44 -0
  9. package/dist/authorisation-control/index.d.ts +13 -0
  10. package/dist/authorisation-control/index.js +31 -0
  11. package/dist/card/api.d.ts +2065 -0
  12. package/dist/card/api.js +1406 -0
  13. package/dist/card/base.d.ts +66 -0
  14. package/dist/card/base.js +65 -0
  15. package/dist/card/common.d.ts +65 -0
  16. package/dist/card/common.js +161 -0
  17. package/dist/card/configuration.d.ts +91 -0
  18. package/dist/card/configuration.js +44 -0
  19. package/dist/card/index.d.ts +13 -0
  20. package/dist/card/index.js +31 -0
  21. package/dist/cardholder/api.d.ts +1890 -0
  22. package/dist/cardholder/api.js +1239 -0
  23. package/dist/cardholder/base.d.ts +66 -0
  24. package/dist/cardholder/base.js +65 -0
  25. package/dist/cardholder/common.d.ts +65 -0
  26. package/dist/cardholder/common.js +161 -0
  27. package/dist/cardholder/configuration.d.ts +91 -0
  28. package/dist/cardholder/configuration.js +44 -0
  29. package/dist/cardholder/index.d.ts +13 -0
  30. package/dist/cardholder/index.js +31 -0
  31. package/dist/cards/api.d.ts +78 -0
  32. package/dist/cards/api.js +142 -0
  33. package/dist/cards/base.d.ts +66 -0
  34. package/dist/cards/base.js +65 -0
  35. package/dist/cards/common.d.ts +65 -0
  36. package/dist/cards/common.js +161 -0
  37. package/dist/cards/configuration.d.ts +91 -0
  38. package/dist/cards/configuration.js +44 -0
  39. package/dist/cards/index.d.ts +13 -0
  40. package/dist/cards/index.js +31 -0
  41. package/dist/clearing-file-copy/api.d.ts +1245 -0
  42. package/dist/clearing-file-copy/api.js +139 -0
  43. package/dist/clearing-file-copy/base.d.ts +66 -0
  44. package/dist/clearing-file-copy/base.js +65 -0
  45. package/dist/clearing-file-copy/common.d.ts +65 -0
  46. package/dist/clearing-file-copy/common.js +161 -0
  47. package/dist/clearing-file-copy/configuration.d.ts +91 -0
  48. package/dist/clearing-file-copy/configuration.js +44 -0
  49. package/dist/clearing-file-copy/index.d.ts +13 -0
  50. package/dist/clearing-file-copy/index.js +31 -0
  51. package/dist/esm/authorisation-control/api.d.ts +771 -0
  52. package/dist/esm/authorisation-control/api.js +233 -0
  53. package/dist/esm/authorisation-control/base.d.ts +66 -0
  54. package/dist/esm/authorisation-control/base.js +60 -0
  55. package/dist/esm/authorisation-control/common.d.ts +65 -0
  56. package/dist/esm/authorisation-control/common.js +149 -0
  57. package/dist/esm/authorisation-control/configuration.d.ts +91 -0
  58. package/dist/esm/authorisation-control/configuration.js +40 -0
  59. package/dist/esm/authorisation-control/index.d.ts +13 -0
  60. package/dist/esm/authorisation-control/index.js +15 -0
  61. package/dist/esm/card/api.d.ts +2065 -0
  62. package/dist/esm/card/api.js +1379 -0
  63. package/dist/esm/card/base.d.ts +66 -0
  64. package/dist/esm/card/base.js +60 -0
  65. package/dist/esm/card/common.d.ts +65 -0
  66. package/dist/esm/card/common.js +149 -0
  67. package/dist/esm/card/configuration.d.ts +91 -0
  68. package/dist/esm/card/configuration.js +40 -0
  69. package/dist/esm/card/index.d.ts +13 -0
  70. package/dist/esm/card/index.js +15 -0
  71. package/dist/esm/cardholder/api.d.ts +1890 -0
  72. package/dist/esm/cardholder/api.js +1220 -0
  73. package/dist/esm/cardholder/base.d.ts +66 -0
  74. package/dist/esm/cardholder/base.js +60 -0
  75. package/dist/esm/cardholder/common.d.ts +65 -0
  76. package/dist/esm/cardholder/common.js +149 -0
  77. package/dist/esm/cardholder/configuration.d.ts +91 -0
  78. package/dist/esm/cardholder/configuration.js +40 -0
  79. package/dist/esm/cardholder/index.d.ts +13 -0
  80. package/dist/esm/cardholder/index.js +15 -0
  81. package/dist/esm/cards/api.d.ts +78 -0
  82. package/dist/esm/cards/api.js +135 -0
  83. package/dist/esm/cards/base.d.ts +66 -0
  84. package/dist/esm/cards/base.js +60 -0
  85. package/dist/esm/cards/common.d.ts +65 -0
  86. package/dist/esm/cards/common.js +149 -0
  87. package/dist/esm/cards/configuration.d.ts +91 -0
  88. package/dist/esm/cards/configuration.js +40 -0
  89. package/dist/esm/cards/index.d.ts +13 -0
  90. package/dist/esm/cards/index.js +15 -0
  91. package/dist/esm/clearing-file-copy/api.d.ts +1245 -0
  92. package/dist/esm/clearing-file-copy/api.js +136 -0
  93. package/dist/esm/clearing-file-copy/base.d.ts +66 -0
  94. package/dist/esm/clearing-file-copy/base.js +60 -0
  95. package/dist/esm/clearing-file-copy/common.d.ts +65 -0
  96. package/dist/esm/clearing-file-copy/common.js +149 -0
  97. package/dist/esm/clearing-file-copy/configuration.d.ts +91 -0
  98. package/dist/esm/clearing-file-copy/configuration.js +40 -0
  99. package/dist/esm/clearing-file-copy/index.d.ts +13 -0
  100. package/dist/esm/clearing-file-copy/index.js +15 -0
  101. package/dist/esm/index.d.ts +12 -0
  102. package/dist/esm/index.js +14 -0
  103. package/dist/esm/issuer-events/api.d.ts +1721 -0
  104. package/dist/esm/issuer-events/api.js +940 -0
  105. package/dist/esm/issuer-events/base.d.ts +66 -0
  106. package/dist/esm/issuer-events/base.js +60 -0
  107. package/dist/esm/issuer-events/common.d.ts +65 -0
  108. package/dist/esm/issuer-events/common.js +149 -0
  109. package/dist/esm/issuer-events/configuration.d.ts +91 -0
  110. package/dist/esm/issuer-events/configuration.js +40 -0
  111. package/dist/esm/issuer-events/index.d.ts +13 -0
  112. package/dist/esm/issuer-events/index.js +15 -0
  113. package/dist/esm/oauth/axios.d.ts +14 -0
  114. package/dist/esm/oauth/axios.js +58 -0
  115. package/dist/esm/oauth/clientCredentials.d.ts +24 -0
  116. package/dist/esm/oauth/clientCredentials.js +59 -0
  117. package/dist/esm/oauth/index.d.ts +3 -0
  118. package/dist/esm/oauth/index.js +24 -0
  119. package/dist/esm/oauth/tokenManager.d.ts +38 -0
  120. package/dist/esm/oauth/tokenManager.js +77 -0
  121. package/dist/esm/pin/api.d.ts +329 -0
  122. package/dist/esm/pin/api.js +341 -0
  123. package/dist/esm/pin/base.d.ts +66 -0
  124. package/dist/esm/pin/base.js +60 -0
  125. package/dist/esm/pin/common.d.ts +65 -0
  126. package/dist/esm/pin/common.js +149 -0
  127. package/dist/esm/pin/configuration.d.ts +91 -0
  128. package/dist/esm/pin/configuration.js +40 -0
  129. package/dist/esm/pin/index.d.ts +13 -0
  130. package/dist/esm/pin/index.js +15 -0
  131. package/dist/esm/threeds/api.d.ts +104 -0
  132. package/dist/esm/threeds/api.js +136 -0
  133. package/dist/esm/threeds/base.d.ts +66 -0
  134. package/dist/esm/threeds/base.js +60 -0
  135. package/dist/esm/threeds/common.d.ts +65 -0
  136. package/dist/esm/threeds/common.js +149 -0
  137. package/dist/esm/threeds/configuration.d.ts +91 -0
  138. package/dist/esm/threeds/configuration.js +40 -0
  139. package/dist/esm/threeds/index.d.ts +13 -0
  140. package/dist/esm/threeds/index.js +15 -0
  141. package/dist/esm/threeds-oob/api.d.ts +241 -0
  142. package/dist/esm/threeds-oob/api.js +141 -0
  143. package/dist/esm/threeds-oob/base.d.ts +66 -0
  144. package/dist/esm/threeds-oob/base.js +60 -0
  145. package/dist/esm/threeds-oob/common.d.ts +65 -0
  146. package/dist/esm/threeds-oob/common.js +149 -0
  147. package/dist/esm/threeds-oob/configuration.d.ts +91 -0
  148. package/dist/esm/threeds-oob/configuration.js +40 -0
  149. package/dist/esm/threeds-oob/index.d.ts +13 -0
  150. package/dist/esm/threeds-oob/index.js +15 -0
  151. package/dist/esm/transaction-event/api.d.ts +1082 -0
  152. package/dist/esm/transaction-event/api.js +163 -0
  153. package/dist/esm/transaction-event/base.d.ts +66 -0
  154. package/dist/esm/transaction-event/base.js +60 -0
  155. package/dist/esm/transaction-event/common.d.ts +65 -0
  156. package/dist/esm/transaction-event/common.js +149 -0
  157. package/dist/esm/transaction-event/configuration.d.ts +91 -0
  158. package/dist/esm/transaction-event/configuration.js +40 -0
  159. package/dist/esm/transaction-event/index.d.ts +13 -0
  160. package/dist/esm/transaction-event/index.js +15 -0
  161. package/dist/esm/wallet/api.d.ts +1385 -0
  162. package/dist/esm/wallet/api.js +1342 -0
  163. package/dist/esm/wallet/base.d.ts +66 -0
  164. package/dist/esm/wallet/base.js +60 -0
  165. package/dist/esm/wallet/common.d.ts +65 -0
  166. package/dist/esm/wallet/common.js +149 -0
  167. package/dist/esm/wallet/configuration.d.ts +91 -0
  168. package/dist/esm/wallet/configuration.js +40 -0
  169. package/dist/esm/wallet/index.d.ts +13 -0
  170. package/dist/esm/wallet/index.js +15 -0
  171. package/dist/index.d.ts +12 -0
  172. package/dist/index.js +17 -0
  173. package/dist/issuer-events/api.d.ts +1721 -0
  174. package/dist/issuer-events/api.js +947 -0
  175. package/dist/issuer-events/base.d.ts +66 -0
  176. package/dist/issuer-events/base.js +65 -0
  177. package/dist/issuer-events/common.d.ts +65 -0
  178. package/dist/issuer-events/common.js +161 -0
  179. package/dist/issuer-events/configuration.d.ts +91 -0
  180. package/dist/issuer-events/configuration.js +44 -0
  181. package/dist/issuer-events/index.d.ts +13 -0
  182. package/dist/issuer-events/index.js +31 -0
  183. package/dist/oauth/axios.d.ts +14 -0
  184. package/dist/oauth/axios.js +61 -0
  185. package/dist/oauth/clientCredentials.d.ts +24 -0
  186. package/dist/oauth/clientCredentials.js +63 -0
  187. package/dist/oauth/index.d.ts +3 -0
  188. package/dist/oauth/index.js +31 -0
  189. package/dist/oauth/tokenManager.d.ts +38 -0
  190. package/dist/oauth/tokenManager.js +81 -0
  191. package/dist/pin/api.d.ts +329 -0
  192. package/dist/pin/api.js +352 -0
  193. package/dist/pin/base.d.ts +66 -0
  194. package/dist/pin/base.js +65 -0
  195. package/dist/pin/common.d.ts +65 -0
  196. package/dist/pin/common.js +161 -0
  197. package/dist/pin/configuration.d.ts +91 -0
  198. package/dist/pin/configuration.js +44 -0
  199. package/dist/pin/index.d.ts +13 -0
  200. package/dist/pin/index.js +31 -0
  201. package/dist/threeds/api.d.ts +104 -0
  202. package/dist/threeds/api.js +143 -0
  203. package/dist/threeds/base.d.ts +66 -0
  204. package/dist/threeds/base.js +65 -0
  205. package/dist/threeds/common.d.ts +65 -0
  206. package/dist/threeds/common.js +161 -0
  207. package/dist/threeds/configuration.d.ts +91 -0
  208. package/dist/threeds/configuration.js +44 -0
  209. package/dist/threeds/index.d.ts +13 -0
  210. package/dist/threeds/index.js +31 -0
  211. package/dist/threeds-oob/api.d.ts +241 -0
  212. package/dist/threeds-oob/api.js +148 -0
  213. package/dist/threeds-oob/base.d.ts +66 -0
  214. package/dist/threeds-oob/base.js +65 -0
  215. package/dist/threeds-oob/common.d.ts +65 -0
  216. package/dist/threeds-oob/common.js +161 -0
  217. package/dist/threeds-oob/configuration.d.ts +91 -0
  218. package/dist/threeds-oob/configuration.js +44 -0
  219. package/dist/threeds-oob/index.d.ts +13 -0
  220. package/dist/threeds-oob/index.js +31 -0
  221. package/dist/transaction-event/api.d.ts +1082 -0
  222. package/dist/transaction-event/api.js +166 -0
  223. package/dist/transaction-event/base.d.ts +66 -0
  224. package/dist/transaction-event/base.js +65 -0
  225. package/dist/transaction-event/common.d.ts +65 -0
  226. package/dist/transaction-event/common.js +161 -0
  227. package/dist/transaction-event/configuration.d.ts +91 -0
  228. package/dist/transaction-event/configuration.js +44 -0
  229. package/dist/transaction-event/index.d.ts +13 -0
  230. package/dist/transaction-event/index.js +31 -0
  231. package/dist/wallet/api.d.ts +1385 -0
  232. package/dist/wallet/api.js +1377 -0
  233. package/dist/wallet/base.d.ts +66 -0
  234. package/dist/wallet/base.js +65 -0
  235. package/dist/wallet/common.d.ts +65 -0
  236. package/dist/wallet/common.js +161 -0
  237. package/dist/wallet/configuration.d.ts +91 -0
  238. package/dist/wallet/configuration.js +44 -0
  239. package/dist/wallet/index.d.ts +13 -0
  240. package/dist/wallet/index.js +31 -0
  241. package/package.json +25 -0
  242. package/src/authorisation-control/api.ts +876 -0
  243. package/src/authorisation-control/base.ts +86 -0
  244. package/src/authorisation-control/common.ts +150 -0
  245. package/src/authorisation-control/configuration.ts +115 -0
  246. package/src/authorisation-control/index.ts +18 -0
  247. package/src/card/api.ts +2792 -0
  248. package/src/card/base.ts +86 -0
  249. package/src/card/common.ts +150 -0
  250. package/src/card/configuration.ts +115 -0
  251. package/src/card/index.ts +18 -0
  252. package/src/cardholder/api.ts +2244 -0
  253. package/src/cardholder/base.ts +86 -0
  254. package/src/cardholder/common.ts +150 -0
  255. package/src/cardholder/configuration.ts +115 -0
  256. package/src/cardholder/index.ts +18 -0
  257. package/src/cards/api.ts +141 -0
  258. package/src/cards/base.ts +86 -0
  259. package/src/cards/common.ts +150 -0
  260. package/src/cards/configuration.ts +115 -0
  261. package/src/cards/index.ts +18 -0
  262. package/src/clearing-file-copy/api.ts +1309 -0
  263. package/src/clearing-file-copy/base.ts +86 -0
  264. package/src/clearing-file-copy/common.ts +150 -0
  265. package/src/clearing-file-copy/configuration.ts +115 -0
  266. package/src/clearing-file-copy/index.ts +18 -0
  267. package/src/index.ts +16 -0
  268. package/src/issuer-events/api.ts +1926 -0
  269. package/src/issuer-events/base.ts +86 -0
  270. package/src/issuer-events/common.ts +150 -0
  271. package/src/issuer-events/configuration.ts +115 -0
  272. package/src/issuer-events/index.ts +18 -0
  273. package/src/oauth/axios.ts +60 -0
  274. package/src/oauth/clientCredentials.ts +72 -0
  275. package/src/oauth/index.ts +24 -0
  276. package/src/oauth/tokenManager.ts +85 -0
  277. package/src/pin/api.ts +507 -0
  278. package/src/pin/base.ts +86 -0
  279. package/src/pin/common.ts +150 -0
  280. package/src/pin/configuration.ts +115 -0
  281. package/src/pin/index.ts +18 -0
  282. package/src/threeds/api.ts +173 -0
  283. package/src/threeds/base.ts +86 -0
  284. package/src/threeds/common.ts +150 -0
  285. package/src/threeds/configuration.ts +115 -0
  286. package/src/threeds/index.ts +18 -0
  287. package/src/threeds-oob/api.ts +311 -0
  288. package/src/threeds-oob/base.ts +86 -0
  289. package/src/threeds-oob/common.ts +150 -0
  290. package/src/threeds-oob/configuration.ts +115 -0
  291. package/src/threeds-oob/index.ts +18 -0
  292. package/src/transaction-event/api.ts +1152 -0
  293. package/src/transaction-event/base.ts +86 -0
  294. package/src/transaction-event/common.ts +150 -0
  295. package/src/transaction-event/configuration.ts +115 -0
  296. package/src/transaction-event/index.ts +18 -0
  297. package/src/wallet/api.ts +2083 -0
  298. package/src/wallet/base.ts +86 -0
  299. package/src/wallet/common.ts +150 -0
  300. package/src/wallet/configuration.ts +115 -0
  301. package/src/wallet/index.ts +18 -0
  302. package/test/authorisation-control.test.ts +71 -0
  303. package/test/card.test.ts +39 -0
  304. package/test/cardholder.test.ts +51 -0
  305. package/test/cards.test.ts +35 -0
  306. package/test/issuer-events.test.ts +55 -0
  307. package/test/oauth.test.ts +205 -0
  308. package/test/pin.test.ts +39 -0
  309. package/test/threeds-oob.test.ts +90 -0
  310. package/test/threeds.test.ts +55 -0
  311. package/test/wallet.test.ts +62 -0
  312. package/tsconfig.esm.json +7 -0
  313. package/tsconfig.json +14 -0
@@ -0,0 +1,2792 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Card API
5
+ * Endpoints for doing various actions connected to the Card entity. All date-time fields adhere to the ISO 8601 standard unless specified otherwise. For example: 2024-05-31T06:55:17Z
6
+ *
7
+ * The version of the OpenAPI document: 1
8
+ * Contact: info@enfuce.com
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+
16
+ import type { Configuration } from './configuration';
17
+ import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
18
+ import globalAxios from 'axios';
19
+ // Some imports not used depending on template conditions
20
+ // @ts-ignore
21
+ import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from './common';
22
+ import type { RequestArgs } from './base';
23
+ // @ts-ignore
24
+ import { BASE_PATH, COLLECTION_FORMATS, BaseAPI, RequiredError, operationServerMap } from './base';
25
+
26
+ /**
27
+ *
28
+ * @export
29
+ * @interface Address
30
+ */
31
+ export interface Address {
32
+ /**
33
+ * First line of address.
34
+ * @type {string}
35
+ * @memberof Address
36
+ */
37
+ 'address1': string;
38
+ /**
39
+ * Second line of address. Any string without trailing or leading whitespaces, or an empty string.
40
+ * @type {string}
41
+ * @memberof Address
42
+ */
43
+ 'address2'?: string;
44
+ /**
45
+ * Third line of address. Any string without trailing or leading whitespaces, or an empty string.
46
+ * @type {string}
47
+ * @memberof Address
48
+ */
49
+ 'address3'?: string;
50
+ /**
51
+ * Fourth line of the address. Any string without trailing or leading whitespaces, or an empty string.
52
+ * @type {string}
53
+ * @memberof Address
54
+ */
55
+ 'address4'?: string;
56
+ /**
57
+ *
58
+ * @type {string}
59
+ * @memberof Address
60
+ */
61
+ 'city': string;
62
+ /**
63
+ * A valid ISO-3166-1 alpha-3 country code.
64
+ * @type {string}
65
+ * @memberof Address
66
+ */
67
+ 'country': string;
68
+ /**
69
+ *
70
+ * @type {string}
71
+ * @memberof Address
72
+ */
73
+ 'region'?: string;
74
+ /**
75
+ *
76
+ * @type {string}
77
+ * @memberof Address
78
+ */
79
+ 'zipCode': string;
80
+ }
81
+ /**
82
+ *
83
+ * @export
84
+ * @interface CardApplication
85
+ */
86
+ export interface CardApplication {
87
+ /**
88
+ * A unique code to identify the card configuration. Max character limit is 36.
89
+ * @type {string}
90
+ * @memberof CardApplication
91
+ */
92
+ 'cardConfigurationCode': string;
93
+ /**
94
+ *
95
+ * @type {CreatePinStatus}
96
+ * @memberof CardApplication
97
+ */
98
+ 'pinStatus'?: CreatePinStatus;
99
+ /**
100
+ * The account id that is connected to the card
101
+ * @type {string}
102
+ * @memberof CardApplication
103
+ */
104
+ 'accountId': string;
105
+ /**
106
+ * The digital layout code for the card. Max character limit is 36.
107
+ * @type {string}
108
+ * @memberof CardApplication
109
+ */
110
+ 'digitalLayoutCode'?: string;
111
+ /**
112
+ *
113
+ * @type {MultiApplicationProperties}
114
+ * @memberof CardApplication
115
+ */
116
+ 'multiApplicationProperties'?: MultiApplicationProperties;
117
+ /**
118
+ * You can include up to **30 additional key-value pairs** in the embossing file sent to the card manufacturer. - **Keys** must follow the pattern: `^[a-zA-Z0-9-]{1,36}$` (only letters, numbers, and hyphens, with a maximum length of 36 characters). - **Values** must follow the pattern: `^[a-zA-Z0-9|\\-_ +.@éàèùçâêîôûëïü\'/=]{1,1000}$`. Enfuce **does not perform any additional validation** on these key-value pairs beyond ensuring they match the specified patterns. These fields are intended for **storing data without further processing**. If you need to store a **complex structure**, you can **base64 encode** the value. The encoded value will be passed as entered, without modifications. ⚠ **Important:** Any usage of these fields should be agreed upon with the manufacturer.
119
+ * @type {{ [key: string]: string; }}
120
+ * @memberof CardApplication
121
+ */
122
+ 'additionalValues'?: { [key: string]: string; };
123
+ /**
124
+ * Unique identifier of a fee configuration. When provided, this value overrides the program default. This feature must be enabled for the tenant; otherwise, this field can be left null and will not be used.
125
+ * @type {string}
126
+ * @memberof CardApplication
127
+ */
128
+ 'feeConfigId'?: string;
129
+ }
130
+
131
+
132
+ /**
133
+ * The type of card defined by this card configuration.
134
+ * @export
135
+ * @enum {string}
136
+ */
137
+
138
+ export const CardConfigurationType = {
139
+ Debit: 'DEBIT',
140
+ Credit: 'CREDIT',
141
+ Combo: 'COMBO'
142
+ } as const;
143
+
144
+ export type CardConfigurationType = typeof CardConfigurationType[keyof typeof CardConfigurationType];
145
+
146
+
147
+ /**
148
+ *
149
+ * @export
150
+ * @interface CardDataControlTokenResponseBody
151
+ */
152
+ export interface CardDataControlTokenResponseBody {
153
+ /**
154
+ * The control token.
155
+ * @type {string}
156
+ * @memberof CardDataControlTokenResponseBody
157
+ */
158
+ 'token': string;
159
+ /**
160
+ * The URL to call on mobile devices for accessing the card\'s data.
161
+ * @type {string}
162
+ * @memberof CardDataControlTokenResponseBody
163
+ */
164
+ 'cardDataUrl'?: string;
165
+ /**
166
+ * The URL to open in iframe to access the card\'s data.
167
+ * @type {string}
168
+ * @memberof CardDataControlTokenResponseBody
169
+ */
170
+ 'cardDataFrameUrl'?: string;
171
+ }
172
+ /**
173
+ * Select the type of delivery you prefer for the new card being created. - MAIL - The card would be sent via mail services. - COURIER - The card would be sent via courier services. - CUSTOM_1–CUSTOM_5 - Custom delivery types that can be used for shipping methods agreed between the customer and the bureau.
174
+ * @export
175
+ * @enum {string}
176
+ */
177
+
178
+ export const CardDeliveryType = {
179
+ Mail: 'MAIL',
180
+ Courier: 'COURIER',
181
+ Custom1: 'CUSTOM_1',
182
+ Custom2: 'CUSTOM_2',
183
+ Custom3: 'CUSTOM_3',
184
+ Custom4: 'CUSTOM_4',
185
+ Custom5: 'CUSTOM_5'
186
+ } as const;
187
+
188
+ export type CardDeliveryType = typeof CardDeliveryType[keyof typeof CardDeliveryType];
189
+
190
+
191
+ /**
192
+ *
193
+ * @export
194
+ * @interface CardResponse
195
+ */
196
+ export interface CardResponse {
197
+ /**
198
+ * Unique identifier of a card.
199
+ * @type {string}
200
+ * @memberof CardResponse
201
+ */
202
+ 'id'?: string;
203
+ /**
204
+ * The date and time when the card was created.
205
+ * @type {string}
206
+ * @memberof CardResponse
207
+ */
208
+ 'createdAt'?: string;
209
+ /**
210
+ * The date and time when the object/entity was updated last time.
211
+ * @type {string}
212
+ * @memberof CardResponse
213
+ */
214
+ 'updatedAt'?: string;
215
+ /**
216
+ * The program ID associated with the card.
217
+ * @type {string}
218
+ * @memberof CardResponse
219
+ */
220
+ 'programId'?: string;
221
+ /**
222
+ * Unique identifier of the cardholder associated with the card.
223
+ * @type {string}
224
+ * @memberof CardResponse
225
+ */
226
+ 'cardholderId'?: string;
227
+ /**
228
+ * Unique identifier of the account associated with the card.
229
+ * @type {string}
230
+ * @memberof CardResponse
231
+ */
232
+ 'accountId'?: string;
233
+ /**
234
+ *
235
+ * @type {Plastic}
236
+ * @memberof CardResponse
237
+ */
238
+ 'plastic'?: Plastic;
239
+ /**
240
+ * Card versions ordered by sequence number ascending.
241
+ * @type {Array<CardVersion>}
242
+ * @memberof CardResponse
243
+ */
244
+ 'cardVersions'?: Array<CardVersion>;
245
+ /**
246
+ *
247
+ * @type {CardRole}
248
+ * @memberof CardResponse
249
+ */
250
+ 'role'?: CardRole;
251
+ /**
252
+ * Unique identifier of the main card. Populated if this card is part of a card application
253
+ * @type {string}
254
+ * @memberof CardResponse
255
+ */
256
+ 'mainCardId'?: string;
257
+ /**
258
+ * A unique code to identify the card configuration. Max character limit is 36.
259
+ * @type {string}
260
+ * @memberof CardResponse
261
+ */
262
+ 'cardConfigurationCode'?: string;
263
+ /**
264
+ *
265
+ * @type {CardConfigurationType}
266
+ * @memberof CardResponse
267
+ */
268
+ 'cardConfigurationType'?: CardConfigurationType;
269
+ /**
270
+ *
271
+ * @type {CardScheme}
272
+ * @memberof CardResponse
273
+ */
274
+ 'cardScheme'?: CardScheme;
275
+ /**
276
+ * A masked version of the primary account number
277
+ * @type {string}
278
+ * @memberof CardResponse
279
+ */
280
+ 'maskedPan'?: string;
281
+ /**
282
+ *
283
+ * @type {PinStatus}
284
+ * @memberof CardResponse
285
+ */
286
+ 'pinStatus'?: PinStatus;
287
+ /**
288
+ *
289
+ * @type {CardStatus}
290
+ * @memberof CardResponse
291
+ */
292
+ 'cardStatus'?: CardStatus;
293
+ /**
294
+ * A flag indicating whether automatic renewal is enabled or not.
295
+ * @type {boolean}
296
+ * @memberof CardResponse
297
+ */
298
+ 'automaticRenewal'?: boolean;
299
+ /**
300
+ * The digital layout code for the card. Max character limit is 36.
301
+ * @type {string}
302
+ * @memberof CardResponse
303
+ */
304
+ 'digitalLayoutCode'?: string;
305
+ /**
306
+ *
307
+ * @type {MultiApplicationProperties}
308
+ * @memberof CardResponse
309
+ */
310
+ 'multiApplicationProperties'?: MultiApplicationProperties;
311
+ /**
312
+ * The version number of the entity.
313
+ * @type {number}
314
+ * @memberof CardResponse
315
+ */
316
+ 'updateCount'?: number;
317
+ /**
318
+ * You can include up to **30 additional key-value pairs** in the embossing file sent to the card manufacturer. - **Keys** must follow the pattern: `^[a-zA-Z0-9-]{1,36}$` (only letters, numbers, and hyphens, with a maximum length of 36 characters). - **Values** must follow the pattern: `^[a-zA-Z0-9|\\-_ +.@éàèùçâêîôûëïü\'/=]{1,1000}$`. Enfuce **does not perform any additional validation** on these key-value pairs beyond ensuring they match the specified patterns. These fields are intended for **storing data without further processing**. If you need to store a **complex structure**, you can **base64 encode** the value. The encoded value will be passed as entered, without modifications. ⚠ **Important:** Any usage of these fields should be agreed upon with the manufacturer.
319
+ * @type {{ [key: string]: string; }}
320
+ * @memberof CardResponse
321
+ */
322
+ 'additionalValues'?: { [key: string]: string; };
323
+ /**
324
+ * Unique identifier of a fee configuration. When provided, this value overrides the program default. This feature must be enabled for the tenant; otherwise, this field can be left null and will not be used.
325
+ * @type {string}
326
+ * @memberof CardResponse
327
+ */
328
+ 'feeConfigId'?: string | null;
329
+ }
330
+
331
+
332
+ /**
333
+ * The role of the card. Multi application cards will have one main card and multiple card applications. Single cards will be treated as main cards.
334
+ * @export
335
+ * @enum {string}
336
+ */
337
+
338
+ export const CardRole = {
339
+ MainCard: 'MAIN_CARD',
340
+ CardApplication: 'CARD_APPLICATION'
341
+ } as const;
342
+
343
+ export type CardRole = typeof CardRole[keyof typeof CardRole];
344
+
345
+
346
+ /**
347
+ *
348
+ * @export
349
+ * @enum {string}
350
+ */
351
+
352
+ export const CardScheme = {
353
+ Mastercard: 'MASTERCARD',
354
+ Visa: 'VISA'
355
+ } as const;
356
+
357
+ export type CardScheme = typeof CardScheme[keyof typeof CardScheme];
358
+
359
+
360
+ /**
361
+ * - ACTIVE - Card is active and is enabled for normal usage. - BLOCKED - Card is temporarily blocked. - BLOCKED_SUSPECTED_FRAUD - Card is temporarily blocked due to suspected fraud. - CLOSED_DUE_TO_FRAUD - Card has been closed due to fraud. - CLOSED_LOST - Card has been closed due to being lost. - CLOSED_STOLEN - Card has been closed due to being stolen. - CLOSED - Card has been manually closed. - CLOSED_EXPIRED - Card has no active or initial card versions and cannot be used.
362
+ * @export
363
+ * @enum {string}
364
+ */
365
+
366
+ export const CardStatus = {
367
+ Active: 'ACTIVE',
368
+ Blocked: 'BLOCKED',
369
+ BlockedSuspectedFraud: 'BLOCKED_SUSPECTED_FRAUD',
370
+ ClosedDueToFraud: 'CLOSED_DUE_TO_FRAUD',
371
+ ClosedLost: 'CLOSED_LOST',
372
+ ClosedStolen: 'CLOSED_STOLEN',
373
+ Closed: 'CLOSED',
374
+ ClosedExpired: 'CLOSED_EXPIRED'
375
+ } as const;
376
+
377
+ export type CardStatus = typeof CardStatus[keyof typeof CardStatus];
378
+
379
+
380
+ /**
381
+ *
382
+ * @export
383
+ * @interface CardVersion
384
+ */
385
+ export interface CardVersion {
386
+ /**
387
+ *
388
+ * @type {CardVersionStatus}
389
+ * @memberof CardVersion
390
+ */
391
+ 'status'?: CardVersionStatus;
392
+ /**
393
+ * The expiration date-time of the card in UTC format. The time must be a value in te future.
394
+ * @type {string}
395
+ * @memberof CardVersion
396
+ */
397
+ 'expirationTime'?: string;
398
+ /**
399
+ * The date when the auto renewal occurs.
400
+ * @type {string}
401
+ * @memberof CardVersion
402
+ */
403
+ 'renewalDate'?: string;
404
+ /**
405
+ * The sequence number of the card version, this value is also known as PSN (pan sequence number)
406
+ * @type {number}
407
+ * @memberof CardVersion
408
+ */
409
+ 'sequenceNumber'?: number;
410
+ /**
411
+ * The id of the key set used by this card version
412
+ * @type {string}
413
+ * @memberof CardVersion
414
+ */
415
+ 'keySetId'?: string;
416
+ /**
417
+ * The date and time when the card was created.
418
+ * @type {string}
419
+ * @memberof CardVersion
420
+ */
421
+ 'createdAt'?: string;
422
+ /**
423
+ * The date and time when the object/entity was updated last time.
424
+ * @type {string}
425
+ * @memberof CardVersion
426
+ */
427
+ 'updatedAt'?: string;
428
+ }
429
+
430
+
431
+ /**
432
+ * - ACTIVE - The card is completely operational. You can perform all actions with the card. - INITIAL - The specific card version is awaiting activation. During this state, the card can have limited usage, such as being added to a digital wallet or cardholder can view the PIN (if it is a plastic card). However, in the INITIAL state, the card cannot be used for payments. - CLOSED - The previous versions of the card are no longer valid as a new version is activated or the card is closed.
433
+ * @export
434
+ * @enum {string}
435
+ */
436
+
437
+ export const CardVersionStatus = {
438
+ Active: 'ACTIVE',
439
+ Initial: 'INITIAL',
440
+ Closed: 'CLOSED'
441
+ } as const;
442
+
443
+ export type CardVersionStatus = typeof CardVersionStatus[keyof typeof CardVersionStatus];
444
+
445
+
446
+ /**
447
+ * - GENERATED - A pin should be randomly generated for the card. - WAITING - A pin is waiting to be set on the card.
448
+ * @export
449
+ * @enum {string}
450
+ */
451
+
452
+ export const ChangePinStatus = {
453
+ Generated: 'GENERATED',
454
+ Waiting: 'WAITING'
455
+ } as const;
456
+
457
+ export type ChangePinStatus = typeof ChangePinStatus[keyof typeof ChangePinStatus];
458
+
459
+
460
+ /**
461
+ *
462
+ * @export
463
+ * @interface ControlTokenRequestBody
464
+ */
465
+ export interface ControlTokenRequestBody {
466
+ /**
467
+ * The sequence number of the card version to use. If not specified, the latest card version is used by default. Only card versions not in CLOSED status are allowed.
468
+ * @type {number}
469
+ * @memberof ControlTokenRequestBody
470
+ */
471
+ 'sequenceNumber'?: number;
472
+ }
473
+ /**
474
+ * @type CreateCard201Response
475
+ * @export
476
+ */
477
+ export type CreateCard201Response = CardResponse | CreateMultiApplicationCardResponse;
478
+
479
+ /**
480
+ *
481
+ * @export
482
+ * @interface CreateCardBody
483
+ */
484
+ export interface CreateCardBody {
485
+ /**
486
+ * The program id that you want to associate with the new card you are creating.
487
+ * @type {string}
488
+ * @memberof CreateCardBody
489
+ */
490
+ 'programId': string;
491
+ /**
492
+ * A unique code to identify the card configuration. Max character limit is 36.
493
+ * @type {string}
494
+ * @memberof CreateCardBody
495
+ */
496
+ 'cardConfigurationCode': string;
497
+ /**
498
+ *
499
+ * @type {CreatePinStatus}
500
+ * @memberof CreateCardBody
501
+ */
502
+ 'pinStatus'?: CreatePinStatus;
503
+ /**
504
+ * Unique identifier of the cardholder associated with the new card.
505
+ * @type {string}
506
+ * @memberof CreateCardBody
507
+ */
508
+ 'cardholderId'?: string;
509
+ /**
510
+ * The expiration date-time of the card in UTC format. The time must be a value in te future.
511
+ * @type {string}
512
+ * @memberof CreateCardBody
513
+ */
514
+ 'expirationTime'?: string;
515
+ /**
516
+ * Unique identifier of the account associated with the new card.
517
+ * @type {string}
518
+ * @memberof CreateCardBody
519
+ */
520
+ 'accountId': string;
521
+ /**
522
+ *
523
+ * @type {CreatePlasticBody}
524
+ * @memberof CreateCardBody
525
+ */
526
+ 'plastic'?: CreatePlasticBody;
527
+ /**
528
+ * A flag indicating whether automatic renewal is enabled or not.
529
+ * @type {boolean}
530
+ * @memberof CreateCardBody
531
+ */
532
+ 'automaticRenewal'?: boolean;
533
+ /**
534
+ * The digital layout code for the card. Max character limit is 36.
535
+ * @type {string}
536
+ * @memberof CreateCardBody
537
+ */
538
+ 'digitalLayoutCode'?: string;
539
+ /**
540
+ * You can include up to **30 additional key-value pairs** in the embossing file sent to the card manufacturer. - **Keys** must follow the pattern: `^[a-zA-Z0-9-]{1,36}$` (only letters, numbers, and hyphens, with a maximum length of 36 characters). - **Values** must follow the pattern: `^[a-zA-Z0-9|\\-_ +.@éàèùçâêîôûëïü\'/=]{1,1000}$`. Enfuce **does not perform any additional validation** on these key-value pairs beyond ensuring they match the specified patterns. These fields are intended for **storing data without further processing**. If you need to store a **complex structure**, you can **base64 encode** the value. The encoded value will be passed as entered, without modifications. ⚠ **Important:** Any usage of these fields should be agreed upon with the manufacturer.
541
+ * @type {{ [key: string]: string; }}
542
+ * @memberof CreateCardBody
543
+ */
544
+ 'additionalValues'?: { [key: string]: string; };
545
+ /**
546
+ * Unique identifier of a fee configuration. When provided, this value overrides the program default. This feature must be enabled for the tenant; otherwise, this field can be left null and will not be used.
547
+ * @type {string}
548
+ * @memberof CreateCardBody
549
+ */
550
+ 'feeConfigId'?: string;
551
+ }
552
+
553
+
554
+ /**
555
+ * @type CreateCardRequest
556
+ * @export
557
+ */
558
+ export type CreateCardRequest = CreateCardBody | CreateMultiApplicationCardBody;
559
+
560
+ /**
561
+ *
562
+ * @export
563
+ * @interface CreateMultiApplicationCardBody
564
+ */
565
+ export interface CreateMultiApplicationCardBody {
566
+ /**
567
+ *
568
+ * @type {MainCard}
569
+ * @memberof CreateMultiApplicationCardBody
570
+ */
571
+ 'mainCard': MainCard;
572
+ /**
573
+ *
574
+ * @type {Array<CardApplication>}
575
+ * @memberof CreateMultiApplicationCardBody
576
+ */
577
+ 'cardApplications': Array<CardApplication>;
578
+ }
579
+ /**
580
+ *
581
+ * @export
582
+ * @interface CreateMultiApplicationCardResponse
583
+ */
584
+ export interface CreateMultiApplicationCardResponse {
585
+ /**
586
+ * Unique identifier of a card.
587
+ * @type {string}
588
+ * @memberof CreateMultiApplicationCardResponse
589
+ */
590
+ 'id'?: string;
591
+ /**
592
+ * The date and time when the card was created.
593
+ * @type {string}
594
+ * @memberof CreateMultiApplicationCardResponse
595
+ */
596
+ 'createdAt'?: string;
597
+ /**
598
+ * The date and time when the object/entity was updated last time.
599
+ * @type {string}
600
+ * @memberof CreateMultiApplicationCardResponse
601
+ */
602
+ 'updatedAt'?: string;
603
+ /**
604
+ * The program ID associated with the card.
605
+ * @type {string}
606
+ * @memberof CreateMultiApplicationCardResponse
607
+ */
608
+ 'programId'?: string;
609
+ /**
610
+ * Unique identifier of the cardholder associated with the card.
611
+ * @type {string}
612
+ * @memberof CreateMultiApplicationCardResponse
613
+ */
614
+ 'cardholderId'?: string;
615
+ /**
616
+ * Unique identifier of the account associated with the card.
617
+ * @type {string}
618
+ * @memberof CreateMultiApplicationCardResponse
619
+ */
620
+ 'accountId'?: string;
621
+ /**
622
+ *
623
+ * @type {Plastic}
624
+ * @memberof CreateMultiApplicationCardResponse
625
+ */
626
+ 'plastic'?: Plastic;
627
+ /**
628
+ * Card versions ordered by sequence number ascending.
629
+ * @type {Array<CardVersion>}
630
+ * @memberof CreateMultiApplicationCardResponse
631
+ */
632
+ 'cardVersions'?: Array<CardVersion>;
633
+ /**
634
+ *
635
+ * @type {CardRole}
636
+ * @memberof CreateMultiApplicationCardResponse
637
+ */
638
+ 'role'?: CardRole;
639
+ /**
640
+ * Unique identifier of the main card. Populated if this card is part of a card application
641
+ * @type {string}
642
+ * @memberof CreateMultiApplicationCardResponse
643
+ */
644
+ 'mainCardId'?: string;
645
+ /**
646
+ * A unique code to identify the card configuration. Max character limit is 36.
647
+ * @type {string}
648
+ * @memberof CreateMultiApplicationCardResponse
649
+ */
650
+ 'cardConfigurationCode'?: string;
651
+ /**
652
+ *
653
+ * @type {CardConfigurationType}
654
+ * @memberof CreateMultiApplicationCardResponse
655
+ */
656
+ 'cardConfigurationType'?: CardConfigurationType;
657
+ /**
658
+ *
659
+ * @type {CardScheme}
660
+ * @memberof CreateMultiApplicationCardResponse
661
+ */
662
+ 'cardScheme'?: CardScheme;
663
+ /**
664
+ * A masked version of the primary account number
665
+ * @type {string}
666
+ * @memberof CreateMultiApplicationCardResponse
667
+ */
668
+ 'maskedPan'?: string;
669
+ /**
670
+ *
671
+ * @type {PinStatus}
672
+ * @memberof CreateMultiApplicationCardResponse
673
+ */
674
+ 'pinStatus'?: PinStatus;
675
+ /**
676
+ *
677
+ * @type {CardStatus}
678
+ * @memberof CreateMultiApplicationCardResponse
679
+ */
680
+ 'cardStatus'?: CardStatus;
681
+ /**
682
+ * A flag indicating whether automatic renewal is enabled or not.
683
+ * @type {boolean}
684
+ * @memberof CreateMultiApplicationCardResponse
685
+ */
686
+ 'automaticRenewal'?: boolean;
687
+ /**
688
+ * The digital layout code for the card. Max character limit is 36.
689
+ * @type {string}
690
+ * @memberof CreateMultiApplicationCardResponse
691
+ */
692
+ 'digitalLayoutCode'?: string;
693
+ /**
694
+ *
695
+ * @type {MultiApplicationProperties}
696
+ * @memberof CreateMultiApplicationCardResponse
697
+ */
698
+ 'multiApplicationProperties'?: MultiApplicationProperties;
699
+ /**
700
+ * The version number of the entity.
701
+ * @type {number}
702
+ * @memberof CreateMultiApplicationCardResponse
703
+ */
704
+ 'updateCount'?: number;
705
+ /**
706
+ * You can include up to **30 additional key-value pairs** in the embossing file sent to the card manufacturer. - **Keys** must follow the pattern: `^[a-zA-Z0-9-]{1,36}$` (only letters, numbers, and hyphens, with a maximum length of 36 characters). - **Values** must follow the pattern: `^[a-zA-Z0-9|\\-_ +.@éàèùçâêîôûëïü\'/=]{1,1000}$`. Enfuce **does not perform any additional validation** on these key-value pairs beyond ensuring they match the specified patterns. These fields are intended for **storing data without further processing**. If you need to store a **complex structure**, you can **base64 encode** the value. The encoded value will be passed as entered, without modifications. ⚠ **Important:** Any usage of these fields should be agreed upon with the manufacturer.
707
+ * @type {{ [key: string]: string; }}
708
+ * @memberof CreateMultiApplicationCardResponse
709
+ */
710
+ 'additionalValues'?: { [key: string]: string; };
711
+ /**
712
+ * Unique identifier of a fee configuration. When provided, this value overrides the program default. This feature must be enabled for the tenant; otherwise, this field can be left null and will not be used.
713
+ * @type {string}
714
+ * @memberof CreateMultiApplicationCardResponse
715
+ */
716
+ 'feeConfigId'?: string | null;
717
+ /**
718
+ *
719
+ * @type {Array<CardResponse>}
720
+ * @memberof CreateMultiApplicationCardResponse
721
+ */
722
+ 'cardApplications'?: Array<CardResponse>;
723
+ }
724
+
725
+
726
+ /**
727
+ * - GENERATED - This endpoint request would generate a random PIN for the new card. - WAITING - The card PIN would be set later.
728
+ * @export
729
+ * @enum {string}
730
+ */
731
+
732
+ export const CreatePinStatus = {
733
+ Generated: 'GENERATED',
734
+ Waiting: 'WAITING'
735
+ } as const;
736
+
737
+ export type CreatePinStatus = typeof CreatePinStatus[keyof typeof CreatePinStatus];
738
+
739
+
740
+ /**
741
+ *
742
+ * @export
743
+ * @interface CreatePlasticBody
744
+ */
745
+ export interface CreatePlasticBody {
746
+ /**
747
+ * The name to be embossed on the card. Max character limit is 26.
748
+ * @type {string}
749
+ * @memberof CreatePlasticBody
750
+ */
751
+ 'embossingName'?: string;
752
+ /**
753
+ *
754
+ * @type {Address}
755
+ * @memberof CreatePlasticBody
756
+ */
757
+ 'preferredCardAddress'?: Address;
758
+ /**
759
+ *
760
+ * @type {CardDeliveryType}
761
+ * @memberof CreatePlasticBody
762
+ */
763
+ 'preferredCardDeliveryType'?: CardDeliveryType;
764
+ /**
765
+ *
766
+ * @type {Address}
767
+ * @memberof CreatePlasticBody
768
+ */
769
+ 'preferredPinAddress'?: Address;
770
+ /**
771
+ *
772
+ * @type {PinDeliveryType}
773
+ * @memberof CreatePlasticBody
774
+ */
775
+ 'preferredPinDeliveryType'?: PinDeliveryType;
776
+ /**
777
+ * Unique code forwarded to the embossing house; the code identifies the plastic layout to be used for printing the new card. Ensure beforehand, the selected embossing house is aligned with the code used for each layout.
778
+ * @type {string}
779
+ * @memberof CreatePlasticBody
780
+ */
781
+ 'externalLayoutCode'?: string;
782
+ /**
783
+ * The manufacturer id to use for this specific plastic if it deviates from the default manufacturer configured on the program
784
+ * @type {string}
785
+ * @memberof CreatePlasticBody
786
+ */
787
+ 'manufacturerId'?: string;
788
+ }
789
+
790
+
791
+ /**
792
+ *
793
+ * @export
794
+ * @interface EncryptCardPaymentInfoRequestBody
795
+ */
796
+ export interface EncryptCardPaymentInfoRequestBody {
797
+ /**
798
+ * Public key used to encrypt the fields in the result.
799
+ * @type {string}
800
+ * @memberof EncryptCardPaymentInfoRequestBody
801
+ */
802
+ 'encryptionKey': string;
803
+ /**
804
+ * In this field the encryption method is selected. This is to prepared for future use since only one method is now supported.
805
+ * @type {string}
806
+ * @memberof EncryptCardPaymentInfoRequestBody
807
+ */
808
+ 'encryptionMethod': EncryptCardPaymentInfoRequestBodyEncryptionMethodEnum;
809
+ /**
810
+ * In this field you can include the parameters that you want to be returned in an encrypted way. If a field is not listed, it will be left out from the response. Note that only primaryAccountNumber and CVV2 will be encrypted.
811
+ * @type {Array<string>}
812
+ * @memberof EncryptCardPaymentInfoRequestBody
813
+ */
814
+ 'fields': Array<EncryptCardPaymentInfoRequestBodyFieldsEnum>;
815
+ /**
816
+ * The sequence number of the card version to use. If not specified, the latest card version is used by default.
817
+ * @type {number}
818
+ * @memberof EncryptCardPaymentInfoRequestBody
819
+ */
820
+ 'sequenceNumber'?: number;
821
+ }
822
+
823
+ export const EncryptCardPaymentInfoRequestBodyEncryptionMethodEnum = {
824
+ RsaEcbOaepSha256Mgf12048: 'RSA_ECB_OAEP_SHA256_MGF1_2048'
825
+ } as const;
826
+
827
+ export type EncryptCardPaymentInfoRequestBodyEncryptionMethodEnum = typeof EncryptCardPaymentInfoRequestBodyEncryptionMethodEnum[keyof typeof EncryptCardPaymentInfoRequestBodyEncryptionMethodEnum];
828
+ export const EncryptCardPaymentInfoRequestBodyFieldsEnum = {
829
+ PrimaryAccountNumber: 'PRIMARY_ACCOUNT_NUMBER',
830
+ ExpirationDate: 'EXPIRATION_DATE',
831
+ Cvv2: 'CVV2'
832
+ } as const;
833
+
834
+ export type EncryptCardPaymentInfoRequestBodyFieldsEnum = typeof EncryptCardPaymentInfoRequestBodyFieldsEnum[keyof typeof EncryptCardPaymentInfoRequestBodyFieldsEnum];
835
+
836
+ /**
837
+ *
838
+ * @export
839
+ * @interface EncryptCardPaymentInfoResponseBody
840
+ */
841
+ export interface EncryptCardPaymentInfoResponseBody {
842
+ /**
843
+ * The encrypted full card number (PAN) — Base64 encoded.
844
+ * @type {string}
845
+ * @memberof EncryptCardPaymentInfoResponseBody
846
+ */
847
+ 'primaryAccountNumber': string;
848
+ /**
849
+ * The expiration date of the card in MMYY format.
850
+ * @type {string}
851
+ * @memberof EncryptCardPaymentInfoResponseBody
852
+ */
853
+ 'expirationDate': string;
854
+ /**
855
+ * The encrypted CVV2 (for Visa) or CVC2 (for Mastercard) value — Base64 encoded.
856
+ * @type {string}
857
+ * @memberof EncryptCardPaymentInfoResponseBody
858
+ */
859
+ 'cvv2': string;
860
+ }
861
+ /**
862
+ *
863
+ * @export
864
+ * @interface ErrorResponse
865
+ */
866
+ export interface ErrorResponse {
867
+ /**
868
+ * The problem type.
869
+ * @type {string}
870
+ * @memberof ErrorResponse
871
+ */
872
+ 'type'?: string;
873
+ /**
874
+ * The reason phrase of HttpStatus.
875
+ * @type {string}
876
+ * @memberof ErrorResponse
877
+ */
878
+ 'title'?: string;
879
+ /**
880
+ * HTTP problem status.
881
+ * @type {number}
882
+ * @memberof ErrorResponse
883
+ */
884
+ 'status'?: number;
885
+ /**
886
+ * The problem detail.
887
+ * @type {string}
888
+ * @memberof ErrorResponse
889
+ */
890
+ 'detail'?: string;
891
+ /**
892
+ * The request path.
893
+ * @type {string}
894
+ * @memberof ErrorResponse
895
+ */
896
+ 'instance'?: string;
897
+ /**
898
+ * Unique error identifier.
899
+ * @type {string}
900
+ * @memberof ErrorResponse
901
+ */
902
+ 'id'?: string;
903
+ /**
904
+ * Date-time when error occurred.
905
+ * @type {string}
906
+ * @memberof ErrorResponse
907
+ */
908
+ 'timestamp'?: string;
909
+ }
910
+ /**
911
+ *
912
+ * @export
913
+ * @interface MainCard
914
+ */
915
+ export interface MainCard {
916
+ /**
917
+ *
918
+ * @type {MultiApplicationProperties}
919
+ * @memberof MainCard
920
+ */
921
+ 'multiApplicationProperties'?: MultiApplicationProperties;
922
+ /**
923
+ * The program id that you want to associate with the new card you are creating.
924
+ * @type {string}
925
+ * @memberof MainCard
926
+ */
927
+ 'programId': string;
928
+ /**
929
+ * A unique code to identify the card configuration. Max character limit is 36.
930
+ * @type {string}
931
+ * @memberof MainCard
932
+ */
933
+ 'cardConfigurationCode': string;
934
+ /**
935
+ *
936
+ * @type {CreatePinStatus}
937
+ * @memberof MainCard
938
+ */
939
+ 'pinStatus'?: CreatePinStatus;
940
+ /**
941
+ * Unique identifier of the cardholder associated with the new card.
942
+ * @type {string}
943
+ * @memberof MainCard
944
+ */
945
+ 'cardholderId'?: string;
946
+ /**
947
+ * The expiration date-time of the card in UTC format. The time must be a value in te future.
948
+ * @type {string}
949
+ * @memberof MainCard
950
+ */
951
+ 'expirationTime'?: string;
952
+ /**
953
+ * Unique identifier of the account associated with the new card.
954
+ * @type {string}
955
+ * @memberof MainCard
956
+ */
957
+ 'accountId': string;
958
+ /**
959
+ *
960
+ * @type {CreatePlasticBody}
961
+ * @memberof MainCard
962
+ */
963
+ 'plastic'?: CreatePlasticBody;
964
+ /**
965
+ * A flag indicating whether automatic renewal is enabled or not.
966
+ * @type {boolean}
967
+ * @memberof MainCard
968
+ */
969
+ 'automaticRenewal'?: boolean;
970
+ /**
971
+ * The digital layout code for the card. Max character limit is 36.
972
+ * @type {string}
973
+ * @memberof MainCard
974
+ */
975
+ 'digitalLayoutCode'?: string;
976
+ /**
977
+ * You can include up to **30 additional key-value pairs** in the embossing file sent to the card manufacturer. - **Keys** must follow the pattern: `^[a-zA-Z0-9-]{1,36}$` (only letters, numbers, and hyphens, with a maximum length of 36 characters). - **Values** must follow the pattern: `^[a-zA-Z0-9|\\-_ +.@éàèùçâêîôûëïü\'/=]{1,1000}$`. Enfuce **does not perform any additional validation** on these key-value pairs beyond ensuring they match the specified patterns. These fields are intended for **storing data without further processing**. If you need to store a **complex structure**, you can **base64 encode** the value. The encoded value will be passed as entered, without modifications. ⚠ **Important:** Any usage of these fields should be agreed upon with the manufacturer.
978
+ * @type {{ [key: string]: string; }}
979
+ * @memberof MainCard
980
+ */
981
+ 'additionalValues'?: { [key: string]: string; };
982
+ /**
983
+ * Unique identifier of a fee configuration. When provided, this value overrides the program default. This feature must be enabled for the tenant; otherwise, this field can be left null and will not be used.
984
+ * @type {string}
985
+ * @memberof MainCard
986
+ */
987
+ 'feeConfigId'?: string;
988
+ }
989
+
990
+
991
+ /**
992
+ * Reason for manufacturing the card.
993
+ * @export
994
+ * @enum {string}
995
+ */
996
+
997
+ export const ManufacturingReason = {
998
+ NewCard: 'NEW_CARD',
999
+ ReplaceCard: 'REPLACE_CARD',
1000
+ ReissueCard: 'REISSUE_CARD',
1001
+ ReorderPin: 'REORDER_PIN',
1002
+ RenewCard: 'RENEW_CARD'
1003
+ } as const;
1004
+
1005
+ export type ManufacturingReason = typeof ManufacturingReason[keyof typeof ManufacturingReason];
1006
+
1007
+
1008
+ /**
1009
+ * - AWAITING_CRYPTO_VALUES - The card is created and is awaiting to receive cryptographic values before being sent to the card manufacturer. - CRYPTO_VALUES_PROCESSED - The card is awaiting to be included in the next embossing file. - SENT_TO_MANUFACTURER - The card has been successfully processed and sent to the manufacturer. - MANUFACTURING_ABORTED - The manufacturing process is aborted.
1010
+ * @export
1011
+ * @enum {string}
1012
+ */
1013
+
1014
+ export const ManufacturingStatus = {
1015
+ AwaitingCryptoValues: 'AWAITING_CRYPTO_VALUES',
1016
+ CryptoValuesProcessed: 'CRYPTO_VALUES_PROCESSED',
1017
+ SentToManufacturer: 'SENT_TO_MANUFACTURER',
1018
+ ManufacturingAborted: 'MANUFACTURING_ABORTED'
1019
+ } as const;
1020
+
1021
+ export type ManufacturingStatus = typeof ManufacturingStatus[keyof typeof ManufacturingStatus];
1022
+
1023
+
1024
+ /**
1025
+ *
1026
+ * @export
1027
+ * @interface MultiApplicationProperties
1028
+ */
1029
+ export interface MultiApplicationProperties {
1030
+ /**
1031
+ * Name of the application. Max character limit is 16. Only applicable to multi-application cards. Otherwise, the request will return 400 Bad Request.
1032
+ * @type {string}
1033
+ * @memberof MultiApplicationProperties
1034
+ */
1035
+ 'applicationName'?: string;
1036
+ /**
1037
+ * The index of the application
1038
+ * @type {number}
1039
+ * @memberof MultiApplicationProperties
1040
+ */
1041
+ 'applicationIndex'?: number;
1042
+ /**
1043
+ * The contact priority level for given card. Only applicable to multi-application cards. Otherwise, the request will return 400 Bad Request.
1044
+ * @type {number}
1045
+ * @memberof MultiApplicationProperties
1046
+ */
1047
+ 'contactPriorityLevel'?: number;
1048
+ /**
1049
+ * The contactless priority level of the given card. Only applicable to multi-application cards. Otherwise, the request will return 400 Bad Request.
1050
+ * @type {number}
1051
+ * @memberof MultiApplicationProperties
1052
+ */
1053
+ 'contactlessPriorityLevel'?: number;
1054
+ /**
1055
+ * Indicates whether the specific card would be printed or not. Only applicable to multi-application cards. Otherwise, the request will return 400 Bad Request.
1056
+ * @type {boolean}
1057
+ * @memberof MultiApplicationProperties
1058
+ */
1059
+ 'printed'?: boolean;
1060
+ /**
1061
+ * Whether the card should be visible in card terminal or not. Only applicable to multi-application cards. Otherwise, the request will return 400 Bad Request.
1062
+ * @type {boolean}
1063
+ * @memberof MultiApplicationProperties
1064
+ */
1065
+ 'chipEnabled'?: boolean;
1066
+ }
1067
+ /**
1068
+ *
1069
+ * @export
1070
+ * @interface PinControlInfoRequestBody
1071
+ */
1072
+ export interface PinControlInfoRequestBody {
1073
+ /**
1074
+ *
1075
+ * @type {PinScope}
1076
+ * @memberof PinControlInfoRequestBody
1077
+ */
1078
+ 'scope': PinScope;
1079
+ /**
1080
+ * The sequence number of the card version, this value is also known as PSN (pan sequence number)
1081
+ * @type {number}
1082
+ * @memberof PinControlInfoRequestBody
1083
+ */
1084
+ 'sequenceNumber'?: number;
1085
+ }
1086
+
1087
+
1088
+ /**
1089
+ *
1090
+ * @export
1091
+ * @interface PinControlInfoResponseBody
1092
+ */
1093
+ export interface PinControlInfoResponseBody {
1094
+ /**
1095
+ * The ID of this PIN Control access token.
1096
+ * @type {string}
1097
+ * @memberof PinControlInfoResponseBody
1098
+ */
1099
+ 'id': string;
1100
+ /**
1101
+ * The URL that the cardholder\'s mobile device webview should browse to for accessing the PIN.
1102
+ * @type {string}
1103
+ * @memberof PinControlInfoResponseBody
1104
+ */
1105
+ 'pinUrl'?: string;
1106
+ /**
1107
+ * The URL of the iframe for desktop browser based flows for accessing PIN.
1108
+ * @type {string}
1109
+ * @memberof PinControlInfoResponseBody
1110
+ */
1111
+ 'pinFrameUrl'?: string;
1112
+ }
1113
+ /**
1114
+ * Select the type of delivery you prefer for sending the card PIN. - MAIL - The card PIN would be sent via mail services. - COURIER - The card PIN would be sent via courier services. - EPIN - The card PIN would be sent digitally.
1115
+ * @export
1116
+ * @enum {string}
1117
+ */
1118
+
1119
+ export const PinDeliveryType = {
1120
+ Mail: 'MAIL',
1121
+ Courier: 'COURIER',
1122
+ Epin: 'EPIN'
1123
+ } as const;
1124
+
1125
+ export type PinDeliveryType = typeof PinDeliveryType[keyof typeof PinDeliveryType];
1126
+
1127
+
1128
+ /**
1129
+ * Describes the scope of the operation authorised by the user.
1130
+ * @export
1131
+ * @enum {string}
1132
+ */
1133
+
1134
+ export const PinScope = {
1135
+ ViewPin: 'VIEW_PIN',
1136
+ SetPin: 'SET_PIN',
1137
+ ChangePin: 'CHANGE_PIN'
1138
+ } as const;
1139
+
1140
+ export type PinScope = typeof PinScope[keyof typeof PinScope];
1141
+
1142
+
1143
+ /**
1144
+ * - GENERATED - A pin has been randomly generated for the card. - WAITING - A pin is waiting to be set on the card. - SET - A pin has been manually set on the card. - INHERITED - For card applications only. The pin status is inherited from the main card.
1145
+ * @export
1146
+ * @enum {string}
1147
+ */
1148
+
1149
+ export const PinStatus = {
1150
+ Generated: 'GENERATED',
1151
+ Waiting: 'WAITING',
1152
+ Set: 'SET',
1153
+ Inherited: 'INHERITED'
1154
+ } as const;
1155
+
1156
+ export type PinStatus = typeof PinStatus[keyof typeof PinStatus];
1157
+
1158
+
1159
+ /**
1160
+ *
1161
+ * @export
1162
+ * @interface Plastic
1163
+ */
1164
+ export interface Plastic {
1165
+ /**
1166
+ * The name to be embossed on the card. Max character limit is 26.
1167
+ * @type {string}
1168
+ * @memberof Plastic
1169
+ */
1170
+ 'embossingName'?: string;
1171
+ /**
1172
+ *
1173
+ * @type {Address}
1174
+ * @memberof Plastic
1175
+ */
1176
+ 'preferredCardAddress'?: Address;
1177
+ /**
1178
+ *
1179
+ * @type {CardDeliveryType}
1180
+ * @memberof Plastic
1181
+ */
1182
+ 'preferredCardDeliveryType': CardDeliveryType;
1183
+ /**
1184
+ *
1185
+ * @type {Address}
1186
+ * @memberof Plastic
1187
+ */
1188
+ 'preferredPinAddress'?: Address;
1189
+ /**
1190
+ *
1191
+ * @type {PinDeliveryType}
1192
+ * @memberof Plastic
1193
+ */
1194
+ 'preferredPinDeliveryType': PinDeliveryType;
1195
+ /**
1196
+ * Unique identifier of a resource.
1197
+ * @type {string}
1198
+ * @memberof Plastic
1199
+ */
1200
+ 'manufacturerId'?: string;
1201
+ /**
1202
+ * Unique code forwarded to the embossing house; the code identifies the plastic layout to be used for printing the new card. Ensure beforehand, the selected embossing house is aligned with the code used for each layout.
1203
+ * @type {string}
1204
+ * @memberof Plastic
1205
+ */
1206
+ 'externalLayoutCode'?: string;
1207
+ /**
1208
+ * The date and time when the card was created.
1209
+ * @type {string}
1210
+ * @memberof Plastic
1211
+ */
1212
+ 'createdAt'?: string;
1213
+ /**
1214
+ * The date and time when the object/entity was updated last time.
1215
+ * @type {string}
1216
+ * @memberof Plastic
1217
+ */
1218
+ 'updatedAt'?: string;
1219
+ }
1220
+
1221
+
1222
+ /**
1223
+ *
1224
+ * @export
1225
+ * @interface PlasticManufacturingHistoryResponse
1226
+ */
1227
+ export interface PlasticManufacturingHistoryResponse {
1228
+ /**
1229
+ *
1230
+ * @type {Array<PlasticManufacturingHistoryResponseManufacturingEntriesInner>}
1231
+ * @memberof PlasticManufacturingHistoryResponse
1232
+ */
1233
+ 'manufacturingEntries'?: Array<PlasticManufacturingHistoryResponseManufacturingEntriesInner>;
1234
+ }
1235
+ /**
1236
+ *
1237
+ * @export
1238
+ * @interface PlasticManufacturingHistoryResponseManufacturingEntriesInner
1239
+ */
1240
+ export interface PlasticManufacturingHistoryResponseManufacturingEntriesInner {
1241
+ /**
1242
+ * Unique identifer of a manufacturing request.
1243
+ * @type {string}
1244
+ * @memberof PlasticManufacturingHistoryResponseManufacturingEntriesInner
1245
+ */
1246
+ 'id'?: string;
1247
+ /**
1248
+ * The date and time when the card was created.
1249
+ * @type {string}
1250
+ * @memberof PlasticManufacturingHistoryResponseManufacturingEntriesInner
1251
+ */
1252
+ 'createdAt'?: string;
1253
+ /**
1254
+ * The date and time when the card was sent to the manufacturer
1255
+ * @type {string}
1256
+ * @memberof PlasticManufacturingHistoryResponseManufacturingEntriesInner
1257
+ */
1258
+ 'sentToManufacturerAt'?: string;
1259
+ /**
1260
+ * Unique identifier of the manufacturer to whom the the card data wants sent for printing the physical card.
1261
+ * @type {string}
1262
+ * @memberof PlasticManufacturingHistoryResponseManufacturingEntriesInner
1263
+ */
1264
+ 'manufacturerId'?: string;
1265
+ /**
1266
+ * The sequence number of the card version, this value is also known as PSN (pan sequence number)
1267
+ * @type {number}
1268
+ * @memberof PlasticManufacturingHistoryResponseManufacturingEntriesInner
1269
+ */
1270
+ 'cardVersionSequenceNumber'?: number;
1271
+ /**
1272
+ *
1273
+ * @type {ManufacturingReason}
1274
+ * @memberof PlasticManufacturingHistoryResponseManufacturingEntriesInner
1275
+ */
1276
+ 'manufacturingReason'?: ManufacturingReason;
1277
+ /**
1278
+ *
1279
+ * @type {ManufacturingStatus}
1280
+ * @memberof PlasticManufacturingHistoryResponseManufacturingEntriesInner
1281
+ */
1282
+ 'status'?: ManufacturingStatus;
1283
+ /**
1284
+ * The json data that was included in the plastic manufacturer file
1285
+ * @type {string}
1286
+ * @memberof PlasticManufacturingHistoryResponseManufacturingEntriesInner
1287
+ */
1288
+ 'data'?: string;
1289
+ }
1290
+
1291
+
1292
+ /**
1293
+ *
1294
+ * @export
1295
+ * @interface ReissueCardBody
1296
+ */
1297
+ export interface ReissueCardBody {
1298
+ /**
1299
+ *
1300
+ * @type {ChangePinStatus}
1301
+ * @memberof ReissueCardBody
1302
+ */
1303
+ 'pinStatus'?: ChangePinStatus;
1304
+ }
1305
+
1306
+
1307
+ /**
1308
+ *
1309
+ * @export
1310
+ * @interface ReplaceCardBody
1311
+ */
1312
+ export interface ReplaceCardBody {
1313
+ /**
1314
+ * Description of why the card should be replaced.
1315
+ * @type {string}
1316
+ * @memberof ReplaceCardBody
1317
+ */
1318
+ 'description'?: string;
1319
+ /**
1320
+ *
1321
+ * @type {ChangePinStatus}
1322
+ * @memberof ReplaceCardBody
1323
+ */
1324
+ 'pinStatus'?: ChangePinStatus;
1325
+ }
1326
+
1327
+
1328
+ /**
1329
+ *
1330
+ * @export
1331
+ * @interface ResourceResponse
1332
+ */
1333
+ export interface ResourceResponse {
1334
+ /**
1335
+ * A description of the response returned.
1336
+ * @type {string}
1337
+ * @memberof ResourceResponse
1338
+ */
1339
+ 'description'?: string;
1340
+ /**
1341
+ * A unique identifier assigned to identify the endpoint request.
1342
+ * @type {string}
1343
+ * @memberof ResourceResponse
1344
+ */
1345
+ 'id'?: string;
1346
+ }
1347
+ /**
1348
+ *
1349
+ * @export
1350
+ * @interface UpdateCardBody
1351
+ */
1352
+ export interface UpdateCardBody {
1353
+ /**
1354
+ * Whether the card should be visible in card terminal or not. Only applicable to multi-application cards. Otherwise, the request will return 400 Bad Request.
1355
+ * @type {boolean}
1356
+ * @memberof UpdateCardBody
1357
+ */
1358
+ 'chipEnabled'?: boolean;
1359
+ /**
1360
+ * The digital layout code for the card. Max character limit is 36.
1361
+ * @type {string}
1362
+ * @memberof UpdateCardBody
1363
+ */
1364
+ 'digitalLayoutCode'?: string;
1365
+ /**
1366
+ * Name of the application. Max character limit is 16. Only applicable to multi-application cards. Otherwise, the request will return 400 Bad Request.
1367
+ * @type {string}
1368
+ * @memberof UpdateCardBody
1369
+ */
1370
+ 'applicationName'?: string;
1371
+ /**
1372
+ * The contact priority level for given card. Only applicable to multi-application cards. Otherwise, the request will return 400 Bad Request.
1373
+ * @type {number}
1374
+ * @memberof UpdateCardBody
1375
+ */
1376
+ 'contactPriorityLevel'?: number;
1377
+ /**
1378
+ * The contactless priority level of the given card. Only applicable to multi-application cards. Otherwise, the request will return 400 Bad Request.
1379
+ * @type {number}
1380
+ * @memberof UpdateCardBody
1381
+ */
1382
+ 'contactlessPriorityLevel'?: number;
1383
+ /**
1384
+ * Indicates whether the specific card would be printed or not. Only applicable to multi-application cards. Otherwise, the request will return 400 Bad Request.
1385
+ * @type {boolean}
1386
+ * @memberof UpdateCardBody
1387
+ */
1388
+ 'printed'?: boolean;
1389
+ /**
1390
+ * Unique identifier of a resource.
1391
+ * @type {string}
1392
+ * @memberof UpdateCardBody
1393
+ */
1394
+ 'cardholderId'?: string;
1395
+ /**
1396
+ * Unique identifier of an account.
1397
+ * @type {string}
1398
+ * @memberof UpdateCardBody
1399
+ */
1400
+ 'accountId'?: string;
1401
+ /**
1402
+ * A flag indicating whether automatic renewal is enabled or not.
1403
+ * @type {boolean}
1404
+ * @memberof UpdateCardBody
1405
+ */
1406
+ 'automaticRenewal'?: boolean;
1407
+ /**
1408
+ *
1409
+ * @type {UpdatePlasticBody}
1410
+ * @memberof UpdateCardBody
1411
+ */
1412
+ 'plastic'?: UpdatePlasticBody;
1413
+ /**
1414
+ *
1415
+ * @type {CardStatus}
1416
+ * @memberof UpdateCardBody
1417
+ */
1418
+ 'cardStatus'?: CardStatus;
1419
+ /**
1420
+ * If set to true, the card status change will impact the status of all tokens. If set to false, the card status change will not impact the status of all tokens.
1421
+ * @type {boolean}
1422
+ * @memberof UpdateCardBody
1423
+ */
1424
+ 'impactTokenStatus'?: boolean;
1425
+ /**
1426
+ *
1427
+ * @type {UpdatePinStatus}
1428
+ * @memberof UpdateCardBody
1429
+ */
1430
+ 'pinStatus'?: UpdatePinStatus;
1431
+ /**
1432
+ * You can include up to **30 additional key-value pairs** in the embossing file sent to the card manufacturer. - **Keys** must follow the pattern: `^[a-zA-Z0-9-]{1,36}$` (only letters, numbers, and hyphens, with a maximum length of 36 characters). - **Values** must follow the pattern: `^[a-zA-Z0-9|\\-_ +.@éàèùçâêîôûëïü\'/=]{1,1000}$`. Enfuce **does not perform any additional validation** on these key-value pairs beyond ensuring they match the specified patterns. These fields are intended for **storing data without further processing**. If you need to store a **complex structure**, you can **base64 encode** the value. The encoded value will be passed as entered, without modifications. ⚠ **Important:** Any usage of these fields should be agreed upon with the manufacturer.
1433
+ * @type {{ [key: string]: string; }}
1434
+ * @memberof UpdateCardBody
1435
+ */
1436
+ 'additionalValues'?: { [key: string]: string; };
1437
+ /**
1438
+ * Unique identifier of a fee configuration. When provided, this value overrides the program default. This feature must be enabled for the tenant; otherwise, this field can be left null and will not be used.
1439
+ * @type {string}
1440
+ * @memberof UpdateCardBody
1441
+ */
1442
+ 'feeConfigId'?: string | null;
1443
+ }
1444
+
1445
+
1446
+ /**
1447
+ * - GENERATED - A pin should be randomly generated for the card.
1448
+ * @export
1449
+ * @enum {string}
1450
+ */
1451
+
1452
+ export const UpdatePinStatus = {
1453
+ Generated: 'GENERATED'
1454
+ } as const;
1455
+
1456
+ export type UpdatePinStatus = typeof UpdatePinStatus[keyof typeof UpdatePinStatus];
1457
+
1458
+
1459
+ /**
1460
+ *
1461
+ * @export
1462
+ * @interface UpdatePlasticBody
1463
+ */
1464
+ export interface UpdatePlasticBody {
1465
+ /**
1466
+ * The name to be embossed on the card. Max character limit is 26.
1467
+ * @type {string}
1468
+ * @memberof UpdatePlasticBody
1469
+ */
1470
+ 'embossingName'?: string;
1471
+ /**
1472
+ *
1473
+ * @type {Address}
1474
+ * @memberof UpdatePlasticBody
1475
+ */
1476
+ 'preferredCardAddress'?: Address;
1477
+ /**
1478
+ *
1479
+ * @type {CardDeliveryType}
1480
+ * @memberof UpdatePlasticBody
1481
+ */
1482
+ 'preferredCardDeliveryType'?: CardDeliveryType;
1483
+ /**
1484
+ *
1485
+ * @type {Address}
1486
+ * @memberof UpdatePlasticBody
1487
+ */
1488
+ 'preferredPinAddress'?: Address;
1489
+ /**
1490
+ *
1491
+ * @type {PinDeliveryType}
1492
+ * @memberof UpdatePlasticBody
1493
+ */
1494
+ 'preferredPinDeliveryType'?: PinDeliveryType;
1495
+ /**
1496
+ * Unique identifier of an entity.
1497
+ * @type {string}
1498
+ * @memberof UpdatePlasticBody
1499
+ */
1500
+ 'manufacturerId'?: string | null;
1501
+ /**
1502
+ * Unique code forwarded to the embossing house; the code identifies the plastic layout to be used for printing the new card. Ensure beforehand, the selected embossing house is aligned with the code used for each layout.
1503
+ * @type {string}
1504
+ * @memberof UpdatePlasticBody
1505
+ */
1506
+ 'externalLayoutCode'?: string;
1507
+ }
1508
+
1509
+
1510
+
1511
+ /**
1512
+ * CreateCardApi - axios parameter creator
1513
+ * @export
1514
+ */
1515
+ export const CreateCardApiAxiosParamCreator = function (configuration?: Configuration) {
1516
+ return {
1517
+ /**
1518
+ * Send a request to this endpoint to create a new card.
1519
+ * @summary Create Card
1520
+ * @param {CreateCardRequest} createCardRequest
1521
+ * @param {string} [xAuditUser] Optional audit user header
1522
+ * @param {string} [xIdempotencyKey] Idempotency key for the request.
1523
+ * @param {*} [options] Override http request option.
1524
+ * @throws {RequiredError}
1525
+ */
1526
+ createCard: async (createCardRequest: CreateCardRequest, xAuditUser?: string, xIdempotencyKey?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
1527
+ // verify required parameter 'createCardRequest' is not null or undefined
1528
+ assertParamExists('createCard', 'createCardRequest', createCardRequest)
1529
+ const localVarPath = `/v1/cards`;
1530
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
1531
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
1532
+ let baseOptions;
1533
+ if (configuration) {
1534
+ baseOptions = configuration.baseOptions;
1535
+ }
1536
+
1537
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
1538
+ const localVarHeaderParameter = {} as any;
1539
+ const localVarQueryParameter = {} as any;
1540
+
1541
+ // authentication bearerAuth required
1542
+ // http bearer authentication required
1543
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
1544
+
1545
+
1546
+
1547
+ localVarHeaderParameter['Content-Type'] = 'application/json';
1548
+
1549
+ if (xAuditUser != null) {
1550
+ localVarHeaderParameter['x-audit-user'] = String(xAuditUser);
1551
+ }
1552
+ if (xIdempotencyKey != null) {
1553
+ localVarHeaderParameter['x-idempotency-key'] = String(xIdempotencyKey);
1554
+ }
1555
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
1556
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1557
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
1558
+ localVarRequestOptions.data = serializeDataIfNeeded(createCardRequest, localVarRequestOptions, configuration)
1559
+
1560
+ return {
1561
+ url: toPathString(localVarUrlObj),
1562
+ options: localVarRequestOptions,
1563
+ };
1564
+ },
1565
+ }
1566
+ };
1567
+
1568
+ /**
1569
+ * CreateCardApi - functional programming interface
1570
+ * @export
1571
+ */
1572
+ export const CreateCardApiFp = function(configuration?: Configuration) {
1573
+ const localVarAxiosParamCreator = CreateCardApiAxiosParamCreator(configuration)
1574
+ return {
1575
+ /**
1576
+ * Send a request to this endpoint to create a new card.
1577
+ * @summary Create Card
1578
+ * @param {CreateCardRequest} createCardRequest
1579
+ * @param {string} [xAuditUser] Optional audit user header
1580
+ * @param {string} [xIdempotencyKey] Idempotency key for the request.
1581
+ * @param {*} [options] Override http request option.
1582
+ * @throws {RequiredError}
1583
+ */
1584
+ async createCard(createCardRequest: CreateCardRequest, xAuditUser?: string, xIdempotencyKey?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateCard201Response>> {
1585
+ const localVarAxiosArgs = await localVarAxiosParamCreator.createCard(createCardRequest, xAuditUser, xIdempotencyKey, options);
1586
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1587
+ const localVarOperationServerBasePath = operationServerMap['CreateCardApi.createCard']?.[localVarOperationServerIndex]?.url;
1588
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1589
+ },
1590
+ }
1591
+ };
1592
+
1593
+ /**
1594
+ * CreateCardApi - factory interface
1595
+ * @export
1596
+ */
1597
+ export const CreateCardApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
1598
+ const localVarFp = CreateCardApiFp(configuration)
1599
+ return {
1600
+ /**
1601
+ * Send a request to this endpoint to create a new card.
1602
+ * @summary Create Card
1603
+ * @param {CreateCardRequest} createCardRequest
1604
+ * @param {string} [xAuditUser] Optional audit user header
1605
+ * @param {string} [xIdempotencyKey] Idempotency key for the request.
1606
+ * @param {*} [options] Override http request option.
1607
+ * @throws {RequiredError}
1608
+ */
1609
+ createCard(createCardRequest: CreateCardRequest, xAuditUser?: string, xIdempotencyKey?: string, options?: RawAxiosRequestConfig): AxiosPromise<CreateCard201Response> {
1610
+ return localVarFp.createCard(createCardRequest, xAuditUser, xIdempotencyKey, options).then((request) => request(axios, basePath));
1611
+ },
1612
+ };
1613
+ };
1614
+
1615
+ /**
1616
+ * CreateCardApi - object-oriented interface
1617
+ * @export
1618
+ * @class CreateCardApi
1619
+ * @extends {BaseAPI}
1620
+ */
1621
+ export class CreateCardApi extends BaseAPI {
1622
+ /**
1623
+ * Send a request to this endpoint to create a new card.
1624
+ * @summary Create Card
1625
+ * @param {CreateCardRequest} createCardRequest
1626
+ * @param {string} [xAuditUser] Optional audit user header
1627
+ * @param {string} [xIdempotencyKey] Idempotency key for the request.
1628
+ * @param {*} [options] Override http request option.
1629
+ * @throws {RequiredError}
1630
+ * @memberof CreateCardApi
1631
+ */
1632
+ public createCard(createCardRequest: CreateCardRequest, xAuditUser?: string, xIdempotencyKey?: string, options?: RawAxiosRequestConfig) {
1633
+ return CreateCardApiFp(this.configuration).createCard(createCardRequest, xAuditUser, xIdempotencyKey, options).then((request) => request(this.axios, this.basePath));
1634
+ }
1635
+ }
1636
+
1637
+
1638
+
1639
+ /**
1640
+ * CreatePINControlAccessTokenApi - axios parameter creator
1641
+ * @export
1642
+ */
1643
+ export const CreatePINControlAccessTokenApiAxiosParamCreator = function (configuration?: Configuration) {
1644
+ return {
1645
+ /**
1646
+ * Send a request to this endpoint to generate a PIN control access token for a specific card version. The requested `scope` determines which PIN operation the token authorises: `VIEW_PIN`, `SET_PIN` or `CHANGE_PIN`. If no `sequenceNumber` is provided, the latest card version is used. A successful response returns the token `id`, a `pinUrl` for the mobile device webview and a `pinFrameUrl` for the desktop browser iframe. Both URLs are specific to the requested `scope`. The token is valid for 30 seconds. For the mobile webview flow, the device sends another API request — a `POST` to the `pinUrl`, including the token `id` in a parameter named `controlId`. For the desktop browser flow, open an iframe to the `pinFrameUrl`. After the iframe has loaded, the browser makes a `window.postMessage()` call to the iframe. The message object contains an `operation` field (`view-pin` for the `VIEW_PIN` scope, `set-pin` for the `SET_PIN` and `CHANGE_PIN` scopes) and a `controlId` field (the token `id`). Note that you must use `set-pin` as the `operation` for the `CHANGE_PIN` scope as well.
1647
+ * @summary Request PIN Control Access Token
1648
+ * @param {string} id Unique identifier of the card for which you want to access the PIN.
1649
+ * @param {PinControlInfoRequestBody} pinControlInfoRequestBody
1650
+ * @param {string} [xAuditUser] Optional audit user header
1651
+ * @param {*} [options] Override http request option.
1652
+ * @throws {RequiredError}
1653
+ */
1654
+ createPinControl: async (id: string, pinControlInfoRequestBody: PinControlInfoRequestBody, xAuditUser?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
1655
+ // verify required parameter 'id' is not null or undefined
1656
+ assertParamExists('createPinControl', 'id', id)
1657
+ // verify required parameter 'pinControlInfoRequestBody' is not null or undefined
1658
+ assertParamExists('createPinControl', 'pinControlInfoRequestBody', pinControlInfoRequestBody)
1659
+ const localVarPath = `/v1/cards/{id}/pinControl`
1660
+ .replace(`{${"id"}}`, encodeURIComponent(String(id)));
1661
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
1662
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
1663
+ let baseOptions;
1664
+ if (configuration) {
1665
+ baseOptions = configuration.baseOptions;
1666
+ }
1667
+
1668
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
1669
+ const localVarHeaderParameter = {} as any;
1670
+ const localVarQueryParameter = {} as any;
1671
+
1672
+ // authentication bearerAuth required
1673
+ // http bearer authentication required
1674
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
1675
+
1676
+
1677
+
1678
+ localVarHeaderParameter['Content-Type'] = 'application/json';
1679
+
1680
+ if (xAuditUser != null) {
1681
+ localVarHeaderParameter['x-audit-user'] = String(xAuditUser);
1682
+ }
1683
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
1684
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1685
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
1686
+ localVarRequestOptions.data = serializeDataIfNeeded(pinControlInfoRequestBody, localVarRequestOptions, configuration)
1687
+
1688
+ return {
1689
+ url: toPathString(localVarUrlObj),
1690
+ options: localVarRequestOptions,
1691
+ };
1692
+ },
1693
+ }
1694
+ };
1695
+
1696
+ /**
1697
+ * CreatePINControlAccessTokenApi - functional programming interface
1698
+ * @export
1699
+ */
1700
+ export const CreatePINControlAccessTokenApiFp = function(configuration?: Configuration) {
1701
+ const localVarAxiosParamCreator = CreatePINControlAccessTokenApiAxiosParamCreator(configuration)
1702
+ return {
1703
+ /**
1704
+ * Send a request to this endpoint to generate a PIN control access token for a specific card version. The requested `scope` determines which PIN operation the token authorises: `VIEW_PIN`, `SET_PIN` or `CHANGE_PIN`. If no `sequenceNumber` is provided, the latest card version is used. A successful response returns the token `id`, a `pinUrl` for the mobile device webview and a `pinFrameUrl` for the desktop browser iframe. Both URLs are specific to the requested `scope`. The token is valid for 30 seconds. For the mobile webview flow, the device sends another API request — a `POST` to the `pinUrl`, including the token `id` in a parameter named `controlId`. For the desktop browser flow, open an iframe to the `pinFrameUrl`. After the iframe has loaded, the browser makes a `window.postMessage()` call to the iframe. The message object contains an `operation` field (`view-pin` for the `VIEW_PIN` scope, `set-pin` for the `SET_PIN` and `CHANGE_PIN` scopes) and a `controlId` field (the token `id`). Note that you must use `set-pin` as the `operation` for the `CHANGE_PIN` scope as well.
1705
+ * @summary Request PIN Control Access Token
1706
+ * @param {string} id Unique identifier of the card for which you want to access the PIN.
1707
+ * @param {PinControlInfoRequestBody} pinControlInfoRequestBody
1708
+ * @param {string} [xAuditUser] Optional audit user header
1709
+ * @param {*} [options] Override http request option.
1710
+ * @throws {RequiredError}
1711
+ */
1712
+ async createPinControl(id: string, pinControlInfoRequestBody: PinControlInfoRequestBody, xAuditUser?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PinControlInfoResponseBody>> {
1713
+ const localVarAxiosArgs = await localVarAxiosParamCreator.createPinControl(id, pinControlInfoRequestBody, xAuditUser, options);
1714
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1715
+ const localVarOperationServerBasePath = operationServerMap['CreatePINControlAccessTokenApi.createPinControl']?.[localVarOperationServerIndex]?.url;
1716
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1717
+ },
1718
+ }
1719
+ };
1720
+
1721
+ /**
1722
+ * CreatePINControlAccessTokenApi - factory interface
1723
+ * @export
1724
+ */
1725
+ export const CreatePINControlAccessTokenApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
1726
+ const localVarFp = CreatePINControlAccessTokenApiFp(configuration)
1727
+ return {
1728
+ /**
1729
+ * Send a request to this endpoint to generate a PIN control access token for a specific card version. The requested `scope` determines which PIN operation the token authorises: `VIEW_PIN`, `SET_PIN` or `CHANGE_PIN`. If no `sequenceNumber` is provided, the latest card version is used. A successful response returns the token `id`, a `pinUrl` for the mobile device webview and a `pinFrameUrl` for the desktop browser iframe. Both URLs are specific to the requested `scope`. The token is valid for 30 seconds. For the mobile webview flow, the device sends another API request — a `POST` to the `pinUrl`, including the token `id` in a parameter named `controlId`. For the desktop browser flow, open an iframe to the `pinFrameUrl`. After the iframe has loaded, the browser makes a `window.postMessage()` call to the iframe. The message object contains an `operation` field (`view-pin` for the `VIEW_PIN` scope, `set-pin` for the `SET_PIN` and `CHANGE_PIN` scopes) and a `controlId` field (the token `id`). Note that you must use `set-pin` as the `operation` for the `CHANGE_PIN` scope as well.
1730
+ * @summary Request PIN Control Access Token
1731
+ * @param {string} id Unique identifier of the card for which you want to access the PIN.
1732
+ * @param {PinControlInfoRequestBody} pinControlInfoRequestBody
1733
+ * @param {string} [xAuditUser] Optional audit user header
1734
+ * @param {*} [options] Override http request option.
1735
+ * @throws {RequiredError}
1736
+ */
1737
+ createPinControl(id: string, pinControlInfoRequestBody: PinControlInfoRequestBody, xAuditUser?: string, options?: RawAxiosRequestConfig): AxiosPromise<PinControlInfoResponseBody> {
1738
+ return localVarFp.createPinControl(id, pinControlInfoRequestBody, xAuditUser, options).then((request) => request(axios, basePath));
1739
+ },
1740
+ };
1741
+ };
1742
+
1743
+ /**
1744
+ * CreatePINControlAccessTokenApi - object-oriented interface
1745
+ * @export
1746
+ * @class CreatePINControlAccessTokenApi
1747
+ * @extends {BaseAPI}
1748
+ */
1749
+ export class CreatePINControlAccessTokenApi extends BaseAPI {
1750
+ /**
1751
+ * Send a request to this endpoint to generate a PIN control access token for a specific card version. The requested `scope` determines which PIN operation the token authorises: `VIEW_PIN`, `SET_PIN` or `CHANGE_PIN`. If no `sequenceNumber` is provided, the latest card version is used. A successful response returns the token `id`, a `pinUrl` for the mobile device webview and a `pinFrameUrl` for the desktop browser iframe. Both URLs are specific to the requested `scope`. The token is valid for 30 seconds. For the mobile webview flow, the device sends another API request — a `POST` to the `pinUrl`, including the token `id` in a parameter named `controlId`. For the desktop browser flow, open an iframe to the `pinFrameUrl`. After the iframe has loaded, the browser makes a `window.postMessage()` call to the iframe. The message object contains an `operation` field (`view-pin` for the `VIEW_PIN` scope, `set-pin` for the `SET_PIN` and `CHANGE_PIN` scopes) and a `controlId` field (the token `id`). Note that you must use `set-pin` as the `operation` for the `CHANGE_PIN` scope as well.
1752
+ * @summary Request PIN Control Access Token
1753
+ * @param {string} id Unique identifier of the card for which you want to access the PIN.
1754
+ * @param {PinControlInfoRequestBody} pinControlInfoRequestBody
1755
+ * @param {string} [xAuditUser] Optional audit user header
1756
+ * @param {*} [options] Override http request option.
1757
+ * @throws {RequiredError}
1758
+ * @memberof CreatePINControlAccessTokenApi
1759
+ */
1760
+ public createPinControl(id: string, pinControlInfoRequestBody: PinControlInfoRequestBody, xAuditUser?: string, options?: RawAxiosRequestConfig) {
1761
+ return CreatePINControlAccessTokenApiFp(this.configuration).createPinControl(id, pinControlInfoRequestBody, xAuditUser, options).then((request) => request(this.axios, this.basePath));
1762
+ }
1763
+ }
1764
+
1765
+
1766
+
1767
+ /**
1768
+ * GetCardApi - axios parameter creator
1769
+ * @export
1770
+ */
1771
+ export const GetCardApiAxiosParamCreator = function (configuration?: Configuration) {
1772
+ return {
1773
+ /**
1774
+ *
1775
+ * @summary Get Card
1776
+ * @param {string} id Unique identifier of the card you want to retrieve.
1777
+ * @param {string} [xAuditUser] Optional audit user header
1778
+ * @param {*} [options] Override http request option.
1779
+ * @throws {RequiredError}
1780
+ */
1781
+ getCard: async (id: string, xAuditUser?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
1782
+ // verify required parameter 'id' is not null or undefined
1783
+ assertParamExists('getCard', 'id', id)
1784
+ const localVarPath = `/v1/cards/{id}`
1785
+ .replace(`{${"id"}}`, encodeURIComponent(String(id)));
1786
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
1787
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
1788
+ let baseOptions;
1789
+ if (configuration) {
1790
+ baseOptions = configuration.baseOptions;
1791
+ }
1792
+
1793
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
1794
+ const localVarHeaderParameter = {} as any;
1795
+ const localVarQueryParameter = {} as any;
1796
+
1797
+ // authentication bearerAuth required
1798
+ // http bearer authentication required
1799
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
1800
+
1801
+
1802
+
1803
+ if (xAuditUser != null) {
1804
+ localVarHeaderParameter['x-audit-user'] = String(xAuditUser);
1805
+ }
1806
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
1807
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1808
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
1809
+
1810
+ return {
1811
+ url: toPathString(localVarUrlObj),
1812
+ options: localVarRequestOptions,
1813
+ };
1814
+ },
1815
+ /**
1816
+ * Send a request to this endpoint when the cardholder wants to retrieve card data, such as PAN, expiry and CVV2/CVC2. If no sequence number is specified, the latest card version is used by default. Only card versions not in CLOSED status are allowed.
1817
+ * @summary Initiate Card Data Retrieval
1818
+ * @param {string} id Unique identifier of the card.
1819
+ * @param {string} [xAuditUser] Optional audit user header
1820
+ * @param {ControlTokenRequestBody} [controlTokenRequestBody]
1821
+ * @param {*} [options] Override http request option.
1822
+ * @throws {RequiredError}
1823
+ */
1824
+ getCardDataControlToken: async (id: string, xAuditUser?: string, controlTokenRequestBody?: ControlTokenRequestBody, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
1825
+ // verify required parameter 'id' is not null or undefined
1826
+ assertParamExists('getCardDataControlToken', 'id', id)
1827
+ const localVarPath = `/v1/cards/{id}/controlToken`
1828
+ .replace(`{${"id"}}`, encodeURIComponent(String(id)));
1829
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
1830
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
1831
+ let baseOptions;
1832
+ if (configuration) {
1833
+ baseOptions = configuration.baseOptions;
1834
+ }
1835
+
1836
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
1837
+ const localVarHeaderParameter = {} as any;
1838
+ const localVarQueryParameter = {} as any;
1839
+
1840
+ // authentication bearerAuth required
1841
+ // http bearer authentication required
1842
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
1843
+
1844
+
1845
+
1846
+ localVarHeaderParameter['Content-Type'] = 'application/json';
1847
+
1848
+ if (xAuditUser != null) {
1849
+ localVarHeaderParameter['x-audit-user'] = String(xAuditUser);
1850
+ }
1851
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
1852
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1853
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
1854
+ localVarRequestOptions.data = serializeDataIfNeeded(controlTokenRequestBody, localVarRequestOptions, configuration)
1855
+
1856
+ return {
1857
+ url: toPathString(localVarUrlObj),
1858
+ options: localVarRequestOptions,
1859
+ };
1860
+ },
1861
+ /**
1862
+ * Send a request to this endpoint to return all card applications for a specific main card. If the main card does not exist, an empty array is returned.
1863
+ * @summary Get Card Applications for Main Card
1864
+ * @param {string} mainCardId Unique identifier of the main card for which you want to retrieve the list of card applications.
1865
+ * @param {string} [xAuditUser] Optional audit user header
1866
+ * @param {*} [options] Override http request option.
1867
+ * @throws {RequiredError}
1868
+ */
1869
+ getCards: async (mainCardId: string, xAuditUser?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
1870
+ // verify required parameter 'mainCardId' is not null or undefined
1871
+ assertParamExists('getCards', 'mainCardId', mainCardId)
1872
+ const localVarPath = `/v1/cards`;
1873
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
1874
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
1875
+ let baseOptions;
1876
+ if (configuration) {
1877
+ baseOptions = configuration.baseOptions;
1878
+ }
1879
+
1880
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
1881
+ const localVarHeaderParameter = {} as any;
1882
+ const localVarQueryParameter = {} as any;
1883
+
1884
+ // authentication bearerAuth required
1885
+ // http bearer authentication required
1886
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
1887
+
1888
+ if (mainCardId !== undefined) {
1889
+ localVarQueryParameter['mainCardId'] = mainCardId;
1890
+ }
1891
+
1892
+
1893
+
1894
+ if (xAuditUser != null) {
1895
+ localVarHeaderParameter['x-audit-user'] = String(xAuditUser);
1896
+ }
1897
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
1898
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1899
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
1900
+
1901
+ return {
1902
+ url: toPathString(localVarUrlObj),
1903
+ options: localVarRequestOptions,
1904
+ };
1905
+ },
1906
+ }
1907
+ };
1908
+
1909
+ /**
1910
+ * GetCardApi - functional programming interface
1911
+ * @export
1912
+ */
1913
+ export const GetCardApiFp = function(configuration?: Configuration) {
1914
+ const localVarAxiosParamCreator = GetCardApiAxiosParamCreator(configuration)
1915
+ return {
1916
+ /**
1917
+ *
1918
+ * @summary Get Card
1919
+ * @param {string} id Unique identifier of the card you want to retrieve.
1920
+ * @param {string} [xAuditUser] Optional audit user header
1921
+ * @param {*} [options] Override http request option.
1922
+ * @throws {RequiredError}
1923
+ */
1924
+ async getCard(id: string, xAuditUser?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CardResponse>> {
1925
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getCard(id, xAuditUser, options);
1926
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1927
+ const localVarOperationServerBasePath = operationServerMap['GetCardApi.getCard']?.[localVarOperationServerIndex]?.url;
1928
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1929
+ },
1930
+ /**
1931
+ * Send a request to this endpoint when the cardholder wants to retrieve card data, such as PAN, expiry and CVV2/CVC2. If no sequence number is specified, the latest card version is used by default. Only card versions not in CLOSED status are allowed.
1932
+ * @summary Initiate Card Data Retrieval
1933
+ * @param {string} id Unique identifier of the card.
1934
+ * @param {string} [xAuditUser] Optional audit user header
1935
+ * @param {ControlTokenRequestBody} [controlTokenRequestBody]
1936
+ * @param {*} [options] Override http request option.
1937
+ * @throws {RequiredError}
1938
+ */
1939
+ async getCardDataControlToken(id: string, xAuditUser?: string, controlTokenRequestBody?: ControlTokenRequestBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CardDataControlTokenResponseBody>> {
1940
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getCardDataControlToken(id, xAuditUser, controlTokenRequestBody, options);
1941
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1942
+ const localVarOperationServerBasePath = operationServerMap['GetCardApi.getCardDataControlToken']?.[localVarOperationServerIndex]?.url;
1943
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1944
+ },
1945
+ /**
1946
+ * Send a request to this endpoint to return all card applications for a specific main card. If the main card does not exist, an empty array is returned.
1947
+ * @summary Get Card Applications for Main Card
1948
+ * @param {string} mainCardId Unique identifier of the main card for which you want to retrieve the list of card applications.
1949
+ * @param {string} [xAuditUser] Optional audit user header
1950
+ * @param {*} [options] Override http request option.
1951
+ * @throws {RequiredError}
1952
+ */
1953
+ async getCards(mainCardId: string, xAuditUser?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<CardResponse>>> {
1954
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getCards(mainCardId, xAuditUser, options);
1955
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1956
+ const localVarOperationServerBasePath = operationServerMap['GetCardApi.getCards']?.[localVarOperationServerIndex]?.url;
1957
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1958
+ },
1959
+ }
1960
+ };
1961
+
1962
+ /**
1963
+ * GetCardApi - factory interface
1964
+ * @export
1965
+ */
1966
+ export const GetCardApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
1967
+ const localVarFp = GetCardApiFp(configuration)
1968
+ return {
1969
+ /**
1970
+ *
1971
+ * @summary Get Card
1972
+ * @param {string} id Unique identifier of the card you want to retrieve.
1973
+ * @param {string} [xAuditUser] Optional audit user header
1974
+ * @param {*} [options] Override http request option.
1975
+ * @throws {RequiredError}
1976
+ */
1977
+ getCard(id: string, xAuditUser?: string, options?: RawAxiosRequestConfig): AxiosPromise<CardResponse> {
1978
+ return localVarFp.getCard(id, xAuditUser, options).then((request) => request(axios, basePath));
1979
+ },
1980
+ /**
1981
+ * Send a request to this endpoint when the cardholder wants to retrieve card data, such as PAN, expiry and CVV2/CVC2. If no sequence number is specified, the latest card version is used by default. Only card versions not in CLOSED status are allowed.
1982
+ * @summary Initiate Card Data Retrieval
1983
+ * @param {string} id Unique identifier of the card.
1984
+ * @param {string} [xAuditUser] Optional audit user header
1985
+ * @param {ControlTokenRequestBody} [controlTokenRequestBody]
1986
+ * @param {*} [options] Override http request option.
1987
+ * @throws {RequiredError}
1988
+ */
1989
+ getCardDataControlToken(id: string, xAuditUser?: string, controlTokenRequestBody?: ControlTokenRequestBody, options?: RawAxiosRequestConfig): AxiosPromise<CardDataControlTokenResponseBody> {
1990
+ return localVarFp.getCardDataControlToken(id, xAuditUser, controlTokenRequestBody, options).then((request) => request(axios, basePath));
1991
+ },
1992
+ /**
1993
+ * Send a request to this endpoint to return all card applications for a specific main card. If the main card does not exist, an empty array is returned.
1994
+ * @summary Get Card Applications for Main Card
1995
+ * @param {string} mainCardId Unique identifier of the main card for which you want to retrieve the list of card applications.
1996
+ * @param {string} [xAuditUser] Optional audit user header
1997
+ * @param {*} [options] Override http request option.
1998
+ * @throws {RequiredError}
1999
+ */
2000
+ getCards(mainCardId: string, xAuditUser?: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<CardResponse>> {
2001
+ return localVarFp.getCards(mainCardId, xAuditUser, options).then((request) => request(axios, basePath));
2002
+ },
2003
+ };
2004
+ };
2005
+
2006
+ /**
2007
+ * GetCardApi - object-oriented interface
2008
+ * @export
2009
+ * @class GetCardApi
2010
+ * @extends {BaseAPI}
2011
+ */
2012
+ export class GetCardApi extends BaseAPI {
2013
+ /**
2014
+ *
2015
+ * @summary Get Card
2016
+ * @param {string} id Unique identifier of the card you want to retrieve.
2017
+ * @param {string} [xAuditUser] Optional audit user header
2018
+ * @param {*} [options] Override http request option.
2019
+ * @throws {RequiredError}
2020
+ * @memberof GetCardApi
2021
+ */
2022
+ public getCard(id: string, xAuditUser?: string, options?: RawAxiosRequestConfig) {
2023
+ return GetCardApiFp(this.configuration).getCard(id, xAuditUser, options).then((request) => request(this.axios, this.basePath));
2024
+ }
2025
+
2026
+ /**
2027
+ * Send a request to this endpoint when the cardholder wants to retrieve card data, such as PAN, expiry and CVV2/CVC2. If no sequence number is specified, the latest card version is used by default. Only card versions not in CLOSED status are allowed.
2028
+ * @summary Initiate Card Data Retrieval
2029
+ * @param {string} id Unique identifier of the card.
2030
+ * @param {string} [xAuditUser] Optional audit user header
2031
+ * @param {ControlTokenRequestBody} [controlTokenRequestBody]
2032
+ * @param {*} [options] Override http request option.
2033
+ * @throws {RequiredError}
2034
+ * @memberof GetCardApi
2035
+ */
2036
+ public getCardDataControlToken(id: string, xAuditUser?: string, controlTokenRequestBody?: ControlTokenRequestBody, options?: RawAxiosRequestConfig) {
2037
+ return GetCardApiFp(this.configuration).getCardDataControlToken(id, xAuditUser, controlTokenRequestBody, options).then((request) => request(this.axios, this.basePath));
2038
+ }
2039
+
2040
+ /**
2041
+ * Send a request to this endpoint to return all card applications for a specific main card. If the main card does not exist, an empty array is returned.
2042
+ * @summary Get Card Applications for Main Card
2043
+ * @param {string} mainCardId Unique identifier of the main card for which you want to retrieve the list of card applications.
2044
+ * @param {string} [xAuditUser] Optional audit user header
2045
+ * @param {*} [options] Override http request option.
2046
+ * @throws {RequiredError}
2047
+ * @memberof GetCardApi
2048
+ */
2049
+ public getCards(mainCardId: string, xAuditUser?: string, options?: RawAxiosRequestConfig) {
2050
+ return GetCardApiFp(this.configuration).getCards(mainCardId, xAuditUser, options).then((request) => request(this.axios, this.basePath));
2051
+ }
2052
+ }
2053
+
2054
+
2055
+
2056
+ /**
2057
+ * GetCardPaymentInfoApi - axios parameter creator
2058
+ * @export
2059
+ */
2060
+ export const GetCardPaymentInfoApiAxiosParamCreator = function (configuration?: Configuration) {
2061
+ return {
2062
+ /**
2063
+ * This is a web service designed to retrieve the card data required for completing e-commerce payments — PAN, CVC2/CVV2, expiry date of the card can be retrieved. The returned payload is encrypted with an asymmetric public key; this enables end-to-end encryption to the card holder device. The parameters that were included in the request are only returned. The caller is responsible of validating the integrity of the public key. <Note><ul><li>Send a request to this endpoint, if you are not using the Enfuce BIN sponsorship.</li><li>Retrieving card data through this endpoint implies PCI DSS compliance of the client with the Scheme. An easier method that you can use is the `Initiate Card Data Retrieval` endpoint — this endpoint enables rendering of card information to the cardholder\'s device without requiring compliance of the client with PCI DSS.</li></ul></Note> ## Example: ```java // ... import java.security.KeyFactory; import java.security.PrivateKey; import java.security.spec.PKCS8EncodedKeySpec; import java.util.Base64; import javax.crypto.Cipher; // ... ## Example of decrypting an encrypted field ```java private String decrypt(String data, String privKeyPEM) throws Exception { ## Example of preparing the key ```java String privKeyString = privKeyPEM.replaceAll(\"\\\\n\", \"\").replace(\"-----BEGIN PRIVATE KEY-----\", \"\").replace(\"-----END PRIVATE KEY-----\", \"\"); byte[] encodedKey = Base64.getDecoder().decode(privKeyString); PKCS8EncodedKeySpec spec = new PKCS8EncodedKeySpec(encodedKey); KeyFactory kf = KeyFactory.getInstance(\"RSA\"); PrivateKey privateKey = kf.generatePrivate(spec); ## Example of preparing the decryption ```java Cipher cipher = Cipher.getInstance(\"RSA/ECB/OAEPWithSHA-256AndMGF1Padding\"); cipher.init(Cipher.DECRYPT_MODE, privateKey); ## Example of preparing the data ```java byte[] cryptogram = Base64.getDecoder().decode(data); ## Example of decryption ```java byte[] decryptedBytes = cipher.doFinal(cryptogram); return new String(decryptedBytes);
2064
+ * @summary Retrieve Card Data | Additional Method
2065
+ * @param {string} id Unique identifier of the card whose details you want to retrieve.
2066
+ * @param {EncryptCardPaymentInfoRequestBody} encryptCardPaymentInfoRequestBody
2067
+ * @param {string} [xAuditUser] Optional audit user header
2068
+ * @param {*} [options] Override http request option.
2069
+ * @throws {RequiredError}
2070
+ */
2071
+ encryptCardPaymentInfo: async (id: string, encryptCardPaymentInfoRequestBody: EncryptCardPaymentInfoRequestBody, xAuditUser?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
2072
+ // verify required parameter 'id' is not null or undefined
2073
+ assertParamExists('encryptCardPaymentInfo', 'id', id)
2074
+ // verify required parameter 'encryptCardPaymentInfoRequestBody' is not null or undefined
2075
+ assertParamExists('encryptCardPaymentInfo', 'encryptCardPaymentInfoRequestBody', encryptCardPaymentInfoRequestBody)
2076
+ const localVarPath = `/v1/cards/{id}/encrypt`
2077
+ .replace(`{${"id"}}`, encodeURIComponent(String(id)));
2078
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
2079
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
2080
+ let baseOptions;
2081
+ if (configuration) {
2082
+ baseOptions = configuration.baseOptions;
2083
+ }
2084
+
2085
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
2086
+ const localVarHeaderParameter = {} as any;
2087
+ const localVarQueryParameter = {} as any;
2088
+
2089
+ // authentication bearerAuth required
2090
+ // http bearer authentication required
2091
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
2092
+
2093
+
2094
+
2095
+ localVarHeaderParameter['Content-Type'] = 'application/json';
2096
+
2097
+ if (xAuditUser != null) {
2098
+ localVarHeaderParameter['x-audit-user'] = String(xAuditUser);
2099
+ }
2100
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
2101
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
2102
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
2103
+ localVarRequestOptions.data = serializeDataIfNeeded(encryptCardPaymentInfoRequestBody, localVarRequestOptions, configuration)
2104
+
2105
+ return {
2106
+ url: toPathString(localVarUrlObj),
2107
+ options: localVarRequestOptions,
2108
+ };
2109
+ },
2110
+ }
2111
+ };
2112
+
2113
+ /**
2114
+ * GetCardPaymentInfoApi - functional programming interface
2115
+ * @export
2116
+ */
2117
+ export const GetCardPaymentInfoApiFp = function(configuration?: Configuration) {
2118
+ const localVarAxiosParamCreator = GetCardPaymentInfoApiAxiosParamCreator(configuration)
2119
+ return {
2120
+ /**
2121
+ * This is a web service designed to retrieve the card data required for completing e-commerce payments — PAN, CVC2/CVV2, expiry date of the card can be retrieved. The returned payload is encrypted with an asymmetric public key; this enables end-to-end encryption to the card holder device. The parameters that were included in the request are only returned. The caller is responsible of validating the integrity of the public key. <Note><ul><li>Send a request to this endpoint, if you are not using the Enfuce BIN sponsorship.</li><li>Retrieving card data through this endpoint implies PCI DSS compliance of the client with the Scheme. An easier method that you can use is the `Initiate Card Data Retrieval` endpoint — this endpoint enables rendering of card information to the cardholder\'s device without requiring compliance of the client with PCI DSS.</li></ul></Note> ## Example: ```java // ... import java.security.KeyFactory; import java.security.PrivateKey; import java.security.spec.PKCS8EncodedKeySpec; import java.util.Base64; import javax.crypto.Cipher; // ... ## Example of decrypting an encrypted field ```java private String decrypt(String data, String privKeyPEM) throws Exception { ## Example of preparing the key ```java String privKeyString = privKeyPEM.replaceAll(\"\\\\n\", \"\").replace(\"-----BEGIN PRIVATE KEY-----\", \"\").replace(\"-----END PRIVATE KEY-----\", \"\"); byte[] encodedKey = Base64.getDecoder().decode(privKeyString); PKCS8EncodedKeySpec spec = new PKCS8EncodedKeySpec(encodedKey); KeyFactory kf = KeyFactory.getInstance(\"RSA\"); PrivateKey privateKey = kf.generatePrivate(spec); ## Example of preparing the decryption ```java Cipher cipher = Cipher.getInstance(\"RSA/ECB/OAEPWithSHA-256AndMGF1Padding\"); cipher.init(Cipher.DECRYPT_MODE, privateKey); ## Example of preparing the data ```java byte[] cryptogram = Base64.getDecoder().decode(data); ## Example of decryption ```java byte[] decryptedBytes = cipher.doFinal(cryptogram); return new String(decryptedBytes);
2122
+ * @summary Retrieve Card Data | Additional Method
2123
+ * @param {string} id Unique identifier of the card whose details you want to retrieve.
2124
+ * @param {EncryptCardPaymentInfoRequestBody} encryptCardPaymentInfoRequestBody
2125
+ * @param {string} [xAuditUser] Optional audit user header
2126
+ * @param {*} [options] Override http request option.
2127
+ * @throws {RequiredError}
2128
+ */
2129
+ async encryptCardPaymentInfo(id: string, encryptCardPaymentInfoRequestBody: EncryptCardPaymentInfoRequestBody, xAuditUser?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EncryptCardPaymentInfoResponseBody>> {
2130
+ const localVarAxiosArgs = await localVarAxiosParamCreator.encryptCardPaymentInfo(id, encryptCardPaymentInfoRequestBody, xAuditUser, options);
2131
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
2132
+ const localVarOperationServerBasePath = operationServerMap['GetCardPaymentInfoApi.encryptCardPaymentInfo']?.[localVarOperationServerIndex]?.url;
2133
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
2134
+ },
2135
+ }
2136
+ };
2137
+
2138
+ /**
2139
+ * GetCardPaymentInfoApi - factory interface
2140
+ * @export
2141
+ */
2142
+ export const GetCardPaymentInfoApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
2143
+ const localVarFp = GetCardPaymentInfoApiFp(configuration)
2144
+ return {
2145
+ /**
2146
+ * This is a web service designed to retrieve the card data required for completing e-commerce payments — PAN, CVC2/CVV2, expiry date of the card can be retrieved. The returned payload is encrypted with an asymmetric public key; this enables end-to-end encryption to the card holder device. The parameters that were included in the request are only returned. The caller is responsible of validating the integrity of the public key. <Note><ul><li>Send a request to this endpoint, if you are not using the Enfuce BIN sponsorship.</li><li>Retrieving card data through this endpoint implies PCI DSS compliance of the client with the Scheme. An easier method that you can use is the `Initiate Card Data Retrieval` endpoint — this endpoint enables rendering of card information to the cardholder\'s device without requiring compliance of the client with PCI DSS.</li></ul></Note> ## Example: ```java // ... import java.security.KeyFactory; import java.security.PrivateKey; import java.security.spec.PKCS8EncodedKeySpec; import java.util.Base64; import javax.crypto.Cipher; // ... ## Example of decrypting an encrypted field ```java private String decrypt(String data, String privKeyPEM) throws Exception { ## Example of preparing the key ```java String privKeyString = privKeyPEM.replaceAll(\"\\\\n\", \"\").replace(\"-----BEGIN PRIVATE KEY-----\", \"\").replace(\"-----END PRIVATE KEY-----\", \"\"); byte[] encodedKey = Base64.getDecoder().decode(privKeyString); PKCS8EncodedKeySpec spec = new PKCS8EncodedKeySpec(encodedKey); KeyFactory kf = KeyFactory.getInstance(\"RSA\"); PrivateKey privateKey = kf.generatePrivate(spec); ## Example of preparing the decryption ```java Cipher cipher = Cipher.getInstance(\"RSA/ECB/OAEPWithSHA-256AndMGF1Padding\"); cipher.init(Cipher.DECRYPT_MODE, privateKey); ## Example of preparing the data ```java byte[] cryptogram = Base64.getDecoder().decode(data); ## Example of decryption ```java byte[] decryptedBytes = cipher.doFinal(cryptogram); return new String(decryptedBytes);
2147
+ * @summary Retrieve Card Data | Additional Method
2148
+ * @param {string} id Unique identifier of the card whose details you want to retrieve.
2149
+ * @param {EncryptCardPaymentInfoRequestBody} encryptCardPaymentInfoRequestBody
2150
+ * @param {string} [xAuditUser] Optional audit user header
2151
+ * @param {*} [options] Override http request option.
2152
+ * @throws {RequiredError}
2153
+ */
2154
+ encryptCardPaymentInfo(id: string, encryptCardPaymentInfoRequestBody: EncryptCardPaymentInfoRequestBody, xAuditUser?: string, options?: RawAxiosRequestConfig): AxiosPromise<EncryptCardPaymentInfoResponseBody> {
2155
+ return localVarFp.encryptCardPaymentInfo(id, encryptCardPaymentInfoRequestBody, xAuditUser, options).then((request) => request(axios, basePath));
2156
+ },
2157
+ };
2158
+ };
2159
+
2160
+ /**
2161
+ * GetCardPaymentInfoApi - object-oriented interface
2162
+ * @export
2163
+ * @class GetCardPaymentInfoApi
2164
+ * @extends {BaseAPI}
2165
+ */
2166
+ export class GetCardPaymentInfoApi extends BaseAPI {
2167
+ /**
2168
+ * This is a web service designed to retrieve the card data required for completing e-commerce payments — PAN, CVC2/CVV2, expiry date of the card can be retrieved. The returned payload is encrypted with an asymmetric public key; this enables end-to-end encryption to the card holder device. The parameters that were included in the request are only returned. The caller is responsible of validating the integrity of the public key. <Note><ul><li>Send a request to this endpoint, if you are not using the Enfuce BIN sponsorship.</li><li>Retrieving card data through this endpoint implies PCI DSS compliance of the client with the Scheme. An easier method that you can use is the `Initiate Card Data Retrieval` endpoint — this endpoint enables rendering of card information to the cardholder\'s device without requiring compliance of the client with PCI DSS.</li></ul></Note> ## Example: ```java // ... import java.security.KeyFactory; import java.security.PrivateKey; import java.security.spec.PKCS8EncodedKeySpec; import java.util.Base64; import javax.crypto.Cipher; // ... ## Example of decrypting an encrypted field ```java private String decrypt(String data, String privKeyPEM) throws Exception { ## Example of preparing the key ```java String privKeyString = privKeyPEM.replaceAll(\"\\\\n\", \"\").replace(\"-----BEGIN PRIVATE KEY-----\", \"\").replace(\"-----END PRIVATE KEY-----\", \"\"); byte[] encodedKey = Base64.getDecoder().decode(privKeyString); PKCS8EncodedKeySpec spec = new PKCS8EncodedKeySpec(encodedKey); KeyFactory kf = KeyFactory.getInstance(\"RSA\"); PrivateKey privateKey = kf.generatePrivate(spec); ## Example of preparing the decryption ```java Cipher cipher = Cipher.getInstance(\"RSA/ECB/OAEPWithSHA-256AndMGF1Padding\"); cipher.init(Cipher.DECRYPT_MODE, privateKey); ## Example of preparing the data ```java byte[] cryptogram = Base64.getDecoder().decode(data); ## Example of decryption ```java byte[] decryptedBytes = cipher.doFinal(cryptogram); return new String(decryptedBytes);
2169
+ * @summary Retrieve Card Data | Additional Method
2170
+ * @param {string} id Unique identifier of the card whose details you want to retrieve.
2171
+ * @param {EncryptCardPaymentInfoRequestBody} encryptCardPaymentInfoRequestBody
2172
+ * @param {string} [xAuditUser] Optional audit user header
2173
+ * @param {*} [options] Override http request option.
2174
+ * @throws {RequiredError}
2175
+ * @memberof GetCardPaymentInfoApi
2176
+ */
2177
+ public encryptCardPaymentInfo(id: string, encryptCardPaymentInfoRequestBody: EncryptCardPaymentInfoRequestBody, xAuditUser?: string, options?: RawAxiosRequestConfig) {
2178
+ return GetCardPaymentInfoApiFp(this.configuration).encryptCardPaymentInfo(id, encryptCardPaymentInfoRequestBody, xAuditUser, options).then((request) => request(this.axios, this.basePath));
2179
+ }
2180
+ }
2181
+
2182
+
2183
+
2184
+ /**
2185
+ * GetPlasticManufacturingHistoryApi - axios parameter creator
2186
+ * @export
2187
+ */
2188
+ export const GetPlasticManufacturingHistoryApiAxiosParamCreator = function (configuration?: Configuration) {
2189
+ return {
2190
+ /**
2191
+ * Send a request to this endpoint to retrieve a detailed list of all past occurrences when the card has been physically manufactured.
2192
+ * @summary Retrieve Manufacturing History of Card
2193
+ * @param {string} id Unique identifier of the card for which you want to retrieve the manufacturing history.
2194
+ * @param {string} [xAuditUser] Optional audit user header
2195
+ * @param {*} [options] Override http request option.
2196
+ * @throws {RequiredError}
2197
+ */
2198
+ manufacturingHistory: async (id: string, xAuditUser?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
2199
+ // verify required parameter 'id' is not null or undefined
2200
+ assertParamExists('manufacturingHistory', 'id', id)
2201
+ const localVarPath = `/v1/cards/{id}/manufacturing-history`
2202
+ .replace(`{${"id"}}`, encodeURIComponent(String(id)));
2203
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
2204
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
2205
+ let baseOptions;
2206
+ if (configuration) {
2207
+ baseOptions = configuration.baseOptions;
2208
+ }
2209
+
2210
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
2211
+ const localVarHeaderParameter = {} as any;
2212
+ const localVarQueryParameter = {} as any;
2213
+
2214
+ // authentication bearerAuth required
2215
+ // http bearer authentication required
2216
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
2217
+
2218
+
2219
+
2220
+ if (xAuditUser != null) {
2221
+ localVarHeaderParameter['x-audit-user'] = String(xAuditUser);
2222
+ }
2223
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
2224
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
2225
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
2226
+
2227
+ return {
2228
+ url: toPathString(localVarUrlObj),
2229
+ options: localVarRequestOptions,
2230
+ };
2231
+ },
2232
+ }
2233
+ };
2234
+
2235
+ /**
2236
+ * GetPlasticManufacturingHistoryApi - functional programming interface
2237
+ * @export
2238
+ */
2239
+ export const GetPlasticManufacturingHistoryApiFp = function(configuration?: Configuration) {
2240
+ const localVarAxiosParamCreator = GetPlasticManufacturingHistoryApiAxiosParamCreator(configuration)
2241
+ return {
2242
+ /**
2243
+ * Send a request to this endpoint to retrieve a detailed list of all past occurrences when the card has been physically manufactured.
2244
+ * @summary Retrieve Manufacturing History of Card
2245
+ * @param {string} id Unique identifier of the card for which you want to retrieve the manufacturing history.
2246
+ * @param {string} [xAuditUser] Optional audit user header
2247
+ * @param {*} [options] Override http request option.
2248
+ * @throws {RequiredError}
2249
+ */
2250
+ async manufacturingHistory(id: string, xAuditUser?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PlasticManufacturingHistoryResponse>> {
2251
+ const localVarAxiosArgs = await localVarAxiosParamCreator.manufacturingHistory(id, xAuditUser, options);
2252
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
2253
+ const localVarOperationServerBasePath = operationServerMap['GetPlasticManufacturingHistoryApi.manufacturingHistory']?.[localVarOperationServerIndex]?.url;
2254
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
2255
+ },
2256
+ }
2257
+ };
2258
+
2259
+ /**
2260
+ * GetPlasticManufacturingHistoryApi - factory interface
2261
+ * @export
2262
+ */
2263
+ export const GetPlasticManufacturingHistoryApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
2264
+ const localVarFp = GetPlasticManufacturingHistoryApiFp(configuration)
2265
+ return {
2266
+ /**
2267
+ * Send a request to this endpoint to retrieve a detailed list of all past occurrences when the card has been physically manufactured.
2268
+ * @summary Retrieve Manufacturing History of Card
2269
+ * @param {string} id Unique identifier of the card for which you want to retrieve the manufacturing history.
2270
+ * @param {string} [xAuditUser] Optional audit user header
2271
+ * @param {*} [options] Override http request option.
2272
+ * @throws {RequiredError}
2273
+ */
2274
+ manufacturingHistory(id: string, xAuditUser?: string, options?: RawAxiosRequestConfig): AxiosPromise<PlasticManufacturingHistoryResponse> {
2275
+ return localVarFp.manufacturingHistory(id, xAuditUser, options).then((request) => request(axios, basePath));
2276
+ },
2277
+ };
2278
+ };
2279
+
2280
+ /**
2281
+ * GetPlasticManufacturingHistoryApi - object-oriented interface
2282
+ * @export
2283
+ * @class GetPlasticManufacturingHistoryApi
2284
+ * @extends {BaseAPI}
2285
+ */
2286
+ export class GetPlasticManufacturingHistoryApi extends BaseAPI {
2287
+ /**
2288
+ * Send a request to this endpoint to retrieve a detailed list of all past occurrences when the card has been physically manufactured.
2289
+ * @summary Retrieve Manufacturing History of Card
2290
+ * @param {string} id Unique identifier of the card for which you want to retrieve the manufacturing history.
2291
+ * @param {string} [xAuditUser] Optional audit user header
2292
+ * @param {*} [options] Override http request option.
2293
+ * @throws {RequiredError}
2294
+ * @memberof GetPlasticManufacturingHistoryApi
2295
+ */
2296
+ public manufacturingHistory(id: string, xAuditUser?: string, options?: RawAxiosRequestConfig) {
2297
+ return GetPlasticManufacturingHistoryApiFp(this.configuration).manufacturingHistory(id, xAuditUser, options).then((request) => request(this.axios, this.basePath));
2298
+ }
2299
+ }
2300
+
2301
+
2302
+
2303
+ /**
2304
+ * UpdateCardApi - axios parameter creator
2305
+ * @export
2306
+ */
2307
+ export const UpdateCardApiAxiosParamCreator = function (configuration?: Configuration) {
2308
+ return {
2309
+ /**
2310
+ * To change the latest card version status from `INITIAL` to `ACTIVE`, send a request to this endpoint.
2311
+ * @summary Activate Card
2312
+ * @param {string} id Unique ID of the card that you want to activate.
2313
+ * @param {string} [xIdempotencyKey] Idempotency key of the request
2314
+ * @param {string} [xAuditUser] Optional audit user header
2315
+ * @param {*} [options] Override http request option.
2316
+ * @throws {RequiredError}
2317
+ */
2318
+ activateCard: async (id: string, xIdempotencyKey?: string, xAuditUser?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
2319
+ // verify required parameter 'id' is not null or undefined
2320
+ assertParamExists('activateCard', 'id', id)
2321
+ const localVarPath = `/v1/cards/{id}/activate`
2322
+ .replace(`{${"id"}}`, encodeURIComponent(String(id)));
2323
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
2324
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
2325
+ let baseOptions;
2326
+ if (configuration) {
2327
+ baseOptions = configuration.baseOptions;
2328
+ }
2329
+
2330
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
2331
+ const localVarHeaderParameter = {} as any;
2332
+ const localVarQueryParameter = {} as any;
2333
+
2334
+ // authentication bearerAuth required
2335
+ // http bearer authentication required
2336
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
2337
+
2338
+
2339
+
2340
+ if (xIdempotencyKey != null) {
2341
+ localVarHeaderParameter['x-idempotency-key'] = String(xIdempotencyKey);
2342
+ }
2343
+ if (xAuditUser != null) {
2344
+ localVarHeaderParameter['x-audit-user'] = String(xAuditUser);
2345
+ }
2346
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
2347
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
2348
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
2349
+
2350
+ return {
2351
+ url: toPathString(localVarUrlObj),
2352
+ options: localVarRequestOptions,
2353
+ };
2354
+ },
2355
+ /**
2356
+ * Send a request to this endpoint when you want to update details of a specific card.
2357
+ * @summary Partially Update Card
2358
+ * @param {string} id Unique identifier of the card that you want to update.
2359
+ * @param {UpdateCardBody} updateCardBody Details of the card that you want to update.
2360
+ * @param {string} [xAuditUser] Optional audit user header
2361
+ * @param {*} [options] Override http request option.
2362
+ * @throws {RequiredError}
2363
+ */
2364
+ patchCard: async (id: string, updateCardBody: UpdateCardBody, xAuditUser?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
2365
+ // verify required parameter 'id' is not null or undefined
2366
+ assertParamExists('patchCard', 'id', id)
2367
+ // verify required parameter 'updateCardBody' is not null or undefined
2368
+ assertParamExists('patchCard', 'updateCardBody', updateCardBody)
2369
+ const localVarPath = `/v1/cards/{id}`
2370
+ .replace(`{${"id"}}`, encodeURIComponent(String(id)));
2371
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
2372
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
2373
+ let baseOptions;
2374
+ if (configuration) {
2375
+ baseOptions = configuration.baseOptions;
2376
+ }
2377
+
2378
+ const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...options};
2379
+ const localVarHeaderParameter = {} as any;
2380
+ const localVarQueryParameter = {} as any;
2381
+
2382
+ // authentication bearerAuth required
2383
+ // http bearer authentication required
2384
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
2385
+
2386
+
2387
+
2388
+ localVarHeaderParameter['Content-Type'] = 'application/json';
2389
+
2390
+ if (xAuditUser != null) {
2391
+ localVarHeaderParameter['x-audit-user'] = String(xAuditUser);
2392
+ }
2393
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
2394
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
2395
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
2396
+ localVarRequestOptions.data = serializeDataIfNeeded(updateCardBody, localVarRequestOptions, configuration)
2397
+
2398
+ return {
2399
+ url: toPathString(localVarUrlObj),
2400
+ options: localVarRequestOptions,
2401
+ };
2402
+ },
2403
+ /**
2404
+ * Send a request to this endpoint when you want to reissue a card.
2405
+ * @summary Reissue Card
2406
+ * @param {string} id Unique identifier of the card that you want to reissue.
2407
+ * @param {string} [xIdempotencyKey] Idempotency key of the request
2408
+ * @param {string} [xAuditUser] Optional audit user header
2409
+ * @param {ReissueCardBody} [reissueCardBody]
2410
+ * @param {*} [options] Override http request option.
2411
+ * @throws {RequiredError}
2412
+ */
2413
+ reissueCard: async (id: string, xIdempotencyKey?: string, xAuditUser?: string, reissueCardBody?: ReissueCardBody, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
2414
+ // verify required parameter 'id' is not null or undefined
2415
+ assertParamExists('reissueCard', 'id', id)
2416
+ const localVarPath = `/v1/cards/{id}/reissue`
2417
+ .replace(`{${"id"}}`, encodeURIComponent(String(id)));
2418
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
2419
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
2420
+ let baseOptions;
2421
+ if (configuration) {
2422
+ baseOptions = configuration.baseOptions;
2423
+ }
2424
+
2425
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
2426
+ const localVarHeaderParameter = {} as any;
2427
+ const localVarQueryParameter = {} as any;
2428
+
2429
+ // authentication bearerAuth required
2430
+ // http bearer authentication required
2431
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
2432
+
2433
+
2434
+
2435
+ localVarHeaderParameter['Content-Type'] = 'application/json';
2436
+
2437
+ if (xIdempotencyKey != null) {
2438
+ localVarHeaderParameter['x-idempotency-key'] = String(xIdempotencyKey);
2439
+ }
2440
+ if (xAuditUser != null) {
2441
+ localVarHeaderParameter['x-audit-user'] = String(xAuditUser);
2442
+ }
2443
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
2444
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
2445
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
2446
+ localVarRequestOptions.data = serializeDataIfNeeded(reissueCardBody, localVarRequestOptions, configuration)
2447
+
2448
+ return {
2449
+ url: toPathString(localVarUrlObj),
2450
+ options: localVarRequestOptions,
2451
+ };
2452
+ },
2453
+ /**
2454
+ * Send a request to this endpoint when you want to reorder existing PIN for a plastic card, if the cardholder has forgotten it. The PIN is delivered to the `preferredPinAddress`. If `preferredPinAddress` is absent, the PIN is delivered to the `preferredCardAddress`.
2455
+ * @summary Reorder PIN for Card
2456
+ * @param {string} id Unique identifier of the card for which you want to reorder PIN.
2457
+ * @param {string} [xIdempotencyKey] Idempotency key of the request.
2458
+ * @param {string} [xAuditUser] Optional audit user header
2459
+ * @param {*} [options] Override http request option.
2460
+ * @throws {RequiredError}
2461
+ */
2462
+ reorderPin: async (id: string, xIdempotencyKey?: string, xAuditUser?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
2463
+ // verify required parameter 'id' is not null or undefined
2464
+ assertParamExists('reorderPin', 'id', id)
2465
+ const localVarPath = `/v1/cards/{id}/reorder-pin`
2466
+ .replace(`{${"id"}}`, encodeURIComponent(String(id)));
2467
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
2468
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
2469
+ let baseOptions;
2470
+ if (configuration) {
2471
+ baseOptions = configuration.baseOptions;
2472
+ }
2473
+
2474
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
2475
+ const localVarHeaderParameter = {} as any;
2476
+ const localVarQueryParameter = {} as any;
2477
+
2478
+ // authentication bearerAuth required
2479
+ // http bearer authentication required
2480
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
2481
+
2482
+
2483
+
2484
+ if (xIdempotencyKey != null) {
2485
+ localVarHeaderParameter['x-idempotency-key'] = String(xIdempotencyKey);
2486
+ }
2487
+ if (xAuditUser != null) {
2488
+ localVarHeaderParameter['x-audit-user'] = String(xAuditUser);
2489
+ }
2490
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
2491
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
2492
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
2493
+
2494
+ return {
2495
+ url: toPathString(localVarUrlObj),
2496
+ options: localVarRequestOptions,
2497
+ };
2498
+ },
2499
+ /**
2500
+ * Send a request to this endpoint when you want to replace the current card. The old card is closed and a new card is issued, where the PAN and the expiry date are updated.
2501
+ * @summary Replace Card
2502
+ * @param {string} id Unique identifier of the card to be replaced.
2503
+ * @param {string} [xIdempotencyKey] Idempotency key of the request.
2504
+ * @param {string} [xAuditUser] Optional audit user header
2505
+ * @param {ReplaceCardBody} [replaceCardBody]
2506
+ * @param {*} [options] Override http request option.
2507
+ * @throws {RequiredError}
2508
+ */
2509
+ replaceCard: async (id: string, xIdempotencyKey?: string, xAuditUser?: string, replaceCardBody?: ReplaceCardBody, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
2510
+ // verify required parameter 'id' is not null or undefined
2511
+ assertParamExists('replaceCard', 'id', id)
2512
+ const localVarPath = `/v1/cards/{id}/replace`
2513
+ .replace(`{${"id"}}`, encodeURIComponent(String(id)));
2514
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
2515
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
2516
+ let baseOptions;
2517
+ if (configuration) {
2518
+ baseOptions = configuration.baseOptions;
2519
+ }
2520
+
2521
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
2522
+ const localVarHeaderParameter = {} as any;
2523
+ const localVarQueryParameter = {} as any;
2524
+
2525
+ // authentication bearerAuth required
2526
+ // http bearer authentication required
2527
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
2528
+
2529
+
2530
+
2531
+ localVarHeaderParameter['Content-Type'] = 'application/json';
2532
+
2533
+ if (xIdempotencyKey != null) {
2534
+ localVarHeaderParameter['x-idempotency-key'] = String(xIdempotencyKey);
2535
+ }
2536
+ if (xAuditUser != null) {
2537
+ localVarHeaderParameter['x-audit-user'] = String(xAuditUser);
2538
+ }
2539
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
2540
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
2541
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
2542
+ localVarRequestOptions.data = serializeDataIfNeeded(replaceCardBody, localVarRequestOptions, configuration)
2543
+
2544
+ return {
2545
+ url: toPathString(localVarUrlObj),
2546
+ options: localVarRequestOptions,
2547
+ };
2548
+ },
2549
+ }
2550
+ };
2551
+
2552
+ /**
2553
+ * UpdateCardApi - functional programming interface
2554
+ * @export
2555
+ */
2556
+ export const UpdateCardApiFp = function(configuration?: Configuration) {
2557
+ const localVarAxiosParamCreator = UpdateCardApiAxiosParamCreator(configuration)
2558
+ return {
2559
+ /**
2560
+ * To change the latest card version status from `INITIAL` to `ACTIVE`, send a request to this endpoint.
2561
+ * @summary Activate Card
2562
+ * @param {string} id Unique ID of the card that you want to activate.
2563
+ * @param {string} [xIdempotencyKey] Idempotency key of the request
2564
+ * @param {string} [xAuditUser] Optional audit user header
2565
+ * @param {*} [options] Override http request option.
2566
+ * @throws {RequiredError}
2567
+ */
2568
+ async activateCard(id: string, xIdempotencyKey?: string, xAuditUser?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ResourceResponse>> {
2569
+ const localVarAxiosArgs = await localVarAxiosParamCreator.activateCard(id, xIdempotencyKey, xAuditUser, options);
2570
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
2571
+ const localVarOperationServerBasePath = operationServerMap['UpdateCardApi.activateCard']?.[localVarOperationServerIndex]?.url;
2572
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
2573
+ },
2574
+ /**
2575
+ * Send a request to this endpoint when you want to update details of a specific card.
2576
+ * @summary Partially Update Card
2577
+ * @param {string} id Unique identifier of the card that you want to update.
2578
+ * @param {UpdateCardBody} updateCardBody Details of the card that you want to update.
2579
+ * @param {string} [xAuditUser] Optional audit user header
2580
+ * @param {*} [options] Override http request option.
2581
+ * @throws {RequiredError}
2582
+ */
2583
+ async patchCard(id: string, updateCardBody: UpdateCardBody, xAuditUser?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ResourceResponse>> {
2584
+ const localVarAxiosArgs = await localVarAxiosParamCreator.patchCard(id, updateCardBody, xAuditUser, options);
2585
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
2586
+ const localVarOperationServerBasePath = operationServerMap['UpdateCardApi.patchCard']?.[localVarOperationServerIndex]?.url;
2587
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
2588
+ },
2589
+ /**
2590
+ * Send a request to this endpoint when you want to reissue a card.
2591
+ * @summary Reissue Card
2592
+ * @param {string} id Unique identifier of the card that you want to reissue.
2593
+ * @param {string} [xIdempotencyKey] Idempotency key of the request
2594
+ * @param {string} [xAuditUser] Optional audit user header
2595
+ * @param {ReissueCardBody} [reissueCardBody]
2596
+ * @param {*} [options] Override http request option.
2597
+ * @throws {RequiredError}
2598
+ */
2599
+ async reissueCard(id: string, xIdempotencyKey?: string, xAuditUser?: string, reissueCardBody?: ReissueCardBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ResourceResponse>> {
2600
+ const localVarAxiosArgs = await localVarAxiosParamCreator.reissueCard(id, xIdempotencyKey, xAuditUser, reissueCardBody, options);
2601
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
2602
+ const localVarOperationServerBasePath = operationServerMap['UpdateCardApi.reissueCard']?.[localVarOperationServerIndex]?.url;
2603
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
2604
+ },
2605
+ /**
2606
+ * Send a request to this endpoint when you want to reorder existing PIN for a plastic card, if the cardholder has forgotten it. The PIN is delivered to the `preferredPinAddress`. If `preferredPinAddress` is absent, the PIN is delivered to the `preferredCardAddress`.
2607
+ * @summary Reorder PIN for Card
2608
+ * @param {string} id Unique identifier of the card for which you want to reorder PIN.
2609
+ * @param {string} [xIdempotencyKey] Idempotency key of the request.
2610
+ * @param {string} [xAuditUser] Optional audit user header
2611
+ * @param {*} [options] Override http request option.
2612
+ * @throws {RequiredError}
2613
+ */
2614
+ async reorderPin(id: string, xIdempotencyKey?: string, xAuditUser?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ResourceResponse>> {
2615
+ const localVarAxiosArgs = await localVarAxiosParamCreator.reorderPin(id, xIdempotencyKey, xAuditUser, options);
2616
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
2617
+ const localVarOperationServerBasePath = operationServerMap['UpdateCardApi.reorderPin']?.[localVarOperationServerIndex]?.url;
2618
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
2619
+ },
2620
+ /**
2621
+ * Send a request to this endpoint when you want to replace the current card. The old card is closed and a new card is issued, where the PAN and the expiry date are updated.
2622
+ * @summary Replace Card
2623
+ * @param {string} id Unique identifier of the card to be replaced.
2624
+ * @param {string} [xIdempotencyKey] Idempotency key of the request.
2625
+ * @param {string} [xAuditUser] Optional audit user header
2626
+ * @param {ReplaceCardBody} [replaceCardBody]
2627
+ * @param {*} [options] Override http request option.
2628
+ * @throws {RequiredError}
2629
+ */
2630
+ async replaceCard(id: string, xIdempotencyKey?: string, xAuditUser?: string, replaceCardBody?: ReplaceCardBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ResourceResponse>> {
2631
+ const localVarAxiosArgs = await localVarAxiosParamCreator.replaceCard(id, xIdempotencyKey, xAuditUser, replaceCardBody, options);
2632
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
2633
+ const localVarOperationServerBasePath = operationServerMap['UpdateCardApi.replaceCard']?.[localVarOperationServerIndex]?.url;
2634
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
2635
+ },
2636
+ }
2637
+ };
2638
+
2639
+ /**
2640
+ * UpdateCardApi - factory interface
2641
+ * @export
2642
+ */
2643
+ export const UpdateCardApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
2644
+ const localVarFp = UpdateCardApiFp(configuration)
2645
+ return {
2646
+ /**
2647
+ * To change the latest card version status from `INITIAL` to `ACTIVE`, send a request to this endpoint.
2648
+ * @summary Activate Card
2649
+ * @param {string} id Unique ID of the card that you want to activate.
2650
+ * @param {string} [xIdempotencyKey] Idempotency key of the request
2651
+ * @param {string} [xAuditUser] Optional audit user header
2652
+ * @param {*} [options] Override http request option.
2653
+ * @throws {RequiredError}
2654
+ */
2655
+ activateCard(id: string, xIdempotencyKey?: string, xAuditUser?: string, options?: RawAxiosRequestConfig): AxiosPromise<ResourceResponse> {
2656
+ return localVarFp.activateCard(id, xIdempotencyKey, xAuditUser, options).then((request) => request(axios, basePath));
2657
+ },
2658
+ /**
2659
+ * Send a request to this endpoint when you want to update details of a specific card.
2660
+ * @summary Partially Update Card
2661
+ * @param {string} id Unique identifier of the card that you want to update.
2662
+ * @param {UpdateCardBody} updateCardBody Details of the card that you want to update.
2663
+ * @param {string} [xAuditUser] Optional audit user header
2664
+ * @param {*} [options] Override http request option.
2665
+ * @throws {RequiredError}
2666
+ */
2667
+ patchCard(id: string, updateCardBody: UpdateCardBody, xAuditUser?: string, options?: RawAxiosRequestConfig): AxiosPromise<ResourceResponse> {
2668
+ return localVarFp.patchCard(id, updateCardBody, xAuditUser, options).then((request) => request(axios, basePath));
2669
+ },
2670
+ /**
2671
+ * Send a request to this endpoint when you want to reissue a card.
2672
+ * @summary Reissue Card
2673
+ * @param {string} id Unique identifier of the card that you want to reissue.
2674
+ * @param {string} [xIdempotencyKey] Idempotency key of the request
2675
+ * @param {string} [xAuditUser] Optional audit user header
2676
+ * @param {ReissueCardBody} [reissueCardBody]
2677
+ * @param {*} [options] Override http request option.
2678
+ * @throws {RequiredError}
2679
+ */
2680
+ reissueCard(id: string, xIdempotencyKey?: string, xAuditUser?: string, reissueCardBody?: ReissueCardBody, options?: RawAxiosRequestConfig): AxiosPromise<ResourceResponse> {
2681
+ return localVarFp.reissueCard(id, xIdempotencyKey, xAuditUser, reissueCardBody, options).then((request) => request(axios, basePath));
2682
+ },
2683
+ /**
2684
+ * Send a request to this endpoint when you want to reorder existing PIN for a plastic card, if the cardholder has forgotten it. The PIN is delivered to the `preferredPinAddress`. If `preferredPinAddress` is absent, the PIN is delivered to the `preferredCardAddress`.
2685
+ * @summary Reorder PIN for Card
2686
+ * @param {string} id Unique identifier of the card for which you want to reorder PIN.
2687
+ * @param {string} [xIdempotencyKey] Idempotency key of the request.
2688
+ * @param {string} [xAuditUser] Optional audit user header
2689
+ * @param {*} [options] Override http request option.
2690
+ * @throws {RequiredError}
2691
+ */
2692
+ reorderPin(id: string, xIdempotencyKey?: string, xAuditUser?: string, options?: RawAxiosRequestConfig): AxiosPromise<ResourceResponse> {
2693
+ return localVarFp.reorderPin(id, xIdempotencyKey, xAuditUser, options).then((request) => request(axios, basePath));
2694
+ },
2695
+ /**
2696
+ * Send a request to this endpoint when you want to replace the current card. The old card is closed and a new card is issued, where the PAN and the expiry date are updated.
2697
+ * @summary Replace Card
2698
+ * @param {string} id Unique identifier of the card to be replaced.
2699
+ * @param {string} [xIdempotencyKey] Idempotency key of the request.
2700
+ * @param {string} [xAuditUser] Optional audit user header
2701
+ * @param {ReplaceCardBody} [replaceCardBody]
2702
+ * @param {*} [options] Override http request option.
2703
+ * @throws {RequiredError}
2704
+ */
2705
+ replaceCard(id: string, xIdempotencyKey?: string, xAuditUser?: string, replaceCardBody?: ReplaceCardBody, options?: RawAxiosRequestConfig): AxiosPromise<ResourceResponse> {
2706
+ return localVarFp.replaceCard(id, xIdempotencyKey, xAuditUser, replaceCardBody, options).then((request) => request(axios, basePath));
2707
+ },
2708
+ };
2709
+ };
2710
+
2711
+ /**
2712
+ * UpdateCardApi - object-oriented interface
2713
+ * @export
2714
+ * @class UpdateCardApi
2715
+ * @extends {BaseAPI}
2716
+ */
2717
+ export class UpdateCardApi extends BaseAPI {
2718
+ /**
2719
+ * To change the latest card version status from `INITIAL` to `ACTIVE`, send a request to this endpoint.
2720
+ * @summary Activate Card
2721
+ * @param {string} id Unique ID of the card that you want to activate.
2722
+ * @param {string} [xIdempotencyKey] Idempotency key of the request
2723
+ * @param {string} [xAuditUser] Optional audit user header
2724
+ * @param {*} [options] Override http request option.
2725
+ * @throws {RequiredError}
2726
+ * @memberof UpdateCardApi
2727
+ */
2728
+ public activateCard(id: string, xIdempotencyKey?: string, xAuditUser?: string, options?: RawAxiosRequestConfig) {
2729
+ return UpdateCardApiFp(this.configuration).activateCard(id, xIdempotencyKey, xAuditUser, options).then((request) => request(this.axios, this.basePath));
2730
+ }
2731
+
2732
+ /**
2733
+ * Send a request to this endpoint when you want to update details of a specific card.
2734
+ * @summary Partially Update Card
2735
+ * @param {string} id Unique identifier of the card that you want to update.
2736
+ * @param {UpdateCardBody} updateCardBody Details of the card that you want to update.
2737
+ * @param {string} [xAuditUser] Optional audit user header
2738
+ * @param {*} [options] Override http request option.
2739
+ * @throws {RequiredError}
2740
+ * @memberof UpdateCardApi
2741
+ */
2742
+ public patchCard(id: string, updateCardBody: UpdateCardBody, xAuditUser?: string, options?: RawAxiosRequestConfig) {
2743
+ return UpdateCardApiFp(this.configuration).patchCard(id, updateCardBody, xAuditUser, options).then((request) => request(this.axios, this.basePath));
2744
+ }
2745
+
2746
+ /**
2747
+ * Send a request to this endpoint when you want to reissue a card.
2748
+ * @summary Reissue Card
2749
+ * @param {string} id Unique identifier of the card that you want to reissue.
2750
+ * @param {string} [xIdempotencyKey] Idempotency key of the request
2751
+ * @param {string} [xAuditUser] Optional audit user header
2752
+ * @param {ReissueCardBody} [reissueCardBody]
2753
+ * @param {*} [options] Override http request option.
2754
+ * @throws {RequiredError}
2755
+ * @memberof UpdateCardApi
2756
+ */
2757
+ public reissueCard(id: string, xIdempotencyKey?: string, xAuditUser?: string, reissueCardBody?: ReissueCardBody, options?: RawAxiosRequestConfig) {
2758
+ return UpdateCardApiFp(this.configuration).reissueCard(id, xIdempotencyKey, xAuditUser, reissueCardBody, options).then((request) => request(this.axios, this.basePath));
2759
+ }
2760
+
2761
+ /**
2762
+ * Send a request to this endpoint when you want to reorder existing PIN for a plastic card, if the cardholder has forgotten it. The PIN is delivered to the `preferredPinAddress`. If `preferredPinAddress` is absent, the PIN is delivered to the `preferredCardAddress`.
2763
+ * @summary Reorder PIN for Card
2764
+ * @param {string} id Unique identifier of the card for which you want to reorder PIN.
2765
+ * @param {string} [xIdempotencyKey] Idempotency key of the request.
2766
+ * @param {string} [xAuditUser] Optional audit user header
2767
+ * @param {*} [options] Override http request option.
2768
+ * @throws {RequiredError}
2769
+ * @memberof UpdateCardApi
2770
+ */
2771
+ public reorderPin(id: string, xIdempotencyKey?: string, xAuditUser?: string, options?: RawAxiosRequestConfig) {
2772
+ return UpdateCardApiFp(this.configuration).reorderPin(id, xIdempotencyKey, xAuditUser, options).then((request) => request(this.axios, this.basePath));
2773
+ }
2774
+
2775
+ /**
2776
+ * Send a request to this endpoint when you want to replace the current card. The old card is closed and a new card is issued, where the PAN and the expiry date are updated.
2777
+ * @summary Replace Card
2778
+ * @param {string} id Unique identifier of the card to be replaced.
2779
+ * @param {string} [xIdempotencyKey] Idempotency key of the request.
2780
+ * @param {string} [xAuditUser] Optional audit user header
2781
+ * @param {ReplaceCardBody} [replaceCardBody]
2782
+ * @param {*} [options] Override http request option.
2783
+ * @throws {RequiredError}
2784
+ * @memberof UpdateCardApi
2785
+ */
2786
+ public replaceCard(id: string, xIdempotencyKey?: string, xAuditUser?: string, replaceCardBody?: ReplaceCardBody, options?: RawAxiosRequestConfig) {
2787
+ return UpdateCardApiFp(this.configuration).replaceCard(id, xIdempotencyKey, xAuditUser, replaceCardBody, options).then((request) => request(this.axios, this.basePath));
2788
+ }
2789
+ }
2790
+
2791
+
2792
+