@onesignal/node-onesignal 5.3.0-beta1 → 5.4.0-beta1

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 (194) hide show
  1. package/dist/apis/DefaultApi.js +44 -44
  2. package/dist/index.d.ts +1 -1
  3. package/dist/models/BasicNotification.d.ts +7 -0
  4. package/dist/models/BasicNotification.js +36 -0
  5. package/dist/models/BasicNotificationAllOf.d.ts +7 -0
  6. package/dist/models/BasicNotificationAllOf.js +36 -0
  7. package/dist/models/Notification.d.ts +7 -0
  8. package/dist/models/Notification.js +36 -0
  9. package/dist/models/NotificationWithMeta.d.ts +7 -0
  10. package/dist/models/NotificationWithMeta.js +36 -0
  11. package/dist/models/ObjectSerializer.js +4 -0
  12. package/package.json +9 -3
  13. package/.github/ISSUE_TEMPLATE/ask-question.yml +0 -25
  14. package/.github/ISSUE_TEMPLATE/bug-report.yml +0 -51
  15. package/.github/ISSUE_TEMPLATE/general-feedback.yml +0 -25
  16. package/.github/pull_request_template.md +0 -44
  17. package/.github/workflows/asana-add-comment.yml +0 -47
  18. package/.github/workflows/asana-create-task.yml +0 -119
  19. package/.github/workflows/asana-update-issue.yml +0 -172
  20. package/.github/workflows/npm_deploy.yml +0 -22
  21. package/.github/workflows/project.yml +0 -17
  22. package/CHANGELOG.md +0 -48
  23. package/DefaultApi.md +0 -3293
  24. package/RELEASE_INSTRUCTIONS.md +0 -2
  25. package/apis/DefaultApi.ts +0 -4673
  26. package/apis/baseapi.ts +0 -37
  27. package/apis/exception.ts +0 -15
  28. package/auth/auth.ts +0 -110
  29. package/configuration.ts +0 -85
  30. package/dist/apis/DefaultApi.js.map +0 -1
  31. package/dist/apis/baseapi.js.map +0 -1
  32. package/dist/apis/exception.js.map +0 -1
  33. package/dist/auth/auth.js.map +0 -1
  34. package/dist/configuration.js.map +0 -1
  35. package/dist/http/http.js.map +0 -1
  36. package/dist/http/isomorphic-fetch.js.map +0 -1
  37. package/dist/index.js.map +0 -1
  38. package/dist/middleware.js.map +0 -1
  39. package/dist/models/ApiKeyToken.js.map +0 -1
  40. package/dist/models/ApiKeyTokensListResponse.js.map +0 -1
  41. package/dist/models/App.js.map +0 -1
  42. package/dist/models/BasicNotification.js.map +0 -1
  43. package/dist/models/BasicNotificationAllOf.js.map +0 -1
  44. package/dist/models/BasicNotificationAllOfAndroidBackgroundLayout.js.map +0 -1
  45. package/dist/models/Button.js.map +0 -1
  46. package/dist/models/CopyTemplateRequest.js.map +0 -1
  47. package/dist/models/CreateApiKeyRequest.js.map +0 -1
  48. package/dist/models/CreateApiKeyResponse.js.map +0 -1
  49. package/dist/models/CreateNotificationSuccessResponse.js.map +0 -1
  50. package/dist/models/CreateSegmentConflictResponse.js.map +0 -1
  51. package/dist/models/CreateSegmentSuccessResponse.js.map +0 -1
  52. package/dist/models/CreateTemplateRequest.js.map +0 -1
  53. package/dist/models/CreateUserConflictResponse.js.map +0 -1
  54. package/dist/models/CreateUserConflictResponseErrorsInner.js.map +0 -1
  55. package/dist/models/CreateUserConflictResponseErrorsItemsMeta.js.map +0 -1
  56. package/dist/models/CustomEvent.js.map +0 -1
  57. package/dist/models/CustomEventsRequest.js.map +0 -1
  58. package/dist/models/DeliveryData.js.map +0 -1
  59. package/dist/models/ExportEventsSuccessResponse.js.map +0 -1
  60. package/dist/models/ExportSubscriptionsRequestBody.js.map +0 -1
  61. package/dist/models/ExportSubscriptionsSuccessResponse.js.map +0 -1
  62. package/dist/models/Filter.js.map +0 -1
  63. package/dist/models/FilterExpression.js.map +0 -1
  64. package/dist/models/GenericError.js.map +0 -1
  65. package/dist/models/GenericSuccessBoolResponse.js.map +0 -1
  66. package/dist/models/GetNotificationHistoryRequestBody.js.map +0 -1
  67. package/dist/models/GetSegmentsSuccessResponse.js.map +0 -1
  68. package/dist/models/LanguageStringMap.js.map +0 -1
  69. package/dist/models/Notification.js.map +0 -1
  70. package/dist/models/NotificationAllOf.js.map +0 -1
  71. package/dist/models/NotificationHistorySuccessResponse.js.map +0 -1
  72. package/dist/models/NotificationSlice.js.map +0 -1
  73. package/dist/models/NotificationTarget.js.map +0 -1
  74. package/dist/models/NotificationWithMeta.js.map +0 -1
  75. package/dist/models/NotificationWithMetaAllOf.js.map +0 -1
  76. package/dist/models/ObjectSerializer.js.map +0 -1
  77. package/dist/models/Operator.js.map +0 -1
  78. package/dist/models/OutcomeData.js.map +0 -1
  79. package/dist/models/OutcomesData.js.map +0 -1
  80. package/dist/models/PlatformDeliveryData.js.map +0 -1
  81. package/dist/models/PlatformDeliveryDataEmailAllOf.js.map +0 -1
  82. package/dist/models/PlatformDeliveryDataSmsAllOf.js.map +0 -1
  83. package/dist/models/PropertiesBody.js.map +0 -1
  84. package/dist/models/PropertiesDeltas.js.map +0 -1
  85. package/dist/models/PropertiesObject.js.map +0 -1
  86. package/dist/models/Purchase.js.map +0 -1
  87. package/dist/models/RateLimitError.js.map +0 -1
  88. package/dist/models/Segment.js.map +0 -1
  89. package/dist/models/SegmentData.js.map +0 -1
  90. package/dist/models/SegmentNotificationTarget.js.map +0 -1
  91. package/dist/models/StartLiveActivityRequest.js.map +0 -1
  92. package/dist/models/StartLiveActivitySuccessResponse.js.map +0 -1
  93. package/dist/models/Subscription.js.map +0 -1
  94. package/dist/models/SubscriptionBody.js.map +0 -1
  95. package/dist/models/SubscriptionNotificationTarget.js.map +0 -1
  96. package/dist/models/TemplateResource.js.map +0 -1
  97. package/dist/models/TemplatesListResponse.js.map +0 -1
  98. package/dist/models/TransferSubscriptionRequestBody.js.map +0 -1
  99. package/dist/models/UpdateApiKeyRequest.js.map +0 -1
  100. package/dist/models/UpdateLiveActivityRequest.js.map +0 -1
  101. package/dist/models/UpdateLiveActivitySuccessResponse.js.map +0 -1
  102. package/dist/models/UpdateTemplateRequest.js.map +0 -1
  103. package/dist/models/UpdateUserRequest.js.map +0 -1
  104. package/dist/models/User.js.map +0 -1
  105. package/dist/models/UserIdentityBody.js.map +0 -1
  106. package/dist/models/WebButton.js.map +0 -1
  107. package/dist/models/all.js.map +0 -1
  108. package/dist/rxjsStub.js.map +0 -1
  109. package/dist/servers.js.map +0 -1
  110. package/dist/types/ObjectParamAPI.js.map +0 -1
  111. package/dist/types/ObservableAPI.js.map +0 -1
  112. package/dist/types/PromiseAPI.js.map +0 -1
  113. package/dist/util.js.map +0 -1
  114. package/http/http.ts +0 -205
  115. package/http/isomorphic-fetch.ts +0 -30
  116. package/index.ts +0 -12
  117. package/middleware.ts +0 -66
  118. package/models/ApiKeyToken.ts +0 -69
  119. package/models/ApiKeyTokensListResponse.ts +0 -32
  120. package/models/App.ts +0 -328
  121. package/models/BasicNotification.ts +0 -1088
  122. package/models/BasicNotificationAllOf.ts +0 -958
  123. package/models/BasicNotificationAllOfAndroidBackgroundLayout.ts +0 -57
  124. package/models/Button.ts +0 -45
  125. package/models/CopyTemplateRequest.ts +0 -34
  126. package/models/CreateApiKeyRequest.ts +0 -48
  127. package/models/CreateApiKeyResponse.ts +0 -38
  128. package/models/CreateNotificationSuccessResponse.ts +0 -48
  129. package/models/CreateSegmentConflictResponse.ts +0 -38
  130. package/models/CreateSegmentSuccessResponse.ts +0 -41
  131. package/models/CreateTemplateRequest.ts +0 -102
  132. package/models/CreateUserConflictResponse.ts +0 -32
  133. package/models/CreateUserConflictResponseErrorsInner.ts +0 -46
  134. package/models/CreateUserConflictResponseErrorsItemsMeta.ts +0 -31
  135. package/models/CustomEvent.ts +0 -74
  136. package/models/CustomEventsRequest.ts +0 -32
  137. package/models/DeliveryData.ts +0 -74
  138. package/models/ExportEventsSuccessResponse.ts +0 -31
  139. package/models/ExportSubscriptionsRequestBody.ts +0 -54
  140. package/models/ExportSubscriptionsSuccessResponse.ts +0 -31
  141. package/models/Filter.ts +0 -107
  142. package/models/FilterExpression.ts +0 -120
  143. package/models/GenericError.ts +0 -45
  144. package/models/GenericSuccessBoolResponse.ts +0 -31
  145. package/models/GetNotificationHistoryRequestBody.ts +0 -54
  146. package/models/GetSegmentsSuccessResponse.ts +0 -65
  147. package/models/LanguageStringMap.ts +0 -454
  148. package/models/Notification.ts +0 -1098
  149. package/models/NotificationAllOf.ts +0 -34
  150. package/models/NotificationHistorySuccessResponse.ts +0 -38
  151. package/models/NotificationSlice.ts +0 -53
  152. package/models/NotificationTarget.ts +0 -156
  153. package/models/NotificationWithMeta.ts +0 -1206
  154. package/models/NotificationWithMetaAllOf.ts +0 -142
  155. package/models/ObjectSerializer.ts +0 -442
  156. package/models/Operator.ts +0 -37
  157. package/models/OutcomeData.ts +0 -48
  158. package/models/OutcomesData.ts +0 -32
  159. package/models/PlatformDeliveryData.ts +0 -86
  160. package/models/PlatformDeliveryDataEmailAllOf.ts +0 -94
  161. package/models/PlatformDeliveryDataSmsAllOf.ts +0 -54
  162. package/models/PropertiesBody.ts +0 -32
  163. package/models/PropertiesDeltas.ts +0 -46
  164. package/models/PropertiesObject.ts +0 -102
  165. package/models/Purchase.ts +0 -61
  166. package/models/RateLimitError.ts +0 -38
  167. package/models/Segment.ts +0 -55
  168. package/models/SegmentData.ts +0 -94
  169. package/models/SegmentNotificationTarget.ts +0 -44
  170. package/models/StartLiveActivityRequest.ts +0 -177
  171. package/models/StartLiveActivitySuccessResponse.ts +0 -31
  172. package/models/Subscription.ts +0 -146
  173. package/models/SubscriptionBody.ts +0 -32
  174. package/models/SubscriptionNotificationTarget.ts +0 -134
  175. package/models/TemplateResource.ts +0 -72
  176. package/models/TemplatesListResponse.ts +0 -32
  177. package/models/TransferSubscriptionRequestBody.ts +0 -31
  178. package/models/UpdateApiKeyRequest.ts +0 -48
  179. package/models/UpdateLiveActivityRequest.ts +0 -109
  180. package/models/UpdateLiveActivitySuccessResponse.ts +0 -31
  181. package/models/UpdateTemplateRequest.ts +0 -92
  182. package/models/UpdateUserRequest.ts +0 -47
  183. package/models/User.ts +0 -47
  184. package/models/UserIdentityBody.ts +0 -31
  185. package/models/WebButton.ts +0 -52
  186. package/models/all.ts +0 -67
  187. package/onesignal-node-onesignal-5.3.0-beta1.tgz +0 -0
  188. package/rxjsStub.ts +0 -27
  189. package/servers.ts +0 -53
  190. package/tsconfig.json +0 -28
  191. package/types/ObjectParamAPI.ts +0 -1270
  192. package/types/ObservableAPI.ts +0 -1201
  193. package/types/PromiseAPI.ts +0 -585
  194. package/util.ts +0 -37
@@ -1,1270 +0,0 @@
1
- import { ResponseContext, RequestContext, HttpFile } from '../http/http';
2
- import * as models from '../models/all';
3
- import { Configuration} from '../configuration'
4
-
5
- import { ApiKeyToken } from '../models/ApiKeyToken';
6
- import { ApiKeyTokensListResponse } from '../models/ApiKeyTokensListResponse';
7
- import { App } from '../models/App';
8
- import { BasicNotification } from '../models/BasicNotification';
9
- import { BasicNotificationAllOf } from '../models/BasicNotificationAllOf';
10
- import { BasicNotificationAllOfAndroidBackgroundLayout } from '../models/BasicNotificationAllOfAndroidBackgroundLayout';
11
- import { Button } from '../models/Button';
12
- import { CopyTemplateRequest } from '../models/CopyTemplateRequest';
13
- import { CreateApiKeyRequest } from '../models/CreateApiKeyRequest';
14
- import { CreateApiKeyResponse } from '../models/CreateApiKeyResponse';
15
- import { CreateNotificationSuccessResponse } from '../models/CreateNotificationSuccessResponse';
16
- import { CreateSegmentConflictResponse } from '../models/CreateSegmentConflictResponse';
17
- import { CreateSegmentSuccessResponse } from '../models/CreateSegmentSuccessResponse';
18
- import { CreateTemplateRequest } from '../models/CreateTemplateRequest';
19
- import { CreateUserConflictResponse } from '../models/CreateUserConflictResponse';
20
- import { CreateUserConflictResponseErrorsInner } from '../models/CreateUserConflictResponseErrorsInner';
21
- import { CreateUserConflictResponseErrorsItemsMeta } from '../models/CreateUserConflictResponseErrorsItemsMeta';
22
- import { CustomEvent } from '../models/CustomEvent';
23
- import { CustomEventsRequest } from '../models/CustomEventsRequest';
24
- import { DeliveryData } from '../models/DeliveryData';
25
- import { ExportEventsSuccessResponse } from '../models/ExportEventsSuccessResponse';
26
- import { ExportSubscriptionsRequestBody } from '../models/ExportSubscriptionsRequestBody';
27
- import { ExportSubscriptionsSuccessResponse } from '../models/ExportSubscriptionsSuccessResponse';
28
- import { Filter } from '../models/Filter';
29
- import { FilterExpression } from '../models/FilterExpression';
30
- import { GenericError } from '../models/GenericError';
31
- import { GenericSuccessBoolResponse } from '../models/GenericSuccessBoolResponse';
32
- import { GetNotificationHistoryRequestBody } from '../models/GetNotificationHistoryRequestBody';
33
- import { GetSegmentsSuccessResponse } from '../models/GetSegmentsSuccessResponse';
34
- import { LanguageStringMap } from '../models/LanguageStringMap';
35
- import { Notification } from '../models/Notification';
36
- import { NotificationAllOf } from '../models/NotificationAllOf';
37
- import { NotificationHistorySuccessResponse } from '../models/NotificationHistorySuccessResponse';
38
- import { NotificationSlice } from '../models/NotificationSlice';
39
- import { NotificationTarget } from '../models/NotificationTarget';
40
- import { NotificationWithMeta } from '../models/NotificationWithMeta';
41
- import { NotificationWithMetaAllOf } from '../models/NotificationWithMetaAllOf';
42
- import { Operator } from '../models/Operator';
43
- import { OutcomeData } from '../models/OutcomeData';
44
- import { OutcomesData } from '../models/OutcomesData';
45
- import { PlatformDeliveryData } from '../models/PlatformDeliveryData';
46
- import { PlatformDeliveryDataEmailAllOf } from '../models/PlatformDeliveryDataEmailAllOf';
47
- import { PlatformDeliveryDataSmsAllOf } from '../models/PlatformDeliveryDataSmsAllOf';
48
- import { PropertiesBody } from '../models/PropertiesBody';
49
- import { PropertiesDeltas } from '../models/PropertiesDeltas';
50
- import { PropertiesObject } from '../models/PropertiesObject';
51
- import { Purchase } from '../models/Purchase';
52
- import { RateLimitError } from '../models/RateLimitError';
53
- import { Segment } from '../models/Segment';
54
- import { SegmentData } from '../models/SegmentData';
55
- import { SegmentNotificationTarget } from '../models/SegmentNotificationTarget';
56
- import { StartLiveActivityRequest } from '../models/StartLiveActivityRequest';
57
- import { StartLiveActivitySuccessResponse } from '../models/StartLiveActivitySuccessResponse';
58
- import { Subscription } from '../models/Subscription';
59
- import { SubscriptionBody } from '../models/SubscriptionBody';
60
- import { SubscriptionNotificationTarget } from '../models/SubscriptionNotificationTarget';
61
- import { TemplateResource } from '../models/TemplateResource';
62
- import { TemplatesListResponse } from '../models/TemplatesListResponse';
63
- import { TransferSubscriptionRequestBody } from '../models/TransferSubscriptionRequestBody';
64
- import { UpdateApiKeyRequest } from '../models/UpdateApiKeyRequest';
65
- import { UpdateLiveActivityRequest } from '../models/UpdateLiveActivityRequest';
66
- import { UpdateLiveActivitySuccessResponse } from '../models/UpdateLiveActivitySuccessResponse';
67
- import { UpdateTemplateRequest } from '../models/UpdateTemplateRequest';
68
- import { UpdateUserRequest } from '../models/UpdateUserRequest';
69
- import { User } from '../models/User';
70
- import { UserIdentityBody } from '../models/UserIdentityBody';
71
- import { WebButton } from '../models/WebButton';
72
-
73
- import { ObservableDefaultApi } from "./ObservableAPI";
74
- import { DefaultApiRequestFactory, DefaultApiResponseProcessor} from "../apis/DefaultApi";
75
-
76
- export interface DefaultApiCancelNotificationRequest {
77
- /**
78
- *
79
- * @type string
80
- * @memberof DefaultApicancelNotification
81
- */
82
- appId: string
83
- /**
84
- *
85
- * @type string
86
- * @memberof DefaultApicancelNotification
87
- */
88
- notificationId: string
89
- }
90
-
91
- export interface DefaultApiCopyTemplateToAppRequest {
92
- /**
93
- *
94
- * @type string
95
- * @memberof DefaultApicopyTemplateToApp
96
- */
97
- templateId: string
98
- /**
99
- *
100
- * @type string
101
- * @memberof DefaultApicopyTemplateToApp
102
- */
103
- appId: string
104
- /**
105
- *
106
- * @type CopyTemplateRequest
107
- * @memberof DefaultApicopyTemplateToApp
108
- */
109
- copyTemplateRequest: CopyTemplateRequest
110
- }
111
-
112
- export interface DefaultApiCreateAliasRequest {
113
- /**
114
- *
115
- * @type string
116
- * @memberof DefaultApicreateAlias
117
- */
118
- appId: string
119
- /**
120
- *
121
- * @type string
122
- * @memberof DefaultApicreateAlias
123
- */
124
- aliasLabel: string
125
- /**
126
- *
127
- * @type string
128
- * @memberof DefaultApicreateAlias
129
- */
130
- aliasId: string
131
- /**
132
- *
133
- * @type UserIdentityBody
134
- * @memberof DefaultApicreateAlias
135
- */
136
- userIdentityBody: UserIdentityBody
137
- }
138
-
139
- export interface DefaultApiCreateAliasBySubscriptionRequest {
140
- /**
141
- *
142
- * @type string
143
- * @memberof DefaultApicreateAliasBySubscription
144
- */
145
- appId: string
146
- /**
147
- *
148
- * @type string
149
- * @memberof DefaultApicreateAliasBySubscription
150
- */
151
- subscriptionId: string
152
- /**
153
- *
154
- * @type UserIdentityBody
155
- * @memberof DefaultApicreateAliasBySubscription
156
- */
157
- userIdentityBody: UserIdentityBody
158
- }
159
-
160
- export interface DefaultApiCreateApiKeyRequest {
161
- /**
162
- *
163
- * @type string
164
- * @memberof DefaultApicreateApiKey
165
- */
166
- appId: string
167
- /**
168
- *
169
- * @type CreateApiKeyRequest
170
- * @memberof DefaultApicreateApiKey
171
- */
172
- createApiKeyRequest: CreateApiKeyRequest
173
- }
174
-
175
- export interface DefaultApiCreateAppRequest {
176
- /**
177
- *
178
- * @type App
179
- * @memberof DefaultApicreateApp
180
- */
181
- app: App
182
- }
183
-
184
- export interface DefaultApiCreateCustomEventsRequest {
185
- /**
186
- * Your OneSignal App ID in UUID v4 format.
187
- * @type string
188
- * @memberof DefaultApicreateCustomEvents
189
- */
190
- appId: string
191
- /**
192
- *
193
- * @type CustomEventsRequest
194
- * @memberof DefaultApicreateCustomEvents
195
- */
196
- customEventsRequest: CustomEventsRequest
197
- }
198
-
199
- export interface DefaultApiCreateNotificationRequest {
200
- /**
201
- *
202
- * @type Notification
203
- * @memberof DefaultApicreateNotification
204
- */
205
- notification: Notification
206
- }
207
-
208
- export interface DefaultApiCreateSegmentRequest {
209
- /**
210
- * The OneSignal App ID for your app. Available in Keys & IDs.
211
- * @type string
212
- * @memberof DefaultApicreateSegment
213
- */
214
- appId: string
215
- /**
216
- *
217
- * @type Segment
218
- * @memberof DefaultApicreateSegment
219
- */
220
- segment?: Segment
221
- }
222
-
223
- export interface DefaultApiCreateSubscriptionRequest {
224
- /**
225
- *
226
- * @type string
227
- * @memberof DefaultApicreateSubscription
228
- */
229
- appId: string
230
- /**
231
- *
232
- * @type string
233
- * @memberof DefaultApicreateSubscription
234
- */
235
- aliasLabel: string
236
- /**
237
- *
238
- * @type string
239
- * @memberof DefaultApicreateSubscription
240
- */
241
- aliasId: string
242
- /**
243
- *
244
- * @type SubscriptionBody
245
- * @memberof DefaultApicreateSubscription
246
- */
247
- subscriptionBody: SubscriptionBody
248
- }
249
-
250
- export interface DefaultApiCreateTemplateRequest {
251
- /**
252
- *
253
- * @type CreateTemplateRequest
254
- * @memberof DefaultApicreateTemplate
255
- */
256
- createTemplateRequest: CreateTemplateRequest
257
- }
258
-
259
- export interface DefaultApiCreateUserRequest {
260
- /**
261
- *
262
- * @type string
263
- * @memberof DefaultApicreateUser
264
- */
265
- appId: string
266
- /**
267
- *
268
- * @type User
269
- * @memberof DefaultApicreateUser
270
- */
271
- user: User
272
- }
273
-
274
- export interface DefaultApiDeleteAliasRequest {
275
- /**
276
- *
277
- * @type string
278
- * @memberof DefaultApideleteAlias
279
- */
280
- appId: string
281
- /**
282
- *
283
- * @type string
284
- * @memberof DefaultApideleteAlias
285
- */
286
- aliasLabel: string
287
- /**
288
- *
289
- * @type string
290
- * @memberof DefaultApideleteAlias
291
- */
292
- aliasId: string
293
- /**
294
- *
295
- * @type string
296
- * @memberof DefaultApideleteAlias
297
- */
298
- aliasLabelToDelete: string
299
- }
300
-
301
- export interface DefaultApiDeleteApiKeyRequest {
302
- /**
303
- *
304
- * @type string
305
- * @memberof DefaultApideleteApiKey
306
- */
307
- appId: string
308
- /**
309
- *
310
- * @type string
311
- * @memberof DefaultApideleteApiKey
312
- */
313
- tokenId: string
314
- }
315
-
316
- export interface DefaultApiDeleteSegmentRequest {
317
- /**
318
- * The OneSignal App ID for your app. Available in Keys & IDs.
319
- * @type string
320
- * @memberof DefaultApideleteSegment
321
- */
322
- appId: string
323
- /**
324
- * The segment_id can be found in the URL of the segment when viewing it in the dashboard.
325
- * @type string
326
- * @memberof DefaultApideleteSegment
327
- */
328
- segmentId: string
329
- }
330
-
331
- export interface DefaultApiDeleteSubscriptionRequest {
332
- /**
333
- *
334
- * @type string
335
- * @memberof DefaultApideleteSubscription
336
- */
337
- appId: string
338
- /**
339
- *
340
- * @type string
341
- * @memberof DefaultApideleteSubscription
342
- */
343
- subscriptionId: string
344
- }
345
-
346
- export interface DefaultApiDeleteTemplateRequest {
347
- /**
348
- *
349
- * @type string
350
- * @memberof DefaultApideleteTemplate
351
- */
352
- templateId: string
353
- /**
354
- *
355
- * @type string
356
- * @memberof DefaultApideleteTemplate
357
- */
358
- appId: string
359
- }
360
-
361
- export interface DefaultApiDeleteUserRequest {
362
- /**
363
- *
364
- * @type string
365
- * @memberof DefaultApideleteUser
366
- */
367
- appId: string
368
- /**
369
- *
370
- * @type string
371
- * @memberof DefaultApideleteUser
372
- */
373
- aliasLabel: string
374
- /**
375
- *
376
- * @type string
377
- * @memberof DefaultApideleteUser
378
- */
379
- aliasId: string
380
- }
381
-
382
- export interface DefaultApiExportEventsRequest {
383
- /**
384
- * The ID of the notification to export events from.
385
- * @type string
386
- * @memberof DefaultApiexportEvents
387
- */
388
- notificationId: string
389
- /**
390
- * The ID of the app that the notification belongs to.
391
- * @type string
392
- * @memberof DefaultApiexportEvents
393
- */
394
- appId: string
395
- }
396
-
397
- export interface DefaultApiExportSubscriptionsRequest {
398
- /**
399
- * The app ID that you want to export devices from
400
- * @type string
401
- * @memberof DefaultApiexportSubscriptions
402
- */
403
- appId: string
404
- /**
405
- *
406
- * @type ExportSubscriptionsRequestBody
407
- * @memberof DefaultApiexportSubscriptions
408
- */
409
- exportSubscriptionsRequestBody?: ExportSubscriptionsRequestBody
410
- }
411
-
412
- export interface DefaultApiGetAliasesRequest {
413
- /**
414
- *
415
- * @type string
416
- * @memberof DefaultApigetAliases
417
- */
418
- appId: string
419
- /**
420
- *
421
- * @type string
422
- * @memberof DefaultApigetAliases
423
- */
424
- aliasLabel: string
425
- /**
426
- *
427
- * @type string
428
- * @memberof DefaultApigetAliases
429
- */
430
- aliasId: string
431
- }
432
-
433
- export interface DefaultApiGetAliasesBySubscriptionRequest {
434
- /**
435
- *
436
- * @type string
437
- * @memberof DefaultApigetAliasesBySubscription
438
- */
439
- appId: string
440
- /**
441
- *
442
- * @type string
443
- * @memberof DefaultApigetAliasesBySubscription
444
- */
445
- subscriptionId: string
446
- }
447
-
448
- export interface DefaultApiGetAppRequest {
449
- /**
450
- * An app id
451
- * @type string
452
- * @memberof DefaultApigetApp
453
- */
454
- appId: string
455
- }
456
-
457
- export interface DefaultApiGetAppsRequest {
458
- }
459
-
460
- export interface DefaultApiGetNotificationRequest {
461
- /**
462
- *
463
- * @type string
464
- * @memberof DefaultApigetNotification
465
- */
466
- appId: string
467
- /**
468
- *
469
- * @type string
470
- * @memberof DefaultApigetNotification
471
- */
472
- notificationId: string
473
- }
474
-
475
- export interface DefaultApiGetNotificationHistoryRequest {
476
- /**
477
- * The \"id\" of the message found in the Notification object
478
- * @type string
479
- * @memberof DefaultApigetNotificationHistory
480
- */
481
- notificationId: string
482
- /**
483
- *
484
- * @type GetNotificationHistoryRequestBody
485
- * @memberof DefaultApigetNotificationHistory
486
- */
487
- getNotificationHistoryRequestBody: GetNotificationHistoryRequestBody
488
- }
489
-
490
- export interface DefaultApiGetNotificationsRequest {
491
- /**
492
- * The app ID that you want to view notifications from
493
- * @type string
494
- * @memberof DefaultApigetNotifications
495
- */
496
- appId: string
497
- /**
498
- * How many notifications to return. Max is 50. Default is 50.
499
- * @type number
500
- * @memberof DefaultApigetNotifications
501
- */
502
- limit?: number
503
- /**
504
- * Page offset. Default is 0. Results are sorted by queued_at in descending order. queued_at is a representation of the time that the notification was queued at.
505
- * @type number
506
- * @memberof DefaultApigetNotifications
507
- */
508
- offset?: number
509
- /**
510
- * Kind of notifications returned: * unset - All notification types (default) * `0` - Dashboard only * `1` - API only * `3` - Automated only
511
- * @type 0 | 1 | 3
512
- * @memberof DefaultApigetNotifications
513
- */
514
- kind?: 0 | 1 | 3
515
- }
516
-
517
- export interface DefaultApiGetOutcomesRequest {
518
- /**
519
- * The OneSignal App ID for your app. Available in Keys & IDs.
520
- * @type string
521
- * @memberof DefaultApigetOutcomes
522
- */
523
- appId: string
524
- /**
525
- * Required Comma-separated list of names and the value (sum/count) for the returned outcome data. Note: Clicks only support count aggregation. For out-of-the-box OneSignal outcomes such as click and session duration, please use the \"os\" prefix with two underscores. For other outcomes, please use the name specified by the user. Example:os__session_duration.count,os__click.count,CustomOutcomeName.sum
526
- * @type string
527
- * @memberof DefaultApigetOutcomes
528
- */
529
- outcomeNames: string
530
- /**
531
- * Optional If outcome names contain any commas, then please specify only one value at a time. Example: outcome_names[]=os__click.count&outcome_names[]=Sales, Purchase.count where \"Sales, Purchase\" is the custom outcomes with a comma in the name.
532
- * @type string
533
- * @memberof DefaultApigetOutcomes
534
- */
535
- outcomeNames2?: string
536
- /**
537
- * Optional Time range for the returned data. The values can be 1h (for the last 1 hour data), 1d (for the last 1 day data), or 1mo (for the last 1 month data). Default is 1h if the parameter is omitted.
538
- * @type string
539
- * @memberof DefaultApigetOutcomes
540
- */
541
- outcomeTimeRange?: string
542
- /**
543
- * Optional Platform id. Refer device\'s platform ids for values. Example: outcome_platform=0 for iOS outcome_platform=7,8 for Safari and Firefox Default is data from all platforms if the parameter is omitted.
544
- * @type string
545
- * @memberof DefaultApigetOutcomes
546
- */
547
- outcomePlatforms?: string
548
- /**
549
- * Optional Attribution type for the outcomes. The values can be direct or influenced or unattributed. Example: outcome_attribution=direct Default is total (returns direct+influenced+unattributed) if the parameter is omitted.
550
- * @type string
551
- * @memberof DefaultApigetOutcomes
552
- */
553
- outcomeAttribution?: string
554
- }
555
-
556
- export interface DefaultApiGetSegmentsRequest {
557
- /**
558
- * The OneSignal App ID for your app. Available in Keys & IDs.
559
- * @type string
560
- * @memberof DefaultApigetSegments
561
- */
562
- appId: string
563
- /**
564
- * 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.
565
- * @type number
566
- * @memberof DefaultApigetSegments
567
- */
568
- offset?: number
569
- /**
570
- * The amount of Segments in the response. Maximum 300.
571
- * @type number
572
- * @memberof DefaultApigetSegments
573
- */
574
- limit?: number
575
- }
576
-
577
- export interface DefaultApiGetUserRequest {
578
- /**
579
- *
580
- * @type string
581
- * @memberof DefaultApigetUser
582
- */
583
- appId: string
584
- /**
585
- *
586
- * @type string
587
- * @memberof DefaultApigetUser
588
- */
589
- aliasLabel: string
590
- /**
591
- *
592
- * @type string
593
- * @memberof DefaultApigetUser
594
- */
595
- aliasId: string
596
- }
597
-
598
- export interface DefaultApiRotateApiKeyRequest {
599
- /**
600
- *
601
- * @type string
602
- * @memberof DefaultApirotateApiKey
603
- */
604
- appId: string
605
- /**
606
- *
607
- * @type string
608
- * @memberof DefaultApirotateApiKey
609
- */
610
- tokenId: string
611
- }
612
-
613
- export interface DefaultApiStartLiveActivityRequest {
614
- /**
615
- * Your OneSignal App ID in UUID v4 format.
616
- * @type string
617
- * @memberof DefaultApistartLiveActivity
618
- */
619
- appId: string
620
- /**
621
- * The name of the Live Activity defined in your app. This should match the attributes struct used in your app\'s Live Activity implementation.
622
- * @type string
623
- * @memberof DefaultApistartLiveActivity
624
- */
625
- activityType: string
626
- /**
627
- *
628
- * @type StartLiveActivityRequest
629
- * @memberof DefaultApistartLiveActivity
630
- */
631
- startLiveActivityRequest: StartLiveActivityRequest
632
- }
633
-
634
- export interface DefaultApiTransferSubscriptionRequest {
635
- /**
636
- *
637
- * @type string
638
- * @memberof DefaultApitransferSubscription
639
- */
640
- appId: string
641
- /**
642
- *
643
- * @type string
644
- * @memberof DefaultApitransferSubscription
645
- */
646
- subscriptionId: string
647
- /**
648
- *
649
- * @type TransferSubscriptionRequestBody
650
- * @memberof DefaultApitransferSubscription
651
- */
652
- transferSubscriptionRequestBody: TransferSubscriptionRequestBody
653
- }
654
-
655
- export interface DefaultApiUnsubscribeEmailWithTokenRequest {
656
- /**
657
- * The OneSignal App ID for your app. Available in Keys & IDs.
658
- * @type string
659
- * @memberof DefaultApiunsubscribeEmailWithToken
660
- */
661
- appId: string
662
- /**
663
- * The id of the message found in the creation notification POST response, View Notifications GET response, or URL within the Message Report.
664
- * @type string
665
- * @memberof DefaultApiunsubscribeEmailWithToken
666
- */
667
- notificationId: string
668
- /**
669
- * The unsubscribe token that is generated via liquid syntax in {{subscription.unsubscribe_token}} when personalizing an email.
670
- * @type string
671
- * @memberof DefaultApiunsubscribeEmailWithToken
672
- */
673
- token: string
674
- }
675
-
676
- export interface DefaultApiUpdateApiKeyRequest {
677
- /**
678
- *
679
- * @type string
680
- * @memberof DefaultApiupdateApiKey
681
- */
682
- appId: string
683
- /**
684
- *
685
- * @type string
686
- * @memberof DefaultApiupdateApiKey
687
- */
688
- tokenId: string
689
- /**
690
- *
691
- * @type UpdateApiKeyRequest
692
- * @memberof DefaultApiupdateApiKey
693
- */
694
- updateApiKeyRequest: UpdateApiKeyRequest
695
- }
696
-
697
- export interface DefaultApiUpdateAppRequest {
698
- /**
699
- * An app id
700
- * @type string
701
- * @memberof DefaultApiupdateApp
702
- */
703
- appId: string
704
- /**
705
- *
706
- * @type App
707
- * @memberof DefaultApiupdateApp
708
- */
709
- app: App
710
- }
711
-
712
- export interface DefaultApiUpdateLiveActivityRequest {
713
- /**
714
- * The OneSignal App ID for your app. Available in Keys & IDs.
715
- * @type string
716
- * @memberof DefaultApiupdateLiveActivity
717
- */
718
- appId: string
719
- /**
720
- * Live Activity record ID
721
- * @type string
722
- * @memberof DefaultApiupdateLiveActivity
723
- */
724
- activityId: string
725
- /**
726
- *
727
- * @type UpdateLiveActivityRequest
728
- * @memberof DefaultApiupdateLiveActivity
729
- */
730
- updateLiveActivityRequest: UpdateLiveActivityRequest
731
- }
732
-
733
- export interface DefaultApiUpdateSubscriptionRequest {
734
- /**
735
- *
736
- * @type string
737
- * @memberof DefaultApiupdateSubscription
738
- */
739
- appId: string
740
- /**
741
- *
742
- * @type string
743
- * @memberof DefaultApiupdateSubscription
744
- */
745
- subscriptionId: string
746
- /**
747
- *
748
- * @type SubscriptionBody
749
- * @memberof DefaultApiupdateSubscription
750
- */
751
- subscriptionBody: SubscriptionBody
752
- }
753
-
754
- export interface DefaultApiUpdateSubscriptionByTokenRequest {
755
- /**
756
- * Your OneSignal App ID in UUID v4 format.
757
- * @type string
758
- * @memberof DefaultApiupdateSubscriptionByToken
759
- */
760
- appId: string
761
- /**
762
- * The type of token to use when looking up the subscription. See Subscription Types.
763
- * @type string
764
- * @memberof DefaultApiupdateSubscriptionByToken
765
- */
766
- tokenType: string
767
- /**
768
- * The value of the token to lookup by (e.g., email address, phone number).
769
- * @type string
770
- * @memberof DefaultApiupdateSubscriptionByToken
771
- */
772
- token: string
773
- /**
774
- *
775
- * @type SubscriptionBody
776
- * @memberof DefaultApiupdateSubscriptionByToken
777
- */
778
- subscriptionBody: SubscriptionBody
779
- }
780
-
781
- export interface DefaultApiUpdateTemplateRequest {
782
- /**
783
- *
784
- * @type string
785
- * @memberof DefaultApiupdateTemplate
786
- */
787
- templateId: string
788
- /**
789
- *
790
- * @type string
791
- * @memberof DefaultApiupdateTemplate
792
- */
793
- appId: string
794
- /**
795
- *
796
- * @type UpdateTemplateRequest
797
- * @memberof DefaultApiupdateTemplate
798
- */
799
- updateTemplateRequest: UpdateTemplateRequest
800
- }
801
-
802
- export interface DefaultApiUpdateUserRequest {
803
- /**
804
- *
805
- * @type string
806
- * @memberof DefaultApiupdateUser
807
- */
808
- appId: string
809
- /**
810
- *
811
- * @type string
812
- * @memberof DefaultApiupdateUser
813
- */
814
- aliasLabel: string
815
- /**
816
- *
817
- * @type string
818
- * @memberof DefaultApiupdateUser
819
- */
820
- aliasId: string
821
- /**
822
- *
823
- * @type UpdateUserRequest
824
- * @memberof DefaultApiupdateUser
825
- */
826
- updateUserRequest: UpdateUserRequest
827
- }
828
-
829
- export interface DefaultApiViewApiKeysRequest {
830
- /**
831
- *
832
- * @type string
833
- * @memberof DefaultApiviewApiKeys
834
- */
835
- appId: string
836
- }
837
-
838
- export interface DefaultApiViewTemplateRequest {
839
- /**
840
- *
841
- * @type string
842
- * @memberof DefaultApiviewTemplate
843
- */
844
- templateId: string
845
- /**
846
- *
847
- * @type string
848
- * @memberof DefaultApiviewTemplate
849
- */
850
- appId: string
851
- }
852
-
853
- export interface DefaultApiViewTemplatesRequest {
854
- /**
855
- * Your OneSignal App ID in UUID v4 format.
856
- * @type string
857
- * @memberof DefaultApiviewTemplates
858
- */
859
- appId: string
860
- /**
861
- * Maximum number of templates. Default and max is 50.
862
- * @type number
863
- * @memberof DefaultApiviewTemplates
864
- */
865
- limit?: number
866
- /**
867
- * Pagination offset.
868
- * @type number
869
- * @memberof DefaultApiviewTemplates
870
- */
871
- offset?: number
872
- /**
873
- * Filter by delivery channel.
874
- * @type 'push' | 'email' | 'sms'
875
- * @memberof DefaultApiviewTemplates
876
- */
877
- channel?: 'push' | 'email' | 'sms'
878
- }
879
-
880
- export class ObjectDefaultApi {
881
- private api: ObservableDefaultApi
882
-
883
- public constructor(configuration: Configuration, requestFactory?: DefaultApiRequestFactory, responseProcessor?: DefaultApiResponseProcessor) {
884
- this.api = new ObservableDefaultApi(configuration, requestFactory, responseProcessor);
885
- }
886
-
887
- /**
888
- * Used to stop a scheduled or currently outgoing notification
889
- * Stop a scheduled or currently outgoing notification
890
- * @param param the request object
891
- */
892
- public cancelNotification(param: DefaultApiCancelNotificationRequest, options?: Configuration): Promise<GenericSuccessBoolResponse> {
893
- return this.api.cancelNotification(param.appId, param.notificationId, options).toPromise();
894
- }
895
-
896
- /**
897
- * Copy a template to a destination app.
898
- * Copy template to another app
899
- * @param param the request object
900
- */
901
- public copyTemplateToApp(param: DefaultApiCopyTemplateToAppRequest, options?: Configuration): Promise<TemplateResource> {
902
- return this.api.copyTemplateToApp(param.templateId, param.appId, param.copyTemplateRequest, options).toPromise();
903
- }
904
-
905
- /**
906
- * Upserts one or more Aliases to an existing User identified by (:alias_label, :alias_id).
907
- * @param param the request object
908
- */
909
- public createAlias(param: DefaultApiCreateAliasRequest, options?: Configuration): Promise<UserIdentityBody> {
910
- return this.api.createAlias(param.appId, param.aliasLabel, param.aliasId, param.userIdentityBody, options).toPromise();
911
- }
912
-
913
- /**
914
- * Upserts one or more Aliases for the User identified by :subscription_id.
915
- * @param param the request object
916
- */
917
- public createAliasBySubscription(param: DefaultApiCreateAliasBySubscriptionRequest, options?: Configuration): Promise<UserIdentityBody> {
918
- return this.api.createAliasBySubscription(param.appId, param.subscriptionId, param.userIdentityBody, options).toPromise();
919
- }
920
-
921
- /**
922
- * Use this API to create a new App API Key (also called a Rich Authentication Token) for a specific OneSignal app. These keys are used to authenticate API requests at the app level and offer enhanced security features, including optional IP allowlisting.
923
- * Create API key
924
- * @param param the request object
925
- */
926
- public createApiKey(param: DefaultApiCreateApiKeyRequest, options?: Configuration): Promise<CreateApiKeyResponse> {
927
- return this.api.createApiKey(param.appId, param.createApiKeyRequest, options).toPromise();
928
- }
929
-
930
- /**
931
- * Creates a new OneSignal app
932
- * Create an app
933
- * @param param the request object
934
- */
935
- public createApp(param: DefaultApiCreateAppRequest, options?: Configuration): Promise<App> {
936
- return this.api.createApp(param.app, options).toPromise();
937
- }
938
-
939
- /**
940
- * The Custom Events API allows you to record user events. Custom events can represent any action users take in your application, such as completing a purchase, viewing content, or achieving milestones.
941
- * Create custom events
942
- * @param param the request object
943
- */
944
- public createCustomEvents(param: DefaultApiCreateCustomEventsRequest, options?: Configuration): Promise<object> {
945
- return this.api.createCustomEvents(param.appId, param.customEventsRequest, options).toPromise();
946
- }
947
-
948
- /**
949
- * Sends notifications to your users
950
- * Create notification
951
- * @param param the request object
952
- */
953
- public createNotification(param: DefaultApiCreateNotificationRequest, options?: Configuration): Promise<CreateNotificationSuccessResponse> {
954
- return this.api.createNotification(param.notification, options).toPromise();
955
- }
956
-
957
- /**
958
- * 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.
959
- * Create Segment
960
- * @param param the request object
961
- */
962
- public createSegment(param: DefaultApiCreateSegmentRequest, options?: Configuration): Promise<CreateSegmentSuccessResponse> {
963
- return this.api.createSegment(param.appId, param.segment, options).toPromise();
964
- }
965
-
966
- /**
967
- * Creates a new Subscription under the User provided. Useful to add email addresses and SMS numbers to the User.
968
- * @param param the request object
969
- */
970
- public createSubscription(param: DefaultApiCreateSubscriptionRequest, options?: Configuration): Promise<SubscriptionBody> {
971
- return this.api.createSubscription(param.appId, param.aliasLabel, param.aliasId, param.subscriptionBody, options).toPromise();
972
- }
973
-
974
- /**
975
- * Create reusable message templates for push, email, and SMS channels.
976
- * Create template
977
- * @param param the request object
978
- */
979
- public createTemplate(param: DefaultApiCreateTemplateRequest, options?: Configuration): Promise<TemplateResource> {
980
- return this.api.createTemplate(param.createTemplateRequest, options).toPromise();
981
- }
982
-
983
- /**
984
- * 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.
985
- * @param param the request object
986
- */
987
- public createUser(param: DefaultApiCreateUserRequest, options?: Configuration): Promise<User> {
988
- return this.api.createUser(param.appId, param.user, options).toPromise();
989
- }
990
-
991
- /**
992
- * Deletes an alias by alias label
993
- * @param param the request object
994
- */
995
- public deleteAlias(param: DefaultApiDeleteAliasRequest, options?: Configuration): Promise<UserIdentityBody> {
996
- return this.api.deleteAlias(param.appId, param.aliasLabel, param.aliasId, param.aliasLabelToDelete, options).toPromise();
997
- }
998
-
999
- /**
1000
- * Delete a specific Rich Authentication Token (App API Key) for a OneSignal app. Requires your Organization API Key and the token’s unique ID, not the token value itself.
1001
- * Delete API key
1002
- * @param param the request object
1003
- */
1004
- public deleteApiKey(param: DefaultApiDeleteApiKeyRequest, options?: Configuration): Promise<object> {
1005
- return this.api.deleteApiKey(param.appId, param.tokenId, options).toPromise();
1006
- }
1007
-
1008
- /**
1009
- * 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.
1010
- * Delete Segment
1011
- * @param param the request object
1012
- */
1013
- public deleteSegment(param: DefaultApiDeleteSegmentRequest, options?: Configuration): Promise<GenericSuccessBoolResponse> {
1014
- return this.api.deleteSegment(param.appId, param.segmentId, options).toPromise();
1015
- }
1016
-
1017
- /**
1018
- * Deletes the Subscription.
1019
- * @param param the request object
1020
- */
1021
- public deleteSubscription(param: DefaultApiDeleteSubscriptionRequest, options?: Configuration): Promise<void> {
1022
- return this.api.deleteSubscription(param.appId, param.subscriptionId, options).toPromise();
1023
- }
1024
-
1025
- /**
1026
- * Delete a template by id.
1027
- * Delete template
1028
- * @param param the request object
1029
- */
1030
- public deleteTemplate(param: DefaultApiDeleteTemplateRequest, options?: Configuration): Promise<GenericSuccessBoolResponse> {
1031
- return this.api.deleteTemplate(param.templateId, param.appId, options).toPromise();
1032
- }
1033
-
1034
- /**
1035
- * Removes the User identified by (:alias_label, :alias_id), and all Subscriptions and Aliases
1036
- * @param param the request object
1037
- */
1038
- public deleteUser(param: DefaultApiDeleteUserRequest, options?: Configuration): Promise<void> {
1039
- return this.api.deleteUser(param.appId, param.aliasLabel, param.aliasId, options).toPromise();
1040
- }
1041
-
1042
- /**
1043
- * 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.
1044
- * Export CSV of Events
1045
- * @param param the request object
1046
- */
1047
- public exportEvents(param: DefaultApiExportEventsRequest, options?: Configuration): Promise<ExportEventsSuccessResponse> {
1048
- return this.api.exportEvents(param.notificationId, param.appId, options).toPromise();
1049
- }
1050
-
1051
- /**
1052
- * 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. |
1053
- * Export CSV of Subscriptions
1054
- * @param param the request object
1055
- */
1056
- public exportSubscriptions(param: DefaultApiExportSubscriptionsRequest, options?: Configuration): Promise<ExportSubscriptionsSuccessResponse> {
1057
- return this.api.exportSubscriptions(param.appId, param.exportSubscriptionsRequestBody, options).toPromise();
1058
- }
1059
-
1060
- /**
1061
- * Lists all Aliases for the User identified by (:alias_label, :alias_id).
1062
- * @param param the request object
1063
- */
1064
- public getAliases(param: DefaultApiGetAliasesRequest, options?: Configuration): Promise<UserIdentityBody> {
1065
- return this.api.getAliases(param.appId, param.aliasLabel, param.aliasId, options).toPromise();
1066
- }
1067
-
1068
- /**
1069
- * Lists all Aliases for the User identified by :subscription_id.
1070
- * @param param the request object
1071
- */
1072
- public getAliasesBySubscription(param: DefaultApiGetAliasesBySubscriptionRequest, options?: Configuration): Promise<UserIdentityBody> {
1073
- return this.api.getAliasesBySubscription(param.appId, param.subscriptionId, options).toPromise();
1074
- }
1075
-
1076
- /**
1077
- * View the details of a single OneSignal app
1078
- * View an app
1079
- * @param param the request object
1080
- */
1081
- public getApp(param: DefaultApiGetAppRequest, options?: Configuration): Promise<App> {
1082
- return this.api.getApp(param.appId, options).toPromise();
1083
- }
1084
-
1085
- /**
1086
- * View the details of all of your current OneSignal apps
1087
- * View apps
1088
- * @param param the request object
1089
- */
1090
- public getApps(param: DefaultApiGetAppsRequest = {}, options?: Configuration): Promise<Array<App>> {
1091
- return this.api.getApps( options).toPromise();
1092
- }
1093
-
1094
- /**
1095
- * View the details of a single notification and outcomes associated with it
1096
- * View notification
1097
- * @param param the request object
1098
- */
1099
- public getNotification(param: DefaultApiGetNotificationRequest, options?: Configuration): Promise<NotificationWithMeta> {
1100
- return this.api.getNotification(param.appId, param.notificationId, options).toPromise();
1101
- }
1102
-
1103
- /**
1104
- * -> View the devices sent a message - OneSignal Paid Plan Required This method will return all devices that were sent the given notification_id of an Email or Push Notification if used within 7 days of the date sent. After 7 days of the sending date, the message history data will be unavailable. After a successful response is received, the destination url may be polled until the file becomes available. Most exports are done in ~1-3 minutes, so setting a poll interval of 10 seconds should be adequate. For use cases that are not meant to be consumed by a script, an email will be sent to the supplied email address. &#x1F6A7; Requirements A OneSignal Paid Plan. Turn on Send History via OneSignal API in Settings -> Analytics. Cannot get data before this was turned on. Must be called within 7 days after sending the message. Messages targeting under 1000 recipients will not have \"sent\" events recorded, but will show \"clicked\" events. Requires your OneSignal App\'s REST API Key, available in Keys & IDs.
1105
- * Notification History
1106
- * @param param the request object
1107
- */
1108
- public getNotificationHistory(param: DefaultApiGetNotificationHistoryRequest, options?: Configuration): Promise<NotificationHistorySuccessResponse> {
1109
- return this.api.getNotificationHistory(param.notificationId, param.getNotificationHistoryRequestBody, options).toPromise();
1110
- }
1111
-
1112
- /**
1113
- * View the details of multiple notifications
1114
- * View notifications
1115
- * @param param the request object
1116
- */
1117
- public getNotifications(param: DefaultApiGetNotificationsRequest, options?: Configuration): Promise<NotificationSlice> {
1118
- return this.api.getNotifications(param.appId, param.limit, param.offset, param.kind, options).toPromise();
1119
- }
1120
-
1121
- /**
1122
- * View the details of all the outcomes associated with your app &#x1F6A7; Requires Authentication Key Requires your OneSignal App\'s REST API Key, available in Keys & IDs. &#x1F6A7; Outcome Data Limitations Outcomes are only accessible for around 30 days before deleted from our servers. You will need to export this data every month if you want to keep it.
1123
- * View Outcomes
1124
- * @param param the request object
1125
- */
1126
- public getOutcomes(param: DefaultApiGetOutcomesRequest, options?: Configuration): Promise<OutcomesData> {
1127
- return this.api.getOutcomes(param.appId, param.outcomeNames, param.outcomeNames2, param.outcomeTimeRange, param.outcomePlatforms, param.outcomeAttribution, options).toPromise();
1128
- }
1129
-
1130
- /**
1131
- * Returns an array of segments from an app.
1132
- * Get Segments
1133
- * @param param the request object
1134
- */
1135
- public getSegments(param: DefaultApiGetSegmentsRequest, options?: Configuration): Promise<GetSegmentsSuccessResponse> {
1136
- return this.api.getSegments(param.appId, param.offset, param.limit, options).toPromise();
1137
- }
1138
-
1139
- /**
1140
- * Returns the User’s properties, Aliases, and Subscriptions.
1141
- * @param param the request object
1142
- */
1143
- public getUser(param: DefaultApiGetUserRequest, options?: Configuration): Promise<User> {
1144
- return this.api.getUser(param.appId, param.aliasLabel, param.aliasId, options).toPromise();
1145
- }
1146
-
1147
- /**
1148
- * Rotate a Rich Authentication Token (App API Key) for a OneSignal app. Rotating a key revokes the current token and generates a new one under the same configuration—ideal when a token is lost or compromised but you don’t want to recreate and reconfigure it from scratch.
1149
- * Rotate API key
1150
- * @param param the request object
1151
- */
1152
- public rotateApiKey(param: DefaultApiRotateApiKeyRequest, options?: Configuration): Promise<CreateApiKeyResponse> {
1153
- return this.api.rotateApiKey(param.appId, param.tokenId, options).toPromise();
1154
- }
1155
-
1156
- /**
1157
- * Remotely start a Live Activity on iOS devices via OneSignal’s REST API.
1158
- * Start Live Activity
1159
- * @param param the request object
1160
- */
1161
- public startLiveActivity(param: DefaultApiStartLiveActivityRequest, options?: Configuration): Promise<StartLiveActivitySuccessResponse> {
1162
- return this.api.startLiveActivity(param.appId, param.activityType, param.startLiveActivityRequest, options).toPromise();
1163
- }
1164
-
1165
- /**
1166
- * Transfers this Subscription to the User identified by the identity in the payload.
1167
- * @param param the request object
1168
- */
1169
- public transferSubscription(param: DefaultApiTransferSubscriptionRequest, options?: Configuration): Promise<UserIdentityBody> {
1170
- return this.api.transferSubscription(param.appId, param.subscriptionId, param.transferSubscriptionRequestBody, options).toPromise();
1171
- }
1172
-
1173
- /**
1174
- * Unsubscribe an email with a token when using your own custom email unsubscribe landing page
1175
- * Unsubscribe with token
1176
- * @param param the request object
1177
- */
1178
- public unsubscribeEmailWithToken(param: DefaultApiUnsubscribeEmailWithTokenRequest, options?: Configuration): Promise<GenericSuccessBoolResponse> {
1179
- return this.api.unsubscribeEmailWithToken(param.appId, param.notificationId, param.token, options).toPromise();
1180
- }
1181
-
1182
- /**
1183
- * Update a Rich Authentication Token (App API Key) for a OneSignal app.
1184
- * Update API key
1185
- * @param param the request object
1186
- */
1187
- public updateApiKey(param: DefaultApiUpdateApiKeyRequest, options?: Configuration): Promise<object> {
1188
- return this.api.updateApiKey(param.appId, param.tokenId, param.updateApiKeyRequest, options).toPromise();
1189
- }
1190
-
1191
- /**
1192
- * Updates the name or configuration settings of an existing OneSignal app
1193
- * Update an app
1194
- * @param param the request object
1195
- */
1196
- public updateApp(param: DefaultApiUpdateAppRequest, options?: Configuration): Promise<App> {
1197
- return this.api.updateApp(param.appId, param.app, options).toPromise();
1198
- }
1199
-
1200
- /**
1201
- * Updates a specified live activity.
1202
- * Update a Live Activity via Push
1203
- * @param param the request object
1204
- */
1205
- public updateLiveActivity(param: DefaultApiUpdateLiveActivityRequest, options?: Configuration): Promise<UpdateLiveActivitySuccessResponse> {
1206
- return this.api.updateLiveActivity(param.appId, param.activityId, param.updateLiveActivityRequest, options).toPromise();
1207
- }
1208
-
1209
- /**
1210
- * Updates an existing Subscription’s properties.
1211
- * @param param the request object
1212
- */
1213
- public updateSubscription(param: DefaultApiUpdateSubscriptionRequest, options?: Configuration): Promise<void> {
1214
- return this.api.updateSubscription(param.appId, param.subscriptionId, param.subscriptionBody, options).toPromise();
1215
- }
1216
-
1217
- /**
1218
- * Update properties on an existing OneSignal subscription using its token.
1219
- * Update subscription by token
1220
- * @param param the request object
1221
- */
1222
- public updateSubscriptionByToken(param: DefaultApiUpdateSubscriptionByTokenRequest, options?: Configuration): Promise<object> {
1223
- return this.api.updateSubscriptionByToken(param.appId, param.tokenType, param.token, param.subscriptionBody, options).toPromise();
1224
- }
1225
-
1226
- /**
1227
- * Update an existing template.
1228
- * Update template
1229
- * @param param the request object
1230
- */
1231
- public updateTemplate(param: DefaultApiUpdateTemplateRequest, options?: Configuration): Promise<TemplateResource> {
1232
- return this.api.updateTemplate(param.templateId, param.appId, param.updateTemplateRequest, options).toPromise();
1233
- }
1234
-
1235
- /**
1236
- * Updates an existing User’s properties.
1237
- * @param param the request object
1238
- */
1239
- public updateUser(param: DefaultApiUpdateUserRequest, options?: Configuration): Promise<PropertiesBody> {
1240
- return this.api.updateUser(param.appId, param.aliasLabel, param.aliasId, param.updateUserRequest, options).toPromise();
1241
- }
1242
-
1243
- /**
1244
- * View the details of all of your current app API keys (Rich Authentication Token) for a single OneSignal app.
1245
- * View API keys
1246
- * @param param the request object
1247
- */
1248
- public viewApiKeys(param: DefaultApiViewApiKeysRequest, options?: Configuration): Promise<ApiKeyTokensListResponse> {
1249
- return this.api.viewApiKeys(param.appId, options).toPromise();
1250
- }
1251
-
1252
- /**
1253
- * Fetch a single template by id.
1254
- * View template
1255
- * @param param the request object
1256
- */
1257
- public viewTemplate(param: DefaultApiViewTemplateRequest, options?: Configuration): Promise<TemplateResource> {
1258
- return this.api.viewTemplate(param.templateId, param.appId, options).toPromise();
1259
- }
1260
-
1261
- /**
1262
- * List templates for an app.
1263
- * View templates
1264
- * @param param the request object
1265
- */
1266
- public viewTemplates(param: DefaultApiViewTemplatesRequest, options?: Configuration): Promise<TemplatesListResponse> {
1267
- return this.api.viewTemplates(param.appId, param.limit, param.offset, param.channel, options).toPromise();
1268
- }
1269
-
1270
- }