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