@onesignal/node-onesignal 1.0.0-beta7 → 1.0.0-beta9

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 (208) hide show
  1. package/.github/workflows/Zapier.yml +29 -0
  2. package/.github/workflows/npm_deploy.yml +6 -7
  3. package/CHANGELOG.md +19 -0
  4. package/DefaultApi.md +1365 -164
  5. package/README.md +189 -0
  6. package/apis/DefaultApi.ts +2041 -423
  7. package/dist/apis/DefaultApi.d.ts +48 -0
  8. package/dist/apis/DefaultApi.js +1861 -414
  9. package/dist/apis/DefaultApi.js.map +1 -1
  10. package/dist/auth/auth.d.ts +6 -6
  11. package/dist/auth/auth.js +1 -1
  12. package/dist/http/http.d.ts +2 -2
  13. package/dist/http/http.js +1 -1
  14. package/dist/models/App.d.ts +5 -1
  15. package/dist/models/App.js +24 -0
  16. package/dist/models/App.js.map +1 -1
  17. package/dist/models/BadRequestError.d.ts +17 -0
  18. package/dist/models/BadRequestError.js +22 -0
  19. package/dist/models/BadRequestError.js.map +1 -0
  20. package/dist/models/BasicNotification.d.ts +5 -1
  21. package/dist/models/BasicNotification.js +12 -0
  22. package/dist/models/BasicNotification.js.map +1 -1
  23. package/dist/models/BasicNotificationAllOf.d.ts +1 -1
  24. package/dist/models/BeginLiveActivityRequest.d.ts +18 -0
  25. package/dist/models/BeginLiveActivityRequest.js +28 -0
  26. package/dist/models/BeginLiveActivityRequest.js.map +1 -0
  27. package/dist/models/CreateSubscriptionRequestBody.d.ts +19 -0
  28. package/dist/models/CreateSubscriptionRequestBody.js +28 -0
  29. package/dist/models/CreateSubscriptionRequestBody.js.map +1 -0
  30. package/dist/models/CreateUserConflictResponse.d.ts +18 -0
  31. package/dist/models/CreateUserConflictResponse.js +22 -0
  32. package/dist/models/CreateUserConflictResponse.js.map +1 -0
  33. package/dist/models/CreateUserConflictResponseErrorsInner.d.ts +20 -0
  34. package/dist/models/CreateUserConflictResponseErrorsInner.js +34 -0
  35. package/dist/models/CreateUserConflictResponseErrorsInner.js.map +1 -0
  36. package/dist/models/CreateUserConflictResponseErrorsItemsMeta.d.ts +17 -0
  37. package/dist/models/CreateUserConflictResponseErrorsItemsMeta.js +22 -0
  38. package/dist/models/CreateUserConflictResponseErrorsItemsMeta.js.map +1 -0
  39. package/dist/models/Filter.d.ts +1 -1
  40. package/dist/models/FilterExpressions.d.ts +2 -2
  41. package/dist/models/GetNotificationRequestBody.d.ts +1 -1
  42. package/dist/models/IdentifyUserConflictResponse.d.ts +18 -0
  43. package/dist/models/IdentifyUserConflictResponse.js +22 -0
  44. package/dist/models/IdentifyUserConflictResponse.js.map +1 -0
  45. package/dist/models/IdentifyUserConflictResponseErrorsInner.d.ts +18 -0
  46. package/dist/models/IdentifyUserConflictResponseErrorsInner.js +28 -0
  47. package/dist/models/IdentifyUserConflictResponseErrorsInner.js.map +1 -0
  48. package/dist/models/InlineResponse200.d.ts +19 -0
  49. package/dist/models/InlineResponse200.js +22 -0
  50. package/dist/models/InlineResponse200.js.map +1 -0
  51. package/dist/models/InlineResponse2003.d.ts +17 -0
  52. package/dist/models/InlineResponse2003.js +22 -0
  53. package/dist/models/InlineResponse2003.js.map +1 -0
  54. package/dist/models/InlineResponse201.d.ts +18 -0
  55. package/dist/models/InlineResponse201.js +22 -0
  56. package/dist/models/InlineResponse201.js.map +1 -0
  57. package/dist/models/InlineResponse202.d.ts +18 -0
  58. package/dist/models/InlineResponse202.js +22 -0
  59. package/dist/models/InlineResponse202.js.map +1 -0
  60. package/dist/models/Notification.d.ts +5 -1
  61. package/dist/models/Notification.js +12 -0
  62. package/dist/models/Notification.js.map +1 -1
  63. package/dist/models/NotificationTarget.d.ts +4 -0
  64. package/dist/models/NotificationTarget.js +12 -0
  65. package/dist/models/NotificationTarget.js.map +1 -1
  66. package/dist/models/NotificationWithMeta.d.ts +5 -1
  67. package/dist/models/NotificationWithMeta.js +12 -0
  68. package/dist/models/NotificationWithMeta.js.map +1 -1
  69. package/dist/models/ObjectSerializer.d.ts +25 -5
  70. package/dist/models/ObjectSerializer.js +83 -15
  71. package/dist/models/ObjectSerializer.js.map +1 -1
  72. package/dist/models/Operator.d.ts +1 -1
  73. package/dist/models/OutcomeData.d.ts +1 -1
  74. package/dist/models/Player.d.ts +1 -1
  75. package/dist/models/Player.js +1 -1
  76. package/dist/models/Player.js.map +1 -1
  77. package/dist/models/PlayerNotificationTarget.d.ts +4 -0
  78. package/dist/models/PlayerNotificationTarget.js +12 -0
  79. package/dist/models/PlayerNotificationTarget.js.map +1 -1
  80. package/dist/models/PlayerNotificationTargetIncludeAliases.d.ts +17 -0
  81. package/dist/models/PlayerNotificationTargetIncludeAliases.js +22 -0
  82. package/dist/models/PlayerNotificationTargetIncludeAliases.js.map +1 -0
  83. package/dist/models/PropertiesDeltas.d.ts +21 -0
  84. package/dist/models/PropertiesDeltas.js +40 -0
  85. package/dist/models/PropertiesDeltas.js.map +1 -0
  86. package/dist/models/PropertiesObject.d.ts +30 -0
  87. package/dist/models/PropertiesObject.js +82 -0
  88. package/dist/models/PropertiesObject.js.map +1 -0
  89. package/dist/models/Purchase.d.ts +1 -1
  90. package/dist/models/Purchase.js +1 -1
  91. package/dist/models/SubscriptionObject.d.ts +34 -0
  92. package/dist/models/SubscriptionObject.js +118 -0
  93. package/dist/models/SubscriptionObject.js.map +1 -0
  94. package/dist/models/TransferSubscriptionRequestBody.d.ts +19 -0
  95. package/dist/models/TransferSubscriptionRequestBody.js +22 -0
  96. package/dist/models/TransferSubscriptionRequestBody.js.map +1 -0
  97. package/dist/models/UpdateLiveActivityRequest.d.ts +22 -0
  98. package/dist/models/UpdateLiveActivityRequest.js +40 -0
  99. package/dist/models/UpdateLiveActivityRequest.js.map +1 -0
  100. package/dist/models/UpdateLiveActivitySuccessResponse.d.ts +19 -0
  101. package/dist/models/UpdateLiveActivitySuccessResponse.js +28 -0
  102. package/dist/models/UpdateLiveActivitySuccessResponse.js.map +1 -0
  103. package/dist/models/UpdateSubscriptionRequestBody.d.ts +18 -0
  104. package/dist/models/UpdateSubscriptionRequestBody.js +22 -0
  105. package/dist/models/UpdateSubscriptionRequestBody.js.map +1 -0
  106. package/dist/models/UpdateUserRequest.d.ts +21 -0
  107. package/dist/models/UpdateUserRequest.js +34 -0
  108. package/dist/models/UpdateUserRequest.js.map +1 -0
  109. package/dist/models/User.d.ts +25 -0
  110. package/dist/models/User.js +40 -0
  111. package/dist/models/User.js.map +1 -0
  112. package/dist/models/UserIdentityRequestBody.d.ts +19 -0
  113. package/dist/models/UserIdentityRequestBody.js +22 -0
  114. package/dist/models/UserIdentityRequestBody.js.map +1 -0
  115. package/dist/models/UserIdentityResponse.d.ts +19 -0
  116. package/dist/models/UserIdentityResponse.js +22 -0
  117. package/dist/models/UserIdentityResponse.js.map +1 -0
  118. package/dist/models/UserSubscriptionOptions.d.ts +17 -0
  119. package/dist/models/UserSubscriptionOptions.js +22 -0
  120. package/dist/models/UserSubscriptionOptions.js.map +1 -0
  121. package/dist/models/all.d.ts +25 -5
  122. package/dist/models/all.js +25 -5
  123. package/dist/models/all.js.map +1 -1
  124. package/dist/types/ObjectParamAPI.d.ts +117 -0
  125. package/dist/types/ObjectParamAPI.js +51 -0
  126. package/dist/types/ObjectParamAPI.js.map +1 -1
  127. package/dist/types/ObservableAPI.d.ts +31 -0
  128. package/dist/types/ObservableAPI.js +464 -56
  129. package/dist/types/ObservableAPI.js.map +1 -1
  130. package/dist/types/PromiseAPI.d.ts +31 -0
  131. package/dist/types/PromiseAPI.js +68 -0
  132. package/dist/types/PromiseAPI.js.map +1 -1
  133. package/models/App.ts +41 -1
  134. package/models/BadRequestError.ts +31 -0
  135. package/models/BasicNotification.ts +17 -1
  136. package/models/BasicNotificationAllOf.ts +1 -1
  137. package/models/BasicNotificationAllOfAndroidBackgroundLayout.ts +1 -1
  138. package/models/BeginLiveActivityRequest.ts +38 -0
  139. package/models/Button.ts +1 -1
  140. package/models/CancelNotificationSuccessResponse.ts +1 -1
  141. package/models/CreateNotificationSuccessResponse.ts +1 -1
  142. package/models/CreatePlayerSuccessResponse.ts +1 -1
  143. package/models/CreateSegmentConflictResponse.ts +1 -1
  144. package/models/CreateSegmentSuccessResponse.ts +1 -1
  145. package/models/CreateSubscriptionRequestBody.ts +39 -0
  146. package/models/CreateUserConflictResponse.ts +32 -0
  147. package/models/CreateUserConflictResponseErrorsInner.ts +46 -0
  148. package/models/CreateUserConflictResponseErrorsItemsMeta.ts +31 -0
  149. package/models/DeletePlayerNotFoundResponse.ts +1 -1
  150. package/models/DeletePlayerSuccessResponse.ts +1 -1
  151. package/models/DeleteSegmentNotFoundResponse.ts +1 -1
  152. package/models/DeleteSegmentSuccessResponse.ts +1 -1
  153. package/models/DeliveryData.ts +1 -1
  154. package/models/ExportPlayersRequestBody.ts +1 -1
  155. package/models/ExportPlayersSuccessResponse.ts +1 -1
  156. package/models/Filter.ts +1 -1
  157. package/models/FilterExpressions.ts +1 -1
  158. package/models/GetNotificationRequestBody.ts +1 -1
  159. package/models/IdentifyUserConflictResponse.ts +32 -0
  160. package/models/IdentifyUserConflictResponseErrorsInner.ts +38 -0
  161. package/models/InlineResponse200.ts +31 -0
  162. package/models/InlineResponse2003.ts +31 -0
  163. package/models/InlineResponse201.ts +32 -0
  164. package/models/InlineResponse202.ts +32 -0
  165. package/models/InvalidIdentifierError.ts +1 -1
  166. package/models/Notification.ts +17 -1
  167. package/models/Notification200Errors.ts +1 -1
  168. package/models/NotificationAllOf.ts +1 -1
  169. package/models/NotificationHistorySuccessResponse.ts +1 -1
  170. package/models/NotificationSlice.ts +1 -1
  171. package/models/NotificationTarget.ts +19 -1
  172. package/models/NotificationWithMeta.ts +17 -1
  173. package/models/NotificationWithMetaAllOf.ts +1 -1
  174. package/models/ObjectSerializer.ts +89 -21
  175. package/models/Operator.ts +1 -1
  176. package/models/OutcomeData.ts +1 -1
  177. package/models/OutcomesData.ts +1 -1
  178. package/models/PlatformDeliveryData.ts +1 -1
  179. package/models/PlatformDeliveryDataEmailAllOf.ts +1 -1
  180. package/models/PlatformDeliveryDataSmsAllOf.ts +1 -1
  181. package/models/Player.ts +3 -3
  182. package/models/PlayerNotificationTarget.ts +19 -1
  183. package/models/PlayerNotificationTargetIncludeAliases.ts +31 -0
  184. package/models/PlayerSlice.ts +1 -1
  185. package/models/PropertiesDeltas.ts +53 -0
  186. package/models/PropertiesObject.ts +102 -0
  187. package/models/Purchase.ts +3 -3
  188. package/models/Segment.ts +1 -1
  189. package/models/SegmentNotificationTarget.ts +1 -1
  190. package/models/StringMap.ts +1 -1
  191. package/models/SubscriptionObject.ts +146 -0
  192. package/models/TransferSubscriptionRequestBody.ts +31 -0
  193. package/models/UpdateLiveActivityRequest.ts +62 -0
  194. package/models/UpdateLiveActivitySuccessResponse.ts +39 -0
  195. package/models/UpdatePlayerSuccessResponse.ts +1 -1
  196. package/models/UpdatePlayerTagsRequestBody.ts +1 -1
  197. package/models/UpdatePlayerTagsSuccessResponse.ts +1 -1
  198. package/models/UpdateSubscriptionRequestBody.ts +32 -0
  199. package/models/UpdateUserRequest.ts +47 -0
  200. package/models/User.ts +55 -0
  201. package/models/UserIdentityRequestBody.ts +31 -0
  202. package/models/UserIdentityResponse.ts +31 -0
  203. package/models/UserSubscriptionOptions.ts +31 -0
  204. package/models/all.ts +25 -5
  205. package/package.json +3 -3
  206. package/types/ObjectParamAPI.ts +527 -5
  207. package/types/ObservableAPI.ts +454 -5
  208. package/types/PromiseAPI.ts +216 -5
@@ -3,21 +3,23 @@ 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';
6
7
  import { BasicNotification } from '../models/BasicNotification';
7
8
  import { BasicNotificationAllOf } from '../models/BasicNotificationAllOf';
8
9
  import { BasicNotificationAllOfAndroidBackgroundLayout } from '../models/BasicNotificationAllOfAndroidBackgroundLayout';
10
+ import { BeginLiveActivityRequest } from '../models/BeginLiveActivityRequest';
9
11
  import { Button } from '../models/Button';
10
12
  import { CancelNotificationSuccessResponse } from '../models/CancelNotificationSuccessResponse';
11
- import { CreateNotificationBadRequestResponse } from '../models/CreateNotificationBadRequestResponse';
12
13
  import { CreateNotificationSuccessResponse } from '../models/CreateNotificationSuccessResponse';
13
14
  import { CreatePlayerSuccessResponse } from '../models/CreatePlayerSuccessResponse';
14
- import { CreateSegmentBadRequestResponse } from '../models/CreateSegmentBadRequestResponse';
15
15
  import { CreateSegmentConflictResponse } from '../models/CreateSegmentConflictResponse';
16
16
  import { CreateSegmentSuccessResponse } from '../models/CreateSegmentSuccessResponse';
17
- import { DeletePlayerBadRequestResponse } from '../models/DeletePlayerBadRequestResponse';
17
+ import { CreateSubscriptionRequestBody } from '../models/CreateSubscriptionRequestBody';
18
+ import { CreateUserConflictResponse } from '../models/CreateUserConflictResponse';
19
+ import { CreateUserConflictResponseErrorsInner } from '../models/CreateUserConflictResponseErrorsInner';
20
+ import { CreateUserConflictResponseErrorsItemsMeta } from '../models/CreateUserConflictResponseErrorsItemsMeta';
18
21
  import { DeletePlayerNotFoundResponse } from '../models/DeletePlayerNotFoundResponse';
19
22
  import { DeletePlayerSuccessResponse } from '../models/DeletePlayerSuccessResponse';
20
- import { DeleteSegmentBadRequestResponse } from '../models/DeleteSegmentBadRequestResponse';
21
23
  import { DeleteSegmentNotFoundResponse } from '../models/DeleteSegmentNotFoundResponse';
22
24
  import { DeleteSegmentSuccessResponse } from '../models/DeleteSegmentSuccessResponse';
23
25
  import { DeliveryData } from '../models/DeliveryData';
@@ -26,11 +28,16 @@ import { ExportPlayersSuccessResponse } from '../models/ExportPlayersSuccessResp
26
28
  import { Filter } from '../models/Filter';
27
29
  import { FilterExpressions } from '../models/FilterExpressions';
28
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';
29
37
  import { InvalidIdentifierError } from '../models/InvalidIdentifierError';
30
38
  import { Notification } from '../models/Notification';
31
39
  import { Notification200Errors } from '../models/Notification200Errors';
32
40
  import { NotificationAllOf } from '../models/NotificationAllOf';
33
- import { NotificationHistoryBadRequestResponse } from '../models/NotificationHistoryBadRequestResponse';
34
41
  import { NotificationHistorySuccessResponse } from '../models/NotificationHistorySuccessResponse';
35
42
  import { NotificationSlice } from '../models/NotificationSlice';
36
43
  import { NotificationTarget } from '../models/NotificationTarget';
@@ -44,18 +51,52 @@ import { PlatformDeliveryDataEmailAllOf } from '../models/PlatformDeliveryDataEm
44
51
  import { PlatformDeliveryDataSmsAllOf } from '../models/PlatformDeliveryDataSmsAllOf';
45
52
  import { Player } from '../models/Player';
46
53
  import { PlayerNotificationTarget } from '../models/PlayerNotificationTarget';
54
+ import { PlayerNotificationTargetIncludeAliases } from '../models/PlayerNotificationTargetIncludeAliases';
47
55
  import { PlayerSlice } from '../models/PlayerSlice';
56
+ import { PropertiesDeltas } from '../models/PropertiesDeltas';
57
+ import { PropertiesObject } from '../models/PropertiesObject';
48
58
  import { Purchase } from '../models/Purchase';
49
59
  import { Segment } from '../models/Segment';
50
60
  import { SegmentNotificationTarget } from '../models/SegmentNotificationTarget';
51
61
  import { StringMap } from '../models/StringMap';
62
+ import { SubscriptionObject } from '../models/SubscriptionObject';
63
+ import { TransferSubscriptionRequestBody } from '../models/TransferSubscriptionRequestBody';
64
+ import { UpdateLiveActivityRequest } from '../models/UpdateLiveActivityRequest';
65
+ import { UpdateLiveActivitySuccessResponse } from '../models/UpdateLiveActivitySuccessResponse';
52
66
  import { UpdatePlayerSuccessResponse } from '../models/UpdatePlayerSuccessResponse';
53
67
  import { UpdatePlayerTagsRequestBody } from '../models/UpdatePlayerTagsRequestBody';
54
68
  import { UpdatePlayerTagsSuccessResponse } from '../models/UpdatePlayerTagsSuccessResponse';
69
+ import { UpdateSubscriptionRequestBody } from '../models/UpdateSubscriptionRequestBody';
70
+ import { UpdateUserRequest } from '../models/UpdateUserRequest';
71
+ import { User } from '../models/User';
72
+ import { UserIdentityRequestBody } from '../models/UserIdentityRequestBody';
73
+ import { UserIdentityResponse } from '../models/UserIdentityResponse';
74
+ import { UserSubscriptionOptions } from '../models/UserSubscriptionOptions';
55
75
 
56
76
  import { ObservableDefaultApi } from "./ObservableAPI";
57
77
  import { DefaultApiRequestFactory, DefaultApiResponseProcessor} from "../apis/DefaultApi";
58
78
 
79
+ export interface DefaultApiBeginLiveActivityRequest {
80
+ /**
81
+ * The OneSignal App ID for your app. Available in Keys & IDs.
82
+ * @type string
83
+ * @memberof DefaultApibeginLiveActivity
84
+ */
85
+ appId: string
86
+ /**
87
+ * Live Activity record ID
88
+ * @type string
89
+ * @memberof DefaultApibeginLiveActivity
90
+ */
91
+ activityId: string
92
+ /**
93
+ *
94
+ * @type BeginLiveActivityRequest
95
+ * @memberof DefaultApibeginLiveActivity
96
+ */
97
+ beginLiveActivityRequest: BeginLiveActivityRequest
98
+ }
99
+
59
100
  export interface DefaultApiCancelNotificationRequest {
60
101
  /**
61
102
  *
@@ -113,6 +154,75 @@ export interface DefaultApiCreateSegmentsRequest {
113
154
  segment?: Segment
114
155
  }
115
156
 
157
+ export interface DefaultApiCreateSubscriptionRequest {
158
+ /**
159
+ *
160
+ * @type string
161
+ * @memberof DefaultApicreateSubscription
162
+ */
163
+ appId: string
164
+ /**
165
+ *
166
+ * @type string
167
+ * @memberof DefaultApicreateSubscription
168
+ */
169
+ aliasLabel: string
170
+ /**
171
+ *
172
+ * @type string
173
+ * @memberof DefaultApicreateSubscription
174
+ */
175
+ aliasId: string
176
+ /**
177
+ *
178
+ * @type CreateSubscriptionRequestBody
179
+ * @memberof DefaultApicreateSubscription
180
+ */
181
+ createSubscriptionRequestBody: CreateSubscriptionRequestBody
182
+ }
183
+
184
+ export interface DefaultApiCreateUserRequest {
185
+ /**
186
+ *
187
+ * @type string
188
+ * @memberof DefaultApicreateUser
189
+ */
190
+ appId: string
191
+ /**
192
+ *
193
+ * @type User
194
+ * @memberof DefaultApicreateUser
195
+ */
196
+ user: User
197
+ }
198
+
199
+ export interface DefaultApiDeleteAliasRequest {
200
+ /**
201
+ *
202
+ * @type string
203
+ * @memberof DefaultApideleteAlias
204
+ */
205
+ appId: string
206
+ /**
207
+ *
208
+ * @type string
209
+ * @memberof DefaultApideleteAlias
210
+ */
211
+ aliasLabel: string
212
+ /**
213
+ *
214
+ * @type string
215
+ * @memberof DefaultApideleteAlias
216
+ */
217
+ aliasId: string
218
+ /**
219
+ *
220
+ * @type string
221
+ * @memberof DefaultApideleteAlias
222
+ */
223
+ aliasLabelToDelete: string
224
+ }
225
+
116
226
  export interface DefaultApiDeletePlayerRequest {
117
227
  /**
118
228
  * The OneSignal App ID for your app. Available in Keys & IDs.
@@ -143,6 +253,63 @@ export interface DefaultApiDeleteSegmentsRequest {
143
253
  segmentId: string
144
254
  }
145
255
 
256
+ export interface DefaultApiDeleteSubscriptionRequest {
257
+ /**
258
+ *
259
+ * @type string
260
+ * @memberof DefaultApideleteSubscription
261
+ */
262
+ appId: string
263
+ /**
264
+ *
265
+ * @type string
266
+ * @memberof DefaultApideleteSubscription
267
+ */
268
+ subscriptionId: string
269
+ }
270
+
271
+ export interface DefaultApiDeleteUserRequest {
272
+ /**
273
+ *
274
+ * @type string
275
+ * @memberof DefaultApideleteUser
276
+ */
277
+ appId: string
278
+ /**
279
+ *
280
+ * @type string
281
+ * @memberof DefaultApideleteUser
282
+ */
283
+ aliasLabel: string
284
+ /**
285
+ *
286
+ * @type string
287
+ * @memberof DefaultApideleteUser
288
+ */
289
+ aliasId: string
290
+ }
291
+
292
+ export interface DefaultApiEndLiveActivityRequest {
293
+ /**
294
+ * The OneSignal App ID for your app. Available in Keys & IDs.
295
+ * @type string
296
+ * @memberof DefaultApiendLiveActivity
297
+ */
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
+
146
313
  export interface DefaultApiExportPlayersRequest {
147
314
  /**
148
315
  * The app ID that you want to export devices from
@@ -158,6 +325,63 @@ export interface DefaultApiExportPlayersRequest {
158
325
  exportPlayersRequestBody?: ExportPlayersRequestBody
159
326
  }
160
327
 
328
+ export interface DefaultApiFetchAliasesRequest {
329
+ /**
330
+ *
331
+ * @type string
332
+ * @memberof DefaultApifetchAliases
333
+ */
334
+ appId: string
335
+ /**
336
+ *
337
+ * @type string
338
+ * @memberof DefaultApifetchAliases
339
+ */
340
+ subscriptionId: string
341
+ }
342
+
343
+ export interface DefaultApiFetchUserRequest {
344
+ /**
345
+ *
346
+ * @type string
347
+ * @memberof DefaultApifetchUser
348
+ */
349
+ appId: string
350
+ /**
351
+ *
352
+ * @type string
353
+ * @memberof DefaultApifetchUser
354
+ */
355
+ aliasLabel: string
356
+ /**
357
+ *
358
+ * @type string
359
+ * @memberof DefaultApifetchUser
360
+ */
361
+ aliasId: string
362
+ }
363
+
364
+ export interface DefaultApiFetchUserIdentityRequest {
365
+ /**
366
+ *
367
+ * @type string
368
+ * @memberof DefaultApifetchUserIdentity
369
+ */
370
+ appId: string
371
+ /**
372
+ *
373
+ * @type string
374
+ * @memberof DefaultApifetchUserIdentity
375
+ */
376
+ aliasLabel: string
377
+ /**
378
+ *
379
+ * @type string
380
+ * @memberof DefaultApifetchUserIdentity
381
+ */
382
+ aliasId: string
383
+ }
384
+
161
385
  export interface DefaultApiGetAppRequest {
162
386
  /**
163
387
  * An app id
@@ -170,6 +394,21 @@ export interface DefaultApiGetAppRequest {
170
394
  export interface DefaultApiGetAppsRequest {
171
395
  }
172
396
 
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
+
173
412
  export interface DefaultApiGetNotificationRequest {
174
413
  /**
175
414
  *
@@ -308,6 +547,75 @@ export interface DefaultApiGetPlayersRequest {
308
547
  offset?: number
309
548
  }
310
549
 
550
+ export interface DefaultApiIdentifyUserByAliasRequest {
551
+ /**
552
+ *
553
+ * @type string
554
+ * @memberof DefaultApiidentifyUserByAlias
555
+ */
556
+ appId: string
557
+ /**
558
+ *
559
+ * @type string
560
+ * @memberof DefaultApiidentifyUserByAlias
561
+ */
562
+ aliasLabel: string
563
+ /**
564
+ *
565
+ * @type string
566
+ * @memberof DefaultApiidentifyUserByAlias
567
+ */
568
+ aliasId: string
569
+ /**
570
+ *
571
+ * @type UserIdentityRequestBody
572
+ * @memberof DefaultApiidentifyUserByAlias
573
+ */
574
+ userIdentityRequestBody: UserIdentityRequestBody
575
+ }
576
+
577
+ export interface DefaultApiIdentifyUserBySubscriptionIdRequest {
578
+ /**
579
+ *
580
+ * @type string
581
+ * @memberof DefaultApiidentifyUserBySubscriptionId
582
+ */
583
+ appId: string
584
+ /**
585
+ *
586
+ * @type string
587
+ * @memberof DefaultApiidentifyUserBySubscriptionId
588
+ */
589
+ subscriptionId: string
590
+ /**
591
+ *
592
+ * @type UserIdentityRequestBody
593
+ * @memberof DefaultApiidentifyUserBySubscriptionId
594
+ */
595
+ userIdentityRequestBody: UserIdentityRequestBody
596
+ }
597
+
598
+ export interface DefaultApiTransferSubscriptionRequest {
599
+ /**
600
+ *
601
+ * @type string
602
+ * @memberof DefaultApitransferSubscription
603
+ */
604
+ appId: string
605
+ /**
606
+ *
607
+ * @type string
608
+ * @memberof DefaultApitransferSubscription
609
+ */
610
+ subscriptionId: string
611
+ /**
612
+ *
613
+ * @type TransferSubscriptionRequestBody
614
+ * @memberof DefaultApitransferSubscription
615
+ */
616
+ transferSubscriptionRequestBody: TransferSubscriptionRequestBody
617
+ }
618
+
311
619
  export interface DefaultApiUpdateAppRequest {
312
620
  /**
313
621
  * An app id
@@ -323,6 +631,27 @@ export interface DefaultApiUpdateAppRequest {
323
631
  app: App
324
632
  }
325
633
 
634
+ export interface DefaultApiUpdateLiveActivityRequest {
635
+ /**
636
+ * The OneSignal App ID for your app. Available in Keys & IDs.
637
+ * @type string
638
+ * @memberof DefaultApiupdateLiveActivity
639
+ */
640
+ appId: string
641
+ /**
642
+ * Live Activity record ID
643
+ * @type string
644
+ * @memberof DefaultApiupdateLiveActivity
645
+ */
646
+ activityId: string
647
+ /**
648
+ *
649
+ * @type UpdateLiveActivityRequest
650
+ * @memberof DefaultApiupdateLiveActivity
651
+ */
652
+ updateLiveActivityRequest: UpdateLiveActivityRequest
653
+ }
654
+
326
655
  export interface DefaultApiUpdatePlayerRequest {
327
656
  /**
328
657
  * Player\'s OneSignal ID
@@ -359,6 +688,60 @@ export interface DefaultApiUpdatePlayerTagsRequest {
359
688
  updatePlayerTagsRequestBody?: UpdatePlayerTagsRequestBody
360
689
  }
361
690
 
691
+ export interface DefaultApiUpdateSubscriptionRequest {
692
+ /**
693
+ *
694
+ * @type string
695
+ * @memberof DefaultApiupdateSubscription
696
+ */
697
+ appId: string
698
+ /**
699
+ *
700
+ * @type string
701
+ * @memberof DefaultApiupdateSubscription
702
+ */
703
+ subscriptionId: string
704
+ /**
705
+ *
706
+ * @type UpdateSubscriptionRequestBody
707
+ * @memberof DefaultApiupdateSubscription
708
+ */
709
+ updateSubscriptionRequestBody: UpdateSubscriptionRequestBody
710
+ }
711
+
712
+ export interface DefaultApiUpdateUserRequest {
713
+ /**
714
+ *
715
+ * @type string
716
+ * @memberof DefaultApiupdateUser
717
+ */
718
+ appId: string
719
+ /**
720
+ *
721
+ * @type string
722
+ * @memberof DefaultApiupdateUser
723
+ */
724
+ aliasLabel: string
725
+ /**
726
+ *
727
+ * @type string
728
+ * @memberof DefaultApiupdateUser
729
+ */
730
+ aliasId: string
731
+ /**
732
+ *
733
+ * @type UpdateUserRequest
734
+ * @memberof DefaultApiupdateUser
735
+ */
736
+ updateUserRequest: UpdateUserRequest
737
+ /**
738
+ *
739
+ * @type string
740
+ * @memberof DefaultApiupdateUser
741
+ */
742
+ subscriptionId?: string
743
+ }
744
+
362
745
  export class ObjectDefaultApi {
363
746
  private api: ObservableDefaultApi
364
747
 
@@ -366,6 +749,15 @@ export class ObjectDefaultApi {
366
749
  this.api = new ObservableDefaultApi(configuration, requestFactory, responseProcessor);
367
750
  }
368
751
 
752
+ /**
753
+ * Starts a Live Activity
754
+ * Start Live Activity
755
+ * @param param the request object
756
+ */
757
+ public beginLiveActivity(param: DefaultApiBeginLiveActivityRequest, options?: Configuration): Promise<void> {
758
+ return this.api.beginLiveActivity(param.appId, param.activityId, param.beginLiveActivityRequest, options).toPromise();
759
+ }
760
+
369
761
  /**
370
762
  * Used to stop a scheduled or currently outgoing notification
371
763
  * Stop a scheduled or currently outgoing notification
@@ -411,6 +803,30 @@ export class ObjectDefaultApi {
411
803
  return this.api.createSegments(param.appId, param.segment, options).toPromise();
412
804
  }
413
805
 
806
+ /**
807
+ * Creates a new Subscription under the User provided. Useful to add email addresses and SMS numbers to the User.
808
+ * @param param the request object
809
+ */
810
+ public createSubscription(param: DefaultApiCreateSubscriptionRequest, options?: Configuration): Promise<InlineResponse201> {
811
+ return this.api.createSubscription(param.appId, param.aliasLabel, param.aliasId, param.createSubscriptionRequestBody, options).toPromise();
812
+ }
813
+
814
+ /**
815
+ * Creates a User, optionally Subscriptions owned by the User as well as Aliases. Aliases provided in the payload will be used to look up an existing User.
816
+ * @param param the request object
817
+ */
818
+ public createUser(param: DefaultApiCreateUserRequest, options?: Configuration): Promise<User> {
819
+ return this.api.createUser(param.appId, param.user, options).toPromise();
820
+ }
821
+
822
+ /**
823
+ * Deletes an alias by alias label
824
+ * @param param the request object
825
+ */
826
+ public deleteAlias(param: DefaultApiDeleteAliasRequest, options?: Configuration): Promise<InlineResponse200> {
827
+ return this.api.deleteAlias(param.appId, param.aliasLabel, param.aliasId, param.aliasLabelToDelete, options).toPromise();
828
+ }
829
+
414
830
  /**
415
831
  * Delete player - Required: Used to delete a single, specific Player ID record from a specific OneSignal app.
416
832
  * Delete a user record
@@ -429,6 +845,31 @@ export class ObjectDefaultApi {
429
845
  return this.api.deleteSegments(param.appId, param.segmentId, options).toPromise();
430
846
  }
431
847
 
848
+ /**
849
+ * Deletes the Subscription.
850
+ * @param param the request object
851
+ */
852
+ public deleteSubscription(param: DefaultApiDeleteSubscriptionRequest, options?: Configuration): Promise<void> {
853
+ return this.api.deleteSubscription(param.appId, param.subscriptionId, options).toPromise();
854
+ }
855
+
856
+ /**
857
+ * Removes the User identified by (:alias_label, :alias_id), and all Subscriptions and Aliases
858
+ * @param param the request object
859
+ */
860
+ public deleteUser(param: DefaultApiDeleteUserRequest, options?: Configuration): Promise<void> {
861
+ return this.api.deleteUser(param.appId, param.aliasLabel, param.aliasId, options).toPromise();
862
+ }
863
+
864
+ /**
865
+ * Stops a Live Activity
866
+ * Stop Live Activity
867
+ * @param param the request object
868
+ */
869
+ public endLiveActivity(param: DefaultApiEndLiveActivityRequest, options?: Configuration): Promise<void> {
870
+ return this.api.endLiveActivity(param.appId, param.activityId, param.subscriptionId, options).toPromise();
871
+ }
872
+
432
873
  /**
433
874
  * 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. |
434
875
  * CSV export
@@ -438,6 +879,30 @@ export class ObjectDefaultApi {
438
879
  return this.api.exportPlayers(param.appId, param.exportPlayersRequestBody, options).toPromise();
439
880
  }
440
881
 
882
+ /**
883
+ * Lists all Aliases for the User identified by :subscription_id.
884
+ * @param param the request object
885
+ */
886
+ public fetchAliases(param: DefaultApiFetchAliasesRequest, options?: Configuration): Promise<UserIdentityResponse> {
887
+ return this.api.fetchAliases(param.appId, param.subscriptionId, options).toPromise();
888
+ }
889
+
890
+ /**
891
+ * Returns the User’s properties, Aliases, and Subscriptions.
892
+ * @param param the request object
893
+ */
894
+ public fetchUser(param: DefaultApiFetchUserRequest, options?: Configuration): Promise<User> {
895
+ return this.api.fetchUser(param.appId, param.aliasLabel, param.aliasId, options).toPromise();
896
+ }
897
+
898
+ /**
899
+ * Lists all Aliases for the User identified by (:alias_label, :alias_id).
900
+ * @param param the request object
901
+ */
902
+ public fetchUserIdentity(param: DefaultApiFetchUserIdentityRequest, options?: Configuration): Promise<InlineResponse200> {
903
+ return this.api.fetchUserIdentity(param.appId, param.aliasLabel, param.aliasId, options).toPromise();
904
+ }
905
+
441
906
  /**
442
907
  * View the details of a single OneSignal app
443
908
  * View an app
@@ -456,6 +921,14 @@ export class ObjectDefaultApi {
456
921
  return this.api.getApps( options).toPromise();
457
922
  }
458
923
 
924
+ /**
925
+ * Manifest of In-App Messages the Subscription is eligible to display by the SDK.
926
+ * @param param the request object
927
+ */
928
+ public getEligibleIams(param: DefaultApiGetEligibleIamsRequest, options?: Configuration): Promise<InlineResponse2003> {
929
+ return this.api.getEligibleIams(param.appId, param.subscriptionId, options).toPromise();
930
+ }
931
+
459
932
  /**
460
933
  * View the details of a single notification and outcomes associated with it
461
934
  * View notification
@@ -510,6 +983,30 @@ export class ObjectDefaultApi {
510
983
  return this.api.getPlayers(param.appId, param.limit, param.offset, options).toPromise();
511
984
  }
512
985
 
986
+ /**
987
+ * Upserts one or more Aliases to an existing User identified by (:alias_label, :alias_id).
988
+ * @param param the request object
989
+ */
990
+ public identifyUserByAlias(param: DefaultApiIdentifyUserByAliasRequest, options?: Configuration): Promise<InlineResponse200> {
991
+ return this.api.identifyUserByAlias(param.appId, param.aliasLabel, param.aliasId, param.userIdentityRequestBody, options).toPromise();
992
+ }
993
+
994
+ /**
995
+ * Upserts one or more Aliases for the User identified by :subscription_id.
996
+ * @param param the request object
997
+ */
998
+ public identifyUserBySubscriptionId(param: DefaultApiIdentifyUserBySubscriptionIdRequest, options?: Configuration): Promise<UserIdentityResponse> {
999
+ return this.api.identifyUserBySubscriptionId(param.appId, param.subscriptionId, param.userIdentityRequestBody, options).toPromise();
1000
+ }
1001
+
1002
+ /**
1003
+ * Transfers this Subscription to the User identified by the identity in the payload.
1004
+ * @param param the request object
1005
+ */
1006
+ public transferSubscription(param: DefaultApiTransferSubscriptionRequest, options?: Configuration): Promise<UserIdentityResponse> {
1007
+ return this.api.transferSubscription(param.appId, param.subscriptionId, param.transferSubscriptionRequestBody, options).toPromise();
1008
+ }
1009
+
513
1010
  /**
514
1011
  * Updates the name or configuration settings of an existing OneSignal app
515
1012
  * Update an app
@@ -519,6 +1016,15 @@ export class ObjectDefaultApi {
519
1016
  return this.api.updateApp(param.appId, param.app, options).toPromise();
520
1017
  }
521
1018
 
1019
+ /**
1020
+ * Updates a specified live activity.
1021
+ * Update a Live Activity via Push
1022
+ * @param param the request object
1023
+ */
1024
+ public updateLiveActivity(param: DefaultApiUpdateLiveActivityRequest, options?: Configuration): Promise<UpdateLiveActivitySuccessResponse> {
1025
+ return this.api.updateLiveActivity(param.appId, param.activityId, param.updateLiveActivityRequest, options).toPromise();
1026
+ }
1027
+
522
1028
  /**
523
1029
  * Update an existing device in one of your OneSignal apps
524
1030
  * Edit device
@@ -537,4 +1043,20 @@ export class ObjectDefaultApi {
537
1043
  return this.api.updatePlayerTags(param.appId, param.externalUserId, param.updatePlayerTagsRequestBody, options).toPromise();
538
1044
  }
539
1045
 
1046
+ /**
1047
+ * Updates an existing Subscription’s properties.
1048
+ * @param param the request object
1049
+ */
1050
+ public updateSubscription(param: DefaultApiUpdateSubscriptionRequest, options?: Configuration): Promise<void> {
1051
+ return this.api.updateSubscription(param.appId, param.subscriptionId, param.updateSubscriptionRequestBody, options).toPromise();
1052
+ }
1053
+
1054
+ /**
1055
+ * Updates an existing User’s properties.
1056
+ * @param param the request object
1057
+ */
1058
+ public updateUser(param: DefaultApiUpdateUserRequest, options?: Configuration): Promise<InlineResponse202> {
1059
+ return this.api.updateUser(param.appId, param.aliasLabel, param.aliasId, param.updateUserRequest, param.subscriptionId, options).toPromise();
1060
+ }
1061
+
540
1062
  }