@getivy/node-sdk 1.7.0 → 2.0.0

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 (639) hide show
  1. package/CHANGELOG.md +149 -563
  2. package/README.md +112 -42
  3. package/api-promise.d.mts +2 -0
  4. package/api-promise.d.mts.map +1 -0
  5. package/api-promise.d.ts +2 -0
  6. package/api-promise.d.ts.map +1 -0
  7. package/api-promise.js +6 -0
  8. package/api-promise.js.map +1 -0
  9. package/api-promise.mjs +2 -0
  10. package/api-promise.mjs.map +1 -0
  11. package/bin/cli +53 -0
  12. package/bin/migration-config.json +6 -0
  13. package/client.d.mts +243 -0
  14. package/client.d.mts.map +1 -0
  15. package/client.d.ts +243 -0
  16. package/client.d.ts.map +1 -0
  17. package/client.js +524 -0
  18. package/client.js.map +1 -0
  19. package/client.mjs +520 -0
  20. package/client.mjs.map +1 -0
  21. package/core/api-promise.d.mts +46 -0
  22. package/core/api-promise.d.mts.map +1 -0
  23. package/core/api-promise.d.ts +46 -0
  24. package/core/api-promise.d.ts.map +1 -0
  25. package/core/api-promise.js +74 -0
  26. package/core/api-promise.js.map +1 -0
  27. package/core/api-promise.mjs +70 -0
  28. package/core/api-promise.mjs.map +1 -0
  29. package/core/error.d.mts +46 -0
  30. package/core/error.d.mts.map +1 -0
  31. package/core/error.d.ts +46 -0
  32. package/core/error.d.ts.map +1 -0
  33. package/core/error.js +113 -0
  34. package/core/error.js.map +1 -0
  35. package/core/error.mjs +97 -0
  36. package/core/error.mjs.map +1 -0
  37. package/core/resource.d.mts +6 -0
  38. package/core/resource.d.mts.map +1 -0
  39. package/core/resource.d.ts +6 -0
  40. package/core/resource.d.ts.map +1 -0
  41. package/core/resource.js +11 -0
  42. package/core/resource.js.map +1 -0
  43. package/core/resource.mjs +7 -0
  44. package/core/resource.mjs.map +1 -0
  45. package/core/uploads.d.mts +3 -0
  46. package/core/uploads.d.mts.map +1 -0
  47. package/core/uploads.d.ts +3 -0
  48. package/core/uploads.d.ts.map +1 -0
  49. package/core/uploads.js +6 -0
  50. package/core/uploads.js.map +1 -0
  51. package/core/uploads.mjs +2 -0
  52. package/core/uploads.mjs.map +1 -0
  53. package/error.d.mts +2 -0
  54. package/error.d.mts.map +1 -0
  55. package/error.d.ts +1 -46
  56. package/error.d.ts.map +1 -1
  57. package/error.js +3 -110
  58. package/error.js.map +1 -1
  59. package/error.mjs +1 -96
  60. package/error.mjs.map +1 -1
  61. package/index.d.mts +6 -175
  62. package/index.d.mts.map +1 -0
  63. package/index.d.ts +5 -174
  64. package/index.d.ts.map +1 -1
  65. package/index.js +12 -166
  66. package/index.js.map +1 -1
  67. package/index.mjs +5 -139
  68. package/index.mjs.map +1 -1
  69. package/internal/builtin-types.d.mts +73 -0
  70. package/internal/builtin-types.d.mts.map +1 -0
  71. package/internal/builtin-types.d.ts +73 -0
  72. package/internal/builtin-types.d.ts.map +1 -0
  73. package/internal/builtin-types.js +4 -0
  74. package/internal/builtin-types.js.map +1 -0
  75. package/internal/builtin-types.mjs +3 -0
  76. package/internal/builtin-types.mjs.map +1 -0
  77. package/internal/detect-platform.d.mts +15 -0
  78. package/internal/detect-platform.d.mts.map +1 -0
  79. package/internal/detect-platform.d.ts +15 -0
  80. package/internal/detect-platform.d.ts.map +1 -0
  81. package/internal/detect-platform.js +162 -0
  82. package/internal/detect-platform.js.map +1 -0
  83. package/internal/detect-platform.mjs +157 -0
  84. package/internal/detect-platform.mjs.map +1 -0
  85. package/internal/errors.d.mts +3 -0
  86. package/internal/errors.d.mts.map +1 -0
  87. package/internal/errors.d.ts +3 -0
  88. package/internal/errors.d.ts.map +1 -0
  89. package/internal/errors.js +41 -0
  90. package/internal/errors.js.map +1 -0
  91. package/internal/errors.mjs +36 -0
  92. package/internal/errors.mjs.map +1 -0
  93. package/internal/headers.d.mts +20 -0
  94. package/internal/headers.d.mts.map +1 -0
  95. package/internal/headers.d.ts +20 -0
  96. package/internal/headers.d.ts.map +1 -0
  97. package/internal/headers.js +79 -0
  98. package/internal/headers.js.map +1 -0
  99. package/internal/headers.mjs +74 -0
  100. package/internal/headers.mjs.map +1 -0
  101. package/internal/parse.d.mts +12 -0
  102. package/internal/parse.d.mts.map +1 -0
  103. package/internal/parse.d.ts +12 -0
  104. package/internal/parse.d.ts.map +1 -0
  105. package/internal/parse.js +40 -0
  106. package/internal/parse.js.map +1 -0
  107. package/internal/parse.mjs +37 -0
  108. package/internal/parse.mjs.map +1 -0
  109. package/internal/request-options.d.mts +75 -0
  110. package/internal/request-options.d.mts.map +1 -0
  111. package/internal/request-options.d.ts +75 -0
  112. package/internal/request-options.d.ts.map +1 -0
  113. package/internal/request-options.js +14 -0
  114. package/internal/request-options.js.map +1 -0
  115. package/internal/request-options.mjs +10 -0
  116. package/internal/request-options.mjs.map +1 -0
  117. package/internal/shim-types.d.mts +17 -0
  118. package/internal/shim-types.d.mts.map +1 -0
  119. package/internal/shim-types.d.ts +17 -0
  120. package/internal/shim-types.d.ts.map +1 -0
  121. package/internal/shim-types.js +4 -0
  122. package/internal/shim-types.js.map +1 -0
  123. package/internal/shim-types.mjs +3 -0
  124. package/internal/shim-types.mjs.map +1 -0
  125. package/internal/shims.d.mts +20 -0
  126. package/internal/shims.d.mts.map +1 -0
  127. package/internal/shims.d.ts +20 -0
  128. package/internal/shims.d.ts.map +1 -0
  129. package/internal/shims.js +92 -0
  130. package/internal/shims.js.map +1 -0
  131. package/internal/shims.mjs +85 -0
  132. package/internal/shims.mjs.map +1 -0
  133. package/internal/to-file.d.mts +45 -0
  134. package/internal/to-file.d.mts.map +1 -0
  135. package/internal/to-file.d.ts +45 -0
  136. package/internal/to-file.d.ts.map +1 -0
  137. package/internal/to-file.js +91 -0
  138. package/internal/to-file.js.map +1 -0
  139. package/internal/to-file.mjs +88 -0
  140. package/internal/to-file.mjs.map +1 -0
  141. package/internal/tslib.js +81 -0
  142. package/internal/tslib.mjs +17 -0
  143. package/internal/types.d.mts +69 -0
  144. package/internal/types.d.mts.map +1 -0
  145. package/internal/types.d.ts +69 -0
  146. package/internal/types.d.ts.map +1 -0
  147. package/internal/types.js +4 -0
  148. package/internal/types.js.map +1 -0
  149. package/internal/types.mjs +3 -0
  150. package/internal/types.mjs.map +1 -0
  151. package/internal/uploads.d.mts +42 -0
  152. package/internal/uploads.d.mts.map +1 -0
  153. package/internal/uploads.d.ts +42 -0
  154. package/internal/uploads.d.ts.map +1 -0
  155. package/internal/uploads.js +141 -0
  156. package/internal/uploads.js.map +1 -0
  157. package/internal/uploads.mjs +131 -0
  158. package/internal/uploads.mjs.map +1 -0
  159. package/internal/utils/base64.d.mts +3 -0
  160. package/internal/utils/base64.d.mts.map +1 -0
  161. package/internal/utils/base64.d.ts +3 -0
  162. package/internal/utils/base64.d.ts.map +1 -0
  163. package/internal/utils/base64.js +38 -0
  164. package/internal/utils/base64.js.map +1 -0
  165. package/internal/utils/base64.mjs +33 -0
  166. package/internal/utils/base64.mjs.map +1 -0
  167. package/internal/utils/bytes.d.mts +4 -0
  168. package/internal/utils/bytes.d.mts.map +1 -0
  169. package/internal/utils/bytes.d.ts +4 -0
  170. package/internal/utils/bytes.d.ts.map +1 -0
  171. package/internal/utils/bytes.js +31 -0
  172. package/internal/utils/bytes.js.map +1 -0
  173. package/internal/utils/bytes.mjs +26 -0
  174. package/internal/utils/bytes.mjs.map +1 -0
  175. package/internal/utils/env.d.mts +9 -0
  176. package/internal/utils/env.d.mts.map +1 -0
  177. package/internal/utils/env.d.ts +9 -0
  178. package/internal/utils/env.d.ts.map +1 -0
  179. package/internal/utils/env.js +22 -0
  180. package/internal/utils/env.js.map +1 -0
  181. package/internal/utils/env.mjs +18 -0
  182. package/internal/utils/env.mjs.map +1 -0
  183. package/internal/utils/log.d.mts +37 -0
  184. package/internal/utils/log.d.mts.map +1 -0
  185. package/internal/utils/log.d.ts +37 -0
  186. package/internal/utils/log.d.ts.map +1 -0
  187. package/internal/utils/log.js +86 -0
  188. package/internal/utils/log.js.map +1 -0
  189. package/internal/utils/log.mjs +80 -0
  190. package/internal/utils/log.mjs.map +1 -0
  191. package/internal/utils/path.d.mts +15 -0
  192. package/internal/utils/path.d.mts.map +1 -0
  193. package/internal/utils/path.d.ts +15 -0
  194. package/internal/utils/path.d.ts.map +1 -0
  195. package/internal/utils/path.js +79 -0
  196. package/internal/utils/path.js.map +1 -0
  197. package/internal/utils/path.mjs +74 -0
  198. package/internal/utils/path.mjs.map +1 -0
  199. package/internal/utils/query.d.mts +5 -0
  200. package/internal/utils/query.d.mts.map +1 -0
  201. package/internal/utils/query.js +2 -3
  202. package/internal/utils/query.js.map +1 -1
  203. package/internal/utils/query.mjs +1 -1
  204. package/internal/utils/query.mjs.map +1 -1
  205. package/internal/utils/sleep.d.mts +2 -0
  206. package/internal/utils/sleep.d.mts.map +1 -0
  207. package/internal/utils/sleep.d.ts +2 -0
  208. package/internal/utils/sleep.d.ts.map +1 -0
  209. package/internal/utils/sleep.js +7 -0
  210. package/internal/utils/sleep.js.map +1 -0
  211. package/internal/utils/sleep.mjs +3 -0
  212. package/internal/utils/sleep.mjs.map +1 -0
  213. package/internal/utils/uuid.d.mts +5 -0
  214. package/internal/utils/uuid.d.mts.map +1 -0
  215. package/internal/utils/uuid.d.ts +5 -0
  216. package/internal/utils/uuid.d.ts.map +1 -0
  217. package/internal/utils/uuid.js +19 -0
  218. package/internal/utils/uuid.js.map +1 -0
  219. package/internal/utils/uuid.mjs +15 -0
  220. package/internal/utils/uuid.mjs.map +1 -0
  221. package/internal/utils/values.d.mts +18 -0
  222. package/internal/utils/values.d.mts.map +1 -0
  223. package/internal/utils/values.d.ts +18 -0
  224. package/internal/utils/values.d.ts.map +1 -0
  225. package/internal/utils/values.js +112 -0
  226. package/internal/utils/values.js.map +1 -0
  227. package/internal/utils/values.mjs +94 -0
  228. package/internal/utils/values.mjs.map +1 -0
  229. package/internal/utils.d.mts +8 -0
  230. package/internal/utils.d.mts.map +1 -0
  231. package/internal/utils.d.ts +8 -0
  232. package/internal/utils.d.ts.map +1 -0
  233. package/internal/utils.js +12 -0
  234. package/internal/utils.js.map +1 -0
  235. package/internal/utils.mjs +9 -0
  236. package/internal/utils.mjs.map +1 -0
  237. package/package.json +114 -64
  238. package/resource.d.mts +2 -0
  239. package/resource.d.mts.map +1 -0
  240. package/resource.d.ts +1 -5
  241. package/resource.d.ts.map +1 -1
  242. package/resource.js +3 -8
  243. package/resource.js.map +1 -1
  244. package/resource.mjs +1 -6
  245. package/resource.mjs.map +1 -1
  246. package/resources/balance.d.mts +44 -0
  247. package/resources/balance.d.mts.map +1 -0
  248. package/resources/balance.d.ts +4 -3
  249. package/resources/balance.d.ts.map +1 -1
  250. package/resources/balance.js +1 -1
  251. package/resources/balance.js.map +1 -1
  252. package/resources/balance.mjs +1 -1
  253. package/resources/balance.mjs.map +1 -1
  254. package/resources/banks.d.mts +251 -0
  255. package/resources/banks.d.mts.map +1 -0
  256. package/resources/banks.d.ts +6 -5
  257. package/resources/banks.d.ts.map +1 -1
  258. package/resources/banks.js +1 -1
  259. package/resources/banks.js.map +1 -1
  260. package/resources/banks.mjs +1 -1
  261. package/resources/banks.mjs.map +1 -1
  262. package/resources/beneficiary-payouts.d.mts +64 -0
  263. package/resources/beneficiary-payouts.d.mts.map +1 -0
  264. package/resources/beneficiary-payouts.d.ts +4 -3
  265. package/resources/beneficiary-payouts.d.ts.map +1 -1
  266. package/resources/beneficiary-payouts.js +1 -1
  267. package/resources/beneficiary-payouts.js.map +1 -1
  268. package/resources/beneficiary-payouts.mjs +1 -1
  269. package/resources/beneficiary-payouts.mjs.map +1 -1
  270. package/resources/capabilities.d.mts +20 -0
  271. package/resources/capabilities.d.mts.map +1 -0
  272. package/resources/capabilities.d.ts +4 -3
  273. package/resources/capabilities.d.ts.map +1 -1
  274. package/resources/capabilities.js +1 -1
  275. package/resources/capabilities.js.map +1 -1
  276. package/resources/capabilities.mjs +1 -1
  277. package/resources/capabilities.mjs.map +1 -1
  278. package/resources/checkoutsession.d.mts +659 -0
  279. package/resources/checkoutsession.d.mts.map +1 -0
  280. package/resources/checkoutsession.d.ts +6 -5
  281. package/resources/checkoutsession.d.ts.map +1 -1
  282. package/resources/checkoutsession.js +1 -1
  283. package/resources/checkoutsession.js.map +1 -1
  284. package/resources/checkoutsession.mjs +1 -1
  285. package/resources/checkoutsession.mjs.map +1 -1
  286. package/resources/customers.d.mts +668 -0
  287. package/resources/customers.d.mts.map +1 -0
  288. package/resources/customers.d.ts +8 -7
  289. package/resources/customers.d.ts.map +1 -1
  290. package/resources/customers.js +1 -1
  291. package/resources/customers.js.map +1 -1
  292. package/resources/customers.mjs +1 -1
  293. package/resources/customers.mjs.map +1 -1
  294. package/resources/data/accounts.d.mts +95 -0
  295. package/resources/data/accounts.d.mts.map +1 -0
  296. package/resources/data/accounts.d.ts +4 -3
  297. package/resources/data/accounts.d.ts.map +1 -1
  298. package/resources/data/accounts.js +1 -1
  299. package/resources/data/accounts.js.map +1 -1
  300. package/resources/data/accounts.mjs +1 -1
  301. package/resources/data/accounts.mjs.map +1 -1
  302. package/resources/data/balances.d.mts +49 -0
  303. package/resources/data/balances.d.mts.map +1 -0
  304. package/resources/data/balances.d.ts +4 -3
  305. package/resources/data/balances.d.ts.map +1 -1
  306. package/resources/data/balances.js +1 -1
  307. package/resources/data/balances.js.map +1 -1
  308. package/resources/data/balances.mjs +1 -1
  309. package/resources/data/balances.mjs.map +1 -1
  310. package/resources/data/consent.d.mts +81 -0
  311. package/resources/data/consent.d.mts.map +1 -0
  312. package/resources/data/consent.d.ts +5 -4
  313. package/resources/data/consent.d.ts.map +1 -1
  314. package/resources/data/consent.js +1 -1
  315. package/resources/data/consent.js.map +1 -1
  316. package/resources/data/consent.mjs +1 -1
  317. package/resources/data/consent.mjs.map +1 -1
  318. package/resources/data/data.d.mts +26 -0
  319. package/resources/data/data.d.mts.map +1 -0
  320. package/resources/data/data.d.ts +1 -1
  321. package/resources/data/data.d.ts.map +1 -1
  322. package/resources/data/data.js +7 -29
  323. package/resources/data/data.js.map +1 -1
  324. package/resources/data/data.mjs +1 -1
  325. package/resources/data/index.d.mts +7 -0
  326. package/resources/data/index.d.mts.map +1 -0
  327. package/resources/data/index.d.ts.map +1 -1
  328. package/resources/data/session.d.mts +259 -0
  329. package/resources/data/session.d.mts.map +1 -0
  330. package/resources/data/session.d.ts +5 -4
  331. package/resources/data/session.d.ts.map +1 -1
  332. package/resources/data/session.js +1 -1
  333. package/resources/data/session.js.map +1 -1
  334. package/resources/data/session.mjs +1 -1
  335. package/resources/data/session.mjs.map +1 -1
  336. package/resources/data/transactions.d.mts +62 -0
  337. package/resources/data/transactions.d.mts.map +1 -0
  338. package/resources/data/transactions.d.ts +4 -3
  339. package/resources/data/transactions.d.ts.map +1 -1
  340. package/resources/data/transactions.js +1 -1
  341. package/resources/data/transactions.js.map +1 -1
  342. package/resources/data/transactions.mjs +1 -1
  343. package/resources/data/transactions.mjs.map +1 -1
  344. package/resources/data.d.mts +2 -0
  345. package/resources/data.d.mts.map +1 -0
  346. package/resources/data.d.ts.map +1 -1
  347. package/resources/data.js +2 -15
  348. package/resources/data.js.map +1 -1
  349. package/resources/deposits.d.mts +192 -0
  350. package/resources/deposits.d.mts.map +1 -0
  351. package/resources/deposits.d.ts +4 -3
  352. package/resources/deposits.d.ts.map +1 -1
  353. package/resources/deposits.js +1 -1
  354. package/resources/deposits.js.map +1 -1
  355. package/resources/deposits.mjs +1 -1
  356. package/resources/deposits.mjs.map +1 -1
  357. package/resources/fx.d.mts +155 -0
  358. package/resources/fx.d.mts.map +1 -0
  359. package/resources/fx.d.ts +6 -5
  360. package/resources/fx.d.ts.map +1 -1
  361. package/resources/fx.js +1 -1
  362. package/resources/fx.js.map +1 -1
  363. package/resources/fx.mjs +1 -1
  364. package/resources/fx.mjs.map +1 -1
  365. package/resources/index.d.mts +18 -0
  366. package/resources/index.d.mts.map +1 -0
  367. package/resources/index.d.ts.map +1 -1
  368. package/resources/orders.d.mts +1251 -0
  369. package/resources/orders.d.mts.map +1 -0
  370. package/resources/orders.d.ts +6 -5
  371. package/resources/orders.d.ts.map +1 -1
  372. package/resources/orders.js +1 -1
  373. package/resources/orders.js.map +1 -1
  374. package/resources/orders.mjs +1 -1
  375. package/resources/orders.mjs.map +1 -1
  376. package/resources/payee.d.mts +51 -0
  377. package/resources/payee.d.mts.map +1 -0
  378. package/resources/payee.d.ts +4 -3
  379. package/resources/payee.d.ts.map +1 -1
  380. package/resources/payee.js +1 -1
  381. package/resources/payee.js.map +1 -1
  382. package/resources/payee.mjs +1 -1
  383. package/resources/payee.mjs.map +1 -1
  384. package/resources/payouts.d.mts +459 -0
  385. package/resources/payouts.d.mts.map +1 -0
  386. package/resources/payouts.d.ts +6 -5
  387. package/resources/payouts.d.ts.map +1 -1
  388. package/resources/payouts.js +1 -1
  389. package/resources/payouts.js.map +1 -1
  390. package/resources/payouts.mjs +1 -1
  391. package/resources/payouts.mjs.map +1 -1
  392. package/resources/refunds.d.mts +97 -0
  393. package/resources/refunds.d.mts.map +1 -0
  394. package/resources/refunds.d.ts +5 -4
  395. package/resources/refunds.d.ts.map +1 -1
  396. package/resources/refunds.js +1 -1
  397. package/resources/refunds.js.map +1 -1
  398. package/resources/refunds.mjs +1 -1
  399. package/resources/refunds.mjs.map +1 -1
  400. package/resources/returns.d.mts +105 -0
  401. package/resources/returns.d.mts.map +1 -0
  402. package/resources/returns.d.ts +5 -4
  403. package/resources/returns.d.ts.map +1 -1
  404. package/resources/returns.js +1 -1
  405. package/resources/returns.js.map +1 -1
  406. package/resources/returns.mjs +1 -1
  407. package/resources/returns.mjs.map +1 -1
  408. package/resources/subaccounts.d.mts +60 -0
  409. package/resources/subaccounts.d.mts.map +1 -0
  410. package/resources/subaccounts.d.ts +5 -4
  411. package/resources/subaccounts.d.ts.map +1 -1
  412. package/resources/subaccounts.js +1 -1
  413. package/resources/subaccounts.js.map +1 -1
  414. package/resources/subaccounts.mjs +1 -1
  415. package/resources/subaccounts.mjs.map +1 -1
  416. package/resources/transactions.d.mts +198 -0
  417. package/resources/transactions.d.mts.map +1 -0
  418. package/resources/transactions.d.ts +4 -3
  419. package/resources/transactions.d.ts.map +1 -1
  420. package/resources/transactions.js +1 -1
  421. package/resources/transactions.js.map +1 -1
  422. package/resources/transactions.mjs +1 -1
  423. package/resources/transactions.mjs.map +1 -1
  424. package/resources/webhook/index.d.mts +3 -0
  425. package/resources/webhook/index.d.mts.map +1 -0
  426. package/resources/webhook/index.d.ts.map +1 -1
  427. package/resources/webhook/subscription.d.mts +153 -0
  428. package/resources/webhook/subscription.d.mts.map +1 -0
  429. package/resources/webhook/subscription.d.ts +8 -7
  430. package/resources/webhook/subscription.d.ts.map +1 -1
  431. package/resources/webhook/subscription.js +1 -1
  432. package/resources/webhook/subscription.js.map +1 -1
  433. package/resources/webhook/subscription.mjs +1 -1
  434. package/resources/webhook/subscription.mjs.map +1 -1
  435. package/resources/webhook/webhook.d.mts +29 -0
  436. package/resources/webhook/webhook.d.mts.map +1 -0
  437. package/resources/webhook/webhook.d.ts +4 -3
  438. package/resources/webhook/webhook.d.ts.map +1 -1
  439. package/resources/webhook/webhook.js +3 -25
  440. package/resources/webhook/webhook.js.map +1 -1
  441. package/resources/webhook/webhook.mjs +1 -1
  442. package/resources/webhook/webhook.mjs.map +1 -1
  443. package/resources/webhook.d.mts +2 -0
  444. package/resources/webhook.d.mts.map +1 -0
  445. package/resources/webhook.d.ts.map +1 -1
  446. package/resources/webhook.js +2 -15
  447. package/resources/webhook.js.map +1 -1
  448. package/resources.d.mts +2 -0
  449. package/resources.d.mts.map +1 -0
  450. package/resources.d.ts.map +1 -1
  451. package/resources.js +2 -15
  452. package/resources.js.map +1 -1
  453. package/src/api-promise.ts +2 -0
  454. package/src/client.ts +1002 -0
  455. package/src/core/README.md +3 -0
  456. package/src/core/api-promise.ts +89 -0
  457. package/src/core/error.ts +130 -0
  458. package/src/core/resource.ts +11 -0
  459. package/src/core/uploads.ts +2 -0
  460. package/src/error.ts +2 -130
  461. package/src/index.ts +5 -450
  462. package/src/internal/README.md +3 -0
  463. package/src/internal/builtin-types.ts +93 -0
  464. package/src/internal/detect-platform.ts +196 -0
  465. package/src/internal/errors.ts +33 -0
  466. package/src/internal/headers.ts +97 -0
  467. package/src/internal/parse.ts +56 -0
  468. package/src/internal/request-options.ts +91 -0
  469. package/src/internal/shim-types.ts +26 -0
  470. package/src/internal/shims.ts +107 -0
  471. package/src/internal/to-file.ts +154 -0
  472. package/src/internal/types.ts +95 -0
  473. package/src/internal/uploads.ts +187 -0
  474. package/src/internal/utils/base64.ts +40 -0
  475. package/src/internal/utils/bytes.ts +32 -0
  476. package/src/internal/utils/env.ts +18 -0
  477. package/src/internal/utils/log.ts +127 -0
  478. package/src/internal/utils/path.ts +88 -0
  479. package/src/internal/utils/query.ts +1 -1
  480. package/src/internal/utils/sleep.ts +3 -0
  481. package/src/internal/utils/uuid.ts +17 -0
  482. package/src/internal/utils/values.ts +105 -0
  483. package/src/internal/utils.ts +9 -0
  484. package/src/resource.ts +2 -11
  485. package/src/resources/balance.ts +4 -6
  486. package/src/resources/banks.ts +6 -5
  487. package/src/resources/beneficiary-payouts.ts +4 -3
  488. package/src/resources/capabilities.ts +4 -6
  489. package/src/resources/checkoutsession.ts +9 -8
  490. package/src/resources/customers.ts +8 -10
  491. package/src/resources/data/accounts.ts +4 -3
  492. package/src/resources/data/balances.ts +4 -3
  493. package/src/resources/data/consent.ts +5 -7
  494. package/src/resources/data/data.ts +1 -1
  495. package/src/resources/data/session.ts +5 -7
  496. package/src/resources/data/transactions.ts +4 -3
  497. package/src/resources/deposits.ts +4 -6
  498. package/src/resources/fx.ts +6 -8
  499. package/src/resources/orders.ts +6 -5
  500. package/src/resources/payee.ts +4 -3
  501. package/src/resources/payouts.ts +6 -8
  502. package/src/resources/refunds.ts +5 -4
  503. package/src/resources/returns.ts +5 -7
  504. package/src/resources/subaccounts.ts +5 -7
  505. package/src/resources/transactions.ts +4 -3
  506. package/src/resources/webhook/subscription.ts +8 -22
  507. package/src/resources/webhook/webhook.ts +4 -6
  508. package/src/tsconfig.json +2 -2
  509. package/src/uploads.ts +2 -255
  510. package/src/version.ts +1 -1
  511. package/uploads.d.mts +2 -0
  512. package/uploads.d.mts.map +1 -0
  513. package/uploads.d.ts +1 -74
  514. package/uploads.d.ts.map +1 -1
  515. package/uploads.js +3 -168
  516. package/uploads.js.map +1 -1
  517. package/uploads.mjs +1 -157
  518. package/uploads.mjs.map +1 -1
  519. package/version.d.mts +2 -0
  520. package/version.d.mts.map +1 -0
  521. package/version.d.ts +1 -1
  522. package/version.js +1 -1
  523. package/version.mjs +1 -1
  524. package/_shims/MultipartBody.d.ts +0 -9
  525. package/_shims/MultipartBody.d.ts.map +0 -1
  526. package/_shims/MultipartBody.js +0 -16
  527. package/_shims/MultipartBody.js.map +0 -1
  528. package/_shims/MultipartBody.mjs +0 -12
  529. package/_shims/MultipartBody.mjs.map +0 -1
  530. package/_shims/README.md +0 -46
  531. package/_shims/auto/runtime-bun.d.ts +0 -5
  532. package/_shims/auto/runtime-bun.d.ts.map +0 -1
  533. package/_shims/auto/runtime-bun.js +0 -21
  534. package/_shims/auto/runtime-bun.js.map +0 -1
  535. package/_shims/auto/runtime-bun.mjs +0 -2
  536. package/_shims/auto/runtime-bun.mjs.map +0 -1
  537. package/_shims/auto/runtime-node.d.ts +0 -5
  538. package/_shims/auto/runtime-node.d.ts.map +0 -1
  539. package/_shims/auto/runtime-node.js +0 -21
  540. package/_shims/auto/runtime-node.js.map +0 -1
  541. package/_shims/auto/runtime-node.mjs +0 -2
  542. package/_shims/auto/runtime-node.mjs.map +0 -1
  543. package/_shims/auto/runtime.d.ts +0 -5
  544. package/_shims/auto/runtime.d.ts.map +0 -1
  545. package/_shims/auto/runtime.js +0 -21
  546. package/_shims/auto/runtime.js.map +0 -1
  547. package/_shims/auto/runtime.mjs +0 -2
  548. package/_shims/auto/runtime.mjs.map +0 -1
  549. package/_shims/auto/types-node.d.ts +0 -5
  550. package/_shims/auto/types-node.d.ts.map +0 -1
  551. package/_shims/auto/types-node.js +0 -21
  552. package/_shims/auto/types-node.js.map +0 -1
  553. package/_shims/auto/types-node.mjs +0 -2
  554. package/_shims/auto/types-node.mjs.map +0 -1
  555. package/_shims/auto/types.d.ts +0 -101
  556. package/_shims/auto/types.js +0 -3
  557. package/_shims/auto/types.mjs +0 -3
  558. package/_shims/bun-runtime.d.ts +0 -6
  559. package/_shims/bun-runtime.d.ts.map +0 -1
  560. package/_shims/bun-runtime.js +0 -14
  561. package/_shims/bun-runtime.js.map +0 -1
  562. package/_shims/bun-runtime.mjs +0 -10
  563. package/_shims/bun-runtime.mjs.map +0 -1
  564. package/_shims/index.d.ts +0 -83
  565. package/_shims/index.js +0 -17
  566. package/_shims/index.mjs +0 -11
  567. package/_shims/manual-types.d.ts +0 -12
  568. package/_shims/manual-types.js +0 -3
  569. package/_shims/manual-types.mjs +0 -3
  570. package/_shims/node-runtime.d.ts +0 -3
  571. package/_shims/node-runtime.d.ts.map +0 -1
  572. package/_shims/node-runtime.js +0 -89
  573. package/_shims/node-runtime.js.map +0 -1
  574. package/_shims/node-runtime.mjs +0 -56
  575. package/_shims/node-runtime.mjs.map +0 -1
  576. package/_shims/node-types.d.ts +0 -42
  577. package/_shims/node-types.js +0 -3
  578. package/_shims/node-types.mjs +0 -3
  579. package/_shims/registry.d.ts +0 -37
  580. package/_shims/registry.d.ts.map +0 -1
  581. package/_shims/registry.js +0 -41
  582. package/_shims/registry.js.map +0 -1
  583. package/_shims/registry.mjs +0 -37
  584. package/_shims/registry.mjs.map +0 -1
  585. package/_shims/web-runtime.d.ts +0 -5
  586. package/_shims/web-runtime.d.ts.map +0 -1
  587. package/_shims/web-runtime.js +0 -78
  588. package/_shims/web-runtime.js.map +0 -1
  589. package/_shims/web-runtime.mjs +0 -71
  590. package/_shims/web-runtime.mjs.map +0 -1
  591. package/_shims/web-types.d.ts +0 -83
  592. package/_shims/web-types.js +0 -3
  593. package/_shims/web-types.mjs +0 -3
  594. package/core.d.ts +0 -255
  595. package/core.d.ts.map +0 -1
  596. package/core.js +0 -920
  597. package/core.js.map +0 -1
  598. package/core.mjs +0 -888
  599. package/core.mjs.map +0 -1
  600. package/shims/node.d.ts +0 -30
  601. package/shims/node.d.ts.map +0 -1
  602. package/shims/node.js +0 -31
  603. package/shims/node.js.map +0 -1
  604. package/shims/node.mjs +0 -5
  605. package/shims/node.mjs.map +0 -1
  606. package/shims/web.d.ts +0 -26
  607. package/shims/web.d.ts.map +0 -1
  608. package/shims/web.js +0 -31
  609. package/shims/web.js.map +0 -1
  610. package/shims/web.mjs +0 -5
  611. package/shims/web.mjs.map +0 -1
  612. package/src/_shims/MultipartBody.ts +0 -9
  613. package/src/_shims/README.md +0 -46
  614. package/src/_shims/auto/runtime-bun.ts +0 -4
  615. package/src/_shims/auto/runtime-node.ts +0 -4
  616. package/src/_shims/auto/runtime.ts +0 -4
  617. package/src/_shims/auto/types-node.ts +0 -4
  618. package/src/_shims/auto/types.d.ts +0 -101
  619. package/src/_shims/auto/types.js +0 -3
  620. package/src/_shims/auto/types.mjs +0 -3
  621. package/src/_shims/bun-runtime.ts +0 -14
  622. package/src/_shims/index.d.ts +0 -83
  623. package/src/_shims/index.js +0 -17
  624. package/src/_shims/index.mjs +0 -11
  625. package/src/_shims/manual-types.d.ts +0 -12
  626. package/src/_shims/manual-types.js +0 -3
  627. package/src/_shims/manual-types.mjs +0 -3
  628. package/src/_shims/node-runtime.ts +0 -81
  629. package/src/_shims/node-types.d.ts +0 -42
  630. package/src/_shims/node-types.js +0 -3
  631. package/src/_shims/node-types.mjs +0 -3
  632. package/src/_shims/registry.ts +0 -67
  633. package/src/_shims/web-runtime.ts +0 -103
  634. package/src/_shims/web-types.d.ts +0 -83
  635. package/src/_shims/web-types.js +0 -3
  636. package/src/_shims/web-types.mjs +0 -3
  637. package/src/core.ts +0 -1231
  638. package/src/shims/node.ts +0 -50
  639. package/src/shims/web.ts +0 -50
@@ -0,0 +1,668 @@
1
+ import { APIResource } from "../core/resource.mjs";
2
+ import { APIPromise } from "../core/api-promise.mjs";
3
+ import { RequestOptions } from "../internal/request-options.mjs";
4
+ export declare class Customers extends APIResource {
5
+ /**
6
+ * Create a new Customer representing your Customers. You can use the Customer to
7
+ * simplify the checkout process for returning journeys.
8
+ */
9
+ create(body: CustomerCreateParams, options?: RequestOptions): APIPromise<CustomerCreateResponse>;
10
+ /**
11
+ * Retrieve a Customer Object by its id.
12
+ */
13
+ retrieve(body: CustomerRetrieveParams, options?: RequestOptions): APIPromise<CustomerRetrieveResponse>;
14
+ /**
15
+ * Update the Customer details
16
+ */
17
+ update(body: CustomerUpdateParams, options?: RequestOptions): APIPromise<CustomerUpdateResponse>;
18
+ /**
19
+ * Delete a Customer by wiping personal data and marking the customer as deleted.
20
+ */
21
+ delete(body: CustomerDeleteParams, options?: RequestOptions): APIPromise<CustomerDeleteResponse>;
22
+ /**
23
+ * Search for customers you have previously created using filters, e.g. by email.
24
+ */
25
+ search(body: CustomerSearchParams, options?: RequestOptions): APIPromise<CustomerSearchResponse>;
26
+ }
27
+ export interface CustomerCreateResponse {
28
+ /**
29
+ * The id of the customer
30
+ */
31
+ id: string;
32
+ /**
33
+ * Array of bank accounts remembered by user
34
+ */
35
+ bankAccounts: Array<CustomerCreateResponse.BankAccount>;
36
+ /**
37
+ * The registered address of the customer
38
+ */
39
+ address?: CustomerCreateResponse.Address;
40
+ /**
41
+ * Customer's date of birth in ISO 8601 datetime format. Example: '2025-09-05'.
42
+ * Reference: https://en.wikipedia.org/wiki/ISO_8601
43
+ */
44
+ dateOfBirth?: string;
45
+ /**
46
+ * Indicates whether the customer was deleted
47
+ */
48
+ deleted?: boolean;
49
+ /**
50
+ * The customer deletion timestamp
51
+ */
52
+ deletedAt?: string;
53
+ /**
54
+ * The email address of the customer
55
+ */
56
+ email?: string;
57
+ /**
58
+ * Deprecated. Use the customer.email instead
59
+ */
60
+ emailAddress?: string;
61
+ /**
62
+ * The full name or business name of the customer
63
+ */
64
+ fullName?: string;
65
+ /**
66
+ * A collection of key-value pairs that can be associated with an object to store
67
+ * custom data in a structured manner. This allows you to attach arbitrary
68
+ * information to enhance the object with additional context or properties. To
69
+ * clear the metadata, send an empty object.
70
+ */
71
+ metadata?: {
72
+ [key: string]: unknown;
73
+ };
74
+ /**
75
+ * The phone number of the customer
76
+ */
77
+ phone?: string;
78
+ }
79
+ export declare namespace CustomerCreateResponse {
80
+ interface BankAccount {
81
+ /**
82
+ * Remembered bank details
83
+ */
84
+ bank: BankAccount.Bank;
85
+ /**
86
+ * Last 4 digits of remembered account number
87
+ */
88
+ last4digits: string;
89
+ }
90
+ namespace BankAccount {
91
+ /**
92
+ * Remembered bank details
93
+ */
94
+ interface Bank {
95
+ /**
96
+ * The id of the bank
97
+ */
98
+ id: string;
99
+ /**
100
+ * The name of the bank
101
+ */
102
+ name: string;
103
+ /**
104
+ * URL address of bank logo image
105
+ */
106
+ logo?: string;
107
+ }
108
+ }
109
+ /**
110
+ * The registered address of the customer
111
+ */
112
+ interface Address {
113
+ /**
114
+ * ISO 3166-1 alpha-2 country code (e.g. DE)
115
+ */
116
+ country: 'AF' | 'AL' | 'DZ' | 'AS' | 'AD' | 'AO' | 'AI' | 'AQ' | 'AG' | 'AR' | 'AM' | 'AW' | 'AU' | 'AT' | 'AZ' | 'BS' | 'BH' | 'BD' | 'BB' | 'BY' | 'BE' | 'BZ' | 'BJ' | 'BM' | 'BT' | 'BO' | 'BA' | 'BW' | 'BV' | 'BR' | 'IO' | 'BN' | 'BG' | 'BF' | 'BI' | 'KH' | 'CM' | 'CA' | 'CV' | 'KY' | 'CF' | 'TD' | 'CL' | 'CN' | 'CX' | 'CC' | 'CO' | 'KM' | 'CG' | 'CD' | 'CK' | 'CR' | 'CI' | 'HR' | 'CU' | 'CY' | 'CZ' | 'DK' | 'DJ' | 'DM' | 'DO' | 'EC' | 'EG' | 'SV' | 'GQ' | 'ER' | 'EE' | 'ET' | 'FK' | 'FO' | 'FJ' | 'FI' | 'FR' | 'GF' | 'PF' | 'TF' | 'GA' | 'GM' | 'GE' | 'DE' | 'GH' | 'GI' | 'GR' | 'GL' | 'GD' | 'GP' | 'GU' | 'GT' | 'GN' | 'GW' | 'GY' | 'HT' | 'HM' | 'VA' | 'HN' | 'HK' | 'HU' | 'IS' | 'IN' | 'ID' | 'IR' | 'IQ' | 'IE' | 'IL' | 'IT' | 'JM' | 'JP' | 'JO' | 'KZ' | 'KE' | 'KI' | 'KP' | 'KR' | 'KW' | 'KG' | 'LA' | 'LV' | 'LB' | 'LS' | 'LR' | 'LY' | 'LI' | 'LT' | 'LU' | 'MO' | 'MG' | 'MW' | 'MY' | 'MV' | 'ML' | 'MT' | 'MH' | 'MQ' | 'MR' | 'MU' | 'YT' | 'MX' | 'FM' | 'MD' | 'MC' | 'MN' | 'MS' | 'MA' | 'MZ' | 'MM' | 'NA' | 'NR' | 'NP' | 'NL' | 'NC' | 'NZ' | 'NI' | 'NE' | 'NG' | 'NU' | 'NF' | 'MP' | 'MK' | 'NO' | 'OM' | 'PK' | 'PW' | 'PS' | 'PA' | 'PG' | 'PY' | 'PE' | 'PH' | 'PN' | 'PL' | 'PT' | 'PR' | 'QA' | 'RE' | 'RO' | 'RU' | 'RW' | 'SH' | 'KN' | 'LC' | 'PM' | 'VC' | 'WS' | 'SM' | 'ST' | 'SA' | 'SN' | 'SC' | 'SL' | 'SG' | 'SK' | 'SI' | 'SB' | 'SO' | 'ZA' | 'GS' | 'ES' | 'LK' | 'SD' | 'SR' | 'SJ' | 'SZ' | 'SE' | 'CH' | 'SY' | 'TW' | 'TJ' | 'TZ' | 'TH' | 'TL' | 'TG' | 'TK' | 'TO' | 'TT' | 'TN' | 'TR' | 'TM' | 'TC' | 'TV' | 'UG' | 'UA' | 'AE' | 'GB' | 'US' | 'UM' | 'UY' | 'UZ' | 'VU' | 'VE' | 'VN' | 'VG' | 'VI' | 'WF' | 'EH' | 'YE' | 'ZM' | 'ZW' | 'AX' | 'BQ' | 'CW' | 'GG' | 'IM' | 'JE' | 'ME' | 'BL' | 'MF' | 'RS' | 'SX' | 'SS' | 'XK';
117
+ /**
118
+ * Full name of the city
119
+ */
120
+ city?: string;
121
+ /**
122
+ * Address line 1
123
+ */
124
+ line1?: string;
125
+ /**
126
+ * Address line 2
127
+ */
128
+ line2?: string;
129
+ /**
130
+ * The second part of the subdivision ISO 3166-2 country code (e.g. BE)
131
+ */
132
+ region?: '02' | '03' | '04' | '05' | '06' | '07' | '08' | 'AJ' | 'AZ' | 'DU' | 'FU' | 'RK' | 'SH' | 'UQ' | 'BAL' | 'BAM' | 'BDG' | 'BDS' | 'BGL' | 'DAY' | 'FRA' | 'FYB' | 'GHA' | 'GHO' | 'HEL' | 'HER' | 'JOW' | 'KAB' | 'KAN' | 'KAP' | 'KDZ' | 'KHO' | 'KNR' | 'LAG' | 'LOG' | 'NAN' | 'NIM' | 'NUR' | 'PAN' | 'PAR' | 'PIA' | 'PKA' | 'SAM' | 'SAR' | 'TAK' | 'URU' | 'WAR' | 'ZAB' | '10' | '11' | '01' | '09' | '12' | 'AG' | 'AR' | 'AV' | 'ER' | 'GR' | 'KT' | 'LO' | 'SU' | 'TV' | 'VD' | 'BGO' | 'BGU' | 'BIE' | 'CAB' | 'CCU' | 'CNN' | 'CNO' | 'CUS' | 'HUA' | 'HUI' | 'LNO' | 'LSU' | 'LUA' | 'MAL' | 'MOX' | 'NAM' | 'UIG' | 'ZAI' | 'A' | 'B' | 'C' | 'D' | 'E' | 'F' | 'G' | 'H' | 'J' | 'K' | 'L' | 'M' | 'N' | 'P' | 'Q' | 'R' | 'S' | 'T' | 'U' | 'V' | 'W' | 'X' | 'Y' | 'Z' | '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9' | 'ACT' | 'NSW' | 'NT' | 'QLD' | 'SA' | 'TAS' | 'VIC' | 'WA' | 'ABS' | 'AGA' | 'AGC' | 'AGM' | 'AGS' | 'AGU' | 'AST' | 'BA' | 'BAB' | 'BAR' | 'BEY' | 'BIL' | 'CAL' | 'CUL' | 'DAS' | 'FUZ' | 'GA' | 'GAD' | 'GOR' | 'GOY' | 'GYG' | 'HAC' | 'IMI' | 'ISM' | 'KAL' | 'KUR' | 'LA' | 'LAC' | 'LAN' | 'LER' | 'MAS' | 'MI' | 'NA' | 'NEF' | 'NV' | 'NX' | 'OGU' | 'ORD' | 'QAB' | 'QAX' | 'QAZ' | 'QBA' | 'QBI' | 'QOB' | 'QUS' | 'SAB' | 'SAD' | 'SAH' | 'SAK' | 'SAL' | 'SAT' | 'SBN' | 'SIY' | 'SKR' | 'SM' | 'SMI' | 'SMX' | 'SR' | 'SUS' | 'TAR' | 'TOV' | 'UCA' | 'XA' | 'XAC' | 'XCI' | 'XIZ' | 'XVD' | 'YAR' | 'YE' | 'YEV' | 'ZAN' | 'ZAQ' | 'ZAR' | 'BIH' | 'BRC' | 'SRP' | '13' | '14' | '15' | '16' | '17' | '18' | '19' | '20' | '21' | '22' | '23' | '24' | '25' | '26' | '27' | '28' | '29' | '30' | '31' | '32' | '33' | '34' | '35' | '36' | '37' | '38' | '39' | '40' | '41' | '42' | '43' | '44' | '45' | '46' | '47' | '48' | '49' | '50' | '51' | '52' | '53' | '54' | '55' | '56' | '57' | '58' | '59' | '60' | '61' | '62' | '63' | '64' | 'BRU' | 'VAN' | 'VBR' | 'VLG' | 'VLI' | 'VOV' | 'VWV' | 'WAL' | 'WBR' | 'WHT' | 'WLG' | 'WLX' | 'WNA' | 'BAN' | 'BAZ' | 'BGR' | 'BLG' | 'BLK' | 'COM' | 'GAN' | 'GNA' | 'GOU' | 'HOU' | 'IOB' | 'KAD' | 'KEN' | 'KMD' | 'KMP' | 'KOP' | 'KOS' | 'KOT' | 'KOW' | 'LOR' | 'MOU' | 'NAO' | 'NAY' | 'NOU' | 'OUB' | 'OUD' | 'PAS' | 'PON' | 'SEN' | 'SIS' | 'SMT' | 'SNG' | 'SOM' | 'SOR' | 'TAP' | 'TUI' | 'YAG' | 'YAT' | 'ZIR' | 'ZON' | 'ZOU' | 'BB' | 'BL' | 'BM' | 'BR' | 'CA' | 'CI' | 'GI' | 'KI' | 'KR' | 'KY' | 'MA' | 'MU' | 'MW' | 'MY' | 'NG' | 'RM' | 'RT' | 'RY' | 'AK' | 'AL' | 'AQ' | 'BO' | 'CO' | 'DO' | 'KO' | 'LI' | 'MO' | 'OU' | 'PL' | 'ZO' | 'BE' | 'TE' | 'TU' | 'O' | 'SE' | 'AC' | 'AM' | 'AP' | 'CE' | 'DF' | 'ES' | 'GO' | 'MG' | 'MS' | 'MT' | 'PA' | 'PB' | 'PE' | 'PI' | 'PR' | 'RJ' | 'RN' | 'RO' | 'RR' | 'RS' | 'SC' | 'SP' | 'TO' | 'BI' | 'BP' | 'BY' | 'CK' | 'CS' | 'EG' | 'EX' | 'FP' | 'GC' | 'HI' | 'HT' | 'IN' | 'MC' | 'NE' | 'NO' | 'NP' | 'NS' | 'RC' | 'RI' | 'SO' | 'SS' | 'SW' | 'WG' | 'TY' | 'CH' | 'FR' | 'GH' | 'JW' | 'KG' | 'KL' | 'KW' | 'NW' | 'ST' | 'HM' | 'HO' | 'HR' | 'VI' | 'BZ' | 'CY' | 'CZL' | 'OW' | 'TOL' | 'AB' | 'BC' | 'MB' | 'NB' | 'NL' | 'NU' | 'ON' | 'QC' | 'SK' | 'YT' | 'BU' | 'EQ' | 'HK' | 'HL' | 'HU' | 'IT' | 'KC' | 'KE' | 'KN' | 'KS' | 'LU' | 'MN' | 'NK' | 'TA' | 'BGF' | 'BK' | 'HS' | 'KB' | 'LB' | 'MP' | 'NM' | 'OP' | 'UK' | 'VK' | 'BZV' | 'AI' | 'BS' | 'GE' | 'GL' | 'JU' | 'SG' | 'SZ' | 'TG' | 'TI' | 'UR' | 'VS' | 'ZG' | 'ZH' | 'CM' | 'DN' | 'GD' | 'LC' | 'LG' | 'SV' | 'VB' | 'WR' | 'YM' | 'ZZ' | 'AN' | 'AT' | 'LL' | 'LR' | 'ML' | 'AD' | 'EN' | 'LT' | 'AH' | 'BJ' | 'CQ' | 'FJ' | 'GS' | 'GX' | 'GZ' | 'HA' | 'HB' | 'HE' | 'HN' | 'JL' | 'JS' | 'JX' | 'LN' | 'QH' | 'SD' | 'SN' | 'SX' | 'TJ' | 'TW' | 'XJ' | 'XZ' | 'YN' | 'ZJ' | 'AMA' | 'ANT' | 'ARA' | 'ATL' | 'BOL' | 'BOY' | 'CAQ' | 'CAS' | 'CAU' | 'CES' | 'CHO' | 'COR' | 'CUN' | 'DC' | 'GUA' | 'GUV' | 'MAG' | 'MET' | 'NAR' | 'NSA' | 'PUT' | 'QUI' | 'RIS' | 'SAN' | 'SAP' | 'SUC' | 'VAC' | 'VAU' | 'VID' | 'SJ' | '99' | 'BV' | 'CF' | 'CR' | 'PN' | 'RB' | 'RG' | 'SF' | 'SL' | 'TS' | '201' | '202' | '203' | '204' | '205' | '206' | '207' | '208' | '209' | '20A' | '20B' | '20C' | '311' | '312' | '313' | '314' | '315' | '316' | '317' | '321' | '322' | '323' | '324' | '325' | '326' | '327' | '411' | '412' | '413' | '421' | '422' | '423' | '424' | '425' | '426' | '427' | '511' | '512' | '513' | '514' | '521' | '522' | '523' | '524' | '525' | '531' | '532' | '533' | '534' | '631' | '632' | '633' | '634' | '635' | '641' | '642' | '643' | '644' | '645' | '646' | '647' | '71' | '711' | '712' | '713' | '714' | '715' | '72' | '721' | '722' | '723' | '724' | '80' | '801' | '802' | '803' | '804' | '805' | '806' | 'BW' | 'HH' | 'MV' | 'NI' | 'RP' | 'TH' | 'AS' | 'DI' | 'DJ' | 'OB' | '015' | '020' | '025' | '030' | '035' | '040' | '042' | '050' | '055' | '060' | '065' | '070' | '076' | '080' | '101' | '147' | '81' | '82' | '83' | '84' | '85' | 'I' | '130' | '141' | '142' | '171' | '184' | '191' | '198' | '214' | '245' | '247' | '251' | '255' | '272' | '283' | '284' | '291' | '293' | '296' | '303' | '305' | '338' | '353' | '430' | '431' | '432' | '441' | '442' | '446' | '478' | '480' | '486' | '503' | '528' | '557' | '567' | '586' | '615' | '618' | '622' | '624' | '638' | '651' | '653' | '661' | '663' | '668' | '68' | '689' | '698' | '708' | '719' | '726' | '732' | '735' | '74' | '784' | '79' | '792' | '793' | '796' | '809' | '824' | '834' | '855' | '87' | '890' | '897' | '899' | '901' | '903' | '907' | '917' | '919' | '928' | 'ALX' | 'ASN' | 'BH' | 'BNS' | 'DK' | 'DT' | 'FYM' | 'IS' | 'KFS' | 'LX' | 'MNF' | 'PTS' | 'SHG' | 'SHR' | 'SIN' | 'SUZ' | 'WAD' | 'GB' | 'CB' | 'CC' | 'CL' | 'CN' | 'CT' | 'CU' | 'GU' | 'IB' | 'LE' | 'MD' | 'NC' | 'OR' | 'PM' | 'PO' | 'PV' | 'TF' | 'VA' | 'VC' | 'ZA' | 'AA' | 'AF' | 'DD' | 'SI' | 'KSA' | 'PNI' | 'TRK' | 'YAP' | '20R' | '2A' | '2B' | '65' | '66' | '67' | '69' | '69M' | '6AE' | '70' | '73' | '75C' | '76' | '77' | '78' | '86' | '88' | '89' | '90' | '91' | '92' | '93' | '94' | '95' | '971' | '972' | '973' | '974' | '976' | 'BFC' | 'BRE' | 'CP' | 'CVL' | 'GES' | 'HDF' | 'IDF' | 'MF' | 'NAQ' | 'NOR' | 'OCC' | 'PAC' | 'PDL' | 'PF' | 'WF' | 'ABC' | 'ABD' | 'ABE' | 'AGB' | 'AGY' | 'AND' | 'ANN' | 'ANS' | 'BAS' | 'BBD' | 'BCP' | 'BDF' | 'BEN' | 'BEX' | 'BFS' | 'BGE' | 'BGW' | 'BIR' | 'BKM' | 'BNE' | 'BNH' | 'BPL' | 'BRD' | 'BRY' | 'BST' | 'BUR' | 'CAM' | 'CAY' | 'CBF' | 'CCG' | 'CGN' | 'CHE' | 'CHW' | 'CLD' | 'CLK' | 'CMA' | 'CMD' | 'CMN' | 'CON' | 'COV' | 'CRF' | 'CRY' | 'CWY' | 'DAL' | 'DBY' | 'DEN' | 'DER' | 'DEV' | 'DGY' | 'DNC' | 'DND' | 'DOR' | 'DRS' | 'DUD' | 'DUR' | 'EAL' | 'EAW' | 'EAY' | 'EDH' | 'EDU' | 'ELN' | 'ELS' | 'ENF' | 'ENG' | 'ERW' | 'ERY' | 'ESS' | 'ESX' | 'FAL' | 'FIF' | 'FLN' | 'FMO' | 'GAT' | 'GBN' | 'GLG' | 'GLS' | 'GRE' | 'GWN' | 'HAL' | 'HAM' | 'HAV' | 'HCK' | 'HEF' | 'HIL' | 'HLD' | 'HMF' | 'HNS' | 'HPL' | 'HRT' | 'HRW' | 'HRY' | 'IOS' | 'IOW' | 'ISL' | 'IVC' | 'KEC' | 'KHL' | 'KIR' | 'KTT' | 'KWL' | 'LBC' | 'LBH' | 'LCE' | 'LDS' | 'LEC' | 'LEW' | 'LIN' | 'LIV' | 'LND' | 'LUT' | 'MAN' | 'MDB' | 'MDW' | 'MEA' | 'MIK' | 'MLN' | 'MON' | 'MRT' | 'MRY' | 'MTY' | 'MUL' | 'NBL' | 'NEL' | 'NET' | 'NFK' | 'NGM' | 'NIR' | 'NLK' | 'NLN' | 'NMD' | 'NNH' | 'NSM' | 'NTL' | 'NTT' | 'NTY' | 'NWM' | 'NWP' | 'NYK' | 'OLD' | 'ORK' | 'OXF' | 'PEM' | 'PKN' | 'PLY' | 'POR' | 'POW' | 'PTE' | 'RCC' | 'RCH' | 'RCT' | 'RDB' | 'RDG' | 'RFW' | 'RIC' | 'ROT' | 'RUT' | 'SAW' | 'SAY' | 'SCB' | 'SCT' | 'SFK' | 'SFT' | 'SGC' | 'SHF' | 'SHN' | 'SKP' | 'SLF' | 'SLG' | 'SLK' | 'SND' | 'SOL' | 'SOS' | 'SRY' | 'STE' | 'STG' | 'STH' | 'STN' | 'STS' | 'STT' | 'STY' | 'SWA' | 'SWD' | 'SWK' | 'TAM' | 'TFW' | 'THR' | 'TOB' | 'TOF' | 'TRF' | 'TWH' | 'UKM' | 'VGL' | 'WBK' | 'WDU' | 'WFT' | 'WGN' | 'WIL' | 'WKF' | 'WLL' | 'WLN' | 'WLS' | 'WLV' | 'WND' | 'WNH' | 'WNM' | 'WOK' | 'WOR' | 'WRL' | 'WRT' | 'WRX' | 'WSM' | 'WSX' | 'YOR' | 'ZET' | 'IM' | 'KA' | 'KK' | 'MM' | 'RL' | 'TB' | 'EP' | 'OT' | 'UE' | 'UW' | 'WN' | 'WP' | 'KU' | 'QE' | 'QT' | 'BF' | 'DB' | 'DL' | 'FA' | 'FO' | 'KD' | 'NZ' | 'YO' | 'BN' | 'OI' | 'QU' | 'DE' | 'EB' | 'PT' | 'UD' | 'UT' | 'FM' | 'LP' | 'OC' | 'OL' | 'SB' | 'ND' | 'FE' | 'GY' | 'HV' | 'JN' | 'KM' | 'KV' | 'NY' | 'PS' | 'VE' | 'VM' | 'ZE' | 'BT' | 'JA' | 'JB' | 'JI' | 'JK' | 'JT' | 'PP' | 'CW' | 'LD' | 'LH' | 'LK' | 'LM' | 'LS' | 'MH' | 'OY' | 'WD' | 'WH' | 'WW' | 'WX' | 'JM' | 'DH' | 'GJ' | 'HP' | 'JH' | 'MZ' | 'PY' | 'TN' | 'TR' | 'UP' | 'WB' | 'BG' | 'DA' | 'DQ' | 'QA' | '00' | 'AKN' | 'AKU' | 'ARN' | 'ASA' | 'BLA' | 'BOG' | 'DAB' | 'DAV' | 'EOM' | 'EYF' | 'FJD' | 'FJL' | 'FLA' | 'FLR' | 'GAR' | 'GOG' | 'GRN' | 'GRU' | 'GRY' | 'HAF' | 'HRG' | 'HRU' | 'HUG' | 'HUV' | 'HVA' | 'HVE' | 'ISA' | 'KJO' | 'MOS' | 'MYR' | 'RGE' | 'RGY' | 'RHH' | 'RKN' | 'RKV' | 'SBT' | 'SDN' | 'SDV' | 'SEL' | 'SFA' | 'SKF' | 'SKG' | 'SKO' | 'SNF' | 'SOG' | 'SSS' | 'STR' | 'SVG' | 'TAL' | 'THG' | 'TJO' | 'VEM' | 'VER' | 'VOP' | '75' | 'CZ' | 'FC' | 'FG' | 'FI' | 'ME' | 'PC' | 'PD' | 'PG' | 'PU' | 'PZ' | 'RA' | 'RE' | 'TP' | 'VR' | 'VT' | 'VV' | 'IR' | 'KH' | 'PH' | 'XE' | 'XI' | 'XS' | 'GG' | 'GK' | 'GP' | 'MR' | 'VL' | 'EC' | 'RD' | 'WI' | '002' | '007' | '011' | '016' | '022' | '026' | '033' | '041' | '047' | '052' | '054' | '056' | '058' | '059' | '062' | '067' | '068' | '073' | '077' | '087' | '088' | '089' | '091' | '094' | '097' | '099' | '102' | '106' | '111' | '112' | '113' | 'DGV' | 'JEL' | 'JUR' | 'LPX' | 'REZ' | 'RIX' | 'VEN' | 'DR' | 'GT' | 'JG' | 'KF' | 'MJ' | 'MQ' | 'NQ' | 'WS' | 'AGD' | 'AOU' | 'ASZ' | 'AZI' | 'BEM' | 'BER' | 'BES' | 'BOD' | 'BOM' | 'BRR' | 'CHI' | 'CHT' | 'DRI' | 'ERR' | 'ESI' | 'ESM' | 'FAH' | 'FES' | 'FIG' | 'FQH' | 'GUE' | 'GUF' | 'HAJ' | 'HAO' | 'HOC' | 'IFR' | 'INE' | 'JDI' | 'JRA' | 'KES' | 'KHE' | 'KHN' | 'LAA' | 'LAR' | 'MAR' | 'MDF' | 'MED' | 'MEK' | 'MID' | 'MOH' | 'NAD' | 'OUA' | 'OUJ' | 'OUZ' | 'RAB' | 'REH' | 'SAF' | 'SEF' | 'SET' | 'SIB' | 'SIF' | 'SIK' | 'SIL' | 'SKH' | 'TAF' | 'TAI' | 'TAO' | 'TAT' | 'TAZ' | 'TET' | 'TIN' | 'TIZ' | 'TNG' | 'TNT' | 'YUS' | 'ZAG' | 'JE' | 'BD' | 'ED' | 'FL' | 'IA' | 'UN' | 'ALK' | 'ALL' | 'AUR' | 'EBO' | 'ENI' | 'JAB' | 'JAL' | 'KIL' | 'KWA' | 'LAE' | 'LIB' | 'LIK' | 'MAJ' | 'MEJ' | 'MIL' | 'NMK' | 'NMU' | 'RON' | 'UJA' | 'UTI' | 'WTH' | 'WTJ' | '103' | '104' | '105' | '107' | '108' | '109' | '210' | '211' | '301' | '304' | '307' | '308' | '310' | '401' | '402' | '403' | '404' | '405' | '406' | '407' | '408' | '409' | '410' | '501' | '502' | '504' | '505' | '506' | '507' | '508' | '509' | '601' | '602' | '603' | '604' | '605' | '606' | '607' | '608' | '609' | '701' | '702' | '703' | '704' | '705' | '706' | '807' | '808' | '810' | '811' | '812' | '813' | '814' | '815' | '816' | '817' | 'BKO' | '037' | '039' | '043' | '046' | '049' | '051' | '053' | '057' | '061' | '063' | '064' | '069' | '071' | 'PW' | 'MLE' | 'RU' | 'BCN' | 'BCS' | 'CHH' | 'CHP' | 'CMX' | 'COA' | 'COL' | 'GRO' | 'HID' | 'MEX' | 'MIC' | 'MOR' | 'NLE' | 'OAX' | 'PUE' | 'QUE' | 'ROO' | 'SLP' | 'SON' | 'TAB' | 'TLA' | 'YUC' | 'ZAC' | 'MPM' | 'OD' | 'OH' | 'OS' | 'EK' | 'OG' | 'AW' | 'BQ1' | 'BQ2' | 'BQ3' | 'NH' | 'OV' | 'P1' | 'P2' | 'P3' | 'P4' | 'P5' | 'P6' | 'P7' | 'AUK' | 'BOP' | 'CAN' | 'CIT' | 'GIS' | 'HKB' | 'MBH' | 'MWT' | 'NSN' | 'OTA' | 'STL' | 'TKI' | 'WKO' | 'WTC' | 'WU' | 'ZU' | 'EM' | 'ANC' | 'APU' | 'ARE' | 'AYA' | 'CAJ' | 'HUC' | 'ICA' | 'JUN' | 'LAL' | 'LAM' | 'LIM' | 'LMA' | 'MDD' | 'MOQ' | 'PIU' | 'PUN' | 'TAC' | 'TUM' | 'CPK' | 'CPM' | 'EBR' | 'EHG' | 'EPW' | 'ESW' | 'GPK' | 'HLA' | 'JWK' | 'MBA' | 'MPL' | 'MRL' | 'NCD' | 'NIK' | 'NPP' | 'NSB' | 'SHM' | 'WHM' | 'WPD' | 'ABR' | 'AGN' | 'AKL' | 'ALB' | 'APA' | 'BOH' | 'BTG' | 'BTN' | 'BUK' | 'BUL' | 'CAG' | 'CAP' | 'CAT' | 'CAV' | 'CEB' | 'DAO' | 'DIN' | 'DVO' | 'EAS' | 'GUI' | 'IFU' | 'ILI' | 'ILN' | 'ILS' | 'LAS' | 'LEY' | 'LUN' | 'MAD' | 'MDC' | 'MDR' | 'MSC' | 'MSR' | 'NCO' | 'NEC' | 'NER' | 'NUE' | 'NUV' | 'PAM' | 'PLW' | 'RIZ' | 'ROM' | 'SCO' | 'SIG' | 'SLE' | 'SLU' | 'SUK' | 'SUN' | 'SUR' | 'TAW' | 'WSA' | 'ZAS' | 'ZMB' | 'ZSI' | 'KP' | 'BTH' | 'DEB' | 'GZA' | 'HBN' | 'JEM' | 'JEN' | 'JRH' | 'KYS' | 'NBS' | 'NGZ' | 'QQA' | 'RBH' | 'RFH' | 'SLT' | 'TBS' | 'TKM' | '004' | '010' | '100' | '150' | '212' | '218' | '222' | '224' | '226' | '227' | '228' | '350' | '370' | 'ASU' | 'US' | 'CJ' | 'CV' | 'HD' | 'IF' | 'IL' | 'TL' | 'TM' | 'VN' | 'VO' | 'ALT' | 'AMU' | 'ARK' | 'BEL' | 'CHU' | 'IRK' | 'IVA' | 'KAM' | 'KDA' | 'KEM' | 'KGD' | 'KGN' | 'KHA' | 'KHM' | 'KLU' | 'KRS' | 'KYA' | 'LEN' | 'LIP' | 'MOW' | 'MUR' | 'NEN' | 'NGR' | 'NIZ' | 'NVS' | 'OMS' | 'ORE' | 'ORL' | 'PER' | 'PNZ' | 'PRI' | 'PSK' | 'ROS' | 'RYA' | 'SMO' | 'SPE' | 'STA' | 'SVE' | 'TOM' | 'TUL' | 'TVE' | 'TYU' | 'ULY' | 'VGG' | 'VLA' | 'VOR' | 'YAN' | 'MK' | 'WE' | 'DS' | 'DW' | 'NR' | '001' | '003' | '005' | '006' | '008' | '009' | '012' | '013' | '014' | '017' | '018' | '019' | '021' | '023' | '024' | '027' | '028' | '029' | '031' | '032' | '034' | '036' | '038' | '044' | '045' | '048' | '066' | '072' | '074' | '075' | '078' | '079' | '081' | '082' | '083' | '084' | '085' | '086' | '090' | '092' | '093' | '095' | '096' | '098' | '110' | '114' | '115' | '116' | '117' | '118' | '119' | '120' | '121' | '122' | '123' | '124' | '125' | '126' | '127' | '128' | '129' | '131' | '132' | '133' | '134' | '135' | '136' | '137' | '138' | '139' | '140' | '143' | '144' | '146' | '148' | '149' | '151' | '152' | '153' | '154' | '155' | '156' | '157' | '158' | '159' | '160' | '161' | '162' | '163' | '164' | '165' | '166' | '167' | '168' | '169' | '170' | '172' | '173' | '174' | '175' | '176' | '177' | '178' | '179' | '180' | '181' | '182' | '183' | '185' | '186' | '187' | '188' | '189' | '190' | '192' | '193' | '194' | '195' | '196' | '197' | '199' | '200' | '213' | 'TC' | 'ZI' | 'FK' | 'JD' | 'WO' | 'EE' | 'EW' | 'UY' | 'DY' | 'ID' | 'EO' | '96' | 'OE' | 'ARI' | 'CHA' | 'CTT' | 'DMN' | 'MRC' | 'PED' | 'POS' | 'PRT' | 'PTF' | 'SFO' | 'SGE' | 'SIP' | 'SJL' | 'TUP' | 'FUN' | 'NIT' | 'NKF' | 'NKL' | 'NMA' | 'NMG' | 'NUI' | 'VAI' | 'CYI' | 'CYQ' | 'HSQ' | 'HSZ' | 'ILA' | 'KEE' | 'KHH' | 'KIN' | 'LIE' | 'MIA' | 'NWT' | 'PEN' | 'PIF' | 'TNN' | 'TPE' | 'TTT' | 'TXG' | 'YUN' | '215' | '216' | '217' | '219' | '220' | '221' | '223' | '225' | '229' | '230' | '231' | '232' | '233' | '234' | '235' | '236' | '237' | '302' | '306' | '309' | '318' | '319' | '320' | '328' | '329' | '330' | '331' | '332' | '333' | '334' | '335' | '336' | '337' | '414' | '415' | '416' | '417' | '418' | '419' | '420' | '428' | '429' | '433' | '434' | '435' | 'NJ' | 'OK' | 'TX' | 'UM' | 'WV' | 'WY' | 'FD' | 'FS' | 'RV' | 'TT' | 'QR' | 'TK' | 'XO' | 'MAP' | 'SEE' | 'TAE' | 'UV' | 'VF' | 'HJ' | 'KZN' | 'WC';
133
+ /**
134
+ * The zip or postal code
135
+ */
136
+ zipCode?: string;
137
+ }
138
+ }
139
+ export interface CustomerRetrieveResponse {
140
+ /**
141
+ * The id of the customer
142
+ */
143
+ id: string;
144
+ /**
145
+ * Array of bank accounts remembered by user
146
+ */
147
+ bankAccounts: Array<CustomerRetrieveResponse.BankAccount>;
148
+ /**
149
+ * The registered address of the customer
150
+ */
151
+ address?: CustomerRetrieveResponse.Address;
152
+ /**
153
+ * Customer's date of birth in ISO 8601 datetime format. Example: '2025-09-05'.
154
+ * Reference: https://en.wikipedia.org/wiki/ISO_8601
155
+ */
156
+ dateOfBirth?: string;
157
+ /**
158
+ * Indicates whether the customer was deleted
159
+ */
160
+ deleted?: boolean;
161
+ /**
162
+ * The customer deletion timestamp
163
+ */
164
+ deletedAt?: string;
165
+ /**
166
+ * The email address of the customer
167
+ */
168
+ email?: string;
169
+ /**
170
+ * Deprecated. Use the customer.email instead
171
+ */
172
+ emailAddress?: string;
173
+ /**
174
+ * The full name or business name of the customer
175
+ */
176
+ fullName?: string;
177
+ /**
178
+ * A collection of key-value pairs that can be associated with an object to store
179
+ * custom data in a structured manner. This allows you to attach arbitrary
180
+ * information to enhance the object with additional context or properties. To
181
+ * clear the metadata, send an empty object.
182
+ */
183
+ metadata?: {
184
+ [key: string]: unknown;
185
+ };
186
+ /**
187
+ * The phone number of the customer
188
+ */
189
+ phone?: string;
190
+ }
191
+ export declare namespace CustomerRetrieveResponse {
192
+ interface BankAccount {
193
+ /**
194
+ * Remembered bank details
195
+ */
196
+ bank: BankAccount.Bank;
197
+ /**
198
+ * Last 4 digits of remembered account number
199
+ */
200
+ last4digits: string;
201
+ }
202
+ namespace BankAccount {
203
+ /**
204
+ * Remembered bank details
205
+ */
206
+ interface Bank {
207
+ /**
208
+ * The id of the bank
209
+ */
210
+ id: string;
211
+ /**
212
+ * The name of the bank
213
+ */
214
+ name: string;
215
+ /**
216
+ * URL address of bank logo image
217
+ */
218
+ logo?: string;
219
+ }
220
+ }
221
+ /**
222
+ * The registered address of the customer
223
+ */
224
+ interface Address {
225
+ /**
226
+ * ISO 3166-1 alpha-2 country code (e.g. DE)
227
+ */
228
+ country: 'AF' | 'AL' | 'DZ' | 'AS' | 'AD' | 'AO' | 'AI' | 'AQ' | 'AG' | 'AR' | 'AM' | 'AW' | 'AU' | 'AT' | 'AZ' | 'BS' | 'BH' | 'BD' | 'BB' | 'BY' | 'BE' | 'BZ' | 'BJ' | 'BM' | 'BT' | 'BO' | 'BA' | 'BW' | 'BV' | 'BR' | 'IO' | 'BN' | 'BG' | 'BF' | 'BI' | 'KH' | 'CM' | 'CA' | 'CV' | 'KY' | 'CF' | 'TD' | 'CL' | 'CN' | 'CX' | 'CC' | 'CO' | 'KM' | 'CG' | 'CD' | 'CK' | 'CR' | 'CI' | 'HR' | 'CU' | 'CY' | 'CZ' | 'DK' | 'DJ' | 'DM' | 'DO' | 'EC' | 'EG' | 'SV' | 'GQ' | 'ER' | 'EE' | 'ET' | 'FK' | 'FO' | 'FJ' | 'FI' | 'FR' | 'GF' | 'PF' | 'TF' | 'GA' | 'GM' | 'GE' | 'DE' | 'GH' | 'GI' | 'GR' | 'GL' | 'GD' | 'GP' | 'GU' | 'GT' | 'GN' | 'GW' | 'GY' | 'HT' | 'HM' | 'VA' | 'HN' | 'HK' | 'HU' | 'IS' | 'IN' | 'ID' | 'IR' | 'IQ' | 'IE' | 'IL' | 'IT' | 'JM' | 'JP' | 'JO' | 'KZ' | 'KE' | 'KI' | 'KP' | 'KR' | 'KW' | 'KG' | 'LA' | 'LV' | 'LB' | 'LS' | 'LR' | 'LY' | 'LI' | 'LT' | 'LU' | 'MO' | 'MG' | 'MW' | 'MY' | 'MV' | 'ML' | 'MT' | 'MH' | 'MQ' | 'MR' | 'MU' | 'YT' | 'MX' | 'FM' | 'MD' | 'MC' | 'MN' | 'MS' | 'MA' | 'MZ' | 'MM' | 'NA' | 'NR' | 'NP' | 'NL' | 'NC' | 'NZ' | 'NI' | 'NE' | 'NG' | 'NU' | 'NF' | 'MP' | 'MK' | 'NO' | 'OM' | 'PK' | 'PW' | 'PS' | 'PA' | 'PG' | 'PY' | 'PE' | 'PH' | 'PN' | 'PL' | 'PT' | 'PR' | 'QA' | 'RE' | 'RO' | 'RU' | 'RW' | 'SH' | 'KN' | 'LC' | 'PM' | 'VC' | 'WS' | 'SM' | 'ST' | 'SA' | 'SN' | 'SC' | 'SL' | 'SG' | 'SK' | 'SI' | 'SB' | 'SO' | 'ZA' | 'GS' | 'ES' | 'LK' | 'SD' | 'SR' | 'SJ' | 'SZ' | 'SE' | 'CH' | 'SY' | 'TW' | 'TJ' | 'TZ' | 'TH' | 'TL' | 'TG' | 'TK' | 'TO' | 'TT' | 'TN' | 'TR' | 'TM' | 'TC' | 'TV' | 'UG' | 'UA' | 'AE' | 'GB' | 'US' | 'UM' | 'UY' | 'UZ' | 'VU' | 'VE' | 'VN' | 'VG' | 'VI' | 'WF' | 'EH' | 'YE' | 'ZM' | 'ZW' | 'AX' | 'BQ' | 'CW' | 'GG' | 'IM' | 'JE' | 'ME' | 'BL' | 'MF' | 'RS' | 'SX' | 'SS' | 'XK';
229
+ /**
230
+ * Full name of the city
231
+ */
232
+ city?: string;
233
+ /**
234
+ * Address line 1
235
+ */
236
+ line1?: string;
237
+ /**
238
+ * Address line 2
239
+ */
240
+ line2?: string;
241
+ /**
242
+ * The second part of the subdivision ISO 3166-2 country code (e.g. BE)
243
+ */
244
+ region?: '02' | '03' | '04' | '05' | '06' | '07' | '08' | 'AJ' | 'AZ' | 'DU' | 'FU' | 'RK' | 'SH' | 'UQ' | 'BAL' | 'BAM' | 'BDG' | 'BDS' | 'BGL' | 'DAY' | 'FRA' | 'FYB' | 'GHA' | 'GHO' | 'HEL' | 'HER' | 'JOW' | 'KAB' | 'KAN' | 'KAP' | 'KDZ' | 'KHO' | 'KNR' | 'LAG' | 'LOG' | 'NAN' | 'NIM' | 'NUR' | 'PAN' | 'PAR' | 'PIA' | 'PKA' | 'SAM' | 'SAR' | 'TAK' | 'URU' | 'WAR' | 'ZAB' | '10' | '11' | '01' | '09' | '12' | 'AG' | 'AR' | 'AV' | 'ER' | 'GR' | 'KT' | 'LO' | 'SU' | 'TV' | 'VD' | 'BGO' | 'BGU' | 'BIE' | 'CAB' | 'CCU' | 'CNN' | 'CNO' | 'CUS' | 'HUA' | 'HUI' | 'LNO' | 'LSU' | 'LUA' | 'MAL' | 'MOX' | 'NAM' | 'UIG' | 'ZAI' | 'A' | 'B' | 'C' | 'D' | 'E' | 'F' | 'G' | 'H' | 'J' | 'K' | 'L' | 'M' | 'N' | 'P' | 'Q' | 'R' | 'S' | 'T' | 'U' | 'V' | 'W' | 'X' | 'Y' | 'Z' | '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9' | 'ACT' | 'NSW' | 'NT' | 'QLD' | 'SA' | 'TAS' | 'VIC' | 'WA' | 'ABS' | 'AGA' | 'AGC' | 'AGM' | 'AGS' | 'AGU' | 'AST' | 'BA' | 'BAB' | 'BAR' | 'BEY' | 'BIL' | 'CAL' | 'CUL' | 'DAS' | 'FUZ' | 'GA' | 'GAD' | 'GOR' | 'GOY' | 'GYG' | 'HAC' | 'IMI' | 'ISM' | 'KAL' | 'KUR' | 'LA' | 'LAC' | 'LAN' | 'LER' | 'MAS' | 'MI' | 'NA' | 'NEF' | 'NV' | 'NX' | 'OGU' | 'ORD' | 'QAB' | 'QAX' | 'QAZ' | 'QBA' | 'QBI' | 'QOB' | 'QUS' | 'SAB' | 'SAD' | 'SAH' | 'SAK' | 'SAL' | 'SAT' | 'SBN' | 'SIY' | 'SKR' | 'SM' | 'SMI' | 'SMX' | 'SR' | 'SUS' | 'TAR' | 'TOV' | 'UCA' | 'XA' | 'XAC' | 'XCI' | 'XIZ' | 'XVD' | 'YAR' | 'YE' | 'YEV' | 'ZAN' | 'ZAQ' | 'ZAR' | 'BIH' | 'BRC' | 'SRP' | '13' | '14' | '15' | '16' | '17' | '18' | '19' | '20' | '21' | '22' | '23' | '24' | '25' | '26' | '27' | '28' | '29' | '30' | '31' | '32' | '33' | '34' | '35' | '36' | '37' | '38' | '39' | '40' | '41' | '42' | '43' | '44' | '45' | '46' | '47' | '48' | '49' | '50' | '51' | '52' | '53' | '54' | '55' | '56' | '57' | '58' | '59' | '60' | '61' | '62' | '63' | '64' | 'BRU' | 'VAN' | 'VBR' | 'VLG' | 'VLI' | 'VOV' | 'VWV' | 'WAL' | 'WBR' | 'WHT' | 'WLG' | 'WLX' | 'WNA' | 'BAN' | 'BAZ' | 'BGR' | 'BLG' | 'BLK' | 'COM' | 'GAN' | 'GNA' | 'GOU' | 'HOU' | 'IOB' | 'KAD' | 'KEN' | 'KMD' | 'KMP' | 'KOP' | 'KOS' | 'KOT' | 'KOW' | 'LOR' | 'MOU' | 'NAO' | 'NAY' | 'NOU' | 'OUB' | 'OUD' | 'PAS' | 'PON' | 'SEN' | 'SIS' | 'SMT' | 'SNG' | 'SOM' | 'SOR' | 'TAP' | 'TUI' | 'YAG' | 'YAT' | 'ZIR' | 'ZON' | 'ZOU' | 'BB' | 'BL' | 'BM' | 'BR' | 'CA' | 'CI' | 'GI' | 'KI' | 'KR' | 'KY' | 'MA' | 'MU' | 'MW' | 'MY' | 'NG' | 'RM' | 'RT' | 'RY' | 'AK' | 'AL' | 'AQ' | 'BO' | 'CO' | 'DO' | 'KO' | 'LI' | 'MO' | 'OU' | 'PL' | 'ZO' | 'BE' | 'TE' | 'TU' | 'O' | 'SE' | 'AC' | 'AM' | 'AP' | 'CE' | 'DF' | 'ES' | 'GO' | 'MG' | 'MS' | 'MT' | 'PA' | 'PB' | 'PE' | 'PI' | 'PR' | 'RJ' | 'RN' | 'RO' | 'RR' | 'RS' | 'SC' | 'SP' | 'TO' | 'BI' | 'BP' | 'BY' | 'CK' | 'CS' | 'EG' | 'EX' | 'FP' | 'GC' | 'HI' | 'HT' | 'IN' | 'MC' | 'NE' | 'NO' | 'NP' | 'NS' | 'RC' | 'RI' | 'SO' | 'SS' | 'SW' | 'WG' | 'TY' | 'CH' | 'FR' | 'GH' | 'JW' | 'KG' | 'KL' | 'KW' | 'NW' | 'ST' | 'HM' | 'HO' | 'HR' | 'VI' | 'BZ' | 'CY' | 'CZL' | 'OW' | 'TOL' | 'AB' | 'BC' | 'MB' | 'NB' | 'NL' | 'NU' | 'ON' | 'QC' | 'SK' | 'YT' | 'BU' | 'EQ' | 'HK' | 'HL' | 'HU' | 'IT' | 'KC' | 'KE' | 'KN' | 'KS' | 'LU' | 'MN' | 'NK' | 'TA' | 'BGF' | 'BK' | 'HS' | 'KB' | 'LB' | 'MP' | 'NM' | 'OP' | 'UK' | 'VK' | 'BZV' | 'AI' | 'BS' | 'GE' | 'GL' | 'JU' | 'SG' | 'SZ' | 'TG' | 'TI' | 'UR' | 'VS' | 'ZG' | 'ZH' | 'CM' | 'DN' | 'GD' | 'LC' | 'LG' | 'SV' | 'VB' | 'WR' | 'YM' | 'ZZ' | 'AN' | 'AT' | 'LL' | 'LR' | 'ML' | 'AD' | 'EN' | 'LT' | 'AH' | 'BJ' | 'CQ' | 'FJ' | 'GS' | 'GX' | 'GZ' | 'HA' | 'HB' | 'HE' | 'HN' | 'JL' | 'JS' | 'JX' | 'LN' | 'QH' | 'SD' | 'SN' | 'SX' | 'TJ' | 'TW' | 'XJ' | 'XZ' | 'YN' | 'ZJ' | 'AMA' | 'ANT' | 'ARA' | 'ATL' | 'BOL' | 'BOY' | 'CAQ' | 'CAS' | 'CAU' | 'CES' | 'CHO' | 'COR' | 'CUN' | 'DC' | 'GUA' | 'GUV' | 'MAG' | 'MET' | 'NAR' | 'NSA' | 'PUT' | 'QUI' | 'RIS' | 'SAN' | 'SAP' | 'SUC' | 'VAC' | 'VAU' | 'VID' | 'SJ' | '99' | 'BV' | 'CF' | 'CR' | 'PN' | 'RB' | 'RG' | 'SF' | 'SL' | 'TS' | '201' | '202' | '203' | '204' | '205' | '206' | '207' | '208' | '209' | '20A' | '20B' | '20C' | '311' | '312' | '313' | '314' | '315' | '316' | '317' | '321' | '322' | '323' | '324' | '325' | '326' | '327' | '411' | '412' | '413' | '421' | '422' | '423' | '424' | '425' | '426' | '427' | '511' | '512' | '513' | '514' | '521' | '522' | '523' | '524' | '525' | '531' | '532' | '533' | '534' | '631' | '632' | '633' | '634' | '635' | '641' | '642' | '643' | '644' | '645' | '646' | '647' | '71' | '711' | '712' | '713' | '714' | '715' | '72' | '721' | '722' | '723' | '724' | '80' | '801' | '802' | '803' | '804' | '805' | '806' | 'BW' | 'HH' | 'MV' | 'NI' | 'RP' | 'TH' | 'AS' | 'DI' | 'DJ' | 'OB' | '015' | '020' | '025' | '030' | '035' | '040' | '042' | '050' | '055' | '060' | '065' | '070' | '076' | '080' | '101' | '147' | '81' | '82' | '83' | '84' | '85' | 'I' | '130' | '141' | '142' | '171' | '184' | '191' | '198' | '214' | '245' | '247' | '251' | '255' | '272' | '283' | '284' | '291' | '293' | '296' | '303' | '305' | '338' | '353' | '430' | '431' | '432' | '441' | '442' | '446' | '478' | '480' | '486' | '503' | '528' | '557' | '567' | '586' | '615' | '618' | '622' | '624' | '638' | '651' | '653' | '661' | '663' | '668' | '68' | '689' | '698' | '708' | '719' | '726' | '732' | '735' | '74' | '784' | '79' | '792' | '793' | '796' | '809' | '824' | '834' | '855' | '87' | '890' | '897' | '899' | '901' | '903' | '907' | '917' | '919' | '928' | 'ALX' | 'ASN' | 'BH' | 'BNS' | 'DK' | 'DT' | 'FYM' | 'IS' | 'KFS' | 'LX' | 'MNF' | 'PTS' | 'SHG' | 'SHR' | 'SIN' | 'SUZ' | 'WAD' | 'GB' | 'CB' | 'CC' | 'CL' | 'CN' | 'CT' | 'CU' | 'GU' | 'IB' | 'LE' | 'MD' | 'NC' | 'OR' | 'PM' | 'PO' | 'PV' | 'TF' | 'VA' | 'VC' | 'ZA' | 'AA' | 'AF' | 'DD' | 'SI' | 'KSA' | 'PNI' | 'TRK' | 'YAP' | '20R' | '2A' | '2B' | '65' | '66' | '67' | '69' | '69M' | '6AE' | '70' | '73' | '75C' | '76' | '77' | '78' | '86' | '88' | '89' | '90' | '91' | '92' | '93' | '94' | '95' | '971' | '972' | '973' | '974' | '976' | 'BFC' | 'BRE' | 'CP' | 'CVL' | 'GES' | 'HDF' | 'IDF' | 'MF' | 'NAQ' | 'NOR' | 'OCC' | 'PAC' | 'PDL' | 'PF' | 'WF' | 'ABC' | 'ABD' | 'ABE' | 'AGB' | 'AGY' | 'AND' | 'ANN' | 'ANS' | 'BAS' | 'BBD' | 'BCP' | 'BDF' | 'BEN' | 'BEX' | 'BFS' | 'BGE' | 'BGW' | 'BIR' | 'BKM' | 'BNE' | 'BNH' | 'BPL' | 'BRD' | 'BRY' | 'BST' | 'BUR' | 'CAM' | 'CAY' | 'CBF' | 'CCG' | 'CGN' | 'CHE' | 'CHW' | 'CLD' | 'CLK' | 'CMA' | 'CMD' | 'CMN' | 'CON' | 'COV' | 'CRF' | 'CRY' | 'CWY' | 'DAL' | 'DBY' | 'DEN' | 'DER' | 'DEV' | 'DGY' | 'DNC' | 'DND' | 'DOR' | 'DRS' | 'DUD' | 'DUR' | 'EAL' | 'EAW' | 'EAY' | 'EDH' | 'EDU' | 'ELN' | 'ELS' | 'ENF' | 'ENG' | 'ERW' | 'ERY' | 'ESS' | 'ESX' | 'FAL' | 'FIF' | 'FLN' | 'FMO' | 'GAT' | 'GBN' | 'GLG' | 'GLS' | 'GRE' | 'GWN' | 'HAL' | 'HAM' | 'HAV' | 'HCK' | 'HEF' | 'HIL' | 'HLD' | 'HMF' | 'HNS' | 'HPL' | 'HRT' | 'HRW' | 'HRY' | 'IOS' | 'IOW' | 'ISL' | 'IVC' | 'KEC' | 'KHL' | 'KIR' | 'KTT' | 'KWL' | 'LBC' | 'LBH' | 'LCE' | 'LDS' | 'LEC' | 'LEW' | 'LIN' | 'LIV' | 'LND' | 'LUT' | 'MAN' | 'MDB' | 'MDW' | 'MEA' | 'MIK' | 'MLN' | 'MON' | 'MRT' | 'MRY' | 'MTY' | 'MUL' | 'NBL' | 'NEL' | 'NET' | 'NFK' | 'NGM' | 'NIR' | 'NLK' | 'NLN' | 'NMD' | 'NNH' | 'NSM' | 'NTL' | 'NTT' | 'NTY' | 'NWM' | 'NWP' | 'NYK' | 'OLD' | 'ORK' | 'OXF' | 'PEM' | 'PKN' | 'PLY' | 'POR' | 'POW' | 'PTE' | 'RCC' | 'RCH' | 'RCT' | 'RDB' | 'RDG' | 'RFW' | 'RIC' | 'ROT' | 'RUT' | 'SAW' | 'SAY' | 'SCB' | 'SCT' | 'SFK' | 'SFT' | 'SGC' | 'SHF' | 'SHN' | 'SKP' | 'SLF' | 'SLG' | 'SLK' | 'SND' | 'SOL' | 'SOS' | 'SRY' | 'STE' | 'STG' | 'STH' | 'STN' | 'STS' | 'STT' | 'STY' | 'SWA' | 'SWD' | 'SWK' | 'TAM' | 'TFW' | 'THR' | 'TOB' | 'TOF' | 'TRF' | 'TWH' | 'UKM' | 'VGL' | 'WBK' | 'WDU' | 'WFT' | 'WGN' | 'WIL' | 'WKF' | 'WLL' | 'WLN' | 'WLS' | 'WLV' | 'WND' | 'WNH' | 'WNM' | 'WOK' | 'WOR' | 'WRL' | 'WRT' | 'WRX' | 'WSM' | 'WSX' | 'YOR' | 'ZET' | 'IM' | 'KA' | 'KK' | 'MM' | 'RL' | 'TB' | 'EP' | 'OT' | 'UE' | 'UW' | 'WN' | 'WP' | 'KU' | 'QE' | 'QT' | 'BF' | 'DB' | 'DL' | 'FA' | 'FO' | 'KD' | 'NZ' | 'YO' | 'BN' | 'OI' | 'QU' | 'DE' | 'EB' | 'PT' | 'UD' | 'UT' | 'FM' | 'LP' | 'OC' | 'OL' | 'SB' | 'ND' | 'FE' | 'GY' | 'HV' | 'JN' | 'KM' | 'KV' | 'NY' | 'PS' | 'VE' | 'VM' | 'ZE' | 'BT' | 'JA' | 'JB' | 'JI' | 'JK' | 'JT' | 'PP' | 'CW' | 'LD' | 'LH' | 'LK' | 'LM' | 'LS' | 'MH' | 'OY' | 'WD' | 'WH' | 'WW' | 'WX' | 'JM' | 'DH' | 'GJ' | 'HP' | 'JH' | 'MZ' | 'PY' | 'TN' | 'TR' | 'UP' | 'WB' | 'BG' | 'DA' | 'DQ' | 'QA' | '00' | 'AKN' | 'AKU' | 'ARN' | 'ASA' | 'BLA' | 'BOG' | 'DAB' | 'DAV' | 'EOM' | 'EYF' | 'FJD' | 'FJL' | 'FLA' | 'FLR' | 'GAR' | 'GOG' | 'GRN' | 'GRU' | 'GRY' | 'HAF' | 'HRG' | 'HRU' | 'HUG' | 'HUV' | 'HVA' | 'HVE' | 'ISA' | 'KJO' | 'MOS' | 'MYR' | 'RGE' | 'RGY' | 'RHH' | 'RKN' | 'RKV' | 'SBT' | 'SDN' | 'SDV' | 'SEL' | 'SFA' | 'SKF' | 'SKG' | 'SKO' | 'SNF' | 'SOG' | 'SSS' | 'STR' | 'SVG' | 'TAL' | 'THG' | 'TJO' | 'VEM' | 'VER' | 'VOP' | '75' | 'CZ' | 'FC' | 'FG' | 'FI' | 'ME' | 'PC' | 'PD' | 'PG' | 'PU' | 'PZ' | 'RA' | 'RE' | 'TP' | 'VR' | 'VT' | 'VV' | 'IR' | 'KH' | 'PH' | 'XE' | 'XI' | 'XS' | 'GG' | 'GK' | 'GP' | 'MR' | 'VL' | 'EC' | 'RD' | 'WI' | '002' | '007' | '011' | '016' | '022' | '026' | '033' | '041' | '047' | '052' | '054' | '056' | '058' | '059' | '062' | '067' | '068' | '073' | '077' | '087' | '088' | '089' | '091' | '094' | '097' | '099' | '102' | '106' | '111' | '112' | '113' | 'DGV' | 'JEL' | 'JUR' | 'LPX' | 'REZ' | 'RIX' | 'VEN' | 'DR' | 'GT' | 'JG' | 'KF' | 'MJ' | 'MQ' | 'NQ' | 'WS' | 'AGD' | 'AOU' | 'ASZ' | 'AZI' | 'BEM' | 'BER' | 'BES' | 'BOD' | 'BOM' | 'BRR' | 'CHI' | 'CHT' | 'DRI' | 'ERR' | 'ESI' | 'ESM' | 'FAH' | 'FES' | 'FIG' | 'FQH' | 'GUE' | 'GUF' | 'HAJ' | 'HAO' | 'HOC' | 'IFR' | 'INE' | 'JDI' | 'JRA' | 'KES' | 'KHE' | 'KHN' | 'LAA' | 'LAR' | 'MAR' | 'MDF' | 'MED' | 'MEK' | 'MID' | 'MOH' | 'NAD' | 'OUA' | 'OUJ' | 'OUZ' | 'RAB' | 'REH' | 'SAF' | 'SEF' | 'SET' | 'SIB' | 'SIF' | 'SIK' | 'SIL' | 'SKH' | 'TAF' | 'TAI' | 'TAO' | 'TAT' | 'TAZ' | 'TET' | 'TIN' | 'TIZ' | 'TNG' | 'TNT' | 'YUS' | 'ZAG' | 'JE' | 'BD' | 'ED' | 'FL' | 'IA' | 'UN' | 'ALK' | 'ALL' | 'AUR' | 'EBO' | 'ENI' | 'JAB' | 'JAL' | 'KIL' | 'KWA' | 'LAE' | 'LIB' | 'LIK' | 'MAJ' | 'MEJ' | 'MIL' | 'NMK' | 'NMU' | 'RON' | 'UJA' | 'UTI' | 'WTH' | 'WTJ' | '103' | '104' | '105' | '107' | '108' | '109' | '210' | '211' | '301' | '304' | '307' | '308' | '310' | '401' | '402' | '403' | '404' | '405' | '406' | '407' | '408' | '409' | '410' | '501' | '502' | '504' | '505' | '506' | '507' | '508' | '509' | '601' | '602' | '603' | '604' | '605' | '606' | '607' | '608' | '609' | '701' | '702' | '703' | '704' | '705' | '706' | '807' | '808' | '810' | '811' | '812' | '813' | '814' | '815' | '816' | '817' | 'BKO' | '037' | '039' | '043' | '046' | '049' | '051' | '053' | '057' | '061' | '063' | '064' | '069' | '071' | 'PW' | 'MLE' | 'RU' | 'BCN' | 'BCS' | 'CHH' | 'CHP' | 'CMX' | 'COA' | 'COL' | 'GRO' | 'HID' | 'MEX' | 'MIC' | 'MOR' | 'NLE' | 'OAX' | 'PUE' | 'QUE' | 'ROO' | 'SLP' | 'SON' | 'TAB' | 'TLA' | 'YUC' | 'ZAC' | 'MPM' | 'OD' | 'OH' | 'OS' | 'EK' | 'OG' | 'AW' | 'BQ1' | 'BQ2' | 'BQ3' | 'NH' | 'OV' | 'P1' | 'P2' | 'P3' | 'P4' | 'P5' | 'P6' | 'P7' | 'AUK' | 'BOP' | 'CAN' | 'CIT' | 'GIS' | 'HKB' | 'MBH' | 'MWT' | 'NSN' | 'OTA' | 'STL' | 'TKI' | 'WKO' | 'WTC' | 'WU' | 'ZU' | 'EM' | 'ANC' | 'APU' | 'ARE' | 'AYA' | 'CAJ' | 'HUC' | 'ICA' | 'JUN' | 'LAL' | 'LAM' | 'LIM' | 'LMA' | 'MDD' | 'MOQ' | 'PIU' | 'PUN' | 'TAC' | 'TUM' | 'CPK' | 'CPM' | 'EBR' | 'EHG' | 'EPW' | 'ESW' | 'GPK' | 'HLA' | 'JWK' | 'MBA' | 'MPL' | 'MRL' | 'NCD' | 'NIK' | 'NPP' | 'NSB' | 'SHM' | 'WHM' | 'WPD' | 'ABR' | 'AGN' | 'AKL' | 'ALB' | 'APA' | 'BOH' | 'BTG' | 'BTN' | 'BUK' | 'BUL' | 'CAG' | 'CAP' | 'CAT' | 'CAV' | 'CEB' | 'DAO' | 'DIN' | 'DVO' | 'EAS' | 'GUI' | 'IFU' | 'ILI' | 'ILN' | 'ILS' | 'LAS' | 'LEY' | 'LUN' | 'MAD' | 'MDC' | 'MDR' | 'MSC' | 'MSR' | 'NCO' | 'NEC' | 'NER' | 'NUE' | 'NUV' | 'PAM' | 'PLW' | 'RIZ' | 'ROM' | 'SCO' | 'SIG' | 'SLE' | 'SLU' | 'SUK' | 'SUN' | 'SUR' | 'TAW' | 'WSA' | 'ZAS' | 'ZMB' | 'ZSI' | 'KP' | 'BTH' | 'DEB' | 'GZA' | 'HBN' | 'JEM' | 'JEN' | 'JRH' | 'KYS' | 'NBS' | 'NGZ' | 'QQA' | 'RBH' | 'RFH' | 'SLT' | 'TBS' | 'TKM' | '004' | '010' | '100' | '150' | '212' | '218' | '222' | '224' | '226' | '227' | '228' | '350' | '370' | 'ASU' | 'US' | 'CJ' | 'CV' | 'HD' | 'IF' | 'IL' | 'TL' | 'TM' | 'VN' | 'VO' | 'ALT' | 'AMU' | 'ARK' | 'BEL' | 'CHU' | 'IRK' | 'IVA' | 'KAM' | 'KDA' | 'KEM' | 'KGD' | 'KGN' | 'KHA' | 'KHM' | 'KLU' | 'KRS' | 'KYA' | 'LEN' | 'LIP' | 'MOW' | 'MUR' | 'NEN' | 'NGR' | 'NIZ' | 'NVS' | 'OMS' | 'ORE' | 'ORL' | 'PER' | 'PNZ' | 'PRI' | 'PSK' | 'ROS' | 'RYA' | 'SMO' | 'SPE' | 'STA' | 'SVE' | 'TOM' | 'TUL' | 'TVE' | 'TYU' | 'ULY' | 'VGG' | 'VLA' | 'VOR' | 'YAN' | 'MK' | 'WE' | 'DS' | 'DW' | 'NR' | '001' | '003' | '005' | '006' | '008' | '009' | '012' | '013' | '014' | '017' | '018' | '019' | '021' | '023' | '024' | '027' | '028' | '029' | '031' | '032' | '034' | '036' | '038' | '044' | '045' | '048' | '066' | '072' | '074' | '075' | '078' | '079' | '081' | '082' | '083' | '084' | '085' | '086' | '090' | '092' | '093' | '095' | '096' | '098' | '110' | '114' | '115' | '116' | '117' | '118' | '119' | '120' | '121' | '122' | '123' | '124' | '125' | '126' | '127' | '128' | '129' | '131' | '132' | '133' | '134' | '135' | '136' | '137' | '138' | '139' | '140' | '143' | '144' | '146' | '148' | '149' | '151' | '152' | '153' | '154' | '155' | '156' | '157' | '158' | '159' | '160' | '161' | '162' | '163' | '164' | '165' | '166' | '167' | '168' | '169' | '170' | '172' | '173' | '174' | '175' | '176' | '177' | '178' | '179' | '180' | '181' | '182' | '183' | '185' | '186' | '187' | '188' | '189' | '190' | '192' | '193' | '194' | '195' | '196' | '197' | '199' | '200' | '213' | 'TC' | 'ZI' | 'FK' | 'JD' | 'WO' | 'EE' | 'EW' | 'UY' | 'DY' | 'ID' | 'EO' | '96' | 'OE' | 'ARI' | 'CHA' | 'CTT' | 'DMN' | 'MRC' | 'PED' | 'POS' | 'PRT' | 'PTF' | 'SFO' | 'SGE' | 'SIP' | 'SJL' | 'TUP' | 'FUN' | 'NIT' | 'NKF' | 'NKL' | 'NMA' | 'NMG' | 'NUI' | 'VAI' | 'CYI' | 'CYQ' | 'HSQ' | 'HSZ' | 'ILA' | 'KEE' | 'KHH' | 'KIN' | 'LIE' | 'MIA' | 'NWT' | 'PEN' | 'PIF' | 'TNN' | 'TPE' | 'TTT' | 'TXG' | 'YUN' | '215' | '216' | '217' | '219' | '220' | '221' | '223' | '225' | '229' | '230' | '231' | '232' | '233' | '234' | '235' | '236' | '237' | '302' | '306' | '309' | '318' | '319' | '320' | '328' | '329' | '330' | '331' | '332' | '333' | '334' | '335' | '336' | '337' | '414' | '415' | '416' | '417' | '418' | '419' | '420' | '428' | '429' | '433' | '434' | '435' | 'NJ' | 'OK' | 'TX' | 'UM' | 'WV' | 'WY' | 'FD' | 'FS' | 'RV' | 'TT' | 'QR' | 'TK' | 'XO' | 'MAP' | 'SEE' | 'TAE' | 'UV' | 'VF' | 'HJ' | 'KZN' | 'WC';
245
+ /**
246
+ * The zip or postal code
247
+ */
248
+ zipCode?: string;
249
+ }
250
+ }
251
+ export interface CustomerUpdateResponse {
252
+ /**
253
+ * The id of the customer
254
+ */
255
+ id: string;
256
+ /**
257
+ * Array of bank accounts remembered by user
258
+ */
259
+ bankAccounts: Array<CustomerUpdateResponse.BankAccount>;
260
+ /**
261
+ * The registered address of the customer
262
+ */
263
+ address?: CustomerUpdateResponse.Address;
264
+ /**
265
+ * Customer's date of birth in ISO 8601 datetime format. Example: '2025-09-05'.
266
+ * Reference: https://en.wikipedia.org/wiki/ISO_8601
267
+ */
268
+ dateOfBirth?: string;
269
+ /**
270
+ * Indicates whether the customer was deleted
271
+ */
272
+ deleted?: boolean;
273
+ /**
274
+ * The customer deletion timestamp
275
+ */
276
+ deletedAt?: string;
277
+ /**
278
+ * The email address of the customer
279
+ */
280
+ email?: string;
281
+ /**
282
+ * Deprecated. Use the customer.email instead
283
+ */
284
+ emailAddress?: string;
285
+ /**
286
+ * The full name or business name of the customer
287
+ */
288
+ fullName?: string;
289
+ /**
290
+ * A collection of key-value pairs that can be associated with an object to store
291
+ * custom data in a structured manner. This allows you to attach arbitrary
292
+ * information to enhance the object with additional context or properties. To
293
+ * clear the metadata, send an empty object.
294
+ */
295
+ metadata?: {
296
+ [key: string]: unknown;
297
+ };
298
+ /**
299
+ * The phone number of the customer
300
+ */
301
+ phone?: string;
302
+ }
303
+ export declare namespace CustomerUpdateResponse {
304
+ interface BankAccount {
305
+ /**
306
+ * Remembered bank details
307
+ */
308
+ bank: BankAccount.Bank;
309
+ /**
310
+ * Last 4 digits of remembered account number
311
+ */
312
+ last4digits: string;
313
+ }
314
+ namespace BankAccount {
315
+ /**
316
+ * Remembered bank details
317
+ */
318
+ interface Bank {
319
+ /**
320
+ * The id of the bank
321
+ */
322
+ id: string;
323
+ /**
324
+ * The name of the bank
325
+ */
326
+ name: string;
327
+ /**
328
+ * URL address of bank logo image
329
+ */
330
+ logo?: string;
331
+ }
332
+ }
333
+ /**
334
+ * The registered address of the customer
335
+ */
336
+ interface Address {
337
+ /**
338
+ * ISO 3166-1 alpha-2 country code (e.g. DE)
339
+ */
340
+ country: 'AF' | 'AL' | 'DZ' | 'AS' | 'AD' | 'AO' | 'AI' | 'AQ' | 'AG' | 'AR' | 'AM' | 'AW' | 'AU' | 'AT' | 'AZ' | 'BS' | 'BH' | 'BD' | 'BB' | 'BY' | 'BE' | 'BZ' | 'BJ' | 'BM' | 'BT' | 'BO' | 'BA' | 'BW' | 'BV' | 'BR' | 'IO' | 'BN' | 'BG' | 'BF' | 'BI' | 'KH' | 'CM' | 'CA' | 'CV' | 'KY' | 'CF' | 'TD' | 'CL' | 'CN' | 'CX' | 'CC' | 'CO' | 'KM' | 'CG' | 'CD' | 'CK' | 'CR' | 'CI' | 'HR' | 'CU' | 'CY' | 'CZ' | 'DK' | 'DJ' | 'DM' | 'DO' | 'EC' | 'EG' | 'SV' | 'GQ' | 'ER' | 'EE' | 'ET' | 'FK' | 'FO' | 'FJ' | 'FI' | 'FR' | 'GF' | 'PF' | 'TF' | 'GA' | 'GM' | 'GE' | 'DE' | 'GH' | 'GI' | 'GR' | 'GL' | 'GD' | 'GP' | 'GU' | 'GT' | 'GN' | 'GW' | 'GY' | 'HT' | 'HM' | 'VA' | 'HN' | 'HK' | 'HU' | 'IS' | 'IN' | 'ID' | 'IR' | 'IQ' | 'IE' | 'IL' | 'IT' | 'JM' | 'JP' | 'JO' | 'KZ' | 'KE' | 'KI' | 'KP' | 'KR' | 'KW' | 'KG' | 'LA' | 'LV' | 'LB' | 'LS' | 'LR' | 'LY' | 'LI' | 'LT' | 'LU' | 'MO' | 'MG' | 'MW' | 'MY' | 'MV' | 'ML' | 'MT' | 'MH' | 'MQ' | 'MR' | 'MU' | 'YT' | 'MX' | 'FM' | 'MD' | 'MC' | 'MN' | 'MS' | 'MA' | 'MZ' | 'MM' | 'NA' | 'NR' | 'NP' | 'NL' | 'NC' | 'NZ' | 'NI' | 'NE' | 'NG' | 'NU' | 'NF' | 'MP' | 'MK' | 'NO' | 'OM' | 'PK' | 'PW' | 'PS' | 'PA' | 'PG' | 'PY' | 'PE' | 'PH' | 'PN' | 'PL' | 'PT' | 'PR' | 'QA' | 'RE' | 'RO' | 'RU' | 'RW' | 'SH' | 'KN' | 'LC' | 'PM' | 'VC' | 'WS' | 'SM' | 'ST' | 'SA' | 'SN' | 'SC' | 'SL' | 'SG' | 'SK' | 'SI' | 'SB' | 'SO' | 'ZA' | 'GS' | 'ES' | 'LK' | 'SD' | 'SR' | 'SJ' | 'SZ' | 'SE' | 'CH' | 'SY' | 'TW' | 'TJ' | 'TZ' | 'TH' | 'TL' | 'TG' | 'TK' | 'TO' | 'TT' | 'TN' | 'TR' | 'TM' | 'TC' | 'TV' | 'UG' | 'UA' | 'AE' | 'GB' | 'US' | 'UM' | 'UY' | 'UZ' | 'VU' | 'VE' | 'VN' | 'VG' | 'VI' | 'WF' | 'EH' | 'YE' | 'ZM' | 'ZW' | 'AX' | 'BQ' | 'CW' | 'GG' | 'IM' | 'JE' | 'ME' | 'BL' | 'MF' | 'RS' | 'SX' | 'SS' | 'XK';
341
+ /**
342
+ * Full name of the city
343
+ */
344
+ city?: string;
345
+ /**
346
+ * Address line 1
347
+ */
348
+ line1?: string;
349
+ /**
350
+ * Address line 2
351
+ */
352
+ line2?: string;
353
+ /**
354
+ * The second part of the subdivision ISO 3166-2 country code (e.g. BE)
355
+ */
356
+ region?: '02' | '03' | '04' | '05' | '06' | '07' | '08' | 'AJ' | 'AZ' | 'DU' | 'FU' | 'RK' | 'SH' | 'UQ' | 'BAL' | 'BAM' | 'BDG' | 'BDS' | 'BGL' | 'DAY' | 'FRA' | 'FYB' | 'GHA' | 'GHO' | 'HEL' | 'HER' | 'JOW' | 'KAB' | 'KAN' | 'KAP' | 'KDZ' | 'KHO' | 'KNR' | 'LAG' | 'LOG' | 'NAN' | 'NIM' | 'NUR' | 'PAN' | 'PAR' | 'PIA' | 'PKA' | 'SAM' | 'SAR' | 'TAK' | 'URU' | 'WAR' | 'ZAB' | '10' | '11' | '01' | '09' | '12' | 'AG' | 'AR' | 'AV' | 'ER' | 'GR' | 'KT' | 'LO' | 'SU' | 'TV' | 'VD' | 'BGO' | 'BGU' | 'BIE' | 'CAB' | 'CCU' | 'CNN' | 'CNO' | 'CUS' | 'HUA' | 'HUI' | 'LNO' | 'LSU' | 'LUA' | 'MAL' | 'MOX' | 'NAM' | 'UIG' | 'ZAI' | 'A' | 'B' | 'C' | 'D' | 'E' | 'F' | 'G' | 'H' | 'J' | 'K' | 'L' | 'M' | 'N' | 'P' | 'Q' | 'R' | 'S' | 'T' | 'U' | 'V' | 'W' | 'X' | 'Y' | 'Z' | '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9' | 'ACT' | 'NSW' | 'NT' | 'QLD' | 'SA' | 'TAS' | 'VIC' | 'WA' | 'ABS' | 'AGA' | 'AGC' | 'AGM' | 'AGS' | 'AGU' | 'AST' | 'BA' | 'BAB' | 'BAR' | 'BEY' | 'BIL' | 'CAL' | 'CUL' | 'DAS' | 'FUZ' | 'GA' | 'GAD' | 'GOR' | 'GOY' | 'GYG' | 'HAC' | 'IMI' | 'ISM' | 'KAL' | 'KUR' | 'LA' | 'LAC' | 'LAN' | 'LER' | 'MAS' | 'MI' | 'NA' | 'NEF' | 'NV' | 'NX' | 'OGU' | 'ORD' | 'QAB' | 'QAX' | 'QAZ' | 'QBA' | 'QBI' | 'QOB' | 'QUS' | 'SAB' | 'SAD' | 'SAH' | 'SAK' | 'SAL' | 'SAT' | 'SBN' | 'SIY' | 'SKR' | 'SM' | 'SMI' | 'SMX' | 'SR' | 'SUS' | 'TAR' | 'TOV' | 'UCA' | 'XA' | 'XAC' | 'XCI' | 'XIZ' | 'XVD' | 'YAR' | 'YE' | 'YEV' | 'ZAN' | 'ZAQ' | 'ZAR' | 'BIH' | 'BRC' | 'SRP' | '13' | '14' | '15' | '16' | '17' | '18' | '19' | '20' | '21' | '22' | '23' | '24' | '25' | '26' | '27' | '28' | '29' | '30' | '31' | '32' | '33' | '34' | '35' | '36' | '37' | '38' | '39' | '40' | '41' | '42' | '43' | '44' | '45' | '46' | '47' | '48' | '49' | '50' | '51' | '52' | '53' | '54' | '55' | '56' | '57' | '58' | '59' | '60' | '61' | '62' | '63' | '64' | 'BRU' | 'VAN' | 'VBR' | 'VLG' | 'VLI' | 'VOV' | 'VWV' | 'WAL' | 'WBR' | 'WHT' | 'WLG' | 'WLX' | 'WNA' | 'BAN' | 'BAZ' | 'BGR' | 'BLG' | 'BLK' | 'COM' | 'GAN' | 'GNA' | 'GOU' | 'HOU' | 'IOB' | 'KAD' | 'KEN' | 'KMD' | 'KMP' | 'KOP' | 'KOS' | 'KOT' | 'KOW' | 'LOR' | 'MOU' | 'NAO' | 'NAY' | 'NOU' | 'OUB' | 'OUD' | 'PAS' | 'PON' | 'SEN' | 'SIS' | 'SMT' | 'SNG' | 'SOM' | 'SOR' | 'TAP' | 'TUI' | 'YAG' | 'YAT' | 'ZIR' | 'ZON' | 'ZOU' | 'BB' | 'BL' | 'BM' | 'BR' | 'CA' | 'CI' | 'GI' | 'KI' | 'KR' | 'KY' | 'MA' | 'MU' | 'MW' | 'MY' | 'NG' | 'RM' | 'RT' | 'RY' | 'AK' | 'AL' | 'AQ' | 'BO' | 'CO' | 'DO' | 'KO' | 'LI' | 'MO' | 'OU' | 'PL' | 'ZO' | 'BE' | 'TE' | 'TU' | 'O' | 'SE' | 'AC' | 'AM' | 'AP' | 'CE' | 'DF' | 'ES' | 'GO' | 'MG' | 'MS' | 'MT' | 'PA' | 'PB' | 'PE' | 'PI' | 'PR' | 'RJ' | 'RN' | 'RO' | 'RR' | 'RS' | 'SC' | 'SP' | 'TO' | 'BI' | 'BP' | 'BY' | 'CK' | 'CS' | 'EG' | 'EX' | 'FP' | 'GC' | 'HI' | 'HT' | 'IN' | 'MC' | 'NE' | 'NO' | 'NP' | 'NS' | 'RC' | 'RI' | 'SO' | 'SS' | 'SW' | 'WG' | 'TY' | 'CH' | 'FR' | 'GH' | 'JW' | 'KG' | 'KL' | 'KW' | 'NW' | 'ST' | 'HM' | 'HO' | 'HR' | 'VI' | 'BZ' | 'CY' | 'CZL' | 'OW' | 'TOL' | 'AB' | 'BC' | 'MB' | 'NB' | 'NL' | 'NU' | 'ON' | 'QC' | 'SK' | 'YT' | 'BU' | 'EQ' | 'HK' | 'HL' | 'HU' | 'IT' | 'KC' | 'KE' | 'KN' | 'KS' | 'LU' | 'MN' | 'NK' | 'TA' | 'BGF' | 'BK' | 'HS' | 'KB' | 'LB' | 'MP' | 'NM' | 'OP' | 'UK' | 'VK' | 'BZV' | 'AI' | 'BS' | 'GE' | 'GL' | 'JU' | 'SG' | 'SZ' | 'TG' | 'TI' | 'UR' | 'VS' | 'ZG' | 'ZH' | 'CM' | 'DN' | 'GD' | 'LC' | 'LG' | 'SV' | 'VB' | 'WR' | 'YM' | 'ZZ' | 'AN' | 'AT' | 'LL' | 'LR' | 'ML' | 'AD' | 'EN' | 'LT' | 'AH' | 'BJ' | 'CQ' | 'FJ' | 'GS' | 'GX' | 'GZ' | 'HA' | 'HB' | 'HE' | 'HN' | 'JL' | 'JS' | 'JX' | 'LN' | 'QH' | 'SD' | 'SN' | 'SX' | 'TJ' | 'TW' | 'XJ' | 'XZ' | 'YN' | 'ZJ' | 'AMA' | 'ANT' | 'ARA' | 'ATL' | 'BOL' | 'BOY' | 'CAQ' | 'CAS' | 'CAU' | 'CES' | 'CHO' | 'COR' | 'CUN' | 'DC' | 'GUA' | 'GUV' | 'MAG' | 'MET' | 'NAR' | 'NSA' | 'PUT' | 'QUI' | 'RIS' | 'SAN' | 'SAP' | 'SUC' | 'VAC' | 'VAU' | 'VID' | 'SJ' | '99' | 'BV' | 'CF' | 'CR' | 'PN' | 'RB' | 'RG' | 'SF' | 'SL' | 'TS' | '201' | '202' | '203' | '204' | '205' | '206' | '207' | '208' | '209' | '20A' | '20B' | '20C' | '311' | '312' | '313' | '314' | '315' | '316' | '317' | '321' | '322' | '323' | '324' | '325' | '326' | '327' | '411' | '412' | '413' | '421' | '422' | '423' | '424' | '425' | '426' | '427' | '511' | '512' | '513' | '514' | '521' | '522' | '523' | '524' | '525' | '531' | '532' | '533' | '534' | '631' | '632' | '633' | '634' | '635' | '641' | '642' | '643' | '644' | '645' | '646' | '647' | '71' | '711' | '712' | '713' | '714' | '715' | '72' | '721' | '722' | '723' | '724' | '80' | '801' | '802' | '803' | '804' | '805' | '806' | 'BW' | 'HH' | 'MV' | 'NI' | 'RP' | 'TH' | 'AS' | 'DI' | 'DJ' | 'OB' | '015' | '020' | '025' | '030' | '035' | '040' | '042' | '050' | '055' | '060' | '065' | '070' | '076' | '080' | '101' | '147' | '81' | '82' | '83' | '84' | '85' | 'I' | '130' | '141' | '142' | '171' | '184' | '191' | '198' | '214' | '245' | '247' | '251' | '255' | '272' | '283' | '284' | '291' | '293' | '296' | '303' | '305' | '338' | '353' | '430' | '431' | '432' | '441' | '442' | '446' | '478' | '480' | '486' | '503' | '528' | '557' | '567' | '586' | '615' | '618' | '622' | '624' | '638' | '651' | '653' | '661' | '663' | '668' | '68' | '689' | '698' | '708' | '719' | '726' | '732' | '735' | '74' | '784' | '79' | '792' | '793' | '796' | '809' | '824' | '834' | '855' | '87' | '890' | '897' | '899' | '901' | '903' | '907' | '917' | '919' | '928' | 'ALX' | 'ASN' | 'BH' | 'BNS' | 'DK' | 'DT' | 'FYM' | 'IS' | 'KFS' | 'LX' | 'MNF' | 'PTS' | 'SHG' | 'SHR' | 'SIN' | 'SUZ' | 'WAD' | 'GB' | 'CB' | 'CC' | 'CL' | 'CN' | 'CT' | 'CU' | 'GU' | 'IB' | 'LE' | 'MD' | 'NC' | 'OR' | 'PM' | 'PO' | 'PV' | 'TF' | 'VA' | 'VC' | 'ZA' | 'AA' | 'AF' | 'DD' | 'SI' | 'KSA' | 'PNI' | 'TRK' | 'YAP' | '20R' | '2A' | '2B' | '65' | '66' | '67' | '69' | '69M' | '6AE' | '70' | '73' | '75C' | '76' | '77' | '78' | '86' | '88' | '89' | '90' | '91' | '92' | '93' | '94' | '95' | '971' | '972' | '973' | '974' | '976' | 'BFC' | 'BRE' | 'CP' | 'CVL' | 'GES' | 'HDF' | 'IDF' | 'MF' | 'NAQ' | 'NOR' | 'OCC' | 'PAC' | 'PDL' | 'PF' | 'WF' | 'ABC' | 'ABD' | 'ABE' | 'AGB' | 'AGY' | 'AND' | 'ANN' | 'ANS' | 'BAS' | 'BBD' | 'BCP' | 'BDF' | 'BEN' | 'BEX' | 'BFS' | 'BGE' | 'BGW' | 'BIR' | 'BKM' | 'BNE' | 'BNH' | 'BPL' | 'BRD' | 'BRY' | 'BST' | 'BUR' | 'CAM' | 'CAY' | 'CBF' | 'CCG' | 'CGN' | 'CHE' | 'CHW' | 'CLD' | 'CLK' | 'CMA' | 'CMD' | 'CMN' | 'CON' | 'COV' | 'CRF' | 'CRY' | 'CWY' | 'DAL' | 'DBY' | 'DEN' | 'DER' | 'DEV' | 'DGY' | 'DNC' | 'DND' | 'DOR' | 'DRS' | 'DUD' | 'DUR' | 'EAL' | 'EAW' | 'EAY' | 'EDH' | 'EDU' | 'ELN' | 'ELS' | 'ENF' | 'ENG' | 'ERW' | 'ERY' | 'ESS' | 'ESX' | 'FAL' | 'FIF' | 'FLN' | 'FMO' | 'GAT' | 'GBN' | 'GLG' | 'GLS' | 'GRE' | 'GWN' | 'HAL' | 'HAM' | 'HAV' | 'HCK' | 'HEF' | 'HIL' | 'HLD' | 'HMF' | 'HNS' | 'HPL' | 'HRT' | 'HRW' | 'HRY' | 'IOS' | 'IOW' | 'ISL' | 'IVC' | 'KEC' | 'KHL' | 'KIR' | 'KTT' | 'KWL' | 'LBC' | 'LBH' | 'LCE' | 'LDS' | 'LEC' | 'LEW' | 'LIN' | 'LIV' | 'LND' | 'LUT' | 'MAN' | 'MDB' | 'MDW' | 'MEA' | 'MIK' | 'MLN' | 'MON' | 'MRT' | 'MRY' | 'MTY' | 'MUL' | 'NBL' | 'NEL' | 'NET' | 'NFK' | 'NGM' | 'NIR' | 'NLK' | 'NLN' | 'NMD' | 'NNH' | 'NSM' | 'NTL' | 'NTT' | 'NTY' | 'NWM' | 'NWP' | 'NYK' | 'OLD' | 'ORK' | 'OXF' | 'PEM' | 'PKN' | 'PLY' | 'POR' | 'POW' | 'PTE' | 'RCC' | 'RCH' | 'RCT' | 'RDB' | 'RDG' | 'RFW' | 'RIC' | 'ROT' | 'RUT' | 'SAW' | 'SAY' | 'SCB' | 'SCT' | 'SFK' | 'SFT' | 'SGC' | 'SHF' | 'SHN' | 'SKP' | 'SLF' | 'SLG' | 'SLK' | 'SND' | 'SOL' | 'SOS' | 'SRY' | 'STE' | 'STG' | 'STH' | 'STN' | 'STS' | 'STT' | 'STY' | 'SWA' | 'SWD' | 'SWK' | 'TAM' | 'TFW' | 'THR' | 'TOB' | 'TOF' | 'TRF' | 'TWH' | 'UKM' | 'VGL' | 'WBK' | 'WDU' | 'WFT' | 'WGN' | 'WIL' | 'WKF' | 'WLL' | 'WLN' | 'WLS' | 'WLV' | 'WND' | 'WNH' | 'WNM' | 'WOK' | 'WOR' | 'WRL' | 'WRT' | 'WRX' | 'WSM' | 'WSX' | 'YOR' | 'ZET' | 'IM' | 'KA' | 'KK' | 'MM' | 'RL' | 'TB' | 'EP' | 'OT' | 'UE' | 'UW' | 'WN' | 'WP' | 'KU' | 'QE' | 'QT' | 'BF' | 'DB' | 'DL' | 'FA' | 'FO' | 'KD' | 'NZ' | 'YO' | 'BN' | 'OI' | 'QU' | 'DE' | 'EB' | 'PT' | 'UD' | 'UT' | 'FM' | 'LP' | 'OC' | 'OL' | 'SB' | 'ND' | 'FE' | 'GY' | 'HV' | 'JN' | 'KM' | 'KV' | 'NY' | 'PS' | 'VE' | 'VM' | 'ZE' | 'BT' | 'JA' | 'JB' | 'JI' | 'JK' | 'JT' | 'PP' | 'CW' | 'LD' | 'LH' | 'LK' | 'LM' | 'LS' | 'MH' | 'OY' | 'WD' | 'WH' | 'WW' | 'WX' | 'JM' | 'DH' | 'GJ' | 'HP' | 'JH' | 'MZ' | 'PY' | 'TN' | 'TR' | 'UP' | 'WB' | 'BG' | 'DA' | 'DQ' | 'QA' | '00' | 'AKN' | 'AKU' | 'ARN' | 'ASA' | 'BLA' | 'BOG' | 'DAB' | 'DAV' | 'EOM' | 'EYF' | 'FJD' | 'FJL' | 'FLA' | 'FLR' | 'GAR' | 'GOG' | 'GRN' | 'GRU' | 'GRY' | 'HAF' | 'HRG' | 'HRU' | 'HUG' | 'HUV' | 'HVA' | 'HVE' | 'ISA' | 'KJO' | 'MOS' | 'MYR' | 'RGE' | 'RGY' | 'RHH' | 'RKN' | 'RKV' | 'SBT' | 'SDN' | 'SDV' | 'SEL' | 'SFA' | 'SKF' | 'SKG' | 'SKO' | 'SNF' | 'SOG' | 'SSS' | 'STR' | 'SVG' | 'TAL' | 'THG' | 'TJO' | 'VEM' | 'VER' | 'VOP' | '75' | 'CZ' | 'FC' | 'FG' | 'FI' | 'ME' | 'PC' | 'PD' | 'PG' | 'PU' | 'PZ' | 'RA' | 'RE' | 'TP' | 'VR' | 'VT' | 'VV' | 'IR' | 'KH' | 'PH' | 'XE' | 'XI' | 'XS' | 'GG' | 'GK' | 'GP' | 'MR' | 'VL' | 'EC' | 'RD' | 'WI' | '002' | '007' | '011' | '016' | '022' | '026' | '033' | '041' | '047' | '052' | '054' | '056' | '058' | '059' | '062' | '067' | '068' | '073' | '077' | '087' | '088' | '089' | '091' | '094' | '097' | '099' | '102' | '106' | '111' | '112' | '113' | 'DGV' | 'JEL' | 'JUR' | 'LPX' | 'REZ' | 'RIX' | 'VEN' | 'DR' | 'GT' | 'JG' | 'KF' | 'MJ' | 'MQ' | 'NQ' | 'WS' | 'AGD' | 'AOU' | 'ASZ' | 'AZI' | 'BEM' | 'BER' | 'BES' | 'BOD' | 'BOM' | 'BRR' | 'CHI' | 'CHT' | 'DRI' | 'ERR' | 'ESI' | 'ESM' | 'FAH' | 'FES' | 'FIG' | 'FQH' | 'GUE' | 'GUF' | 'HAJ' | 'HAO' | 'HOC' | 'IFR' | 'INE' | 'JDI' | 'JRA' | 'KES' | 'KHE' | 'KHN' | 'LAA' | 'LAR' | 'MAR' | 'MDF' | 'MED' | 'MEK' | 'MID' | 'MOH' | 'NAD' | 'OUA' | 'OUJ' | 'OUZ' | 'RAB' | 'REH' | 'SAF' | 'SEF' | 'SET' | 'SIB' | 'SIF' | 'SIK' | 'SIL' | 'SKH' | 'TAF' | 'TAI' | 'TAO' | 'TAT' | 'TAZ' | 'TET' | 'TIN' | 'TIZ' | 'TNG' | 'TNT' | 'YUS' | 'ZAG' | 'JE' | 'BD' | 'ED' | 'FL' | 'IA' | 'UN' | 'ALK' | 'ALL' | 'AUR' | 'EBO' | 'ENI' | 'JAB' | 'JAL' | 'KIL' | 'KWA' | 'LAE' | 'LIB' | 'LIK' | 'MAJ' | 'MEJ' | 'MIL' | 'NMK' | 'NMU' | 'RON' | 'UJA' | 'UTI' | 'WTH' | 'WTJ' | '103' | '104' | '105' | '107' | '108' | '109' | '210' | '211' | '301' | '304' | '307' | '308' | '310' | '401' | '402' | '403' | '404' | '405' | '406' | '407' | '408' | '409' | '410' | '501' | '502' | '504' | '505' | '506' | '507' | '508' | '509' | '601' | '602' | '603' | '604' | '605' | '606' | '607' | '608' | '609' | '701' | '702' | '703' | '704' | '705' | '706' | '807' | '808' | '810' | '811' | '812' | '813' | '814' | '815' | '816' | '817' | 'BKO' | '037' | '039' | '043' | '046' | '049' | '051' | '053' | '057' | '061' | '063' | '064' | '069' | '071' | 'PW' | 'MLE' | 'RU' | 'BCN' | 'BCS' | 'CHH' | 'CHP' | 'CMX' | 'COA' | 'COL' | 'GRO' | 'HID' | 'MEX' | 'MIC' | 'MOR' | 'NLE' | 'OAX' | 'PUE' | 'QUE' | 'ROO' | 'SLP' | 'SON' | 'TAB' | 'TLA' | 'YUC' | 'ZAC' | 'MPM' | 'OD' | 'OH' | 'OS' | 'EK' | 'OG' | 'AW' | 'BQ1' | 'BQ2' | 'BQ3' | 'NH' | 'OV' | 'P1' | 'P2' | 'P3' | 'P4' | 'P5' | 'P6' | 'P7' | 'AUK' | 'BOP' | 'CAN' | 'CIT' | 'GIS' | 'HKB' | 'MBH' | 'MWT' | 'NSN' | 'OTA' | 'STL' | 'TKI' | 'WKO' | 'WTC' | 'WU' | 'ZU' | 'EM' | 'ANC' | 'APU' | 'ARE' | 'AYA' | 'CAJ' | 'HUC' | 'ICA' | 'JUN' | 'LAL' | 'LAM' | 'LIM' | 'LMA' | 'MDD' | 'MOQ' | 'PIU' | 'PUN' | 'TAC' | 'TUM' | 'CPK' | 'CPM' | 'EBR' | 'EHG' | 'EPW' | 'ESW' | 'GPK' | 'HLA' | 'JWK' | 'MBA' | 'MPL' | 'MRL' | 'NCD' | 'NIK' | 'NPP' | 'NSB' | 'SHM' | 'WHM' | 'WPD' | 'ABR' | 'AGN' | 'AKL' | 'ALB' | 'APA' | 'BOH' | 'BTG' | 'BTN' | 'BUK' | 'BUL' | 'CAG' | 'CAP' | 'CAT' | 'CAV' | 'CEB' | 'DAO' | 'DIN' | 'DVO' | 'EAS' | 'GUI' | 'IFU' | 'ILI' | 'ILN' | 'ILS' | 'LAS' | 'LEY' | 'LUN' | 'MAD' | 'MDC' | 'MDR' | 'MSC' | 'MSR' | 'NCO' | 'NEC' | 'NER' | 'NUE' | 'NUV' | 'PAM' | 'PLW' | 'RIZ' | 'ROM' | 'SCO' | 'SIG' | 'SLE' | 'SLU' | 'SUK' | 'SUN' | 'SUR' | 'TAW' | 'WSA' | 'ZAS' | 'ZMB' | 'ZSI' | 'KP' | 'BTH' | 'DEB' | 'GZA' | 'HBN' | 'JEM' | 'JEN' | 'JRH' | 'KYS' | 'NBS' | 'NGZ' | 'QQA' | 'RBH' | 'RFH' | 'SLT' | 'TBS' | 'TKM' | '004' | '010' | '100' | '150' | '212' | '218' | '222' | '224' | '226' | '227' | '228' | '350' | '370' | 'ASU' | 'US' | 'CJ' | 'CV' | 'HD' | 'IF' | 'IL' | 'TL' | 'TM' | 'VN' | 'VO' | 'ALT' | 'AMU' | 'ARK' | 'BEL' | 'CHU' | 'IRK' | 'IVA' | 'KAM' | 'KDA' | 'KEM' | 'KGD' | 'KGN' | 'KHA' | 'KHM' | 'KLU' | 'KRS' | 'KYA' | 'LEN' | 'LIP' | 'MOW' | 'MUR' | 'NEN' | 'NGR' | 'NIZ' | 'NVS' | 'OMS' | 'ORE' | 'ORL' | 'PER' | 'PNZ' | 'PRI' | 'PSK' | 'ROS' | 'RYA' | 'SMO' | 'SPE' | 'STA' | 'SVE' | 'TOM' | 'TUL' | 'TVE' | 'TYU' | 'ULY' | 'VGG' | 'VLA' | 'VOR' | 'YAN' | 'MK' | 'WE' | 'DS' | 'DW' | 'NR' | '001' | '003' | '005' | '006' | '008' | '009' | '012' | '013' | '014' | '017' | '018' | '019' | '021' | '023' | '024' | '027' | '028' | '029' | '031' | '032' | '034' | '036' | '038' | '044' | '045' | '048' | '066' | '072' | '074' | '075' | '078' | '079' | '081' | '082' | '083' | '084' | '085' | '086' | '090' | '092' | '093' | '095' | '096' | '098' | '110' | '114' | '115' | '116' | '117' | '118' | '119' | '120' | '121' | '122' | '123' | '124' | '125' | '126' | '127' | '128' | '129' | '131' | '132' | '133' | '134' | '135' | '136' | '137' | '138' | '139' | '140' | '143' | '144' | '146' | '148' | '149' | '151' | '152' | '153' | '154' | '155' | '156' | '157' | '158' | '159' | '160' | '161' | '162' | '163' | '164' | '165' | '166' | '167' | '168' | '169' | '170' | '172' | '173' | '174' | '175' | '176' | '177' | '178' | '179' | '180' | '181' | '182' | '183' | '185' | '186' | '187' | '188' | '189' | '190' | '192' | '193' | '194' | '195' | '196' | '197' | '199' | '200' | '213' | 'TC' | 'ZI' | 'FK' | 'JD' | 'WO' | 'EE' | 'EW' | 'UY' | 'DY' | 'ID' | 'EO' | '96' | 'OE' | 'ARI' | 'CHA' | 'CTT' | 'DMN' | 'MRC' | 'PED' | 'POS' | 'PRT' | 'PTF' | 'SFO' | 'SGE' | 'SIP' | 'SJL' | 'TUP' | 'FUN' | 'NIT' | 'NKF' | 'NKL' | 'NMA' | 'NMG' | 'NUI' | 'VAI' | 'CYI' | 'CYQ' | 'HSQ' | 'HSZ' | 'ILA' | 'KEE' | 'KHH' | 'KIN' | 'LIE' | 'MIA' | 'NWT' | 'PEN' | 'PIF' | 'TNN' | 'TPE' | 'TTT' | 'TXG' | 'YUN' | '215' | '216' | '217' | '219' | '220' | '221' | '223' | '225' | '229' | '230' | '231' | '232' | '233' | '234' | '235' | '236' | '237' | '302' | '306' | '309' | '318' | '319' | '320' | '328' | '329' | '330' | '331' | '332' | '333' | '334' | '335' | '336' | '337' | '414' | '415' | '416' | '417' | '418' | '419' | '420' | '428' | '429' | '433' | '434' | '435' | 'NJ' | 'OK' | 'TX' | 'UM' | 'WV' | 'WY' | 'FD' | 'FS' | 'RV' | 'TT' | 'QR' | 'TK' | 'XO' | 'MAP' | 'SEE' | 'TAE' | 'UV' | 'VF' | 'HJ' | 'KZN' | 'WC';
357
+ /**
358
+ * The zip or postal code
359
+ */
360
+ zipCode?: string;
361
+ }
362
+ }
363
+ export interface CustomerDeleteResponse {
364
+ /**
365
+ * Indicates whether the customer deletion was successful
366
+ */
367
+ success: boolean;
368
+ }
369
+ export interface CustomerSearchResponse {
370
+ /**
371
+ * The total number of items
372
+ */
373
+ count: number;
374
+ /**
375
+ * Whether there are more items to retrieve
376
+ */
377
+ hasNext: boolean;
378
+ /**
379
+ * Array of customer objects matching the search criteria
380
+ */
381
+ items: Array<CustomerSearchResponse.Item>;
382
+ /**
383
+ * The number of items skipped
384
+ */
385
+ skip: number;
386
+ }
387
+ export declare namespace CustomerSearchResponse {
388
+ interface Item {
389
+ /**
390
+ * The id of the customer
391
+ */
392
+ id: string;
393
+ /**
394
+ * Array of bank accounts remembered by user
395
+ */
396
+ bankAccounts: Array<Item.BankAccount>;
397
+ /**
398
+ * The registered address of the customer
399
+ */
400
+ address?: Item.Address;
401
+ /**
402
+ * Customer's date of birth in ISO 8601 datetime format. Example: '2025-09-05'.
403
+ * Reference: https://en.wikipedia.org/wiki/ISO_8601
404
+ */
405
+ dateOfBirth?: string;
406
+ /**
407
+ * Indicates whether the customer was deleted
408
+ */
409
+ deleted?: boolean;
410
+ /**
411
+ * The customer deletion timestamp
412
+ */
413
+ deletedAt?: string;
414
+ /**
415
+ * The email address of the customer
416
+ */
417
+ email?: string;
418
+ /**
419
+ * Deprecated. Use the customer.email instead
420
+ */
421
+ emailAddress?: string;
422
+ /**
423
+ * The full name or business name of the customer
424
+ */
425
+ fullName?: string;
426
+ /**
427
+ * A collection of key-value pairs that can be associated with an object to store
428
+ * custom data in a structured manner. This allows you to attach arbitrary
429
+ * information to enhance the object with additional context or properties. To
430
+ * clear the metadata, send an empty object.
431
+ */
432
+ metadata?: {
433
+ [key: string]: unknown;
434
+ };
435
+ /**
436
+ * The phone number of the customer
437
+ */
438
+ phone?: string;
439
+ }
440
+ namespace Item {
441
+ interface BankAccount {
442
+ /**
443
+ * Remembered bank details
444
+ */
445
+ bank: BankAccount.Bank;
446
+ /**
447
+ * Last 4 digits of remembered account number
448
+ */
449
+ last4digits: string;
450
+ }
451
+ namespace BankAccount {
452
+ /**
453
+ * Remembered bank details
454
+ */
455
+ interface Bank {
456
+ /**
457
+ * The id of the bank
458
+ */
459
+ id: string;
460
+ /**
461
+ * The name of the bank
462
+ */
463
+ name: string;
464
+ /**
465
+ * URL address of bank logo image
466
+ */
467
+ logo?: string;
468
+ }
469
+ }
470
+ /**
471
+ * The registered address of the customer
472
+ */
473
+ interface Address {
474
+ /**
475
+ * ISO 3166-1 alpha-2 country code (e.g. DE)
476
+ */
477
+ country: 'AF' | 'AL' | 'DZ' | 'AS' | 'AD' | 'AO' | 'AI' | 'AQ' | 'AG' | 'AR' | 'AM' | 'AW' | 'AU' | 'AT' | 'AZ' | 'BS' | 'BH' | 'BD' | 'BB' | 'BY' | 'BE' | 'BZ' | 'BJ' | 'BM' | 'BT' | 'BO' | 'BA' | 'BW' | 'BV' | 'BR' | 'IO' | 'BN' | 'BG' | 'BF' | 'BI' | 'KH' | 'CM' | 'CA' | 'CV' | 'KY' | 'CF' | 'TD' | 'CL' | 'CN' | 'CX' | 'CC' | 'CO' | 'KM' | 'CG' | 'CD' | 'CK' | 'CR' | 'CI' | 'HR' | 'CU' | 'CY' | 'CZ' | 'DK' | 'DJ' | 'DM' | 'DO' | 'EC' | 'EG' | 'SV' | 'GQ' | 'ER' | 'EE' | 'ET' | 'FK' | 'FO' | 'FJ' | 'FI' | 'FR' | 'GF' | 'PF' | 'TF' | 'GA' | 'GM' | 'GE' | 'DE' | 'GH' | 'GI' | 'GR' | 'GL' | 'GD' | 'GP' | 'GU' | 'GT' | 'GN' | 'GW' | 'GY' | 'HT' | 'HM' | 'VA' | 'HN' | 'HK' | 'HU' | 'IS' | 'IN' | 'ID' | 'IR' | 'IQ' | 'IE' | 'IL' | 'IT' | 'JM' | 'JP' | 'JO' | 'KZ' | 'KE' | 'KI' | 'KP' | 'KR' | 'KW' | 'KG' | 'LA' | 'LV' | 'LB' | 'LS' | 'LR' | 'LY' | 'LI' | 'LT' | 'LU' | 'MO' | 'MG' | 'MW' | 'MY' | 'MV' | 'ML' | 'MT' | 'MH' | 'MQ' | 'MR' | 'MU' | 'YT' | 'MX' | 'FM' | 'MD' | 'MC' | 'MN' | 'MS' | 'MA' | 'MZ' | 'MM' | 'NA' | 'NR' | 'NP' | 'NL' | 'NC' | 'NZ' | 'NI' | 'NE' | 'NG' | 'NU' | 'NF' | 'MP' | 'MK' | 'NO' | 'OM' | 'PK' | 'PW' | 'PS' | 'PA' | 'PG' | 'PY' | 'PE' | 'PH' | 'PN' | 'PL' | 'PT' | 'PR' | 'QA' | 'RE' | 'RO' | 'RU' | 'RW' | 'SH' | 'KN' | 'LC' | 'PM' | 'VC' | 'WS' | 'SM' | 'ST' | 'SA' | 'SN' | 'SC' | 'SL' | 'SG' | 'SK' | 'SI' | 'SB' | 'SO' | 'ZA' | 'GS' | 'ES' | 'LK' | 'SD' | 'SR' | 'SJ' | 'SZ' | 'SE' | 'CH' | 'SY' | 'TW' | 'TJ' | 'TZ' | 'TH' | 'TL' | 'TG' | 'TK' | 'TO' | 'TT' | 'TN' | 'TR' | 'TM' | 'TC' | 'TV' | 'UG' | 'UA' | 'AE' | 'GB' | 'US' | 'UM' | 'UY' | 'UZ' | 'VU' | 'VE' | 'VN' | 'VG' | 'VI' | 'WF' | 'EH' | 'YE' | 'ZM' | 'ZW' | 'AX' | 'BQ' | 'CW' | 'GG' | 'IM' | 'JE' | 'ME' | 'BL' | 'MF' | 'RS' | 'SX' | 'SS' | 'XK';
478
+ /**
479
+ * Full name of the city
480
+ */
481
+ city?: string;
482
+ /**
483
+ * Address line 1
484
+ */
485
+ line1?: string;
486
+ /**
487
+ * Address line 2
488
+ */
489
+ line2?: string;
490
+ /**
491
+ * The second part of the subdivision ISO 3166-2 country code (e.g. BE)
492
+ */
493
+ region?: '02' | '03' | '04' | '05' | '06' | '07' | '08' | 'AJ' | 'AZ' | 'DU' | 'FU' | 'RK' | 'SH' | 'UQ' | 'BAL' | 'BAM' | 'BDG' | 'BDS' | 'BGL' | 'DAY' | 'FRA' | 'FYB' | 'GHA' | 'GHO' | 'HEL' | 'HER' | 'JOW' | 'KAB' | 'KAN' | 'KAP' | 'KDZ' | 'KHO' | 'KNR' | 'LAG' | 'LOG' | 'NAN' | 'NIM' | 'NUR' | 'PAN' | 'PAR' | 'PIA' | 'PKA' | 'SAM' | 'SAR' | 'TAK' | 'URU' | 'WAR' | 'ZAB' | '10' | '11' | '01' | '09' | '12' | 'AG' | 'AR' | 'AV' | 'ER' | 'GR' | 'KT' | 'LO' | 'SU' | 'TV' | 'VD' | 'BGO' | 'BGU' | 'BIE' | 'CAB' | 'CCU' | 'CNN' | 'CNO' | 'CUS' | 'HUA' | 'HUI' | 'LNO' | 'LSU' | 'LUA' | 'MAL' | 'MOX' | 'NAM' | 'UIG' | 'ZAI' | 'A' | 'B' | 'C' | 'D' | 'E' | 'F' | 'G' | 'H' | 'J' | 'K' | 'L' | 'M' | 'N' | 'P' | 'Q' | 'R' | 'S' | 'T' | 'U' | 'V' | 'W' | 'X' | 'Y' | 'Z' | '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9' | 'ACT' | 'NSW' | 'NT' | 'QLD' | 'SA' | 'TAS' | 'VIC' | 'WA' | 'ABS' | 'AGA' | 'AGC' | 'AGM' | 'AGS' | 'AGU' | 'AST' | 'BA' | 'BAB' | 'BAR' | 'BEY' | 'BIL' | 'CAL' | 'CUL' | 'DAS' | 'FUZ' | 'GA' | 'GAD' | 'GOR' | 'GOY' | 'GYG' | 'HAC' | 'IMI' | 'ISM' | 'KAL' | 'KUR' | 'LA' | 'LAC' | 'LAN' | 'LER' | 'MAS' | 'MI' | 'NA' | 'NEF' | 'NV' | 'NX' | 'OGU' | 'ORD' | 'QAB' | 'QAX' | 'QAZ' | 'QBA' | 'QBI' | 'QOB' | 'QUS' | 'SAB' | 'SAD' | 'SAH' | 'SAK' | 'SAL' | 'SAT' | 'SBN' | 'SIY' | 'SKR' | 'SM' | 'SMI' | 'SMX' | 'SR' | 'SUS' | 'TAR' | 'TOV' | 'UCA' | 'XA' | 'XAC' | 'XCI' | 'XIZ' | 'XVD' | 'YAR' | 'YE' | 'YEV' | 'ZAN' | 'ZAQ' | 'ZAR' | 'BIH' | 'BRC' | 'SRP' | '13' | '14' | '15' | '16' | '17' | '18' | '19' | '20' | '21' | '22' | '23' | '24' | '25' | '26' | '27' | '28' | '29' | '30' | '31' | '32' | '33' | '34' | '35' | '36' | '37' | '38' | '39' | '40' | '41' | '42' | '43' | '44' | '45' | '46' | '47' | '48' | '49' | '50' | '51' | '52' | '53' | '54' | '55' | '56' | '57' | '58' | '59' | '60' | '61' | '62' | '63' | '64' | 'BRU' | 'VAN' | 'VBR' | 'VLG' | 'VLI' | 'VOV' | 'VWV' | 'WAL' | 'WBR' | 'WHT' | 'WLG' | 'WLX' | 'WNA' | 'BAN' | 'BAZ' | 'BGR' | 'BLG' | 'BLK' | 'COM' | 'GAN' | 'GNA' | 'GOU' | 'HOU' | 'IOB' | 'KAD' | 'KEN' | 'KMD' | 'KMP' | 'KOP' | 'KOS' | 'KOT' | 'KOW' | 'LOR' | 'MOU' | 'NAO' | 'NAY' | 'NOU' | 'OUB' | 'OUD' | 'PAS' | 'PON' | 'SEN' | 'SIS' | 'SMT' | 'SNG' | 'SOM' | 'SOR' | 'TAP' | 'TUI' | 'YAG' | 'YAT' | 'ZIR' | 'ZON' | 'ZOU' | 'BB' | 'BL' | 'BM' | 'BR' | 'CA' | 'CI' | 'GI' | 'KI' | 'KR' | 'KY' | 'MA' | 'MU' | 'MW' | 'MY' | 'NG' | 'RM' | 'RT' | 'RY' | 'AK' | 'AL' | 'AQ' | 'BO' | 'CO' | 'DO' | 'KO' | 'LI' | 'MO' | 'OU' | 'PL' | 'ZO' | 'BE' | 'TE' | 'TU' | 'O' | 'SE' | 'AC' | 'AM' | 'AP' | 'CE' | 'DF' | 'ES' | 'GO' | 'MG' | 'MS' | 'MT' | 'PA' | 'PB' | 'PE' | 'PI' | 'PR' | 'RJ' | 'RN' | 'RO' | 'RR' | 'RS' | 'SC' | 'SP' | 'TO' | 'BI' | 'BP' | 'BY' | 'CK' | 'CS' | 'EG' | 'EX' | 'FP' | 'GC' | 'HI' | 'HT' | 'IN' | 'MC' | 'NE' | 'NO' | 'NP' | 'NS' | 'RC' | 'RI' | 'SO' | 'SS' | 'SW' | 'WG' | 'TY' | 'CH' | 'FR' | 'GH' | 'JW' | 'KG' | 'KL' | 'KW' | 'NW' | 'ST' | 'HM' | 'HO' | 'HR' | 'VI' | 'BZ' | 'CY' | 'CZL' | 'OW' | 'TOL' | 'AB' | 'BC' | 'MB' | 'NB' | 'NL' | 'NU' | 'ON' | 'QC' | 'SK' | 'YT' | 'BU' | 'EQ' | 'HK' | 'HL' | 'HU' | 'IT' | 'KC' | 'KE' | 'KN' | 'KS' | 'LU' | 'MN' | 'NK' | 'TA' | 'BGF' | 'BK' | 'HS' | 'KB' | 'LB' | 'MP' | 'NM' | 'OP' | 'UK' | 'VK' | 'BZV' | 'AI' | 'BS' | 'GE' | 'GL' | 'JU' | 'SG' | 'SZ' | 'TG' | 'TI' | 'UR' | 'VS' | 'ZG' | 'ZH' | 'CM' | 'DN' | 'GD' | 'LC' | 'LG' | 'SV' | 'VB' | 'WR' | 'YM' | 'ZZ' | 'AN' | 'AT' | 'LL' | 'LR' | 'ML' | 'AD' | 'EN' | 'LT' | 'AH' | 'BJ' | 'CQ' | 'FJ' | 'GS' | 'GX' | 'GZ' | 'HA' | 'HB' | 'HE' | 'HN' | 'JL' | 'JS' | 'JX' | 'LN' | 'QH' | 'SD' | 'SN' | 'SX' | 'TJ' | 'TW' | 'XJ' | 'XZ' | 'YN' | 'ZJ' | 'AMA' | 'ANT' | 'ARA' | 'ATL' | 'BOL' | 'BOY' | 'CAQ' | 'CAS' | 'CAU' | 'CES' | 'CHO' | 'COR' | 'CUN' | 'DC' | 'GUA' | 'GUV' | 'MAG' | 'MET' | 'NAR' | 'NSA' | 'PUT' | 'QUI' | 'RIS' | 'SAN' | 'SAP' | 'SUC' | 'VAC' | 'VAU' | 'VID' | 'SJ' | '99' | 'BV' | 'CF' | 'CR' | 'PN' | 'RB' | 'RG' | 'SF' | 'SL' | 'TS' | '201' | '202' | '203' | '204' | '205' | '206' | '207' | '208' | '209' | '20A' | '20B' | '20C' | '311' | '312' | '313' | '314' | '315' | '316' | '317' | '321' | '322' | '323' | '324' | '325' | '326' | '327' | '411' | '412' | '413' | '421' | '422' | '423' | '424' | '425' | '426' | '427' | '511' | '512' | '513' | '514' | '521' | '522' | '523' | '524' | '525' | '531' | '532' | '533' | '534' | '631' | '632' | '633' | '634' | '635' | '641' | '642' | '643' | '644' | '645' | '646' | '647' | '71' | '711' | '712' | '713' | '714' | '715' | '72' | '721' | '722' | '723' | '724' | '80' | '801' | '802' | '803' | '804' | '805' | '806' | 'BW' | 'HH' | 'MV' | 'NI' | 'RP' | 'TH' | 'AS' | 'DI' | 'DJ' | 'OB' | '015' | '020' | '025' | '030' | '035' | '040' | '042' | '050' | '055' | '060' | '065' | '070' | '076' | '080' | '101' | '147' | '81' | '82' | '83' | '84' | '85' | 'I' | '130' | '141' | '142' | '171' | '184' | '191' | '198' | '214' | '245' | '247' | '251' | '255' | '272' | '283' | '284' | '291' | '293' | '296' | '303' | '305' | '338' | '353' | '430' | '431' | '432' | '441' | '442' | '446' | '478' | '480' | '486' | '503' | '528' | '557' | '567' | '586' | '615' | '618' | '622' | '624' | '638' | '651' | '653' | '661' | '663' | '668' | '68' | '689' | '698' | '708' | '719' | '726' | '732' | '735' | '74' | '784' | '79' | '792' | '793' | '796' | '809' | '824' | '834' | '855' | '87' | '890' | '897' | '899' | '901' | '903' | '907' | '917' | '919' | '928' | 'ALX' | 'ASN' | 'BH' | 'BNS' | 'DK' | 'DT' | 'FYM' | 'IS' | 'KFS' | 'LX' | 'MNF' | 'PTS' | 'SHG' | 'SHR' | 'SIN' | 'SUZ' | 'WAD' | 'GB' | 'CB' | 'CC' | 'CL' | 'CN' | 'CT' | 'CU' | 'GU' | 'IB' | 'LE' | 'MD' | 'NC' | 'OR' | 'PM' | 'PO' | 'PV' | 'TF' | 'VA' | 'VC' | 'ZA' | 'AA' | 'AF' | 'DD' | 'SI' | 'KSA' | 'PNI' | 'TRK' | 'YAP' | '20R' | '2A' | '2B' | '65' | '66' | '67' | '69' | '69M' | '6AE' | '70' | '73' | '75C' | '76' | '77' | '78' | '86' | '88' | '89' | '90' | '91' | '92' | '93' | '94' | '95' | '971' | '972' | '973' | '974' | '976' | 'BFC' | 'BRE' | 'CP' | 'CVL' | 'GES' | 'HDF' | 'IDF' | 'MF' | 'NAQ' | 'NOR' | 'OCC' | 'PAC' | 'PDL' | 'PF' | 'WF' | 'ABC' | 'ABD' | 'ABE' | 'AGB' | 'AGY' | 'AND' | 'ANN' | 'ANS' | 'BAS' | 'BBD' | 'BCP' | 'BDF' | 'BEN' | 'BEX' | 'BFS' | 'BGE' | 'BGW' | 'BIR' | 'BKM' | 'BNE' | 'BNH' | 'BPL' | 'BRD' | 'BRY' | 'BST' | 'BUR' | 'CAM' | 'CAY' | 'CBF' | 'CCG' | 'CGN' | 'CHE' | 'CHW' | 'CLD' | 'CLK' | 'CMA' | 'CMD' | 'CMN' | 'CON' | 'COV' | 'CRF' | 'CRY' | 'CWY' | 'DAL' | 'DBY' | 'DEN' | 'DER' | 'DEV' | 'DGY' | 'DNC' | 'DND' | 'DOR' | 'DRS' | 'DUD' | 'DUR' | 'EAL' | 'EAW' | 'EAY' | 'EDH' | 'EDU' | 'ELN' | 'ELS' | 'ENF' | 'ENG' | 'ERW' | 'ERY' | 'ESS' | 'ESX' | 'FAL' | 'FIF' | 'FLN' | 'FMO' | 'GAT' | 'GBN' | 'GLG' | 'GLS' | 'GRE' | 'GWN' | 'HAL' | 'HAM' | 'HAV' | 'HCK' | 'HEF' | 'HIL' | 'HLD' | 'HMF' | 'HNS' | 'HPL' | 'HRT' | 'HRW' | 'HRY' | 'IOS' | 'IOW' | 'ISL' | 'IVC' | 'KEC' | 'KHL' | 'KIR' | 'KTT' | 'KWL' | 'LBC' | 'LBH' | 'LCE' | 'LDS' | 'LEC' | 'LEW' | 'LIN' | 'LIV' | 'LND' | 'LUT' | 'MAN' | 'MDB' | 'MDW' | 'MEA' | 'MIK' | 'MLN' | 'MON' | 'MRT' | 'MRY' | 'MTY' | 'MUL' | 'NBL' | 'NEL' | 'NET' | 'NFK' | 'NGM' | 'NIR' | 'NLK' | 'NLN' | 'NMD' | 'NNH' | 'NSM' | 'NTL' | 'NTT' | 'NTY' | 'NWM' | 'NWP' | 'NYK' | 'OLD' | 'ORK' | 'OXF' | 'PEM' | 'PKN' | 'PLY' | 'POR' | 'POW' | 'PTE' | 'RCC' | 'RCH' | 'RCT' | 'RDB' | 'RDG' | 'RFW' | 'RIC' | 'ROT' | 'RUT' | 'SAW' | 'SAY' | 'SCB' | 'SCT' | 'SFK' | 'SFT' | 'SGC' | 'SHF' | 'SHN' | 'SKP' | 'SLF' | 'SLG' | 'SLK' | 'SND' | 'SOL' | 'SOS' | 'SRY' | 'STE' | 'STG' | 'STH' | 'STN' | 'STS' | 'STT' | 'STY' | 'SWA' | 'SWD' | 'SWK' | 'TAM' | 'TFW' | 'THR' | 'TOB' | 'TOF' | 'TRF' | 'TWH' | 'UKM' | 'VGL' | 'WBK' | 'WDU' | 'WFT' | 'WGN' | 'WIL' | 'WKF' | 'WLL' | 'WLN' | 'WLS' | 'WLV' | 'WND' | 'WNH' | 'WNM' | 'WOK' | 'WOR' | 'WRL' | 'WRT' | 'WRX' | 'WSM' | 'WSX' | 'YOR' | 'ZET' | 'IM' | 'KA' | 'KK' | 'MM' | 'RL' | 'TB' | 'EP' | 'OT' | 'UE' | 'UW' | 'WN' | 'WP' | 'KU' | 'QE' | 'QT' | 'BF' | 'DB' | 'DL' | 'FA' | 'FO' | 'KD' | 'NZ' | 'YO' | 'BN' | 'OI' | 'QU' | 'DE' | 'EB' | 'PT' | 'UD' | 'UT' | 'FM' | 'LP' | 'OC' | 'OL' | 'SB' | 'ND' | 'FE' | 'GY' | 'HV' | 'JN' | 'KM' | 'KV' | 'NY' | 'PS' | 'VE' | 'VM' | 'ZE' | 'BT' | 'JA' | 'JB' | 'JI' | 'JK' | 'JT' | 'PP' | 'CW' | 'LD' | 'LH' | 'LK' | 'LM' | 'LS' | 'MH' | 'OY' | 'WD' | 'WH' | 'WW' | 'WX' | 'JM' | 'DH' | 'GJ' | 'HP' | 'JH' | 'MZ' | 'PY' | 'TN' | 'TR' | 'UP' | 'WB' | 'BG' | 'DA' | 'DQ' | 'QA' | '00' | 'AKN' | 'AKU' | 'ARN' | 'ASA' | 'BLA' | 'BOG' | 'DAB' | 'DAV' | 'EOM' | 'EYF' | 'FJD' | 'FJL' | 'FLA' | 'FLR' | 'GAR' | 'GOG' | 'GRN' | 'GRU' | 'GRY' | 'HAF' | 'HRG' | 'HRU' | 'HUG' | 'HUV' | 'HVA' | 'HVE' | 'ISA' | 'KJO' | 'MOS' | 'MYR' | 'RGE' | 'RGY' | 'RHH' | 'RKN' | 'RKV' | 'SBT' | 'SDN' | 'SDV' | 'SEL' | 'SFA' | 'SKF' | 'SKG' | 'SKO' | 'SNF' | 'SOG' | 'SSS' | 'STR' | 'SVG' | 'TAL' | 'THG' | 'TJO' | 'VEM' | 'VER' | 'VOP' | '75' | 'CZ' | 'FC' | 'FG' | 'FI' | 'ME' | 'PC' | 'PD' | 'PG' | 'PU' | 'PZ' | 'RA' | 'RE' | 'TP' | 'VR' | 'VT' | 'VV' | 'IR' | 'KH' | 'PH' | 'XE' | 'XI' | 'XS' | 'GG' | 'GK' | 'GP' | 'MR' | 'VL' | 'EC' | 'RD' | 'WI' | '002' | '007' | '011' | '016' | '022' | '026' | '033' | '041' | '047' | '052' | '054' | '056' | '058' | '059' | '062' | '067' | '068' | '073' | '077' | '087' | '088' | '089' | '091' | '094' | '097' | '099' | '102' | '106' | '111' | '112' | '113' | 'DGV' | 'JEL' | 'JUR' | 'LPX' | 'REZ' | 'RIX' | 'VEN' | 'DR' | 'GT' | 'JG' | 'KF' | 'MJ' | 'MQ' | 'NQ' | 'WS' | 'AGD' | 'AOU' | 'ASZ' | 'AZI' | 'BEM' | 'BER' | 'BES' | 'BOD' | 'BOM' | 'BRR' | 'CHI' | 'CHT' | 'DRI' | 'ERR' | 'ESI' | 'ESM' | 'FAH' | 'FES' | 'FIG' | 'FQH' | 'GUE' | 'GUF' | 'HAJ' | 'HAO' | 'HOC' | 'IFR' | 'INE' | 'JDI' | 'JRA' | 'KES' | 'KHE' | 'KHN' | 'LAA' | 'LAR' | 'MAR' | 'MDF' | 'MED' | 'MEK' | 'MID' | 'MOH' | 'NAD' | 'OUA' | 'OUJ' | 'OUZ' | 'RAB' | 'REH' | 'SAF' | 'SEF' | 'SET' | 'SIB' | 'SIF' | 'SIK' | 'SIL' | 'SKH' | 'TAF' | 'TAI' | 'TAO' | 'TAT' | 'TAZ' | 'TET' | 'TIN' | 'TIZ' | 'TNG' | 'TNT' | 'YUS' | 'ZAG' | 'JE' | 'BD' | 'ED' | 'FL' | 'IA' | 'UN' | 'ALK' | 'ALL' | 'AUR' | 'EBO' | 'ENI' | 'JAB' | 'JAL' | 'KIL' | 'KWA' | 'LAE' | 'LIB' | 'LIK' | 'MAJ' | 'MEJ' | 'MIL' | 'NMK' | 'NMU' | 'RON' | 'UJA' | 'UTI' | 'WTH' | 'WTJ' | '103' | '104' | '105' | '107' | '108' | '109' | '210' | '211' | '301' | '304' | '307' | '308' | '310' | '401' | '402' | '403' | '404' | '405' | '406' | '407' | '408' | '409' | '410' | '501' | '502' | '504' | '505' | '506' | '507' | '508' | '509' | '601' | '602' | '603' | '604' | '605' | '606' | '607' | '608' | '609' | '701' | '702' | '703' | '704' | '705' | '706' | '807' | '808' | '810' | '811' | '812' | '813' | '814' | '815' | '816' | '817' | 'BKO' | '037' | '039' | '043' | '046' | '049' | '051' | '053' | '057' | '061' | '063' | '064' | '069' | '071' | 'PW' | 'MLE' | 'RU' | 'BCN' | 'BCS' | 'CHH' | 'CHP' | 'CMX' | 'COA' | 'COL' | 'GRO' | 'HID' | 'MEX' | 'MIC' | 'MOR' | 'NLE' | 'OAX' | 'PUE' | 'QUE' | 'ROO' | 'SLP' | 'SON' | 'TAB' | 'TLA' | 'YUC' | 'ZAC' | 'MPM' | 'OD' | 'OH' | 'OS' | 'EK' | 'OG' | 'AW' | 'BQ1' | 'BQ2' | 'BQ3' | 'NH' | 'OV' | 'P1' | 'P2' | 'P3' | 'P4' | 'P5' | 'P6' | 'P7' | 'AUK' | 'BOP' | 'CAN' | 'CIT' | 'GIS' | 'HKB' | 'MBH' | 'MWT' | 'NSN' | 'OTA' | 'STL' | 'TKI' | 'WKO' | 'WTC' | 'WU' | 'ZU' | 'EM' | 'ANC' | 'APU' | 'ARE' | 'AYA' | 'CAJ' | 'HUC' | 'ICA' | 'JUN' | 'LAL' | 'LAM' | 'LIM' | 'LMA' | 'MDD' | 'MOQ' | 'PIU' | 'PUN' | 'TAC' | 'TUM' | 'CPK' | 'CPM' | 'EBR' | 'EHG' | 'EPW' | 'ESW' | 'GPK' | 'HLA' | 'JWK' | 'MBA' | 'MPL' | 'MRL' | 'NCD' | 'NIK' | 'NPP' | 'NSB' | 'SHM' | 'WHM' | 'WPD' | 'ABR' | 'AGN' | 'AKL' | 'ALB' | 'APA' | 'BOH' | 'BTG' | 'BTN' | 'BUK' | 'BUL' | 'CAG' | 'CAP' | 'CAT' | 'CAV' | 'CEB' | 'DAO' | 'DIN' | 'DVO' | 'EAS' | 'GUI' | 'IFU' | 'ILI' | 'ILN' | 'ILS' | 'LAS' | 'LEY' | 'LUN' | 'MAD' | 'MDC' | 'MDR' | 'MSC' | 'MSR' | 'NCO' | 'NEC' | 'NER' | 'NUE' | 'NUV' | 'PAM' | 'PLW' | 'RIZ' | 'ROM' | 'SCO' | 'SIG' | 'SLE' | 'SLU' | 'SUK' | 'SUN' | 'SUR' | 'TAW' | 'WSA' | 'ZAS' | 'ZMB' | 'ZSI' | 'KP' | 'BTH' | 'DEB' | 'GZA' | 'HBN' | 'JEM' | 'JEN' | 'JRH' | 'KYS' | 'NBS' | 'NGZ' | 'QQA' | 'RBH' | 'RFH' | 'SLT' | 'TBS' | 'TKM' | '004' | '010' | '100' | '150' | '212' | '218' | '222' | '224' | '226' | '227' | '228' | '350' | '370' | 'ASU' | 'US' | 'CJ' | 'CV' | 'HD' | 'IF' | 'IL' | 'TL' | 'TM' | 'VN' | 'VO' | 'ALT' | 'AMU' | 'ARK' | 'BEL' | 'CHU' | 'IRK' | 'IVA' | 'KAM' | 'KDA' | 'KEM' | 'KGD' | 'KGN' | 'KHA' | 'KHM' | 'KLU' | 'KRS' | 'KYA' | 'LEN' | 'LIP' | 'MOW' | 'MUR' | 'NEN' | 'NGR' | 'NIZ' | 'NVS' | 'OMS' | 'ORE' | 'ORL' | 'PER' | 'PNZ' | 'PRI' | 'PSK' | 'ROS' | 'RYA' | 'SMO' | 'SPE' | 'STA' | 'SVE' | 'TOM' | 'TUL' | 'TVE' | 'TYU' | 'ULY' | 'VGG' | 'VLA' | 'VOR' | 'YAN' | 'MK' | 'WE' | 'DS' | 'DW' | 'NR' | '001' | '003' | '005' | '006' | '008' | '009' | '012' | '013' | '014' | '017' | '018' | '019' | '021' | '023' | '024' | '027' | '028' | '029' | '031' | '032' | '034' | '036' | '038' | '044' | '045' | '048' | '066' | '072' | '074' | '075' | '078' | '079' | '081' | '082' | '083' | '084' | '085' | '086' | '090' | '092' | '093' | '095' | '096' | '098' | '110' | '114' | '115' | '116' | '117' | '118' | '119' | '120' | '121' | '122' | '123' | '124' | '125' | '126' | '127' | '128' | '129' | '131' | '132' | '133' | '134' | '135' | '136' | '137' | '138' | '139' | '140' | '143' | '144' | '146' | '148' | '149' | '151' | '152' | '153' | '154' | '155' | '156' | '157' | '158' | '159' | '160' | '161' | '162' | '163' | '164' | '165' | '166' | '167' | '168' | '169' | '170' | '172' | '173' | '174' | '175' | '176' | '177' | '178' | '179' | '180' | '181' | '182' | '183' | '185' | '186' | '187' | '188' | '189' | '190' | '192' | '193' | '194' | '195' | '196' | '197' | '199' | '200' | '213' | 'TC' | 'ZI' | 'FK' | 'JD' | 'WO' | 'EE' | 'EW' | 'UY' | 'DY' | 'ID' | 'EO' | '96' | 'OE' | 'ARI' | 'CHA' | 'CTT' | 'DMN' | 'MRC' | 'PED' | 'POS' | 'PRT' | 'PTF' | 'SFO' | 'SGE' | 'SIP' | 'SJL' | 'TUP' | 'FUN' | 'NIT' | 'NKF' | 'NKL' | 'NMA' | 'NMG' | 'NUI' | 'VAI' | 'CYI' | 'CYQ' | 'HSQ' | 'HSZ' | 'ILA' | 'KEE' | 'KHH' | 'KIN' | 'LIE' | 'MIA' | 'NWT' | 'PEN' | 'PIF' | 'TNN' | 'TPE' | 'TTT' | 'TXG' | 'YUN' | '215' | '216' | '217' | '219' | '220' | '221' | '223' | '225' | '229' | '230' | '231' | '232' | '233' | '234' | '235' | '236' | '237' | '302' | '306' | '309' | '318' | '319' | '320' | '328' | '329' | '330' | '331' | '332' | '333' | '334' | '335' | '336' | '337' | '414' | '415' | '416' | '417' | '418' | '419' | '420' | '428' | '429' | '433' | '434' | '435' | 'NJ' | 'OK' | 'TX' | 'UM' | 'WV' | 'WY' | 'FD' | 'FS' | 'RV' | 'TT' | 'QR' | 'TK' | 'XO' | 'MAP' | 'SEE' | 'TAE' | 'UV' | 'VF' | 'HJ' | 'KZN' | 'WC';
494
+ /**
495
+ * The zip or postal code
496
+ */
497
+ zipCode?: string;
498
+ }
499
+ }
500
+ }
501
+ export interface CustomerCreateParams {
502
+ /**
503
+ * The registered address of the customer
504
+ */
505
+ address?: CustomerCreateParams.Address;
506
+ /**
507
+ * Customer's date of birth in ISO 8601 datetime format. Example: '2025-09-05'.
508
+ * Reference: https://en.wikipedia.org/wiki/ISO_8601
509
+ */
510
+ dateOfBirth?: string;
511
+ /**
512
+ * The email address of the customer
513
+ */
514
+ email?: string;
515
+ /**
516
+ * The full name or business name of the customer
517
+ */
518
+ fullName?: string;
519
+ /**
520
+ * A collection of key-value pairs that can be associated with an object to store
521
+ * custom data in a structured manner. This allows you to attach arbitrary
522
+ * information to enhance the object with additional context or properties. To
523
+ * clear the metadata, send an empty object.
524
+ */
525
+ metadata?: {
526
+ [key: string]: unknown;
527
+ };
528
+ /**
529
+ * The phone number of the customer in international format (e.g., +491631234567)
530
+ */
531
+ phone?: string;
532
+ }
533
+ export declare namespace CustomerCreateParams {
534
+ /**
535
+ * The registered address of the customer
536
+ */
537
+ interface Address {
538
+ /**
539
+ * ISO 3166-1 alpha-2 country code (e.g. DE)
540
+ */
541
+ country: 'AF' | 'AL' | 'DZ' | 'AS' | 'AD' | 'AO' | 'AI' | 'AQ' | 'AG' | 'AR' | 'AM' | 'AW' | 'AU' | 'AT' | 'AZ' | 'BS' | 'BH' | 'BD' | 'BB' | 'BY' | 'BE' | 'BZ' | 'BJ' | 'BM' | 'BT' | 'BO' | 'BA' | 'BW' | 'BV' | 'BR' | 'IO' | 'BN' | 'BG' | 'BF' | 'BI' | 'KH' | 'CM' | 'CA' | 'CV' | 'KY' | 'CF' | 'TD' | 'CL' | 'CN' | 'CX' | 'CC' | 'CO' | 'KM' | 'CG' | 'CD' | 'CK' | 'CR' | 'CI' | 'HR' | 'CU' | 'CY' | 'CZ' | 'DK' | 'DJ' | 'DM' | 'DO' | 'EC' | 'EG' | 'SV' | 'GQ' | 'ER' | 'EE' | 'ET' | 'FK' | 'FO' | 'FJ' | 'FI' | 'FR' | 'GF' | 'PF' | 'TF' | 'GA' | 'GM' | 'GE' | 'DE' | 'GH' | 'GI' | 'GR' | 'GL' | 'GD' | 'GP' | 'GU' | 'GT' | 'GN' | 'GW' | 'GY' | 'HT' | 'HM' | 'VA' | 'HN' | 'HK' | 'HU' | 'IS' | 'IN' | 'ID' | 'IR' | 'IQ' | 'IE' | 'IL' | 'IT' | 'JM' | 'JP' | 'JO' | 'KZ' | 'KE' | 'KI' | 'KP' | 'KR' | 'KW' | 'KG' | 'LA' | 'LV' | 'LB' | 'LS' | 'LR' | 'LY' | 'LI' | 'LT' | 'LU' | 'MO' | 'MG' | 'MW' | 'MY' | 'MV' | 'ML' | 'MT' | 'MH' | 'MQ' | 'MR' | 'MU' | 'YT' | 'MX' | 'FM' | 'MD' | 'MC' | 'MN' | 'MS' | 'MA' | 'MZ' | 'MM' | 'NA' | 'NR' | 'NP' | 'NL' | 'NC' | 'NZ' | 'NI' | 'NE' | 'NG' | 'NU' | 'NF' | 'MP' | 'MK' | 'NO' | 'OM' | 'PK' | 'PW' | 'PS' | 'PA' | 'PG' | 'PY' | 'PE' | 'PH' | 'PN' | 'PL' | 'PT' | 'PR' | 'QA' | 'RE' | 'RO' | 'RU' | 'RW' | 'SH' | 'KN' | 'LC' | 'PM' | 'VC' | 'WS' | 'SM' | 'ST' | 'SA' | 'SN' | 'SC' | 'SL' | 'SG' | 'SK' | 'SI' | 'SB' | 'SO' | 'ZA' | 'GS' | 'ES' | 'LK' | 'SD' | 'SR' | 'SJ' | 'SZ' | 'SE' | 'CH' | 'SY' | 'TW' | 'TJ' | 'TZ' | 'TH' | 'TL' | 'TG' | 'TK' | 'TO' | 'TT' | 'TN' | 'TR' | 'TM' | 'TC' | 'TV' | 'UG' | 'UA' | 'AE' | 'GB' | 'US' | 'UM' | 'UY' | 'UZ' | 'VU' | 'VE' | 'VN' | 'VG' | 'VI' | 'WF' | 'EH' | 'YE' | 'ZM' | 'ZW' | 'AX' | 'BQ' | 'CW' | 'GG' | 'IM' | 'JE' | 'ME' | 'BL' | 'MF' | 'RS' | 'SX' | 'SS' | 'XK';
542
+ /**
543
+ * Full name of the city
544
+ */
545
+ city?: string;
546
+ /**
547
+ * Address line 1
548
+ */
549
+ line1?: string;
550
+ /**
551
+ * Address line 2
552
+ */
553
+ line2?: string;
554
+ /**
555
+ * The second part of the subdivision ISO 3166-2 country code (e.g. BE)
556
+ */
557
+ region?: '02' | '03' | '04' | '05' | '06' | '07' | '08' | 'AJ' | 'AZ' | 'DU' | 'FU' | 'RK' | 'SH' | 'UQ' | 'BAL' | 'BAM' | 'BDG' | 'BDS' | 'BGL' | 'DAY' | 'FRA' | 'FYB' | 'GHA' | 'GHO' | 'HEL' | 'HER' | 'JOW' | 'KAB' | 'KAN' | 'KAP' | 'KDZ' | 'KHO' | 'KNR' | 'LAG' | 'LOG' | 'NAN' | 'NIM' | 'NUR' | 'PAN' | 'PAR' | 'PIA' | 'PKA' | 'SAM' | 'SAR' | 'TAK' | 'URU' | 'WAR' | 'ZAB' | '10' | '11' | '01' | '09' | '12' | 'AG' | 'AR' | 'AV' | 'ER' | 'GR' | 'KT' | 'LO' | 'SU' | 'TV' | 'VD' | 'BGO' | 'BGU' | 'BIE' | 'CAB' | 'CCU' | 'CNN' | 'CNO' | 'CUS' | 'HUA' | 'HUI' | 'LNO' | 'LSU' | 'LUA' | 'MAL' | 'MOX' | 'NAM' | 'UIG' | 'ZAI' | 'A' | 'B' | 'C' | 'D' | 'E' | 'F' | 'G' | 'H' | 'J' | 'K' | 'L' | 'M' | 'N' | 'P' | 'Q' | 'R' | 'S' | 'T' | 'U' | 'V' | 'W' | 'X' | 'Y' | 'Z' | '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9' | 'ACT' | 'NSW' | 'NT' | 'QLD' | 'SA' | 'TAS' | 'VIC' | 'WA' | 'ABS' | 'AGA' | 'AGC' | 'AGM' | 'AGS' | 'AGU' | 'AST' | 'BA' | 'BAB' | 'BAR' | 'BEY' | 'BIL' | 'CAL' | 'CUL' | 'DAS' | 'FUZ' | 'GA' | 'GAD' | 'GOR' | 'GOY' | 'GYG' | 'HAC' | 'IMI' | 'ISM' | 'KAL' | 'KUR' | 'LA' | 'LAC' | 'LAN' | 'LER' | 'MAS' | 'MI' | 'NA' | 'NEF' | 'NV' | 'NX' | 'OGU' | 'ORD' | 'QAB' | 'QAX' | 'QAZ' | 'QBA' | 'QBI' | 'QOB' | 'QUS' | 'SAB' | 'SAD' | 'SAH' | 'SAK' | 'SAL' | 'SAT' | 'SBN' | 'SIY' | 'SKR' | 'SM' | 'SMI' | 'SMX' | 'SR' | 'SUS' | 'TAR' | 'TOV' | 'UCA' | 'XA' | 'XAC' | 'XCI' | 'XIZ' | 'XVD' | 'YAR' | 'YE' | 'YEV' | 'ZAN' | 'ZAQ' | 'ZAR' | 'BIH' | 'BRC' | 'SRP' | '13' | '14' | '15' | '16' | '17' | '18' | '19' | '20' | '21' | '22' | '23' | '24' | '25' | '26' | '27' | '28' | '29' | '30' | '31' | '32' | '33' | '34' | '35' | '36' | '37' | '38' | '39' | '40' | '41' | '42' | '43' | '44' | '45' | '46' | '47' | '48' | '49' | '50' | '51' | '52' | '53' | '54' | '55' | '56' | '57' | '58' | '59' | '60' | '61' | '62' | '63' | '64' | 'BRU' | 'VAN' | 'VBR' | 'VLG' | 'VLI' | 'VOV' | 'VWV' | 'WAL' | 'WBR' | 'WHT' | 'WLG' | 'WLX' | 'WNA' | 'BAN' | 'BAZ' | 'BGR' | 'BLG' | 'BLK' | 'COM' | 'GAN' | 'GNA' | 'GOU' | 'HOU' | 'IOB' | 'KAD' | 'KEN' | 'KMD' | 'KMP' | 'KOP' | 'KOS' | 'KOT' | 'KOW' | 'LOR' | 'MOU' | 'NAO' | 'NAY' | 'NOU' | 'OUB' | 'OUD' | 'PAS' | 'PON' | 'SEN' | 'SIS' | 'SMT' | 'SNG' | 'SOM' | 'SOR' | 'TAP' | 'TUI' | 'YAG' | 'YAT' | 'ZIR' | 'ZON' | 'ZOU' | 'BB' | 'BL' | 'BM' | 'BR' | 'CA' | 'CI' | 'GI' | 'KI' | 'KR' | 'KY' | 'MA' | 'MU' | 'MW' | 'MY' | 'NG' | 'RM' | 'RT' | 'RY' | 'AK' | 'AL' | 'AQ' | 'BO' | 'CO' | 'DO' | 'KO' | 'LI' | 'MO' | 'OU' | 'PL' | 'ZO' | 'BE' | 'TE' | 'TU' | 'O' | 'SE' | 'AC' | 'AM' | 'AP' | 'CE' | 'DF' | 'ES' | 'GO' | 'MG' | 'MS' | 'MT' | 'PA' | 'PB' | 'PE' | 'PI' | 'PR' | 'RJ' | 'RN' | 'RO' | 'RR' | 'RS' | 'SC' | 'SP' | 'TO' | 'BI' | 'BP' | 'BY' | 'CK' | 'CS' | 'EG' | 'EX' | 'FP' | 'GC' | 'HI' | 'HT' | 'IN' | 'MC' | 'NE' | 'NO' | 'NP' | 'NS' | 'RC' | 'RI' | 'SO' | 'SS' | 'SW' | 'WG' | 'TY' | 'CH' | 'FR' | 'GH' | 'JW' | 'KG' | 'KL' | 'KW' | 'NW' | 'ST' | 'HM' | 'HO' | 'HR' | 'VI' | 'BZ' | 'CY' | 'CZL' | 'OW' | 'TOL' | 'AB' | 'BC' | 'MB' | 'NB' | 'NL' | 'NU' | 'ON' | 'QC' | 'SK' | 'YT' | 'BU' | 'EQ' | 'HK' | 'HL' | 'HU' | 'IT' | 'KC' | 'KE' | 'KN' | 'KS' | 'LU' | 'MN' | 'NK' | 'TA' | 'BGF' | 'BK' | 'HS' | 'KB' | 'LB' | 'MP' | 'NM' | 'OP' | 'UK' | 'VK' | 'BZV' | 'AI' | 'BS' | 'GE' | 'GL' | 'JU' | 'SG' | 'SZ' | 'TG' | 'TI' | 'UR' | 'VS' | 'ZG' | 'ZH' | 'CM' | 'DN' | 'GD' | 'LC' | 'LG' | 'SV' | 'VB' | 'WR' | 'YM' | 'ZZ' | 'AN' | 'AT' | 'LL' | 'LR' | 'ML' | 'AD' | 'EN' | 'LT' | 'AH' | 'BJ' | 'CQ' | 'FJ' | 'GS' | 'GX' | 'GZ' | 'HA' | 'HB' | 'HE' | 'HN' | 'JL' | 'JS' | 'JX' | 'LN' | 'QH' | 'SD' | 'SN' | 'SX' | 'TJ' | 'TW' | 'XJ' | 'XZ' | 'YN' | 'ZJ' | 'AMA' | 'ANT' | 'ARA' | 'ATL' | 'BOL' | 'BOY' | 'CAQ' | 'CAS' | 'CAU' | 'CES' | 'CHO' | 'COR' | 'CUN' | 'DC' | 'GUA' | 'GUV' | 'MAG' | 'MET' | 'NAR' | 'NSA' | 'PUT' | 'QUI' | 'RIS' | 'SAN' | 'SAP' | 'SUC' | 'VAC' | 'VAU' | 'VID' | 'SJ' | '99' | 'BV' | 'CF' | 'CR' | 'PN' | 'RB' | 'RG' | 'SF' | 'SL' | 'TS' | '201' | '202' | '203' | '204' | '205' | '206' | '207' | '208' | '209' | '20A' | '20B' | '20C' | '311' | '312' | '313' | '314' | '315' | '316' | '317' | '321' | '322' | '323' | '324' | '325' | '326' | '327' | '411' | '412' | '413' | '421' | '422' | '423' | '424' | '425' | '426' | '427' | '511' | '512' | '513' | '514' | '521' | '522' | '523' | '524' | '525' | '531' | '532' | '533' | '534' | '631' | '632' | '633' | '634' | '635' | '641' | '642' | '643' | '644' | '645' | '646' | '647' | '71' | '711' | '712' | '713' | '714' | '715' | '72' | '721' | '722' | '723' | '724' | '80' | '801' | '802' | '803' | '804' | '805' | '806' | 'BW' | 'HH' | 'MV' | 'NI' | 'RP' | 'TH' | 'AS' | 'DI' | 'DJ' | 'OB' | '015' | '020' | '025' | '030' | '035' | '040' | '042' | '050' | '055' | '060' | '065' | '070' | '076' | '080' | '101' | '147' | '81' | '82' | '83' | '84' | '85' | 'I' | '130' | '141' | '142' | '171' | '184' | '191' | '198' | '214' | '245' | '247' | '251' | '255' | '272' | '283' | '284' | '291' | '293' | '296' | '303' | '305' | '338' | '353' | '430' | '431' | '432' | '441' | '442' | '446' | '478' | '480' | '486' | '503' | '528' | '557' | '567' | '586' | '615' | '618' | '622' | '624' | '638' | '651' | '653' | '661' | '663' | '668' | '68' | '689' | '698' | '708' | '719' | '726' | '732' | '735' | '74' | '784' | '79' | '792' | '793' | '796' | '809' | '824' | '834' | '855' | '87' | '890' | '897' | '899' | '901' | '903' | '907' | '917' | '919' | '928' | 'ALX' | 'ASN' | 'BH' | 'BNS' | 'DK' | 'DT' | 'FYM' | 'IS' | 'KFS' | 'LX' | 'MNF' | 'PTS' | 'SHG' | 'SHR' | 'SIN' | 'SUZ' | 'WAD' | 'GB' | 'CB' | 'CC' | 'CL' | 'CN' | 'CT' | 'CU' | 'GU' | 'IB' | 'LE' | 'MD' | 'NC' | 'OR' | 'PM' | 'PO' | 'PV' | 'TF' | 'VA' | 'VC' | 'ZA' | 'AA' | 'AF' | 'DD' | 'SI' | 'KSA' | 'PNI' | 'TRK' | 'YAP' | '20R' | '2A' | '2B' | '65' | '66' | '67' | '69' | '69M' | '6AE' | '70' | '73' | '75C' | '76' | '77' | '78' | '86' | '88' | '89' | '90' | '91' | '92' | '93' | '94' | '95' | '971' | '972' | '973' | '974' | '976' | 'BFC' | 'BRE' | 'CP' | 'CVL' | 'GES' | 'HDF' | 'IDF' | 'MF' | 'NAQ' | 'NOR' | 'OCC' | 'PAC' | 'PDL' | 'PF' | 'WF' | 'ABC' | 'ABD' | 'ABE' | 'AGB' | 'AGY' | 'AND' | 'ANN' | 'ANS' | 'BAS' | 'BBD' | 'BCP' | 'BDF' | 'BEN' | 'BEX' | 'BFS' | 'BGE' | 'BGW' | 'BIR' | 'BKM' | 'BNE' | 'BNH' | 'BPL' | 'BRD' | 'BRY' | 'BST' | 'BUR' | 'CAM' | 'CAY' | 'CBF' | 'CCG' | 'CGN' | 'CHE' | 'CHW' | 'CLD' | 'CLK' | 'CMA' | 'CMD' | 'CMN' | 'CON' | 'COV' | 'CRF' | 'CRY' | 'CWY' | 'DAL' | 'DBY' | 'DEN' | 'DER' | 'DEV' | 'DGY' | 'DNC' | 'DND' | 'DOR' | 'DRS' | 'DUD' | 'DUR' | 'EAL' | 'EAW' | 'EAY' | 'EDH' | 'EDU' | 'ELN' | 'ELS' | 'ENF' | 'ENG' | 'ERW' | 'ERY' | 'ESS' | 'ESX' | 'FAL' | 'FIF' | 'FLN' | 'FMO' | 'GAT' | 'GBN' | 'GLG' | 'GLS' | 'GRE' | 'GWN' | 'HAL' | 'HAM' | 'HAV' | 'HCK' | 'HEF' | 'HIL' | 'HLD' | 'HMF' | 'HNS' | 'HPL' | 'HRT' | 'HRW' | 'HRY' | 'IOS' | 'IOW' | 'ISL' | 'IVC' | 'KEC' | 'KHL' | 'KIR' | 'KTT' | 'KWL' | 'LBC' | 'LBH' | 'LCE' | 'LDS' | 'LEC' | 'LEW' | 'LIN' | 'LIV' | 'LND' | 'LUT' | 'MAN' | 'MDB' | 'MDW' | 'MEA' | 'MIK' | 'MLN' | 'MON' | 'MRT' | 'MRY' | 'MTY' | 'MUL' | 'NBL' | 'NEL' | 'NET' | 'NFK' | 'NGM' | 'NIR' | 'NLK' | 'NLN' | 'NMD' | 'NNH' | 'NSM' | 'NTL' | 'NTT' | 'NTY' | 'NWM' | 'NWP' | 'NYK' | 'OLD' | 'ORK' | 'OXF' | 'PEM' | 'PKN' | 'PLY' | 'POR' | 'POW' | 'PTE' | 'RCC' | 'RCH' | 'RCT' | 'RDB' | 'RDG' | 'RFW' | 'RIC' | 'ROT' | 'RUT' | 'SAW' | 'SAY' | 'SCB' | 'SCT' | 'SFK' | 'SFT' | 'SGC' | 'SHF' | 'SHN' | 'SKP' | 'SLF' | 'SLG' | 'SLK' | 'SND' | 'SOL' | 'SOS' | 'SRY' | 'STE' | 'STG' | 'STH' | 'STN' | 'STS' | 'STT' | 'STY' | 'SWA' | 'SWD' | 'SWK' | 'TAM' | 'TFW' | 'THR' | 'TOB' | 'TOF' | 'TRF' | 'TWH' | 'UKM' | 'VGL' | 'WBK' | 'WDU' | 'WFT' | 'WGN' | 'WIL' | 'WKF' | 'WLL' | 'WLN' | 'WLS' | 'WLV' | 'WND' | 'WNH' | 'WNM' | 'WOK' | 'WOR' | 'WRL' | 'WRT' | 'WRX' | 'WSM' | 'WSX' | 'YOR' | 'ZET' | 'IM' | 'KA' | 'KK' | 'MM' | 'RL' | 'TB' | 'EP' | 'OT' | 'UE' | 'UW' | 'WN' | 'WP' | 'KU' | 'QE' | 'QT' | 'BF' | 'DB' | 'DL' | 'FA' | 'FO' | 'KD' | 'NZ' | 'YO' | 'BN' | 'OI' | 'QU' | 'DE' | 'EB' | 'PT' | 'UD' | 'UT' | 'FM' | 'LP' | 'OC' | 'OL' | 'SB' | 'ND' | 'FE' | 'GY' | 'HV' | 'JN' | 'KM' | 'KV' | 'NY' | 'PS' | 'VE' | 'VM' | 'ZE' | 'BT' | 'JA' | 'JB' | 'JI' | 'JK' | 'JT' | 'PP' | 'CW' | 'LD' | 'LH' | 'LK' | 'LM' | 'LS' | 'MH' | 'OY' | 'WD' | 'WH' | 'WW' | 'WX' | 'JM' | 'DH' | 'GJ' | 'HP' | 'JH' | 'MZ' | 'PY' | 'TN' | 'TR' | 'UP' | 'WB' | 'BG' | 'DA' | 'DQ' | 'QA' | '00' | 'AKN' | 'AKU' | 'ARN' | 'ASA' | 'BLA' | 'BOG' | 'DAB' | 'DAV' | 'EOM' | 'EYF' | 'FJD' | 'FJL' | 'FLA' | 'FLR' | 'GAR' | 'GOG' | 'GRN' | 'GRU' | 'GRY' | 'HAF' | 'HRG' | 'HRU' | 'HUG' | 'HUV' | 'HVA' | 'HVE' | 'ISA' | 'KJO' | 'MOS' | 'MYR' | 'RGE' | 'RGY' | 'RHH' | 'RKN' | 'RKV' | 'SBT' | 'SDN' | 'SDV' | 'SEL' | 'SFA' | 'SKF' | 'SKG' | 'SKO' | 'SNF' | 'SOG' | 'SSS' | 'STR' | 'SVG' | 'TAL' | 'THG' | 'TJO' | 'VEM' | 'VER' | 'VOP' | '75' | 'CZ' | 'FC' | 'FG' | 'FI' | 'ME' | 'PC' | 'PD' | 'PG' | 'PU' | 'PZ' | 'RA' | 'RE' | 'TP' | 'VR' | 'VT' | 'VV' | 'IR' | 'KH' | 'PH' | 'XE' | 'XI' | 'XS' | 'GG' | 'GK' | 'GP' | 'MR' | 'VL' | 'EC' | 'RD' | 'WI' | '002' | '007' | '011' | '016' | '022' | '026' | '033' | '041' | '047' | '052' | '054' | '056' | '058' | '059' | '062' | '067' | '068' | '073' | '077' | '087' | '088' | '089' | '091' | '094' | '097' | '099' | '102' | '106' | '111' | '112' | '113' | 'DGV' | 'JEL' | 'JUR' | 'LPX' | 'REZ' | 'RIX' | 'VEN' | 'DR' | 'GT' | 'JG' | 'KF' | 'MJ' | 'MQ' | 'NQ' | 'WS' | 'AGD' | 'AOU' | 'ASZ' | 'AZI' | 'BEM' | 'BER' | 'BES' | 'BOD' | 'BOM' | 'BRR' | 'CHI' | 'CHT' | 'DRI' | 'ERR' | 'ESI' | 'ESM' | 'FAH' | 'FES' | 'FIG' | 'FQH' | 'GUE' | 'GUF' | 'HAJ' | 'HAO' | 'HOC' | 'IFR' | 'INE' | 'JDI' | 'JRA' | 'KES' | 'KHE' | 'KHN' | 'LAA' | 'LAR' | 'MAR' | 'MDF' | 'MED' | 'MEK' | 'MID' | 'MOH' | 'NAD' | 'OUA' | 'OUJ' | 'OUZ' | 'RAB' | 'REH' | 'SAF' | 'SEF' | 'SET' | 'SIB' | 'SIF' | 'SIK' | 'SIL' | 'SKH' | 'TAF' | 'TAI' | 'TAO' | 'TAT' | 'TAZ' | 'TET' | 'TIN' | 'TIZ' | 'TNG' | 'TNT' | 'YUS' | 'ZAG' | 'JE' | 'BD' | 'ED' | 'FL' | 'IA' | 'UN' | 'ALK' | 'ALL' | 'AUR' | 'EBO' | 'ENI' | 'JAB' | 'JAL' | 'KIL' | 'KWA' | 'LAE' | 'LIB' | 'LIK' | 'MAJ' | 'MEJ' | 'MIL' | 'NMK' | 'NMU' | 'RON' | 'UJA' | 'UTI' | 'WTH' | 'WTJ' | '103' | '104' | '105' | '107' | '108' | '109' | '210' | '211' | '301' | '304' | '307' | '308' | '310' | '401' | '402' | '403' | '404' | '405' | '406' | '407' | '408' | '409' | '410' | '501' | '502' | '504' | '505' | '506' | '507' | '508' | '509' | '601' | '602' | '603' | '604' | '605' | '606' | '607' | '608' | '609' | '701' | '702' | '703' | '704' | '705' | '706' | '807' | '808' | '810' | '811' | '812' | '813' | '814' | '815' | '816' | '817' | 'BKO' | '037' | '039' | '043' | '046' | '049' | '051' | '053' | '057' | '061' | '063' | '064' | '069' | '071' | 'PW' | 'MLE' | 'RU' | 'BCN' | 'BCS' | 'CHH' | 'CHP' | 'CMX' | 'COA' | 'COL' | 'GRO' | 'HID' | 'MEX' | 'MIC' | 'MOR' | 'NLE' | 'OAX' | 'PUE' | 'QUE' | 'ROO' | 'SLP' | 'SON' | 'TAB' | 'TLA' | 'YUC' | 'ZAC' | 'MPM' | 'OD' | 'OH' | 'OS' | 'EK' | 'OG' | 'AW' | 'BQ1' | 'BQ2' | 'BQ3' | 'NH' | 'OV' | 'P1' | 'P2' | 'P3' | 'P4' | 'P5' | 'P6' | 'P7' | 'AUK' | 'BOP' | 'CAN' | 'CIT' | 'GIS' | 'HKB' | 'MBH' | 'MWT' | 'NSN' | 'OTA' | 'STL' | 'TKI' | 'WKO' | 'WTC' | 'WU' | 'ZU' | 'EM' | 'ANC' | 'APU' | 'ARE' | 'AYA' | 'CAJ' | 'HUC' | 'ICA' | 'JUN' | 'LAL' | 'LAM' | 'LIM' | 'LMA' | 'MDD' | 'MOQ' | 'PIU' | 'PUN' | 'TAC' | 'TUM' | 'CPK' | 'CPM' | 'EBR' | 'EHG' | 'EPW' | 'ESW' | 'GPK' | 'HLA' | 'JWK' | 'MBA' | 'MPL' | 'MRL' | 'NCD' | 'NIK' | 'NPP' | 'NSB' | 'SHM' | 'WHM' | 'WPD' | 'ABR' | 'AGN' | 'AKL' | 'ALB' | 'APA' | 'BOH' | 'BTG' | 'BTN' | 'BUK' | 'BUL' | 'CAG' | 'CAP' | 'CAT' | 'CAV' | 'CEB' | 'DAO' | 'DIN' | 'DVO' | 'EAS' | 'GUI' | 'IFU' | 'ILI' | 'ILN' | 'ILS' | 'LAS' | 'LEY' | 'LUN' | 'MAD' | 'MDC' | 'MDR' | 'MSC' | 'MSR' | 'NCO' | 'NEC' | 'NER' | 'NUE' | 'NUV' | 'PAM' | 'PLW' | 'RIZ' | 'ROM' | 'SCO' | 'SIG' | 'SLE' | 'SLU' | 'SUK' | 'SUN' | 'SUR' | 'TAW' | 'WSA' | 'ZAS' | 'ZMB' | 'ZSI' | 'KP' | 'BTH' | 'DEB' | 'GZA' | 'HBN' | 'JEM' | 'JEN' | 'JRH' | 'KYS' | 'NBS' | 'NGZ' | 'QQA' | 'RBH' | 'RFH' | 'SLT' | 'TBS' | 'TKM' | '004' | '010' | '100' | '150' | '212' | '218' | '222' | '224' | '226' | '227' | '228' | '350' | '370' | 'ASU' | 'US' | 'CJ' | 'CV' | 'HD' | 'IF' | 'IL' | 'TL' | 'TM' | 'VN' | 'VO' | 'ALT' | 'AMU' | 'ARK' | 'BEL' | 'CHU' | 'IRK' | 'IVA' | 'KAM' | 'KDA' | 'KEM' | 'KGD' | 'KGN' | 'KHA' | 'KHM' | 'KLU' | 'KRS' | 'KYA' | 'LEN' | 'LIP' | 'MOW' | 'MUR' | 'NEN' | 'NGR' | 'NIZ' | 'NVS' | 'OMS' | 'ORE' | 'ORL' | 'PER' | 'PNZ' | 'PRI' | 'PSK' | 'ROS' | 'RYA' | 'SMO' | 'SPE' | 'STA' | 'SVE' | 'TOM' | 'TUL' | 'TVE' | 'TYU' | 'ULY' | 'VGG' | 'VLA' | 'VOR' | 'YAN' | 'MK' | 'WE' | 'DS' | 'DW' | 'NR' | '001' | '003' | '005' | '006' | '008' | '009' | '012' | '013' | '014' | '017' | '018' | '019' | '021' | '023' | '024' | '027' | '028' | '029' | '031' | '032' | '034' | '036' | '038' | '044' | '045' | '048' | '066' | '072' | '074' | '075' | '078' | '079' | '081' | '082' | '083' | '084' | '085' | '086' | '090' | '092' | '093' | '095' | '096' | '098' | '110' | '114' | '115' | '116' | '117' | '118' | '119' | '120' | '121' | '122' | '123' | '124' | '125' | '126' | '127' | '128' | '129' | '131' | '132' | '133' | '134' | '135' | '136' | '137' | '138' | '139' | '140' | '143' | '144' | '146' | '148' | '149' | '151' | '152' | '153' | '154' | '155' | '156' | '157' | '158' | '159' | '160' | '161' | '162' | '163' | '164' | '165' | '166' | '167' | '168' | '169' | '170' | '172' | '173' | '174' | '175' | '176' | '177' | '178' | '179' | '180' | '181' | '182' | '183' | '185' | '186' | '187' | '188' | '189' | '190' | '192' | '193' | '194' | '195' | '196' | '197' | '199' | '200' | '213' | 'TC' | 'ZI' | 'FK' | 'JD' | 'WO' | 'EE' | 'EW' | 'UY' | 'DY' | 'ID' | 'EO' | '96' | 'OE' | 'ARI' | 'CHA' | 'CTT' | 'DMN' | 'MRC' | 'PED' | 'POS' | 'PRT' | 'PTF' | 'SFO' | 'SGE' | 'SIP' | 'SJL' | 'TUP' | 'FUN' | 'NIT' | 'NKF' | 'NKL' | 'NMA' | 'NMG' | 'NUI' | 'VAI' | 'CYI' | 'CYQ' | 'HSQ' | 'HSZ' | 'ILA' | 'KEE' | 'KHH' | 'KIN' | 'LIE' | 'MIA' | 'NWT' | 'PEN' | 'PIF' | 'TNN' | 'TPE' | 'TTT' | 'TXG' | 'YUN' | '215' | '216' | '217' | '219' | '220' | '221' | '223' | '225' | '229' | '230' | '231' | '232' | '233' | '234' | '235' | '236' | '237' | '302' | '306' | '309' | '318' | '319' | '320' | '328' | '329' | '330' | '331' | '332' | '333' | '334' | '335' | '336' | '337' | '414' | '415' | '416' | '417' | '418' | '419' | '420' | '428' | '429' | '433' | '434' | '435' | 'NJ' | 'OK' | 'TX' | 'UM' | 'WV' | 'WY' | 'FD' | 'FS' | 'RV' | 'TT' | 'QR' | 'TK' | 'XO' | 'MAP' | 'SEE' | 'TAE' | 'UV' | 'VF' | 'HJ' | 'KZN' | 'WC';
558
+ /**
559
+ * The zip or postal code
560
+ */
561
+ zipCode?: string;
562
+ }
563
+ }
564
+ export interface CustomerRetrieveParams {
565
+ /**
566
+ * The id of the customer
567
+ */
568
+ id: string;
569
+ }
570
+ export interface CustomerUpdateParams {
571
+ /**
572
+ * The id of the customer
573
+ */
574
+ id: string;
575
+ /**
576
+ * The registered address of the customer. To update an existing address, you must
577
+ * provide all fields that are present in the existing address. Partial updates
578
+ * will be ignored.
579
+ */
580
+ address?: CustomerUpdateParams.Address | null;
581
+ /**
582
+ * Customer's date of birth in ISO 8601 datetime format. Example: '2025-09-05'.
583
+ * Reference: https://en.wikipedia.org/wiki/ISO_8601
584
+ */
585
+ dateOfBirth?: string | null;
586
+ /**
587
+ * The email address of the customer
588
+ */
589
+ email?: string | null;
590
+ /**
591
+ * The full name or business name of the customer
592
+ */
593
+ fullName?: string | null;
594
+ /**
595
+ * A collection of key-value pairs that can be associated with an object to store
596
+ * custom data in a structured manner. This allows you to attach arbitrary
597
+ * information to enhance the object with additional context or properties. To
598
+ * clear the metadata, send an empty object.
599
+ */
600
+ metadata?: {
601
+ [key: string]: unknown;
602
+ };
603
+ /**
604
+ * The phone number of the customer in international format (e.g., +491631234567)
605
+ */
606
+ phone?: string | null;
607
+ }
608
+ export declare namespace CustomerUpdateParams {
609
+ /**
610
+ * The registered address of the customer. To update an existing address, you must
611
+ * provide all fields that are present in the existing address. Partial updates
612
+ * will be ignored.
613
+ */
614
+ interface Address {
615
+ /**
616
+ * ISO 3166-1 alpha-2 country code (e.g. DE)
617
+ */
618
+ country: 'AF' | 'AL' | 'DZ' | 'AS' | 'AD' | 'AO' | 'AI' | 'AQ' | 'AG' | 'AR' | 'AM' | 'AW' | 'AU' | 'AT' | 'AZ' | 'BS' | 'BH' | 'BD' | 'BB' | 'BY' | 'BE' | 'BZ' | 'BJ' | 'BM' | 'BT' | 'BO' | 'BA' | 'BW' | 'BV' | 'BR' | 'IO' | 'BN' | 'BG' | 'BF' | 'BI' | 'KH' | 'CM' | 'CA' | 'CV' | 'KY' | 'CF' | 'TD' | 'CL' | 'CN' | 'CX' | 'CC' | 'CO' | 'KM' | 'CG' | 'CD' | 'CK' | 'CR' | 'CI' | 'HR' | 'CU' | 'CY' | 'CZ' | 'DK' | 'DJ' | 'DM' | 'DO' | 'EC' | 'EG' | 'SV' | 'GQ' | 'ER' | 'EE' | 'ET' | 'FK' | 'FO' | 'FJ' | 'FI' | 'FR' | 'GF' | 'PF' | 'TF' | 'GA' | 'GM' | 'GE' | 'DE' | 'GH' | 'GI' | 'GR' | 'GL' | 'GD' | 'GP' | 'GU' | 'GT' | 'GN' | 'GW' | 'GY' | 'HT' | 'HM' | 'VA' | 'HN' | 'HK' | 'HU' | 'IS' | 'IN' | 'ID' | 'IR' | 'IQ' | 'IE' | 'IL' | 'IT' | 'JM' | 'JP' | 'JO' | 'KZ' | 'KE' | 'KI' | 'KP' | 'KR' | 'KW' | 'KG' | 'LA' | 'LV' | 'LB' | 'LS' | 'LR' | 'LY' | 'LI' | 'LT' | 'LU' | 'MO' | 'MG' | 'MW' | 'MY' | 'MV' | 'ML' | 'MT' | 'MH' | 'MQ' | 'MR' | 'MU' | 'YT' | 'MX' | 'FM' | 'MD' | 'MC' | 'MN' | 'MS' | 'MA' | 'MZ' | 'MM' | 'NA' | 'NR' | 'NP' | 'NL' | 'NC' | 'NZ' | 'NI' | 'NE' | 'NG' | 'NU' | 'NF' | 'MP' | 'MK' | 'NO' | 'OM' | 'PK' | 'PW' | 'PS' | 'PA' | 'PG' | 'PY' | 'PE' | 'PH' | 'PN' | 'PL' | 'PT' | 'PR' | 'QA' | 'RE' | 'RO' | 'RU' | 'RW' | 'SH' | 'KN' | 'LC' | 'PM' | 'VC' | 'WS' | 'SM' | 'ST' | 'SA' | 'SN' | 'SC' | 'SL' | 'SG' | 'SK' | 'SI' | 'SB' | 'SO' | 'ZA' | 'GS' | 'ES' | 'LK' | 'SD' | 'SR' | 'SJ' | 'SZ' | 'SE' | 'CH' | 'SY' | 'TW' | 'TJ' | 'TZ' | 'TH' | 'TL' | 'TG' | 'TK' | 'TO' | 'TT' | 'TN' | 'TR' | 'TM' | 'TC' | 'TV' | 'UG' | 'UA' | 'AE' | 'GB' | 'US' | 'UM' | 'UY' | 'UZ' | 'VU' | 'VE' | 'VN' | 'VG' | 'VI' | 'WF' | 'EH' | 'YE' | 'ZM' | 'ZW' | 'AX' | 'BQ' | 'CW' | 'GG' | 'IM' | 'JE' | 'ME' | 'BL' | 'MF' | 'RS' | 'SX' | 'SS' | 'XK';
619
+ /**
620
+ * Full name of the city
621
+ */
622
+ city?: string;
623
+ /**
624
+ * Address line 1
625
+ */
626
+ line1?: string;
627
+ /**
628
+ * Address line 2
629
+ */
630
+ line2?: string;
631
+ /**
632
+ * The second part of the subdivision ISO 3166-2 country code (e.g. BE)
633
+ */
634
+ region?: '02' | '03' | '04' | '05' | '06' | '07' | '08' | 'AJ' | 'AZ' | 'DU' | 'FU' | 'RK' | 'SH' | 'UQ' | 'BAL' | 'BAM' | 'BDG' | 'BDS' | 'BGL' | 'DAY' | 'FRA' | 'FYB' | 'GHA' | 'GHO' | 'HEL' | 'HER' | 'JOW' | 'KAB' | 'KAN' | 'KAP' | 'KDZ' | 'KHO' | 'KNR' | 'LAG' | 'LOG' | 'NAN' | 'NIM' | 'NUR' | 'PAN' | 'PAR' | 'PIA' | 'PKA' | 'SAM' | 'SAR' | 'TAK' | 'URU' | 'WAR' | 'ZAB' | '10' | '11' | '01' | '09' | '12' | 'AG' | 'AR' | 'AV' | 'ER' | 'GR' | 'KT' | 'LO' | 'SU' | 'TV' | 'VD' | 'BGO' | 'BGU' | 'BIE' | 'CAB' | 'CCU' | 'CNN' | 'CNO' | 'CUS' | 'HUA' | 'HUI' | 'LNO' | 'LSU' | 'LUA' | 'MAL' | 'MOX' | 'NAM' | 'UIG' | 'ZAI' | 'A' | 'B' | 'C' | 'D' | 'E' | 'F' | 'G' | 'H' | 'J' | 'K' | 'L' | 'M' | 'N' | 'P' | 'Q' | 'R' | 'S' | 'T' | 'U' | 'V' | 'W' | 'X' | 'Y' | 'Z' | '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9' | 'ACT' | 'NSW' | 'NT' | 'QLD' | 'SA' | 'TAS' | 'VIC' | 'WA' | 'ABS' | 'AGA' | 'AGC' | 'AGM' | 'AGS' | 'AGU' | 'AST' | 'BA' | 'BAB' | 'BAR' | 'BEY' | 'BIL' | 'CAL' | 'CUL' | 'DAS' | 'FUZ' | 'GA' | 'GAD' | 'GOR' | 'GOY' | 'GYG' | 'HAC' | 'IMI' | 'ISM' | 'KAL' | 'KUR' | 'LA' | 'LAC' | 'LAN' | 'LER' | 'MAS' | 'MI' | 'NA' | 'NEF' | 'NV' | 'NX' | 'OGU' | 'ORD' | 'QAB' | 'QAX' | 'QAZ' | 'QBA' | 'QBI' | 'QOB' | 'QUS' | 'SAB' | 'SAD' | 'SAH' | 'SAK' | 'SAL' | 'SAT' | 'SBN' | 'SIY' | 'SKR' | 'SM' | 'SMI' | 'SMX' | 'SR' | 'SUS' | 'TAR' | 'TOV' | 'UCA' | 'XA' | 'XAC' | 'XCI' | 'XIZ' | 'XVD' | 'YAR' | 'YE' | 'YEV' | 'ZAN' | 'ZAQ' | 'ZAR' | 'BIH' | 'BRC' | 'SRP' | '13' | '14' | '15' | '16' | '17' | '18' | '19' | '20' | '21' | '22' | '23' | '24' | '25' | '26' | '27' | '28' | '29' | '30' | '31' | '32' | '33' | '34' | '35' | '36' | '37' | '38' | '39' | '40' | '41' | '42' | '43' | '44' | '45' | '46' | '47' | '48' | '49' | '50' | '51' | '52' | '53' | '54' | '55' | '56' | '57' | '58' | '59' | '60' | '61' | '62' | '63' | '64' | 'BRU' | 'VAN' | 'VBR' | 'VLG' | 'VLI' | 'VOV' | 'VWV' | 'WAL' | 'WBR' | 'WHT' | 'WLG' | 'WLX' | 'WNA' | 'BAN' | 'BAZ' | 'BGR' | 'BLG' | 'BLK' | 'COM' | 'GAN' | 'GNA' | 'GOU' | 'HOU' | 'IOB' | 'KAD' | 'KEN' | 'KMD' | 'KMP' | 'KOP' | 'KOS' | 'KOT' | 'KOW' | 'LOR' | 'MOU' | 'NAO' | 'NAY' | 'NOU' | 'OUB' | 'OUD' | 'PAS' | 'PON' | 'SEN' | 'SIS' | 'SMT' | 'SNG' | 'SOM' | 'SOR' | 'TAP' | 'TUI' | 'YAG' | 'YAT' | 'ZIR' | 'ZON' | 'ZOU' | 'BB' | 'BL' | 'BM' | 'BR' | 'CA' | 'CI' | 'GI' | 'KI' | 'KR' | 'KY' | 'MA' | 'MU' | 'MW' | 'MY' | 'NG' | 'RM' | 'RT' | 'RY' | 'AK' | 'AL' | 'AQ' | 'BO' | 'CO' | 'DO' | 'KO' | 'LI' | 'MO' | 'OU' | 'PL' | 'ZO' | 'BE' | 'TE' | 'TU' | 'O' | 'SE' | 'AC' | 'AM' | 'AP' | 'CE' | 'DF' | 'ES' | 'GO' | 'MG' | 'MS' | 'MT' | 'PA' | 'PB' | 'PE' | 'PI' | 'PR' | 'RJ' | 'RN' | 'RO' | 'RR' | 'RS' | 'SC' | 'SP' | 'TO' | 'BI' | 'BP' | 'BY' | 'CK' | 'CS' | 'EG' | 'EX' | 'FP' | 'GC' | 'HI' | 'HT' | 'IN' | 'MC' | 'NE' | 'NO' | 'NP' | 'NS' | 'RC' | 'RI' | 'SO' | 'SS' | 'SW' | 'WG' | 'TY' | 'CH' | 'FR' | 'GH' | 'JW' | 'KG' | 'KL' | 'KW' | 'NW' | 'ST' | 'HM' | 'HO' | 'HR' | 'VI' | 'BZ' | 'CY' | 'CZL' | 'OW' | 'TOL' | 'AB' | 'BC' | 'MB' | 'NB' | 'NL' | 'NU' | 'ON' | 'QC' | 'SK' | 'YT' | 'BU' | 'EQ' | 'HK' | 'HL' | 'HU' | 'IT' | 'KC' | 'KE' | 'KN' | 'KS' | 'LU' | 'MN' | 'NK' | 'TA' | 'BGF' | 'BK' | 'HS' | 'KB' | 'LB' | 'MP' | 'NM' | 'OP' | 'UK' | 'VK' | 'BZV' | 'AI' | 'BS' | 'GE' | 'GL' | 'JU' | 'SG' | 'SZ' | 'TG' | 'TI' | 'UR' | 'VS' | 'ZG' | 'ZH' | 'CM' | 'DN' | 'GD' | 'LC' | 'LG' | 'SV' | 'VB' | 'WR' | 'YM' | 'ZZ' | 'AN' | 'AT' | 'LL' | 'LR' | 'ML' | 'AD' | 'EN' | 'LT' | 'AH' | 'BJ' | 'CQ' | 'FJ' | 'GS' | 'GX' | 'GZ' | 'HA' | 'HB' | 'HE' | 'HN' | 'JL' | 'JS' | 'JX' | 'LN' | 'QH' | 'SD' | 'SN' | 'SX' | 'TJ' | 'TW' | 'XJ' | 'XZ' | 'YN' | 'ZJ' | 'AMA' | 'ANT' | 'ARA' | 'ATL' | 'BOL' | 'BOY' | 'CAQ' | 'CAS' | 'CAU' | 'CES' | 'CHO' | 'COR' | 'CUN' | 'DC' | 'GUA' | 'GUV' | 'MAG' | 'MET' | 'NAR' | 'NSA' | 'PUT' | 'QUI' | 'RIS' | 'SAN' | 'SAP' | 'SUC' | 'VAC' | 'VAU' | 'VID' | 'SJ' | '99' | 'BV' | 'CF' | 'CR' | 'PN' | 'RB' | 'RG' | 'SF' | 'SL' | 'TS' | '201' | '202' | '203' | '204' | '205' | '206' | '207' | '208' | '209' | '20A' | '20B' | '20C' | '311' | '312' | '313' | '314' | '315' | '316' | '317' | '321' | '322' | '323' | '324' | '325' | '326' | '327' | '411' | '412' | '413' | '421' | '422' | '423' | '424' | '425' | '426' | '427' | '511' | '512' | '513' | '514' | '521' | '522' | '523' | '524' | '525' | '531' | '532' | '533' | '534' | '631' | '632' | '633' | '634' | '635' | '641' | '642' | '643' | '644' | '645' | '646' | '647' | '71' | '711' | '712' | '713' | '714' | '715' | '72' | '721' | '722' | '723' | '724' | '80' | '801' | '802' | '803' | '804' | '805' | '806' | 'BW' | 'HH' | 'MV' | 'NI' | 'RP' | 'TH' | 'AS' | 'DI' | 'DJ' | 'OB' | '015' | '020' | '025' | '030' | '035' | '040' | '042' | '050' | '055' | '060' | '065' | '070' | '076' | '080' | '101' | '147' | '81' | '82' | '83' | '84' | '85' | 'I' | '130' | '141' | '142' | '171' | '184' | '191' | '198' | '214' | '245' | '247' | '251' | '255' | '272' | '283' | '284' | '291' | '293' | '296' | '303' | '305' | '338' | '353' | '430' | '431' | '432' | '441' | '442' | '446' | '478' | '480' | '486' | '503' | '528' | '557' | '567' | '586' | '615' | '618' | '622' | '624' | '638' | '651' | '653' | '661' | '663' | '668' | '68' | '689' | '698' | '708' | '719' | '726' | '732' | '735' | '74' | '784' | '79' | '792' | '793' | '796' | '809' | '824' | '834' | '855' | '87' | '890' | '897' | '899' | '901' | '903' | '907' | '917' | '919' | '928' | 'ALX' | 'ASN' | 'BH' | 'BNS' | 'DK' | 'DT' | 'FYM' | 'IS' | 'KFS' | 'LX' | 'MNF' | 'PTS' | 'SHG' | 'SHR' | 'SIN' | 'SUZ' | 'WAD' | 'GB' | 'CB' | 'CC' | 'CL' | 'CN' | 'CT' | 'CU' | 'GU' | 'IB' | 'LE' | 'MD' | 'NC' | 'OR' | 'PM' | 'PO' | 'PV' | 'TF' | 'VA' | 'VC' | 'ZA' | 'AA' | 'AF' | 'DD' | 'SI' | 'KSA' | 'PNI' | 'TRK' | 'YAP' | '20R' | '2A' | '2B' | '65' | '66' | '67' | '69' | '69M' | '6AE' | '70' | '73' | '75C' | '76' | '77' | '78' | '86' | '88' | '89' | '90' | '91' | '92' | '93' | '94' | '95' | '971' | '972' | '973' | '974' | '976' | 'BFC' | 'BRE' | 'CP' | 'CVL' | 'GES' | 'HDF' | 'IDF' | 'MF' | 'NAQ' | 'NOR' | 'OCC' | 'PAC' | 'PDL' | 'PF' | 'WF' | 'ABC' | 'ABD' | 'ABE' | 'AGB' | 'AGY' | 'AND' | 'ANN' | 'ANS' | 'BAS' | 'BBD' | 'BCP' | 'BDF' | 'BEN' | 'BEX' | 'BFS' | 'BGE' | 'BGW' | 'BIR' | 'BKM' | 'BNE' | 'BNH' | 'BPL' | 'BRD' | 'BRY' | 'BST' | 'BUR' | 'CAM' | 'CAY' | 'CBF' | 'CCG' | 'CGN' | 'CHE' | 'CHW' | 'CLD' | 'CLK' | 'CMA' | 'CMD' | 'CMN' | 'CON' | 'COV' | 'CRF' | 'CRY' | 'CWY' | 'DAL' | 'DBY' | 'DEN' | 'DER' | 'DEV' | 'DGY' | 'DNC' | 'DND' | 'DOR' | 'DRS' | 'DUD' | 'DUR' | 'EAL' | 'EAW' | 'EAY' | 'EDH' | 'EDU' | 'ELN' | 'ELS' | 'ENF' | 'ENG' | 'ERW' | 'ERY' | 'ESS' | 'ESX' | 'FAL' | 'FIF' | 'FLN' | 'FMO' | 'GAT' | 'GBN' | 'GLG' | 'GLS' | 'GRE' | 'GWN' | 'HAL' | 'HAM' | 'HAV' | 'HCK' | 'HEF' | 'HIL' | 'HLD' | 'HMF' | 'HNS' | 'HPL' | 'HRT' | 'HRW' | 'HRY' | 'IOS' | 'IOW' | 'ISL' | 'IVC' | 'KEC' | 'KHL' | 'KIR' | 'KTT' | 'KWL' | 'LBC' | 'LBH' | 'LCE' | 'LDS' | 'LEC' | 'LEW' | 'LIN' | 'LIV' | 'LND' | 'LUT' | 'MAN' | 'MDB' | 'MDW' | 'MEA' | 'MIK' | 'MLN' | 'MON' | 'MRT' | 'MRY' | 'MTY' | 'MUL' | 'NBL' | 'NEL' | 'NET' | 'NFK' | 'NGM' | 'NIR' | 'NLK' | 'NLN' | 'NMD' | 'NNH' | 'NSM' | 'NTL' | 'NTT' | 'NTY' | 'NWM' | 'NWP' | 'NYK' | 'OLD' | 'ORK' | 'OXF' | 'PEM' | 'PKN' | 'PLY' | 'POR' | 'POW' | 'PTE' | 'RCC' | 'RCH' | 'RCT' | 'RDB' | 'RDG' | 'RFW' | 'RIC' | 'ROT' | 'RUT' | 'SAW' | 'SAY' | 'SCB' | 'SCT' | 'SFK' | 'SFT' | 'SGC' | 'SHF' | 'SHN' | 'SKP' | 'SLF' | 'SLG' | 'SLK' | 'SND' | 'SOL' | 'SOS' | 'SRY' | 'STE' | 'STG' | 'STH' | 'STN' | 'STS' | 'STT' | 'STY' | 'SWA' | 'SWD' | 'SWK' | 'TAM' | 'TFW' | 'THR' | 'TOB' | 'TOF' | 'TRF' | 'TWH' | 'UKM' | 'VGL' | 'WBK' | 'WDU' | 'WFT' | 'WGN' | 'WIL' | 'WKF' | 'WLL' | 'WLN' | 'WLS' | 'WLV' | 'WND' | 'WNH' | 'WNM' | 'WOK' | 'WOR' | 'WRL' | 'WRT' | 'WRX' | 'WSM' | 'WSX' | 'YOR' | 'ZET' | 'IM' | 'KA' | 'KK' | 'MM' | 'RL' | 'TB' | 'EP' | 'OT' | 'UE' | 'UW' | 'WN' | 'WP' | 'KU' | 'QE' | 'QT' | 'BF' | 'DB' | 'DL' | 'FA' | 'FO' | 'KD' | 'NZ' | 'YO' | 'BN' | 'OI' | 'QU' | 'DE' | 'EB' | 'PT' | 'UD' | 'UT' | 'FM' | 'LP' | 'OC' | 'OL' | 'SB' | 'ND' | 'FE' | 'GY' | 'HV' | 'JN' | 'KM' | 'KV' | 'NY' | 'PS' | 'VE' | 'VM' | 'ZE' | 'BT' | 'JA' | 'JB' | 'JI' | 'JK' | 'JT' | 'PP' | 'CW' | 'LD' | 'LH' | 'LK' | 'LM' | 'LS' | 'MH' | 'OY' | 'WD' | 'WH' | 'WW' | 'WX' | 'JM' | 'DH' | 'GJ' | 'HP' | 'JH' | 'MZ' | 'PY' | 'TN' | 'TR' | 'UP' | 'WB' | 'BG' | 'DA' | 'DQ' | 'QA' | '00' | 'AKN' | 'AKU' | 'ARN' | 'ASA' | 'BLA' | 'BOG' | 'DAB' | 'DAV' | 'EOM' | 'EYF' | 'FJD' | 'FJL' | 'FLA' | 'FLR' | 'GAR' | 'GOG' | 'GRN' | 'GRU' | 'GRY' | 'HAF' | 'HRG' | 'HRU' | 'HUG' | 'HUV' | 'HVA' | 'HVE' | 'ISA' | 'KJO' | 'MOS' | 'MYR' | 'RGE' | 'RGY' | 'RHH' | 'RKN' | 'RKV' | 'SBT' | 'SDN' | 'SDV' | 'SEL' | 'SFA' | 'SKF' | 'SKG' | 'SKO' | 'SNF' | 'SOG' | 'SSS' | 'STR' | 'SVG' | 'TAL' | 'THG' | 'TJO' | 'VEM' | 'VER' | 'VOP' | '75' | 'CZ' | 'FC' | 'FG' | 'FI' | 'ME' | 'PC' | 'PD' | 'PG' | 'PU' | 'PZ' | 'RA' | 'RE' | 'TP' | 'VR' | 'VT' | 'VV' | 'IR' | 'KH' | 'PH' | 'XE' | 'XI' | 'XS' | 'GG' | 'GK' | 'GP' | 'MR' | 'VL' | 'EC' | 'RD' | 'WI' | '002' | '007' | '011' | '016' | '022' | '026' | '033' | '041' | '047' | '052' | '054' | '056' | '058' | '059' | '062' | '067' | '068' | '073' | '077' | '087' | '088' | '089' | '091' | '094' | '097' | '099' | '102' | '106' | '111' | '112' | '113' | 'DGV' | 'JEL' | 'JUR' | 'LPX' | 'REZ' | 'RIX' | 'VEN' | 'DR' | 'GT' | 'JG' | 'KF' | 'MJ' | 'MQ' | 'NQ' | 'WS' | 'AGD' | 'AOU' | 'ASZ' | 'AZI' | 'BEM' | 'BER' | 'BES' | 'BOD' | 'BOM' | 'BRR' | 'CHI' | 'CHT' | 'DRI' | 'ERR' | 'ESI' | 'ESM' | 'FAH' | 'FES' | 'FIG' | 'FQH' | 'GUE' | 'GUF' | 'HAJ' | 'HAO' | 'HOC' | 'IFR' | 'INE' | 'JDI' | 'JRA' | 'KES' | 'KHE' | 'KHN' | 'LAA' | 'LAR' | 'MAR' | 'MDF' | 'MED' | 'MEK' | 'MID' | 'MOH' | 'NAD' | 'OUA' | 'OUJ' | 'OUZ' | 'RAB' | 'REH' | 'SAF' | 'SEF' | 'SET' | 'SIB' | 'SIF' | 'SIK' | 'SIL' | 'SKH' | 'TAF' | 'TAI' | 'TAO' | 'TAT' | 'TAZ' | 'TET' | 'TIN' | 'TIZ' | 'TNG' | 'TNT' | 'YUS' | 'ZAG' | 'JE' | 'BD' | 'ED' | 'FL' | 'IA' | 'UN' | 'ALK' | 'ALL' | 'AUR' | 'EBO' | 'ENI' | 'JAB' | 'JAL' | 'KIL' | 'KWA' | 'LAE' | 'LIB' | 'LIK' | 'MAJ' | 'MEJ' | 'MIL' | 'NMK' | 'NMU' | 'RON' | 'UJA' | 'UTI' | 'WTH' | 'WTJ' | '103' | '104' | '105' | '107' | '108' | '109' | '210' | '211' | '301' | '304' | '307' | '308' | '310' | '401' | '402' | '403' | '404' | '405' | '406' | '407' | '408' | '409' | '410' | '501' | '502' | '504' | '505' | '506' | '507' | '508' | '509' | '601' | '602' | '603' | '604' | '605' | '606' | '607' | '608' | '609' | '701' | '702' | '703' | '704' | '705' | '706' | '807' | '808' | '810' | '811' | '812' | '813' | '814' | '815' | '816' | '817' | 'BKO' | '037' | '039' | '043' | '046' | '049' | '051' | '053' | '057' | '061' | '063' | '064' | '069' | '071' | 'PW' | 'MLE' | 'RU' | 'BCN' | 'BCS' | 'CHH' | 'CHP' | 'CMX' | 'COA' | 'COL' | 'GRO' | 'HID' | 'MEX' | 'MIC' | 'MOR' | 'NLE' | 'OAX' | 'PUE' | 'QUE' | 'ROO' | 'SLP' | 'SON' | 'TAB' | 'TLA' | 'YUC' | 'ZAC' | 'MPM' | 'OD' | 'OH' | 'OS' | 'EK' | 'OG' | 'AW' | 'BQ1' | 'BQ2' | 'BQ3' | 'NH' | 'OV' | 'P1' | 'P2' | 'P3' | 'P4' | 'P5' | 'P6' | 'P7' | 'AUK' | 'BOP' | 'CAN' | 'CIT' | 'GIS' | 'HKB' | 'MBH' | 'MWT' | 'NSN' | 'OTA' | 'STL' | 'TKI' | 'WKO' | 'WTC' | 'WU' | 'ZU' | 'EM' | 'ANC' | 'APU' | 'ARE' | 'AYA' | 'CAJ' | 'HUC' | 'ICA' | 'JUN' | 'LAL' | 'LAM' | 'LIM' | 'LMA' | 'MDD' | 'MOQ' | 'PIU' | 'PUN' | 'TAC' | 'TUM' | 'CPK' | 'CPM' | 'EBR' | 'EHG' | 'EPW' | 'ESW' | 'GPK' | 'HLA' | 'JWK' | 'MBA' | 'MPL' | 'MRL' | 'NCD' | 'NIK' | 'NPP' | 'NSB' | 'SHM' | 'WHM' | 'WPD' | 'ABR' | 'AGN' | 'AKL' | 'ALB' | 'APA' | 'BOH' | 'BTG' | 'BTN' | 'BUK' | 'BUL' | 'CAG' | 'CAP' | 'CAT' | 'CAV' | 'CEB' | 'DAO' | 'DIN' | 'DVO' | 'EAS' | 'GUI' | 'IFU' | 'ILI' | 'ILN' | 'ILS' | 'LAS' | 'LEY' | 'LUN' | 'MAD' | 'MDC' | 'MDR' | 'MSC' | 'MSR' | 'NCO' | 'NEC' | 'NER' | 'NUE' | 'NUV' | 'PAM' | 'PLW' | 'RIZ' | 'ROM' | 'SCO' | 'SIG' | 'SLE' | 'SLU' | 'SUK' | 'SUN' | 'SUR' | 'TAW' | 'WSA' | 'ZAS' | 'ZMB' | 'ZSI' | 'KP' | 'BTH' | 'DEB' | 'GZA' | 'HBN' | 'JEM' | 'JEN' | 'JRH' | 'KYS' | 'NBS' | 'NGZ' | 'QQA' | 'RBH' | 'RFH' | 'SLT' | 'TBS' | 'TKM' | '004' | '010' | '100' | '150' | '212' | '218' | '222' | '224' | '226' | '227' | '228' | '350' | '370' | 'ASU' | 'US' | 'CJ' | 'CV' | 'HD' | 'IF' | 'IL' | 'TL' | 'TM' | 'VN' | 'VO' | 'ALT' | 'AMU' | 'ARK' | 'BEL' | 'CHU' | 'IRK' | 'IVA' | 'KAM' | 'KDA' | 'KEM' | 'KGD' | 'KGN' | 'KHA' | 'KHM' | 'KLU' | 'KRS' | 'KYA' | 'LEN' | 'LIP' | 'MOW' | 'MUR' | 'NEN' | 'NGR' | 'NIZ' | 'NVS' | 'OMS' | 'ORE' | 'ORL' | 'PER' | 'PNZ' | 'PRI' | 'PSK' | 'ROS' | 'RYA' | 'SMO' | 'SPE' | 'STA' | 'SVE' | 'TOM' | 'TUL' | 'TVE' | 'TYU' | 'ULY' | 'VGG' | 'VLA' | 'VOR' | 'YAN' | 'MK' | 'WE' | 'DS' | 'DW' | 'NR' | '001' | '003' | '005' | '006' | '008' | '009' | '012' | '013' | '014' | '017' | '018' | '019' | '021' | '023' | '024' | '027' | '028' | '029' | '031' | '032' | '034' | '036' | '038' | '044' | '045' | '048' | '066' | '072' | '074' | '075' | '078' | '079' | '081' | '082' | '083' | '084' | '085' | '086' | '090' | '092' | '093' | '095' | '096' | '098' | '110' | '114' | '115' | '116' | '117' | '118' | '119' | '120' | '121' | '122' | '123' | '124' | '125' | '126' | '127' | '128' | '129' | '131' | '132' | '133' | '134' | '135' | '136' | '137' | '138' | '139' | '140' | '143' | '144' | '146' | '148' | '149' | '151' | '152' | '153' | '154' | '155' | '156' | '157' | '158' | '159' | '160' | '161' | '162' | '163' | '164' | '165' | '166' | '167' | '168' | '169' | '170' | '172' | '173' | '174' | '175' | '176' | '177' | '178' | '179' | '180' | '181' | '182' | '183' | '185' | '186' | '187' | '188' | '189' | '190' | '192' | '193' | '194' | '195' | '196' | '197' | '199' | '200' | '213' | 'TC' | 'ZI' | 'FK' | 'JD' | 'WO' | 'EE' | 'EW' | 'UY' | 'DY' | 'ID' | 'EO' | '96' | 'OE' | 'ARI' | 'CHA' | 'CTT' | 'DMN' | 'MRC' | 'PED' | 'POS' | 'PRT' | 'PTF' | 'SFO' | 'SGE' | 'SIP' | 'SJL' | 'TUP' | 'FUN' | 'NIT' | 'NKF' | 'NKL' | 'NMA' | 'NMG' | 'NUI' | 'VAI' | 'CYI' | 'CYQ' | 'HSQ' | 'HSZ' | 'ILA' | 'KEE' | 'KHH' | 'KIN' | 'LIE' | 'MIA' | 'NWT' | 'PEN' | 'PIF' | 'TNN' | 'TPE' | 'TTT' | 'TXG' | 'YUN' | '215' | '216' | '217' | '219' | '220' | '221' | '223' | '225' | '229' | '230' | '231' | '232' | '233' | '234' | '235' | '236' | '237' | '302' | '306' | '309' | '318' | '319' | '320' | '328' | '329' | '330' | '331' | '332' | '333' | '334' | '335' | '336' | '337' | '414' | '415' | '416' | '417' | '418' | '419' | '420' | '428' | '429' | '433' | '434' | '435' | 'NJ' | 'OK' | 'TX' | 'UM' | 'WV' | 'WY' | 'FD' | 'FS' | 'RV' | 'TT' | 'QR' | 'TK' | 'XO' | 'MAP' | 'SEE' | 'TAE' | 'UV' | 'VF' | 'HJ' | 'KZN' | 'WC';
635
+ /**
636
+ * The zip or postal code
637
+ */
638
+ zipCode?: string;
639
+ }
640
+ }
641
+ export interface CustomerDeleteParams {
642
+ /**
643
+ * The id of the customer
644
+ */
645
+ id: string;
646
+ }
647
+ export interface CustomerSearchParams {
648
+ /**
649
+ * Search for customers by email
650
+ */
651
+ email?: string;
652
+ /**
653
+ * A limit on the number of objects to be returned.
654
+ */
655
+ limit?: number;
656
+ /**
657
+ * Search for customers by phone
658
+ */
659
+ phone?: string;
660
+ /**
661
+ * The number of items to skip
662
+ */
663
+ skip?: number;
664
+ }
665
+ export declare namespace Customers {
666
+ export { type CustomerCreateResponse as CustomerCreateResponse, type CustomerRetrieveResponse as CustomerRetrieveResponse, type CustomerUpdateResponse as CustomerUpdateResponse, type CustomerDeleteResponse as CustomerDeleteResponse, type CustomerSearchResponse as CustomerSearchResponse, type CustomerCreateParams as CustomerCreateParams, type CustomerRetrieveParams as CustomerRetrieveParams, type CustomerUpdateParams as CustomerUpdateParams, type CustomerDeleteParams as CustomerDeleteParams, type CustomerSearchParams as CustomerSearchParams, };
667
+ }
668
+ //# sourceMappingURL=customers.d.mts.map