@unlimited-messaging/sdk 0.1.2 → 0.1.4

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 (228) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +20 -9
  3. package/package.json +34 -5
  4. package/src/Client.d.ts +9 -6
  5. package/src/Client.js +11 -6
  6. package/src/api/errors/BadRequestError.d.ts +8 -0
  7. package/src/api/errors/BadRequestError.js +52 -0
  8. package/src/api/errors/ForbiddenError.d.ts +8 -0
  9. package/src/api/errors/ForbiddenError.js +52 -0
  10. package/src/api/errors/NotFoundError.d.ts +8 -0
  11. package/src/api/errors/NotFoundError.js +52 -0
  12. package/src/api/errors/UnauthorizedError.d.ts +8 -0
  13. package/src/api/errors/UnauthorizedError.js +52 -0
  14. package/src/api/errors/UnprocessableEntityError.d.ts +8 -0
  15. package/src/api/errors/UnprocessableEntityError.js +52 -0
  16. package/src/api/errors/index.d.ts +5 -0
  17. package/src/api/errors/index.js +21 -0
  18. package/src/api/index.d.ts +1 -0
  19. package/src/api/index.js +1 -0
  20. package/src/api/resources/apiKeys/client/Client.d.ts +81 -0
  21. package/src/api/resources/apiKeys/client/Client.js +288 -0
  22. package/src/api/resources/apiKeys/client/requests/ApiKeyCreateRequest.d.ts +13 -0
  23. package/src/api/resources/apiKeys/client/requests/ApiKeyRevokeRequest.d.ts +9 -0
  24. package/src/api/resources/apiKeys/client/requests/index.d.ts +2 -0
  25. package/src/api/resources/apiKeys/types/ApiKeyCreateResponse.d.ts +14 -0
  26. package/src/api/resources/apiKeys/types/ApiKeyListResponseItem.d.ts +13 -0
  27. package/src/api/resources/apiKeys/types/index.d.ts +2 -0
  28. package/src/api/resources/apiKeys/types/index.js +18 -0
  29. package/src/api/resources/index.d.ts +9 -5
  30. package/src/api/resources/index.js +10 -6
  31. package/src/api/resources/messages/client/Client.d.ts +92 -0
  32. package/src/api/resources/{message → messages}/client/Client.js +96 -37
  33. package/src/api/resources/{message → messages}/client/requests/MessageFindAllRequest.d.ts +2 -0
  34. package/src/api/resources/{message → messages}/client/requests/MessageSendRequest.d.ts +1 -1
  35. package/src/api/resources/messages/types/MessageFindAllRequestChannel.d.ts +9 -0
  36. package/src/api/resources/messages/types/MessageFindAllRequestChannel.js +11 -0
  37. package/src/api/resources/messages/types/MessageFindAllRequestDirection.d.ts +8 -0
  38. package/src/api/resources/messages/types/MessageFindAllRequestDirection.js +10 -0
  39. package/src/api/resources/{message → messages}/types/MessageFindAllRequestStatus.d.ts +2 -1
  40. package/src/api/resources/{message → messages}/types/MessageFindAllRequestStatus.js +1 -0
  41. package/src/api/resources/{message → messages}/types/MessageFindAllResponseDataItem.d.ts +2 -0
  42. package/src/api/resources/messages/types/MessageFindAllResponseDataItem.js +5 -0
  43. package/src/api/resources/messages/types/MessageFindAllResponseDataItemChannel.d.ts +9 -0
  44. package/src/api/resources/messages/types/MessageFindAllResponseDataItemChannel.js +11 -0
  45. package/src/api/resources/{message → messages}/types/MessageFindAllResponseDataItemStatus.d.ts +2 -1
  46. package/src/api/resources/{message → messages}/types/MessageFindAllResponseDataItemStatus.js +1 -0
  47. package/src/api/resources/{message → messages}/types/MessageFindOneResponse.d.ts +2 -0
  48. package/src/api/resources/messages/types/MessageFindOneResponse.js +5 -0
  49. package/src/api/resources/messages/types/MessageFindOneResponseChannel.d.ts +9 -0
  50. package/src/api/resources/messages/types/MessageFindOneResponseChannel.js +11 -0
  51. package/src/api/resources/{message → messages}/types/MessageFindOneResponseStatus.d.ts +2 -1
  52. package/src/api/resources/{message → messages}/types/MessageFindOneResponseStatus.js +1 -0
  53. package/src/api/resources/{message → messages}/types/MessageSendResponse.d.ts +2 -0
  54. package/src/api/resources/messages/types/MessageSendResponse.js +5 -0
  55. package/src/api/resources/messages/types/MessageSendResponseChannel.d.ts +9 -0
  56. package/src/api/resources/messages/types/MessageSendResponseChannel.js +11 -0
  57. package/src/api/resources/{message → messages}/types/MessageSendResponseStatus.d.ts +2 -1
  58. package/src/api/resources/{message → messages}/types/MessageSendResponseStatus.js +1 -0
  59. package/src/{serialization/resources/message → api/resources/messages}/types/index.d.ts +5 -0
  60. package/src/{serialization/resources/message → api/resources/messages}/types/index.js +5 -0
  61. package/src/api/resources/siMs/client/Client.d.ts +137 -0
  62. package/src/api/resources/siMs/client/Client.js +521 -0
  63. package/src/api/resources/siMs/client/index.d.ts +1 -0
  64. package/src/api/resources/{sim/types → siMs/client}/index.js +1 -1
  65. package/src/api/resources/siMs/client/requests/SimGetSimQrCodeRequest.d.ts +9 -0
  66. package/src/api/resources/siMs/client/requests/SimGetSimQrCodeRequest.js +5 -0
  67. package/src/api/resources/siMs/client/requests/SimGetSimRequest.d.ts +9 -0
  68. package/src/api/resources/siMs/client/requests/SimGetSimRequest.js +5 -0
  69. package/src/api/resources/siMs/client/requests/SimUnlinkSimRequest.d.ts +9 -0
  70. package/src/api/resources/siMs/client/requests/SimUnlinkSimRequest.js +5 -0
  71. package/src/api/resources/siMs/client/requests/SimUpdateSimRequest.d.ts +12 -0
  72. package/src/api/resources/siMs/client/requests/SimUpdateSimRequest.js +5 -0
  73. package/src/api/resources/siMs/client/requests/index.d.ts +4 -0
  74. package/src/api/resources/siMs/client/requests/index.js +2 -0
  75. package/src/api/resources/{sim → siMs}/types/SimGetLinkedSimsResponseItem.d.ts +4 -0
  76. package/src/api/resources/siMs/types/SimGetLinkedSimsResponseItem.js +5 -0
  77. package/src/api/resources/siMs/types/SimGetLinkedSimsResponseItemStatus.d.ts +11 -0
  78. package/src/api/resources/siMs/types/SimGetLinkedSimsResponseItemStatus.js +13 -0
  79. package/src/api/resources/siMs/types/SimGetLinkedSimsResponseItemType.d.ts +8 -0
  80. package/src/api/resources/siMs/types/SimGetLinkedSimsResponseItemType.js +10 -0
  81. package/src/api/resources/siMs/types/SimGetSimQrCodeResponse.d.ts +6 -0
  82. package/src/api/resources/siMs/types/SimGetSimQrCodeResponse.js +5 -0
  83. package/src/api/resources/siMs/types/SimGetSimResponse.d.ts +14 -0
  84. package/src/api/resources/siMs/types/SimGetSimResponse.js +5 -0
  85. package/src/api/resources/siMs/types/SimGetSimResponseStatus.d.ts +11 -0
  86. package/src/api/resources/siMs/types/SimGetSimResponseStatus.js +13 -0
  87. package/src/api/resources/siMs/types/SimGetSimResponseType.d.ts +8 -0
  88. package/src/api/resources/siMs/types/SimGetSimResponseType.js +10 -0
  89. package/src/api/resources/siMs/types/SimLinkSimResponse.d.ts +6 -0
  90. package/src/api/resources/siMs/types/SimLinkSimResponse.js +5 -0
  91. package/src/api/resources/siMs/types/SimUpdateSimResponse.d.ts +14 -0
  92. package/src/api/resources/siMs/types/SimUpdateSimResponse.js +5 -0
  93. package/src/api/resources/siMs/types/SimUpdateSimResponseStatus.d.ts +11 -0
  94. package/src/api/resources/siMs/types/SimUpdateSimResponseStatus.js +13 -0
  95. package/src/api/resources/siMs/types/SimUpdateSimResponseType.d.ts +8 -0
  96. package/src/api/resources/siMs/types/SimUpdateSimResponseType.js +10 -0
  97. package/src/api/resources/siMs/types/index.d.ts +11 -0
  98. package/src/api/resources/siMs/types/index.js +27 -0
  99. package/src/serialization/resources/apiKeys/client/apiKeyList.d.ts +11 -0
  100. package/src/serialization/resources/apiKeys/client/apiKeyList.js +42 -0
  101. package/src/serialization/resources/apiKeys/client/index.d.ts +2 -0
  102. package/src/serialization/resources/{sim → apiKeys}/client/index.js +6 -2
  103. package/src/serialization/resources/apiKeys/client/requests/ApiKeyCreateRequest.d.ts +13 -0
  104. package/src/serialization/resources/apiKeys/client/requests/ApiKeyCreateRequest.js +44 -0
  105. package/src/serialization/resources/apiKeys/client/requests/index.d.ts +1 -0
  106. package/src/serialization/resources/apiKeys/client/requests/index.js +5 -0
  107. package/src/serialization/resources/apiKeys/types/ApiKeyCreateResponse.d.ts +20 -0
  108. package/src/serialization/resources/apiKeys/types/ApiKeyCreateResponse.js +51 -0
  109. package/src/serialization/resources/apiKeys/types/ApiKeyListResponseItem.d.ts +19 -0
  110. package/src/serialization/resources/{sim/types/SimGetLinkedSimsResponseItem.js → apiKeys/types/ApiKeyListResponseItem.js} +7 -4
  111. package/src/serialization/resources/apiKeys/types/index.d.ts +2 -0
  112. package/src/serialization/resources/apiKeys/types/index.js +18 -0
  113. package/src/serialization/resources/index.d.ts +9 -5
  114. package/src/serialization/resources/index.js +10 -6
  115. package/src/serialization/resources/messages/client/index.d.ts +1 -0
  116. package/src/serialization/resources/{sim/types → messages/client}/index.js +1 -1
  117. package/src/serialization/resources/{message → messages}/client/requests/MessageSendRequest.d.ts +1 -1
  118. package/src/serialization/resources/{message → messages}/client/requests/MessageSendRequest.js +1 -1
  119. package/src/serialization/resources/messages/index.d.ts +2 -0
  120. package/src/serialization/resources/messages/index.js +18 -0
  121. package/src/serialization/resources/messages/types/MessageFindAllRequestChannel.d.ts +10 -0
  122. package/src/serialization/resources/messages/types/MessageFindAllRequestChannel.js +41 -0
  123. package/src/serialization/resources/messages/types/MessageFindAllRequestDirection.d.ts +10 -0
  124. package/src/serialization/resources/messages/types/MessageFindAllRequestDirection.js +41 -0
  125. package/src/serialization/resources/{message → messages}/types/MessageFindAllRequestStatus.d.ts +1 -1
  126. package/src/serialization/resources/{message → messages}/types/MessageFindAllRequestStatus.js +1 -1
  127. package/src/serialization/resources/{message → messages}/types/MessageFindAllResponseDataItem.d.ts +3 -0
  128. package/src/serialization/resources/{message → messages}/types/MessageFindAllResponseDataItem.js +3 -0
  129. package/src/serialization/resources/messages/types/MessageFindAllResponseDataItemChannel.d.ts +10 -0
  130. package/src/serialization/resources/messages/types/MessageFindAllResponseDataItemChannel.js +41 -0
  131. package/src/serialization/resources/{message → messages}/types/MessageFindAllResponseDataItemStatus.d.ts +1 -1
  132. package/src/serialization/resources/{message → messages}/types/MessageFindAllResponseDataItemStatus.js +1 -1
  133. package/src/serialization/resources/{message → messages}/types/MessageFindOneResponse.d.ts +3 -0
  134. package/src/serialization/resources/{message → messages}/types/MessageFindOneResponse.js +3 -0
  135. package/src/serialization/resources/messages/types/MessageFindOneResponseChannel.d.ts +10 -0
  136. package/src/serialization/resources/messages/types/MessageFindOneResponseChannel.js +41 -0
  137. package/src/serialization/resources/{message → messages}/types/MessageFindOneResponseStatus.d.ts +1 -1
  138. package/src/serialization/resources/{message → messages}/types/MessageFindOneResponseStatus.js +1 -1
  139. package/src/serialization/resources/{message → messages}/types/MessageSendResponse.d.ts +3 -0
  140. package/src/serialization/resources/{message → messages}/types/MessageSendResponse.js +3 -0
  141. package/src/serialization/resources/messages/types/MessageSendResponseChannel.d.ts +10 -0
  142. package/src/serialization/resources/messages/types/MessageSendResponseChannel.js +41 -0
  143. package/src/serialization/resources/{message → messages}/types/MessageSendResponseStatus.d.ts +1 -1
  144. package/src/serialization/resources/{message → messages}/types/MessageSendResponseStatus.js +1 -1
  145. package/src/{api/resources/message → serialization/resources/messages}/types/index.d.ts +5 -0
  146. package/src/{api/resources/message → serialization/resources/messages}/types/index.js +5 -0
  147. package/src/serialization/resources/siMs/client/index.d.ts +2 -0
  148. package/src/serialization/resources/siMs/client/index.js +41 -0
  149. package/src/serialization/resources/siMs/client/requests/SimUpdateSimRequest.d.ts +12 -0
  150. package/src/serialization/resources/siMs/client/requests/SimUpdateSimRequest.js +43 -0
  151. package/src/serialization/resources/siMs/client/requests/index.d.ts +1 -0
  152. package/src/serialization/resources/siMs/client/requests/index.js +5 -0
  153. package/src/serialization/resources/{sim/client/getLinkedSims.d.ts → siMs/client/simGetLinkedSims.d.ts} +1 -1
  154. package/src/serialization/resources/siMs/index.d.ts +2 -0
  155. package/src/serialization/resources/siMs/index.js +18 -0
  156. package/src/serialization/resources/{sim → siMs}/types/SimGetLinkedSimsResponseItem.d.ts +5 -0
  157. package/src/serialization/resources/siMs/types/SimGetLinkedSimsResponseItem.js +52 -0
  158. package/src/serialization/resources/siMs/types/SimGetLinkedSimsResponseItemStatus.d.ts +10 -0
  159. package/src/serialization/resources/siMs/types/SimGetLinkedSimsResponseItemStatus.js +41 -0
  160. package/src/serialization/resources/siMs/types/SimGetLinkedSimsResponseItemType.d.ts +10 -0
  161. package/src/serialization/resources/siMs/types/SimGetLinkedSimsResponseItemType.js +41 -0
  162. package/src/serialization/resources/siMs/types/SimGetSimQrCodeResponse.d.ts +12 -0
  163. package/src/serialization/resources/siMs/types/SimGetSimQrCodeResponse.js +43 -0
  164. package/src/serialization/resources/siMs/types/SimGetSimResponse.d.ts +21 -0
  165. package/src/serialization/resources/siMs/types/SimGetSimResponse.js +52 -0
  166. package/src/serialization/resources/siMs/types/SimGetSimResponseStatus.d.ts +10 -0
  167. package/src/serialization/resources/siMs/types/SimGetSimResponseStatus.js +41 -0
  168. package/src/serialization/resources/siMs/types/SimGetSimResponseType.d.ts +10 -0
  169. package/src/serialization/resources/siMs/types/SimGetSimResponseType.js +41 -0
  170. package/src/serialization/resources/siMs/types/SimLinkSimResponse.d.ts +12 -0
  171. package/src/serialization/resources/siMs/types/SimLinkSimResponse.js +43 -0
  172. package/src/serialization/resources/siMs/types/SimUpdateSimResponse.d.ts +21 -0
  173. package/src/serialization/resources/siMs/types/SimUpdateSimResponse.js +52 -0
  174. package/src/serialization/resources/siMs/types/SimUpdateSimResponseStatus.d.ts +10 -0
  175. package/src/serialization/resources/siMs/types/SimUpdateSimResponseStatus.js +41 -0
  176. package/src/serialization/resources/siMs/types/SimUpdateSimResponseType.d.ts +10 -0
  177. package/src/serialization/resources/siMs/types/SimUpdateSimResponseType.js +41 -0
  178. package/src/serialization/resources/siMs/types/index.d.ts +11 -0
  179. package/src/serialization/resources/siMs/types/index.js +27 -0
  180. package/src/api/resources/message/client/Client.d.ts +0 -75
  181. package/src/api/resources/sim/client/Client.d.ts +0 -41
  182. package/src/api/resources/sim/client/Client.js +0 -129
  183. package/src/api/resources/sim/client/index.d.ts +0 -1
  184. package/src/api/resources/sim/types/index.d.ts +0 -1
  185. package/src/serialization/resources/sim/client/index.d.ts +0 -1
  186. package/src/serialization/resources/sim/types/index.d.ts +0 -1
  187. /package/src/api/resources/{message → apiKeys}/client/index.d.ts +0 -0
  188. /package/src/api/resources/{message → apiKeys}/client/index.js +0 -0
  189. /package/src/api/resources/{message/client/requests/MessageFindAllRequest.js → apiKeys/client/requests/ApiKeyCreateRequest.js} +0 -0
  190. /package/src/api/resources/{message/client/requests/MessageFindOneRequest.js → apiKeys/client/requests/ApiKeyRevokeRequest.js} +0 -0
  191. /package/src/api/resources/{message → apiKeys}/client/requests/index.js +0 -0
  192. /package/src/api/resources/{message → apiKeys}/index.d.ts +0 -0
  193. /package/src/api/resources/{message → apiKeys}/index.js +0 -0
  194. /package/src/api/resources/{message/client/requests/MessageSendRequest.js → apiKeys/types/ApiKeyCreateResponse.js} +0 -0
  195. /package/src/api/resources/{message/types/MessageFindAllResponse.js → apiKeys/types/ApiKeyListResponseItem.js} +0 -0
  196. /package/src/{serialization/resources/message → api/resources/messages}/client/index.d.ts +0 -0
  197. /package/src/{serialization/resources/message → api/resources/messages}/client/index.js +0 -0
  198. /package/src/api/resources/{message/types/MessageFindAllResponseDataItem.js → messages/client/requests/MessageFindAllRequest.js} +0 -0
  199. /package/src/api/resources/{message → messages}/client/requests/MessageFindOneRequest.d.ts +0 -0
  200. /package/src/api/resources/{message/types/MessageFindOneResponse.js → messages/client/requests/MessageFindOneRequest.js} +0 -0
  201. /package/src/api/resources/{message/types/MessageSendResponse.js → messages/client/requests/MessageSendRequest.js} +0 -0
  202. /package/src/api/resources/{message → messages}/client/requests/index.d.ts +0 -0
  203. /package/src/api/resources/{sim/client → messages/client/requests}/index.js +0 -0
  204. /package/src/api/resources/{sim → messages}/index.d.ts +0 -0
  205. /package/src/api/resources/{sim → messages}/index.js +0 -0
  206. /package/src/api/resources/{message → messages}/types/MessageFindAllResponse.d.ts +0 -0
  207. /package/src/api/resources/{sim/types/SimGetLinkedSimsResponseItem.js → messages/types/MessageFindAllResponse.js} +0 -0
  208. /package/src/api/resources/{message → messages}/types/MessageFindAllResponseDataItemDirection.d.ts +0 -0
  209. /package/src/api/resources/{message → messages}/types/MessageFindAllResponseDataItemDirection.js +0 -0
  210. /package/src/api/resources/{message → messages}/types/MessageFindOneResponseDirection.d.ts +0 -0
  211. /package/src/api/resources/{message → messages}/types/MessageFindOneResponseDirection.js +0 -0
  212. /package/src/api/resources/{message → messages}/types/MessageSendResponseDirection.d.ts +0 -0
  213. /package/src/api/resources/{message → messages}/types/MessageSendResponseDirection.js +0 -0
  214. /package/src/{serialization/resources/message → api/resources/siMs}/index.d.ts +0 -0
  215. /package/src/{serialization/resources/message → api/resources/siMs}/index.js +0 -0
  216. /package/src/serialization/resources/{sim → apiKeys}/index.d.ts +0 -0
  217. /package/src/serialization/resources/{sim → apiKeys}/index.js +0 -0
  218. /package/src/serialization/resources/{message → messages}/client/requests/index.d.ts +0 -0
  219. /package/src/serialization/resources/{message → messages}/client/requests/index.js +0 -0
  220. /package/src/serialization/resources/{message → messages}/types/MessageFindAllResponse.d.ts +0 -0
  221. /package/src/serialization/resources/{message → messages}/types/MessageFindAllResponse.js +0 -0
  222. /package/src/serialization/resources/{message → messages}/types/MessageFindAllResponseDataItemDirection.d.ts +0 -0
  223. /package/src/serialization/resources/{message → messages}/types/MessageFindAllResponseDataItemDirection.js +0 -0
  224. /package/src/serialization/resources/{message → messages}/types/MessageFindOneResponseDirection.d.ts +0 -0
  225. /package/src/serialization/resources/{message → messages}/types/MessageFindOneResponseDirection.js +0 -0
  226. /package/src/serialization/resources/{message → messages}/types/MessageSendResponseDirection.d.ts +0 -0
  227. /package/src/serialization/resources/{message → messages}/types/MessageSendResponseDirection.js +0 -0
  228. /package/src/serialization/resources/{sim/client/getLinkedSims.js → siMs/client/simGetLinkedSims.js} +0 -0
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2025 Unlimited Messaging
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md CHANGED
@@ -5,7 +5,10 @@ Official TypeScript / Node.js client for the [Unlimited Messaging](https://unlim
5
5
  [![npm version](https://img.shields.io/npm/v/@unlimited-messaging/sdk?style=flat-square&color=cb0000)](https://www.npmjs.com/package/@unlimited-messaging/sdk)
6
6
  [![npm downloads](https://img.shields.io/npm/dm/@unlimited-messaging/sdk?style=flat-square&color=cb0000)](https://www.npmjs.com/package/@unlimited-messaging/sdk)
7
7
  [![npm total downloads](https://img.shields.io/npm/dt/@unlimited-messaging/sdk?style=flat-square&label=total%20downloads&color=cb0000)](https://www.npmjs.com/package/@unlimited-messaging/sdk)
8
+ [![Bundle size](https://img.shields.io/bundlephobia/minzip/@unlimited-messaging/sdk?style=flat-square&label=gzipped)](https://bundlephobia.com/package/@unlimited-messaging/sdk)
9
+ [![CI](https://img.shields.io/github/actions/workflow/status/unlimitedmessaging/unlimited-messaging-sdk/release.yml?style=flat-square&label=CI)](https://github.com/unlimitedmessaging/unlimited-messaging-sdk/actions/workflows/release.yml)
8
10
  [![License](https://img.shields.io/npm/l/@unlimited-messaging/sdk?style=flat-square)](https://github.com/unlimitedmessaging/unlimited-messaging-sdk/blob/main/LICENSE)
11
+ [![Socket](https://socket.dev/api/badge/npm/package/@unlimited-messaging/sdk)](https://socket.dev/npm/package/@unlimited-messaging/sdk)
9
12
 
10
13
  - **Website:** [unlimitedmessaging.app](https://unlimitedmessaging.app)
11
14
  - **Docs:** [docs.unlimitedmessaging.app](https://docs.unlimitedmessaging.app)
@@ -29,7 +32,7 @@ const client = new UnlimitedMessagingApiClient({
29
32
  });
30
33
 
31
34
  // Send a WhatsApp message
32
- const message = await client.message.messageControllerSend({
35
+ const message = await client.message.send({
33
36
  recipient: "+33612345678",
34
37
  text: "Hello!",
35
38
  });
@@ -52,7 +55,7 @@ const client = new UnlimitedMessagingApiClient({
52
55
  ### Send a message
53
56
 
54
57
  ```typescript
55
- const message = await client.message.messageControllerSend({
58
+ const message = await client.message.send({
56
59
  recipient: "+33612345678",
57
60
  text: "Hello from the SDK!",
58
61
  simId: "optional-sim-id", // force a specific SIM
@@ -62,7 +65,7 @@ const message = await client.message.messageControllerSend({
62
65
  ### List messages
63
66
 
64
67
  ```typescript
65
- const result = await client.message.messageControllerFindAll({
68
+ const result = await client.message.findAll({
66
69
  page: 1,
67
70
  limit: 20,
68
71
  status: "DELIVERED", // PENDING | SENDING | SENT | DELIVERED | READ | FAILED
@@ -75,10 +78,17 @@ for (const msg of result.data) {
75
78
  }
76
79
  ```
77
80
 
81
+ ### Get a single message
82
+
83
+ ```typescript
84
+ const msg = await client.message.findOne("message-id");
85
+ console.log(msg.id, msg.status, msg.text);
86
+ ```
87
+
78
88
  ### List linked SIMs
79
89
 
80
90
  ```typescript
81
- const sims = await client.sim.simControllerGetLinkedSims();
91
+ const sims = await client.sim.getLinkedSims();
82
92
 
83
93
  for (const sim of sims) {
84
94
  console.log(sim.id, sim.phoneNumber);
@@ -87,11 +97,12 @@ for (const sim of sims) {
87
97
 
88
98
  ## API reference
89
99
 
90
- | Method | Description |
91
- | --- | --- |
92
- | `message.messageControllerSend` | Send a WhatsApp message |
93
- | `message.messageControllerFindAll` | List messages with pagination and filters |
94
- | `sim.simControllerGetLinkedSims` | List linked SIMs |
100
+ | Method | Description |
101
+ | ------------------- | ----------------------------------------- |
102
+ | `message.send` | Send a WhatsApp message |
103
+ | `message.findAll` | List messages with pagination and filters |
104
+ | `message.findOne` | Get a single message by ID |
105
+ | `sim.getLinkedSims` | List linked SIMs |
95
106
 
96
107
  Official documentation: [docs.unlimitedmessaging.app](https://docs.unlimitedmessaging.app)
97
108
 
package/package.json CHANGED
@@ -1,22 +1,51 @@
1
1
  {
2
2
  "name": "@unlimited-messaging/sdk",
3
- "version": "0.1.2",
4
- "description": "TypeScript SDK for the Unlimited Messaging API at https://unlimitedmessaging.app",
3
+ "version": "0.1.4",
4
+ "description": "TypeScript / Node.js SDK for the Unlimited Messaging API — send and receive WhatsApp messages programmatically",
5
5
  "main": "src/index.js",
6
6
  "types": "src/index.d.ts",
7
+ "exports": {
8
+ ".": {
9
+ "require": "./src/index.js",
10
+ "types": "./src/index.d.ts"
11
+ }
12
+ },
13
+ "sideEffects": false,
14
+ "keywords": [
15
+ "whatsapp",
16
+ "messaging",
17
+ "sms",
18
+ "api",
19
+ "sdk",
20
+ "client",
21
+ "whatsapp-api",
22
+ "send-message",
23
+ "unlimited-messaging",
24
+ "typescript",
25
+ "nodejs"
26
+ ],
27
+ "author": {
28
+ "name": "Ilian",
29
+ "email": "ilian572@gmail.com",
30
+ "url": "https://ilianazz.com"
31
+ },
7
32
  "license": "MIT",
8
- "homepage": "https://docs.unlimitedmessaging.app",
33
+ "homepage": "https://unlimitedmessaging.app",
9
34
  "repository": {
10
35
  "type": "git",
11
- "url": "https://github.com/unlimitedmessaging/unlimited-messaging-sdk.git"
36
+ "url": "https://github.com/UnlimitedMessaging/unlimited-messaging-sdk.git"
12
37
  },
13
38
  "bugs": {
14
- "url": "https://github.com/unlimitedmessaging/unlimited-messaging-sdk/issues"
39
+ "url": "https://github.com/UnlimitedMessaging/unlimited-messaging-sdk/issues"
40
+ },
41
+ "engines": {
42
+ "node": ">=18"
15
43
  },
16
44
  "files": [
17
45
  "src/**/*.js",
18
46
  "src/**/*.d.ts",
19
47
  "README.md",
48
+ "LICENSE",
20
49
  "!node_modules/**",
21
50
  "!**/*.test.*"
22
51
  ],
package/src/Client.d.ts CHANGED
@@ -3,8 +3,9 @@
3
3
  */
4
4
  import * as environments from "./environments";
5
5
  import * as core from "./core";
6
- import { Message } from "./api/resources/message/client/Client";
7
- import { Sim } from "./api/resources/sim/client/Client";
6
+ import { Messages } from "./api/resources/messages/client/Client";
7
+ import { SiMs } from "./api/resources/siMs/client/Client";
8
+ import { ApiKeys } from "./api/resources/apiKeys/client/Client";
8
9
  export declare namespace UnlimitedMessagingApiClient {
9
10
  interface Options {
10
11
  environment?: core.Supplier<environments.UnlimitedMessagingApiEnvironment | string>;
@@ -25,9 +26,11 @@ export declare namespace UnlimitedMessagingApiClient {
25
26
  }
26
27
  export declare class UnlimitedMessagingApiClient {
27
28
  protected readonly _options: UnlimitedMessagingApiClient.Options;
28
- protected _message: Message | undefined;
29
- protected _sim: Sim | undefined;
29
+ protected _messages: Messages | undefined;
30
+ protected _siMs: SiMs | undefined;
31
+ protected _apiKeys: ApiKeys | undefined;
30
32
  constructor(_options: UnlimitedMessagingApiClient.Options);
31
- get message(): Message;
32
- get sim(): Sim;
33
+ get messages(): Messages;
34
+ get siMs(): SiMs;
35
+ get apiKeys(): ApiKeys;
33
36
  }
package/src/Client.js CHANGED
@@ -4,19 +4,24 @@
4
4
  */
5
5
  Object.defineProperty(exports, "__esModule", { value: true });
6
6
  exports.UnlimitedMessagingApiClient = void 0;
7
- const Client_1 = require("./api/resources/message/client/Client");
8
- const Client_2 = require("./api/resources/sim/client/Client");
7
+ const Client_1 = require("./api/resources/messages/client/Client");
8
+ const Client_2 = require("./api/resources/siMs/client/Client");
9
+ const Client_3 = require("./api/resources/apiKeys/client/Client");
9
10
  class UnlimitedMessagingApiClient {
10
11
  constructor(_options) {
11
12
  this._options = _options;
12
13
  }
13
- get message() {
14
+ get messages() {
14
15
  var _a;
15
- return ((_a = this._message) !== null && _a !== void 0 ? _a : (this._message = new Client_1.Message(this._options)));
16
+ return ((_a = this._messages) !== null && _a !== void 0 ? _a : (this._messages = new Client_1.Messages(this._options)));
16
17
  }
17
- get sim() {
18
+ get siMs() {
18
19
  var _a;
19
- return ((_a = this._sim) !== null && _a !== void 0 ? _a : (this._sim = new Client_2.Sim(this._options)));
20
+ return ((_a = this._siMs) !== null && _a !== void 0 ? _a : (this._siMs = new Client_2.SiMs(this._options)));
21
+ }
22
+ get apiKeys() {
23
+ var _a;
24
+ return ((_a = this._apiKeys) !== null && _a !== void 0 ? _a : (this._apiKeys = new Client_3.ApiKeys(this._options)));
20
25
  }
21
26
  }
22
27
  exports.UnlimitedMessagingApiClient = UnlimitedMessagingApiClient;
@@ -0,0 +1,8 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ import * as errors from "../../errors/index";
5
+ import * as core from "../../core";
6
+ export declare class BadRequestError extends errors.UnlimitedMessagingApiError {
7
+ constructor(body?: unknown, rawResponse?: core.RawResponse);
8
+ }
@@ -0,0 +1,52 @@
1
+ "use strict";
2
+ /**
3
+ * This file was auto-generated by Fern from our API Definition.
4
+ */
5
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
6
+ if (k2 === undefined) k2 = k;
7
+ var desc = Object.getOwnPropertyDescriptor(m, k);
8
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
9
+ desc = { enumerable: true, get: function() { return m[k]; } };
10
+ }
11
+ Object.defineProperty(o, k2, desc);
12
+ }) : (function(o, m, k, k2) {
13
+ if (k2 === undefined) k2 = k;
14
+ o[k2] = m[k];
15
+ }));
16
+ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
17
+ Object.defineProperty(o, "default", { enumerable: true, value: v });
18
+ }) : function(o, v) {
19
+ o["default"] = v;
20
+ });
21
+ var __importStar = (this && this.__importStar) || (function () {
22
+ var ownKeys = function(o) {
23
+ ownKeys = Object.getOwnPropertyNames || function (o) {
24
+ var ar = [];
25
+ for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
26
+ return ar;
27
+ };
28
+ return ownKeys(o);
29
+ };
30
+ return function (mod) {
31
+ if (mod && mod.__esModule) return mod;
32
+ var result = {};
33
+ if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
34
+ __setModuleDefault(result, mod);
35
+ return result;
36
+ };
37
+ })();
38
+ Object.defineProperty(exports, "__esModule", { value: true });
39
+ exports.BadRequestError = void 0;
40
+ const errors = __importStar(require("../../errors/index"));
41
+ class BadRequestError extends errors.UnlimitedMessagingApiError {
42
+ constructor(body, rawResponse) {
43
+ super({
44
+ message: "BadRequestError",
45
+ statusCode: 400,
46
+ body: body,
47
+ rawResponse: rawResponse,
48
+ });
49
+ Object.setPrototypeOf(this, BadRequestError.prototype);
50
+ }
51
+ }
52
+ exports.BadRequestError = BadRequestError;
@@ -0,0 +1,8 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ import * as errors from "../../errors/index";
5
+ import * as core from "../../core";
6
+ export declare class ForbiddenError extends errors.UnlimitedMessagingApiError {
7
+ constructor(body?: unknown, rawResponse?: core.RawResponse);
8
+ }
@@ -0,0 +1,52 @@
1
+ "use strict";
2
+ /**
3
+ * This file was auto-generated by Fern from our API Definition.
4
+ */
5
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
6
+ if (k2 === undefined) k2 = k;
7
+ var desc = Object.getOwnPropertyDescriptor(m, k);
8
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
9
+ desc = { enumerable: true, get: function() { return m[k]; } };
10
+ }
11
+ Object.defineProperty(o, k2, desc);
12
+ }) : (function(o, m, k, k2) {
13
+ if (k2 === undefined) k2 = k;
14
+ o[k2] = m[k];
15
+ }));
16
+ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
17
+ Object.defineProperty(o, "default", { enumerable: true, value: v });
18
+ }) : function(o, v) {
19
+ o["default"] = v;
20
+ });
21
+ var __importStar = (this && this.__importStar) || (function () {
22
+ var ownKeys = function(o) {
23
+ ownKeys = Object.getOwnPropertyNames || function (o) {
24
+ var ar = [];
25
+ for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
26
+ return ar;
27
+ };
28
+ return ownKeys(o);
29
+ };
30
+ return function (mod) {
31
+ if (mod && mod.__esModule) return mod;
32
+ var result = {};
33
+ if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
34
+ __setModuleDefault(result, mod);
35
+ return result;
36
+ };
37
+ })();
38
+ Object.defineProperty(exports, "__esModule", { value: true });
39
+ exports.ForbiddenError = void 0;
40
+ const errors = __importStar(require("../../errors/index"));
41
+ class ForbiddenError extends errors.UnlimitedMessagingApiError {
42
+ constructor(body, rawResponse) {
43
+ super({
44
+ message: "ForbiddenError",
45
+ statusCode: 403,
46
+ body: body,
47
+ rawResponse: rawResponse,
48
+ });
49
+ Object.setPrototypeOf(this, ForbiddenError.prototype);
50
+ }
51
+ }
52
+ exports.ForbiddenError = ForbiddenError;
@@ -0,0 +1,8 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ import * as errors from "../../errors/index";
5
+ import * as core from "../../core";
6
+ export declare class NotFoundError extends errors.UnlimitedMessagingApiError {
7
+ constructor(body?: unknown, rawResponse?: core.RawResponse);
8
+ }
@@ -0,0 +1,52 @@
1
+ "use strict";
2
+ /**
3
+ * This file was auto-generated by Fern from our API Definition.
4
+ */
5
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
6
+ if (k2 === undefined) k2 = k;
7
+ var desc = Object.getOwnPropertyDescriptor(m, k);
8
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
9
+ desc = { enumerable: true, get: function() { return m[k]; } };
10
+ }
11
+ Object.defineProperty(o, k2, desc);
12
+ }) : (function(o, m, k, k2) {
13
+ if (k2 === undefined) k2 = k;
14
+ o[k2] = m[k];
15
+ }));
16
+ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
17
+ Object.defineProperty(o, "default", { enumerable: true, value: v });
18
+ }) : function(o, v) {
19
+ o["default"] = v;
20
+ });
21
+ var __importStar = (this && this.__importStar) || (function () {
22
+ var ownKeys = function(o) {
23
+ ownKeys = Object.getOwnPropertyNames || function (o) {
24
+ var ar = [];
25
+ for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
26
+ return ar;
27
+ };
28
+ return ownKeys(o);
29
+ };
30
+ return function (mod) {
31
+ if (mod && mod.__esModule) return mod;
32
+ var result = {};
33
+ if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
34
+ __setModuleDefault(result, mod);
35
+ return result;
36
+ };
37
+ })();
38
+ Object.defineProperty(exports, "__esModule", { value: true });
39
+ exports.NotFoundError = void 0;
40
+ const errors = __importStar(require("../../errors/index"));
41
+ class NotFoundError extends errors.UnlimitedMessagingApiError {
42
+ constructor(body, rawResponse) {
43
+ super({
44
+ message: "NotFoundError",
45
+ statusCode: 404,
46
+ body: body,
47
+ rawResponse: rawResponse,
48
+ });
49
+ Object.setPrototypeOf(this, NotFoundError.prototype);
50
+ }
51
+ }
52
+ exports.NotFoundError = NotFoundError;
@@ -0,0 +1,8 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ import * as errors from "../../errors/index";
5
+ import * as core from "../../core";
6
+ export declare class UnauthorizedError extends errors.UnlimitedMessagingApiError {
7
+ constructor(body?: unknown, rawResponse?: core.RawResponse);
8
+ }
@@ -0,0 +1,52 @@
1
+ "use strict";
2
+ /**
3
+ * This file was auto-generated by Fern from our API Definition.
4
+ */
5
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
6
+ if (k2 === undefined) k2 = k;
7
+ var desc = Object.getOwnPropertyDescriptor(m, k);
8
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
9
+ desc = { enumerable: true, get: function() { return m[k]; } };
10
+ }
11
+ Object.defineProperty(o, k2, desc);
12
+ }) : (function(o, m, k, k2) {
13
+ if (k2 === undefined) k2 = k;
14
+ o[k2] = m[k];
15
+ }));
16
+ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
17
+ Object.defineProperty(o, "default", { enumerable: true, value: v });
18
+ }) : function(o, v) {
19
+ o["default"] = v;
20
+ });
21
+ var __importStar = (this && this.__importStar) || (function () {
22
+ var ownKeys = function(o) {
23
+ ownKeys = Object.getOwnPropertyNames || function (o) {
24
+ var ar = [];
25
+ for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
26
+ return ar;
27
+ };
28
+ return ownKeys(o);
29
+ };
30
+ return function (mod) {
31
+ if (mod && mod.__esModule) return mod;
32
+ var result = {};
33
+ if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
34
+ __setModuleDefault(result, mod);
35
+ return result;
36
+ };
37
+ })();
38
+ Object.defineProperty(exports, "__esModule", { value: true });
39
+ exports.UnauthorizedError = void 0;
40
+ const errors = __importStar(require("../../errors/index"));
41
+ class UnauthorizedError extends errors.UnlimitedMessagingApiError {
42
+ constructor(body, rawResponse) {
43
+ super({
44
+ message: "UnauthorizedError",
45
+ statusCode: 401,
46
+ body: body,
47
+ rawResponse: rawResponse,
48
+ });
49
+ Object.setPrototypeOf(this, UnauthorizedError.prototype);
50
+ }
51
+ }
52
+ exports.UnauthorizedError = UnauthorizedError;
@@ -0,0 +1,8 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ import * as errors from "../../errors/index";
5
+ import * as core from "../../core";
6
+ export declare class UnprocessableEntityError extends errors.UnlimitedMessagingApiError {
7
+ constructor(body?: unknown, rawResponse?: core.RawResponse);
8
+ }
@@ -0,0 +1,52 @@
1
+ "use strict";
2
+ /**
3
+ * This file was auto-generated by Fern from our API Definition.
4
+ */
5
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
6
+ if (k2 === undefined) k2 = k;
7
+ var desc = Object.getOwnPropertyDescriptor(m, k);
8
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
9
+ desc = { enumerable: true, get: function() { return m[k]; } };
10
+ }
11
+ Object.defineProperty(o, k2, desc);
12
+ }) : (function(o, m, k, k2) {
13
+ if (k2 === undefined) k2 = k;
14
+ o[k2] = m[k];
15
+ }));
16
+ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
17
+ Object.defineProperty(o, "default", { enumerable: true, value: v });
18
+ }) : function(o, v) {
19
+ o["default"] = v;
20
+ });
21
+ var __importStar = (this && this.__importStar) || (function () {
22
+ var ownKeys = function(o) {
23
+ ownKeys = Object.getOwnPropertyNames || function (o) {
24
+ var ar = [];
25
+ for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
26
+ return ar;
27
+ };
28
+ return ownKeys(o);
29
+ };
30
+ return function (mod) {
31
+ if (mod && mod.__esModule) return mod;
32
+ var result = {};
33
+ if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
34
+ __setModuleDefault(result, mod);
35
+ return result;
36
+ };
37
+ })();
38
+ Object.defineProperty(exports, "__esModule", { value: true });
39
+ exports.UnprocessableEntityError = void 0;
40
+ const errors = __importStar(require("../../errors/index"));
41
+ class UnprocessableEntityError extends errors.UnlimitedMessagingApiError {
42
+ constructor(body, rawResponse) {
43
+ super({
44
+ message: "UnprocessableEntityError",
45
+ statusCode: 422,
46
+ body: body,
47
+ rawResponse: rawResponse,
48
+ });
49
+ Object.setPrototypeOf(this, UnprocessableEntityError.prototype);
50
+ }
51
+ }
52
+ exports.UnprocessableEntityError = UnprocessableEntityError;
@@ -0,0 +1,5 @@
1
+ export * from "./BadRequestError";
2
+ export * from "./UnauthorizedError";
3
+ export * from "./ForbiddenError";
4
+ export * from "./NotFoundError";
5
+ export * from "./UnprocessableEntityError";
@@ -0,0 +1,21 @@
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("./BadRequestError"), exports);
18
+ __exportStar(require("./UnauthorizedError"), exports);
19
+ __exportStar(require("./ForbiddenError"), exports);
20
+ __exportStar(require("./NotFoundError"), exports);
21
+ __exportStar(require("./UnprocessableEntityError"), exports);
@@ -1 +1,2 @@
1
1
  export * from "./resources";
2
+ export * from "./errors";
package/src/api/index.js CHANGED
@@ -15,3 +15,4 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
15
15
  };
16
16
  Object.defineProperty(exports, "__esModule", { value: true });
17
17
  __exportStar(require("./resources"), exports);
18
+ __exportStar(require("./errors"), exports);
@@ -0,0 +1,81 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ import * as environments from "../../../../environments";
5
+ import * as core from "../../../../core";
6
+ import * as UnlimitedMessagingApi from "../../../index";
7
+ export declare namespace ApiKeys {
8
+ interface Options {
9
+ environment?: core.Supplier<environments.UnlimitedMessagingApiEnvironment | string>;
10
+ /** Specify a custom URL to connect the client to. */
11
+ baseUrl?: core.Supplier<string>;
12
+ token: core.Supplier<core.BearerToken>;
13
+ }
14
+ interface RequestOptions {
15
+ /** The maximum time to wait for a response in seconds. */
16
+ timeoutInSeconds?: number;
17
+ /** The number of times to retry the request. Defaults to 2. */
18
+ maxRetries?: number;
19
+ /** A hook to abort the request. */
20
+ abortSignal?: AbortSignal;
21
+ /** Additional headers to include in the request. */
22
+ headers?: Record<string, string>;
23
+ }
24
+ }
25
+ export declare class ApiKeys {
26
+ protected readonly _options: ApiKeys.Options;
27
+ constructor(_options: ApiKeys.Options);
28
+ /**
29
+ * **Protection**: Protected endpoint. Allowed roles: USER, ADMIN. Required scopes: OTHER:READ
30
+ *
31
+ * Returns all active API keys for the authenticated user. The raw key value is never returned — only metadata (id, name, prefix, dates).
32
+ *
33
+ * @param {ApiKeys.RequestOptions} requestOptions - Request-specific configuration.
34
+ *
35
+ * @throws {@link UnlimitedMessagingApi.UnauthorizedError}
36
+ * @throws {@link UnlimitedMessagingApi.ForbiddenError}
37
+ *
38
+ * @example
39
+ * await client.apiKeys.apiKeyList()
40
+ */
41
+ apiKeyList(requestOptions?: ApiKeys.RequestOptions): core.HttpResponsePromise<UnlimitedMessagingApi.ApiKeyListResponseItem[]>;
42
+ private __apiKeyList;
43
+ /**
44
+ * **Protection**: Protected endpoint. Allowed roles: USER, ADMIN. Required scopes: OTHER:WRITE
45
+ *
46
+ * Generates a new API key for the authenticated user. The raw `key` value is only returned once — store it securely.
47
+ *
48
+ * @param {UnlimitedMessagingApi.ApiKeyCreateRequest} request
49
+ * @param {ApiKeys.RequestOptions} requestOptions - Request-specific configuration.
50
+ *
51
+ * @throws {@link UnlimitedMessagingApi.BadRequestError}
52
+ * @throws {@link UnlimitedMessagingApi.UnauthorizedError}
53
+ * @throws {@link UnlimitedMessagingApi.ForbiddenError}
54
+ *
55
+ * @example
56
+ * await client.apiKeys.apiKeyCreate({
57
+ * name: "name"
58
+ * })
59
+ */
60
+ apiKeyCreate(request: UnlimitedMessagingApi.ApiKeyCreateRequest, requestOptions?: ApiKeys.RequestOptions): core.HttpResponsePromise<UnlimitedMessagingApi.ApiKeyCreateResponse>;
61
+ private __apiKeyCreate;
62
+ /**
63
+ * **Protection**: Protected endpoint. Allowed roles: USER, ADMIN. Required scopes: OTHER:WRITE
64
+ *
65
+ * Permanently revokes an API key by ID. The key is immediately invalidated and cannot be restored.
66
+ *
67
+ * @param {string} id
68
+ * @param {UnlimitedMessagingApi.ApiKeyRevokeRequest} request
69
+ * @param {ApiKeys.RequestOptions} requestOptions - Request-specific configuration.
70
+ *
71
+ * @throws {@link UnlimitedMessagingApi.UnauthorizedError}
72
+ * @throws {@link UnlimitedMessagingApi.ForbiddenError}
73
+ * @throws {@link UnlimitedMessagingApi.NotFoundError}
74
+ *
75
+ * @example
76
+ * await client.apiKeys.apiKeyRevoke("id")
77
+ */
78
+ apiKeyRevoke(id: string, request?: UnlimitedMessagingApi.ApiKeyRevokeRequest, requestOptions?: ApiKeys.RequestOptions): core.HttpResponsePromise<void>;
79
+ private __apiKeyRevoke;
80
+ protected _getAuthorizationHeader(): Promise<string>;
81
+ }