celitech-sdk 1.1.85 → 1.1.86

Sign up to get free protection for your applications and to get access to all the features.
Files changed (340) hide show
  1. package/README.md +4 -18
  2. package/dist/index.d.ts +1503 -12
  3. package/dist/index.js +2140 -76
  4. package/dist/index.mjs +2102 -0
  5. package/package.json +22 -5
  6. package/.devcontainer/devcontainer.json +0 -24
  7. package/.github/workflows/publish_npmjs.yml +0 -32
  8. package/.manifest.json +0 -256
  9. package/dist/http/client.d.ts +0 -14
  10. package/dist/http/client.d.ts.map +0 -1
  11. package/dist/http/client.js +0 -36
  12. package/dist/http/client.js.map +0 -1
  13. package/dist/http/environment.d.ts +0 -4
  14. package/dist/http/environment.d.ts.map +0 -1
  15. package/dist/http/environment.js +0 -8
  16. package/dist/http/environment.js.map +0 -1
  17. package/dist/http/error.d.ts +0 -7
  18. package/dist/http/error.d.ts.map +0 -1
  19. package/dist/http/error.js +0 -12
  20. package/dist/http/error.js.map +0 -1
  21. package/dist/http/handlers/handler-chain.d.ts +0 -8
  22. package/dist/http/handlers/handler-chain.d.ts.map +0 -1
  23. package/dist/http/handlers/handler-chain.js +0 -34
  24. package/dist/http/handlers/handler-chain.js.map +0 -1
  25. package/dist/http/handlers/hook-handler.d.ts +0 -12
  26. package/dist/http/handlers/hook-handler.d.ts.map +0 -1
  27. package/dist/http/handlers/hook-handler.js +0 -49
  28. package/dist/http/handlers/hook-handler.js.map +0 -1
  29. package/dist/http/handlers/request-validation-handler.d.ts +0 -9
  30. package/dist/http/handlers/request-validation-handler.d.ts.map +0 -1
  31. package/dist/http/handlers/request-validation-handler.js +0 -78
  32. package/dist/http/handlers/request-validation-handler.js.map +0 -1
  33. package/dist/http/handlers/response-validation-handler.d.ts +0 -11
  34. package/dist/http/handlers/response-validation-handler.d.ts.map +0 -1
  35. package/dist/http/handlers/response-validation-handler.js +0 -89
  36. package/dist/http/handlers/response-validation-handler.js.map +0 -1
  37. package/dist/http/handlers/retry-handler.d.ts +0 -9
  38. package/dist/http/handlers/retry-handler.d.ts.map +0 -1
  39. package/dist/http/handlers/retry-handler.js +0 -47
  40. package/dist/http/handlers/retry-handler.js.map +0 -1
  41. package/dist/http/handlers/terminating-handler.d.ts +0 -8
  42. package/dist/http/handlers/terminating-handler.d.ts.map +0 -1
  43. package/dist/http/handlers/terminating-handler.js +0 -45
  44. package/dist/http/handlers/terminating-handler.js.map +0 -1
  45. package/dist/http/hooks/custom-hook.d.ts +0 -8
  46. package/dist/http/hooks/custom-hook.d.ts.map +0 -1
  47. package/dist/http/hooks/custom-hook.js +0 -37
  48. package/dist/http/hooks/custom-hook.js.map +0 -1
  49. package/dist/http/hooks/hook.d.ts +0 -31
  50. package/dist/http/hooks/hook.d.ts.map +0 -1
  51. package/dist/http/hooks/hook.js +0 -3
  52. package/dist/http/hooks/hook.js.map +0 -1
  53. package/dist/http/serializer.d.ts +0 -13
  54. package/dist/http/serializer.d.ts.map +0 -1
  55. package/dist/http/serializer.js +0 -150
  56. package/dist/http/serializer.js.map +0 -1
  57. package/dist/http/transport/request-builder.d.ts +0 -24
  58. package/dist/http/transport/request-builder.d.ts.map +0 -1
  59. package/dist/http/transport/request-builder.js +0 -130
  60. package/dist/http/transport/request-builder.js.map +0 -1
  61. package/dist/http/transport/request.d.ts +0 -53
  62. package/dist/http/transport/request.d.ts.map +0 -1
  63. package/dist/http/transport/request.js +0 -116
  64. package/dist/http/transport/request.js.map +0 -1
  65. package/dist/http/types.d.ts +0 -60
  66. package/dist/http/types.d.ts.map +0 -1
  67. package/dist/http/types.js +0 -16
  68. package/dist/http/types.js.map +0 -1
  69. package/dist/index.d.ts.map +0 -1
  70. package/dist/index.js.map +0 -1
  71. package/dist/services/base-service.d.ts +0 -14
  72. package/dist/services/base-service.d.ts.map +0 -1
  73. package/dist/services/base-service.js +0 -27
  74. package/dist/services/base-service.js.map +0 -1
  75. package/dist/services/destinations/destinations.d.ts +0 -11
  76. package/dist/services/destinations/destinations.d.ts.map +0 -1
  77. package/dist/services/destinations/destinations.js +0 -43
  78. package/dist/services/destinations/destinations.js.map +0 -1
  79. package/dist/services/destinations/index.d.ts +0 -3
  80. package/dist/services/destinations/index.d.ts.map +0 -1
  81. package/dist/services/destinations/index.js +0 -21
  82. package/dist/services/destinations/index.js.map +0 -1
  83. package/dist/services/destinations/models/destinations.d.ts +0 -76
  84. package/dist/services/destinations/models/destinations.d.ts.map +0 -1
  85. package/dist/services/destinations/models/destinations.js +0 -49
  86. package/dist/services/destinations/models/destinations.js.map +0 -1
  87. package/dist/services/destinations/models/index.d.ts +0 -3
  88. package/dist/services/destinations/models/index.d.ts.map +0 -1
  89. package/dist/services/destinations/models/index.js +0 -3
  90. package/dist/services/destinations/models/index.js.map +0 -1
  91. package/dist/services/destinations/models/list-destinations-ok-response.d.ts +0 -140
  92. package/dist/services/destinations/models/list-destinations-ok-response.d.ts.map +0 -1
  93. package/dist/services/destinations/models/list-destinations-ok-response.js +0 -36
  94. package/dist/services/destinations/models/list-destinations-ok-response.js.map +0 -1
  95. package/dist/services/e-sim/e-sim.d.ts +0 -34
  96. package/dist/services/e-sim/e-sim.d.ts.map +0 -1
  97. package/dist/services/e-sim/e-sim.js +0 -120
  98. package/dist/services/e-sim/e-sim.js.map +0 -1
  99. package/dist/services/e-sim/index.d.ts +0 -3
  100. package/dist/services/e-sim/index.d.ts.map +0 -1
  101. package/dist/services/e-sim/index.js +0 -21
  102. package/dist/services/e-sim/index.js.map +0 -1
  103. package/dist/services/e-sim/models/device.d.ts +0 -90
  104. package/dist/services/e-sim/models/device.d.ts.map +0 -1
  105. package/dist/services/e-sim/models/device.js +0 -54
  106. package/dist/services/e-sim/models/device.js.map +0 -1
  107. package/dist/services/e-sim/models/get-esim-device-ok-response.d.ts +0 -163
  108. package/dist/services/e-sim/models/get-esim-device-ok-response.d.ts.map +0 -1
  109. package/dist/services/e-sim/models/get-esim-device-ok-response.js +0 -36
  110. package/dist/services/e-sim/models/get-esim-device-ok-response.js.map +0 -1
  111. package/dist/services/e-sim/models/get-esim-history-ok-response-esim.d.ts +0 -154
  112. package/dist/services/e-sim/models/get-esim-history-ok-response-esim.d.ts.map +0 -1
  113. package/dist/services/e-sim/models/get-esim-history-ok-response-esim.js +0 -40
  114. package/dist/services/e-sim/models/get-esim-history-ok-response-esim.js.map +0 -1
  115. package/dist/services/e-sim/models/get-esim-history-ok-response.d.ts +0 -249
  116. package/dist/services/e-sim/models/get-esim-history-ok-response.d.ts.map +0 -1
  117. package/dist/services/e-sim/models/get-esim-history-ok-response.js +0 -36
  118. package/dist/services/e-sim/models/get-esim-history-ok-response.js.map +0 -1
  119. package/dist/services/e-sim/models/get-esim-mac-ok-response-esim.d.ts +0 -76
  120. package/dist/services/e-sim/models/get-esim-mac-ok-response-esim.d.ts.map +0 -1
  121. package/dist/services/e-sim/models/get-esim-mac-ok-response-esim.js +0 -49
  122. package/dist/services/e-sim/models/get-esim-mac-ok-response-esim.js.map +0 -1
  123. package/dist/services/e-sim/models/get-esim-mac-ok-response.d.ts +0 -140
  124. package/dist/services/e-sim/models/get-esim-mac-ok-response.d.ts.map +0 -1
  125. package/dist/services/e-sim/models/get-esim-mac-ok-response.js +0 -36
  126. package/dist/services/e-sim/models/get-esim-mac-ok-response.js.map +0 -1
  127. package/dist/services/e-sim/models/get-esim-ok-response-esim.d.ts +0 -90
  128. package/dist/services/e-sim/models/get-esim-ok-response-esim.d.ts.map +0 -1
  129. package/dist/services/e-sim/models/get-esim-ok-response-esim.js +0 -54
  130. package/dist/services/e-sim/models/get-esim-ok-response-esim.js.map +0 -1
  131. package/dist/services/e-sim/models/get-esim-ok-response.d.ts +0 -163
  132. package/dist/services/e-sim/models/get-esim-ok-response.d.ts.map +0 -1
  133. package/dist/services/e-sim/models/get-esim-ok-response.js +0 -36
  134. package/dist/services/e-sim/models/get-esim-ok-response.js.map +0 -1
  135. package/dist/services/e-sim/models/history.d.ts +0 -76
  136. package/dist/services/e-sim/models/history.d.ts.map +0 -1
  137. package/dist/services/e-sim/models/history.js +0 -45
  138. package/dist/services/e-sim/models/history.js.map +0 -1
  139. package/dist/services/e-sim/models/index.d.ts +0 -10
  140. package/dist/services/e-sim/models/index.d.ts.map +0 -1
  141. package/dist/services/e-sim/models/index.js +0 -3
  142. package/dist/services/e-sim/models/index.js.map +0 -1
  143. package/dist/services/e-sim/request-params.d.ts +0 -4
  144. package/dist/services/e-sim/request-params.d.ts.map +0 -1
  145. package/dist/services/e-sim/request-params.js +0 -3
  146. package/dist/services/e-sim/request-params.js.map +0 -1
  147. package/dist/services/packages/index.d.ts +0 -3
  148. package/dist/services/packages/index.d.ts.map +0 -1
  149. package/dist/services/packages/index.js +0 -21
  150. package/dist/services/packages/index.js.map +0 -1
  151. package/dist/services/packages/models/index.d.ts +0 -3
  152. package/dist/services/packages/models/index.d.ts.map +0 -1
  153. package/dist/services/packages/models/index.js +0 -3
  154. package/dist/services/packages/models/index.js.map +0 -1
  155. package/dist/services/packages/models/list-packages-ok-response.d.ts +0 -223
  156. package/dist/services/packages/models/list-packages-ok-response.d.ts.map +0 -1
  157. package/dist/services/packages/models/list-packages-ok-response.js +0 -42
  158. package/dist/services/packages/models/list-packages-ok-response.js.map +0 -1
  159. package/dist/services/packages/models/packages.d.ts +0 -118
  160. package/dist/services/packages/models/packages.d.ts.map +0 -1
  161. package/dist/services/packages/models/packages.js +0 -64
  162. package/dist/services/packages/models/packages.js.map +0 -1
  163. package/dist/services/packages/packages.d.ts +0 -20
  164. package/dist/services/packages/packages.d.ts.map +0 -1
  165. package/dist/services/packages/packages.js +0 -59
  166. package/dist/services/packages/packages.js.map +0 -1
  167. package/dist/services/packages/request-params.d.ts +0 -11
  168. package/dist/services/packages/request-params.d.ts.map +0 -1
  169. package/dist/services/packages/request-params.js +0 -3
  170. package/dist/services/packages/request-params.js.map +0 -1
  171. package/dist/services/purchases/index.d.ts +0 -3
  172. package/dist/services/purchases/index.d.ts.map +0 -1
  173. package/dist/services/purchases/index.js +0 -21
  174. package/dist/services/purchases/index.js.map +0 -1
  175. package/dist/services/purchases/models/create-purchase-ok-response-profile.d.ts +0 -62
  176. package/dist/services/purchases/models/create-purchase-ok-response-profile.d.ts.map +0 -1
  177. package/dist/services/purchases/models/create-purchase-ok-response-profile.js +0 -39
  178. package/dist/services/purchases/models/create-purchase-ok-response-profile.js.map +0 -1
  179. package/dist/services/purchases/models/create-purchase-ok-response-purchase.d.ts +0 -132
  180. package/dist/services/purchases/models/create-purchase-ok-response-purchase.d.ts.map +0 -1
  181. package/dist/services/purchases/models/create-purchase-ok-response-purchase.js +0 -69
  182. package/dist/services/purchases/models/create-purchase-ok-response-purchase.js.map +0 -1
  183. package/dist/services/purchases/models/create-purchase-ok-response.d.ts +0 -315
  184. package/dist/services/purchases/models/create-purchase-ok-response.d.ts.map +0 -1
  185. package/dist/services/purchases/models/create-purchase-ok-response.js +0 -46
  186. package/dist/services/purchases/models/create-purchase-ok-response.js.map +0 -1
  187. package/dist/services/purchases/models/create-purchase-request.d.ts +0 -160
  188. package/dist/services/purchases/models/create-purchase-request.d.ts.map +0 -1
  189. package/dist/services/purchases/models/create-purchase-request.js +0 -79
  190. package/dist/services/purchases/models/create-purchase-request.js.map +0 -1
  191. package/dist/services/purchases/models/edit-purchase-ok-response.d.ts +0 -104
  192. package/dist/services/purchases/models/edit-purchase-ok-response.d.ts.map +0 -1
  193. package/dist/services/purchases/models/edit-purchase-ok-response.js +0 -59
  194. package/dist/services/purchases/models/edit-purchase-ok-response.js.map +0 -1
  195. package/dist/services/purchases/models/edit-purchase-request.d.ts +0 -104
  196. package/dist/services/purchases/models/edit-purchase-request.d.ts.map +0 -1
  197. package/dist/services/purchases/models/edit-purchase-request.js +0 -59
  198. package/dist/services/purchases/models/edit-purchase-request.js.map +0 -1
  199. package/dist/services/purchases/models/get-purchase-consumption-ok-response.d.ts +0 -62
  200. package/dist/services/purchases/models/get-purchase-consumption-ok-response.d.ts.map +0 -1
  201. package/dist/services/purchases/models/get-purchase-consumption-ok-response.js +0 -41
  202. package/dist/services/purchases/models/get-purchase-consumption-ok-response.js.map +0 -1
  203. package/dist/services/purchases/models/index.d.ts +0 -16
  204. package/dist/services/purchases/models/index.d.ts.map +0 -1
  205. package/dist/services/purchases/models/index.js +0 -3
  206. package/dist/services/purchases/models/index.js.map +0 -1
  207. package/dist/services/purchases/models/list-purchases-ok-response.d.ts +0 -622
  208. package/dist/services/purchases/models/list-purchases-ok-response.d.ts.map +0 -1
  209. package/dist/services/purchases/models/list-purchases-ok-response.js +0 -42
  210. package/dist/services/purchases/models/list-purchases-ok-response.js.map +0 -1
  211. package/dist/services/purchases/models/package_.d.ts +0 -104
  212. package/dist/services/purchases/models/package_.d.ts.map +0 -1
  213. package/dist/services/purchases/models/package_.js +0 -59
  214. package/dist/services/purchases/models/package_.js.map +0 -1
  215. package/dist/services/purchases/models/purchases-esim.d.ts +0 -48
  216. package/dist/services/purchases/models/purchases-esim.d.ts.map +0 -1
  217. package/dist/services/purchases/models/purchases-esim.js +0 -35
  218. package/dist/services/purchases/models/purchases-esim.js.map +0 -1
  219. package/dist/services/purchases/models/purchases.d.ts +0 -372
  220. package/dist/services/purchases/models/purchases.d.ts.map +0 -1
  221. package/dist/services/purchases/models/purchases.js +0 -91
  222. package/dist/services/purchases/models/purchases.js.map +0 -1
  223. package/dist/services/purchases/models/top-up-esim-ok-response-profile.d.ts +0 -48
  224. package/dist/services/purchases/models/top-up-esim-ok-response-profile.d.ts.map +0 -1
  225. package/dist/services/purchases/models/top-up-esim-ok-response-profile.js +0 -35
  226. package/dist/services/purchases/models/top-up-esim-ok-response-profile.js.map +0 -1
  227. package/dist/services/purchases/models/top-up-esim-ok-response-purchase.d.ts +0 -132
  228. package/dist/services/purchases/models/top-up-esim-ok-response-purchase.d.ts.map +0 -1
  229. package/dist/services/purchases/models/top-up-esim-ok-response-purchase.js +0 -69
  230. package/dist/services/purchases/models/top-up-esim-ok-response-purchase.js.map +0 -1
  231. package/dist/services/purchases/models/top-up-esim-ok-response.d.ts +0 -292
  232. package/dist/services/purchases/models/top-up-esim-ok-response.d.ts.map +0 -1
  233. package/dist/services/purchases/models/top-up-esim-ok-response.js +0 -46
  234. package/dist/services/purchases/models/top-up-esim-ok-response.js.map +0 -1
  235. package/dist/services/purchases/models/top-up-esim-request.d.ts +0 -146
  236. package/dist/services/purchases/models/top-up-esim-request.d.ts.map +0 -1
  237. package/dist/services/purchases/models/top-up-esim-request.js +0 -74
  238. package/dist/services/purchases/models/top-up-esim-request.js.map +0 -1
  239. package/dist/services/purchases/purchases.d.ts +0 -48
  240. package/dist/services/purchases/purchases.d.ts.map +0 -1
  241. package/dist/services/purchases/purchases.js +0 -162
  242. package/dist/services/purchases/purchases.js.map +0 -1
  243. package/dist/services/purchases/request-params.d.ts +0 -11
  244. package/dist/services/purchases/request-params.d.ts.map +0 -1
  245. package/dist/services/purchases/request-params.js +0 -3
  246. package/dist/services/purchases/request-params.js.map +0 -1
  247. package/documentation/models/CreatePurchaseOkResponse.md +0 -31
  248. package/documentation/models/CreatePurchaseRequest.md +0 -15
  249. package/documentation/models/EditPurchaseOkResponse.md +0 -11
  250. package/documentation/models/EditPurchaseRequest.md +0 -11
  251. package/documentation/models/GetEsimDeviceOkResponse.md +0 -18
  252. package/documentation/models/GetEsimHistoryOkResponse.md +0 -26
  253. package/documentation/models/GetEsimMacOkResponse.md +0 -17
  254. package/documentation/models/GetEsimOkResponse.md +0 -18
  255. package/documentation/models/GetPurchaseConsumptionOkResponse.md +0 -8
  256. package/documentation/models/ListDestinationsOkResponse.md +0 -17
  257. package/documentation/models/ListPackagesOkResponse.md +0 -21
  258. package/documentation/models/ListPurchasesOkResponse.md +0 -46
  259. package/documentation/models/TopUpEsimOkResponse.md +0 -30
  260. package/documentation/models/TopUpEsimRequest.md +0 -14
  261. package/documentation/services/DestinationsService.md +0 -35
  262. package/documentation/services/ESimService.md +0 -148
  263. package/documentation/services/PackagesService.md +0 -48
  264. package/documentation/services/PurchasesService.md +0 -222
  265. package/documentation/snippets/destinations-get.md +0 -14
  266. package/documentation/snippets/esim-get.md +0 -16
  267. package/documentation/snippets/esim-{iccid}-device-get.md +0 -14
  268. package/documentation/snippets/esim-{iccid}-history-get.md +0 -14
  269. package/documentation/snippets/esim-{iccid}-mac-get.md +0 -14
  270. package/documentation/snippets/packages-get.md +0 -14
  271. package/documentation/snippets/purchases-edit-post.md +0 -23
  272. package/documentation/snippets/purchases-get.md +0 -14
  273. package/documentation/snippets/purchases-post.md +0 -27
  274. package/documentation/snippets/purchases-topup-post.md +0 -26
  275. package/documentation/snippets/purchases-{purchaseId}-consumption-get.md +0 -14
  276. package/examples/README.md +0 -27
  277. package/examples/package.json +0 -18
  278. package/examples/src/index.ts +0 -12
  279. package/examples/tsconfig.json +0 -22
  280. package/src/http/client.ts +0 -46
  281. package/src/http/environment.ts +0 -3
  282. package/src/http/error.ts +0 -12
  283. package/src/http/handlers/handler-chain.ts +0 -22
  284. package/src/http/handlers/hook-handler.ts +0 -47
  285. package/src/http/handlers/request-validation-handler.ts +0 -72
  286. package/src/http/handlers/response-validation-handler.ts +0 -106
  287. package/src/http/handlers/retry-handler.ts +0 -40
  288. package/src/http/handlers/terminating-handler.ts +0 -38
  289. package/src/http/hooks/custom-hook.ts +0 -32
  290. package/src/http/hooks/hook.ts +0 -40
  291. package/src/http/serializer.ts +0 -183
  292. package/src/http/transport/request-builder.ts +0 -145
  293. package/src/http/transport/request.ts +0 -178
  294. package/src/http/types.ts +0 -70
  295. package/src/index.ts +0 -73
  296. package/src/services/base-service.ts +0 -29
  297. package/src/services/destinations/destinations.ts +0 -28
  298. package/src/services/destinations/index.ts +0 -2
  299. package/src/services/destinations/models/destinations.ts +0 -57
  300. package/src/services/destinations/models/index.ts +0 -2
  301. package/src/services/destinations/models/list-destinations-ok-response.ts +0 -42
  302. package/src/services/e-sim/e-sim.ts +0 -103
  303. package/src/services/e-sim/index.ts +0 -2
  304. package/src/services/e-sim/models/device.ts +0 -63
  305. package/src/services/e-sim/models/get-esim-device-ok-response.ts +0 -42
  306. package/src/services/e-sim/models/get-esim-history-ok-response-esim.ts +0 -47
  307. package/src/services/e-sim/models/get-esim-history-ok-response.ts +0 -46
  308. package/src/services/e-sim/models/get-esim-mac-ok-response-esim.ts +0 -57
  309. package/src/services/e-sim/models/get-esim-mac-ok-response.ts +0 -46
  310. package/src/services/e-sim/models/get-esim-ok-response-esim.ts +0 -63
  311. package/src/services/e-sim/models/get-esim-ok-response.ts +0 -46
  312. package/src/services/e-sim/models/history.ts +0 -53
  313. package/src/services/e-sim/models/index.ts +0 -9
  314. package/src/services/e-sim/request-params.ts +0 -3
  315. package/src/services/packages/index.ts +0 -2
  316. package/src/services/packages/models/index.ts +0 -2
  317. package/src/services/packages/models/list-packages-ok-response.ts +0 -49
  318. package/src/services/packages/models/packages.ts +0 -75
  319. package/src/services/packages/packages.ts +0 -48
  320. package/src/services/packages/request-params.ts +0 -10
  321. package/src/services/purchases/index.ts +0 -2
  322. package/src/services/purchases/models/create-purchase-ok-response-profile.ts +0 -46
  323. package/src/services/purchases/models/create-purchase-ok-response-purchase.ts +0 -81
  324. package/src/services/purchases/models/create-purchase-ok-response.ts +0 -61
  325. package/src/services/purchases/models/create-purchase-request.ts +0 -93
  326. package/src/services/purchases/models/edit-purchase-ok-response.ts +0 -69
  327. package/src/services/purchases/models/edit-purchase-request.ts +0 -69
  328. package/src/services/purchases/models/get-purchase-consumption-ok-response.ts +0 -48
  329. package/src/services/purchases/models/index.ts +0 -15
  330. package/src/services/purchases/models/list-purchases-ok-response.ts +0 -49
  331. package/src/services/purchases/models/package_.ts +0 -69
  332. package/src/services/purchases/models/purchases-esim.ts +0 -41
  333. package/src/services/purchases/models/purchases.ts +0 -107
  334. package/src/services/purchases/models/top-up-esim-ok-response-profile.ts +0 -41
  335. package/src/services/purchases/models/top-up-esim-ok-response-purchase.ts +0 -81
  336. package/src/services/purchases/models/top-up-esim-ok-response.ts +0 -61
  337. package/src/services/purchases/models/top-up-esim-request.ts +0 -87
  338. package/src/services/purchases/purchases.ts +0 -159
  339. package/src/services/purchases/request-params.ts +0 -10
  340. package/tsconfig.json +0 -22
package/dist/index.d.ts CHANGED
@@ -1,14 +1,1504 @@
1
- import { Environment } from './http/environment';
2
- import { SdkConfig } from './http/types';
3
- import { DestinationsService } from './services/destinations';
4
- import { PackagesService } from './services/packages';
5
- import { PurchasesService } from './services/purchases';
6
- import { ESimService } from './services/e-sim';
7
- export * as Destinations from './services/destinations';
8
- export * as Packages from './services/packages';
9
- export * as Purchases from './services/purchases';
10
- export * as ESim from './services/e-sim';
11
- export declare class Celitech {
1
+ import { ZodType, z } from 'zod';
2
+
3
+ declare enum Environment {
4
+ DEFAULT = "https://api.celitech.net/v1"
5
+ }
6
+
7
+ type HttpMethod$1 = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE';
8
+ interface HttpRequest {
9
+ baseUrl: string;
10
+ method: HttpMethod$1;
11
+ path: string;
12
+ headers: Map<string, unknown>;
13
+ body?: BodyInit;
14
+ abortSignal?: AbortSignal;
15
+ queryParams: Map<string, unknown>;
16
+ }
17
+ interface HttpMetadata$1 {
18
+ status: number;
19
+ statusText: string;
20
+ headers: Record<string, string>;
21
+ }
22
+ interface HttpResponse$1<T> {
23
+ data?: T;
24
+ metadata: HttpMetadata$1;
25
+ raw: ArrayBuffer;
26
+ }
27
+ interface HttpError {
28
+ error: string;
29
+ metadata: HttpMetadata$1;
30
+ }
31
+ interface Hook {
32
+ beforeRequest(request: HttpRequest, params: Map<string, string>): Promise<HttpRequest>;
33
+ afterResponse(request: HttpRequest, response: HttpResponse$1<any>, params: Map<string, string>): Promise<HttpResponse$1<any>>;
34
+ onError(request: HttpRequest, response: HttpResponse$1<any>, params: Map<string, string>): Promise<HttpError>;
35
+ }
36
+
37
+ declare enum SerializationStyle {
38
+ SIMPLE = "simple",
39
+ LABEL = "label",
40
+ MATRIX = "matrix",
41
+ FORM = "form",
42
+ SPACE_DELIMITED = "space_delimited",
43
+ PIPE_DELIMITED = "pipe_delimited",
44
+ DEEP_OBJECT = "deep_object",
45
+ NONE = "none"
46
+ }
47
+
48
+ interface CreateRequestParameters<T> {
49
+ baseUrl: string;
50
+ method: HttpMethod;
51
+ body?: any;
52
+ headers: Map<string, RequestParameter>;
53
+ queryParams: Map<string, RequestParameter>;
54
+ pathParams: Map<string, RequestParameter>;
55
+ path: string;
56
+ config: SdkConfig;
57
+ responseSchema: ZodType<T, any, any>;
58
+ requestSchema: ZodType;
59
+ requestContentType: ContentType;
60
+ responseContentType: ContentType;
61
+ validation: ValidationOptions;
62
+ retry: RetryOptions;
63
+ }
64
+ interface RequestParameter {
65
+ key: string | undefined;
66
+ value: unknown;
67
+ explode: boolean;
68
+ encode: boolean;
69
+ style: SerializationStyle;
70
+ }
71
+ declare class Request<T> {
72
+ baseUrl: string;
73
+ headers: Map<string, RequestParameter>;
74
+ queryParams: Map<string, RequestParameter>;
75
+ pathParams: Map<string, RequestParameter>;
76
+ body?: any;
77
+ method: HttpMethod;
78
+ path: string;
79
+ config: SdkConfig;
80
+ responseSchema: ZodType<T, any, any>;
81
+ requestSchema: ZodType;
82
+ requestContentType: ContentType;
83
+ responseContentType: ContentType;
84
+ validation: ValidationOptions;
85
+ retry: RetryOptions;
86
+ private readonly pathPattern;
87
+ constructor(params: CreateRequestParameters<T>);
88
+ addHeaderParam(key: string, param: RequestParameter): void;
89
+ addQueryParam(key: string, param: RequestParameter): void;
90
+ addPathParam(key: string, param: RequestParameter): void;
91
+ addBody(body: any): void;
92
+ updateFromHookRequest(hookRequest: HttpRequest): void;
93
+ toHookRequest(): HttpRequest;
94
+ constructFullUrl(): string;
95
+ copy(overrides?: Partial<CreateRequestParameters<T>>): Request<T>;
96
+ getHeaders(): HeadersInit | undefined;
97
+ private constructPath;
98
+ }
99
+
100
+ type HttpMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE';
101
+ interface SdkConfig {
102
+ baseUrl?: string;
103
+ environment?: Environment;
104
+ timeout?: number;
105
+ clientId?: string;
106
+ clientSecret?: string;
107
+ retry?: RetryOptions;
108
+ validation?: ValidationOptions;
109
+ }
110
+ interface HttpMetadata {
111
+ status: number;
112
+ statusText: string;
113
+ headers: Record<string, string>;
114
+ }
115
+ interface HttpResponse<T> {
116
+ data?: T;
117
+ metadata: HttpMetadata;
118
+ raw: ArrayBuffer;
119
+ }
120
+ declare enum ContentType {
121
+ Json = "json",
122
+ Xml = "xml",
123
+ Pdf = "pdf",
124
+ Image = "image",
125
+ File = "file",
126
+ Binary = "binary",
127
+ FormUrlEncoded = "form",
128
+ Text = "text",
129
+ MultipartFormData = "multipartFormData"
130
+ }
131
+ interface RequestConfig {
132
+ retry?: RetryOptions;
133
+ validation?: ValidationOptions;
134
+ }
135
+ interface RetryOptions {
136
+ attempts: number;
137
+ delayMs?: number;
138
+ }
139
+ interface ValidationOptions {
140
+ responseValidation?: boolean;
141
+ }
142
+
143
+ declare class CustomHook implements Hook {
144
+ getToken(clientId: string, clientSecret: string): Promise<any>;
145
+ beforeRequest(request: HttpRequest, params: Map<string, string>): Promise<HttpRequest>;
146
+ afterResponse(request: HttpRequest, response: HttpResponse$1<any>, params: Map<string, string>): Promise<HttpResponse$1<any>>;
147
+ onError(request: HttpRequest, response: HttpResponse$1<any>, params: Map<string, string>): Promise<HttpError>;
148
+ }
149
+
150
+ declare class HttpClient {
151
+ private config;
152
+ private readonly requestHandlerChain;
153
+ constructor(config: SdkConfig, hook?: CustomHook);
154
+ call<T>(request: Request<T>): Promise<HttpResponse<T>>;
155
+ setBaseUrl(url: string): void;
156
+ setConfig(config: SdkConfig): void;
157
+ }
158
+
159
+ declare class BaseService {
160
+ config: SdkConfig;
161
+ client: HttpClient;
162
+ constructor(config: SdkConfig);
163
+ set baseUrl(baseUrl: string);
164
+ set environment(environment: Environment);
165
+ set timeout(timeout: number);
166
+ set clientId(clientId: string);
167
+ set clientSecret(clientSecret: string);
168
+ }
169
+
170
+ /**
171
+ * The shape of the model inside the application code - what the users use
172
+ */
173
+ declare const listDestinationsOkResponse: z.ZodLazy<z.ZodObject<{
174
+ destinations: z.ZodOptional<z.ZodArray<z.ZodLazy<z.ZodObject<{
175
+ name: z.ZodOptional<z.ZodString>;
176
+ destination: z.ZodOptional<z.ZodString>;
177
+ supportedCountries: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
178
+ }, "strip", z.ZodTypeAny, {
179
+ name?: string | undefined;
180
+ destination?: string | undefined;
181
+ supportedCountries?: string[] | undefined;
182
+ }, {
183
+ name?: string | undefined;
184
+ destination?: string | undefined;
185
+ supportedCountries?: string[] | undefined;
186
+ }>>, "many">>;
187
+ }, "strip", z.ZodTypeAny, {
188
+ destinations?: {
189
+ name?: string | undefined;
190
+ destination?: string | undefined;
191
+ supportedCountries?: string[] | undefined;
192
+ }[] | undefined;
193
+ }, {
194
+ destinations?: {
195
+ name?: string | undefined;
196
+ destination?: string | undefined;
197
+ supportedCountries?: string[] | undefined;
198
+ }[] | undefined;
199
+ }>>;
200
+ /**
201
+ *
202
+ * @typedef {ListDestinationsOkResponse} listDestinationsOkResponse
203
+ * @property {Destinations[]}
204
+ */
205
+ type ListDestinationsOkResponse = z.infer<typeof listDestinationsOkResponse>;
206
+
207
+ declare class DestinationsService extends BaseService {
208
+ /**
209
+ * List Destinations
210
+ * @returns {Promise<HttpResponse<ListDestinationsOkResponse>>} Successful Response
211
+ */
212
+ listDestinations(requestConfig?: RequestConfig): Promise<HttpResponse<ListDestinationsOkResponse>>;
213
+ }
214
+
215
+ /**
216
+ * The shape of the model inside the application code - what the users use
217
+ */
218
+ declare const destinations: z.ZodLazy<z.ZodObject<{
219
+ name: z.ZodOptional<z.ZodString>;
220
+ destination: z.ZodOptional<z.ZodString>;
221
+ supportedCountries: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
222
+ }, "strip", z.ZodTypeAny, {
223
+ name?: string | undefined;
224
+ destination?: string | undefined;
225
+ supportedCountries?: string[] | undefined;
226
+ }, {
227
+ name?: string | undefined;
228
+ destination?: string | undefined;
229
+ supportedCountries?: string[] | undefined;
230
+ }>>;
231
+ /**
232
+ *
233
+ * @typedef {Destinations} destinations
234
+ * @property {string} - Name of the destination
235
+ * @property {string} - ISO representation of the destination
236
+ * @property {string[]} - This array indicates the geographical area covered by a specific destination. If the destination represents a single country, the array will include that country. However, if the destination represents a broader regional scope, the array will be populated with the names of the countries belonging to that region.
237
+ */
238
+ type Destinations = z.infer<typeof destinations>;
239
+
240
+ /**
241
+ * The shape of the model inside the application code - what the users use
242
+ */
243
+ declare const listPackagesOkResponse: z.ZodLazy<z.ZodObject<{
244
+ packages: z.ZodOptional<z.ZodArray<z.ZodLazy<z.ZodObject<{
245
+ id: z.ZodOptional<z.ZodString>;
246
+ destination: z.ZodOptional<z.ZodString>;
247
+ dataLimitInBytes: z.ZodOptional<z.ZodNumber>;
248
+ minDays: z.ZodOptional<z.ZodNumber>;
249
+ maxDays: z.ZodOptional<z.ZodNumber>;
250
+ priceInCents: z.ZodOptional<z.ZodNumber>;
251
+ }, "strip", z.ZodTypeAny, {
252
+ id?: string | undefined;
253
+ destination?: string | undefined;
254
+ dataLimitInBytes?: number | undefined;
255
+ minDays?: number | undefined;
256
+ maxDays?: number | undefined;
257
+ priceInCents?: number | undefined;
258
+ }, {
259
+ id?: string | undefined;
260
+ destination?: string | undefined;
261
+ dataLimitInBytes?: number | undefined;
262
+ minDays?: number | undefined;
263
+ maxDays?: number | undefined;
264
+ priceInCents?: number | undefined;
265
+ }>>, "many">>;
266
+ afterCursor: z.ZodNullable<z.ZodOptional<z.ZodString>>;
267
+ }, "strip", z.ZodTypeAny, {
268
+ packages?: {
269
+ id?: string | undefined;
270
+ destination?: string | undefined;
271
+ dataLimitInBytes?: number | undefined;
272
+ minDays?: number | undefined;
273
+ maxDays?: number | undefined;
274
+ priceInCents?: number | undefined;
275
+ }[] | undefined;
276
+ afterCursor?: string | null | undefined;
277
+ }, {
278
+ packages?: {
279
+ id?: string | undefined;
280
+ destination?: string | undefined;
281
+ dataLimitInBytes?: number | undefined;
282
+ minDays?: number | undefined;
283
+ maxDays?: number | undefined;
284
+ priceInCents?: number | undefined;
285
+ }[] | undefined;
286
+ afterCursor?: string | null | undefined;
287
+ }>>;
288
+ /**
289
+ *
290
+ * @typedef {ListPackagesOkResponse} listPackagesOkResponse
291
+ * @property {Packages[]}
292
+ * @property {string} - The cursor value representing the end of the current page of results. Use this cursor value as the "afterCursor" parameter in your next request to retrieve the subsequent page of results. It ensures that you continue fetching data from where you left off, facilitating smooth pagination
293
+ */
294
+ type ListPackagesOkResponse = z.infer<typeof listPackagesOkResponse>;
295
+
296
+ interface ListPackagesParams {
297
+ destination?: string;
298
+ startDate?: string;
299
+ endDate?: string;
300
+ afterCursor?: string;
301
+ limit?: number;
302
+ startTime?: number;
303
+ endTime?: number;
304
+ duration?: number;
305
+ }
306
+
307
+ declare class PackagesService extends BaseService {
308
+ /**
309
+ * List Packages
310
+ * @param {string} [destination] - ISO representation of the package's destination.
311
+ * @param {string} [startDate] - Start date of the package's validity in the format 'yyyy-MM-dd'. This date can be set to the current day or any day within the next 12 months.
312
+ * @param {string} [endDate] - End date of the package's validity in the format 'yyyy-MM-dd'. End date can be maximum 90 days after Start date.
313
+ * @param {string} [afterCursor] - To get the next batch of results, use this parameter. It tells the API where to start fetching data after the last item you received. It helps you avoid repeats and efficiently browse through large sets of data.
314
+ * @param {number} [limit] - Maximum number of packages to be returned in the response. The value must be greater than 0 and less than or equal to 160. If not provided, the default value is 20
315
+ * @param {number} [startTime] - Epoch value representing the start time of the package's validity. This timestamp can be set to the current time or any time within the next 12 months
316
+ * @param {number} [endTime] - Epoch value representing the end time of the package's validity. End time can be maximum 90 days after Start time
317
+ * @param {number} [duration] - Duration in seconds for the package's validity. If this parameter is present, it will override the startTime and endTime parameters. The maximum duration for a package's validity period is 90 days
318
+ * @returns {Promise<HttpResponse<ListPackagesOkResponse>>} Successful Response
319
+ */
320
+ listPackages(params?: ListPackagesParams, requestConfig?: RequestConfig): Promise<HttpResponse<ListPackagesOkResponse>>;
321
+ }
322
+
323
+ /**
324
+ * The shape of the model inside the application code - what the users use
325
+ */
326
+ declare const packages: z.ZodLazy<z.ZodObject<{
327
+ id: z.ZodOptional<z.ZodString>;
328
+ destination: z.ZodOptional<z.ZodString>;
329
+ dataLimitInBytes: z.ZodOptional<z.ZodNumber>;
330
+ minDays: z.ZodOptional<z.ZodNumber>;
331
+ maxDays: z.ZodOptional<z.ZodNumber>;
332
+ priceInCents: z.ZodOptional<z.ZodNumber>;
333
+ }, "strip", z.ZodTypeAny, {
334
+ id?: string | undefined;
335
+ destination?: string | undefined;
336
+ dataLimitInBytes?: number | undefined;
337
+ minDays?: number | undefined;
338
+ maxDays?: number | undefined;
339
+ priceInCents?: number | undefined;
340
+ }, {
341
+ id?: string | undefined;
342
+ destination?: string | undefined;
343
+ dataLimitInBytes?: number | undefined;
344
+ minDays?: number | undefined;
345
+ maxDays?: number | undefined;
346
+ priceInCents?: number | undefined;
347
+ }>>;
348
+ /**
349
+ *
350
+ * @typedef {Packages} packages
351
+ * @property {string} - ID of the package
352
+ * @property {string} - ISO representation of the package's destination
353
+ * @property {number} - Size of the package in Bytes
354
+ * @property {number} - Min number of days for the package
355
+ * @property {number} - Max number of days for the package
356
+ * @property {number} - Price of the package in cents
357
+ */
358
+ type Packages = z.infer<typeof packages>;
359
+
360
+ /**
361
+ * The shape of the model inside the application code - what the users use
362
+ */
363
+ declare const listPurchasesOkResponse: z.ZodLazy<z.ZodObject<{
364
+ purchases: z.ZodOptional<z.ZodArray<z.ZodLazy<z.ZodObject<{
365
+ id: z.ZodOptional<z.ZodString>;
366
+ startDate: z.ZodOptional<z.ZodString>;
367
+ endDate: z.ZodOptional<z.ZodString>;
368
+ createdDate: z.ZodOptional<z.ZodString>;
369
+ startTime: z.ZodOptional<z.ZodNumber>;
370
+ endTime: z.ZodOptional<z.ZodNumber>;
371
+ createdAt: z.ZodOptional<z.ZodNumber>;
372
+ package: z.ZodOptional<z.ZodLazy<z.ZodObject<{
373
+ id: z.ZodOptional<z.ZodString>;
374
+ dataLimitInBytes: z.ZodOptional<z.ZodNumber>;
375
+ destination: z.ZodOptional<z.ZodString>;
376
+ destinationName: z.ZodOptional<z.ZodString>;
377
+ priceInCents: z.ZodOptional<z.ZodNumber>;
378
+ }, "strip", z.ZodTypeAny, {
379
+ id?: string | undefined;
380
+ dataLimitInBytes?: number | undefined;
381
+ destination?: string | undefined;
382
+ destinationName?: string | undefined;
383
+ priceInCents?: number | undefined;
384
+ }, {
385
+ id?: string | undefined;
386
+ dataLimitInBytes?: number | undefined;
387
+ destination?: string | undefined;
388
+ destinationName?: string | undefined;
389
+ priceInCents?: number | undefined;
390
+ }>>>;
391
+ esim: z.ZodOptional<z.ZodLazy<z.ZodObject<{
392
+ iccid: z.ZodOptional<z.ZodString>;
393
+ }, "strip", z.ZodTypeAny, {
394
+ iccid?: string | undefined;
395
+ }, {
396
+ iccid?: string | undefined;
397
+ }>>>;
398
+ source: z.ZodOptional<z.ZodString>;
399
+ referenceId: z.ZodOptional<z.ZodString>;
400
+ }, "strip", z.ZodTypeAny, {
401
+ id?: string | undefined;
402
+ startDate?: string | undefined;
403
+ endDate?: string | undefined;
404
+ createdDate?: string | undefined;
405
+ startTime?: number | undefined;
406
+ endTime?: number | undefined;
407
+ createdAt?: number | undefined;
408
+ package?: {
409
+ id?: string | undefined;
410
+ dataLimitInBytes?: number | undefined;
411
+ destination?: string | undefined;
412
+ destinationName?: string | undefined;
413
+ priceInCents?: number | undefined;
414
+ } | undefined;
415
+ esim?: {
416
+ iccid?: string | undefined;
417
+ } | undefined;
418
+ source?: string | undefined;
419
+ referenceId?: string | undefined;
420
+ }, {
421
+ id?: string | undefined;
422
+ startDate?: string | undefined;
423
+ endDate?: string | undefined;
424
+ createdDate?: string | undefined;
425
+ startTime?: number | undefined;
426
+ endTime?: number | undefined;
427
+ createdAt?: number | undefined;
428
+ package?: {
429
+ id?: string | undefined;
430
+ dataLimitInBytes?: number | undefined;
431
+ destination?: string | undefined;
432
+ destinationName?: string | undefined;
433
+ priceInCents?: number | undefined;
434
+ } | undefined;
435
+ esim?: {
436
+ iccid?: string | undefined;
437
+ } | undefined;
438
+ source?: string | undefined;
439
+ referenceId?: string | undefined;
440
+ }>>, "many">>;
441
+ afterCursor: z.ZodNullable<z.ZodOptional<z.ZodString>>;
442
+ }, "strip", z.ZodTypeAny, {
443
+ purchases?: {
444
+ id?: string | undefined;
445
+ startDate?: string | undefined;
446
+ endDate?: string | undefined;
447
+ createdDate?: string | undefined;
448
+ startTime?: number | undefined;
449
+ endTime?: number | undefined;
450
+ createdAt?: number | undefined;
451
+ package?: {
452
+ id?: string | undefined;
453
+ dataLimitInBytes?: number | undefined;
454
+ destination?: string | undefined;
455
+ destinationName?: string | undefined;
456
+ priceInCents?: number | undefined;
457
+ } | undefined;
458
+ esim?: {
459
+ iccid?: string | undefined;
460
+ } | undefined;
461
+ source?: string | undefined;
462
+ referenceId?: string | undefined;
463
+ }[] | undefined;
464
+ afterCursor?: string | null | undefined;
465
+ }, {
466
+ purchases?: {
467
+ id?: string | undefined;
468
+ startDate?: string | undefined;
469
+ endDate?: string | undefined;
470
+ createdDate?: string | undefined;
471
+ startTime?: number | undefined;
472
+ endTime?: number | undefined;
473
+ createdAt?: number | undefined;
474
+ package?: {
475
+ id?: string | undefined;
476
+ dataLimitInBytes?: number | undefined;
477
+ destination?: string | undefined;
478
+ destinationName?: string | undefined;
479
+ priceInCents?: number | undefined;
480
+ } | undefined;
481
+ esim?: {
482
+ iccid?: string | undefined;
483
+ } | undefined;
484
+ source?: string | undefined;
485
+ referenceId?: string | undefined;
486
+ }[] | undefined;
487
+ afterCursor?: string | null | undefined;
488
+ }>>;
489
+ /**
490
+ *
491
+ * @typedef {ListPurchasesOkResponse} listPurchasesOkResponse
492
+ * @property {Purchases[]}
493
+ * @property {string} - The cursor value representing the end of the current page of results. Use this cursor value as the "afterCursor" parameter in your next request to retrieve the subsequent page of results. It ensures that you continue fetching data from where you left off, facilitating smooth pagination.
494
+ */
495
+ type ListPurchasesOkResponse = z.infer<typeof listPurchasesOkResponse>;
496
+
497
+ interface ListPurchasesParams {
498
+ iccid?: string;
499
+ afterDate?: string;
500
+ beforeDate?: string;
501
+ referenceId?: string;
502
+ afterCursor?: string;
503
+ limit?: number;
504
+ after?: number;
505
+ before?: number;
506
+ }
507
+
508
+ /**
509
+ * The shape of the model inside the application code - what the users use
510
+ */
511
+ declare const createPurchaseRequest: z.ZodLazy<z.ZodObject<{
512
+ destination: z.ZodString;
513
+ dataLimitInGb: z.ZodNumber;
514
+ startDate: z.ZodString;
515
+ endDate: z.ZodString;
516
+ email: z.ZodOptional<z.ZodString>;
517
+ referenceId: z.ZodOptional<z.ZodString>;
518
+ networkBrand: z.ZodOptional<z.ZodString>;
519
+ startTime: z.ZodOptional<z.ZodNumber>;
520
+ endTime: z.ZodOptional<z.ZodNumber>;
521
+ }, "strip", z.ZodTypeAny, {
522
+ destination: string;
523
+ startDate: string;
524
+ endDate: string;
525
+ dataLimitInGb: number;
526
+ email?: string | undefined;
527
+ referenceId?: string | undefined;
528
+ networkBrand?: string | undefined;
529
+ startTime?: number | undefined;
530
+ endTime?: number | undefined;
531
+ }, {
532
+ destination: string;
533
+ startDate: string;
534
+ endDate: string;
535
+ dataLimitInGb: number;
536
+ email?: string | undefined;
537
+ referenceId?: string | undefined;
538
+ networkBrand?: string | undefined;
539
+ startTime?: number | undefined;
540
+ endTime?: number | undefined;
541
+ }>>;
542
+ /**
543
+ *
544
+ * @typedef {CreatePurchaseRequest} createPurchaseRequest
545
+ * @property {string} - ISO representation of the package's destination
546
+ * @property {number} - Size of the package in GB. The available options are 1, 2, 3, 5, 8, 20GB
547
+ * @property {string} - Start date of the package's validity in the format 'yyyy-MM-dd'. This date can be set to the current day or any day within the next 12 months.
548
+ * @property {string} - End date of the package's validity in the format 'yyyy-MM-dd'. End date can be maximum 90 days after Start date.
549
+ * @property {string} - Email address where the purchase confirmation email will be sent (including QR Code & activation steps)
550
+ * @property {string} - An identifier provided by the partner to link this purchase to their booking or transaction for analytics and debugging purposes.
551
+ * @property {string} - Customize the network brand of the issued eSIM. This parameter is accessible to platforms with Diamond tier and requires an alphanumeric string of up to 15 characters
552
+ * @property {number} - Epoch value representing the start time of the package's validity. This timestamp can be set to the current time or any time within the next 12 months.
553
+ * @property {number} - Epoch value representing the end time of the package's validity. End time can be maximum 90 days after Start time.
554
+ */
555
+ type CreatePurchaseRequest = z.infer<typeof createPurchaseRequest>;
556
+
557
+ /**
558
+ * The shape of the model inside the application code - what the users use
559
+ */
560
+ declare const createPurchaseOkResponse: z.ZodLazy<z.ZodObject<{
561
+ purchase: z.ZodOptional<z.ZodLazy<z.ZodObject<{
562
+ id: z.ZodOptional<z.ZodString>;
563
+ packageId: z.ZodOptional<z.ZodString>;
564
+ startDate: z.ZodOptional<z.ZodString>;
565
+ endDate: z.ZodOptional<z.ZodString>;
566
+ createdDate: z.ZodOptional<z.ZodString>;
567
+ startTime: z.ZodOptional<z.ZodNumber>;
568
+ endTime: z.ZodOptional<z.ZodNumber>;
569
+ }, "strip", z.ZodTypeAny, {
570
+ id?: string | undefined;
571
+ packageId?: string | undefined;
572
+ startDate?: string | undefined;
573
+ endDate?: string | undefined;
574
+ createdDate?: string | undefined;
575
+ startTime?: number | undefined;
576
+ endTime?: number | undefined;
577
+ }, {
578
+ id?: string | undefined;
579
+ packageId?: string | undefined;
580
+ startDate?: string | undefined;
581
+ endDate?: string | undefined;
582
+ createdDate?: string | undefined;
583
+ startTime?: number | undefined;
584
+ endTime?: number | undefined;
585
+ }>>>;
586
+ profile: z.ZodOptional<z.ZodLazy<z.ZodObject<{
587
+ iccid: z.ZodOptional<z.ZodString>;
588
+ activationCode: z.ZodOptional<z.ZodString>;
589
+ }, "strip", z.ZodTypeAny, {
590
+ iccid?: string | undefined;
591
+ activationCode?: string | undefined;
592
+ }, {
593
+ iccid?: string | undefined;
594
+ activationCode?: string | undefined;
595
+ }>>>;
596
+ }, "strip", z.ZodTypeAny, {
597
+ purchase?: {
598
+ id?: string | undefined;
599
+ packageId?: string | undefined;
600
+ startDate?: string | undefined;
601
+ endDate?: string | undefined;
602
+ createdDate?: string | undefined;
603
+ startTime?: number | undefined;
604
+ endTime?: number | undefined;
605
+ } | undefined;
606
+ profile?: {
607
+ iccid?: string | undefined;
608
+ activationCode?: string | undefined;
609
+ } | undefined;
610
+ }, {
611
+ purchase?: {
612
+ id?: string | undefined;
613
+ packageId?: string | undefined;
614
+ startDate?: string | undefined;
615
+ endDate?: string | undefined;
616
+ createdDate?: string | undefined;
617
+ startTime?: number | undefined;
618
+ endTime?: number | undefined;
619
+ } | undefined;
620
+ profile?: {
621
+ iccid?: string | undefined;
622
+ activationCode?: string | undefined;
623
+ } | undefined;
624
+ }>>;
625
+ /**
626
+ *
627
+ * @typedef {CreatePurchaseOkResponse} createPurchaseOkResponse
628
+ * @property {CreatePurchaseOkResponsePurchase}
629
+ * @property {CreatePurchaseOkResponseProfile}
630
+ */
631
+ type CreatePurchaseOkResponse = z.infer<typeof createPurchaseOkResponse>;
632
+
633
+ /**
634
+ * The shape of the model inside the application code - what the users use
635
+ */
636
+ declare const topUpEsimRequest: z.ZodLazy<z.ZodObject<{
637
+ iccid: z.ZodString;
638
+ dataLimitInGb: z.ZodNumber;
639
+ startDate: z.ZodString;
640
+ endDate: z.ZodString;
641
+ email: z.ZodOptional<z.ZodString>;
642
+ referenceId: z.ZodOptional<z.ZodString>;
643
+ startTime: z.ZodOptional<z.ZodNumber>;
644
+ endTime: z.ZodOptional<z.ZodNumber>;
645
+ }, "strip", z.ZodTypeAny, {
646
+ startDate: string;
647
+ endDate: string;
648
+ iccid: string;
649
+ dataLimitInGb: number;
650
+ email?: string | undefined;
651
+ referenceId?: string | undefined;
652
+ startTime?: number | undefined;
653
+ endTime?: number | undefined;
654
+ }, {
655
+ startDate: string;
656
+ endDate: string;
657
+ iccid: string;
658
+ dataLimitInGb: number;
659
+ email?: string | undefined;
660
+ referenceId?: string | undefined;
661
+ startTime?: number | undefined;
662
+ endTime?: number | undefined;
663
+ }>>;
664
+ /**
665
+ *
666
+ * @typedef {TopUpEsimRequest} topUpEsimRequest
667
+ * @property {string} - ID of the eSIM
668
+ * @property {number} - Size of the package in GB. The available options are 1, 2, 3, 5, 8, 20GB
669
+ * @property {string} - Start date of the package's validity in the format 'yyyy-MM-dd'. This date can be set to the current day or any day within the next 12 months.
670
+ * @property {string} - End date of the package's validity in the format 'yyyy-MM-dd'. End date can be maximum 90 days after Start date.
671
+ * @property {string} - Email address where the purchase confirmation email will be sent (excluding QR Code & activation steps)
672
+ * @property {string} - An identifier provided by the partner to link this purchase to their booking or transaction for analytics and debugging purposes.
673
+ * @property {number} - Epoch value representing the start time of the package's validity. This timestamp can be set to the current time or any time within the next 12 months.
674
+ * @property {number} - Epoch value representing the end time of the package's validity. End time can be maximum 90 days after Start time.
675
+ */
676
+ type TopUpEsimRequest = z.infer<typeof topUpEsimRequest>;
677
+
678
+ /**
679
+ * The shape of the model inside the application code - what the users use
680
+ */
681
+ declare const topUpEsimOkResponse: z.ZodLazy<z.ZodObject<{
682
+ purchase: z.ZodOptional<z.ZodLazy<z.ZodObject<{
683
+ id: z.ZodOptional<z.ZodString>;
684
+ packageId: z.ZodOptional<z.ZodString>;
685
+ startDate: z.ZodOptional<z.ZodString>;
686
+ endDate: z.ZodOptional<z.ZodString>;
687
+ createdDate: z.ZodOptional<z.ZodString>;
688
+ startTime: z.ZodOptional<z.ZodNumber>;
689
+ endTime: z.ZodOptional<z.ZodNumber>;
690
+ }, "strip", z.ZodTypeAny, {
691
+ id?: string | undefined;
692
+ packageId?: string | undefined;
693
+ startDate?: string | undefined;
694
+ endDate?: string | undefined;
695
+ createdDate?: string | undefined;
696
+ startTime?: number | undefined;
697
+ endTime?: number | undefined;
698
+ }, {
699
+ id?: string | undefined;
700
+ packageId?: string | undefined;
701
+ startDate?: string | undefined;
702
+ endDate?: string | undefined;
703
+ createdDate?: string | undefined;
704
+ startTime?: number | undefined;
705
+ endTime?: number | undefined;
706
+ }>>>;
707
+ profile: z.ZodOptional<z.ZodLazy<z.ZodObject<{
708
+ iccid: z.ZodOptional<z.ZodString>;
709
+ }, "strip", z.ZodTypeAny, {
710
+ iccid?: string | undefined;
711
+ }, {
712
+ iccid?: string | undefined;
713
+ }>>>;
714
+ }, "strip", z.ZodTypeAny, {
715
+ purchase?: {
716
+ id?: string | undefined;
717
+ packageId?: string | undefined;
718
+ startDate?: string | undefined;
719
+ endDate?: string | undefined;
720
+ createdDate?: string | undefined;
721
+ startTime?: number | undefined;
722
+ endTime?: number | undefined;
723
+ } | undefined;
724
+ profile?: {
725
+ iccid?: string | undefined;
726
+ } | undefined;
727
+ }, {
728
+ purchase?: {
729
+ id?: string | undefined;
730
+ packageId?: string | undefined;
731
+ startDate?: string | undefined;
732
+ endDate?: string | undefined;
733
+ createdDate?: string | undefined;
734
+ startTime?: number | undefined;
735
+ endTime?: number | undefined;
736
+ } | undefined;
737
+ profile?: {
738
+ iccid?: string | undefined;
739
+ } | undefined;
740
+ }>>;
741
+ /**
742
+ *
743
+ * @typedef {TopUpEsimOkResponse} topUpEsimOkResponse
744
+ * @property {TopUpEsimOkResponsePurchase}
745
+ * @property {TopUpEsimOkResponseProfile}
746
+ */
747
+ type TopUpEsimOkResponse = z.infer<typeof topUpEsimOkResponse>;
748
+
749
+ /**
750
+ * The shape of the model inside the application code - what the users use
751
+ */
752
+ declare const editPurchaseRequest: z.ZodLazy<z.ZodObject<{
753
+ purchaseId: z.ZodString;
754
+ startDate: z.ZodString;
755
+ endDate: z.ZodString;
756
+ startTime: z.ZodOptional<z.ZodNumber>;
757
+ endTime: z.ZodOptional<z.ZodNumber>;
758
+ }, "strip", z.ZodTypeAny, {
759
+ startDate: string;
760
+ endDate: string;
761
+ purchaseId: string;
762
+ startTime?: number | undefined;
763
+ endTime?: number | undefined;
764
+ }, {
765
+ startDate: string;
766
+ endDate: string;
767
+ purchaseId: string;
768
+ startTime?: number | undefined;
769
+ endTime?: number | undefined;
770
+ }>>;
771
+ /**
772
+ *
773
+ * @typedef {EditPurchaseRequest} editPurchaseRequest
774
+ * @property {string} - ID of the purchase
775
+ * @property {string} - Start date of the package's validity in the format 'yyyy-MM-dd'. This date can be set to the current day or any day within the next 12 months.
776
+ * @property {string} - End date of the package's validity in the format 'yyyy-MM-dd'. End date can be maximum 90 days after Start date.
777
+ * @property {number} - Epoch value representing the start time of the package's validity. This timestamp can be set to the current time or any time within the next 12 months.
778
+ * @property {number} - Epoch value representing the end time of the package's validity. End time can be maximum 90 days after Start time.
779
+ */
780
+ type EditPurchaseRequest = z.infer<typeof editPurchaseRequest>;
781
+
782
+ /**
783
+ * The shape of the model inside the application code - what the users use
784
+ */
785
+ declare const editPurchaseOkResponse: z.ZodLazy<z.ZodObject<{
786
+ purchaseId: z.ZodOptional<z.ZodString>;
787
+ newStartDate: z.ZodOptional<z.ZodString>;
788
+ newEndDate: z.ZodOptional<z.ZodString>;
789
+ newStartTime: z.ZodOptional<z.ZodNumber>;
790
+ newEndTime: z.ZodOptional<z.ZodNumber>;
791
+ }, "strip", z.ZodTypeAny, {
792
+ purchaseId?: string | undefined;
793
+ newStartDate?: string | undefined;
794
+ newEndDate?: string | undefined;
795
+ newStartTime?: number | undefined;
796
+ newEndTime?: number | undefined;
797
+ }, {
798
+ purchaseId?: string | undefined;
799
+ newStartDate?: string | undefined;
800
+ newEndDate?: string | undefined;
801
+ newStartTime?: number | undefined;
802
+ newEndTime?: number | undefined;
803
+ }>>;
804
+ /**
805
+ *
806
+ * @typedef {EditPurchaseOkResponse} editPurchaseOkResponse
807
+ * @property {string} - ID of the purchase
808
+ * @property {string} - Start date of the package's validity in the format 'yyyy-MM-ddThh:mm:ssZZ'
809
+ * @property {string} - End date of the package's validity in the format 'yyyy-MM-ddThh:mm:ssZZ'
810
+ * @property {number} - Epoch value representing the new start time of the package's validity
811
+ * @property {number} - Epoch value representing the new end time of the package's validity
812
+ */
813
+ type EditPurchaseOkResponse = z.infer<typeof editPurchaseOkResponse>;
814
+
815
+ /**
816
+ * The shape of the model inside the application code - what the users use
817
+ */
818
+ declare const getPurchaseConsumptionOkResponse: z.ZodLazy<z.ZodObject<{
819
+ dataUsageRemainingInBytes: z.ZodOptional<z.ZodNumber>;
820
+ status: z.ZodOptional<z.ZodString>;
821
+ }, "strip", z.ZodTypeAny, {
822
+ dataUsageRemainingInBytes?: number | undefined;
823
+ status?: string | undefined;
824
+ }, {
825
+ dataUsageRemainingInBytes?: number | undefined;
826
+ status?: string | undefined;
827
+ }>>;
828
+ /**
829
+ *
830
+ * @typedef {GetPurchaseConsumptionOkResponse} getPurchaseConsumptionOkResponse
831
+ * @property {number} - Remaining balance of the package in bytes
832
+ * @property {string} - Status of the connectivity, possible values are 'ACTIVE' or 'NOT_ACTIVE'
833
+ */
834
+ type GetPurchaseConsumptionOkResponse = z.infer<typeof getPurchaseConsumptionOkResponse>;
835
+
836
+ declare class PurchasesService extends BaseService {
837
+ /**
838
+ * This endpoint can be used to list all the successful purchases made between a given interval.
839
+ * @param {string} [iccid] - ID of the eSIM
840
+ * @param {string} [afterDate] - Start date of the interval for filtering purchases in the format 'yyyy-MM-dd'
841
+ * @param {string} [beforeDate] - End date of the interval for filtering purchases in the format 'yyyy-MM-dd'
842
+ * @param {string} [referenceId] - The referenceId that was provided by the partner during the purchase or topup flow.
843
+ * @param {string} [afterCursor] - To get the next batch of results, use this parameter. It tells the API where to start fetching data after the last item you received. It helps you avoid repeats and efficiently browse through large sets of data.
844
+ * @param {number} [limit] - Maximum number of purchases to be returned in the response. The value must be greater than 0 and less than or equal to 100. If not provided, the default value is 20
845
+ * @param {number} [after] - Epoch value representing the start of the time interval for filtering purchases
846
+ * @param {number} [before] - Epoch value representing the end of the time interval for filtering purchases
847
+ * @returns {Promise<HttpResponse<ListPurchasesOkResponse>>} Successful Response
848
+ */
849
+ listPurchases(params?: ListPurchasesParams, requestConfig?: RequestConfig): Promise<HttpResponse<ListPurchasesOkResponse>>;
850
+ /**
851
+ * This endpoint is used to purchase a new eSIM by providing the package details.
852
+ * @returns {Promise<HttpResponse<CreatePurchaseOkResponse>>} Successful Response
853
+ */
854
+ createPurchase(body: CreatePurchaseRequest, requestConfig?: RequestConfig): Promise<HttpResponse<CreatePurchaseOkResponse>>;
855
+ /**
856
+ * This endpoint is used to top-up an eSIM with the previously associated destination by providing an existing ICCID and the package details. The top-up is not feasible for eSIMs in "DELETED" or "ERROR" state.
857
+ * @returns {Promise<HttpResponse<TopUpEsimOkResponse>>} Successful Response
858
+ */
859
+ topUpEsim(body: TopUpEsimRequest, requestConfig?: RequestConfig): Promise<HttpResponse<TopUpEsimOkResponse>>;
860
+ /**
861
+ * This endpoint allows you to modify the dates of an existing package with a future activation start time. Editing can only be performed for packages that have not been activated, and it cannot change the package size. The modification must not change the package duration category to ensure pricing consistency.
862
+ * @returns {Promise<HttpResponse<EditPurchaseOkResponse>>} Successful Response
863
+ */
864
+ editPurchase(body: EditPurchaseRequest, requestConfig?: RequestConfig): Promise<HttpResponse<EditPurchaseOkResponse>>;
865
+ /**
866
+ * This endpoint can be called for consumption notifications (e.g. every 1 hour or when the user clicks a button). It returns the data balance (consumption) of purchased packages.
867
+ * @param {string} purchaseId - ID of the purchase
868
+ * @returns {Promise<HttpResponse<GetPurchaseConsumptionOkResponse>>} Successful Response
869
+ */
870
+ getPurchaseConsumption(purchaseId: string, requestConfig?: RequestConfig): Promise<HttpResponse<GetPurchaseConsumptionOkResponse>>;
871
+ }
872
+
873
+ /**
874
+ * The shape of the model inside the application code - what the users use
875
+ */
876
+ declare const purchases: z.ZodLazy<z.ZodObject<{
877
+ id: z.ZodOptional<z.ZodString>;
878
+ startDate: z.ZodOptional<z.ZodString>;
879
+ endDate: z.ZodOptional<z.ZodString>;
880
+ createdDate: z.ZodOptional<z.ZodString>;
881
+ startTime: z.ZodOptional<z.ZodNumber>;
882
+ endTime: z.ZodOptional<z.ZodNumber>;
883
+ createdAt: z.ZodOptional<z.ZodNumber>;
884
+ package: z.ZodOptional<z.ZodLazy<z.ZodObject<{
885
+ id: z.ZodOptional<z.ZodString>;
886
+ dataLimitInBytes: z.ZodOptional<z.ZodNumber>;
887
+ destination: z.ZodOptional<z.ZodString>;
888
+ destinationName: z.ZodOptional<z.ZodString>;
889
+ priceInCents: z.ZodOptional<z.ZodNumber>;
890
+ }, "strip", z.ZodTypeAny, {
891
+ id?: string | undefined;
892
+ dataLimitInBytes?: number | undefined;
893
+ destination?: string | undefined;
894
+ destinationName?: string | undefined;
895
+ priceInCents?: number | undefined;
896
+ }, {
897
+ id?: string | undefined;
898
+ dataLimitInBytes?: number | undefined;
899
+ destination?: string | undefined;
900
+ destinationName?: string | undefined;
901
+ priceInCents?: number | undefined;
902
+ }>>>;
903
+ esim: z.ZodOptional<z.ZodLazy<z.ZodObject<{
904
+ iccid: z.ZodOptional<z.ZodString>;
905
+ }, "strip", z.ZodTypeAny, {
906
+ iccid?: string | undefined;
907
+ }, {
908
+ iccid?: string | undefined;
909
+ }>>>;
910
+ source: z.ZodOptional<z.ZodString>;
911
+ referenceId: z.ZodOptional<z.ZodString>;
912
+ }, "strip", z.ZodTypeAny, {
913
+ id?: string | undefined;
914
+ startDate?: string | undefined;
915
+ endDate?: string | undefined;
916
+ createdDate?: string | undefined;
917
+ startTime?: number | undefined;
918
+ endTime?: number | undefined;
919
+ createdAt?: number | undefined;
920
+ package?: {
921
+ id?: string | undefined;
922
+ dataLimitInBytes?: number | undefined;
923
+ destination?: string | undefined;
924
+ destinationName?: string | undefined;
925
+ priceInCents?: number | undefined;
926
+ } | undefined;
927
+ esim?: {
928
+ iccid?: string | undefined;
929
+ } | undefined;
930
+ source?: string | undefined;
931
+ referenceId?: string | undefined;
932
+ }, {
933
+ id?: string | undefined;
934
+ startDate?: string | undefined;
935
+ endDate?: string | undefined;
936
+ createdDate?: string | undefined;
937
+ startTime?: number | undefined;
938
+ endTime?: number | undefined;
939
+ createdAt?: number | undefined;
940
+ package?: {
941
+ id?: string | undefined;
942
+ dataLimitInBytes?: number | undefined;
943
+ destination?: string | undefined;
944
+ destinationName?: string | undefined;
945
+ priceInCents?: number | undefined;
946
+ } | undefined;
947
+ esim?: {
948
+ iccid?: string | undefined;
949
+ } | undefined;
950
+ source?: string | undefined;
951
+ referenceId?: string | undefined;
952
+ }>>;
953
+ /**
954
+ *
955
+ * @typedef {Purchases} purchases
956
+ * @property {string} - ID of the purchase
957
+ * @property {string} - Start date of the package's validity in the format 'yyyy-MM-ddThh:mm:ssZZ'
958
+ * @property {string} - End date of the package's validity in the format 'yyyy-MM-ddThh:mm:ssZZ'
959
+ * @property {string} - Creation date of the purchase in the format 'yyyy-MM-ddThh:mm:ssZZ'
960
+ * @property {number} - Epoch value representing the start time of the package's validity
961
+ * @property {number} - Epoch value representing the end time of the package's validity
962
+ * @property {number} - Epoch value representing the date of creation of the purchase
963
+ * @property {Package_}
964
+ * @property {PurchasesEsim}
965
+ * @property {string} - The source indicates where the eSIM was purchased, which can be from the API, dashboard, landing-page or promo-page. For purchases made before September 8, 2023, the value will be displayed as 'Not available'.
966
+ * @property {string} - The referenceId that was provided by the partner during the purchase or topup flow. This identifier can be used for analytics and debugging purposes.
967
+ */
968
+ type Purchases = z.infer<typeof purchases>;
969
+
970
+ /**
971
+ * The shape of the model inside the application code - what the users use
972
+ */
973
+ declare const package_: z.ZodLazy<z.ZodObject<{
974
+ id: z.ZodOptional<z.ZodString>;
975
+ dataLimitInBytes: z.ZodOptional<z.ZodNumber>;
976
+ destination: z.ZodOptional<z.ZodString>;
977
+ destinationName: z.ZodOptional<z.ZodString>;
978
+ priceInCents: z.ZodOptional<z.ZodNumber>;
979
+ }, "strip", z.ZodTypeAny, {
980
+ id?: string | undefined;
981
+ dataLimitInBytes?: number | undefined;
982
+ destination?: string | undefined;
983
+ destinationName?: string | undefined;
984
+ priceInCents?: number | undefined;
985
+ }, {
986
+ id?: string | undefined;
987
+ dataLimitInBytes?: number | undefined;
988
+ destination?: string | undefined;
989
+ destinationName?: string | undefined;
990
+ priceInCents?: number | undefined;
991
+ }>>;
992
+ /**
993
+ *
994
+ * @typedef {Package_} package_
995
+ * @property {string} - ID of the package
996
+ * @property {number} - Size of the package in Bytes
997
+ * @property {string} - ISO representation of the package's destination
998
+ * @property {string} - Name of the package's destination
999
+ * @property {number} - Price of the package in cents
1000
+ */
1001
+ type Package_ = z.infer<typeof package_>;
1002
+
1003
+ /**
1004
+ * The shape of the model inside the application code - what the users use
1005
+ */
1006
+ declare const purchasesEsim: z.ZodLazy<z.ZodObject<{
1007
+ iccid: z.ZodOptional<z.ZodString>;
1008
+ }, "strip", z.ZodTypeAny, {
1009
+ iccid?: string | undefined;
1010
+ }, {
1011
+ iccid?: string | undefined;
1012
+ }>>;
1013
+ /**
1014
+ *
1015
+ * @typedef {PurchasesEsim} purchasesEsim
1016
+ * @property {string} - ID of the eSIM
1017
+ */
1018
+ type PurchasesEsim = z.infer<typeof purchasesEsim>;
1019
+
1020
+ /**
1021
+ * The shape of the model inside the application code - what the users use
1022
+ */
1023
+ declare const createPurchaseOkResponsePurchase: z.ZodLazy<z.ZodObject<{
1024
+ id: z.ZodOptional<z.ZodString>;
1025
+ packageId: z.ZodOptional<z.ZodString>;
1026
+ startDate: z.ZodOptional<z.ZodString>;
1027
+ endDate: z.ZodOptional<z.ZodString>;
1028
+ createdDate: z.ZodOptional<z.ZodString>;
1029
+ startTime: z.ZodOptional<z.ZodNumber>;
1030
+ endTime: z.ZodOptional<z.ZodNumber>;
1031
+ }, "strip", z.ZodTypeAny, {
1032
+ id?: string | undefined;
1033
+ packageId?: string | undefined;
1034
+ startDate?: string | undefined;
1035
+ endDate?: string | undefined;
1036
+ createdDate?: string | undefined;
1037
+ startTime?: number | undefined;
1038
+ endTime?: number | undefined;
1039
+ }, {
1040
+ id?: string | undefined;
1041
+ packageId?: string | undefined;
1042
+ startDate?: string | undefined;
1043
+ endDate?: string | undefined;
1044
+ createdDate?: string | undefined;
1045
+ startTime?: number | undefined;
1046
+ endTime?: number | undefined;
1047
+ }>>;
1048
+ /**
1049
+ *
1050
+ * @typedef {CreatePurchaseOkResponsePurchase} createPurchaseOkResponsePurchase
1051
+ * @property {string} - ID of the purchase
1052
+ * @property {string} - ID of the package
1053
+ * @property {string} - Start date of the package's validity in the format 'yyyy-MM-ddThh:mm:ssZZ'
1054
+ * @property {string} - End date of the package's validity in the format 'yyyy-MM-ddThh:mm:ssZZ'
1055
+ * @property {string} - Creation date of the purchase in the format 'yyyy-MM-ddThh:mm:ssZZ'
1056
+ * @property {number} - Epoch value representing the start time of the package's validity
1057
+ * @property {number} - Epoch value representing the end time of the package's validity
1058
+ */
1059
+ type CreatePurchaseOkResponsePurchase = z.infer<typeof createPurchaseOkResponsePurchase>;
1060
+
1061
+ /**
1062
+ * The shape of the model inside the application code - what the users use
1063
+ */
1064
+ declare const createPurchaseOkResponseProfile: z.ZodLazy<z.ZodObject<{
1065
+ iccid: z.ZodOptional<z.ZodString>;
1066
+ activationCode: z.ZodOptional<z.ZodString>;
1067
+ }, "strip", z.ZodTypeAny, {
1068
+ iccid?: string | undefined;
1069
+ activationCode?: string | undefined;
1070
+ }, {
1071
+ iccid?: string | undefined;
1072
+ activationCode?: string | undefined;
1073
+ }>>;
1074
+ /**
1075
+ *
1076
+ * @typedef {CreatePurchaseOkResponseProfile} createPurchaseOkResponseProfile
1077
+ * @property {string} - ID of the eSIM
1078
+ * @property {string} - QR Code of the eSIM as base64
1079
+ */
1080
+ type CreatePurchaseOkResponseProfile = z.infer<typeof createPurchaseOkResponseProfile>;
1081
+
1082
+ /**
1083
+ * The shape of the model inside the application code - what the users use
1084
+ */
1085
+ declare const topUpEsimOkResponsePurchase: z.ZodLazy<z.ZodObject<{
1086
+ id: z.ZodOptional<z.ZodString>;
1087
+ packageId: z.ZodOptional<z.ZodString>;
1088
+ startDate: z.ZodOptional<z.ZodString>;
1089
+ endDate: z.ZodOptional<z.ZodString>;
1090
+ createdDate: z.ZodOptional<z.ZodString>;
1091
+ startTime: z.ZodOptional<z.ZodNumber>;
1092
+ endTime: z.ZodOptional<z.ZodNumber>;
1093
+ }, "strip", z.ZodTypeAny, {
1094
+ id?: string | undefined;
1095
+ packageId?: string | undefined;
1096
+ startDate?: string | undefined;
1097
+ endDate?: string | undefined;
1098
+ createdDate?: string | undefined;
1099
+ startTime?: number | undefined;
1100
+ endTime?: number | undefined;
1101
+ }, {
1102
+ id?: string | undefined;
1103
+ packageId?: string | undefined;
1104
+ startDate?: string | undefined;
1105
+ endDate?: string | undefined;
1106
+ createdDate?: string | undefined;
1107
+ startTime?: number | undefined;
1108
+ endTime?: number | undefined;
1109
+ }>>;
1110
+ /**
1111
+ *
1112
+ * @typedef {TopUpEsimOkResponsePurchase} topUpEsimOkResponsePurchase
1113
+ * @property {string} - ID of the purchase
1114
+ * @property {string} - ID of the package
1115
+ * @property {string} - Start date of the package's validity in the format 'yyyy-MM-ddThh:mm:ssZZ'
1116
+ * @property {string} - End date of the package's validity in the format 'yyyy-MM-ddThh:mm:ssZZ'
1117
+ * @property {string} - Creation date of the purchase in the format 'yyyy-MM-ddThh:mm:ssZZ'
1118
+ * @property {number} - Epoch value representing the start time of the package's validity
1119
+ * @property {number} - Epoch value representing the end time of the package's validity
1120
+ */
1121
+ type TopUpEsimOkResponsePurchase = z.infer<typeof topUpEsimOkResponsePurchase>;
1122
+
1123
+ /**
1124
+ * The shape of the model inside the application code - what the users use
1125
+ */
1126
+ declare const topUpEsimOkResponseProfile: z.ZodLazy<z.ZodObject<{
1127
+ iccid: z.ZodOptional<z.ZodString>;
1128
+ }, "strip", z.ZodTypeAny, {
1129
+ iccid?: string | undefined;
1130
+ }, {
1131
+ iccid?: string | undefined;
1132
+ }>>;
1133
+ /**
1134
+ *
1135
+ * @typedef {TopUpEsimOkResponseProfile} topUpEsimOkResponseProfile
1136
+ * @property {string} - ID of the eSIM
1137
+ */
1138
+ type TopUpEsimOkResponseProfile = z.infer<typeof topUpEsimOkResponseProfile>;
1139
+
1140
+ /**
1141
+ * The shape of the model inside the application code - what the users use
1142
+ */
1143
+ declare const getEsimOkResponse: z.ZodLazy<z.ZodObject<{
1144
+ esim: z.ZodOptional<z.ZodLazy<z.ZodObject<{
1145
+ iccid: z.ZodOptional<z.ZodString>;
1146
+ smdpAddress: z.ZodOptional<z.ZodString>;
1147
+ manualActivationCode: z.ZodOptional<z.ZodString>;
1148
+ status: z.ZodOptional<z.ZodString>;
1149
+ }, "strip", z.ZodTypeAny, {
1150
+ iccid?: string | undefined;
1151
+ smdpAddress?: string | undefined;
1152
+ manualActivationCode?: string | undefined;
1153
+ status?: string | undefined;
1154
+ }, {
1155
+ iccid?: string | undefined;
1156
+ smdpAddress?: string | undefined;
1157
+ manualActivationCode?: string | undefined;
1158
+ status?: string | undefined;
1159
+ }>>>;
1160
+ }, "strip", z.ZodTypeAny, {
1161
+ esim?: {
1162
+ iccid?: string | undefined;
1163
+ smdpAddress?: string | undefined;
1164
+ manualActivationCode?: string | undefined;
1165
+ status?: string | undefined;
1166
+ } | undefined;
1167
+ }, {
1168
+ esim?: {
1169
+ iccid?: string | undefined;
1170
+ smdpAddress?: string | undefined;
1171
+ manualActivationCode?: string | undefined;
1172
+ status?: string | undefined;
1173
+ } | undefined;
1174
+ }>>;
1175
+ /**
1176
+ *
1177
+ * @typedef {GetEsimOkResponse} getEsimOkResponse
1178
+ * @property {GetEsimOkResponseEsim}
1179
+ */
1180
+ type GetEsimOkResponse = z.infer<typeof getEsimOkResponse>;
1181
+
1182
+ interface GetEsimParams {
1183
+ iccid: string;
1184
+ }
1185
+
1186
+ /**
1187
+ * The shape of the model inside the application code - what the users use
1188
+ */
1189
+ declare const getEsimDeviceOkResponse: z.ZodLazy<z.ZodObject<{
1190
+ device: z.ZodOptional<z.ZodLazy<z.ZodObject<{
1191
+ oem: z.ZodOptional<z.ZodString>;
1192
+ hardwareName: z.ZodOptional<z.ZodString>;
1193
+ hardwareModel: z.ZodOptional<z.ZodString>;
1194
+ eid: z.ZodOptional<z.ZodString>;
1195
+ }, "strip", z.ZodTypeAny, {
1196
+ oem?: string | undefined;
1197
+ hardwareName?: string | undefined;
1198
+ hardwareModel?: string | undefined;
1199
+ eid?: string | undefined;
1200
+ }, {
1201
+ oem?: string | undefined;
1202
+ hardwareName?: string | undefined;
1203
+ hardwareModel?: string | undefined;
1204
+ eid?: string | undefined;
1205
+ }>>>;
1206
+ }, "strip", z.ZodTypeAny, {
1207
+ device?: {
1208
+ oem?: string | undefined;
1209
+ hardwareName?: string | undefined;
1210
+ hardwareModel?: string | undefined;
1211
+ eid?: string | undefined;
1212
+ } | undefined;
1213
+ }, {
1214
+ device?: {
1215
+ oem?: string | undefined;
1216
+ hardwareName?: string | undefined;
1217
+ hardwareModel?: string | undefined;
1218
+ eid?: string | undefined;
1219
+ } | undefined;
1220
+ }>>;
1221
+ /**
1222
+ *
1223
+ * @typedef {GetEsimDeviceOkResponse} getEsimDeviceOkResponse
1224
+ * @property {Device}
1225
+ */
1226
+ type GetEsimDeviceOkResponse = z.infer<typeof getEsimDeviceOkResponse>;
1227
+
1228
+ /**
1229
+ * The shape of the model inside the application code - what the users use
1230
+ */
1231
+ declare const getEsimHistoryOkResponse: z.ZodLazy<z.ZodObject<{
1232
+ esim: z.ZodOptional<z.ZodLazy<z.ZodObject<{
1233
+ iccid: z.ZodOptional<z.ZodString>;
1234
+ history: z.ZodOptional<z.ZodArray<z.ZodLazy<z.ZodObject<{
1235
+ status: z.ZodOptional<z.ZodString>;
1236
+ statusDate: z.ZodOptional<z.ZodString>;
1237
+ date: z.ZodOptional<z.ZodNumber>;
1238
+ }, "strip", z.ZodTypeAny, {
1239
+ status?: string | undefined;
1240
+ statusDate?: string | undefined;
1241
+ date?: number | undefined;
1242
+ }, {
1243
+ status?: string | undefined;
1244
+ statusDate?: string | undefined;
1245
+ date?: number | undefined;
1246
+ }>>, "many">>;
1247
+ }, "strip", z.ZodTypeAny, {
1248
+ iccid?: string | undefined;
1249
+ history?: {
1250
+ status?: string | undefined;
1251
+ statusDate?: string | undefined;
1252
+ date?: number | undefined;
1253
+ }[] | undefined;
1254
+ }, {
1255
+ iccid?: string | undefined;
1256
+ history?: {
1257
+ status?: string | undefined;
1258
+ statusDate?: string | undefined;
1259
+ date?: number | undefined;
1260
+ }[] | undefined;
1261
+ }>>>;
1262
+ }, "strip", z.ZodTypeAny, {
1263
+ esim?: {
1264
+ iccid?: string | undefined;
1265
+ history?: {
1266
+ status?: string | undefined;
1267
+ statusDate?: string | undefined;
1268
+ date?: number | undefined;
1269
+ }[] | undefined;
1270
+ } | undefined;
1271
+ }, {
1272
+ esim?: {
1273
+ iccid?: string | undefined;
1274
+ history?: {
1275
+ status?: string | undefined;
1276
+ statusDate?: string | undefined;
1277
+ date?: number | undefined;
1278
+ }[] | undefined;
1279
+ } | undefined;
1280
+ }>>;
1281
+ /**
1282
+ *
1283
+ * @typedef {GetEsimHistoryOkResponse} getEsimHistoryOkResponse
1284
+ * @property {GetEsimHistoryOkResponseEsim}
1285
+ */
1286
+ type GetEsimHistoryOkResponse = z.infer<typeof getEsimHistoryOkResponse>;
1287
+
1288
+ /**
1289
+ * The shape of the model inside the application code - what the users use
1290
+ */
1291
+ declare const getEsimMacOkResponse: z.ZodLazy<z.ZodObject<{
1292
+ esim: z.ZodOptional<z.ZodLazy<z.ZodObject<{
1293
+ iccid: z.ZodOptional<z.ZodString>;
1294
+ smdpAddress: z.ZodOptional<z.ZodString>;
1295
+ manualActivationCode: z.ZodOptional<z.ZodString>;
1296
+ }, "strip", z.ZodTypeAny, {
1297
+ iccid?: string | undefined;
1298
+ smdpAddress?: string | undefined;
1299
+ manualActivationCode?: string | undefined;
1300
+ }, {
1301
+ iccid?: string | undefined;
1302
+ smdpAddress?: string | undefined;
1303
+ manualActivationCode?: string | undefined;
1304
+ }>>>;
1305
+ }, "strip", z.ZodTypeAny, {
1306
+ esim?: {
1307
+ iccid?: string | undefined;
1308
+ smdpAddress?: string | undefined;
1309
+ manualActivationCode?: string | undefined;
1310
+ } | undefined;
1311
+ }, {
1312
+ esim?: {
1313
+ iccid?: string | undefined;
1314
+ smdpAddress?: string | undefined;
1315
+ manualActivationCode?: string | undefined;
1316
+ } | undefined;
1317
+ }>>;
1318
+ /**
1319
+ *
1320
+ * @typedef {GetEsimMacOkResponse} getEsimMacOkResponse
1321
+ * @property {GetEsimMacOkResponseEsim}
1322
+ */
1323
+ type GetEsimMacOkResponse = z.infer<typeof getEsimMacOkResponse>;
1324
+
1325
+ declare class ESimService extends BaseService {
1326
+ /**
1327
+ * Get eSIM Status
1328
+ * @param {string} iccid - ID of the eSIM
1329
+ * @returns {Promise<HttpResponse<GetEsimOkResponse>>} Successful Response
1330
+ */
1331
+ getEsim(params: GetEsimParams, requestConfig?: RequestConfig): Promise<HttpResponse<GetEsimOkResponse>>;
1332
+ /**
1333
+ * Get eSIM Device
1334
+ * @param {string} iccid - ID of the eSIM
1335
+ * @returns {Promise<HttpResponse<GetEsimDeviceOkResponse>>} Successful Response
1336
+ */
1337
+ getEsimDevice(iccid: string, requestConfig?: RequestConfig): Promise<HttpResponse<GetEsimDeviceOkResponse>>;
1338
+ /**
1339
+ * Get eSIM History
1340
+ * @param {string} iccid - ID of the eSIM
1341
+ * @returns {Promise<HttpResponse<GetEsimHistoryOkResponse>>} Successful Response
1342
+ */
1343
+ getEsimHistory(iccid: string, requestConfig?: RequestConfig): Promise<HttpResponse<GetEsimHistoryOkResponse>>;
1344
+ /**
1345
+ * Get eSIM MAC
1346
+ * @param {string} iccid - ID of the eSIM
1347
+ * @returns {Promise<HttpResponse<GetEsimMacOkResponse>>} Successful Response
1348
+ */
1349
+ getEsimMac(iccid: string, requestConfig?: RequestConfig): Promise<HttpResponse<GetEsimMacOkResponse>>;
1350
+ }
1351
+
1352
+ /**
1353
+ * The shape of the model inside the application code - what the users use
1354
+ */
1355
+ declare const getEsimOkResponseEsim: z.ZodLazy<z.ZodObject<{
1356
+ iccid: z.ZodOptional<z.ZodString>;
1357
+ smdpAddress: z.ZodOptional<z.ZodString>;
1358
+ manualActivationCode: z.ZodOptional<z.ZodString>;
1359
+ status: z.ZodOptional<z.ZodString>;
1360
+ }, "strip", z.ZodTypeAny, {
1361
+ iccid?: string | undefined;
1362
+ smdpAddress?: string | undefined;
1363
+ manualActivationCode?: string | undefined;
1364
+ status?: string | undefined;
1365
+ }, {
1366
+ iccid?: string | undefined;
1367
+ smdpAddress?: string | undefined;
1368
+ manualActivationCode?: string | undefined;
1369
+ status?: string | undefined;
1370
+ }>>;
1371
+ /**
1372
+ *
1373
+ * @typedef {GetEsimOkResponseEsim} getEsimOkResponseEsim
1374
+ * @property {string} - ID of the eSIM
1375
+ * @property {string} - SM-DP+ Address
1376
+ * @property {string} - The manual activation code
1377
+ * @property {string} - Status of the eSIM, possible values are 'RELEASED', 'DOWNLOADED', 'INSTALLED', 'ENABLED', 'DELETED', or 'ERROR'
1378
+ */
1379
+ type GetEsimOkResponseEsim = z.infer<typeof getEsimOkResponseEsim>;
1380
+
1381
+ /**
1382
+ * The shape of the model inside the application code - what the users use
1383
+ */
1384
+ declare const device: z.ZodLazy<z.ZodObject<{
1385
+ oem: z.ZodOptional<z.ZodString>;
1386
+ hardwareName: z.ZodOptional<z.ZodString>;
1387
+ hardwareModel: z.ZodOptional<z.ZodString>;
1388
+ eid: z.ZodOptional<z.ZodString>;
1389
+ }, "strip", z.ZodTypeAny, {
1390
+ oem?: string | undefined;
1391
+ hardwareName?: string | undefined;
1392
+ hardwareModel?: string | undefined;
1393
+ eid?: string | undefined;
1394
+ }, {
1395
+ oem?: string | undefined;
1396
+ hardwareName?: string | undefined;
1397
+ hardwareModel?: string | undefined;
1398
+ eid?: string | undefined;
1399
+ }>>;
1400
+ /**
1401
+ *
1402
+ * @typedef {Device} device
1403
+ * @property {string} - Name of the OEM
1404
+ * @property {string} - Name of the Device
1405
+ * @property {string} - Model of the Device
1406
+ * @property {string} - Serial Number of the eSIM
1407
+ */
1408
+ type Device = z.infer<typeof device>;
1409
+
1410
+ /**
1411
+ * The shape of the model inside the application code - what the users use
1412
+ */
1413
+ declare const getEsimHistoryOkResponseEsim: z.ZodLazy<z.ZodObject<{
1414
+ iccid: z.ZodOptional<z.ZodString>;
1415
+ history: z.ZodOptional<z.ZodArray<z.ZodLazy<z.ZodObject<{
1416
+ status: z.ZodOptional<z.ZodString>;
1417
+ statusDate: z.ZodOptional<z.ZodString>;
1418
+ date: z.ZodOptional<z.ZodNumber>;
1419
+ }, "strip", z.ZodTypeAny, {
1420
+ status?: string | undefined;
1421
+ statusDate?: string | undefined;
1422
+ date?: number | undefined;
1423
+ }, {
1424
+ status?: string | undefined;
1425
+ statusDate?: string | undefined;
1426
+ date?: number | undefined;
1427
+ }>>, "many">>;
1428
+ }, "strip", z.ZodTypeAny, {
1429
+ iccid?: string | undefined;
1430
+ history?: {
1431
+ status?: string | undefined;
1432
+ statusDate?: string | undefined;
1433
+ date?: number | undefined;
1434
+ }[] | undefined;
1435
+ }, {
1436
+ iccid?: string | undefined;
1437
+ history?: {
1438
+ status?: string | undefined;
1439
+ statusDate?: string | undefined;
1440
+ date?: number | undefined;
1441
+ }[] | undefined;
1442
+ }>>;
1443
+ /**
1444
+ *
1445
+ * @typedef {GetEsimHistoryOkResponseEsim} getEsimHistoryOkResponseEsim
1446
+ * @property {string} - ID of the eSIM
1447
+ * @property {History[]}
1448
+ */
1449
+ type GetEsimHistoryOkResponseEsim = z.infer<typeof getEsimHistoryOkResponseEsim>;
1450
+
1451
+ /**
1452
+ * The shape of the model inside the application code - what the users use
1453
+ */
1454
+ declare const history: z.ZodLazy<z.ZodObject<{
1455
+ status: z.ZodOptional<z.ZodString>;
1456
+ statusDate: z.ZodOptional<z.ZodString>;
1457
+ date: z.ZodOptional<z.ZodNumber>;
1458
+ }, "strip", z.ZodTypeAny, {
1459
+ status?: string | undefined;
1460
+ statusDate?: string | undefined;
1461
+ date?: number | undefined;
1462
+ }, {
1463
+ status?: string | undefined;
1464
+ statusDate?: string | undefined;
1465
+ date?: number | undefined;
1466
+ }>>;
1467
+ /**
1468
+ *
1469
+ * @typedef {History} history
1470
+ * @property {string} - The status of the eSIM at a given time, possible values are 'RELEASED', 'DOWNLOADED', 'INSTALLED', 'ENABLED', 'DELETED', or 'ERROR'
1471
+ * @property {string} - The date when the eSIM status changed in the format 'yyyy-MM-ddThh:mm:ssZZ'
1472
+ * @property {number} - Epoch value representing the date when the eSIM status changed
1473
+ */
1474
+ type History = z.infer<typeof history>;
1475
+
1476
+ /**
1477
+ * The shape of the model inside the application code - what the users use
1478
+ */
1479
+ declare const getEsimMacOkResponseEsim: z.ZodLazy<z.ZodObject<{
1480
+ iccid: z.ZodOptional<z.ZodString>;
1481
+ smdpAddress: z.ZodOptional<z.ZodString>;
1482
+ manualActivationCode: z.ZodOptional<z.ZodString>;
1483
+ }, "strip", z.ZodTypeAny, {
1484
+ iccid?: string | undefined;
1485
+ smdpAddress?: string | undefined;
1486
+ manualActivationCode?: string | undefined;
1487
+ }, {
1488
+ iccid?: string | undefined;
1489
+ smdpAddress?: string | undefined;
1490
+ manualActivationCode?: string | undefined;
1491
+ }>>;
1492
+ /**
1493
+ *
1494
+ * @typedef {GetEsimMacOkResponseEsim} getEsimMacOkResponseEsim
1495
+ * @property {string} - ID of the eSIM
1496
+ * @property {string} - SM-DP+ Address
1497
+ * @property {string} - The manual activation code
1498
+ */
1499
+ type GetEsimMacOkResponseEsim = z.infer<typeof getEsimMacOkResponseEsim>;
1500
+
1501
+ declare class Celitech {
12
1502
  config: SdkConfig;
13
1503
  readonly destinations: DestinationsService;
14
1504
  readonly packages: PackagesService;
@@ -21,4 +1511,5 @@ export declare class Celitech {
21
1511
  set clientId(clientId: string);
22
1512
  set clientSecret(clientSecret: string);
23
1513
  }
24
- //# sourceMappingURL=index.d.ts.map
1514
+
1515
+ export { Celitech, CreatePurchaseOkResponse, CreatePurchaseOkResponseProfile, CreatePurchaseOkResponsePurchase, CreatePurchaseRequest, Destinations, DestinationsService, Device, ESimService, EditPurchaseOkResponse, EditPurchaseRequest, GetEsimDeviceOkResponse, GetEsimHistoryOkResponse, GetEsimHistoryOkResponseEsim, GetEsimMacOkResponse, GetEsimMacOkResponseEsim, GetEsimOkResponse, GetEsimOkResponseEsim, GetPurchaseConsumptionOkResponse, History, ListDestinationsOkResponse, ListPackagesOkResponse, ListPurchasesOkResponse, Package_, Packages, PackagesService, Purchases, PurchasesEsim, PurchasesService, RequestConfig, RetryOptions, SdkConfig, TopUpEsimOkResponse, TopUpEsimOkResponseProfile, TopUpEsimOkResponsePurchase, TopUpEsimRequest, ValidationOptions };