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