@onesignal/node-onesignal 2.0.1-beta1 → 2.0.1-beta2
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 +126 -4
- package/apis/DefaultApi.ts +623 -95
- package/dist/apis/DefaultApi.d.ts +3 -0
- package/dist/apis/DefaultApi.js +1063 -415
- package/dist/apis/DefaultApi.js.map +1 -1
- package/dist/models/{BadRequestError.d.ts → ExportEventsSuccessResponse.d.ts} +2 -2
- package/dist/models/ExportEventsSuccessResponse.js +22 -0
- package/dist/models/ExportEventsSuccessResponse.js.map +1 -0
- package/dist/models/{CreateSegmentBadRequestResponse.d.ts → GenericError.d.ts} +3 -3
- package/dist/models/GenericError.js +22 -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/ObjectSerializer.d.ts +4 -3
- package/dist/models/ObjectSerializer.js +12 -9
- package/dist/models/ObjectSerializer.js.map +1 -1
- package/dist/models/{DeletePlayerBadRequestResponse.d.ts → RateLimiterError.d.ts} +3 -2
- package/dist/models/RateLimiterError.js +22 -0
- package/dist/models/RateLimiterError.js.map +1 -0
- package/dist/models/all.d.ts +4 -3
- package/dist/models/all.js +4 -3
- package/dist/models/all.js.map +1 -1
- package/dist/types/ObjectParamAPI.d.ts +6 -0
- package/dist/types/ObjectParamAPI.js +3 -0
- package/dist/types/ObjectParamAPI.js.map +1 -1
- package/dist/types/ObservableAPI.d.ts +2 -0
- package/dist/types/ObservableAPI.js +89 -65
- package/dist/types/ObservableAPI.js.map +1 -1
- package/dist/types/PromiseAPI.d.ts +2 -0
- package/dist/types/PromiseAPI.js +4 -0
- package/dist/types/PromiseAPI.js.map +1 -1
- package/models/App.ts +1 -1
- package/models/BasicNotification.ts +1 -1
- package/models/BasicNotificationAllOf.ts +1 -1
- package/models/BasicNotificationAllOfAndroidBackgroundLayout.ts +1 -1
- package/models/BeginLiveActivityRequest.ts +1 -1
- package/models/Button.ts +1 -1
- package/models/CancelNotificationSuccessResponse.ts +1 -1
- package/models/CreateNotificationSuccessResponse.ts +1 -1
- package/models/CreatePlayerSuccessResponse.ts +1 -1
- package/models/CreateSegmentConflictResponse.ts +1 -1
- package/models/CreateSegmentSuccessResponse.ts +1 -1
- package/models/CreateSubscriptionRequestBody.ts +1 -1
- package/models/CreateUserConflictResponse.ts +1 -1
- package/models/CreateUserConflictResponseErrorsInner.ts +1 -1
- package/models/CreateUserConflictResponseErrorsItemsMeta.ts +1 -1
- package/models/DeletePlayerNotFoundResponse.ts +1 -1
- package/models/DeletePlayerSuccessResponse.ts +1 -1
- package/models/DeleteSegmentNotFoundResponse.ts +1 -1
- package/models/DeleteSegmentSuccessResponse.ts +1 -1
- package/models/DeliveryData.ts +1 -1
- package/models/{DeletePlayerBadRequestResponse.ts → ExportEventsSuccessResponse.ts} +7 -7
- package/models/ExportPlayersRequestBody.ts +1 -1
- package/models/ExportPlayersSuccessResponse.ts +1 -1
- package/models/Filter.ts +1 -1
- package/models/FilterExpressions.ts +1 -1
- package/models/{CreateNotificationBadRequestResponse.ts → GenericError.ts} +6 -5
- package/models/{IdentifyUserConflictResponseErrorsInner.ts → GenericErrorErrorsInner.ts} +3 -3
- package/models/GetNotificationRequestBody.ts +1 -1
- package/models/InlineResponse200.ts +1 -1
- package/models/InlineResponse2003.ts +1 -1
- package/models/InlineResponse201.ts +1 -1
- package/models/InlineResponse202.ts +1 -1
- package/models/InvalidIdentifierError.ts +1 -1
- package/models/Notification.ts +1 -1
- package/models/Notification200Errors.ts +1 -1
- package/models/NotificationAllOf.ts +1 -1
- package/models/NotificationHistorySuccessResponse.ts +1 -1
- package/models/NotificationSlice.ts +1 -1
- package/models/NotificationTarget.ts +1 -1
- package/models/NotificationWithMeta.ts +1 -1
- package/models/NotificationWithMetaAllOf.ts +1 -1
- package/models/ObjectSerializer.ts +12 -9
- 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/Player.ts +1 -1
- package/models/PlayerNotificationTarget.ts +1 -1
- package/models/PlayerNotificationTargetIncludeAliases.ts +1 -1
- package/models/PlayerSlice.ts +1 -1
- package/models/PropertiesDeltas.ts +1 -1
- package/models/PropertiesObject.ts +1 -1
- package/models/Purchase.ts +1 -1
- package/models/{BadRequestError.ts → RateLimiterError.ts} +6 -5
- package/models/Segment.ts +1 -1
- package/models/SegmentNotificationTarget.ts +1 -1
- package/models/StringMap.ts +1 -1
- package/models/SubscriptionObject.ts +1 -1
- package/models/TransferSubscriptionRequestBody.ts +1 -1
- package/models/UpdateLiveActivityRequest.ts +1 -1
- package/models/UpdateLiveActivitySuccessResponse.ts +1 -1
- package/models/UpdatePlayerSuccessResponse.ts +1 -1
- package/models/UpdatePlayerTagsRequestBody.ts +1 -1
- package/models/UpdatePlayerTagsSuccessResponse.ts +1 -1
- package/models/UpdateSubscriptionRequestBody.ts +1 -1
- package/models/UpdateUserRequest.ts +1 -1
- package/models/User.ts +1 -1
- package/models/UserIdentityRequestBody.ts +1 -1
- package/models/UserIdentityResponse.ts +1 -1
- package/models/UserSubscriptionOptions.ts +1 -1
- package/models/all.ts +4 -3
- package/package.json +2 -2
- package/types/ObjectParamAPI.ts +29 -4
- package/types/ObservableAPI.ts +30 -4
- package/types/PromiseAPI.ts +16 -4
- package/dist/models/BadRequestError.js +0 -22
- package/dist/models/BadRequestError.js.map +0 -1
- package/dist/models/CreateNotificationBadRequestResponse.d.ts +0 -17
- package/dist/models/CreateNotificationBadRequestResponse.js +0 -22
- package/dist/models/CreateNotificationBadRequestResponse.js.map +0 -1
- package/dist/models/CreateSegmentBadRequestResponse.js +0 -28
- package/dist/models/CreateSegmentBadRequestResponse.js.map +0 -1
- package/dist/models/DeletePlayerBadRequestResponse.js +0 -22
- package/dist/models/DeletePlayerBadRequestResponse.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/FilterNotificationTarget.d.ts +0 -28
- package/dist/models/FilterNotificationTarget.js +0 -88
- package/dist/models/FilterNotificationTarget.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/NotificationHistoryBadRequestResponse.d.ts +0 -18
- package/dist/models/NotificationHistoryBadRequestResponse.js +0 -28
- package/dist/models/NotificationHistoryBadRequestResponse.js.map +0 -1
- package/models/CreateSegmentBadRequestResponse.ts +0 -38
- package/models/DeleteSegmentBadRequestResponse.ts +0 -31
- package/models/FilterNotificationTarget.ts +0 -144
- package/models/IdentifyUserConflictResponse.ts +0 -32
- package/models/NotificationHistoryBadRequestResponse.ts +0 -38
package/models/Player.ts
CHANGED
package/models/PlayerSlice.ts
CHANGED
package/models/Purchase.ts
CHANGED
|
@@ -2,14 +2,15 @@
|
|
|
2
2
|
* OneSignal
|
|
3
3
|
* A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com
|
|
4
4
|
*
|
|
5
|
-
* API Version: 1.2.
|
|
5
|
+
* API Version: 1.2.2
|
|
6
6
|
* Contact: devrel@onesignal.com
|
|
7
7
|
*/
|
|
8
8
|
|
|
9
|
+
import { GenericErrorErrorsInner } from './GenericErrorErrorsInner';
|
|
9
10
|
import { HttpFile } from '../http/http';
|
|
10
11
|
|
|
11
|
-
export class
|
|
12
|
-
'errors'?: Array<
|
|
12
|
+
export class RateLimiterError {
|
|
13
|
+
'errors'?: Array<GenericErrorErrorsInner>;
|
|
13
14
|
|
|
14
15
|
static readonly discriminator: string | undefined = undefined;
|
|
15
16
|
|
|
@@ -17,12 +18,12 @@ export class BadRequestError {
|
|
|
17
18
|
{
|
|
18
19
|
"name": "errors",
|
|
19
20
|
"baseName": "errors",
|
|
20
|
-
"type": "Array<
|
|
21
|
+
"type": "Array<GenericErrorErrorsInner>",
|
|
21
22
|
"format": ""
|
|
22
23
|
} ];
|
|
23
24
|
|
|
24
25
|
static getAttributeTypeMap() {
|
|
25
|
-
return
|
|
26
|
+
return RateLimiterError.attributeTypeMap;
|
|
26
27
|
}
|
|
27
28
|
|
|
28
29
|
public constructor() {
|
package/models/Segment.ts
CHANGED
package/models/StringMap.ts
CHANGED
package/models/User.ts
CHANGED
package/models/all.ts
CHANGED
|
@@ -1,5 +1,4 @@
|
|
|
1
1
|
export * from './App'
|
|
2
|
-
export * from './BadRequestError'
|
|
3
2
|
export * from './BasicNotification'
|
|
4
3
|
export * from './BasicNotificationAllOf'
|
|
5
4
|
export * from './BasicNotificationAllOfAndroidBackgroundLayout'
|
|
@@ -19,13 +18,14 @@ export * from './DeletePlayerSuccessResponse'
|
|
|
19
18
|
export * from './DeleteSegmentNotFoundResponse'
|
|
20
19
|
export * from './DeleteSegmentSuccessResponse'
|
|
21
20
|
export * from './DeliveryData'
|
|
21
|
+
export * from './ExportEventsSuccessResponse'
|
|
22
22
|
export * from './ExportPlayersRequestBody'
|
|
23
23
|
export * from './ExportPlayersSuccessResponse'
|
|
24
24
|
export * from './Filter'
|
|
25
25
|
export * from './FilterExpressions'
|
|
26
|
+
export * from './GenericError'
|
|
27
|
+
export * from './GenericErrorErrorsInner'
|
|
26
28
|
export * from './GetNotificationRequestBody'
|
|
27
|
-
export * from './IdentifyUserConflictResponse'
|
|
28
|
-
export * from './IdentifyUserConflictResponseErrorsInner'
|
|
29
29
|
export * from './InlineResponse200'
|
|
30
30
|
export * from './InlineResponse2003'
|
|
31
31
|
export * from './InlineResponse201'
|
|
@@ -52,6 +52,7 @@ export * from './PlayerSlice'
|
|
|
52
52
|
export * from './PropertiesDeltas'
|
|
53
53
|
export * from './PropertiesObject'
|
|
54
54
|
export * from './Purchase'
|
|
55
|
+
export * from './RateLimiterError'
|
|
55
56
|
export * from './Segment'
|
|
56
57
|
export * from './SegmentNotificationTarget'
|
|
57
58
|
export * from './StringMap'
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@onesignal/node-onesignal",
|
|
3
|
-
"version": "2.0.1-
|
|
3
|
+
"version": "2.0.1-beta2",
|
|
4
4
|
"description": "OpenAPI client for @onesignal/node-onesignal",
|
|
5
5
|
"author": "OpenAPI-Generator Contributors",
|
|
6
6
|
"keywords": [
|
|
@@ -21,7 +21,7 @@
|
|
|
21
21
|
"prepare": "npm run build"
|
|
22
22
|
},
|
|
23
23
|
"dependencies": {
|
|
24
|
-
"@types/node": "^20.4.
|
|
24
|
+
"@types/node": "^20.4.5",
|
|
25
25
|
"@types/node-fetch": "^2.5.7",
|
|
26
26
|
"btoa": "^1.2.1",
|
|
27
27
|
"es6-promise": "^4.2.4",
|
package/types/ObjectParamAPI.ts
CHANGED
|
@@ -3,7 +3,6 @@ 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';
|
|
@@ -23,13 +22,14 @@ import { DeletePlayerSuccessResponse } from '../models/DeletePlayerSuccessRespon
|
|
|
23
22
|
import { DeleteSegmentNotFoundResponse } from '../models/DeleteSegmentNotFoundResponse';
|
|
24
23
|
import { DeleteSegmentSuccessResponse } from '../models/DeleteSegmentSuccessResponse';
|
|
25
24
|
import { DeliveryData } from '../models/DeliveryData';
|
|
25
|
+
import { ExportEventsSuccessResponse } from '../models/ExportEventsSuccessResponse';
|
|
26
26
|
import { ExportPlayersRequestBody } from '../models/ExportPlayersRequestBody';
|
|
27
27
|
import { ExportPlayersSuccessResponse } from '../models/ExportPlayersSuccessResponse';
|
|
28
28
|
import { Filter } from '../models/Filter';
|
|
29
29
|
import { FilterExpressions } from '../models/FilterExpressions';
|
|
30
|
+
import { GenericError } from '../models/GenericError';
|
|
31
|
+
import { GenericErrorErrorsInner } from '../models/GenericErrorErrorsInner';
|
|
30
32
|
import { GetNotificationRequestBody } from '../models/GetNotificationRequestBody';
|
|
31
|
-
import { IdentifyUserConflictResponse } from '../models/IdentifyUserConflictResponse';
|
|
32
|
-
import { IdentifyUserConflictResponseErrorsInner } from '../models/IdentifyUserConflictResponseErrorsInner';
|
|
33
33
|
import { InlineResponse200 } from '../models/InlineResponse200';
|
|
34
34
|
import { InlineResponse2003 } from '../models/InlineResponse2003';
|
|
35
35
|
import { InlineResponse201 } from '../models/InlineResponse201';
|
|
@@ -56,6 +56,7 @@ import { PlayerSlice } from '../models/PlayerSlice';
|
|
|
56
56
|
import { PropertiesDeltas } from '../models/PropertiesDeltas';
|
|
57
57
|
import { PropertiesObject } from '../models/PropertiesObject';
|
|
58
58
|
import { Purchase } from '../models/Purchase';
|
|
59
|
+
import { RateLimiterError } from '../models/RateLimiterError';
|
|
59
60
|
import { Segment } from '../models/Segment';
|
|
60
61
|
import { SegmentNotificationTarget } from '../models/SegmentNotificationTarget';
|
|
61
62
|
import { StringMap } from '../models/StringMap';
|
|
@@ -310,6 +311,21 @@ export interface DefaultApiEndLiveActivityRequest {
|
|
|
310
311
|
subscriptionId: string
|
|
311
312
|
}
|
|
312
313
|
|
|
314
|
+
export interface DefaultApiExportEventsRequest {
|
|
315
|
+
/**
|
|
316
|
+
* The ID of the notification to export events from.
|
|
317
|
+
* @type string
|
|
318
|
+
* @memberof DefaultApiexportEvents
|
|
319
|
+
*/
|
|
320
|
+
notificationId: string
|
|
321
|
+
/**
|
|
322
|
+
* The ID of the app that the notification belongs to.
|
|
323
|
+
* @type string
|
|
324
|
+
* @memberof DefaultApiexportEvents
|
|
325
|
+
*/
|
|
326
|
+
appId: string
|
|
327
|
+
}
|
|
328
|
+
|
|
313
329
|
export interface DefaultApiExportPlayersRequest {
|
|
314
330
|
/**
|
|
315
331
|
* The app ID that you want to export devices from
|
|
@@ -864,9 +880,18 @@ export class ObjectDefaultApi {
|
|
|
864
880
|
return this.api.endLiveActivity(param.appId, param.activityId, param.subscriptionId, options).toPromise();
|
|
865
881
|
}
|
|
866
882
|
|
|
883
|
+
/**
|
|
884
|
+
* 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.
|
|
885
|
+
* Export CSV of Events
|
|
886
|
+
* @param param the request object
|
|
887
|
+
*/
|
|
888
|
+
public exportEvents(param: DefaultApiExportEventsRequest, options?: Configuration): Promise<ExportEventsSuccessResponse> {
|
|
889
|
+
return this.api.exportEvents(param.notificationId, param.appId, options).toPromise();
|
|
890
|
+
}
|
|
891
|
+
|
|
867
892
|
/**
|
|
868
893
|
* 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
|
|
894
|
+
* Export CSV of Players
|
|
870
895
|
* @param param the request object
|
|
871
896
|
*/
|
|
872
897
|
public exportPlayers(param: DefaultApiExportPlayersRequest, options?: Configuration): Promise<ExportPlayersSuccessResponse> {
|
package/types/ObservableAPI.ts
CHANGED
|
@@ -4,7 +4,6 @@ import { Configuration} from '../configuration'
|
|
|
4
4
|
import { Observable, of, from } from '../rxjsStub';
|
|
5
5
|
import {mergeMap, map} from '../rxjsStub';
|
|
6
6
|
import { App } from '../models/App';
|
|
7
|
-
import { BadRequestError } from '../models/BadRequestError';
|
|
8
7
|
import { BasicNotification } from '../models/BasicNotification';
|
|
9
8
|
import { BasicNotificationAllOf } from '../models/BasicNotificationAllOf';
|
|
10
9
|
import { BasicNotificationAllOfAndroidBackgroundLayout } from '../models/BasicNotificationAllOfAndroidBackgroundLayout';
|
|
@@ -24,13 +23,14 @@ import { DeletePlayerSuccessResponse } from '../models/DeletePlayerSuccessRespon
|
|
|
24
23
|
import { DeleteSegmentNotFoundResponse } from '../models/DeleteSegmentNotFoundResponse';
|
|
25
24
|
import { DeleteSegmentSuccessResponse } from '../models/DeleteSegmentSuccessResponse';
|
|
26
25
|
import { DeliveryData } from '../models/DeliveryData';
|
|
26
|
+
import { ExportEventsSuccessResponse } from '../models/ExportEventsSuccessResponse';
|
|
27
27
|
import { ExportPlayersRequestBody } from '../models/ExportPlayersRequestBody';
|
|
28
28
|
import { ExportPlayersSuccessResponse } from '../models/ExportPlayersSuccessResponse';
|
|
29
29
|
import { Filter } from '../models/Filter';
|
|
30
30
|
import { FilterExpressions } from '../models/FilterExpressions';
|
|
31
|
+
import { GenericError } from '../models/GenericError';
|
|
32
|
+
import { GenericErrorErrorsInner } from '../models/GenericErrorErrorsInner';
|
|
31
33
|
import { GetNotificationRequestBody } from '../models/GetNotificationRequestBody';
|
|
32
|
-
import { IdentifyUserConflictResponse } from '../models/IdentifyUserConflictResponse';
|
|
33
|
-
import { IdentifyUserConflictResponseErrorsInner } from '../models/IdentifyUserConflictResponseErrorsInner';
|
|
34
34
|
import { InlineResponse200 } from '../models/InlineResponse200';
|
|
35
35
|
import { InlineResponse2003 } from '../models/InlineResponse2003';
|
|
36
36
|
import { InlineResponse201 } from '../models/InlineResponse201';
|
|
@@ -57,6 +57,7 @@ import { PlayerSlice } from '../models/PlayerSlice';
|
|
|
57
57
|
import { PropertiesDeltas } from '../models/PropertiesDeltas';
|
|
58
58
|
import { PropertiesObject } from '../models/PropertiesObject';
|
|
59
59
|
import { Purchase } from '../models/Purchase';
|
|
60
|
+
import { RateLimiterError } from '../models/RateLimiterError';
|
|
60
61
|
import { Segment } from '../models/Segment';
|
|
61
62
|
import { SegmentNotificationTarget } from '../models/SegmentNotificationTarget';
|
|
62
63
|
import { StringMap } from '../models/StringMap';
|
|
@@ -439,9 +440,34 @@ export class ObservableDefaultApi {
|
|
|
439
440
|
}));
|
|
440
441
|
}
|
|
441
442
|
|
|
443
|
+
/**
|
|
444
|
+
* 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.
|
|
445
|
+
* Export CSV of Events
|
|
446
|
+
* @param notificationId The ID of the notification to export events from.
|
|
447
|
+
* @param appId The ID of the app that the notification belongs to.
|
|
448
|
+
*/
|
|
449
|
+
public exportEvents(notificationId: string, appId: string, _options?: Configuration): Observable<ExportEventsSuccessResponse> {
|
|
450
|
+
const requestContextPromise = this.requestFactory.exportEvents(notificationId, appId, _options);
|
|
451
|
+
|
|
452
|
+
// build promise chain
|
|
453
|
+
let middlewarePreObservable = from<RequestContext>(requestContextPromise);
|
|
454
|
+
for (let middleware of this.configuration.middleware) {
|
|
455
|
+
middlewarePreObservable = middlewarePreObservable.pipe(mergeMap((ctx: RequestContext) => middleware.pre(ctx)));
|
|
456
|
+
}
|
|
457
|
+
|
|
458
|
+
return middlewarePreObservable.pipe(mergeMap((ctx: RequestContext) => this.configuration.httpApi.send(ctx))).
|
|
459
|
+
pipe(mergeMap((response: ResponseContext) => {
|
|
460
|
+
let middlewarePostObservable = of(response);
|
|
461
|
+
for (let middleware of this.configuration.middleware) {
|
|
462
|
+
middlewarePostObservable = middlewarePostObservable.pipe(mergeMap((rsp: ResponseContext) => middleware.post(rsp)));
|
|
463
|
+
}
|
|
464
|
+
return middlewarePostObservable.pipe(map((rsp: ResponseContext) => this.responseProcessor.exportEvents(rsp)));
|
|
465
|
+
}));
|
|
466
|
+
}
|
|
467
|
+
|
|
442
468
|
/**
|
|
443
469
|
* 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. |
|
|
444
|
-
* CSV
|
|
470
|
+
* Export CSV of Players
|
|
445
471
|
* @param appId The app ID that you want to export devices from
|
|
446
472
|
* @param exportPlayersRequestBody
|
|
447
473
|
*/
|
package/types/PromiseAPI.ts
CHANGED
|
@@ -3,7 +3,6 @@ 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';
|
|
@@ -23,13 +22,14 @@ import { DeletePlayerSuccessResponse } from '../models/DeletePlayerSuccessRespon
|
|
|
23
22
|
import { DeleteSegmentNotFoundResponse } from '../models/DeleteSegmentNotFoundResponse';
|
|
24
23
|
import { DeleteSegmentSuccessResponse } from '../models/DeleteSegmentSuccessResponse';
|
|
25
24
|
import { DeliveryData } from '../models/DeliveryData';
|
|
25
|
+
import { ExportEventsSuccessResponse } from '../models/ExportEventsSuccessResponse';
|
|
26
26
|
import { ExportPlayersRequestBody } from '../models/ExportPlayersRequestBody';
|
|
27
27
|
import { ExportPlayersSuccessResponse } from '../models/ExportPlayersSuccessResponse';
|
|
28
28
|
import { Filter } from '../models/Filter';
|
|
29
29
|
import { FilterExpressions } from '../models/FilterExpressions';
|
|
30
|
+
import { GenericError } from '../models/GenericError';
|
|
31
|
+
import { GenericErrorErrorsInner } from '../models/GenericErrorErrorsInner';
|
|
30
32
|
import { GetNotificationRequestBody } from '../models/GetNotificationRequestBody';
|
|
31
|
-
import { IdentifyUserConflictResponse } from '../models/IdentifyUserConflictResponse';
|
|
32
|
-
import { IdentifyUserConflictResponseErrorsInner } from '../models/IdentifyUserConflictResponseErrorsInner';
|
|
33
33
|
import { InlineResponse200 } from '../models/InlineResponse200';
|
|
34
34
|
import { InlineResponse2003 } from '../models/InlineResponse2003';
|
|
35
35
|
import { InlineResponse201 } from '../models/InlineResponse201';
|
|
@@ -56,6 +56,7 @@ import { PlayerSlice } from '../models/PlayerSlice';
|
|
|
56
56
|
import { PropertiesDeltas } from '../models/PropertiesDeltas';
|
|
57
57
|
import { PropertiesObject } from '../models/PropertiesObject';
|
|
58
58
|
import { Purchase } from '../models/Purchase';
|
|
59
|
+
import { RateLimiterError } from '../models/RateLimiterError';
|
|
59
60
|
import { Segment } from '../models/Segment';
|
|
60
61
|
import { SegmentNotificationTarget } from '../models/SegmentNotificationTarget';
|
|
61
62
|
import { StringMap } from '../models/StringMap';
|
|
@@ -239,9 +240,20 @@ export class PromiseDefaultApi {
|
|
|
239
240
|
return result.toPromise();
|
|
240
241
|
}
|
|
241
242
|
|
|
243
|
+
/**
|
|
244
|
+
* 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.
|
|
245
|
+
* Export CSV of Events
|
|
246
|
+
* @param notificationId The ID of the notification to export events from.
|
|
247
|
+
* @param appId The ID of the app that the notification belongs to.
|
|
248
|
+
*/
|
|
249
|
+
public exportEvents(notificationId: string, appId: string, _options?: Configuration): Promise<ExportEventsSuccessResponse> {
|
|
250
|
+
const result = this.api.exportEvents(notificationId, appId, _options);
|
|
251
|
+
return result.toPromise();
|
|
252
|
+
}
|
|
253
|
+
|
|
242
254
|
/**
|
|
243
255
|
* 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. |
|
|
244
|
-
* CSV
|
|
256
|
+
* Export CSV of Players
|
|
245
257
|
* @param appId The app ID that you want to export devices from
|
|
246
258
|
* @param exportPlayersRequestBody
|
|
247
259
|
*/
|
|
@@ -1,22 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.BadRequestError = void 0;
|
|
4
|
-
var BadRequestError = (function () {
|
|
5
|
-
function BadRequestError() {
|
|
6
|
-
}
|
|
7
|
-
BadRequestError.getAttributeTypeMap = function () {
|
|
8
|
-
return BadRequestError.attributeTypeMap;
|
|
9
|
-
};
|
|
10
|
-
BadRequestError.discriminator = undefined;
|
|
11
|
-
BadRequestError.attributeTypeMap = [
|
|
12
|
-
{
|
|
13
|
-
"name": "errors",
|
|
14
|
-
"baseName": "errors",
|
|
15
|
-
"type": "Array<string>",
|
|
16
|
-
"format": ""
|
|
17
|
-
}
|
|
18
|
-
];
|
|
19
|
-
return BadRequestError;
|
|
20
|
-
}());
|
|
21
|
-
exports.BadRequestError = BadRequestError;
|
|
22
|
-
//# sourceMappingURL=BadRequestError.js.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"BadRequestError.js","sourceRoot":"","sources":["../../models/BadRequestError.ts"],"names":[],"mappings":";;;AAUA;IAiBI;IACA,CAAC;IALM,mCAAmB,GAA1B;QACI,OAAO,eAAe,CAAC,gBAAgB,CAAC;IAC5C,CAAC;IAZe,6BAAa,GAAuB,SAAS,CAAC;IAE9C,gCAAgB,GAA0E;QACtG;YACI,MAAM,EAAE,QAAQ;YAChB,UAAU,EAAE,QAAQ;YACpB,MAAM,EAAE,eAAe;YACvB,QAAQ,EAAE,EAAE;SACf;KAAK,CAAC;IAQf,sBAAC;CAAA,AAnBD,IAmBC;AAnBY,0CAAe"}
|
|
@@ -1,17 +0,0 @@
|
|
|
1
|
-
export declare class CreateNotificationBadRequestResponse {
|
|
2
|
-
'errors'?: Array<string>;
|
|
3
|
-
static readonly discriminator: string | undefined;
|
|
4
|
-
static readonly attributeTypeMap: Array<{
|
|
5
|
-
name: string;
|
|
6
|
-
baseName: string;
|
|
7
|
-
type: string;
|
|
8
|
-
format: string;
|
|
9
|
-
}>;
|
|
10
|
-
static getAttributeTypeMap(): {
|
|
11
|
-
name: string;
|
|
12
|
-
baseName: string;
|
|
13
|
-
type: string;
|
|
14
|
-
format: string;
|
|
15
|
-
}[];
|
|
16
|
-
constructor();
|
|
17
|
-
}
|
|
@@ -1,22 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.CreateNotificationBadRequestResponse = void 0;
|
|
4
|
-
var CreateNotificationBadRequestResponse = (function () {
|
|
5
|
-
function CreateNotificationBadRequestResponse() {
|
|
6
|
-
}
|
|
7
|
-
CreateNotificationBadRequestResponse.getAttributeTypeMap = function () {
|
|
8
|
-
return CreateNotificationBadRequestResponse.attributeTypeMap;
|
|
9
|
-
};
|
|
10
|
-
CreateNotificationBadRequestResponse.discriminator = undefined;
|
|
11
|
-
CreateNotificationBadRequestResponse.attributeTypeMap = [
|
|
12
|
-
{
|
|
13
|
-
"name": "errors",
|
|
14
|
-
"baseName": "errors",
|
|
15
|
-
"type": "Array<string>",
|
|
16
|
-
"format": ""
|
|
17
|
-
}
|
|
18
|
-
];
|
|
19
|
-
return CreateNotificationBadRequestResponse;
|
|
20
|
-
}());
|
|
21
|
-
exports.CreateNotificationBadRequestResponse = CreateNotificationBadRequestResponse;
|
|
22
|
-
//# sourceMappingURL=CreateNotificationBadRequestResponse.js.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"CreateNotificationBadRequestResponse.js","sourceRoot":"","sources":["../../models/CreateNotificationBadRequestResponse.ts"],"names":[],"mappings":";;;AAUA;IAiBI;IACA,CAAC;IALM,wDAAmB,GAA1B;QACI,OAAO,oCAAoC,CAAC,gBAAgB,CAAC;IACjE,CAAC;IAZe,kDAAa,GAAuB,SAAS,CAAC;IAE9C,qDAAgB,GAA0E;QACtG;YACI,MAAM,EAAE,QAAQ;YAChB,UAAU,EAAE,QAAQ;YACpB,MAAM,EAAE,eAAe;YACvB,QAAQ,EAAE,EAAE;SACf;KAAK,CAAC;IAQf,2CAAC;CAAA,AAnBD,IAmBC;AAnBY,oFAAoC"}
|