@sinch/sms 0.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 (326) hide show
  1. package/README.md +166 -0
  2. package/dist/index.d.ts +3 -0
  3. package/dist/index.js +20 -0
  4. package/dist/index.js.map +1 -0
  5. package/dist/models/index.d.ts +1 -0
  6. package/dist/models/index.js +18 -0
  7. package/dist/models/index.js.map +1 -0
  8. package/dist/models/v1/api-batch-list/api-batch-list.d.ts +17 -0
  9. package/dist/models/v1/api-batch-list/api-batch-list.js +9 -0
  10. package/dist/models/v1/api-batch-list/api-batch-list.js.map +1 -0
  11. package/dist/models/v1/api-batch-list/index.d.ts +1 -0
  12. package/dist/models/v1/api-batch-list/index.js +3 -0
  13. package/dist/models/v1/api-batch-list/index.js.map +1 -0
  14. package/dist/models/v1/api-batch-list-batches-inner/api-batch-list-batches-inner.d.ts +10 -0
  15. package/dist/models/v1/api-batch-list-batches-inner/api-batch-list-batches-inner.js +9 -0
  16. package/dist/models/v1/api-batch-list-batches-inner/api-batch-list-batches-inner.js.map +1 -0
  17. package/dist/models/v1/api-batch-list-batches-inner/index.d.ts +1 -0
  18. package/dist/models/v1/api-batch-list-batches-inner/index.js +3 -0
  19. package/dist/models/v1/api-batch-list-batches-inner/index.js.map +1 -0
  20. package/dist/models/v1/api-inbound-list/api-inbound-list.d.ts +17 -0
  21. package/dist/models/v1/api-inbound-list/api-inbound-list.js +9 -0
  22. package/dist/models/v1/api-inbound-list/api-inbound-list.js.map +1 -0
  23. package/dist/models/v1/api-inbound-list/index.d.ts +1 -0
  24. package/dist/models/v1/api-inbound-list/index.js +3 -0
  25. package/dist/models/v1/api-inbound-list/index.js.map +1 -0
  26. package/dist/models/v1/api-mo-message/api-mo-message.d.ts +27 -0
  27. package/dist/models/v1/api-mo-message/api-mo-message.js +9 -0
  28. package/dist/models/v1/api-mo-message/api-mo-message.js.map +1 -0
  29. package/dist/models/v1/api-mo-message/index.d.ts +1 -0
  30. package/dist/models/v1/api-mo-message/index.js +3 -0
  31. package/dist/models/v1/api-mo-message/index.js.map +1 -0
  32. package/dist/models/v1/api-update-binary-mt-message/api-update-binary-mt-message.d.ts +30 -0
  33. package/dist/models/v1/api-update-binary-mt-message/api-update-binary-mt-message.js +3 -0
  34. package/dist/models/v1/api-update-binary-mt-message/api-update-binary-mt-message.js.map +1 -0
  35. package/dist/models/v1/api-update-binary-mt-message/index.d.ts +1 -0
  36. package/dist/models/v1/api-update-binary-mt-message/index.js +3 -0
  37. package/dist/models/v1/api-update-binary-mt-message/index.js.map +1 -0
  38. package/dist/models/v1/api-update-mms-mt-message/api-update-mms-mt-message.d.ts +34 -0
  39. package/dist/models/v1/api-update-mms-mt-message/api-update-mms-mt-message.js +9 -0
  40. package/dist/models/v1/api-update-mms-mt-message/api-update-mms-mt-message.js.map +1 -0
  41. package/dist/models/v1/api-update-mms-mt-message/index.d.ts +1 -0
  42. package/dist/models/v1/api-update-mms-mt-message/index.js +3 -0
  43. package/dist/models/v1/api-update-mms-mt-message/index.js.map +1 -0
  44. package/dist/models/v1/api-update-mt-message/api-update-mt-message.d.ts +24 -0
  45. package/dist/models/v1/api-update-mt-message/api-update-mt-message.js +3 -0
  46. package/dist/models/v1/api-update-mt-message/api-update-mt-message.js.map +1 -0
  47. package/dist/models/v1/api-update-mt-message/index.d.ts +1 -0
  48. package/dist/models/v1/api-update-mt-message/index.js +3 -0
  49. package/dist/models/v1/api-update-mt-message/index.js.map +1 -0
  50. package/dist/models/v1/api-update-text-mt-message/api-update-text-mt-message.d.ts +31 -0
  51. package/dist/models/v1/api-update-text-mt-message/api-update-text-mt-message.js +9 -0
  52. package/dist/models/v1/api-update-text-mt-message/api-update-text-mt-message.js.map +1 -0
  53. package/dist/models/v1/api-update-text-mt-message/index.d.ts +1 -0
  54. package/dist/models/v1/api-update-text-mt-message/index.js +3 -0
  55. package/dist/models/v1/api-update-text-mt-message/index.js.map +1 -0
  56. package/dist/models/v1/binary-request/binary-request.d.ts +42 -0
  57. package/dist/models/v1/binary-request/binary-request.js +3 -0
  58. package/dist/models/v1/binary-request/binary-request.js.map +1 -0
  59. package/dist/models/v1/binary-request/index.d.ts +1 -0
  60. package/dist/models/v1/binary-request/index.js +3 -0
  61. package/dist/models/v1/binary-request/index.js.map +1 -0
  62. package/dist/models/v1/binary-response/binary-response.d.ts +50 -0
  63. package/dist/models/v1/binary-response/binary-response.js +3 -0
  64. package/dist/models/v1/binary-response/binary-response.js.map +1 -0
  65. package/dist/models/v1/binary-response/index.d.ts +1 -0
  66. package/dist/models/v1/binary-response/index.js +3 -0
  67. package/dist/models/v1/binary-response/index.js.map +1 -0
  68. package/dist/models/v1/create-group-request/create-group-request.d.ts +17 -0
  69. package/dist/models/v1/create-group-request/create-group-request.js +9 -0
  70. package/dist/models/v1/create-group-request/create-group-request.js.map +1 -0
  71. package/dist/models/v1/create-group-request/index.d.ts +1 -0
  72. package/dist/models/v1/create-group-request/index.js +3 -0
  73. package/dist/models/v1/create-group-request/index.js.map +1 -0
  74. package/dist/models/v1/create-group-response/create-group-response.d.ts +23 -0
  75. package/dist/models/v1/create-group-response/create-group-response.js +9 -0
  76. package/dist/models/v1/create-group-response/create-group-response.js.map +1 -0
  77. package/dist/models/v1/create-group-response/index.d.ts +4 -0
  78. package/dist/models/v1/create-group-response/index.js +3 -0
  79. package/dist/models/v1/create-group-response/index.js.map +1 -0
  80. package/dist/models/v1/delivery-feedback-request/delivery-feedback-request.d.ts +10 -0
  81. package/dist/models/v1/delivery-feedback-request/delivery-feedback-request.js +9 -0
  82. package/dist/models/v1/delivery-feedback-request/delivery-feedback-request.js.map +1 -0
  83. package/dist/models/v1/delivery-feedback-request/index.d.ts +1 -0
  84. package/dist/models/v1/delivery-feedback-request/index.js +3 -0
  85. package/dist/models/v1/delivery-feedback-request/index.js.map +1 -0
  86. package/dist/models/v1/delivery-report/delivery-report.d.ts +20 -0
  87. package/dist/models/v1/delivery-report/delivery-report.js +9 -0
  88. package/dist/models/v1/delivery-report/delivery-report.js.map +1 -0
  89. package/dist/models/v1/delivery-report/index.d.ts +1 -0
  90. package/dist/models/v1/delivery-report/index.js +3 -0
  91. package/dist/models/v1/delivery-report/index.js.map +1 -0
  92. package/dist/models/v1/delivery-report-list/delivery-report-list.d.ts +17 -0
  93. package/dist/models/v1/delivery-report-list/delivery-report-list.js +9 -0
  94. package/dist/models/v1/delivery-report-list/delivery-report-list.js.map +1 -0
  95. package/dist/models/v1/delivery-report-list/index.d.ts +1 -0
  96. package/dist/models/v1/delivery-report-list/index.js +3 -0
  97. package/dist/models/v1/delivery-report-list/index.js.map +1 -0
  98. package/dist/models/v1/dry-run-request/dry-run-request.d.ts +11 -0
  99. package/dist/models/v1/dry-run-request/dry-run-request.js +9 -0
  100. package/dist/models/v1/dry-run-request/dry-run-request.js.map +1 -0
  101. package/dist/models/v1/dry-run-request/index.d.ts +1 -0
  102. package/dist/models/v1/dry-run-request/index.js +3 -0
  103. package/dist/models/v1/dry-run-request/index.js.map +1 -0
  104. package/dist/models/v1/dry-run-response/dry-run-response.d.ts +15 -0
  105. package/dist/models/v1/dry-run-response/dry-run-response.js +9 -0
  106. package/dist/models/v1/dry-run-response/dry-run-response.js.map +1 -0
  107. package/dist/models/v1/dry-run-response/index.d.ts +1 -0
  108. package/dist/models/v1/dry-run-response/index.js +3 -0
  109. package/dist/models/v1/dry-run-response/index.js.map +1 -0
  110. package/dist/models/v1/dry-run-response-per-recipient-inner/dry-run-response-per-recipient-inner.d.ts +12 -0
  111. package/dist/models/v1/dry-run-response-per-recipient-inner/dry-run-response-per-recipient-inner.js +9 -0
  112. package/dist/models/v1/dry-run-response-per-recipient-inner/dry-run-response-per-recipient-inner.js.map +1 -0
  113. package/dist/models/v1/dry-run-response-per-recipient-inner/index.d.ts +1 -0
  114. package/dist/models/v1/dry-run-response-per-recipient-inner/index.js +3 -0
  115. package/dist/models/v1/dry-run-response-per-recipient-inner/index.js.map +1 -0
  116. package/dist/models/v1/enums.d.ts +15 -0
  117. package/dist/models/v1/enums.js +3 -0
  118. package/dist/models/v1/enums.js.map +1 -0
  119. package/dist/models/v1/error-response-obj/error-response-obj.d.ts +12 -0
  120. package/dist/models/v1/error-response-obj/error-response-obj.js +9 -0
  121. package/dist/models/v1/error-response-obj/error-response-obj.js.map +1 -0
  122. package/dist/models/v1/error-response-obj/index.d.ts +1 -0
  123. package/dist/models/v1/error-response-obj/index.js +3 -0
  124. package/dist/models/v1/error-response-obj/index.js.map +1 -0
  125. package/dist/models/v1/group-auto-update/group-auto-update.d.ts +12 -0
  126. package/dist/models/v1/group-auto-update/group-auto-update.js +9 -0
  127. package/dist/models/v1/group-auto-update/group-auto-update.js.map +1 -0
  128. package/dist/models/v1/group-auto-update/index.d.ts +1 -0
  129. package/dist/models/v1/group-auto-update/index.js +3 -0
  130. package/dist/models/v1/group-auto-update/index.js.map +1 -0
  131. package/dist/models/v1/group-object-auto-update/group-object-auto-update.d.ts +16 -0
  132. package/dist/models/v1/group-object-auto-update/group-object-auto-update.js +9 -0
  133. package/dist/models/v1/group-object-auto-update/group-object-auto-update.js.map +1 -0
  134. package/dist/models/v1/group-object-auto-update/index.d.ts +1 -0
  135. package/dist/models/v1/group-object-auto-update/index.js +3 -0
  136. package/dist/models/v1/group-object-auto-update/index.js.map +1 -0
  137. package/dist/models/v1/group-object-auto-update-remove/group-object-auto-update-remove.d.ts +19 -0
  138. package/dist/models/v1/group-object-auto-update-remove/group-object-auto-update-remove.js +14 -0
  139. package/dist/models/v1/group-object-auto-update-remove/group-object-auto-update-remove.js.map +1 -0
  140. package/dist/models/v1/group-object-auto-update-remove/index.d.ts +1 -0
  141. package/dist/models/v1/group-object-auto-update-remove/index.js +3 -0
  142. package/dist/models/v1/group-object-auto-update-remove/index.js.map +1 -0
  143. package/dist/models/v1/inbound-message-response/inbound-message-response.d.ts +9 -0
  144. package/dist/models/v1/inbound-message-response/inbound-message-response.js +9 -0
  145. package/dist/models/v1/inbound-message-response/inbound-message-response.js.map +1 -0
  146. package/dist/models/v1/inbound-message-response/index.d.ts +1 -0
  147. package/dist/models/v1/inbound-message-response/index.js +3 -0
  148. package/dist/models/v1/inbound-message-response/index.js.map +1 -0
  149. package/dist/models/v1/index.d.ts +45 -0
  150. package/dist/models/v1/index.js +62 -0
  151. package/dist/models/v1/index.js.map +1 -0
  152. package/dist/models/v1/list-groups-response/index.d.ts +1 -0
  153. package/dist/models/v1/list-groups-response/index.js +3 -0
  154. package/dist/models/v1/list-groups-response/index.js.map +1 -0
  155. package/dist/models/v1/list-groups-response/list-groups-response.d.ts +17 -0
  156. package/dist/models/v1/list-groups-response/list-groups-response.js +9 -0
  157. package/dist/models/v1/list-groups-response/list-groups-response.js.map +1 -0
  158. package/dist/models/v1/media-body/index.d.ts +1 -0
  159. package/dist/models/v1/media-body/index.js +3 -0
  160. package/dist/models/v1/media-body/index.js.map +1 -0
  161. package/dist/models/v1/media-body/media-body.d.ts +15 -0
  162. package/dist/models/v1/media-body/media-body.js +9 -0
  163. package/dist/models/v1/media-body/media-body.js.map +1 -0
  164. package/dist/models/v1/media-request/index.d.ts +1 -0
  165. package/dist/models/v1/media-request/index.js +3 -0
  166. package/dist/models/v1/media-request/index.js.map +1 -0
  167. package/dist/models/v1/media-request/media-request.d.ts +39 -0
  168. package/dist/models/v1/media-request/media-request.js +9 -0
  169. package/dist/models/v1/media-request/media-request.js.map +1 -0
  170. package/dist/models/v1/media-response/index.d.ts +1 -0
  171. package/dist/models/v1/media-response/index.js +3 -0
  172. package/dist/models/v1/media-response/index.js.map +1 -0
  173. package/dist/models/v1/media-response/media-response.d.ts +44 -0
  174. package/dist/models/v1/media-response/media-response.js +9 -0
  175. package/dist/models/v1/media-response/media-response.js.map +1 -0
  176. package/dist/models/v1/message-delivery-status/index.d.ts +1 -0
  177. package/dist/models/v1/message-delivery-status/index.js +3 -0
  178. package/dist/models/v1/message-delivery-status/index.js.map +1 -0
  179. package/dist/models/v1/message-delivery-status/message-delivery-status.d.ts +20 -0
  180. package/dist/models/v1/message-delivery-status/message-delivery-status.js +9 -0
  181. package/dist/models/v1/message-delivery-status/message-delivery-status.js.map +1 -0
  182. package/dist/models/v1/mo-binary/index.d.ts +1 -0
  183. package/dist/models/v1/mo-binary/index.js +3 -0
  184. package/dist/models/v1/mo-binary/index.js.map +1 -0
  185. package/dist/models/v1/mo-binary/mo-binary.d.ts +16 -0
  186. package/dist/models/v1/mo-binary/mo-binary.js +9 -0
  187. package/dist/models/v1/mo-binary/mo-binary.js.map +1 -0
  188. package/dist/models/v1/mo-text/index.d.ts +1 -0
  189. package/dist/models/v1/mo-text/index.js +3 -0
  190. package/dist/models/v1/mo-text/index.js.map +1 -0
  191. package/dist/models/v1/mo-text/mo-text.d.ts +13 -0
  192. package/dist/models/v1/mo-text/mo-text.js +9 -0
  193. package/dist/models/v1/mo-text/mo-text.js.map +1 -0
  194. package/dist/models/v1/parameter-obj/index.d.ts +1 -0
  195. package/dist/models/v1/parameter-obj/index.js +3 -0
  196. package/dist/models/v1/parameter-obj/index.js.map +1 -0
  197. package/dist/models/v1/parameter-obj/parameter-obj.d.ts +14 -0
  198. package/dist/models/v1/parameter-obj/parameter-obj.js +9 -0
  199. package/dist/models/v1/parameter-obj/parameter-obj.js.map +1 -0
  200. package/dist/models/v1/parameter-obj-parameter-key/index.d.ts +1 -0
  201. package/dist/models/v1/parameter-obj-parameter-key/index.js +3 -0
  202. package/dist/models/v1/parameter-obj-parameter-key/index.js.map +1 -0
  203. package/dist/models/v1/parameter-obj-parameter-key/parameter-obj-parameter-key.d.ts +15 -0
  204. package/dist/models/v1/parameter-obj-parameter-key/parameter-obj-parameter-key.js +9 -0
  205. package/dist/models/v1/parameter-obj-parameter-key/parameter-obj-parameter-key.js.map +1 -0
  206. package/dist/models/v1/recipient-delivery-report/index.d.ts +1 -0
  207. package/dist/models/v1/recipient-delivery-report/index.js +3 -0
  208. package/dist/models/v1/recipient-delivery-report/index.js.map +1 -0
  209. package/dist/models/v1/recipient-delivery-report/recipient-delivery-report.d.ts +35 -0
  210. package/dist/models/v1/recipient-delivery-report/recipient-delivery-report.js +3 -0
  211. package/dist/models/v1/recipient-delivery-report/recipient-delivery-report.js.map +1 -0
  212. package/dist/models/v1/replace-group-request/index.d.ts +1 -0
  213. package/dist/models/v1/replace-group-request/index.js +3 -0
  214. package/dist/models/v1/replace-group-request/index.js.map +1 -0
  215. package/dist/models/v1/replace-group-request/replace-group-request.d.ts +12 -0
  216. package/dist/models/v1/replace-group-request/replace-group-request.js +9 -0
  217. package/dist/models/v1/replace-group-request/replace-group-request.js.map +1 -0
  218. package/dist/models/v1/send-sms-request/index.d.ts +1 -0
  219. package/dist/models/v1/send-sms-request/index.js +3 -0
  220. package/dist/models/v1/send-sms-request/index.js.map +1 -0
  221. package/dist/models/v1/send-sms-request/send-sms-request.d.ts +10 -0
  222. package/dist/models/v1/send-sms-request/send-sms-request.js +9 -0
  223. package/dist/models/v1/send-sms-request/send-sms-request.js.map +1 -0
  224. package/dist/models/v1/send-sms-response/index.d.ts +1 -0
  225. package/dist/models/v1/send-sms-response/index.js +3 -0
  226. package/dist/models/v1/send-sms-response/index.js.map +1 -0
  227. package/dist/models/v1/send-sms-response/send-sms-response.d.ts +12 -0
  228. package/dist/models/v1/send-sms-response/send-sms-response.js +9 -0
  229. package/dist/models/v1/send-sms-response/send-sms-response.js.map +1 -0
  230. package/dist/models/v1/text-request/index.d.ts +1 -0
  231. package/dist/models/v1/text-request/index.js +3 -0
  232. package/dist/models/v1/text-request/index.js.map +1 -0
  233. package/dist/models/v1/text-request/text-request.d.ts +43 -0
  234. package/dist/models/v1/text-request/text-request.js +9 -0
  235. package/dist/models/v1/text-request/text-request.js.map +1 -0
  236. package/dist/models/v1/text-response/index.d.ts +1 -0
  237. package/dist/models/v1/text-response/index.js +3 -0
  238. package/dist/models/v1/text-response/index.js.map +1 -0
  239. package/dist/models/v1/text-response/text-response.d.ts +51 -0
  240. package/dist/models/v1/text-response/text-response.js +9 -0
  241. package/dist/models/v1/text-response/text-response.js.map +1 -0
  242. package/dist/models/v1/update-batch-message-request/index.d.ts +1 -0
  243. package/dist/models/v1/update-batch-message-request/index.js +3 -0
  244. package/dist/models/v1/update-batch-message-request/index.js.map +1 -0
  245. package/dist/models/v1/update-batch-message-request/update-batch-message-request.d.ts +10 -0
  246. package/dist/models/v1/update-batch-message-request/update-batch-message-request.js +9 -0
  247. package/dist/models/v1/update-batch-message-request/update-batch-message-request.js.map +1 -0
  248. package/dist/models/v1/update-group-request/index.d.ts +1 -0
  249. package/dist/models/v1/update-group-request/index.js +3 -0
  250. package/dist/models/v1/update-group-request/index.js.map +1 -0
  251. package/dist/models/v1/update-group-request/update-group-request.d.ts +21 -0
  252. package/dist/models/v1/update-group-request/update-group-request.js +9 -0
  253. package/dist/models/v1/update-group-request/update-group-request.js.map +1 -0
  254. package/dist/models/v1/update-group-request-auto-update/index.d.ts +1 -0
  255. package/dist/models/v1/update-group-request-auto-update/index.js +3 -0
  256. package/dist/models/v1/update-group-request-auto-update/index.js.map +1 -0
  257. package/dist/models/v1/update-group-request-auto-update/update-group-request-auto-update.d.ts +16 -0
  258. package/dist/models/v1/update-group-request-auto-update/update-group-request-auto-update.js +9 -0
  259. package/dist/models/v1/update-group-request-auto-update/update-group-request-auto-update.js.map +1 -0
  260. package/dist/models/v1/update-group-request-auto-update-add/index.d.ts +1 -0
  261. package/dist/models/v1/update-group-request-auto-update-add/index.js +3 -0
  262. package/dist/models/v1/update-group-request-auto-update-add/index.js.map +1 -0
  263. package/dist/models/v1/update-group-request-auto-update-add/update-group-request-auto-update-add.d.ts +16 -0
  264. package/dist/models/v1/update-group-request-auto-update-add/update-group-request-auto-update-add.js +14 -0
  265. package/dist/models/v1/update-group-request-auto-update-add/update-group-request-auto-update-add.js.map +1 -0
  266. package/dist/models/v1/update-group-request-auto-update-remove/index.d.ts +1 -0
  267. package/dist/models/v1/update-group-request-auto-update-remove/index.js +3 -0
  268. package/dist/models/v1/update-group-request-auto-update-remove/index.js.map +1 -0
  269. package/dist/models/v1/update-group-request-auto-update-remove/update-group-request-auto-update-remove.d.ts +19 -0
  270. package/dist/models/v1/update-group-request-auto-update-remove/update-group-request-auto-update-remove.js +14 -0
  271. package/dist/models/v1/update-group-request-auto-update-remove/update-group-request-auto-update-remove.js.map +1 -0
  272. package/dist/rest/index.d.ts +1 -0
  273. package/dist/rest/index.js +18 -0
  274. package/dist/rest/index.js.map +1 -0
  275. package/dist/rest/v1/batches/batches-api.d.ts +114 -0
  276. package/dist/rest/v1/batches/batches-api.jest.fixture.d.ts +38 -0
  277. package/dist/rest/v1/batches/batches-api.jest.fixture.js +41 -0
  278. package/dist/rest/v1/batches/batches-api.jest.fixture.js.map +1 -0
  279. package/dist/rest/v1/batches/batches-api.js +213 -0
  280. package/dist/rest/v1/batches/batches-api.js.map +1 -0
  281. package/dist/rest/v1/batches/index.d.ts +1 -0
  282. package/dist/rest/v1/batches/index.js +18 -0
  283. package/dist/rest/v1/batches/index.js.map +1 -0
  284. package/dist/rest/v1/delivery-reports/delivery-reports-api.d.ts +63 -0
  285. package/dist/rest/v1/delivery-reports/delivery-reports-api.jest.fixture.d.ts +22 -0
  286. package/dist/rest/v1/delivery-reports/delivery-reports-api.jest.fixture.js +21 -0
  287. package/dist/rest/v1/delivery-reports/delivery-reports-api.jest.fixture.js.map +1 -0
  288. package/dist/rest/v1/delivery-reports/delivery-reports-api.js +94 -0
  289. package/dist/rest/v1/delivery-reports/delivery-reports-api.js.map +1 -0
  290. package/dist/rest/v1/delivery-reports/index.d.ts +1 -0
  291. package/dist/rest/v1/delivery-reports/index.js +18 -0
  292. package/dist/rest/v1/delivery-reports/index.js.map +1 -0
  293. package/dist/rest/v1/enums.d.ts +1 -0
  294. package/dist/rest/v1/enums.js +3 -0
  295. package/dist/rest/v1/enums.js.map +1 -0
  296. package/dist/rest/v1/fixtures.jest.d.ts +4 -0
  297. package/dist/rest/v1/fixtures.jest.js +12 -0
  298. package/dist/rest/v1/fixtures.jest.js.map +1 -0
  299. package/dist/rest/v1/groups/groups-api.d.ts +88 -0
  300. package/dist/rest/v1/groups/groups-api.jest.fixture.d.ts +34 -0
  301. package/dist/rest/v1/groups/groups-api.jest.fixture.js +37 -0
  302. package/dist/rest/v1/groups/groups-api.jest.fixture.js.map +1 -0
  303. package/dist/rest/v1/groups/groups-api.js +185 -0
  304. package/dist/rest/v1/groups/groups-api.js.map +1 -0
  305. package/dist/rest/v1/groups/index.d.ts +1 -0
  306. package/dist/rest/v1/groups/index.js +18 -0
  307. package/dist/rest/v1/groups/index.js.map +1 -0
  308. package/dist/rest/v1/inbounds/inbounds-api.d.ts +42 -0
  309. package/dist/rest/v1/inbounds/inbounds-api.jest.fixture.d.ts +16 -0
  310. package/dist/rest/v1/inbounds/inbounds-api.jest.fixture.js +17 -0
  311. package/dist/rest/v1/inbounds/inbounds-api.jest.fixture.js.map +1 -0
  312. package/dist/rest/v1/inbounds/inbounds-api.js +68 -0
  313. package/dist/rest/v1/inbounds/inbounds-api.js.map +1 -0
  314. package/dist/rest/v1/inbounds/index.d.ts +1 -0
  315. package/dist/rest/v1/inbounds/index.js +18 -0
  316. package/dist/rest/v1/inbounds/index.js.map +1 -0
  317. package/dist/rest/v1/index.d.ts +7 -0
  318. package/dist/rest/v1/index.js +24 -0
  319. package/dist/rest/v1/index.js.map +1 -0
  320. package/dist/rest/v1/sms-api.d.ts +26 -0
  321. package/dist/rest/v1/sms-api.js +89 -0
  322. package/dist/rest/v1/sms-api.js.map +1 -0
  323. package/dist/rest/v1/sms.d.ts +24 -0
  324. package/dist/rest/v1/sms.js +28 -0
  325. package/dist/rest/v1/sms.js.map +1 -0
  326. package/package.json +37 -0
@@ -0,0 +1,19 @@
1
+ /**
2
+ * Model: UpdateGroupRequestAutoUpdateRemove
3
+ *
4
+ * THIS FILE HAS BEEN AUTOMATICALLY GENERATED. DO NOT EDIT.
5
+ *
6
+ */
7
+ /**
8
+ * Keyword to be sent in MO to remove from a group.
9
+ */
10
+ export interface UpdateGroupRequestAutoUpdateRemove {
11
+ /** Opt-out keyword. For example, \"LEAVE\" if `auto_update.to` is a dedicated long/short number or a unique brand keyword like \"Sinch\" (if it is a shared short code). Constraints: Must be one word. */
12
+ first_word?: string;
13
+ /** Opt-out keyword. For example, \"LEAVE\" if `auto_update.to` is a shared short code. Constraints: Must be one word. */
14
+ second_word?: string;
15
+ }
16
+ /** Validation regex for first_word */
17
+ export declare const firstWordPattern: RegExp;
18
+ /** Validation regex for second_word */
19
+ export declare const secondWordPattern: RegExp;
@@ -0,0 +1,14 @@
1
+ "use strict";
2
+ /**
3
+ * Model: UpdateGroupRequestAutoUpdateRemove
4
+ *
5
+ * THIS FILE HAS BEEN AUTOMATICALLY GENERATED. DO NOT EDIT.
6
+ *
7
+ */
8
+ Object.defineProperty(exports, "__esModule", { value: true });
9
+ exports.secondWordPattern = exports.firstWordPattern = void 0;
10
+ /** Validation regex for first_word */
11
+ exports.firstWordPattern = /^\w+$/;
12
+ /** Validation regex for second_word */
13
+ exports.secondWordPattern = /^\w+$/;
14
+ //# sourceMappingURL=update-group-request-auto-update-remove.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"update-group-request-auto-update-remove.js","sourceRoot":"","sources":["../../../../src/models/v1/update-group-request-auto-update-remove/update-group-request-auto-update-remove.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAeH,sCAAsC;AACzB,QAAA,gBAAgB,GAAG,OAAO,CAAC;AACxC,uCAAuC;AAC1B,QAAA,iBAAiB,GAAG,OAAO,CAAC"}
@@ -0,0 +1 @@
1
+ export * from './v1';
@@ -0,0 +1,18 @@
1
+ "use strict";
2
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
+ if (k2 === undefined) k2 = k;
4
+ var desc = Object.getOwnPropertyDescriptor(m, k);
5
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
6
+ desc = { enumerable: true, get: function() { return m[k]; } };
7
+ }
8
+ Object.defineProperty(o, k2, desc);
9
+ }) : (function(o, m, k, k2) {
10
+ if (k2 === undefined) k2 = k;
11
+ o[k2] = m[k];
12
+ }));
13
+ var __exportStar = (this && this.__exportStar) || function(m, exports) {
14
+ for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
15
+ };
16
+ Object.defineProperty(exports, "__esModule", { value: true });
17
+ __exportStar(require("./v1"), exports);
18
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/rest/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,uCAAqB"}
@@ -0,0 +1,114 @@
1
+ import { ApiBatchListBatchesInner, CancelBatchMessageResponse, DeliveryFeedbackRequest, DryRunResponse, DryRunRequest, ReplaceBatchMessageResponse, ReplaceBatchMessageRequest, SendSMSResponse, SendSMSRequest, UpdateBatchMessageRequest } from '../../../models';
2
+ import { ApiListPromise, SinchClientParameters } from '@sinch/sdk-client';
3
+ import { SmsApi } from '../sms-api';
4
+ export interface CancelBatchMessageRequestData {
5
+ /** The batch ID you received from sending a message. */
6
+ 'batch_id': string;
7
+ }
8
+ export interface DeliveryFeedbackRequestData {
9
+ /** The batch ID you received from sending a message. */
10
+ 'batch_id': string;
11
+ /** A list of phone numbers (MSISDNs) that successfully received the message. */
12
+ 'deliveryFeedbackRequestBody': DeliveryFeedbackRequest;
13
+ }
14
+ export interface DryRunRequestData {
15
+ /** Whether to include per recipient details in the response */
16
+ 'per_recipient'?: boolean;
17
+ /** Max number of recipients to include per recipient details for in the response */
18
+ 'number_of_recipients'?: number;
19
+ /** */
20
+ 'dryRunRequestBody'?: DryRunRequest;
21
+ }
22
+ export interface GetBatchMessageRequestData {
23
+ /** The batch ID you received from sending a message. */
24
+ 'batch_id': string;
25
+ }
26
+ export interface ListBatchesRequestData {
27
+ /** The page number starting from 0. */
28
+ 'page'?: number;
29
+ /** Determines the size of a page. */
30
+ 'page_size'?: number;
31
+ /** Only list messages sent from this sender number. Multiple originating numbers can be comma separated. Must be phone numbers or short code. */
32
+ 'from'?: string;
33
+ /** Only list messages received at or after this date/time. Formatted as [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601): `YYYY-MM-DDThh:mm:ss.SSSZ`. Default: Now-24 */
34
+ 'start_date'?: Date;
35
+ /** Only list messages received before this date/time. Formatted as [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601): `YYYY-MM-DDThh:mm:ss.SSSZ`. */
36
+ 'end_date'?: Date;
37
+ /** Client reference to include */
38
+ 'client_reference'?: string;
39
+ }
40
+ export interface ReplaceBatchMessageRequestData {
41
+ /** The batch ID you received from sending a message. */
42
+ 'batch_id': string;
43
+ /** */
44
+ 'replaceBatchMessageRequestBody'?: ReplaceBatchMessageRequest;
45
+ }
46
+ export interface SendSMSRequestData {
47
+ /** Default schema is Text if type is not specified. */
48
+ 'sendSMSRequestBody'?: SendSMSRequest;
49
+ }
50
+ export interface UpdateBatchMessageRequestData {
51
+ /** The batch ID you received from sending a message. */
52
+ 'batch_id': string;
53
+ /** */
54
+ 'updateBatchMessageRequestBody'?: UpdateBatchMessageRequest;
55
+ }
56
+ export declare class BatchesApi extends SmsApi {
57
+ /**
58
+ * Initialize your interface
59
+ *
60
+ * @param {SinchClientParameters} sinchClientParameters - The parameters used to initialize the API Client.
61
+ */
62
+ constructor(sinchClientParameters: SinchClientParameters);
63
+ /**
64
+ * Cancel a batch message
65
+ * A batch can be canceled at any point. If a batch is canceled while it's currently being delivered some messages currently being processed might still be delivered. The delivery report will indicate which messages were canceled and which weren't. Canceling a batch scheduled in the future will result in an empty delivery report while canceling an already sent batch would result in no change to the completed delivery report.
66
+ * @param { CancelBatchMessageRequestData } data - The data to provide to the API call.
67
+ */
68
+ cancel(data: CancelBatchMessageRequestData): Promise<CancelBatchMessageResponse>;
69
+ /**
70
+ * Send delivery feedback for a message
71
+ * Send feedback if your system can confirm successful message delivery. Feedback can only be provided if 'feedback_enabled' was set when batch was submitted.
72
+ * **Batches**: It is possible to submit feedback multiple times for the same batch for different recipients. Feedback without specified recipients is treated as successful message delivery to all recipients referenced in the batch. Note that the 'recipients' key is still required even if the value is empty.
73
+ * **Groups**: If the batch message was creating using a group ID, at least one recipient is required. Excluding recipients (an empty recipient list) does not work and will result in a failed request.
74
+ * @param { DeliveryFeedbackRequestData } data - The data to provide to the API call.
75
+ */
76
+ sendDeliveryFeedback(data: DeliveryFeedbackRequestData): Promise<void>;
77
+ /**
78
+ * Dry run
79
+ * This operation will perform a dry run of a batch which calculates the bodies and number of parts for all messages in the batch without actually sending any messages.
80
+ * @param { DryRunRequestData } data - The data to provide to the API call.
81
+ */
82
+ dryRun(data: DryRunRequestData): Promise<DryRunResponse>;
83
+ /**
84
+ * Get a batch message
85
+ * This operation returns a specific batch that matches the provided batch ID.
86
+ * @param { GetBatchMessageRequestData } data - The data to provide to the API call.
87
+ */
88
+ get(data: GetBatchMessageRequestData): Promise<SendSMSResponse>;
89
+ /**
90
+ * List Batches
91
+ * With the list operation you can list batch messages created in the last 14 days that you have created. This operation supports pagination.
92
+ * @param { ListBatchesRequestData } data - The data to provide to the API call.
93
+ * @return {ApiListPromise<ApiBatchListBatchesInner>}
94
+ */
95
+ list(data: ListBatchesRequestData): ApiListPromise<ApiBatchListBatchesInner>;
96
+ /**
97
+ * Replace a batch
98
+ * This operation will replace all the parameters of a batch with the provided values. It is the same as cancelling a batch and sending a new one instead.
99
+ * @param { ReplaceBatchMessageRequestData } data - The data to provide to the API call.
100
+ */
101
+ replace(data: ReplaceBatchMessageRequestData): Promise<ReplaceBatchMessageResponse>;
102
+ /**
103
+ * Send
104
+ * Send a message or a batch of messages. Depending on the length of the body, one message might be split into multiple parts and charged accordingly. Any groups targeted in a scheduled batch will be evaluated at the time of sending. If a group is deleted between batch creation and scheduled date, it will be considered empty. Be sure to use the correct &lt;a href&#x3D;\&quot;/docs/sms/api-reference/#base-url\&quot; target&#x3D;\&quot;_blank\&quot;&gt;region&lt;/a&gt; in the server URL.
105
+ * @param { SendSMSRequestData } data - The data to provide to the API call.
106
+ */
107
+ send(data: SendSMSRequestData): Promise<SendSMSResponse>;
108
+ /**
109
+ * Update a Batch message
110
+ * This operation updates all specified parameters of a batch that matches the provided batch ID.
111
+ * @param { UpdateBatchMessageRequestData } data - The data to provide to the API call.
112
+ */
113
+ update(data: UpdateBatchMessageRequestData): Promise<SendSMSResponse>;
114
+ }
@@ -0,0 +1,38 @@
1
+ /// <reference types="jest" />
2
+ import { BatchesApi, CancelBatchMessageRequestData, DeliveryFeedbackRequestData, DryRunRequestData, GetBatchMessageRequestData, ListBatchesRequestData, ReplaceBatchMessageRequestData, SendSMSRequestData, UpdateBatchMessageRequestData } from './batches-api';
3
+ import { ApiBatchListBatchesInner, DryRunResponse, SendSMSResponse } from '../../../models';
4
+ import { ApiListPromise } from '@sinch/sdk-client';
5
+ export declare class BatchesApiFixture implements Partial<Readonly<BatchesApi>> {
6
+ /**
7
+ * Fixture associated to function cancel
8
+ */
9
+ cancel: jest.Mock<Promise<SendSMSResponse>, [CancelBatchMessageRequestData]>;
10
+ /**
11
+ * Fixture associated to function sendDeliveryFeedback
12
+ */
13
+ sendDeliveryFeedback: jest.Mock<Promise<void>, [DeliveryFeedbackRequestData]>;
14
+ /**
15
+ * Fixture associated to function dryRun
16
+ */
17
+ dryRun: jest.Mock<Promise<DryRunResponse>, [DryRunRequestData]>;
18
+ /**
19
+ * Fixture associated to function get
20
+ */
21
+ get: jest.Mock<Promise<SendSMSResponse>, [GetBatchMessageRequestData]>;
22
+ /**
23
+ * Fixture associated to function list
24
+ */
25
+ list: jest.Mock<ApiListPromise<ApiBatchListBatchesInner>, [ListBatchesRequestData]>;
26
+ /**
27
+ * Fixture associated to function replace
28
+ */
29
+ replace: jest.Mock<Promise<SendSMSResponse>, [ReplaceBatchMessageRequestData]>;
30
+ /**
31
+ * Fixture associated to function send
32
+ */
33
+ send: jest.Mock<Promise<SendSMSResponse>, [SendSMSRequestData]>;
34
+ /**
35
+ * Fixture associated to function update
36
+ */
37
+ update: jest.Mock<Promise<SendSMSResponse>, [UpdateBatchMessageRequestData]>;
38
+ }
@@ -0,0 +1,41 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.BatchesApiFixture = void 0;
4
+ class BatchesApiFixture {
5
+ constructor() {
6
+ /**
7
+ * Fixture associated to function cancel
8
+ */
9
+ this.cancel = jest.fn();
10
+ /**
11
+ * Fixture associated to function sendDeliveryFeedback
12
+ */
13
+ this.sendDeliveryFeedback = jest.fn();
14
+ /**
15
+ * Fixture associated to function dryRun
16
+ */
17
+ this.dryRun = jest.fn();
18
+ /**
19
+ * Fixture associated to function get
20
+ */
21
+ this.get = jest.fn();
22
+ /**
23
+ * Fixture associated to function list
24
+ */
25
+ this.list = jest.fn();
26
+ /**
27
+ * Fixture associated to function replace
28
+ */
29
+ this.replace = jest.fn();
30
+ /**
31
+ * Fixture associated to function send
32
+ */
33
+ this.send = jest.fn();
34
+ /**
35
+ * Fixture associated to function update
36
+ */
37
+ this.update = jest.fn();
38
+ }
39
+ }
40
+ exports.BatchesApiFixture = BatchesApiFixture;
41
+ //# sourceMappingURL=batches-api.jest.fixture.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"batches-api.jest.fixture.js","sourceRoot":"","sources":["../../../../src/rest/v1/batches/batches-api.jest.fixture.ts"],"names":[],"mappings":";;;AAIA,MAAa,iBAAiB;IAA9B;QAEE;;YAEI;QACG,WAAM,GAAyE,IAAI,CAAC,EAAE,EAAE,CAAC;QAChG;;YAEI;QACG,yBAAoB,GAA4D,IAAI,CAAC,EAAE,EAAE,CAAC;QACjG;;YAEI;QACG,WAAM,GAA4D,IAAI,CAAC,EAAE,EAAE,CAAC;QACnF;;YAEI;QACG,QAAG,GAAsE,IAAI,CAAC,EAAE,EAAE,CAAC;QAC1F;;YAEI;QACG,SAAI,GAAkF,IAAI,CAAC,EAAE,EAAE,CAAC;QACvG;;YAEI;QACG,YAAO,GAA0E,IAAI,CAAC,EAAE,EAAE,CAAC;QAClG;;YAEI;QACG,SAAI,GAA8D,IAAI,CAAC,EAAE,EAAE,CAAC;QACnF;;YAEI;QACG,WAAM,GAAyE,IAAI,CAAC,EAAE,EAAE,CAAC;IAClG,CAAC;CAAA;AAlCD,8CAkCC"}
@@ -0,0 +1,213 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.BatchesApi = void 0;
4
+ const sdk_client_1 = require("@sinch/sdk-client");
5
+ const sms_api_1 = require("../sms-api");
6
+ class BatchesApi extends sms_api_1.SmsApi {
7
+ /**
8
+ * Initialize your interface
9
+ *
10
+ * @param {SinchClientParameters} sinchClientParameters - The parameters used to initialize the API Client.
11
+ */
12
+ constructor(sinchClientParameters) {
13
+ super(sinchClientParameters, 'BatchesApi');
14
+ }
15
+ /**
16
+ * Cancel a batch message
17
+ * A batch can be canceled at any point. If a batch is canceled while it's currently being delivered some messages currently being processed might still be delivered. The delivery report will indicate which messages were canceled and which weren't. Canceling a batch scheduled in the future will result in an empty delivery report while canceling an already sent batch would result in no change to the completed delivery report.
18
+ * @param { CancelBatchMessageRequestData } data - The data to provide to the API call.
19
+ */
20
+ async cancel(data) {
21
+ this.client = this.getSinchClient();
22
+ const getParams = this.client.extractQueryParams(data, []);
23
+ const headers = {
24
+ 'Content-Type': 'application/json',
25
+ 'Accept': 'application/json',
26
+ };
27
+ const body = '';
28
+ const basePathUrl = `${this.client.apiClientOptions.basePath}/xms/v1/${this.client.apiClientOptions.projectId}/batches/${data['batch_id']}`;
29
+ const requestOptions = await this.client.prepareOptions(basePathUrl, 'DELETE', getParams, headers, body || undefined);
30
+ const url = this.client.prepareUrl(requestOptions.basePath, requestOptions.queryParams);
31
+ return this.client.processCall({
32
+ url,
33
+ requestOptions,
34
+ apiName: this.apiName,
35
+ operationId: 'CancelBatchMessage',
36
+ });
37
+ }
38
+ /**
39
+ * Send delivery feedback for a message
40
+ * Send feedback if your system can confirm successful message delivery. Feedback can only be provided if 'feedback_enabled' was set when batch was submitted.
41
+ * **Batches**: It is possible to submit feedback multiple times for the same batch for different recipients. Feedback without specified recipients is treated as successful message delivery to all recipients referenced in the batch. Note that the 'recipients' key is still required even if the value is empty.
42
+ * **Groups**: If the batch message was creating using a group ID, at least one recipient is required. Excluding recipients (an empty recipient list) does not work and will result in a failed request.
43
+ * @param { DeliveryFeedbackRequestData } data - The data to provide to the API call.
44
+ */
45
+ async sendDeliveryFeedback(data) {
46
+ this.client = this.getSinchClient();
47
+ const getParams = this.client.extractQueryParams(data, []);
48
+ const headers = {
49
+ 'Content-Type': 'application/json',
50
+ 'Accept': '',
51
+ };
52
+ const body = data['deliveryFeedbackRequestBody'] ? JSON.stringify(data['deliveryFeedbackRequestBody']) : '{}';
53
+ const basePathUrl = `${this.client.apiClientOptions.basePath}/xms/v1/${this.client.apiClientOptions.projectId}/batches/${data['batch_id']}/delivery_feedback`;
54
+ const requestOptions = await this.client.prepareOptions(basePathUrl, 'POST', getParams, headers, body || undefined);
55
+ const url = this.client.prepareUrl(requestOptions.basePath, requestOptions.queryParams);
56
+ return this.client.processCall({
57
+ url,
58
+ requestOptions,
59
+ apiName: this.apiName,
60
+ operationId: 'DeliveryFeedback',
61
+ });
62
+ }
63
+ /**
64
+ * Dry run
65
+ * This operation will perform a dry run of a batch which calculates the bodies and number of parts for all messages in the batch without actually sending any messages.
66
+ * @param { DryRunRequestData } data - The data to provide to the API call.
67
+ */
68
+ async dryRun(data) {
69
+ this.client = this.getSinchClient();
70
+ data['number_of_recipients'] = data['number_of_recipients'] !== undefined ? data['number_of_recipients'] : 100;
71
+ const getParams = this.client.extractQueryParams(data, [
72
+ 'per_recipient',
73
+ 'number_of_recipients'
74
+ ]);
75
+ const headers = {
76
+ 'Content-Type': 'application/json',
77
+ 'Accept': 'application/json',
78
+ };
79
+ const body = data['dryRunRequestBody'] ? JSON.stringify(data['dryRunRequestBody']) : '{}';
80
+ const basePathUrl = `${this.client.apiClientOptions.basePath}/xms/v1/${this.client.apiClientOptions.projectId}/batches/dry_run`;
81
+ const requestOptions = await this.client.prepareOptions(basePathUrl, 'POST', getParams, headers, body || undefined);
82
+ const url = this.client.prepareUrl(requestOptions.basePath, requestOptions.queryParams);
83
+ return this.client.processCall({
84
+ url,
85
+ requestOptions,
86
+ apiName: this.apiName,
87
+ operationId: 'Run',
88
+ });
89
+ }
90
+ /**
91
+ * Get a batch message
92
+ * This operation returns a specific batch that matches the provided batch ID.
93
+ * @param { GetBatchMessageRequestData } data - The data to provide to the API call.
94
+ */
95
+ async get(data) {
96
+ this.client = this.getSinchClient();
97
+ const getParams = this.client.extractQueryParams(data, []);
98
+ const headers = {
99
+ 'Content-Type': 'application/json',
100
+ 'Accept': 'application/json',
101
+ };
102
+ const body = '';
103
+ const basePathUrl = `${this.client.apiClientOptions.basePath}/xms/v1/${this.client.apiClientOptions.projectId}/batches/${data['batch_id']}`;
104
+ const requestOptions = await this.client.prepareOptions(basePathUrl, 'GET', getParams, headers, body || undefined);
105
+ const url = this.client.prepareUrl(requestOptions.basePath, requestOptions.queryParams);
106
+ return this.client.processCall({
107
+ url,
108
+ requestOptions,
109
+ apiName: this.apiName,
110
+ operationId: 'GetBatchMessage',
111
+ });
112
+ }
113
+ /**
114
+ * List Batches
115
+ * With the list operation you can list batch messages created in the last 14 days that you have created. This operation supports pagination.
116
+ * @param { ListBatchesRequestData } data - The data to provide to the API call.
117
+ * @return {ApiListPromise<ApiBatchListBatchesInner>}
118
+ */
119
+ list(data) {
120
+ this.client = this.getSinchClient();
121
+ data['page_size'] = data['page_size'] !== undefined ? data['page_size'] : 30;
122
+ const getParams = this.client.extractQueryParams(data, ['page', 'page_size', 'from', 'start_date', 'end_date', 'client_reference']);
123
+ const headers = {
124
+ 'Content-Type': 'application/json',
125
+ 'Accept': 'application/json',
126
+ };
127
+ const body = '';
128
+ const basePathUrl = `${this.client.apiClientOptions.basePath}/xms/v1/${this.client.apiClientOptions.projectId}/batches`;
129
+ const requestOptionsPromise = this.client.prepareOptions(basePathUrl, 'GET', getParams, headers, body || undefined);
130
+ const operationProperties = {
131
+ pagination: sdk_client_1.PaginationEnum.PAGE,
132
+ apiName: this.apiName,
133
+ operationId: 'ListBatches',
134
+ dataKey: 'batches',
135
+ };
136
+ // Create the promise containing the response wrapped as a PageResult
137
+ const listPromise = (0, sdk_client_1.buildPageResultPromise)(this.client, requestOptionsPromise, operationProperties);
138
+ // Add properties to the Promise to offer the possibility to use it as an iterator
139
+ Object.assign(listPromise, (0, sdk_client_1.createIteratorMethodsForPagination)(this.client, requestOptionsPromise, listPromise, operationProperties));
140
+ return listPromise;
141
+ }
142
+ /**
143
+ * Replace a batch
144
+ * This operation will replace all the parameters of a batch with the provided values. It is the same as cancelling a batch and sending a new one instead.
145
+ * @param { ReplaceBatchMessageRequestData } data - The data to provide to the API call.
146
+ */
147
+ async replace(data) {
148
+ this.client = this.getSinchClient();
149
+ const getParams = this.client.extractQueryParams(data, []);
150
+ const headers = {
151
+ 'Content-Type': 'application/json',
152
+ 'Accept': 'application/json',
153
+ };
154
+ const body = data['replaceBatchMessageRequestBody'] ? JSON.stringify(data['replaceBatchMessageRequestBody']) : '{}';
155
+ const basePathUrl = `${this.client.apiClientOptions.basePath}/xms/v1/${this.client.apiClientOptions.projectId}/batches/${data['batch_id']}`;
156
+ const requestOptions = await this.client.prepareOptions(basePathUrl, 'PUT', getParams, headers, body || undefined);
157
+ const url = this.client.prepareUrl(requestOptions.basePath, requestOptions.queryParams);
158
+ return this.client.processCall({
159
+ url,
160
+ requestOptions,
161
+ apiName: this.apiName,
162
+ operationId: 'ReplaceBatch',
163
+ });
164
+ }
165
+ /**
166
+ * Send
167
+ * Send a message or a batch of messages. Depending on the length of the body, one message might be split into multiple parts and charged accordingly. Any groups targeted in a scheduled batch will be evaluated at the time of sending. If a group is deleted between batch creation and scheduled date, it will be considered empty. Be sure to use the correct &lt;a href&#x3D;\&quot;/docs/sms/api-reference/#base-url\&quot; target&#x3D;\&quot;_blank\&quot;&gt;region&lt;/a&gt; in the server URL.
168
+ * @param { SendSMSRequestData } data - The data to provide to the API call.
169
+ */
170
+ async send(data) {
171
+ this.client = this.getSinchClient();
172
+ const getParams = this.client.extractQueryParams(data, []);
173
+ const headers = {
174
+ 'Content-Type': 'application/json',
175
+ 'Accept': 'application/json',
176
+ };
177
+ const body = data['sendSMSRequestBody'] ? JSON.stringify(data['sendSMSRequestBody']) : '{}';
178
+ const basePathUrl = `${this.client.apiClientOptions.basePath}/xms/v1/${this.client.apiClientOptions.projectId}/batches`;
179
+ const requestOptions = await this.client.prepareOptions(basePathUrl, 'POST', getParams, headers, body || undefined);
180
+ const url = this.client.prepareUrl(requestOptions.basePath, requestOptions.queryParams);
181
+ return this.client.processCall({
182
+ url,
183
+ requestOptions,
184
+ apiName: this.apiName,
185
+ operationId: 'SendSMS',
186
+ });
187
+ }
188
+ /**
189
+ * Update a Batch message
190
+ * This operation updates all specified parameters of a batch that matches the provided batch ID.
191
+ * @param { UpdateBatchMessageRequestData } data - The data to provide to the API call.
192
+ */
193
+ async update(data) {
194
+ this.client = this.getSinchClient();
195
+ const getParams = this.client.extractQueryParams(data, []);
196
+ const headers = {
197
+ 'Content-Type': 'application/json',
198
+ 'Accept': 'application/json',
199
+ };
200
+ const body = data['updateBatchMessageRequestBody'] ? JSON.stringify(data['updateBatchMessageRequestBody']) : '{}';
201
+ const basePathUrl = `${this.client.apiClientOptions.basePath}/xms/v1/${this.client.apiClientOptions.projectId}/batches/${data['batch_id']}`;
202
+ const requestOptions = await this.client.prepareOptions(basePathUrl, 'POST', getParams, headers, body || undefined);
203
+ const url = this.client.prepareUrl(requestOptions.basePath, requestOptions.queryParams);
204
+ return this.client.processCall({
205
+ url,
206
+ requestOptions,
207
+ apiName: this.apiName,
208
+ operationId: 'UpdateBatchMessage',
209
+ });
210
+ }
211
+ }
212
+ exports.BatchesApi = BatchesApi;
213
+ //# sourceMappingURL=batches-api.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"batches-api.js","sourceRoot":"","sources":["../../../../src/rest/v1/batches/batches-api.ts"],"names":[],"mappings":";;;AAYA,kDAQ2B;AAC3B,wCAAoC;AAuDpC,MAAa,UAAW,SAAQ,gBAAM;IAEpC;;;;OAIG;IACH,YAAY,qBAA4C;QACtD,KAAK,CAAC,qBAAqB,EAAE,YAAY,CAAC,CAAC;IAC7C,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,MAAM,CAAC,IAAmC;QACrD,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,cAAc,EAAE,CAAC;QACpC,MAAM,SAAS,GAAG,IAAI,CAAC,MAAM,CAAC,kBAAkB,CAAgC,IAAI,EAAE,EAAa,CAAC,CAAC;QACrG,MAAM,OAAO,GAA0C;YACrD,cAAc,EAAE,kBAAkB;YAClC,QAAQ,EAAE,kBAAkB;SAC7B,CAAC;QAEF,MAAM,IAAI,GAAgB,EAAE,CAAC;QAC7B,MAAM,WAAW,GACb,GAAG,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,QAAQ,WAAW,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,SAAS,YAAY,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC;QAE5H,MAAM,cAAc,GAChB,MAAM,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,WAAW,EAAE,QAAQ,EAAE,SAAS,EAAE,OAAO,EAAE,IAAI,IAAI,SAAS,CAAC,CAAC;QACnG,MAAM,GAAG,GAAG,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,cAAc,CAAC,QAAQ,EAAE,cAAc,CAAC,WAAW,CAAC,CAAC;QAExF,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAA6B;YACzD,GAAG;YACH,cAAc;YACd,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,WAAW,EAAE,oBAAoB;SAClC,CAAC,CAAC;IACL,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,oBAAoB,CAAC,IAAiC;QACjE,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,cAAc,EAAE,CAAC;QACpC,MAAM,SAAS,GAAG,IAAI,CAAC,MAAM,CAAC,kBAAkB,CAA8B,IAAI,EAAE,EAAa,CAAC,CAAC;QACnG,MAAM,OAAO,GAA0C;YACrD,cAAc,EAAE,kBAAkB;YAClC,QAAQ,EAAE,EAAE;SACb,CAAC;QAEF,MAAM,IAAI,GACN,IAAI,CAAC,6BAA6B,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,6BAA6B,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;QACrG,MAAM,WAAW,GAAG,GAAG,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,QAAQ,WAAW,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,SAAS,YAAY,IAAI,CAAC,UAAU,CAAC,oBAAoB,CAAC;QAE9J,MAAM,cAAc,GAChB,MAAM,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,WAAW,EAAE,MAAM,EAAE,SAAS,EAAE,OAAO,EAAE,IAAI,IAAI,SAAS,CAAC,CAAC;QACjG,MAAM,GAAG,GAAG,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,cAAc,CAAC,QAAQ,EAAE,cAAc,CAAC,WAAW,CAAC,CAAC;QAExF,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAAO;YACnC,GAAG;YACH,cAAc;YACd,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,WAAW,EAAE,kBAAkB;SAChC,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,MAAM,CAAC,IAAuB;QACzC,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,cAAc,EAAE,CAAC;QACpC,IAAI,CAAC,sBAAsB,CAAC,GAAG,IAAI,CAAC,sBAAsB,CAAC,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,sBAAsB,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC;QAC/G,MAAM,SAAS,GAAG,IAAI,CAAC,MAAM,CAAC,kBAAkB,CAAoB,IAAI,EAAE;YACxE,eAAe;YACf,sBAAsB;SAAC,CAAC,CAAC;QAC3B,MAAM,OAAO,GAA0C;YACrD,cAAc,EAAE,kBAAkB;YAClC,QAAQ,EAAE,kBAAkB;SAC7B,CAAC;QAEF,MAAM,IAAI,GAAgB,IAAI,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;QACvG,MAAM,WAAW,GAAG,GAAG,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,QAAQ,WAAW,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,SAAS,kBAAkB,CAAC;QAEhI,MAAM,cAAc,GAChB,MAAM,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,WAAW,EAAE,MAAM,EAAE,SAAS,EAAE,OAAO,EAAE,IAAI,IAAI,SAAS,CAAC,CAAC;QACjG,MAAM,GAAG,GAAG,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,cAAc,CAAC,QAAQ,EAAE,cAAc,CAAC,WAAW,CAAC,CAAC;QAExF,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAAiB;YAC7C,GAAG;YACH,cAAc;YACd,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,WAAW,EAAE,KAAK;SACnB,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,GAAG,CAAC,IAAgC;QAC/C,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,cAAc,EAAE,CAAC;QACpC,MAAM,SAAS,GAAG,IAAI,CAAC,MAAM,CAAC,kBAAkB,CAA6B,IAAI,EAAE,EAAa,CAAC,CAAC;QAClG,MAAM,OAAO,GAA0C;YACrD,cAAc,EAAE,kBAAkB;YAClC,QAAQ,EAAE,kBAAkB;SAC7B,CAAC;QAEF,MAAM,IAAI,GAAgB,EAAE,CAAC;QAC7B,MAAM,WAAW,GAAG,GAAG,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,QAAQ,WAAW,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,SAAS,YAAY,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC;QAE5I,MAAM,cAAc,GAChB,MAAM,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,WAAW,EAAE,KAAK,EAAE,SAAS,EAAE,OAAO,EAAE,IAAI,IAAI,SAAS,CAAC,CAAC;QAChG,MAAM,GAAG,GAAG,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,cAAc,CAAC,QAAQ,EAAE,cAAc,CAAC,WAAW,CAAC,CAAC;QAExF,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAAkB;YAC9C,GAAG;YACH,cAAc;YACd,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,WAAW,EAAE,iBAAiB;SAC/B,CAAC,CAAC;IACL,CAAC;IAED;;;;;MAKE;IACK,IAAI,CAAC,IAA4B;QACtC,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,cAAc,EAAE,CAAC;QACpC,IAAI,CAAC,WAAW,CAAC,GAAG,IAAI,CAAC,WAAW,CAAC,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QAC7E,MAAM,SAAS,GAAG,IAAI,CAAC,MAAM,CAAC,kBAAkB,CAC9C,IAAI,EACJ,CAAC,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,YAAY,EAAE,UAAU,EAAE,kBAAkB,CAAC,CAC5E,CAAC;QACF,MAAM,OAAO,GAA0C;YACrD,cAAc,EAAE,kBAAkB;YAClC,QAAQ,EAAE,kBAAkB;SAC7B,CAAC;QAEF,MAAM,IAAI,GAAgB,EAAE,CAAC;QAC7B,MAAM,WAAW,GAAG,GAAG,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,QAAQ,WAAW,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,SAAS,UAAU,CAAC;QAExH,MAAM,qBAAqB,GACvB,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,WAAW,EAAE,KAAK,EAAE,SAAS,EAAE,OAAO,EAAE,IAAI,IAAI,SAAS,CAAC,CAAC;QAE1F,MAAM,mBAAmB,GAA2B;YAClD,UAAU,EAAE,2BAAc,CAAC,IAAI;YAC/B,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,WAAW,EAAE,aAAa;YAC1B,OAAO,EAAE,SAAS;SACnB,CAAC;QAEF,qEAAqE;QACrE,MAAM,WAAW,GAAG,IAAA,mCAAsB,EACxC,IAAI,CAAC,MAAM,EACX,qBAAqB,EACrB,mBAAmB,CAAC,CAAC;QAEvB,kFAAkF;QAClF,MAAM,CAAC,MAAM,CACX,WAAW,EACX,IAAA,+CAAkC,EAChC,IAAI,CAAC,MAAM,EAAE,qBAAqB,EAAE,WAAW,EAAE,mBAAmB,CAAC,CACxE,CAAC;QAEF,OAAO,WAAuD,CAAC;IACjE,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,OAAO,CAAC,IAAoC;QACvD,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,cAAc,EAAE,CAAC;QACpC,MAAM,SAAS,GAAG,IAAI,CAAC,MAAM,CAAC,kBAAkB,CAAiC,IAAI,EAAE,EAAa,CAAC,CAAC;QACtG,MAAM,OAAO,GAA0C;YACrD,cAAc,EAAE,kBAAkB;YAClC,QAAQ,EAAE,kBAAkB;SAC7B,CAAC;QAEF,MAAM,IAAI,GACN,IAAI,CAAC,gCAAgC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,gCAAgC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;QAC3G,MAAM,WAAW,GAAG,GAAG,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,QAAQ,WAAW,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,SAAS,YAAY,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC;QAE5I,MAAM,cAAc,GAChB,MAAM,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,WAAW,EAAE,KAAK,EAAE,SAAS,EAAE,OAAO,EAAE,IAAI,IAAI,SAAS,CAAC,CAAC;QAChG,MAAM,GAAG,GAAG,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,cAAc,CAAC,QAAQ,EAAE,cAAc,CAAC,WAAW,CAAC,CAAC;QAExF,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAA8B;YAC1D,GAAG;YACH,cAAc;YACd,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,WAAW,EAAE,cAAc;SAC5B,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,IAAI,CAAC,IAAwB;QACxC,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,cAAc,EAAE,CAAC;QACpC,MAAM,SAAS,GAAG,IAAI,CAAC,MAAM,CAAC,kBAAkB,CAAqB,IAAI,EAAE,EAAa,CAAC,CAAC;QAC1F,MAAM,OAAO,GAA0C;YACrD,cAAc,EAAE,kBAAkB;YAClC,QAAQ,EAAE,kBAAkB;SAC7B,CAAC;QAEF,MAAM,IAAI,GAAgB,IAAI,CAAC,oBAAoB,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;QACzG,MAAM,WAAW,GAAG,GAAG,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,QAAQ,WAAW,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,SAAS,UAAU,CAAC;QAExH,MAAM,cAAc,GAChB,MAAM,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,WAAW,EAAE,MAAM,EAAE,SAAS,EAAE,OAAO,EAAE,IAAI,IAAI,SAAS,CAAC,CAAC;QACjG,MAAM,GAAG,GAAG,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,cAAc,CAAC,QAAQ,EAAE,cAAc,CAAC,WAAW,CAAC,CAAC;QAExF,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAAkB;YAC9C,GAAG;YACH,cAAc;YACd,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,WAAW,EAAE,SAAS;SACvB,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,MAAM,CAAC,IAAmC;QACrD,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,cAAc,EAAE,CAAC;QACpC,MAAM,SAAS,GAAG,IAAI,CAAC,MAAM,CAAC,kBAAkB,CAAgC,IAAI,EAAE,EAAa,CAAC,CAAC;QACrG,MAAM,OAAO,GAA0C;YACrD,cAAc,EAAE,kBAAkB;YAClC,QAAQ,EAAE,kBAAkB;SAC7B,CAAC;QAEF,MAAM,IAAI,GACN,IAAI,CAAC,+BAA+B,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,+BAA+B,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;QACzG,MAAM,WAAW,GAAG,GAAG,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,QAAQ,WAAW,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,SAAS,YAAY,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC;QAE5I,MAAM,cAAc,GAChB,MAAM,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,WAAW,EAAE,MAAM,EAAE,SAAS,EAAE,OAAO,EAAE,IAAI,IAAI,SAAS,CAAC,CAAC;QACjG,MAAM,GAAG,GAAG,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,cAAc,CAAC,QAAQ,EAAE,cAAc,CAAC,WAAW,CAAC,CAAC;QAExF,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAAkB;YAC9C,GAAG;YACH,cAAc;YACd,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,WAAW,EAAE,oBAAoB;SAClC,CAAC,CAAC;IACL,CAAC;CAEF;AAvQD,gCAuQC"}
@@ -0,0 +1 @@
1
+ export * from './batches-api';
@@ -0,0 +1,18 @@
1
+ "use strict";
2
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
+ if (k2 === undefined) k2 = k;
4
+ var desc = Object.getOwnPropertyDescriptor(m, k);
5
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
6
+ desc = { enumerable: true, get: function() { return m[k]; } };
7
+ }
8
+ Object.defineProperty(o, k2, desc);
9
+ }) : (function(o, m, k, k2) {
10
+ if (k2 === undefined) k2 = k;
11
+ o[k2] = m[k];
12
+ }));
13
+ var __exportStar = (this && this.__exportStar) || function(m, exports) {
14
+ for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
15
+ };
16
+ Object.defineProperty(exports, "__esModule", { value: true });
17
+ __exportStar(require("./batches-api"), exports);
18
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/rest/v1/batches/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,gDAA8B"}
@@ -0,0 +1,63 @@
1
+ import { DeliveryReport, DeliveryReportStatusEnum, RecipientDeliveryReport } from '../../../models';
2
+ import { ApiListPromise, SinchClientParameters } from '@sinch/sdk-client';
3
+ import { SmsApi } from '../sms-api';
4
+ export type GetDeliveryReportByBatchIdTypeEnum = 'summary' | 'full';
5
+ export interface GetDeliveryReportByBatchIdRequestData {
6
+ /** The batch ID you received from sending a message. */
7
+ 'batch_id': string;
8
+ /** The type of delivery report. - A `summary` will count the number of messages sent per status. - A `full` report give that of a `summary` report but in addition, lists phone numbers. */
9
+ 'type'?: GetDeliveryReportByBatchIdTypeEnum;
10
+ /** Comma separated list of delivery_report_statuses to include */
11
+ 'status'?: DeliveryReportStatusEnum[];
12
+ /** Comma separated list of delivery_receipt_error_codes to include\" */
13
+ 'code'?: string;
14
+ }
15
+ export interface GetDeliveryReportByPhoneNumberRequestData {
16
+ /** The batch ID you received from sending a message. */
17
+ 'batch_id': string;
18
+ /** Phone number for which you to want to search. */
19
+ 'recipient_msisdn': string;
20
+ }
21
+ export interface GetDeliveryReportsRequestData {
22
+ /** The page number starting from 0. */
23
+ 'page'?: number;
24
+ /** Determines the size of a page. */
25
+ 'page_size'?: number;
26
+ /** Only list messages received at or after this date/time. Default: 24h ago */
27
+ 'start_date'?: Date;
28
+ /** Only list messages received before this date/time. */
29
+ 'end_date'?: Date;
30
+ /** Comma separated list of delivery report statuses to include. */
31
+ 'status'?: DeliveryReportStatusEnum[];
32
+ /** Comma separated list of delivery receipt error codes to include. */
33
+ 'code'?: string;
34
+ /** Client reference to include */
35
+ 'client_reference'?: string;
36
+ }
37
+ export declare class DeliveryReportsApi extends SmsApi {
38
+ /**
39
+ * Initialize your interface
40
+ *
41
+ * @param {SinchClientParameters} sinchClientParameters - The parameters used to initialize the API Client.
42
+ */
43
+ constructor(sinchClientParameters: SinchClientParameters);
44
+ /**
45
+ * Retrieve a delivery report
46
+ * Delivery reports can be retrieved even if no callback was requested. The difference between a summary and a full report is only that the full report contains the phone numbers in &lt;a href&#x3D;\&quot;https://community.sinch.com/t5/Glossary/E-164/ta-p/7537\&quot; target&#x3D;\&quot;_blank\&quot;&gt;E.164&lt;/a&gt; format for each status code.
47
+ * @param { GetDeliveryReportByBatchIdRequestData } data - The data to provide to the API call.
48
+ */
49
+ get(data: GetDeliveryReportByBatchIdRequestData): Promise<DeliveryReport>;
50
+ /**
51
+ * Retrieve a recipient delivery report
52
+ * A recipient delivery report contains the message status for a single recipient phone number.
53
+ * @param { GetDeliveryReportByPhoneNumberRequestData } data - The data to provide to the API call.
54
+ */
55
+ getByPhoneNumber(data: GetDeliveryReportByPhoneNumberRequestData): Promise<RecipientDeliveryReport>;
56
+ /**
57
+ * Retrieve a list of delivery reports
58
+ * Get a list of finished delivery reports. This operation supports pagination.
59
+ * @param { GetDeliveryReportsRequestData } data - The data to provide to the API call.
60
+ * @return {ApiListPromise<RecipientDeliveryReport>}
61
+ */
62
+ list(data: GetDeliveryReportsRequestData): ApiListPromise<RecipientDeliveryReport>;
63
+ }
@@ -0,0 +1,22 @@
1
+ /// <reference types="jest" />
2
+ import { DeliveryReportsApi, GetDeliveryReportByBatchIdRequestData, GetDeliveryReportByPhoneNumberRequestData, GetDeliveryReportsRequestData } from './delivery-reports-api';
3
+ import { DeliveryReport, RecipientDeliveryReport } from '../../../models';
4
+ import { ApiListPromise } from '@sinch/sdk-client';
5
+ export declare class DeliveryReportsApiFixture implements Partial<Readonly<DeliveryReportsApi>> {
6
+ /**
7
+ * Fixture associated to function getByBatchId
8
+ */
9
+ get: jest.Mock<Promise<DeliveryReport>, [
10
+ GetDeliveryReportByBatchIdRequestData
11
+ ]>;
12
+ /**
13
+ * Fixture associated to function getDeliveryReportByPhoneNumber
14
+ */
15
+ getByPhoneNumber: jest.Mock<Promise<RecipientDeliveryReport>, [
16
+ GetDeliveryReportByPhoneNumberRequestData
17
+ ]>;
18
+ /**
19
+ * Fixture associated to function list
20
+ */
21
+ list: jest.Mock<ApiListPromise<RecipientDeliveryReport>, [GetDeliveryReportsRequestData]>;
22
+ }
@@ -0,0 +1,21 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.DeliveryReportsApiFixture = void 0;
4
+ class DeliveryReportsApiFixture {
5
+ constructor() {
6
+ /**
7
+ * Fixture associated to function getByBatchId
8
+ */
9
+ this.get = jest.fn();
10
+ /**
11
+ * Fixture associated to function getDeliveryReportByPhoneNumber
12
+ */
13
+ this.getByPhoneNumber = jest.fn();
14
+ /**
15
+ * Fixture associated to function list
16
+ */
17
+ this.list = jest.fn();
18
+ }
19
+ }
20
+ exports.DeliveryReportsApiFixture = DeliveryReportsApiFixture;
21
+ //# sourceMappingURL=delivery-reports-api.jest.fixture.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"delivery-reports-api.jest.fixture.js","sourceRoot":"","sources":["../../../../src/rest/v1/delivery-reports/delivery-reports-api.jest.fixture.ts"],"names":[],"mappings":";;;AAIA,MAAa,yBAAyB;IAAtC;QAEE;;YAEI;QACG,QAAG,GACmC,IAAI,CAAC,EAAE,EAAE,CAAC;QACvD;;YAEI;QACG,qBAAgB,GAC0B,IAAI,CAAC,EAAE,EAAE,CAAC;QAC3D;;YAEI;QACG,SAAI,GAAwF,IAAI,CAAC,EAAE,EAAE,CAAC;IAC/G,CAAC;CAAA;AAhBD,8DAgBC"}