@onesignal/node-onesignal 2.0.1-beta1 → 5.0.0-alpha-01

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 (308) hide show
  1. package/DefaultApi.md +452 -707
  2. package/apis/DefaultApi.ts +998 -1004
  3. package/auth/auth.ts +14 -14
  4. package/configuration.ts +6 -6
  5. package/dist/apis/DefaultApi.d.ts +39 -63
  6. package/dist/apis/DefaultApi.js +1149 -1022
  7. package/dist/apis/DefaultApi.js.map +1 -1
  8. package/dist/auth/auth.d.ts +6 -6
  9. package/dist/auth/auth.js +19 -19
  10. package/dist/auth/auth.js.map +1 -1
  11. package/dist/configuration.d.ts +2 -2
  12. package/dist/configuration.js +4 -4
  13. package/dist/configuration.js.map +1 -1
  14. package/dist/models/BasicNotification.d.ts +14 -12
  15. package/dist/models/BasicNotification.js +20 -20
  16. package/dist/models/BasicNotification.js.map +1 -1
  17. package/dist/models/BasicNotificationAllOf.d.ts +10 -8
  18. package/dist/models/BasicNotificationAllOf.js +17 -11
  19. package/dist/models/BasicNotificationAllOf.js.map +1 -1
  20. package/dist/models/CreateNotificationSuccessResponse.d.ts +1 -3
  21. package/dist/models/CreateNotificationSuccessResponse.js +1 -7
  22. package/dist/models/CreateNotificationSuccessResponse.js.map +1 -1
  23. package/dist/models/{ExportPlayersSuccessResponse.d.ts → ExportEventsSuccessResponse.d.ts} +1 -1
  24. package/dist/models/ExportEventsSuccessResponse.js +22 -0
  25. package/dist/models/ExportEventsSuccessResponse.js.map +1 -0
  26. package/dist/models/{ExportPlayersRequestBody.d.ts → ExportSubscriptionsRequestBody.d.ts} +1 -1
  27. package/dist/models/ExportSubscriptionsRequestBody.js +34 -0
  28. package/dist/models/ExportSubscriptionsRequestBody.js.map +1 -0
  29. package/dist/models/{DeletePlayerNotFoundResponse.d.ts → ExportSubscriptionsSuccessResponse.d.ts} +2 -2
  30. package/dist/models/ExportSubscriptionsSuccessResponse.js +22 -0
  31. package/dist/models/ExportSubscriptionsSuccessResponse.js.map +1 -0
  32. package/dist/models/Filter.d.ts +6 -2
  33. package/dist/models/Filter.js +24 -0
  34. package/dist/models/Filter.js.map +1 -1
  35. package/dist/models/FilterExpression.d.ts +27 -0
  36. package/dist/models/FilterExpression.js +70 -0
  37. package/dist/models/FilterExpression.js.map +1 -0
  38. package/dist/models/{CancelNotificationSuccessResponse.d.ts → GenericError.d.ts} +3 -1
  39. package/dist/models/GenericError.js +34 -0
  40. package/dist/models/GenericError.js.map +1 -0
  41. package/dist/models/{IdentifyUserConflictResponseErrorsInner.d.ts → GenericErrorErrorsInner.d.ts} +1 -1
  42. package/dist/models/GenericErrorErrorsInner.js +28 -0
  43. package/dist/models/GenericErrorErrorsInner.js.map +1 -0
  44. package/dist/models/{DeletePlayerSuccessResponse.d.ts → GenericSuccessBoolResponse.d.ts} +1 -1
  45. package/dist/models/GenericSuccessBoolResponse.js +22 -0
  46. package/dist/models/GenericSuccessBoolResponse.js.map +1 -0
  47. package/dist/models/{GetNotificationRequestBody.d.ts → GetNotificationHistoryRequestBody.d.ts} +3 -3
  48. package/dist/models/GetNotificationHistoryRequestBody.js +34 -0
  49. package/dist/models/GetNotificationHistoryRequestBody.js.map +1 -0
  50. package/dist/models/{PlayerSlice.d.ts → GetSegmentsSuccessResponse.d.ts} +3 -3
  51. package/dist/models/GetSegmentsSuccessResponse.js +40 -0
  52. package/dist/models/GetSegmentsSuccessResponse.js.map +1 -0
  53. package/dist/models/InvalidIdentifierError.d.ts +1 -1
  54. package/dist/models/InvalidIdentifierError.js +2 -2
  55. package/dist/models/InvalidIdentifierError.js.map +1 -1
  56. package/dist/models/{StringMap.d.ts → LanguageStringMap.d.ts} +1 -1
  57. package/dist/models/{StringMap.js → LanguageStringMap.js} +10 -10
  58. package/dist/models/LanguageStringMap.js.map +1 -0
  59. package/dist/models/Notification.d.ts +14 -12
  60. package/dist/models/Notification.js +20 -20
  61. package/dist/models/Notification.js.map +1 -1
  62. package/dist/models/NotificationTarget.d.ts +4 -4
  63. package/dist/models/NotificationTarget.js +3 -9
  64. package/dist/models/NotificationTarget.js.map +1 -1
  65. package/dist/models/NotificationWithMeta.d.ts +14 -12
  66. package/dist/models/NotificationWithMeta.js +20 -20
  67. package/dist/models/NotificationWithMeta.js.map +1 -1
  68. package/dist/models/ObjectSerializer.d.ts +17 -33
  69. package/dist/models/ObjectSerializer.js +56 -105
  70. package/dist/models/ObjectSerializer.js.map +1 -1
  71. package/dist/models/{InlineResponse202.d.ts → PropertiesBody.d.ts} +1 -1
  72. package/dist/models/PropertiesBody.js +22 -0
  73. package/dist/models/PropertiesBody.js.map +1 -0
  74. package/dist/models/{BadRequestError.d.ts → RateLimitError.d.ts} +2 -1
  75. package/dist/models/RateLimitError.js +28 -0
  76. package/dist/models/RateLimitError.js.map +1 -0
  77. package/dist/models/RateLimiterError.d.ts +18 -0
  78. package/dist/models/RateLimiterError.js +22 -0
  79. package/dist/models/RateLimiterError.js.map +1 -0
  80. package/dist/models/Segment.d.ts +2 -2
  81. package/dist/models/Segment.js +1 -1
  82. package/dist/models/Segment.js.map +1 -1
  83. package/dist/models/{CreatePlayerSuccessResponse.d.ts → SegmentData.d.ts} +7 -2
  84. package/dist/models/SegmentData.js +58 -0
  85. package/dist/models/SegmentData.js.map +1 -0
  86. package/dist/models/{SubscriptionObject.d.ts → Subscription.d.ts} +3 -3
  87. package/dist/models/{SubscriptionObject.js → Subscription.js} +11 -11
  88. package/dist/models/Subscription.js.map +1 -0
  89. package/dist/models/{BeginLiveActivityRequest.d.ts → SubscriptionBody.d.ts} +3 -3
  90. package/dist/models/SubscriptionBody.js +22 -0
  91. package/dist/models/SubscriptionBody.js.map +1 -0
  92. package/dist/models/{PlayerNotificationTarget.d.ts → SubscriptionNotificationTarget.d.ts} +7 -7
  93. package/dist/models/{PlayerNotificationTarget.js → SubscriptionNotificationTarget.js} +14 -20
  94. package/dist/models/SubscriptionNotificationTarget.js.map +1 -0
  95. package/dist/models/TransferSubscriptionRequestBody.d.ts +1 -1
  96. package/dist/models/TransferSubscriptionRequestBody.js +1 -1
  97. package/dist/models/TransferSubscriptionRequestBody.js.map +1 -1
  98. package/dist/models/UpdateLiveActivityRequest.d.ts +8 -3
  99. package/dist/models/UpdateLiveActivityRequest.js +33 -3
  100. package/dist/models/UpdateLiveActivityRequest.js.map +1 -1
  101. package/dist/models/UpdateLiveActivitySuccessResponse.d.ts +1 -3
  102. package/dist/models/UpdateLiveActivitySuccessResponse.js +2 -8
  103. package/dist/models/UpdateLiveActivitySuccessResponse.js.map +1 -1
  104. package/dist/models/User.d.ts +3 -5
  105. package/dist/models/User.js +2 -8
  106. package/dist/models/User.js.map +1 -1
  107. package/dist/models/{InlineResponse200.d.ts → UserIdentityBody.d.ts} +2 -2
  108. package/dist/models/UserIdentityBody.js +22 -0
  109. package/dist/models/UserIdentityBody.js.map +1 -0
  110. package/dist/models/{CreateNotificationBadRequestResponse.d.ts → WebButton.d.ts} +5 -2
  111. package/dist/models/WebButton.js +40 -0
  112. package/dist/models/WebButton.js.map +1 -0
  113. package/dist/models/all.d.ts +17 -33
  114. package/dist/models/all.js +17 -33
  115. package/dist/models/all.js.map +1 -1
  116. package/dist/servers.js +1 -1
  117. package/dist/servers.js.map +1 -1
  118. package/dist/types/ObjectParamAPI.d.ts +56 -100
  119. package/dist/types/ObjectParamAPI.js +28 -46
  120. package/dist/types/ObjectParamAPI.js.map +1 -1
  121. package/dist/types/ObservableAPI.d.ts +27 -45
  122. package/dist/types/ObservableAPI.js +82 -226
  123. package/dist/types/ObservableAPI.js.map +1 -1
  124. package/dist/types/PromiseAPI.d.ts +27 -45
  125. package/dist/types/PromiseAPI.js +34 -58
  126. package/dist/types/PromiseAPI.js.map +1 -1
  127. package/models/App.ts +1 -1
  128. package/models/BasicNotification.ts +49 -46
  129. package/models/BasicNotificationAllOf.ts +34 -23
  130. package/models/BasicNotificationAllOfAndroidBackgroundLayout.ts +1 -1
  131. package/models/Button.ts +1 -1
  132. package/models/CreateNotificationSuccessResponse.ts +5 -13
  133. package/models/CreateSegmentConflictResponse.ts +1 -1
  134. package/models/CreateSegmentSuccessResponse.ts +1 -1
  135. package/models/CreateUserConflictResponse.ts +1 -1
  136. package/models/CreateUserConflictResponseErrorsInner.ts +1 -1
  137. package/models/CreateUserConflictResponseErrorsItemsMeta.ts +1 -1
  138. package/models/DeliveryData.ts +1 -1
  139. package/models/{ExportPlayersSuccessResponse.ts → ExportEventsSuccessResponse.ts} +3 -3
  140. package/models/{ExportPlayersRequestBody.ts → ExportSubscriptionsRequestBody.ts} +3 -3
  141. package/models/{CancelNotificationSuccessResponse.ts → ExportSubscriptionsSuccessResponse.ts} +7 -7
  142. package/models/Filter.ts +45 -5
  143. package/models/FilterExpression.ts +120 -0
  144. package/models/{CreateSegmentBadRequestResponse.ts → GenericError.ts} +14 -7
  145. package/models/{IdentifyUserConflictResponseErrorsInner.ts → GenericErrorErrorsInner.ts} +3 -3
  146. package/models/{DeletePlayerNotFoundResponse.ts → GenericSuccessBoolResponse.ts} +3 -3
  147. package/models/{GetNotificationRequestBody.ts → GetNotificationHistoryRequestBody.ts} +6 -6
  148. package/models/{PlayerSlice.ts → GetSegmentsSuccessResponse.ts} +20 -8
  149. package/models/InvalidIdentifierError.ts +6 -6
  150. package/models/{StringMap.ts → LanguageStringMap.ts} +3 -3
  151. package/models/Notification.ts +49 -46
  152. package/models/NotificationAllOf.ts +1 -1
  153. package/models/NotificationHistorySuccessResponse.ts +1 -1
  154. package/models/NotificationSlice.ts +1 -1
  155. package/models/NotificationTarget.ts +17 -25
  156. package/models/NotificationWithMeta.ts +49 -46
  157. package/models/NotificationWithMetaAllOf.ts +1 -1
  158. package/models/ObjectSerializer.ts +63 -112
  159. package/models/Operator.ts +1 -1
  160. package/models/OutcomeData.ts +1 -1
  161. package/models/OutcomesData.ts +1 -1
  162. package/models/PlatformDeliveryData.ts +1 -1
  163. package/models/PlatformDeliveryDataEmailAllOf.ts +1 -1
  164. package/models/PlatformDeliveryDataSmsAllOf.ts +1 -1
  165. package/models/{InlineResponse202.ts → PropertiesBody.ts} +3 -3
  166. package/models/PropertiesDeltas.ts +1 -1
  167. package/models/PropertiesObject.ts +1 -1
  168. package/models/Purchase.ts +1 -1
  169. package/models/{NotificationHistoryBadRequestResponse.ts → RateLimitError.ts} +10 -10
  170. package/models/{BadRequestError.ts → RateLimiterError.ts} +6 -5
  171. package/models/Segment.ts +4 -4
  172. package/models/SegmentData.ts +94 -0
  173. package/models/SegmentNotificationTarget.ts +1 -1
  174. package/models/{SubscriptionObject.ts → Subscription.ts} +6 -6
  175. package/models/{InlineResponse201.ts → SubscriptionBody.ts} +6 -6
  176. package/models/{PlayerNotificationTarget.ts → SubscriptionNotificationTarget.ts} +21 -29
  177. package/models/TransferSubscriptionRequestBody.ts +3 -3
  178. package/models/UpdateLiveActivityRequest.ts +56 -9
  179. package/models/UpdateLiveActivitySuccessResponse.ts +4 -12
  180. package/models/UpdateUserRequest.ts +1 -1
  181. package/models/User.ts +6 -14
  182. package/models/{InlineResponse200.ts → UserIdentityBody.ts} +5 -5
  183. package/models/{CreatePlayerSuccessResponse.ts → WebButton.ts} +24 -10
  184. package/models/all.ts +17 -33
  185. package/package.json +2 -2
  186. package/servers.ts +1 -1
  187. package/types/ObjectParamAPI.ts +174 -345
  188. package/types/ObservableAPI.ts +117 -284
  189. package/types/PromiseAPI.ts +97 -180
  190. package/dist/models/BadRequestError.js +0 -22
  191. package/dist/models/BadRequestError.js.map +0 -1
  192. package/dist/models/BeginLiveActivityRequest.js +0 -28
  193. package/dist/models/BeginLiveActivityRequest.js.map +0 -1
  194. package/dist/models/CancelNotificationSuccessResponse.js +0 -22
  195. package/dist/models/CancelNotificationSuccessResponse.js.map +0 -1
  196. package/dist/models/CreateNotificationBadRequestResponse.js +0 -22
  197. package/dist/models/CreateNotificationBadRequestResponse.js.map +0 -1
  198. package/dist/models/CreatePlayerSuccessResponse.js +0 -28
  199. package/dist/models/CreatePlayerSuccessResponse.js.map +0 -1
  200. package/dist/models/CreateSegmentBadRequestResponse.d.ts +0 -18
  201. package/dist/models/CreateSegmentBadRequestResponse.js +0 -28
  202. package/dist/models/CreateSegmentBadRequestResponse.js.map +0 -1
  203. package/dist/models/CreateSubscriptionRequestBody.d.ts +0 -19
  204. package/dist/models/CreateSubscriptionRequestBody.js +0 -28
  205. package/dist/models/CreateSubscriptionRequestBody.js.map +0 -1
  206. package/dist/models/DeletePlayerBadRequestResponse.d.ts +0 -17
  207. package/dist/models/DeletePlayerBadRequestResponse.js +0 -22
  208. package/dist/models/DeletePlayerBadRequestResponse.js.map +0 -1
  209. package/dist/models/DeletePlayerNotFoundResponse.js +0 -22
  210. package/dist/models/DeletePlayerNotFoundResponse.js.map +0 -1
  211. package/dist/models/DeletePlayerSuccessResponse.js +0 -22
  212. package/dist/models/DeletePlayerSuccessResponse.js.map +0 -1
  213. package/dist/models/DeleteSegmentBadRequestResponse.d.ts +0 -17
  214. package/dist/models/DeleteSegmentBadRequestResponse.js +0 -22
  215. package/dist/models/DeleteSegmentBadRequestResponse.js.map +0 -1
  216. package/dist/models/DeleteSegmentNotFoundResponse.d.ts +0 -17
  217. package/dist/models/DeleteSegmentNotFoundResponse.js +0 -22
  218. package/dist/models/DeleteSegmentNotFoundResponse.js.map +0 -1
  219. package/dist/models/DeleteSegmentSuccessResponse.d.ts +0 -17
  220. package/dist/models/DeleteSegmentSuccessResponse.js +0 -22
  221. package/dist/models/DeleteSegmentSuccessResponse.js.map +0 -1
  222. package/dist/models/ExportPlayersRequestBody.js +0 -34
  223. package/dist/models/ExportPlayersRequestBody.js.map +0 -1
  224. package/dist/models/ExportPlayersSuccessResponse.js +0 -22
  225. package/dist/models/ExportPlayersSuccessResponse.js.map +0 -1
  226. package/dist/models/FilterExpressions.d.ts +0 -23
  227. package/dist/models/FilterExpressions.js +0 -46
  228. package/dist/models/FilterExpressions.js.map +0 -1
  229. package/dist/models/FilterNotificationTarget.d.ts +0 -28
  230. package/dist/models/FilterNotificationTarget.js +0 -88
  231. package/dist/models/FilterNotificationTarget.js.map +0 -1
  232. package/dist/models/GetNotificationRequestBody.js +0 -34
  233. package/dist/models/GetNotificationRequestBody.js.map +0 -1
  234. package/dist/models/IdentifyUserConflictResponse.d.ts +0 -18
  235. package/dist/models/IdentifyUserConflictResponse.js +0 -22
  236. package/dist/models/IdentifyUserConflictResponse.js.map +0 -1
  237. package/dist/models/IdentifyUserConflictResponseErrorsInner.js +0 -28
  238. package/dist/models/IdentifyUserConflictResponseErrorsInner.js.map +0 -1
  239. package/dist/models/InlineResponse200.js +0 -22
  240. package/dist/models/InlineResponse200.js.map +0 -1
  241. package/dist/models/InlineResponse2003.d.ts +0 -17
  242. package/dist/models/InlineResponse2003.js +0 -22
  243. package/dist/models/InlineResponse2003.js.map +0 -1
  244. package/dist/models/InlineResponse201.d.ts +0 -18
  245. package/dist/models/InlineResponse201.js +0 -22
  246. package/dist/models/InlineResponse201.js.map +0 -1
  247. package/dist/models/InlineResponse202.js +0 -22
  248. package/dist/models/InlineResponse202.js.map +0 -1
  249. package/dist/models/Notification200Errors.d.ts +0 -18
  250. package/dist/models/Notification200Errors.js +0 -28
  251. package/dist/models/Notification200Errors.js.map +0 -1
  252. package/dist/models/NotificationHistoryBadRequestResponse.d.ts +0 -18
  253. package/dist/models/NotificationHistoryBadRequestResponse.js +0 -28
  254. package/dist/models/NotificationHistoryBadRequestResponse.js.map +0 -1
  255. package/dist/models/Player.d.ts +0 -43
  256. package/dist/models/Player.js +0 -178
  257. package/dist/models/Player.js.map +0 -1
  258. package/dist/models/PlayerNotificationTarget.js.map +0 -1
  259. package/dist/models/PlayerNotificationTargetIncludeAliases.d.ts +0 -17
  260. package/dist/models/PlayerNotificationTargetIncludeAliases.js +0 -22
  261. package/dist/models/PlayerNotificationTargetIncludeAliases.js.map +0 -1
  262. package/dist/models/PlayerSlice.js +0 -40
  263. package/dist/models/PlayerSlice.js.map +0 -1
  264. package/dist/models/StringMap.js.map +0 -1
  265. package/dist/models/SubscriptionObject.js.map +0 -1
  266. package/dist/models/UpdatePlayerSuccessResponse.d.ts +0 -17
  267. package/dist/models/UpdatePlayerSuccessResponse.js +0 -22
  268. package/dist/models/UpdatePlayerSuccessResponse.js.map +0 -1
  269. package/dist/models/UpdatePlayerTagsRequestBody.d.ts +0 -17
  270. package/dist/models/UpdatePlayerTagsRequestBody.js +0 -22
  271. package/dist/models/UpdatePlayerTagsRequestBody.js.map +0 -1
  272. package/dist/models/UpdatePlayerTagsSuccessResponse.d.ts +0 -17
  273. package/dist/models/UpdatePlayerTagsSuccessResponse.js +0 -22
  274. package/dist/models/UpdatePlayerTagsSuccessResponse.js.map +0 -1
  275. package/dist/models/UpdateSubscriptionRequestBody.d.ts +0 -18
  276. package/dist/models/UpdateSubscriptionRequestBody.js +0 -22
  277. package/dist/models/UpdateSubscriptionRequestBody.js.map +0 -1
  278. package/dist/models/UserIdentityRequestBody.d.ts +0 -19
  279. package/dist/models/UserIdentityRequestBody.js +0 -22
  280. package/dist/models/UserIdentityRequestBody.js.map +0 -1
  281. package/dist/models/UserIdentityResponse.d.ts +0 -19
  282. package/dist/models/UserIdentityResponse.js +0 -22
  283. package/dist/models/UserIdentityResponse.js.map +0 -1
  284. package/dist/models/UserSubscriptionOptions.d.ts +0 -17
  285. package/dist/models/UserSubscriptionOptions.js +0 -22
  286. package/dist/models/UserSubscriptionOptions.js.map +0 -1
  287. package/models/BeginLiveActivityRequest.ts +0 -38
  288. package/models/CreateNotificationBadRequestResponse.ts +0 -31
  289. package/models/CreateSubscriptionRequestBody.ts +0 -39
  290. package/models/DeletePlayerBadRequestResponse.ts +0 -31
  291. package/models/DeletePlayerSuccessResponse.ts +0 -31
  292. package/models/DeleteSegmentBadRequestResponse.ts +0 -31
  293. package/models/DeleteSegmentNotFoundResponse.ts +0 -31
  294. package/models/DeleteSegmentSuccessResponse.ts +0 -31
  295. package/models/FilterExpressions.ts +0 -80
  296. package/models/FilterNotificationTarget.ts +0 -144
  297. package/models/IdentifyUserConflictResponse.ts +0 -32
  298. package/models/InlineResponse2003.ts +0 -31
  299. package/models/Notification200Errors.ts +0 -45
  300. package/models/Player.ts +0 -291
  301. package/models/PlayerNotificationTargetIncludeAliases.ts +0 -31
  302. package/models/UpdatePlayerSuccessResponse.ts +0 -31
  303. package/models/UpdatePlayerTagsRequestBody.ts +0 -34
  304. package/models/UpdatePlayerTagsSuccessResponse.ts +0 -31
  305. package/models/UpdateSubscriptionRequestBody.ts +0 -32
  306. package/models/UserIdentityRequestBody.ts +0 -31
  307. package/models/UserIdentityResponse.ts +0 -31
  308. package/models/UserSubscriptionOptions.ts +0 -31
@@ -3,40 +3,29 @@ import * as models from '../models/all';
3
3
  import { Configuration} from '../configuration'
4
4
 
5
5
  import { App } from '../models/App';
6
- import { BadRequestError } from '../models/BadRequestError';
7
6
  import { BasicNotification } from '../models/BasicNotification';
8
7
  import { BasicNotificationAllOf } from '../models/BasicNotificationAllOf';
9
8
  import { BasicNotificationAllOfAndroidBackgroundLayout } from '../models/BasicNotificationAllOfAndroidBackgroundLayout';
10
- import { BeginLiveActivityRequest } from '../models/BeginLiveActivityRequest';
11
9
  import { Button } from '../models/Button';
12
- import { CancelNotificationSuccessResponse } from '../models/CancelNotificationSuccessResponse';
13
10
  import { CreateNotificationSuccessResponse } from '../models/CreateNotificationSuccessResponse';
14
- import { CreatePlayerSuccessResponse } from '../models/CreatePlayerSuccessResponse';
15
11
  import { CreateSegmentConflictResponse } from '../models/CreateSegmentConflictResponse';
16
12
  import { CreateSegmentSuccessResponse } from '../models/CreateSegmentSuccessResponse';
17
- import { CreateSubscriptionRequestBody } from '../models/CreateSubscriptionRequestBody';
18
13
  import { CreateUserConflictResponse } from '../models/CreateUserConflictResponse';
19
14
  import { CreateUserConflictResponseErrorsInner } from '../models/CreateUserConflictResponseErrorsInner';
20
15
  import { CreateUserConflictResponseErrorsItemsMeta } from '../models/CreateUserConflictResponseErrorsItemsMeta';
21
- import { DeletePlayerNotFoundResponse } from '../models/DeletePlayerNotFoundResponse';
22
- import { DeletePlayerSuccessResponse } from '../models/DeletePlayerSuccessResponse';
23
- import { DeleteSegmentNotFoundResponse } from '../models/DeleteSegmentNotFoundResponse';
24
- import { DeleteSegmentSuccessResponse } from '../models/DeleteSegmentSuccessResponse';
25
16
  import { DeliveryData } from '../models/DeliveryData';
26
- import { ExportPlayersRequestBody } from '../models/ExportPlayersRequestBody';
27
- import { ExportPlayersSuccessResponse } from '../models/ExportPlayersSuccessResponse';
17
+ import { ExportEventsSuccessResponse } from '../models/ExportEventsSuccessResponse';
18
+ import { ExportSubscriptionsRequestBody } from '../models/ExportSubscriptionsRequestBody';
19
+ import { ExportSubscriptionsSuccessResponse } from '../models/ExportSubscriptionsSuccessResponse';
28
20
  import { Filter } from '../models/Filter';
29
- import { FilterExpressions } from '../models/FilterExpressions';
30
- import { GetNotificationRequestBody } from '../models/GetNotificationRequestBody';
31
- import { IdentifyUserConflictResponse } from '../models/IdentifyUserConflictResponse';
32
- import { IdentifyUserConflictResponseErrorsInner } from '../models/IdentifyUserConflictResponseErrorsInner';
33
- import { InlineResponse200 } from '../models/InlineResponse200';
34
- import { InlineResponse2003 } from '../models/InlineResponse2003';
35
- import { InlineResponse201 } from '../models/InlineResponse201';
36
- import { InlineResponse202 } from '../models/InlineResponse202';
21
+ import { FilterExpression } from '../models/FilterExpression';
22
+ import { GenericError } from '../models/GenericError';
23
+ import { GenericSuccessBoolResponse } from '../models/GenericSuccessBoolResponse';
24
+ import { GetNotificationHistoryRequestBody } from '../models/GetNotificationHistoryRequestBody';
25
+ import { GetSegmentsSuccessResponse } from '../models/GetSegmentsSuccessResponse';
37
26
  import { InvalidIdentifierError } from '../models/InvalidIdentifierError';
27
+ import { LanguageStringMap } from '../models/LanguageStringMap';
38
28
  import { Notification } from '../models/Notification';
39
- import { Notification200Errors } from '../models/Notification200Errors';
40
29
  import { NotificationAllOf } from '../models/NotificationAllOf';
41
30
  import { NotificationHistorySuccessResponse } from '../models/NotificationHistorySuccessResponse';
42
31
  import { NotificationSlice } from '../models/NotificationSlice';
@@ -49,67 +38,89 @@ import { OutcomesData } from '../models/OutcomesData';
49
38
  import { PlatformDeliveryData } from '../models/PlatformDeliveryData';
50
39
  import { PlatformDeliveryDataEmailAllOf } from '../models/PlatformDeliveryDataEmailAllOf';
51
40
  import { PlatformDeliveryDataSmsAllOf } from '../models/PlatformDeliveryDataSmsAllOf';
52
- import { Player } from '../models/Player';
53
- import { PlayerNotificationTarget } from '../models/PlayerNotificationTarget';
54
- import { PlayerNotificationTargetIncludeAliases } from '../models/PlayerNotificationTargetIncludeAliases';
55
- import { PlayerSlice } from '../models/PlayerSlice';
41
+ import { PropertiesBody } from '../models/PropertiesBody';
56
42
  import { PropertiesDeltas } from '../models/PropertiesDeltas';
57
43
  import { PropertiesObject } from '../models/PropertiesObject';
58
44
  import { Purchase } from '../models/Purchase';
45
+ import { RateLimitError } from '../models/RateLimitError';
59
46
  import { Segment } from '../models/Segment';
47
+ import { SegmentData } from '../models/SegmentData';
60
48
  import { SegmentNotificationTarget } from '../models/SegmentNotificationTarget';
61
- import { StringMap } from '../models/StringMap';
62
- import { SubscriptionObject } from '../models/SubscriptionObject';
49
+ import { Subscription } from '../models/Subscription';
50
+ import { SubscriptionBody } from '../models/SubscriptionBody';
51
+ import { SubscriptionNotificationTarget } from '../models/SubscriptionNotificationTarget';
63
52
  import { TransferSubscriptionRequestBody } from '../models/TransferSubscriptionRequestBody';
64
53
  import { UpdateLiveActivityRequest } from '../models/UpdateLiveActivityRequest';
65
54
  import { UpdateLiveActivitySuccessResponse } from '../models/UpdateLiveActivitySuccessResponse';
66
- import { UpdatePlayerSuccessResponse } from '../models/UpdatePlayerSuccessResponse';
67
- import { UpdatePlayerTagsRequestBody } from '../models/UpdatePlayerTagsRequestBody';
68
- import { UpdatePlayerTagsSuccessResponse } from '../models/UpdatePlayerTagsSuccessResponse';
69
- import { UpdateSubscriptionRequestBody } from '../models/UpdateSubscriptionRequestBody';
70
55
  import { UpdateUserRequest } from '../models/UpdateUserRequest';
71
56
  import { User } from '../models/User';
72
- import { UserIdentityRequestBody } from '../models/UserIdentityRequestBody';
73
- import { UserIdentityResponse } from '../models/UserIdentityResponse';
74
- import { UserSubscriptionOptions } from '../models/UserSubscriptionOptions';
57
+ import { UserIdentityBody } from '../models/UserIdentityBody';
58
+ import { WebButton } from '../models/WebButton';
75
59
 
76
60
  import { ObservableDefaultApi } from "./ObservableAPI";
77
61
  import { DefaultApiRequestFactory, DefaultApiResponseProcessor} from "../apis/DefaultApi";
78
62
 
79
- export interface DefaultApiBeginLiveActivityRequest {
63
+ export interface DefaultApiCancelNotificationRequest {
80
64
  /**
81
- * The OneSignal App ID for your app. Available in Keys & IDs.
65
+ *
82
66
  * @type string
83
- * @memberof DefaultApibeginLiveActivity
67
+ * @memberof DefaultApicancelNotification
84
68
  */
85
69
  appId: string
86
70
  /**
87
- * Live Activity record ID
71
+ *
88
72
  * @type string
89
- * @memberof DefaultApibeginLiveActivity
73
+ * @memberof DefaultApicancelNotification
90
74
  */
91
- activityId: string
75
+ notificationId: string
76
+ }
77
+
78
+ export interface DefaultApiCreateAliasRequest {
92
79
  /**
93
80
  *
94
- * @type BeginLiveActivityRequest
95
- * @memberof DefaultApibeginLiveActivity
81
+ * @type string
82
+ * @memberof DefaultApicreateAlias
96
83
  */
97
- beginLiveActivityRequest: BeginLiveActivityRequest
84
+ appId: string
85
+ /**
86
+ *
87
+ * @type string
88
+ * @memberof DefaultApicreateAlias
89
+ */
90
+ aliasLabel: string
91
+ /**
92
+ *
93
+ * @type string
94
+ * @memberof DefaultApicreateAlias
95
+ */
96
+ aliasId: string
97
+ /**
98
+ *
99
+ * @type UserIdentityBody
100
+ * @memberof DefaultApicreateAlias
101
+ */
102
+ userIdentityBody: UserIdentityBody
98
103
  }
99
104
 
100
- export interface DefaultApiCancelNotificationRequest {
105
+ export interface DefaultApiCreateAliasBySubscriptionRequest {
101
106
  /**
102
107
  *
103
108
  * @type string
104
- * @memberof DefaultApicancelNotification
109
+ * @memberof DefaultApicreateAliasBySubscription
105
110
  */
106
111
  appId: string
107
112
  /**
108
113
  *
109
114
  * @type string
110
- * @memberof DefaultApicancelNotification
115
+ * @memberof DefaultApicreateAliasBySubscription
111
116
  */
112
- notificationId: string
117
+ subscriptionId: string
118
+ /**
119
+ *
120
+ * @type UserIdentityBody
121
+ * @memberof DefaultApicreateAliasBySubscription
122
+ */
123
+ userIdentityBody: UserIdentityBody
113
124
  }
114
125
 
115
126
  export interface DefaultApiCreateAppRequest {
@@ -130,26 +141,17 @@ export interface DefaultApiCreateNotificationRequest {
130
141
  notification: Notification
131
142
  }
132
143
 
133
- export interface DefaultApiCreatePlayerRequest {
134
- /**
135
- *
136
- * @type Player
137
- * @memberof DefaultApicreatePlayer
138
- */
139
- player: Player
140
- }
141
-
142
- export interface DefaultApiCreateSegmentsRequest {
144
+ export interface DefaultApiCreateSegmentRequest {
143
145
  /**
144
146
  * The OneSignal App ID for your app. Available in Keys & IDs.
145
147
  * @type string
146
- * @memberof DefaultApicreateSegments
148
+ * @memberof DefaultApicreateSegment
147
149
  */
148
150
  appId: string
149
151
  /**
150
152
  *
151
153
  * @type Segment
152
- * @memberof DefaultApicreateSegments
154
+ * @memberof DefaultApicreateSegment
153
155
  */
154
156
  segment?: Segment
155
157
  }
@@ -175,10 +177,10 @@ export interface DefaultApiCreateSubscriptionRequest {
175
177
  aliasId: string
176
178
  /**
177
179
  *
178
- * @type CreateSubscriptionRequestBody
180
+ * @type SubscriptionBody
179
181
  * @memberof DefaultApicreateSubscription
180
182
  */
181
- createSubscriptionRequestBody: CreateSubscriptionRequestBody
183
+ subscriptionBody: SubscriptionBody
182
184
  }
183
185
 
184
186
  export interface DefaultApiCreateUserRequest {
@@ -223,32 +225,17 @@ export interface DefaultApiDeleteAliasRequest {
223
225
  aliasLabelToDelete: string
224
226
  }
225
227
 
226
- export interface DefaultApiDeletePlayerRequest {
227
- /**
228
- * The OneSignal App ID for your app. Available in Keys & IDs.
229
- * @type string
230
- * @memberof DefaultApideletePlayer
231
- */
232
- appId: string
233
- /**
234
- * The OneSignal player_id
235
- * @type string
236
- * @memberof DefaultApideletePlayer
237
- */
238
- playerId: string
239
- }
240
-
241
- export interface DefaultApiDeleteSegmentsRequest {
228
+ export interface DefaultApiDeleteSegmentRequest {
242
229
  /**
243
230
  * The OneSignal App ID for your app. Available in Keys & IDs.
244
231
  * @type string
245
- * @memberof DefaultApideleteSegments
232
+ * @memberof DefaultApideleteSegment
246
233
  */
247
234
  appId: string
248
235
  /**
249
236
  * The segment_id can be found in the URL of the segment when viewing it in the dashboard.
250
237
  * @type string
251
- * @memberof DefaultApideleteSegments
238
+ * @memberof DefaultApideleteSegment
252
239
  */
253
240
  segmentId: string
254
241
  }
@@ -289,97 +276,70 @@ export interface DefaultApiDeleteUserRequest {
289
276
  aliasId: string
290
277
  }
291
278
 
292
- export interface DefaultApiEndLiveActivityRequest {
279
+ export interface DefaultApiExportEventsRequest {
293
280
  /**
294
- * The OneSignal App ID for your app. Available in Keys & IDs.
281
+ * The ID of the notification to export events from.
295
282
  * @type string
296
- * @memberof DefaultApiendLiveActivity
283
+ * @memberof DefaultApiexportEvents
297
284
  */
298
- appId: string
299
- /**
300
- * Live Activity record ID
301
- * @type string
302
- * @memberof DefaultApiendLiveActivity
303
- */
304
- activityId: string
305
- /**
306
- * Subscription ID
307
- * @type string
308
- * @memberof DefaultApiendLiveActivity
309
- */
310
- subscriptionId: string
311
- }
312
-
313
- export interface DefaultApiExportPlayersRequest {
285
+ notificationId: string
314
286
  /**
315
- * The app ID that you want to export devices from
287
+ * The ID of the app that the notification belongs to.
316
288
  * @type string
317
- * @memberof DefaultApiexportPlayers
289
+ * @memberof DefaultApiexportEvents
318
290
  */
319
291
  appId: string
320
- /**
321
- *
322
- * @type ExportPlayersRequestBody
323
- * @memberof DefaultApiexportPlayers
324
- */
325
- exportPlayersRequestBody?: ExportPlayersRequestBody
326
292
  }
327
293
 
328
- export interface DefaultApiFetchAliasesRequest {
294
+ export interface DefaultApiExportSubscriptionsRequest {
329
295
  /**
330
- *
296
+ * The app ID that you want to export devices from
331
297
  * @type string
332
- * @memberof DefaultApifetchAliases
298
+ * @memberof DefaultApiexportSubscriptions
333
299
  */
334
300
  appId: string
335
301
  /**
336
302
  *
337
- * @type string
338
- * @memberof DefaultApifetchAliases
303
+ * @type ExportSubscriptionsRequestBody
304
+ * @memberof DefaultApiexportSubscriptions
339
305
  */
340
- subscriptionId: string
306
+ exportSubscriptionsRequestBody?: ExportSubscriptionsRequestBody
341
307
  }
342
308
 
343
- export interface DefaultApiFetchUserRequest {
309
+ export interface DefaultApiGetAliasesRequest {
344
310
  /**
345
311
  *
346
312
  * @type string
347
- * @memberof DefaultApifetchUser
313
+ * @memberof DefaultApigetAliases
348
314
  */
349
315
  appId: string
350
316
  /**
351
317
  *
352
318
  * @type string
353
- * @memberof DefaultApifetchUser
319
+ * @memberof DefaultApigetAliases
354
320
  */
355
321
  aliasLabel: string
356
322
  /**
357
323
  *
358
324
  * @type string
359
- * @memberof DefaultApifetchUser
325
+ * @memberof DefaultApigetAliases
360
326
  */
361
327
  aliasId: string
362
328
  }
363
329
 
364
- export interface DefaultApiFetchUserIdentityRequest {
330
+ export interface DefaultApiGetAliasesBySubscriptionRequest {
365
331
  /**
366
332
  *
367
333
  * @type string
368
- * @memberof DefaultApifetchUserIdentity
334
+ * @memberof DefaultApigetAliasesBySubscription
369
335
  */
370
336
  appId: string
371
337
  /**
372
338
  *
373
339
  * @type string
374
- * @memberof DefaultApifetchUserIdentity
340
+ * @memberof DefaultApigetAliasesBySubscription
375
341
  */
376
- aliasLabel: string
377
- /**
378
- *
379
- * @type string
380
- * @memberof DefaultApifetchUserIdentity
381
- */
382
- aliasId: string
342
+ subscriptionId: string
383
343
  }
384
344
 
385
345
  export interface DefaultApiGetAppRequest {
@@ -394,21 +354,6 @@ export interface DefaultApiGetAppRequest {
394
354
  export interface DefaultApiGetAppsRequest {
395
355
  }
396
356
 
397
- export interface DefaultApiGetEligibleIamsRequest {
398
- /**
399
- *
400
- * @type string
401
- * @memberof DefaultApigetEligibleIams
402
- */
403
- appId: string
404
- /**
405
- *
406
- * @type string
407
- * @memberof DefaultApigetEligibleIams
408
- */
409
- subscriptionId: string
410
- }
411
-
412
357
  export interface DefaultApiGetNotificationRequest {
413
358
  /**
414
359
  *
@@ -433,10 +378,10 @@ export interface DefaultApiGetNotificationHistoryRequest {
433
378
  notificationId: string
434
379
  /**
435
380
  *
436
- * @type GetNotificationRequestBody
381
+ * @type GetNotificationHistoryRequestBody
437
382
  * @memberof DefaultApigetNotificationHistory
438
383
  */
439
- getNotificationRequestBody: GetNotificationRequestBody
384
+ getNotificationHistoryRequestBody: GetNotificationHistoryRequestBody
440
385
  }
441
386
 
442
387
  export interface DefaultApiGetNotificationsRequest {
@@ -505,115 +450,88 @@ export interface DefaultApiGetOutcomesRequest {
505
450
  outcomeAttribution?: string
506
451
  }
507
452
 
508
- export interface DefaultApiGetPlayerRequest {
509
- /**
510
- * Your app_id for this device
511
- * @type string
512
- * @memberof DefaultApigetPlayer
513
- */
514
- appId: string
515
- /**
516
- * Player\'s OneSignal ID
517
- * @type string
518
- * @memberof DefaultApigetPlayer
519
- */
520
- playerId: string
521
- /**
522
- * Email - Only required if you have enabled Identity Verification and device_type is email (11).
523
- * @type string
524
- * @memberof DefaultApigetPlayer
525
- */
526
- emailAuthHash?: string
527
- }
528
-
529
- export interface DefaultApiGetPlayersRequest {
453
+ export interface DefaultApiGetSegmentsRequest {
530
454
  /**
531
- * The app ID that you want to view players from
455
+ * The OneSignal App ID for your app. Available in Keys & IDs.
532
456
  * @type string
533
- * @memberof DefaultApigetPlayers
457
+ * @memberof DefaultApigetSegments
534
458
  */
535
459
  appId: string
536
460
  /**
537
- * How many devices to return. Max is 300. Default is 300
461
+ * Segments are listed in ascending order of created_at date. offset will omit that number of segments from the beginning of the list. Eg offset 5, will remove the 5 earliest created Segments.
538
462
  * @type number
539
- * @memberof DefaultApigetPlayers
463
+ * @memberof DefaultApigetSegments
540
464
  */
541
- limit?: number
465
+ offset?: number
542
466
  /**
543
- * Result offset. Default is 0. Results are sorted by id;
467
+ * The amount of Segments in the response. Maximum 300.
544
468
  * @type number
545
- * @memberof DefaultApigetPlayers
469
+ * @memberof DefaultApigetSegments
546
470
  */
547
- offset?: number
471
+ limit?: number
548
472
  }
549
473
 
550
- export interface DefaultApiIdentifyUserByAliasRequest {
474
+ export interface DefaultApiGetUserRequest {
551
475
  /**
552
476
  *
553
477
  * @type string
554
- * @memberof DefaultApiidentifyUserByAlias
478
+ * @memberof DefaultApigetUser
555
479
  */
556
480
  appId: string
557
481
  /**
558
482
  *
559
483
  * @type string
560
- * @memberof DefaultApiidentifyUserByAlias
484
+ * @memberof DefaultApigetUser
561
485
  */
562
486
  aliasLabel: string
563
487
  /**
564
488
  *
565
489
  * @type string
566
- * @memberof DefaultApiidentifyUserByAlias
490
+ * @memberof DefaultApigetUser
567
491
  */
568
492
  aliasId: string
569
- /**
570
- *
571
- * @type UserIdentityRequestBody
572
- * @memberof DefaultApiidentifyUserByAlias
573
- */
574
- userIdentityRequestBody: UserIdentityRequestBody
575
493
  }
576
494
 
577
- export interface DefaultApiIdentifyUserBySubscriptionIdRequest {
495
+ export interface DefaultApiTransferSubscriptionRequest {
578
496
  /**
579
497
  *
580
498
  * @type string
581
- * @memberof DefaultApiidentifyUserBySubscriptionId
499
+ * @memberof DefaultApitransferSubscription
582
500
  */
583
501
  appId: string
584
502
  /**
585
503
  *
586
504
  * @type string
587
- * @memberof DefaultApiidentifyUserBySubscriptionId
505
+ * @memberof DefaultApitransferSubscription
588
506
  */
589
507
  subscriptionId: string
590
508
  /**
591
509
  *
592
- * @type UserIdentityRequestBody
593
- * @memberof DefaultApiidentifyUserBySubscriptionId
510
+ * @type TransferSubscriptionRequestBody
511
+ * @memberof DefaultApitransferSubscription
594
512
  */
595
- userIdentityRequestBody: UserIdentityRequestBody
513
+ transferSubscriptionRequestBody: TransferSubscriptionRequestBody
596
514
  }
597
515
 
598
- export interface DefaultApiTransferSubscriptionRequest {
516
+ export interface DefaultApiUnsubscribeEmailWithTokenRequest {
599
517
  /**
600
- *
518
+ * The OneSignal App ID for your app. Available in Keys & IDs.
601
519
  * @type string
602
- * @memberof DefaultApitransferSubscription
520
+ * @memberof DefaultApiunsubscribeEmailWithToken
603
521
  */
604
522
  appId: string
605
523
  /**
606
- *
524
+ * The id of the message found in the creation notification POST response, View Notifications GET response, or URL within the Message Report.
607
525
  * @type string
608
- * @memberof DefaultApitransferSubscription
526
+ * @memberof DefaultApiunsubscribeEmailWithToken
609
527
  */
610
- subscriptionId: string
528
+ notificationId: string
611
529
  /**
612
- *
613
- * @type TransferSubscriptionRequestBody
614
- * @memberof DefaultApitransferSubscription
530
+ * The unsubscribe token that is generated via liquid syntax in {{subscription.unsubscribe_token}} when personalizing an email.
531
+ * @type string
532
+ * @memberof DefaultApiunsubscribeEmailWithToken
615
533
  */
616
- transferSubscriptionRequestBody: TransferSubscriptionRequestBody
534
+ token: string
617
535
  }
618
536
 
619
537
  export interface DefaultApiUpdateAppRequest {
@@ -652,42 +570,6 @@ export interface DefaultApiUpdateLiveActivityRequest {
652
570
  updateLiveActivityRequest: UpdateLiveActivityRequest
653
571
  }
654
572
 
655
- export interface DefaultApiUpdatePlayerRequest {
656
- /**
657
- * Player\'s OneSignal ID
658
- * @type string
659
- * @memberof DefaultApiupdatePlayer
660
- */
661
- playerId: string
662
- /**
663
- *
664
- * @type Player
665
- * @memberof DefaultApiupdatePlayer
666
- */
667
- player: Player
668
- }
669
-
670
- export interface DefaultApiUpdatePlayerTagsRequest {
671
- /**
672
- * The OneSignal App ID the user record is found under.
673
- * @type string
674
- * @memberof DefaultApiupdatePlayerTags
675
- */
676
- appId: string
677
- /**
678
- * The External User ID mapped to teh device record in OneSignal. Must be actively set on the device to be updated.
679
- * @type string
680
- * @memberof DefaultApiupdatePlayerTags
681
- */
682
- externalUserId: string
683
- /**
684
- *
685
- * @type UpdatePlayerTagsRequestBody
686
- * @memberof DefaultApiupdatePlayerTags
687
- */
688
- updatePlayerTagsRequestBody?: UpdatePlayerTagsRequestBody
689
- }
690
-
691
573
  export interface DefaultApiUpdateSubscriptionRequest {
692
574
  /**
693
575
  *
@@ -703,10 +585,10 @@ export interface DefaultApiUpdateSubscriptionRequest {
703
585
  subscriptionId: string
704
586
  /**
705
587
  *
706
- * @type UpdateSubscriptionRequestBody
588
+ * @type SubscriptionBody
707
589
  * @memberof DefaultApiupdateSubscription
708
590
  */
709
- updateSubscriptionRequestBody: UpdateSubscriptionRequestBody
591
+ subscriptionBody: SubscriptionBody
710
592
  }
711
593
 
712
594
  export interface DefaultApiUpdateUserRequest {
@@ -744,21 +626,28 @@ export class ObjectDefaultApi {
744
626
  }
745
627
 
746
628
  /**
747
- * Starts a Live Activity
748
- * Start Live Activity
629
+ * Used to stop a scheduled or currently outgoing notification
630
+ * Stop a scheduled or currently outgoing notification
749
631
  * @param param the request object
750
632
  */
751
- public beginLiveActivity(param: DefaultApiBeginLiveActivityRequest, options?: Configuration): Promise<void> {
752
- return this.api.beginLiveActivity(param.appId, param.activityId, param.beginLiveActivityRequest, options).toPromise();
633
+ public cancelNotification(param: DefaultApiCancelNotificationRequest, options?: Configuration): Promise<GenericSuccessBoolResponse> {
634
+ return this.api.cancelNotification(param.appId, param.notificationId, options).toPromise();
753
635
  }
754
636
 
755
637
  /**
756
- * Used to stop a scheduled or currently outgoing notification
757
- * Stop a scheduled or currently outgoing notification
638
+ * Upserts one or more Aliases to an existing User identified by (:alias_label, :alias_id).
758
639
  * @param param the request object
759
640
  */
760
- public cancelNotification(param: DefaultApiCancelNotificationRequest, options?: Configuration): Promise<CancelNotificationSuccessResponse> {
761
- return this.api.cancelNotification(param.appId, param.notificationId, options).toPromise();
641
+ public createAlias(param: DefaultApiCreateAliasRequest, options?: Configuration): Promise<UserIdentityBody> {
642
+ return this.api.createAlias(param.appId, param.aliasLabel, param.aliasId, param.userIdentityBody, options).toPromise();
643
+ }
644
+
645
+ /**
646
+ * Upserts one or more Aliases for the User identified by :subscription_id.
647
+ * @param param the request object
648
+ */
649
+ public createAliasBySubscription(param: DefaultApiCreateAliasBySubscriptionRequest, options?: Configuration): Promise<UserIdentityBody> {
650
+ return this.api.createAliasBySubscription(param.appId, param.subscriptionId, param.userIdentityBody, options).toPromise();
762
651
  }
763
652
 
764
653
  /**
@@ -780,29 +669,20 @@ export class ObjectDefaultApi {
780
669
  }
781
670
 
782
671
  /**
783
- * Register a new device to one of your OneSignal apps &#x1F6A7; Don\'t use this This API endpoint is designed to be used from our open source Mobile and Web Push SDKs. It is not designed for developers to use it directly, unless instructed to do so by OneSignal support. If you use this method instead of our SDKs, many OneSignal features such as conversion tracking, timezone tracking, language detection, and rich-push won\'t work out of the box. It will also make it harder to identify possible setup issues. This method is used to register a new device with OneSignal. If a device is already registered with the specified identifier, then this will update the existing device record instead of creating a new one. The returned player is a player / user ID. Use the returned ID to send push notifications to this specific user later, or to include this player when sending to a set of users. &#x1F6A7; iOS Must set test_type to 1 when building your iOS app as development. Omit this field in your production app builds.
784
- * Add a device
672
+ * Create a segment visible and usable in the dashboard and API - Required: OneSignal Paid Plan The Create Segment method is used when you want your server to programmatically create a segment instead of using the OneSignal Dashboard UI. Just like creating Segments from the dashboard you can pass in filters with multiple \"AND\" or \"OR\" operator\'s. &#x1F6A7; Does Not Update Segments This endpoint will only create segments, it does not edit or update currently created Segments. You will need to use the Delete Segment endpoint and re-create it with this endpoint to edit.
673
+ * Create Segment
785
674
  * @param param the request object
786
675
  */
787
- public createPlayer(param: DefaultApiCreatePlayerRequest, options?: Configuration): Promise<CreatePlayerSuccessResponse> {
788
- return this.api.createPlayer(param.player, options).toPromise();
789
- }
790
-
791
- /**
792
- * Create segments visible and usable in the dashboard and API - Required: OneSignal Paid Plan The Create Segment method is used when you want your server to programmatically create a segment instead of using the OneSignal Dashboard UI. Just like creating Segments from the dashboard you can pass in filters with multiple \"AND\" or \"OR\" operator\'s. &#x1F6A7; Does Not Update Segments This endpoint will only create segments, it does not edit or update currently created Segments. You will need to use the Delete Segments endpoint and re-create it with this endpoint to edit.
793
- * Create Segments
794
- * @param param the request object
795
- */
796
- public createSegments(param: DefaultApiCreateSegmentsRequest, options?: Configuration): Promise<CreateSegmentSuccessResponse> {
797
- return this.api.createSegments(param.appId, param.segment, options).toPromise();
676
+ public createSegment(param: DefaultApiCreateSegmentRequest, options?: Configuration): Promise<CreateSegmentSuccessResponse> {
677
+ return this.api.createSegment(param.appId, param.segment, options).toPromise();
798
678
  }
799
679
 
800
680
  /**
801
681
  * Creates a new Subscription under the User provided. Useful to add email addresses and SMS numbers to the User.
802
682
  * @param param the request object
803
683
  */
804
- public createSubscription(param: DefaultApiCreateSubscriptionRequest, options?: Configuration): Promise<InlineResponse201> {
805
- return this.api.createSubscription(param.appId, param.aliasLabel, param.aliasId, param.createSubscriptionRequestBody, options).toPromise();
684
+ public createSubscription(param: DefaultApiCreateSubscriptionRequest, options?: Configuration): Promise<SubscriptionBody> {
685
+ return this.api.createSubscription(param.appId, param.aliasLabel, param.aliasId, param.subscriptionBody, options).toPromise();
806
686
  }
807
687
 
808
688
  /**
@@ -817,26 +697,17 @@ export class ObjectDefaultApi {
817
697
  * Deletes an alias by alias label
818
698
  * @param param the request object
819
699
  */
820
- public deleteAlias(param: DefaultApiDeleteAliasRequest, options?: Configuration): Promise<InlineResponse200> {
700
+ public deleteAlias(param: DefaultApiDeleteAliasRequest, options?: Configuration): Promise<UserIdentityBody> {
821
701
  return this.api.deleteAlias(param.appId, param.aliasLabel, param.aliasId, param.aliasLabelToDelete, options).toPromise();
822
702
  }
823
703
 
824
704
  /**
825
- * Delete player - Required: Used to delete a single, specific Player ID record from a specific OneSignal app.
826
- * Delete a user record
827
- * @param param the request object
828
- */
829
- public deletePlayer(param: DefaultApiDeletePlayerRequest, options?: Configuration): Promise<DeletePlayerSuccessResponse> {
830
- return this.api.deletePlayer(param.appId, param.playerId, options).toPromise();
831
- }
832
-
833
- /**
834
- * Delete segments (not user devices) - Required: OneSignal Paid Plan You can delete a segment under your app by calling this API. You must provide an API key in the Authorization header that has admin access on the app. The segment_id can be found in the URL of the segment when viewing it in the dashboard.
835
- * Delete Segments
705
+ * Delete a segment (not user devices) - Required: OneSignal Paid Plan You can delete a segment under your app by calling this API. You must provide an API key in the Authorization header that has admin access on the app. The segment_id can be found in the URL of the segment when viewing it in the dashboard.
706
+ * Delete Segment
836
707
  * @param param the request object
837
708
  */
838
- public deleteSegments(param: DefaultApiDeleteSegmentsRequest, options?: Configuration): Promise<DeleteSegmentSuccessResponse> {
839
- return this.api.deleteSegments(param.appId, param.segmentId, options).toPromise();
709
+ public deleteSegment(param: DefaultApiDeleteSegmentRequest, options?: Configuration): Promise<GenericSuccessBoolResponse> {
710
+ return this.api.deleteSegment(param.appId, param.segmentId, options).toPromise();
840
711
  }
841
712
 
842
713
  /**
@@ -856,45 +727,37 @@ export class ObjectDefaultApi {
856
727
  }
857
728
 
858
729
  /**
859
- * Stops a Live Activity
860
- * Stop Live Activity
730
+ * Generate a compressed CSV report of all of the events data for a notification. This will return a URL immediately upon success but it may take several minutes for the CSV to become available at that URL depending on the volume of data. Only one export can be in-progress per OneSignal account at any given time.
731
+ * Export CSV of Events
861
732
  * @param param the request object
862
733
  */
863
- public endLiveActivity(param: DefaultApiEndLiveActivityRequest, options?: Configuration): Promise<void> {
864
- return this.api.endLiveActivity(param.appId, param.activityId, param.subscriptionId, options).toPromise();
734
+ public exportEvents(param: DefaultApiExportEventsRequest, options?: Configuration): Promise<ExportEventsSuccessResponse> {
735
+ return this.api.exportEvents(param.notificationId, param.appId, options).toPromise();
865
736
  }
866
737
 
867
738
  /**
868
739
  * Generate a compressed CSV export of all of your current user data This method can be used to generate a compressed CSV export of all of your current user data. It is a much faster alternative than retrieving this data using the /players API endpoint. The file will be compressed using GZip. The file may take several minutes to generate depending on the number of users in your app. The URL generated will be available for 3 days and includes random v4 uuid as part of the resource name to be unguessable. &#x1F6A7; 403 Error Responses You can test if it is complete by making a GET request to the csv_file_url value. This file may take time to generate depending on how many device records are being pulled. If the file is not ready, a 403 error will be returned. Otherwise the file itself will be returned. &#x1F6A7; Requires Authentication Key Requires your OneSignal App\'s REST API Key, available in Keys & IDs. &#x1F6A7; Concurrent Exports Only one concurrent export is allowed per OneSignal account. Please ensure you have successfully downloaded the .csv.gz file before exporting another app. CSV File Format: - Default Columns: | Field | Details | | --- | --- | | id | OneSignal Player Id | | identifier | Push Token | | session_count | Number of times they visited the app or site | language | Device language code | | timezone | Number of seconds away from UTC. Example: -28800 | | game_version | Version of your mobile app gathered from Android Studio versionCode in your App/build.gradle and iOS uses kCFBundleVersionKey in Xcode. | | device_os | Device Operating System Version. Example: 80 = Chrome 80, 9 = Android 9 | | device_type | Device Operating System Type | | device_model | Device Hardware String Code. Example: Mobile Web Subscribers will have `Linux armv` | | ad_id | Based on the Google Advertising Id for Android, identifierForVendor for iOS. OptedOut means user turned off Advertising tracking on the device. | | tags | Current OneSignal Data Tags on the device. | | last_active | Date and time the user last opened the mobile app or visited the site. | | playtime | Total amount of time in seconds the user had the mobile app open. | | amount_spent | Mobile only - amount spent in USD on In-App Purchases. | | created_at | Date and time the device record was created in OneSignal. Mobile - first time they opened the app with OneSignal SDK. Web - first time the user subscribed to the site. | | invalid_identifier | t = unsubscribed, f = subscibed | | badge_count | Current number of badges on the device | - Extra Columns: | Field | Details | | --- | --- | | external_user_id | Your User Id set on the device | | notification_types | Notification types | | location | Location points (Latitude and Longitude) set on the device. | | country | Country code | | rooted | Android device rooted or not | | ip | IP Address of the device if being tracked. See Handling Personal Data. | | web_auth | Web Only authorization key. | | web_p256 | Web Only p256 key. |
869
- * CSV export
740
+ * Export CSV of Subscriptions
870
741
  * @param param the request object
871
742
  */
872
- public exportPlayers(param: DefaultApiExportPlayersRequest, options?: Configuration): Promise<ExportPlayersSuccessResponse> {
873
- return this.api.exportPlayers(param.appId, param.exportPlayersRequestBody, options).toPromise();
743
+ public exportSubscriptions(param: DefaultApiExportSubscriptionsRequest, options?: Configuration): Promise<ExportSubscriptionsSuccessResponse> {
744
+ return this.api.exportSubscriptions(param.appId, param.exportSubscriptionsRequestBody, options).toPromise();
874
745
  }
875
746
 
876
747
  /**
877
- * Lists all Aliases for the User identified by :subscription_id.
878
- * @param param the request object
879
- */
880
- public fetchAliases(param: DefaultApiFetchAliasesRequest, options?: Configuration): Promise<UserIdentityResponse> {
881
- return this.api.fetchAliases(param.appId, param.subscriptionId, options).toPromise();
882
- }
883
-
884
- /**
885
- * Returns the User’s properties, Aliases, and Subscriptions.
748
+ * Lists all Aliases for the User identified by (:alias_label, :alias_id).
886
749
  * @param param the request object
887
750
  */
888
- public fetchUser(param: DefaultApiFetchUserRequest, options?: Configuration): Promise<User> {
889
- return this.api.fetchUser(param.appId, param.aliasLabel, param.aliasId, options).toPromise();
751
+ public getAliases(param: DefaultApiGetAliasesRequest, options?: Configuration): Promise<UserIdentityBody> {
752
+ return this.api.getAliases(param.appId, param.aliasLabel, param.aliasId, options).toPromise();
890
753
  }
891
754
 
892
755
  /**
893
- * Lists all Aliases for the User identified by (:alias_label, :alias_id).
756
+ * Lists all Aliases for the User identified by :subscription_id.
894
757
  * @param param the request object
895
758
  */
896
- public fetchUserIdentity(param: DefaultApiFetchUserIdentityRequest, options?: Configuration): Promise<InlineResponse200> {
897
- return this.api.fetchUserIdentity(param.appId, param.aliasLabel, param.aliasId, options).toPromise();
759
+ public getAliasesBySubscription(param: DefaultApiGetAliasesBySubscriptionRequest, options?: Configuration): Promise<UserIdentityBody> {
760
+ return this.api.getAliasesBySubscription(param.appId, param.subscriptionId, options).toPromise();
898
761
  }
899
762
 
900
763
  /**
@@ -915,14 +778,6 @@ export class ObjectDefaultApi {
915
778
  return this.api.getApps( options).toPromise();
916
779
  }
917
780
 
918
- /**
919
- * Manifest of In-App Messages the Subscription is eligible to display by the SDK.
920
- * @param param the request object
921
- */
922
- public getEligibleIams(param: DefaultApiGetEligibleIamsRequest, options?: Configuration): Promise<InlineResponse2003> {
923
- return this.api.getEligibleIams(param.appId, param.subscriptionId, options).toPromise();
924
- }
925
-
926
781
  /**
927
782
  * View the details of a single notification and outcomes associated with it
928
783
  * View notification
@@ -938,7 +793,7 @@ export class ObjectDefaultApi {
938
793
  * @param param the request object
939
794
  */
940
795
  public getNotificationHistory(param: DefaultApiGetNotificationHistoryRequest, options?: Configuration): Promise<NotificationHistorySuccessResponse> {
941
- return this.api.getNotificationHistory(param.notificationId, param.getNotificationRequestBody, options).toPromise();
796
+ return this.api.getNotificationHistory(param.notificationId, param.getNotificationHistoryRequestBody, options).toPromise();
942
797
  }
943
798
 
944
799
  /**
@@ -960,45 +815,37 @@ export class ObjectDefaultApi {
960
815
  }
961
816
 
962
817
  /**
963
- * View the details of an existing device in one of your OneSignal apps
964
- * View device
818
+ * Returns an array of segments from an app.
819
+ * Get Segments
965
820
  * @param param the request object
966
821
  */
967
- public getPlayer(param: DefaultApiGetPlayerRequest, options?: Configuration): Promise<Player> {
968
- return this.api.getPlayer(param.appId, param.playerId, param.emailAuthHash, options).toPromise();
822
+ public getSegments(param: DefaultApiGetSegmentsRequest, options?: Configuration): Promise<GetSegmentsSuccessResponse> {
823
+ return this.api.getSegments(param.appId, param.offset, param.limit, options).toPromise();
969
824
  }
970
825
 
971
826
  /**
972
- * View the details of multiple devices in one of your OneSignal apps Unavailable for Apps Over 80,000 Users For performance reasons, this method is not available for larger apps. Larger apps should use the CSV export API endpoint, which is much more performant.
973
- * View devices
974
- * @param param the request object
975
- */
976
- public getPlayers(param: DefaultApiGetPlayersRequest, options?: Configuration): Promise<PlayerSlice> {
977
- return this.api.getPlayers(param.appId, param.limit, param.offset, options).toPromise();
978
- }
979
-
980
- /**
981
- * Upserts one or more Aliases to an existing User identified by (:alias_label, :alias_id).
827
+ * Returns the User’s properties, Aliases, and Subscriptions.
982
828
  * @param param the request object
983
829
  */
984
- public identifyUserByAlias(param: DefaultApiIdentifyUserByAliasRequest, options?: Configuration): Promise<InlineResponse200> {
985
- return this.api.identifyUserByAlias(param.appId, param.aliasLabel, param.aliasId, param.userIdentityRequestBody, options).toPromise();
830
+ public getUser(param: DefaultApiGetUserRequest, options?: Configuration): Promise<User> {
831
+ return this.api.getUser(param.appId, param.aliasLabel, param.aliasId, options).toPromise();
986
832
  }
987
833
 
988
834
  /**
989
- * Upserts one or more Aliases for the User identified by :subscription_id.
835
+ * Transfers this Subscription to the User identified by the identity in the payload.
990
836
  * @param param the request object
991
837
  */
992
- public identifyUserBySubscriptionId(param: DefaultApiIdentifyUserBySubscriptionIdRequest, options?: Configuration): Promise<UserIdentityResponse> {
993
- return this.api.identifyUserBySubscriptionId(param.appId, param.subscriptionId, param.userIdentityRequestBody, options).toPromise();
838
+ public transferSubscription(param: DefaultApiTransferSubscriptionRequest, options?: Configuration): Promise<UserIdentityBody> {
839
+ return this.api.transferSubscription(param.appId, param.subscriptionId, param.transferSubscriptionRequestBody, options).toPromise();
994
840
  }
995
841
 
996
842
  /**
997
- * Transfers this Subscription to the User identified by the identity in the payload.
843
+ * Unsubscribe an email with a token when using your own custom email unsubscribe landing page
844
+ * Unsubscribe with token
998
845
  * @param param the request object
999
846
  */
1000
- public transferSubscription(param: DefaultApiTransferSubscriptionRequest, options?: Configuration): Promise<UserIdentityResponse> {
1001
- return this.api.transferSubscription(param.appId, param.subscriptionId, param.transferSubscriptionRequestBody, options).toPromise();
847
+ public unsubscribeEmailWithToken(param: DefaultApiUnsubscribeEmailWithTokenRequest, options?: Configuration): Promise<GenericSuccessBoolResponse> {
848
+ return this.api.unsubscribeEmailWithToken(param.appId, param.notificationId, param.token, options).toPromise();
1002
849
  }
1003
850
 
1004
851
  /**
@@ -1019,37 +866,19 @@ export class ObjectDefaultApi {
1019
866
  return this.api.updateLiveActivity(param.appId, param.activityId, param.updateLiveActivityRequest, options).toPromise();
1020
867
  }
1021
868
 
1022
- /**
1023
- * Update an existing device in one of your OneSignal apps
1024
- * Edit device
1025
- * @param param the request object
1026
- */
1027
- public updatePlayer(param: DefaultApiUpdatePlayerRequest, options?: Configuration): Promise<UpdatePlayerSuccessResponse> {
1028
- return this.api.updatePlayer(param.playerId, param.player, options).toPromise();
1029
- }
1030
-
1031
- /**
1032
- * Update an existing device\'s tags in one of your OneSignal apps using the External User ID. Warning - Android SDK Data Synchronization Tags added through the Android SDK tagging methods may not update if using the API to change or update the same tag. For example, if you use SDK method sendTag(\"key\", \"value1\") then update the tag value to \"value2\" with this API endpoint. You will not be able to set the value back to \"value1\" through the SDK, you will need to change it to something different through the SDK to be reset. Recommendations if using this Endpoint on Android Mobile Apps: 1 - Do not use the same tag keys for SDK and API updates 2 - If you want to use the same key for both SDK and API updates, call the SDK getTags method first to update the device\'s tags. This is only applicable on the Android Mobile App SDKs. &#128216; Deleting Tags To delete a tag, include its key and set its value to blank. Omitting a key/value will not delete it. For example, if I wanted to delete two existing tags rank and category while simultaneously adding a new tag class, the tags JSON would look like the following: \"tags\": { \"rank\": \"\", \"category\": \"\", \"class\": \"my_new_value\" }
1033
- * Edit tags with external user id
1034
- * @param param the request object
1035
- */
1036
- public updatePlayerTags(param: DefaultApiUpdatePlayerTagsRequest, options?: Configuration): Promise<UpdatePlayerTagsSuccessResponse> {
1037
- return this.api.updatePlayerTags(param.appId, param.externalUserId, param.updatePlayerTagsRequestBody, options).toPromise();
1038
- }
1039
-
1040
869
  /**
1041
870
  * Updates an existing Subscription’s properties.
1042
871
  * @param param the request object
1043
872
  */
1044
873
  public updateSubscription(param: DefaultApiUpdateSubscriptionRequest, options?: Configuration): Promise<void> {
1045
- return this.api.updateSubscription(param.appId, param.subscriptionId, param.updateSubscriptionRequestBody, options).toPromise();
874
+ return this.api.updateSubscription(param.appId, param.subscriptionId, param.subscriptionBody, options).toPromise();
1046
875
  }
1047
876
 
1048
877
  /**
1049
878
  * Updates an existing User’s properties.
1050
879
  * @param param the request object
1051
880
  */
1052
- public updateUser(param: DefaultApiUpdateUserRequest, options?: Configuration): Promise<InlineResponse202> {
881
+ public updateUser(param: DefaultApiUpdateUserRequest, options?: Configuration): Promise<PropertiesBody> {
1053
882
  return this.api.updateUser(param.appId, param.aliasLabel, param.aliasId, param.updateUserRequest, options).toPromise();
1054
883
  }
1055
884