@onesignal/node-onesignal 1.0.0-beta4 → 1.0.0-beta5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (234) hide show
  1. package/.github/ISSUE_TEMPLATE/ask-question.yml +25 -0
  2. package/.github/ISSUE_TEMPLATE/bug-report.yml +51 -0
  3. package/.github/ISSUE_TEMPLATE/general-feedback.yml +25 -0
  4. package/.github/pull_request_template.md +44 -0
  5. package/.github/workflows/npm_deploy.yml +21 -0
  6. package/CHANGELOG.md +26 -0
  7. package/DefaultApi.md +1232 -0
  8. package/LICENSE +24 -0
  9. package/README.md +205 -102
  10. package/RELEASE_INSTRUCTIONS.md +2 -0
  11. package/apis/DefaultApi.ts +519 -532
  12. package/apis/baseapi.ts +4 -4
  13. package/apis/exception.ts +4 -3
  14. package/auth/auth.ts +4 -1
  15. package/configuration.ts +21 -2
  16. package/http/http.ts +26 -26
  17. package/index.ts +1 -0
  18. package/middleware.ts +1 -1
  19. package/models/App.ts +8 -8
  20. package/models/BasicNotification.ts +1019 -0
  21. package/models/BasicNotificationAllOf.ts +897 -0
  22. package/models/{NotificationAllOfAndroidBackgroundLayout.ts → BasicNotificationAllOfAndroidBackgroundLayout.ts} +4 -4
  23. package/models/Button.ts +2 -2
  24. package/models/CancelNotificationSuccessResponse.ts +31 -0
  25. package/models/{InlineResponse400.ts → CreateNotificationBadRequestResponse.ts} +4 -4
  26. package/models/{InlineResponse200.ts → CreateNotificationSuccessResponse.ts} +7 -6
  27. package/models/{InlineResponse2004.ts → CreatePlayerSuccessResponse.ts} +4 -4
  28. package/models/CreateSegmentBadRequestResponse.ts +38 -0
  29. package/models/{InlineResponse409.ts → CreateSegmentConflictResponse.ts} +4 -4
  30. package/models/{InlineResponse201.ts → CreateSegmentSuccessResponse.ts} +4 -4
  31. package/models/DeletePlayerBadRequestResponse.ts +31 -0
  32. package/models/DeletePlayerNotFoundResponse.ts +31 -0
  33. package/models/{InlineResponse2003.ts → DeletePlayerSuccessResponse.ts} +4 -4
  34. package/models/{InlineResponse4002.ts → DeleteSegmentBadRequestResponse.ts} +4 -4
  35. package/models/DeleteSegmentNotFoundResponse.ts +31 -0
  36. package/models/DeleteSegmentSuccessResponse.ts +31 -0
  37. package/models/DeliveryData.ts +17 -2
  38. package/models/ExportPlayersRequestBody.ts +5 -5
  39. package/models/{InlineResponse2005.ts → ExportPlayersSuccessResponse.ts} +4 -4
  40. package/models/Filter.ts +4 -4
  41. package/models/FilterExpressions.ts +4 -4
  42. package/models/FilterNotificationTarget.ts +2 -2
  43. package/models/GetNotificationRequestBody.ts +2 -2
  44. package/models/InvalidIdentifierError.ts +44 -0
  45. package/models/Notification.ts +72 -174
  46. package/models/Notification200Errors.ts +45 -0
  47. package/models/NotificationAllOf.ts +3 -858
  48. package/models/{InlineResponse4001.ts → NotificationHistoryBadRequestResponse.ts} +4 -4
  49. package/models/{InlineResponse2002.ts → NotificationHistorySuccessResponse.ts} +6 -6
  50. package/models/NotificationSlice.ts +5 -5
  51. package/models/NotificationTarget.ts +3 -124
  52. package/models/NotificationWithMeta.ts +1127 -0
  53. package/models/NotificationWithMetaAllOf.ts +132 -0
  54. package/models/ObjectSerializer.ts +97 -46
  55. package/models/Operator.ts +2 -2
  56. package/models/OutcomeData.ts +2 -2
  57. package/models/OutcomesData.ts +32 -0
  58. package/models/PlatformDeliveryData.ts +18 -2
  59. package/models/PlatformDeliveryDataEmailAllOf.ts +94 -0
  60. package/models/PlatformDeliveryDataSmsAllOf.ts +54 -0
  61. package/models/Player.ts +14 -14
  62. package/models/PlayerNotificationTarget.ts +3 -3
  63. package/models/PlayerSlice.ts +2 -2
  64. package/models/Purchase.ts +2 -2
  65. package/models/Segment.ts +3 -3
  66. package/models/SegmentNotificationTarget.ts +2 -2
  67. package/models/StringMap.ts +3 -3
  68. package/models/{InlineResponse2001.ts → UpdatePlayerSuccessResponse.ts} +6 -6
  69. package/models/UpdatePlayerTagsRequestBody.ts +4 -4
  70. package/models/UpdatePlayerTagsSuccessResponse.ts +31 -0
  71. package/models/all.ts +28 -13
  72. package/package.json +14 -9
  73. package/tsconfig.json +1 -2
  74. package/types/ObjectParamAPI.ts +101 -86
  75. package/types/ObservableAPI.ts +116 -101
  76. package/types/PromiseAPI.ts +97 -82
  77. package/util.ts +10 -1
  78. package/dist/apis/DefaultApi.d.ts +0 -62
  79. package/dist/apis/DefaultApi.js +0 -1317
  80. package/dist/apis/DefaultApi.js.map +0 -1
  81. package/dist/apis/baseapi.d.ts +0 -16
  82. package/dist/apis/baseapi.js +0 -42
  83. package/dist/apis/baseapi.js.map +0 -1
  84. package/dist/apis/exception.d.ts +0 -5
  85. package/dist/apis/exception.js +0 -28
  86. package/dist/apis/exception.js.map +0 -1
  87. package/dist/auth/auth.d.ts +0 -40
  88. package/dist/auth/auth.js +0 -108
  89. package/dist/auth/auth.js.map +0 -1
  90. package/dist/configuration.d.ts +0 -18
  91. package/dist/configuration.js +0 -21
  92. package/dist/configuration.js.map +0 -1
  93. package/dist/http/http.d.ts +0 -72
  94. package/dist/http/http.js +0 -205
  95. package/dist/http/http.js.map +0 -1
  96. package/dist/http/isomorphic-fetch.d.ts +0 -5
  97. package/dist/http/isomorphic-fetch.js +0 -33
  98. package/dist/http/isomorphic-fetch.js.map +0 -1
  99. package/dist/index.d.ts +0 -9
  100. package/dist/index.js +0 -22
  101. package/dist/index.js.map +0 -1
  102. package/dist/middleware.d.ts +0 -16
  103. package/dist/middleware.js +0 -18
  104. package/dist/middleware.js.map +0 -1
  105. package/dist/models/App.d.ts +0 -47
  106. package/dist/models/App.js +0 -196
  107. package/dist/models/App.js.map +0 -1
  108. package/dist/models/Button.d.ts +0 -19
  109. package/dist/models/Button.js +0 -34
  110. package/dist/models/Button.js.map +0 -1
  111. package/dist/models/DeliveryData.d.ts +0 -21
  112. package/dist/models/DeliveryData.js +0 -46
  113. package/dist/models/DeliveryData.js.map +0 -1
  114. package/dist/models/ExportPlayersRequestBody.d.ts +0 -19
  115. package/dist/models/ExportPlayersRequestBody.js +0 -34
  116. package/dist/models/ExportPlayersRequestBody.js.map +0 -1
  117. package/dist/models/Filter.d.ts +0 -21
  118. package/dist/models/Filter.js +0 -40
  119. package/dist/models/Filter.js.map +0 -1
  120. package/dist/models/FilterExpressions.d.ts +0 -23
  121. package/dist/models/FilterExpressions.js +0 -46
  122. package/dist/models/FilterExpressions.js.map +0 -1
  123. package/dist/models/FilterNotificationTarget.d.ts +0 -28
  124. package/dist/models/FilterNotificationTarget.js +0 -88
  125. package/dist/models/FilterNotificationTarget.js.map +0 -1
  126. package/dist/models/GetNotificationRequestBody.d.ts +0 -20
  127. package/dist/models/GetNotificationRequestBody.js +0 -34
  128. package/dist/models/GetNotificationRequestBody.js.map +0 -1
  129. package/dist/models/InlineResponse200.d.ts +0 -20
  130. package/dist/models/InlineResponse200.js +0 -40
  131. package/dist/models/InlineResponse200.js.map +0 -1
  132. package/dist/models/InlineResponse2001.d.ts +0 -17
  133. package/dist/models/InlineResponse2001.js +0 -22
  134. package/dist/models/InlineResponse2001.js.map +0 -1
  135. package/dist/models/InlineResponse2002.d.ts +0 -18
  136. package/dist/models/InlineResponse2002.js +0 -28
  137. package/dist/models/InlineResponse2002.js.map +0 -1
  138. package/dist/models/InlineResponse2003.d.ts +0 -17
  139. package/dist/models/InlineResponse2003.js +0 -22
  140. package/dist/models/InlineResponse2003.js.map +0 -1
  141. package/dist/models/InlineResponse2004.d.ts +0 -18
  142. package/dist/models/InlineResponse2004.js +0 -28
  143. package/dist/models/InlineResponse2004.js.map +0 -1
  144. package/dist/models/InlineResponse2005.d.ts +0 -17
  145. package/dist/models/InlineResponse2005.js +0 -22
  146. package/dist/models/InlineResponse2005.js.map +0 -1
  147. package/dist/models/InlineResponse201.d.ts +0 -18
  148. package/dist/models/InlineResponse201.js +0 -28
  149. package/dist/models/InlineResponse201.js.map +0 -1
  150. package/dist/models/InlineResponse400.d.ts +0 -17
  151. package/dist/models/InlineResponse400.js +0 -22
  152. package/dist/models/InlineResponse400.js.map +0 -1
  153. package/dist/models/InlineResponse4001.d.ts +0 -18
  154. package/dist/models/InlineResponse4001.js +0 -28
  155. package/dist/models/InlineResponse4001.js.map +0 -1
  156. package/dist/models/InlineResponse4002.d.ts +0 -17
  157. package/dist/models/InlineResponse4002.js +0 -22
  158. package/dist/models/InlineResponse4002.js.map +0 -1
  159. package/dist/models/InlineResponse409.d.ts +0 -18
  160. package/dist/models/InlineResponse409.js +0 -28
  161. package/dist/models/InlineResponse409.js.map +0 -1
  162. package/dist/models/Notification.d.ts +0 -132
  163. package/dist/models/Notification.js +0 -688
  164. package/dist/models/Notification.js.map +0 -1
  165. package/dist/models/NotificationAllOf.d.ts +0 -108
  166. package/dist/models/NotificationAllOf.js +0 -544
  167. package/dist/models/NotificationAllOf.js.map +0 -1
  168. package/dist/models/NotificationAllOfAndroidBackgroundLayout.d.ts +0 -19
  169. package/dist/models/NotificationAllOfAndroidBackgroundLayout.js +0 -34
  170. package/dist/models/NotificationAllOfAndroidBackgroundLayout.js.map +0 -1
  171. package/dist/models/NotificationSlice.d.ts +0 -21
  172. package/dist/models/NotificationSlice.js +0 -40
  173. package/dist/models/NotificationSlice.js.map +0 -1
  174. package/dist/models/NotificationTarget.d.ts +0 -40
  175. package/dist/models/NotificationTarget.js +0 -160
  176. package/dist/models/NotificationTarget.js.map +0 -1
  177. package/dist/models/ObjectSerializer.d.ts +0 -44
  178. package/dist/models/ObjectSerializer.js +0 -312
  179. package/dist/models/ObjectSerializer.js.map +0 -1
  180. package/dist/models/Operator.d.ts +0 -18
  181. package/dist/models/Operator.js +0 -22
  182. package/dist/models/Operator.js.map +0 -1
  183. package/dist/models/OutcomeData.d.ts +0 -20
  184. package/dist/models/OutcomeData.js +0 -34
  185. package/dist/models/OutcomeData.js.map +0 -1
  186. package/dist/models/PlatformDeliveryData.d.ts +0 -23
  187. package/dist/models/PlatformDeliveryData.js +0 -52
  188. package/dist/models/PlatformDeliveryData.js.map +0 -1
  189. package/dist/models/Player.d.ts +0 -43
  190. package/dist/models/Player.js +0 -178
  191. package/dist/models/Player.js.map +0 -1
  192. package/dist/models/PlayerNotificationTarget.d.ts +0 -26
  193. package/dist/models/PlayerNotificationTarget.js +0 -76
  194. package/dist/models/PlayerNotificationTarget.js.map +0 -1
  195. package/dist/models/PlayerSlice.d.ts +0 -21
  196. package/dist/models/PlayerSlice.js +0 -40
  197. package/dist/models/PlayerSlice.js.map +0 -1
  198. package/dist/models/Purchase.d.ts +0 -19
  199. package/dist/models/Purchase.js +0 -34
  200. package/dist/models/Purchase.js.map +0 -1
  201. package/dist/models/Segment.d.ts +0 -20
  202. package/dist/models/Segment.js +0 -34
  203. package/dist/models/Segment.js.map +0 -1
  204. package/dist/models/SegmentNotificationTarget.d.ts +0 -18
  205. package/dist/models/SegmentNotificationTarget.js +0 -28
  206. package/dist/models/SegmentNotificationTarget.js.map +0 -1
  207. package/dist/models/StringMap.d.ts +0 -59
  208. package/dist/models/StringMap.js +0 -274
  209. package/dist/models/StringMap.js.map +0 -1
  210. package/dist/models/UpdatePlayerTagsRequestBody.d.ts +0 -17
  211. package/dist/models/UpdatePlayerTagsRequestBody.js +0 -22
  212. package/dist/models/UpdatePlayerTagsRequestBody.js.map +0 -1
  213. package/dist/models/all.d.ts +0 -35
  214. package/dist/models/all.js +0 -48
  215. package/dist/models/all.js.map +0 -1
  216. package/dist/rxjsStub.d.ts +0 -10
  217. package/dist/rxjsStub.js +0 -33
  218. package/dist/rxjsStub.js.map +0 -1
  219. package/dist/servers.d.ts +0 -17
  220. package/dist/servers.js +0 -32
  221. package/dist/servers.js.map +0 -1
  222. package/dist/types/ObjectParamAPI.d.ts +0 -121
  223. package/dist/types/ObjectParamAPI.js +0 -69
  224. package/dist/types/ObjectParamAPI.js.map +0 -1
  225. package/dist/types/ObservableAPI.d.ts +0 -45
  226. package/dist/types/ObservableAPI.js +0 -472
  227. package/dist/types/ObservableAPI.js.map +0 -1
  228. package/dist/types/PromiseAPI.d.ts +0 -42
  229. package/dist/types/PromiseAPI.js +0 -88
  230. package/dist/types/PromiseAPI.js.map +0 -1
  231. package/dist/util.d.ts +0 -1
  232. package/dist/util.js +0 -25
  233. package/dist/util.js.map +0 -1
  234. package/git_push.sh +0 -52
@@ -4,32 +4,45 @@ 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 { BasicNotification } from '../models/BasicNotification';
8
+ import { BasicNotificationAllOf } from '../models/BasicNotificationAllOf';
9
+ import { BasicNotificationAllOfAndroidBackgroundLayout } from '../models/BasicNotificationAllOfAndroidBackgroundLayout';
7
10
  import { Button } from '../models/Button';
11
+ import { CancelNotificationSuccessResponse } from '../models/CancelNotificationSuccessResponse';
12
+ import { CreateNotificationBadRequestResponse } from '../models/CreateNotificationBadRequestResponse';
13
+ import { CreateNotificationSuccessResponse } from '../models/CreateNotificationSuccessResponse';
14
+ import { CreatePlayerSuccessResponse } from '../models/CreatePlayerSuccessResponse';
15
+ import { CreateSegmentBadRequestResponse } from '../models/CreateSegmentBadRequestResponse';
16
+ import { CreateSegmentConflictResponse } from '../models/CreateSegmentConflictResponse';
17
+ import { CreateSegmentSuccessResponse } from '../models/CreateSegmentSuccessResponse';
18
+ import { DeletePlayerBadRequestResponse } from '../models/DeletePlayerBadRequestResponse';
19
+ import { DeletePlayerNotFoundResponse } from '../models/DeletePlayerNotFoundResponse';
20
+ import { DeletePlayerSuccessResponse } from '../models/DeletePlayerSuccessResponse';
21
+ import { DeleteSegmentBadRequestResponse } from '../models/DeleteSegmentBadRequestResponse';
22
+ import { DeleteSegmentNotFoundResponse } from '../models/DeleteSegmentNotFoundResponse';
23
+ import { DeleteSegmentSuccessResponse } from '../models/DeleteSegmentSuccessResponse';
8
24
  import { DeliveryData } from '../models/DeliveryData';
9
25
  import { ExportPlayersRequestBody } from '../models/ExportPlayersRequestBody';
26
+ import { ExportPlayersSuccessResponse } from '../models/ExportPlayersSuccessResponse';
10
27
  import { Filter } from '../models/Filter';
11
28
  import { FilterExpressions } from '../models/FilterExpressions';
12
- import { FilterNotificationTarget } from '../models/FilterNotificationTarget';
13
29
  import { GetNotificationRequestBody } from '../models/GetNotificationRequestBody';
14
- import { InlineResponse200 } from '../models/InlineResponse200';
15
- import { InlineResponse2001 } from '../models/InlineResponse2001';
16
- import { InlineResponse2002 } from '../models/InlineResponse2002';
17
- import { InlineResponse2003 } from '../models/InlineResponse2003';
18
- import { InlineResponse2004 } from '../models/InlineResponse2004';
19
- import { InlineResponse2005 } from '../models/InlineResponse2005';
20
- import { InlineResponse201 } from '../models/InlineResponse201';
21
- import { InlineResponse400 } from '../models/InlineResponse400';
22
- import { InlineResponse4001 } from '../models/InlineResponse4001';
23
- import { InlineResponse4002 } from '../models/InlineResponse4002';
24
- import { InlineResponse409 } from '../models/InlineResponse409';
30
+ import { InvalidIdentifierError } from '../models/InvalidIdentifierError';
25
31
  import { Notification } from '../models/Notification';
32
+ import { Notification200Errors } from '../models/Notification200Errors';
26
33
  import { NotificationAllOf } from '../models/NotificationAllOf';
27
- import { NotificationAllOfAndroidBackgroundLayout } from '../models/NotificationAllOfAndroidBackgroundLayout';
34
+ import { NotificationHistoryBadRequestResponse } from '../models/NotificationHistoryBadRequestResponse';
35
+ import { NotificationHistorySuccessResponse } from '../models/NotificationHistorySuccessResponse';
28
36
  import { NotificationSlice } from '../models/NotificationSlice';
29
37
  import { NotificationTarget } from '../models/NotificationTarget';
38
+ import { NotificationWithMeta } from '../models/NotificationWithMeta';
39
+ import { NotificationWithMetaAllOf } from '../models/NotificationWithMetaAllOf';
30
40
  import { Operator } from '../models/Operator';
31
41
  import { OutcomeData } from '../models/OutcomeData';
42
+ import { OutcomesData } from '../models/OutcomesData';
32
43
  import { PlatformDeliveryData } from '../models/PlatformDeliveryData';
44
+ import { PlatformDeliveryDataEmailAllOf } from '../models/PlatformDeliveryDataEmailAllOf';
45
+ import { PlatformDeliveryDataSmsAllOf } from '../models/PlatformDeliveryDataSmsAllOf';
33
46
  import { Player } from '../models/Player';
34
47
  import { PlayerNotificationTarget } from '../models/PlayerNotificationTarget';
35
48
  import { PlayerSlice } from '../models/PlayerSlice';
@@ -37,7 +50,9 @@ import { Purchase } from '../models/Purchase';
37
50
  import { Segment } from '../models/Segment';
38
51
  import { SegmentNotificationTarget } from '../models/SegmentNotificationTarget';
39
52
  import { StringMap } from '../models/StringMap';
53
+ import { UpdatePlayerSuccessResponse } from '../models/UpdatePlayerSuccessResponse';
40
54
  import { UpdatePlayerTagsRequestBody } from '../models/UpdatePlayerTagsRequestBody';
55
+ import { UpdatePlayerTagsSuccessResponse } from '../models/UpdatePlayerTagsSuccessResponse';
41
56
 
42
57
  import { DefaultApiRequestFactory, DefaultApiResponseProcessor} from "../apis/DefaultApi";
43
58
  export class ObservableDefaultApi {
@@ -58,11 +73,11 @@ export class ObservableDefaultApi {
58
73
  /**
59
74
  * Used to stop a scheduled or currently outgoing notification
60
75
  * Stop a scheduled or currently outgoing notification
61
- * @param app_id
62
- * @param notification_id
76
+ * @param appId
77
+ * @param notificationId
63
78
  */
64
- public cancelNotification(app_id: string, notification_id: string, _options?: Configuration): Observable<InlineResponse2001> {
65
- const requestContextPromise = this.requestFactory.cancelNotification(app_id, notification_id, _options);
79
+ public cancelNotification(appId: string, notificationId: string, _options?: Configuration): Observable<CancelNotificationSuccessResponse> {
80
+ const requestContextPromise = this.requestFactory.cancelNotification(appId, notificationId, _options);
66
81
 
67
82
  // build promise chain
68
83
  let middlewarePreObservable = from<RequestContext>(requestContextPromise);
@@ -79,7 +94,7 @@ export class ObservableDefaultApi {
79
94
  return middlewarePostObservable.pipe(map((rsp: ResponseContext) => this.responseProcessor.cancelNotification(rsp)));
80
95
  }));
81
96
  }
82
-
97
+
83
98
  /**
84
99
  * Creates a new OneSignal app
85
100
  * Create an app
@@ -103,13 +118,13 @@ export class ObservableDefaultApi {
103
118
  return middlewarePostObservable.pipe(map((rsp: ResponseContext) => this.responseProcessor.createApp(rsp)));
104
119
  }));
105
120
  }
106
-
121
+
107
122
  /**
108
123
  * Sends notifications to your users
109
124
  * Create notification
110
125
  * @param notification
111
126
  */
112
- public createNotification(notification: Notification, _options?: Configuration): Observable<InlineResponse200> {
127
+ public createNotification(notification: Notification, _options?: Configuration): Observable<CreateNotificationSuccessResponse> {
113
128
  const requestContextPromise = this.requestFactory.createNotification(notification, _options);
114
129
 
115
130
  // build promise chain
@@ -127,13 +142,13 @@ export class ObservableDefaultApi {
127
142
  return middlewarePostObservable.pipe(map((rsp: ResponseContext) => this.responseProcessor.createNotification(rsp)));
128
143
  }));
129
144
  }
130
-
145
+
131
146
  /**
132
- * Register a new device to one of your OneSignal apps 🚧 Don't use this This API endpoint is designed to be used from our open source Mobile and Web Push SDKs. It is not designed for developers to use it directly, unless instructed to do so by OneSignal support. If you use this method instead of our SDKs, many OneSignal features such as conversion tracking, timezone tracking, language detection, and rich-push won't work out of the box. It will also make it harder to identify possible setup issues. This method is used to register a new device with OneSignal. If a device is already registered with the specified identifier, then this will update the existing device record instead of creating a new one. The returned player is a player / user ID. Use the returned ID to send push notifications to this specific user later, or to include this player when sending to a set of users. 🚧 iOS Must set test_type to 1 when building your iOS app as development. Omit this field in your production app builds.
147
+ * Register a new device to one of your OneSignal apps &#x1F6A7; Don\'t use this This API endpoint is designed to be used from our open source Mobile and Web Push SDKs. It is not designed for developers to use it directly, unless instructed to do so by OneSignal support. If you use this method instead of our SDKs, many OneSignal features such as conversion tracking, timezone tracking, language detection, and rich-push won\'t work out of the box. It will also make it harder to identify possible setup issues. This method is used to register a new device with OneSignal. If a device is already registered with the specified identifier, then this will update the existing device record instead of creating a new one. The returned player is a player / user ID. Use the returned ID to send push notifications to this specific user later, or to include this player when sending to a set of users. &#x1F6A7; iOS Must set test_type to 1 when building your iOS app as development. Omit this field in your production app builds.
133
148
  * Add a device
134
149
  * @param player
135
150
  */
136
- public createPlayer(player: Player, _options?: Configuration): Observable<InlineResponse2004> {
151
+ public createPlayer(player: Player, _options?: Configuration): Observable<CreatePlayerSuccessResponse> {
137
152
  const requestContextPromise = this.requestFactory.createPlayer(player, _options);
138
153
 
139
154
  // build promise chain
@@ -151,15 +166,15 @@ export class ObservableDefaultApi {
151
166
  return middlewarePostObservable.pipe(map((rsp: ResponseContext) => this.responseProcessor.createPlayer(rsp)));
152
167
  }));
153
168
  }
154
-
169
+
155
170
  /**
156
- * 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.
171
+ * 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. &#x1F6A7; Does Not Update Segments This endpoint will only create segments, it does not edit or update currently created Segments. You will need to use the Delete Segments endpoint and re-create it with this endpoint to edit.
157
172
  * Create Segments
158
- * @param app_id The OneSignal App ID for your app. Available in Keys &amp; IDs.
173
+ * @param appId The OneSignal App ID for your app. Available in Keys &amp; IDs.
159
174
  * @param segment
160
175
  */
161
- public createSegments(app_id: string, segment?: Segment, _options?: Configuration): Observable<InlineResponse201> {
162
- const requestContextPromise = this.requestFactory.createSegments(app_id, segment, _options);
176
+ public createSegments(appId: string, segment?: Segment, _options?: Configuration): Observable<CreateSegmentSuccessResponse> {
177
+ const requestContextPromise = this.requestFactory.createSegments(appId, segment, _options);
163
178
 
164
179
  // build promise chain
165
180
  let middlewarePreObservable = from<RequestContext>(requestContextPromise);
@@ -176,15 +191,15 @@ export class ObservableDefaultApi {
176
191
  return middlewarePostObservable.pipe(map((rsp: ResponseContext) => this.responseProcessor.createSegments(rsp)));
177
192
  }));
178
193
  }
179
-
194
+
180
195
  /**
181
196
  * Delete player - Required: Used to delete a single, specific Player ID record from a specific OneSignal app.
182
197
  * Delete a user record
183
- * @param app_id The OneSignal App ID for your app. Available in Keys &amp; IDs.
184
- * @param player_id The OneSignal player_id
198
+ * @param appId The OneSignal App ID for your app. Available in Keys &amp; IDs.
199
+ * @param playerId The OneSignal player_id
185
200
  */
186
- public deletePlayer(app_id: string, player_id: string, _options?: Configuration): Observable<InlineResponse2001> {
187
- const requestContextPromise = this.requestFactory.deletePlayer(app_id, player_id, _options);
201
+ public deletePlayer(appId: string, playerId: string, _options?: Configuration): Observable<DeletePlayerSuccessResponse> {
202
+ const requestContextPromise = this.requestFactory.deletePlayer(appId, playerId, _options);
188
203
 
189
204
  // build promise chain
190
205
  let middlewarePreObservable = from<RequestContext>(requestContextPromise);
@@ -201,15 +216,15 @@ export class ObservableDefaultApi {
201
216
  return middlewarePostObservable.pipe(map((rsp: ResponseContext) => this.responseProcessor.deletePlayer(rsp)));
202
217
  }));
203
218
  }
204
-
219
+
205
220
  /**
206
221
  * 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.
207
222
  * Delete Segments
208
- * @param app_id The OneSignal App ID for your app. Available in Keys &amp; IDs.
209
- * @param segment_id The segment_id can be found in the URL of the segment when viewing it in the dashboard.
223
+ * @param appId The OneSignal App ID for your app. Available in Keys &amp; IDs.
224
+ * @param segmentId The segment_id can be found in the URL of the segment when viewing it in the dashboard.
210
225
  */
211
- public deleteSegments(app_id: string, segment_id: string, _options?: Configuration): Observable<InlineResponse2003> {
212
- const requestContextPromise = this.requestFactory.deleteSegments(app_id, segment_id, _options);
226
+ public deleteSegments(appId: string, segmentId: string, _options?: Configuration): Observable<DeleteSegmentSuccessResponse> {
227
+ const requestContextPromise = this.requestFactory.deleteSegments(appId, segmentId, _options);
213
228
 
214
229
  // build promise chain
215
230
  let middlewarePreObservable = from<RequestContext>(requestContextPromise);
@@ -226,15 +241,15 @@ export class ObservableDefaultApi {
226
241
  return middlewarePostObservable.pipe(map((rsp: ResponseContext) => this.responseProcessor.deleteSegments(rsp)));
227
242
  }));
228
243
  }
229
-
244
+
230
245
  /**
231
- * 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. |
246
+ * Generate a compressed CSV export of all of your current user data This method can be used to generate a compressed CSV export of all of your current user data. It is a much faster alternative than retrieving this data using the /players API endpoint. The file will be compressed using GZip. The file may take several minutes to generate depending on the number of users in your app. The URL generated will be available for 3 days and includes random v4 uuid as part of the resource name to be unguessable. &#x1F6A7; 403 Error Responses You can test if it is complete by making a GET request to the csv_file_url value. This file may take time to generate depending on how many device records are being pulled. If the file is not ready, a 403 error will be returned. Otherwise the file itself will be returned. &#x1F6A7; Requires Authentication Key Requires your OneSignal App\'s REST API Key, available in Keys & IDs. &#x1F6A7; Concurrent Exports Only one concurrent export is allowed per OneSignal account. Please ensure you have successfully downloaded the .csv.gz file before exporting another app. CSV File Format: - Default Columns: | Field | Details | | --- | --- | | id | OneSignal Player Id | | identifier | Push Token | | session_count | Number of times they visited the app or site | language | Device language code | | timezone | Number of seconds away from UTC. Example: -28800 | | game_version | Version of your mobile app gathered from Android Studio versionCode in your App/build.gradle and iOS uses kCFBundleVersionKey in Xcode. | | device_os | Device Operating System Version. Example: 80 = Chrome 80, 9 = Android 9 | | device_type | Device Operating System Type | | device_model | Device Hardware String Code. Example: Mobile Web Subscribers will have `Linux armv` | | ad_id | Based on the Google Advertising Id for Android, identifierForVendor for iOS. OptedOut means user turned off Advertising tracking on the device. | | tags | Current OneSignal Data Tags on the device. | | last_active | Date and time the user last opened the mobile app or visited the site. | | playtime | Total amount of time in seconds the user had the mobile app open. | | amount_spent | Mobile only - amount spent in USD on In-App Purchases. | | created_at | Date and time the device record was created in OneSignal. Mobile - first time they opened the app with OneSignal SDK. Web - first time the user subscribed to the site. | | invalid_identifier | t = unsubscribed, f = subscibed | | badge_count | Current number of badges on the device | - Extra Columns: | Field | Details | | --- | --- | | external_user_id | Your User Id set on the device | | notification_types | Notification types | | location | Location points (Latitude and Longitude) set on the device. | | country | Country code | | rooted | Android device rooted or not | | ip | IP Address of the device if being tracked. See Handling Personal Data. | | web_auth | Web Only authorization key. | | web_p256 | Web Only p256 key. |
232
247
  * CSV export
233
- * @param app_id The app ID that you want to export devices from
234
- * @param export_players_request_body
248
+ * @param appId The app ID that you want to export devices from
249
+ * @param exportPlayersRequestBody
235
250
  */
236
- public exportPlayers(app_id: string, export_players_request_body?: ExportPlayersRequestBody, _options?: Configuration): Observable<InlineResponse2005> {
237
- const requestContextPromise = this.requestFactory.exportPlayers(app_id, export_players_request_body, _options);
251
+ public exportPlayers(appId: string, exportPlayersRequestBody?: ExportPlayersRequestBody, _options?: Configuration): Observable<ExportPlayersSuccessResponse> {
252
+ const requestContextPromise = this.requestFactory.exportPlayers(appId, exportPlayersRequestBody, _options);
238
253
 
239
254
  // build promise chain
240
255
  let middlewarePreObservable = from<RequestContext>(requestContextPromise);
@@ -251,14 +266,14 @@ export class ObservableDefaultApi {
251
266
  return middlewarePostObservable.pipe(map((rsp: ResponseContext) => this.responseProcessor.exportPlayers(rsp)));
252
267
  }));
253
268
  }
254
-
269
+
255
270
  /**
256
271
  * View the details of a single OneSignal app
257
272
  * View an app
258
- * @param app_id An app id
273
+ * @param appId An app id
259
274
  */
260
- public getApp(app_id: string, _options?: Configuration): Observable<App> {
261
- const requestContextPromise = this.requestFactory.getApp(app_id, _options);
275
+ public getApp(appId: string, _options?: Configuration): Observable<App> {
276
+ const requestContextPromise = this.requestFactory.getApp(appId, _options);
262
277
 
263
278
  // build promise chain
264
279
  let middlewarePreObservable = from<RequestContext>(requestContextPromise);
@@ -275,12 +290,12 @@ export class ObservableDefaultApi {
275
290
  return middlewarePostObservable.pipe(map((rsp: ResponseContext) => this.responseProcessor.getApp(rsp)));
276
291
  }));
277
292
  }
278
-
293
+
279
294
  /**
280
295
  * View the details of all of your current OneSignal apps
281
296
  * View apps
282
297
  */
283
- public getApps(_options?: Configuration): Observable<string> {
298
+ public getApps(_options?: Configuration): Observable<Array<App>> {
284
299
  const requestContextPromise = this.requestFactory.getApps(_options);
285
300
 
286
301
  // build promise chain
@@ -298,15 +313,15 @@ export class ObservableDefaultApi {
298
313
  return middlewarePostObservable.pipe(map((rsp: ResponseContext) => this.responseProcessor.getApps(rsp)));
299
314
  }));
300
315
  }
301
-
316
+
302
317
  /**
303
318
  * View the details of a single notification and outcomes associated with it
304
319
  * View notification
305
- * @param app_id
306
- * @param notification_id
320
+ * @param appId
321
+ * @param notificationId
307
322
  */
308
- public getNotification(app_id: string, notification_id: string, _options?: Configuration): Observable<Notification> {
309
- const requestContextPromise = this.requestFactory.getNotification(app_id, notification_id, _options);
323
+ public getNotification(appId: string, notificationId: string, _options?: Configuration): Observable<NotificationWithMeta> {
324
+ const requestContextPromise = this.requestFactory.getNotification(appId, notificationId, _options);
310
325
 
311
326
  // build promise chain
312
327
  let middlewarePreObservable = from<RequestContext>(requestContextPromise);
@@ -323,15 +338,15 @@ export class ObservableDefaultApi {
323
338
  return middlewarePostObservable.pipe(map((rsp: ResponseContext) => this.responseProcessor.getNotification(rsp)));
324
339
  }));
325
340
  }
326
-
341
+
327
342
  /**
328
- * -> View the devices sent a message - OneSignal Paid Plan Required This method will return all devices that were sent the given notification_id of an Email or Push Notification if used within 7 days of the date sent. After 7 days of the sending date, the message history data will be unavailable. After a successful response is received, the destination url may be polled until the file becomes available. Most exports are done in ~1-3 minutes, so setting a poll interval of 10 seconds should be adequate. For use cases that are not meant to be consumed by a script, an email will be sent to the supplied email address. 🚧 Requirements A OneSignal Paid Plan. Turn on Send History via OneSignal API in Settings -> Analytics. Cannot get data before this was turned on. Must be called within 7 days after sending the message. Messages targeting under 1000 recipients will not have \"sent\" events recorded, but will show \"clicked\" events. Requires your OneSignal App's REST API Key, available in Keys & IDs.
343
+ * -> View the devices sent a message - OneSignal Paid Plan Required This method will return all devices that were sent the given notification_id of an Email or Push Notification if used within 7 days of the date sent. After 7 days of the sending date, the message history data will be unavailable. After a successful response is received, the destination url may be polled until the file becomes available. Most exports are done in ~1-3 minutes, so setting a poll interval of 10 seconds should be adequate. For use cases that are not meant to be consumed by a script, an email will be sent to the supplied email address. &#x1F6A7; Requirements A OneSignal Paid Plan. Turn on Send History via OneSignal API in Settings -> Analytics. Cannot get data before this was turned on. Must be called within 7 days after sending the message. Messages targeting under 1000 recipients will not have \"sent\" events recorded, but will show \"clicked\" events. Requires your OneSignal App\'s REST API Key, available in Keys & IDs.
329
344
  * Notification History
330
- * @param notification_id The \&quot;id\&quot; of the message found in the Notification object
331
- * @param get_notification_request_body
345
+ * @param notificationId The \&quot;id\&quot; of the message found in the Notification object
346
+ * @param getNotificationRequestBody
332
347
  */
333
- public getNotificationHistory(notification_id: string, get_notification_request_body: GetNotificationRequestBody, _options?: Configuration): Observable<InlineResponse2002> {
334
- const requestContextPromise = this.requestFactory.getNotificationHistory(notification_id, get_notification_request_body, _options);
348
+ public getNotificationHistory(notificationId: string, getNotificationRequestBody: GetNotificationRequestBody, _options?: Configuration): Observable<NotificationHistorySuccessResponse> {
349
+ const requestContextPromise = this.requestFactory.getNotificationHistory(notificationId, getNotificationRequestBody, _options);
335
350
 
336
351
  // build promise chain
337
352
  let middlewarePreObservable = from<RequestContext>(requestContextPromise);
@@ -348,17 +363,17 @@ export class ObservableDefaultApi {
348
363
  return middlewarePostObservable.pipe(map((rsp: ResponseContext) => this.responseProcessor.getNotificationHistory(rsp)));
349
364
  }));
350
365
  }
351
-
366
+
352
367
  /**
353
368
  * View the details of multiple notifications
354
369
  * View notifications
355
- * @param app_id The app ID that you want to view notifications from
370
+ * @param appId The app ID that you want to view notifications from
356
371
  * @param limit How many notifications to return. Max is 50. Default is 50.
357
372
  * @param offset Page offset. Default is 0. Results are sorted by queued_at in descending order. queued_at is a representation of the time that the notification was queued at.
358
373
  * @param kind Kind of notifications returned: * unset - All notification types (default) * &#x60;0&#x60; - Dashboard only * &#x60;1&#x60; - API only * &#x60;3&#x60; - Automated only
359
374
  */
360
- public getNotifications(app_id: string, limit?: string, offset?: number, kind?: 0 | 1 | 3, _options?: Configuration): Observable<NotificationSlice> {
361
- const requestContextPromise = this.requestFactory.getNotifications(app_id, limit, offset, kind, _options);
375
+ public getNotifications(appId: string, limit?: number, offset?: number, kind?: 0 | 1 | 3, _options?: Configuration): Observable<NotificationSlice> {
376
+ const requestContextPromise = this.requestFactory.getNotifications(appId, limit, offset, kind, _options);
362
377
 
363
378
  // build promise chain
364
379
  let middlewarePreObservable = from<RequestContext>(requestContextPromise);
@@ -375,19 +390,19 @@ export class ObservableDefaultApi {
375
390
  return middlewarePostObservable.pipe(map((rsp: ResponseContext) => this.responseProcessor.getNotifications(rsp)));
376
391
  }));
377
392
  }
378
-
393
+
379
394
  /**
380
- * View the details of all the outcomes associated with your app 🚧 Requires Authentication Key Requires your OneSignal App's REST API Key, available in Keys & IDs. 🚧 Outcome Data Limitations Outcomes are only accessible for around 30 days before deleted from our servers. You will need to export this data every month if you want to keep it.
395
+ * View the details of all the outcomes associated with your app &#x1F6A7; Requires Authentication Key Requires your OneSignal App\'s REST API Key, available in Keys & IDs. &#x1F6A7; Outcome Data Limitations Outcomes are only accessible for around 30 days before deleted from our servers. You will need to export this data every month if you want to keep it.
381
396
  * View Outcomes
382
- * @param app_id The OneSignal App ID for your app. Available in Keys &amp; IDs.
383
- * @param outcome_names Required Comma-separated list of names and the value (sum/count) for the returned outcome data. Note: Clicks only support count aggregation. For out-of-the-box OneSignal outcomes such as click and session duration, please use the os prefix with two underscores. For other outcomes, please use the name specified by the user. Example:os__session_duration.count,os__click.count,CustomOutcomeName.sum
384
- * @param outcome_names2 Optional If outcome names contain any commas, then please specify only one value at a time. Example: outcome_names[]&#x3D;os__click.count&amp;outcome_names[]&#x3D;Sales, Purchase.count where Sales, Purchase is the custom outcomes with a comma in the name.
385
- * @param outcome_time_range Optional Time range for the returned data. The values can be 1h (for the last 1 hour data), 1d (for the last 1 day data), or 1mo (for the last 1 month data). Default is 1h if the parameter is omitted.
386
- * @param outcome_platforms Optional Platform id. Refer device&#39;s platform ids for values. Example: outcome_platform&#x3D;0 for iOS outcome_platform&#x3D;7,8 for Safari and Firefox Default is data from all platforms if the parameter is omitted.
387
- * @param outcome_attribution Optional Attribution type for the outcomes. The values can be direct or influenced or unattributed. Example: outcome_attribution&#x3D;direct Default is total (returns direct+influenced+unattributed) if the parameter is omitted.
397
+ * @param appId The OneSignal App ID for your app. Available in Keys &amp; IDs.
398
+ * @param outcomeNames Required Comma-separated list of names and the value (sum/count) for the returned outcome data. Note: Clicks only support count aggregation. For out-of-the-box OneSignal outcomes such as click and session duration, please use the \&quot;os\&quot; prefix with two underscores. For other outcomes, please use the name specified by the user. Example:os__session_duration.count,os__click.count,CustomOutcomeName.sum
399
+ * @param outcomeNames2 Optional If outcome names contain any commas, then please specify only one value at a time. Example: outcome_names[]&#x3D;os__click.count&amp;outcome_names[]&#x3D;Sales, Purchase.count where \&quot;Sales, Purchase\&quot; is the custom outcomes with a comma in the name.
400
+ * @param outcomeTimeRange Optional Time range for the returned data. The values can be 1h (for the last 1 hour data), 1d (for the last 1 day data), or 1mo (for the last 1 month data). Default is 1h if the parameter is omitted.
401
+ * @param outcomePlatforms Optional Platform id. Refer device\&#39;s platform ids for values. Example: outcome_platform&#x3D;0 for iOS outcome_platform&#x3D;7,8 for Safari and Firefox Default is data from all platforms if the parameter is omitted.
402
+ * @param outcomeAttribution Optional Attribution type for the outcomes. The values can be direct or influenced or unattributed. Example: outcome_attribution&#x3D;direct Default is total (returns direct+influenced+unattributed) if the parameter is omitted.
388
403
  */
389
- public getOutcomes(app_id: string, outcome_names: string, outcome_names2?: string, outcome_time_range?: string, outcome_platforms?: string, outcome_attribution?: string, _options?: Configuration): Observable<Array<OutcomeData>> {
390
- const requestContextPromise = this.requestFactory.getOutcomes(app_id, outcome_names, outcome_names2, outcome_time_range, outcome_platforms, outcome_attribution, _options);
404
+ public getOutcomes(appId: string, outcomeNames: string, outcomeNames2?: string, outcomeTimeRange?: string, outcomePlatforms?: string, outcomeAttribution?: string, _options?: Configuration): Observable<OutcomesData> {
405
+ const requestContextPromise = this.requestFactory.getOutcomes(appId, outcomeNames, outcomeNames2, outcomeTimeRange, outcomePlatforms, outcomeAttribution, _options);
391
406
 
392
407
  // build promise chain
393
408
  let middlewarePreObservable = from<RequestContext>(requestContextPromise);
@@ -404,16 +419,16 @@ export class ObservableDefaultApi {
404
419
  return middlewarePostObservable.pipe(map((rsp: ResponseContext) => this.responseProcessor.getOutcomes(rsp)));
405
420
  }));
406
421
  }
407
-
422
+
408
423
  /**
409
424
  * View the details of an existing device in one of your OneSignal apps
410
425
  * View device
411
- * @param app_id Your app_id for this device
412
- * @param player_id Player&#39;s OneSignal ID
413
- * @param email_auth_hash Email - Only required if you have enabled Identity Verification and device_type is email (11).
426
+ * @param appId Your app_id for this device
427
+ * @param playerId Player\&#39;s OneSignal ID
428
+ * @param emailAuthHash Email - Only required if you have enabled Identity Verification and device_type is email (11).
414
429
  */
415
- public getPlayer(app_id: string, player_id: string, email_auth_hash?: string, _options?: Configuration): Observable<Player> {
416
- const requestContextPromise = this.requestFactory.getPlayer(app_id, player_id, email_auth_hash, _options);
430
+ public getPlayer(appId: string, playerId: string, emailAuthHash?: string, _options?: Configuration): Observable<Player> {
431
+ const requestContextPromise = this.requestFactory.getPlayer(appId, playerId, emailAuthHash, _options);
417
432
 
418
433
  // build promise chain
419
434
  let middlewarePreObservable = from<RequestContext>(requestContextPromise);
@@ -430,16 +445,16 @@ export class ObservableDefaultApi {
430
445
  return middlewarePostObservable.pipe(map((rsp: ResponseContext) => this.responseProcessor.getPlayer(rsp)));
431
446
  }));
432
447
  }
433
-
448
+
434
449
  /**
435
450
  * View the details of multiple devices in one of your OneSignal apps Unavailable for Apps Over 80,000 Users For performance reasons, this method is not available for larger apps. Larger apps should use the CSV export API endpoint, which is much more performant.
436
451
  * View devices
437
- * @param app_id The app ID that you want to view players from
452
+ * @param appId The app ID that you want to view players from
438
453
  * @param limit How many devices to return. Max is 300. Default is 300
439
454
  * @param offset Result offset. Default is 0. Results are sorted by id;
440
455
  */
441
- public getPlayers(app_id: string, limit?: string, offset?: number, _options?: Configuration): Observable<PlayerSlice> {
442
- const requestContextPromise = this.requestFactory.getPlayers(app_id, limit, offset, _options);
456
+ public getPlayers(appId: string, limit?: number, offset?: number, _options?: Configuration): Observable<PlayerSlice> {
457
+ const requestContextPromise = this.requestFactory.getPlayers(appId, limit, offset, _options);
443
458
 
444
459
  // build promise chain
445
460
  let middlewarePreObservable = from<RequestContext>(requestContextPromise);
@@ -456,15 +471,15 @@ export class ObservableDefaultApi {
456
471
  return middlewarePostObservable.pipe(map((rsp: ResponseContext) => this.responseProcessor.getPlayers(rsp)));
457
472
  }));
458
473
  }
459
-
474
+
460
475
  /**
461
476
  * Updates the name or configuration settings of an existing OneSignal app
462
477
  * Update an app
463
- * @param app_id An app id
478
+ * @param appId An app id
464
479
  * @param app
465
480
  */
466
- public updateApp(app_id: string, app: App, _options?: Configuration): Observable<App> {
467
- const requestContextPromise = this.requestFactory.updateApp(app_id, app, _options);
481
+ public updateApp(appId: string, app: App, _options?: Configuration): Observable<App> {
482
+ const requestContextPromise = this.requestFactory.updateApp(appId, app, _options);
468
483
 
469
484
  // build promise chain
470
485
  let middlewarePreObservable = from<RequestContext>(requestContextPromise);
@@ -481,15 +496,15 @@ export class ObservableDefaultApi {
481
496
  return middlewarePostObservable.pipe(map((rsp: ResponseContext) => this.responseProcessor.updateApp(rsp)));
482
497
  }));
483
498
  }
484
-
499
+
485
500
  /**
486
501
  * Update an existing device in one of your OneSignal apps
487
502
  * Edit device
488
- * @param player_id Player&#39;s OneSignal ID
503
+ * @param playerId Player\&#39;s OneSignal ID
489
504
  * @param player
490
505
  */
491
- public updatePlayer(player_id: string, player: Player, _options?: Configuration): Observable<InlineResponse2001> {
492
- const requestContextPromise = this.requestFactory.updatePlayer(player_id, player, _options);
506
+ public updatePlayer(playerId: string, player: Player, _options?: Configuration): Observable<UpdatePlayerSuccessResponse> {
507
+ const requestContextPromise = this.requestFactory.updatePlayer(playerId, player, _options);
493
508
 
494
509
  // build promise chain
495
510
  let middlewarePreObservable = from<RequestContext>(requestContextPromise);
@@ -506,16 +521,16 @@ export class ObservableDefaultApi {
506
521
  return middlewarePostObservable.pipe(map((rsp: ResponseContext) => this.responseProcessor.updatePlayer(rsp)));
507
522
  }));
508
523
  }
509
-
524
+
510
525
  /**
511
- * 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\" }
526
+ * 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. &#128216; 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\" }
512
527
  * Edit tags with external user id
513
- * @param app_id The OneSignal App ID the user record is found under.
514
- * @param external_user_id The External User ID mapped to teh device record in OneSignal. Must be actively set on the device to be updated.
515
- * @param update_player_tags_request_body
528
+ * @param appId The OneSignal App ID the user record is found under.
529
+ * @param externalUserId The External User ID mapped to teh device record in OneSignal. Must be actively set on the device to be updated.
530
+ * @param updatePlayerTagsRequestBody
516
531
  */
517
- public updatePlayerTags(app_id: string, external_user_id: string, update_player_tags_request_body?: UpdatePlayerTagsRequestBody, _options?: Configuration): Observable<InlineResponse2003> {
518
- const requestContextPromise = this.requestFactory.updatePlayerTags(app_id, external_user_id, update_player_tags_request_body, _options);
532
+ public updatePlayerTags(appId: string, externalUserId: string, updatePlayerTagsRequestBody?: UpdatePlayerTagsRequestBody, _options?: Configuration): Observable<UpdatePlayerTagsSuccessResponse> {
533
+ const requestContextPromise = this.requestFactory.updatePlayerTags(appId, externalUserId, updatePlayerTagsRequestBody, _options);
519
534
 
520
535
  // build promise chain
521
536
  let middlewarePreObservable = from<RequestContext>(requestContextPromise);
@@ -532,5 +547,5 @@ export class ObservableDefaultApi {
532
547
  return middlewarePostObservable.pipe(map((rsp: ResponseContext) => this.responseProcessor.updatePlayerTags(rsp)));
533
548
  }));
534
549
  }
535
-
550
+
536
551
  }