@onesignal/node-onesignal 2.0.1-beta2 → 5.0.0-alpha-01

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (268) hide show
  1. package/DefaultApi.md +401 -778
  2. package/apis/DefaultApi.ts +682 -1216
  3. package/auth/auth.ts +14 -14
  4. package/configuration.ts +6 -6
  5. package/dist/apis/DefaultApi.d.ts +36 -63
  6. package/dist/apis/DefaultApi.js +653 -1174
  7. package/dist/apis/DefaultApi.js.map +1 -1
  8. package/dist/auth/auth.d.ts +6 -6
  9. package/dist/auth/auth.js +19 -19
  10. package/dist/auth/auth.js.map +1 -1
  11. package/dist/configuration.d.ts +2 -2
  12. package/dist/configuration.js +4 -4
  13. package/dist/configuration.js.map +1 -1
  14. package/dist/models/BasicNotification.d.ts +14 -12
  15. package/dist/models/BasicNotification.js +20 -20
  16. package/dist/models/BasicNotification.js.map +1 -1
  17. package/dist/models/BasicNotificationAllOf.d.ts +10 -8
  18. package/dist/models/BasicNotificationAllOf.js +17 -11
  19. package/dist/models/BasicNotificationAllOf.js.map +1 -1
  20. package/dist/models/CreateNotificationSuccessResponse.d.ts +1 -3
  21. package/dist/models/CreateNotificationSuccessResponse.js +1 -7
  22. package/dist/models/CreateNotificationSuccessResponse.js.map +1 -1
  23. package/dist/models/{ExportPlayersRequestBody.d.ts → ExportSubscriptionsRequestBody.d.ts} +1 -1
  24. package/dist/models/ExportSubscriptionsRequestBody.js +34 -0
  25. package/dist/models/ExportSubscriptionsRequestBody.js.map +1 -0
  26. package/dist/models/{ExportPlayersSuccessResponse.d.ts → ExportSubscriptionsSuccessResponse.d.ts} +1 -1
  27. package/dist/models/ExportSubscriptionsSuccessResponse.js +22 -0
  28. package/dist/models/ExportSubscriptionsSuccessResponse.js.map +1 -0
  29. package/dist/models/Filter.d.ts +6 -2
  30. package/dist/models/Filter.js +24 -0
  31. package/dist/models/Filter.js.map +1 -1
  32. package/dist/models/FilterExpression.d.ts +27 -0
  33. package/dist/models/FilterExpression.js +70 -0
  34. package/dist/models/FilterExpression.js.map +1 -0
  35. package/dist/models/GenericError.d.ts +3 -2
  36. package/dist/models/GenericError.js +13 -1
  37. package/dist/models/GenericError.js.map +1 -1
  38. package/dist/models/{DeletePlayerSuccessResponse.d.ts → GenericSuccessBoolResponse.d.ts} +1 -1
  39. package/dist/models/GenericSuccessBoolResponse.js +22 -0
  40. package/dist/models/GenericSuccessBoolResponse.js.map +1 -0
  41. package/dist/models/{GetNotificationRequestBody.d.ts → GetNotificationHistoryRequestBody.d.ts} +3 -3
  42. package/dist/models/GetNotificationHistoryRequestBody.js +34 -0
  43. package/dist/models/GetNotificationHistoryRequestBody.js.map +1 -0
  44. package/dist/models/{PlayerSlice.d.ts → GetSegmentsSuccessResponse.d.ts} +3 -3
  45. package/dist/models/GetSegmentsSuccessResponse.js +40 -0
  46. package/dist/models/GetSegmentsSuccessResponse.js.map +1 -0
  47. package/dist/models/InvalidIdentifierError.d.ts +1 -1
  48. package/dist/models/InvalidIdentifierError.js +2 -2
  49. package/dist/models/InvalidIdentifierError.js.map +1 -1
  50. package/dist/models/{StringMap.d.ts → LanguageStringMap.d.ts} +1 -1
  51. package/dist/models/{StringMap.js → LanguageStringMap.js} +10 -10
  52. package/dist/models/LanguageStringMap.js.map +1 -0
  53. package/dist/models/Notification.d.ts +14 -12
  54. package/dist/models/Notification.js +20 -20
  55. package/dist/models/Notification.js.map +1 -1
  56. package/dist/models/NotificationTarget.d.ts +4 -4
  57. package/dist/models/NotificationTarget.js +3 -9
  58. package/dist/models/NotificationTarget.js.map +1 -1
  59. package/dist/models/NotificationWithMeta.d.ts +14 -12
  60. package/dist/models/NotificationWithMeta.js +20 -20
  61. package/dist/models/NotificationWithMeta.js.map +1 -1
  62. package/dist/models/ObjectSerializer.d.ts +15 -32
  63. package/dist/models/ObjectSerializer.js +50 -102
  64. package/dist/models/ObjectSerializer.js.map +1 -1
  65. package/dist/models/{InlineResponse202.d.ts → PropertiesBody.d.ts} +1 -1
  66. package/dist/models/PropertiesBody.js +22 -0
  67. package/dist/models/PropertiesBody.js.map +1 -0
  68. package/dist/models/{DeleteSegmentNotFoundResponse.d.ts → RateLimitError.d.ts} +3 -2
  69. package/dist/models/RateLimitError.js +28 -0
  70. package/dist/models/RateLimitError.js.map +1 -0
  71. package/dist/models/Segment.d.ts +2 -2
  72. package/dist/models/Segment.js +1 -1
  73. package/dist/models/Segment.js.map +1 -1
  74. package/dist/models/{CreateSubscriptionRequestBody.d.ts → SegmentData.d.ts} +8 -4
  75. package/dist/models/SegmentData.js +58 -0
  76. package/dist/models/SegmentData.js.map +1 -0
  77. package/dist/models/{SubscriptionObject.d.ts → Subscription.d.ts} +3 -3
  78. package/dist/models/{SubscriptionObject.js → Subscription.js} +11 -11
  79. package/dist/models/Subscription.js.map +1 -0
  80. package/dist/models/{CreatePlayerSuccessResponse.d.ts → SubscriptionBody.d.ts} +3 -3
  81. package/dist/models/SubscriptionBody.js +22 -0
  82. package/dist/models/SubscriptionBody.js.map +1 -0
  83. package/dist/models/{PlayerNotificationTarget.d.ts → SubscriptionNotificationTarget.d.ts} +7 -7
  84. package/dist/models/{PlayerNotificationTarget.js → SubscriptionNotificationTarget.js} +14 -20
  85. package/dist/models/SubscriptionNotificationTarget.js.map +1 -0
  86. package/dist/models/TransferSubscriptionRequestBody.d.ts +1 -1
  87. package/dist/models/TransferSubscriptionRequestBody.js +1 -1
  88. package/dist/models/TransferSubscriptionRequestBody.js.map +1 -1
  89. package/dist/models/UpdateLiveActivityRequest.d.ts +8 -3
  90. package/dist/models/UpdateLiveActivityRequest.js +33 -3
  91. package/dist/models/UpdateLiveActivityRequest.js.map +1 -1
  92. package/dist/models/UpdateLiveActivitySuccessResponse.d.ts +1 -3
  93. package/dist/models/UpdateLiveActivitySuccessResponse.js +2 -8
  94. package/dist/models/UpdateLiveActivitySuccessResponse.js.map +1 -1
  95. package/dist/models/User.d.ts +3 -5
  96. package/dist/models/User.js +2 -8
  97. package/dist/models/User.js.map +1 -1
  98. package/dist/models/{InlineResponse200.d.ts → UserIdentityBody.d.ts} +2 -2
  99. package/dist/models/UserIdentityBody.js +22 -0
  100. package/dist/models/UserIdentityBody.js.map +1 -0
  101. package/dist/models/{BeginLiveActivityRequest.d.ts → WebButton.d.ts} +5 -3
  102. package/dist/models/WebButton.js +40 -0
  103. package/dist/models/WebButton.js.map +1 -0
  104. package/dist/models/all.d.ts +15 -32
  105. package/dist/models/all.js +15 -32
  106. package/dist/models/all.js.map +1 -1
  107. package/dist/servers.js +1 -1
  108. package/dist/servers.js.map +1 -1
  109. package/dist/types/ObjectParamAPI.d.ts +52 -102
  110. package/dist/types/ObjectParamAPI.js +26 -47
  111. package/dist/types/ObjectParamAPI.js.map +1 -1
  112. package/dist/types/ObservableAPI.d.ts +25 -45
  113. package/dist/types/ObservableAPI.js +82 -250
  114. package/dist/types/ObservableAPI.js.map +1 -1
  115. package/dist/types/PromiseAPI.d.ts +25 -45
  116. package/dist/types/PromiseAPI.js +32 -60
  117. package/dist/types/PromiseAPI.js.map +1 -1
  118. package/models/App.ts +1 -1
  119. package/models/BasicNotification.ts +49 -46
  120. package/models/BasicNotificationAllOf.ts +34 -23
  121. package/models/BasicNotificationAllOfAndroidBackgroundLayout.ts +1 -1
  122. package/models/Button.ts +1 -1
  123. package/models/CreateNotificationSuccessResponse.ts +5 -13
  124. package/models/CreateSegmentConflictResponse.ts +1 -1
  125. package/models/CreateSegmentSuccessResponse.ts +1 -1
  126. package/models/CreateUserConflictResponse.ts +1 -1
  127. package/models/CreateUserConflictResponseErrorsInner.ts +1 -1
  128. package/models/CreateUserConflictResponseErrorsItemsMeta.ts +1 -1
  129. package/models/DeliveryData.ts +1 -1
  130. package/models/ExportEventsSuccessResponse.ts +1 -1
  131. package/models/{ExportPlayersRequestBody.ts → ExportSubscriptionsRequestBody.ts} +3 -3
  132. package/models/{ExportPlayersSuccessResponse.ts → ExportSubscriptionsSuccessResponse.ts} +3 -3
  133. package/models/Filter.ts +45 -5
  134. package/models/FilterExpression.ts +120 -0
  135. package/models/GenericError.ts +17 -4
  136. package/models/{DeletePlayerSuccessResponse.ts → GenericSuccessBoolResponse.ts} +3 -3
  137. package/models/{GetNotificationRequestBody.ts → GetNotificationHistoryRequestBody.ts} +6 -6
  138. package/models/{PlayerSlice.ts → GetSegmentsSuccessResponse.ts} +20 -8
  139. package/models/InvalidIdentifierError.ts +6 -6
  140. package/models/{StringMap.ts → LanguageStringMap.ts} +3 -3
  141. package/models/Notification.ts +49 -46
  142. package/models/NotificationAllOf.ts +1 -1
  143. package/models/NotificationHistorySuccessResponse.ts +1 -1
  144. package/models/NotificationSlice.ts +1 -1
  145. package/models/NotificationTarget.ts +17 -25
  146. package/models/NotificationWithMeta.ts +49 -46
  147. package/models/NotificationWithMetaAllOf.ts +1 -1
  148. package/models/ObjectSerializer.ts +57 -109
  149. package/models/Operator.ts +1 -1
  150. package/models/OutcomeData.ts +1 -1
  151. package/models/OutcomesData.ts +1 -1
  152. package/models/PlatformDeliveryData.ts +1 -1
  153. package/models/PlatformDeliveryDataEmailAllOf.ts +1 -1
  154. package/models/PlatformDeliveryDataSmsAllOf.ts +1 -1
  155. package/models/{InlineResponse202.ts → PropertiesBody.ts} +3 -3
  156. package/models/PropertiesDeltas.ts +1 -1
  157. package/models/PropertiesObject.ts +1 -1
  158. package/models/Purchase.ts +1 -1
  159. package/models/{CreatePlayerSuccessResponse.ts → RateLimitError.ts} +10 -10
  160. package/models/Segment.ts +4 -4
  161. package/models/SegmentData.ts +94 -0
  162. package/models/SegmentNotificationTarget.ts +1 -1
  163. package/models/{SubscriptionObject.ts → Subscription.ts} +6 -6
  164. package/models/{InlineResponse201.ts → SubscriptionBody.ts} +6 -6
  165. package/models/{PlayerNotificationTarget.ts → SubscriptionNotificationTarget.ts} +21 -29
  166. package/models/TransferSubscriptionRequestBody.ts +3 -3
  167. package/models/UpdateLiveActivityRequest.ts +56 -9
  168. package/models/UpdateLiveActivitySuccessResponse.ts +4 -12
  169. package/models/UpdateUserRequest.ts +1 -1
  170. package/models/User.ts +6 -14
  171. package/models/{InlineResponse200.ts → UserIdentityBody.ts} +5 -5
  172. package/models/{BeginLiveActivityRequest.ts → WebButton.ts} +23 -9
  173. package/models/all.ts +15 -32
  174. package/package.json +2 -2
  175. package/servers.ts +1 -1
  176. package/types/ObjectParamAPI.ts +161 -357
  177. package/types/ObservableAPI.ts +108 -301
  178. package/types/PromiseAPI.ts +89 -184
  179. package/dist/models/BeginLiveActivityRequest.js +0 -28
  180. package/dist/models/BeginLiveActivityRequest.js.map +0 -1
  181. package/dist/models/CancelNotificationSuccessResponse.d.ts +0 -17
  182. package/dist/models/CancelNotificationSuccessResponse.js +0 -22
  183. package/dist/models/CancelNotificationSuccessResponse.js.map +0 -1
  184. package/dist/models/CreatePlayerSuccessResponse.js +0 -28
  185. package/dist/models/CreatePlayerSuccessResponse.js.map +0 -1
  186. package/dist/models/CreateSubscriptionRequestBody.js +0 -28
  187. package/dist/models/CreateSubscriptionRequestBody.js.map +0 -1
  188. package/dist/models/DeletePlayerNotFoundResponse.d.ts +0 -17
  189. package/dist/models/DeletePlayerNotFoundResponse.js +0 -22
  190. package/dist/models/DeletePlayerNotFoundResponse.js.map +0 -1
  191. package/dist/models/DeletePlayerSuccessResponse.js +0 -22
  192. package/dist/models/DeletePlayerSuccessResponse.js.map +0 -1
  193. package/dist/models/DeleteSegmentNotFoundResponse.js +0 -22
  194. package/dist/models/DeleteSegmentNotFoundResponse.js.map +0 -1
  195. package/dist/models/DeleteSegmentSuccessResponse.d.ts +0 -17
  196. package/dist/models/DeleteSegmentSuccessResponse.js +0 -22
  197. package/dist/models/DeleteSegmentSuccessResponse.js.map +0 -1
  198. package/dist/models/ExportPlayersRequestBody.js +0 -34
  199. package/dist/models/ExportPlayersRequestBody.js.map +0 -1
  200. package/dist/models/ExportPlayersSuccessResponse.js +0 -22
  201. package/dist/models/ExportPlayersSuccessResponse.js.map +0 -1
  202. package/dist/models/FilterExpressions.d.ts +0 -23
  203. package/dist/models/FilterExpressions.js +0 -46
  204. package/dist/models/FilterExpressions.js.map +0 -1
  205. package/dist/models/GetNotificationRequestBody.js +0 -34
  206. package/dist/models/GetNotificationRequestBody.js.map +0 -1
  207. package/dist/models/InlineResponse200.js +0 -22
  208. package/dist/models/InlineResponse200.js.map +0 -1
  209. package/dist/models/InlineResponse2003.d.ts +0 -17
  210. package/dist/models/InlineResponse2003.js +0 -22
  211. package/dist/models/InlineResponse2003.js.map +0 -1
  212. package/dist/models/InlineResponse201.d.ts +0 -18
  213. package/dist/models/InlineResponse201.js +0 -22
  214. package/dist/models/InlineResponse201.js.map +0 -1
  215. package/dist/models/InlineResponse202.js +0 -22
  216. package/dist/models/InlineResponse202.js.map +0 -1
  217. package/dist/models/Notification200Errors.d.ts +0 -18
  218. package/dist/models/Notification200Errors.js +0 -28
  219. package/dist/models/Notification200Errors.js.map +0 -1
  220. package/dist/models/Player.d.ts +0 -43
  221. package/dist/models/Player.js +0 -178
  222. package/dist/models/Player.js.map +0 -1
  223. package/dist/models/PlayerNotificationTarget.js.map +0 -1
  224. package/dist/models/PlayerNotificationTargetIncludeAliases.d.ts +0 -17
  225. package/dist/models/PlayerNotificationTargetIncludeAliases.js +0 -22
  226. package/dist/models/PlayerNotificationTargetIncludeAliases.js.map +0 -1
  227. package/dist/models/PlayerSlice.js +0 -40
  228. package/dist/models/PlayerSlice.js.map +0 -1
  229. package/dist/models/StringMap.js.map +0 -1
  230. package/dist/models/SubscriptionObject.js.map +0 -1
  231. package/dist/models/UpdatePlayerSuccessResponse.d.ts +0 -17
  232. package/dist/models/UpdatePlayerSuccessResponse.js +0 -22
  233. package/dist/models/UpdatePlayerSuccessResponse.js.map +0 -1
  234. package/dist/models/UpdatePlayerTagsRequestBody.d.ts +0 -17
  235. package/dist/models/UpdatePlayerTagsRequestBody.js +0 -22
  236. package/dist/models/UpdatePlayerTagsRequestBody.js.map +0 -1
  237. package/dist/models/UpdatePlayerTagsSuccessResponse.d.ts +0 -17
  238. package/dist/models/UpdatePlayerTagsSuccessResponse.js +0 -22
  239. package/dist/models/UpdatePlayerTagsSuccessResponse.js.map +0 -1
  240. package/dist/models/UpdateSubscriptionRequestBody.d.ts +0 -18
  241. package/dist/models/UpdateSubscriptionRequestBody.js +0 -22
  242. package/dist/models/UpdateSubscriptionRequestBody.js.map +0 -1
  243. package/dist/models/UserIdentityRequestBody.d.ts +0 -19
  244. package/dist/models/UserIdentityRequestBody.js +0 -22
  245. package/dist/models/UserIdentityRequestBody.js.map +0 -1
  246. package/dist/models/UserIdentityResponse.d.ts +0 -19
  247. package/dist/models/UserIdentityResponse.js +0 -22
  248. package/dist/models/UserIdentityResponse.js.map +0 -1
  249. package/dist/models/UserSubscriptionOptions.d.ts +0 -17
  250. package/dist/models/UserSubscriptionOptions.js +0 -22
  251. package/dist/models/UserSubscriptionOptions.js.map +0 -1
  252. package/models/CancelNotificationSuccessResponse.ts +0 -31
  253. package/models/CreateSubscriptionRequestBody.ts +0 -39
  254. package/models/DeletePlayerNotFoundResponse.ts +0 -31
  255. package/models/DeleteSegmentNotFoundResponse.ts +0 -31
  256. package/models/DeleteSegmentSuccessResponse.ts +0 -31
  257. package/models/FilterExpressions.ts +0 -80
  258. package/models/InlineResponse2003.ts +0 -31
  259. package/models/Notification200Errors.ts +0 -45
  260. package/models/Player.ts +0 -291
  261. package/models/PlayerNotificationTargetIncludeAliases.ts +0 -31
  262. package/models/UpdatePlayerSuccessResponse.ts +0 -31
  263. package/models/UpdatePlayerTagsRequestBody.ts +0 -34
  264. package/models/UpdatePlayerTagsSuccessResponse.ts +0 -31
  265. package/models/UpdateSubscriptionRequestBody.ts +0 -32
  266. package/models/UserIdentityRequestBody.ts +0 -31
  267. package/models/UserIdentityResponse.ts +0 -31
  268. package/models/UserSubscriptionOptions.ts +0 -31
@@ -0,0 +1,120 @@
1
+ /**
2
+ * OneSignal
3
+ * A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com
4
+ *
5
+ * API Version: 5.0.0-alpha-01
6
+ * Contact: devrel@onesignal.com
7
+ */
8
+
9
+ import { Filter } from './Filter';
10
+ import { Operator } from './Operator';
11
+ import { HttpFile } from '../http/http';
12
+
13
+ export class FilterExpression {
14
+ /**
15
+ * Required. Name of the field to use as the first operand in the filter expression.
16
+ */
17
+ 'field'?: string;
18
+ /**
19
+ * If `field` is `tag`, this field is *required* to specify `key` inside the tags.
20
+ */
21
+ 'key'?: string;
22
+ /**
23
+ * Constant value to use as the second operand in the filter expression. This value is *required* when the relation operator is a binary operator.
24
+ */
25
+ 'value'?: string;
26
+ /**
27
+ * If `field` is session-related, this is *required* to specify the number of hours before or after the user\'s session.
28
+ */
29
+ 'hours_ago'?: string;
30
+ /**
31
+ * If `field` is `location`, this will specify the radius in meters from a provided location point. Use with `lat` and `long`.
32
+ */
33
+ 'radius'?: number;
34
+ /**
35
+ * If `field` is `location`, this is *required* to specify the user\'s latitude.
36
+ */
37
+ 'lat'?: number;
38
+ /**
39
+ * If `field` is `location`, this is *required* to specify the user\'s longitude.
40
+ */
41
+ 'long'?: number;
42
+ /**
43
+ * Required. Operator of a filter expression.
44
+ */
45
+ 'relation'?: FilterExpressionRelationEnum;
46
+ /**
47
+ * Strictly, this must be either `\"OR\"`, or `\"AND\"`. It can be used to compose Filters as part of a Filters object.
48
+ */
49
+ 'operator'?: FilterExpressionOperatorEnum;
50
+
51
+ static readonly discriminator: string | undefined = undefined;
52
+
53
+ static readonly attributeTypeMap: Array<{name: string, baseName: string, type: string, format: string}> = [
54
+ {
55
+ "name": "field",
56
+ "baseName": "field",
57
+ "type": "string",
58
+ "format": ""
59
+ },
60
+ {
61
+ "name": "key",
62
+ "baseName": "key",
63
+ "type": "string",
64
+ "format": ""
65
+ },
66
+ {
67
+ "name": "value",
68
+ "baseName": "value",
69
+ "type": "string",
70
+ "format": ""
71
+ },
72
+ {
73
+ "name": "hours_ago",
74
+ "baseName": "hours_ago",
75
+ "type": "string",
76
+ "format": ""
77
+ },
78
+ {
79
+ "name": "radius",
80
+ "baseName": "radius",
81
+ "type": "number",
82
+ "format": ""
83
+ },
84
+ {
85
+ "name": "lat",
86
+ "baseName": "lat",
87
+ "type": "number",
88
+ "format": ""
89
+ },
90
+ {
91
+ "name": "long",
92
+ "baseName": "long",
93
+ "type": "number",
94
+ "format": ""
95
+ },
96
+ {
97
+ "name": "relation",
98
+ "baseName": "relation",
99
+ "type": "FilterExpressionRelationEnum",
100
+ "format": ""
101
+ },
102
+ {
103
+ "name": "operator",
104
+ "baseName": "operator",
105
+ "type": "FilterExpressionOperatorEnum",
106
+ "format": ""
107
+ } ];
108
+
109
+ static getAttributeTypeMap() {
110
+ return FilterExpression.attributeTypeMap;
111
+ }
112
+
113
+ public constructor() {
114
+ }
115
+ }
116
+
117
+
118
+ export type FilterExpressionRelationEnum = ">" | "<" | "=" | "!=" | "exists" | "not_exists" | "time_elapsed_gt" | "time_elapsed_lt" ;
119
+ export type FilterExpressionOperatorEnum = "OR" | "AND" ;
120
+
@@ -2,15 +2,16 @@
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.2
5
+ * API Version: 5.0.0-alpha-01
6
6
  * Contact: devrel@onesignal.com
7
7
  */
8
8
 
9
- import { GenericErrorErrorsInner } from './GenericErrorErrorsInner';
10
9
  import { HttpFile } from '../http/http';
11
10
 
12
11
  export class GenericError {
13
- 'errors'?: Array<GenericErrorErrorsInner>;
12
+ 'errors'?: any;
13
+ 'success'?: boolean;
14
+ 'reference'?: any;
14
15
 
15
16
  static readonly discriminator: string | undefined = undefined;
16
17
 
@@ -18,7 +19,19 @@ export class GenericError {
18
19
  {
19
20
  "name": "errors",
20
21
  "baseName": "errors",
21
- "type": "Array<GenericErrorErrorsInner>",
22
+ "type": "any",
23
+ "format": ""
24
+ },
25
+ {
26
+ "name": "success",
27
+ "baseName": "success",
28
+ "type": "boolean",
29
+ "format": ""
30
+ },
31
+ {
32
+ "name": "reference",
33
+ "baseName": "reference",
34
+ "type": "any",
22
35
  "format": ""
23
36
  } ];
24
37
 
@@ -2,13 +2,13 @@
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.2
5
+ * API Version: 5.0.0-alpha-01
6
6
  * Contact: devrel@onesignal.com
7
7
  */
8
8
 
9
9
  import { HttpFile } from '../http/http';
10
10
 
11
- export class DeletePlayerSuccessResponse {
11
+ export class GenericSuccessBoolResponse {
12
12
  'success'?: boolean;
13
13
 
14
14
  static readonly discriminator: string | undefined = undefined;
@@ -22,7 +22,7 @@ export class DeletePlayerSuccessResponse {
22
22
  } ];
23
23
 
24
24
  static getAttributeTypeMap() {
25
- return DeletePlayerSuccessResponse.attributeTypeMap;
25
+ return GenericSuccessBoolResponse.attributeTypeMap;
26
26
  }
27
27
 
28
28
  public constructor() {
@@ -2,17 +2,17 @@
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.2
5
+ * API Version: 5.0.0-alpha-01
6
6
  * Contact: devrel@onesignal.com
7
7
  */
8
8
 
9
9
  import { HttpFile } from '../http/http';
10
10
 
11
- export class GetNotificationRequestBody {
11
+ export class GetNotificationHistoryRequestBody {
12
12
  /**
13
13
  * -> \"sent\" - All the devices by player_id that were sent the specified notification_id. Notifications targeting under 1000 recipients will not have \"sent\" events recorded, but will show \"clicked\" events. \"clicked\" - All the devices by `player_id` that clicked the specified notification_id.
14
14
  */
15
- 'events'?: GetNotificationRequestBodyEventsEnum;
15
+ 'events'?: GetNotificationHistoryRequestBodyEventsEnum;
16
16
  /**
17
17
  * The email address you would like the report sent.
18
18
  */
@@ -25,7 +25,7 @@ export class GetNotificationRequestBody {
25
25
  {
26
26
  "name": "events",
27
27
  "baseName": "events",
28
- "type": "GetNotificationRequestBodyEventsEnum",
28
+ "type": "GetNotificationHistoryRequestBodyEventsEnum",
29
29
  "format": ""
30
30
  },
31
31
  {
@@ -42,7 +42,7 @@ export class GetNotificationRequestBody {
42
42
  } ];
43
43
 
44
44
  static getAttributeTypeMap() {
45
- return GetNotificationRequestBody.attributeTypeMap;
45
+ return GetNotificationHistoryRequestBody.attributeTypeMap;
46
46
  }
47
47
 
48
48
  public constructor() {
@@ -50,5 +50,5 @@ export class GetNotificationRequestBody {
50
50
  }
51
51
 
52
52
 
53
- export type GetNotificationRequestBodyEventsEnum = "sent" | "clicked" ;
53
+ export type GetNotificationHistoryRequestBodyEventsEnum = "sent" | "clicked" ;
54
54
 
@@ -2,18 +2,30 @@
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.2
5
+ * API Version: 5.0.0-alpha-01
6
6
  * Contact: devrel@onesignal.com
7
7
  */
8
8
 
9
- import { Player } from './Player';
9
+ import { SegmentData } from './SegmentData';
10
10
  import { HttpFile } from '../http/http';
11
11
 
12
- export class PlayerSlice {
12
+ export class GetSegmentsSuccessResponse {
13
+ /**
14
+ * The number of Segments in the response.
15
+ */
13
16
  'total_count'?: number;
17
+ /**
18
+ * Set with the offset query parameter. Default 0.
19
+ */
14
20
  'offset'?: number;
21
+ /**
22
+ * Maximum number of Segments returned. Default 300.
23
+ */
15
24
  'limit'?: number;
16
- 'players'?: Array<Player>;
25
+ /**
26
+ * An array containing the Segment information.
27
+ */
28
+ 'segments'?: Array<SegmentData>;
17
29
 
18
30
  static readonly discriminator: string | undefined = undefined;
19
31
 
@@ -37,14 +49,14 @@ export class PlayerSlice {
37
49
  "format": ""
38
50
  },
39
51
  {
40
- "name": "players",
41
- "baseName": "players",
42
- "type": "Array<Player>",
52
+ "name": "segments",
53
+ "baseName": "segments",
54
+ "type": "Array<SegmentData>",
43
55
  "format": ""
44
56
  } ];
45
57
 
46
58
  static getAttributeTypeMap() {
47
- return PlayerSlice.attributeTypeMap;
59
+ return GetSegmentsSuccessResponse.attributeTypeMap;
48
60
  }
49
61
 
50
62
  public constructor() {
@@ -2,7 +2,7 @@
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.2
5
+ * API Version: 5.0.0-alpha-01
6
6
  * Contact: devrel@onesignal.com
7
7
  */
8
8
 
@@ -10,11 +10,11 @@ import { HttpFile } from '../http/http';
10
10
 
11
11
  export class InvalidIdentifierError {
12
12
  /**
13
- * Returned if using include_external_user_ids
13
+ * Returned if using include_aliases
14
14
  */
15
- 'invalid_external_user_ids'?: Array<string>;
15
+ 'invalid_aliases'?: Array<string>;
16
16
  /**
17
- * Returned if using include_player_ids and some were valid and others were not.
17
+ * Returned if using include_subscription_ids and some were valid and others were not.
18
18
  */
19
19
  'invalid_player_ids'?: Array<string>;
20
20
 
@@ -22,8 +22,8 @@ export class InvalidIdentifierError {
22
22
 
23
23
  static readonly attributeTypeMap: Array<{name: string, baseName: string, type: string, format: string}> = [
24
24
  {
25
- "name": "invalid_external_user_ids",
26
- "baseName": "invalid_external_user_ids",
25
+ "name": "invalid_aliases",
26
+ "baseName": "invalid_aliases",
27
27
  "type": "Array<string>",
28
28
  "format": ""
29
29
  },
@@ -2,13 +2,13 @@
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.2
5
+ * API Version: 5.0.0-alpha-01
6
6
  * Contact: devrel@onesignal.com
7
7
  */
8
8
 
9
9
  import { HttpFile } from '../http/http';
10
10
 
11
- export class StringMap {
11
+ export class LanguageStringMap {
12
12
  /**
13
13
  * Text in English. Will be used as a fallback
14
14
  */
@@ -445,7 +445,7 @@ export class StringMap {
445
445
  } ];
446
446
 
447
447
  static getAttributeTypeMap() {
448
- return StringMap.attributeTypeMap;
448
+ return LanguageStringMap.attributeTypeMap;
449
449
  }
450
450
 
451
451
  public constructor() {
@@ -2,17 +2,17 @@
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.2
5
+ * API Version: 5.0.0-alpha-01
6
6
  * Contact: devrel@onesignal.com
7
7
  */
8
8
 
9
9
  import { BasicNotification } from './BasicNotification';
10
10
  import { BasicNotificationAllOfAndroidBackgroundLayout } from './BasicNotificationAllOfAndroidBackgroundLayout';
11
11
  import { Button } from './Button';
12
- import { Filter } from './Filter';
12
+ import { FilterExpression } from './FilterExpression';
13
+ import { LanguageStringMap } from './LanguageStringMap';
13
14
  import { NotificationAllOf } from './NotificationAllOf';
14
- import { PlayerNotificationTargetIncludeAliases } from './PlayerNotificationTargetIncludeAliases';
15
- import { StringMap } from './StringMap';
15
+ import { WebButton } from './WebButton';
16
16
  import { HttpFile } from '../http/http';
17
17
 
18
18
  export class Notification {
@@ -25,13 +25,9 @@ export class Notification {
25
25
  */
26
26
  'excluded_segments'?: Array<string>;
27
27
  /**
28
- * Specific playerids to send your notification to. _Does not require API Auth Key. Do not combine with other targeting parameters. Not compatible with any other targeting parameters. Example: [\"1dd608f2-c6a1-11e3-851d-000c2940e62c\"] Limit of 2,000 entries per REST API call
28
+ * Specific subscription ids to send your notification to. _Does not require API Auth Key._ Not compatible with any other targeting parameters. Example: [\"1dd608f2-c6a1-11e3-851d-000c2940e62c\"] Limit of 2,000 entries per REST API call
29
29
  */
30
- 'include_player_ids'?: Array<string>;
31
- /**
32
- * Target specific devices by custom user IDs assigned via API. Not compatible with any other targeting parameters Example: [\"custom-id-assigned-by-api\"] REQUIRED: REST API Key Authentication Limit of 2,000 entries per REST API call. Note: If targeting push, email, or sms subscribers with same ids, use with channel_for_external_user_ids to indicate you are sending a push or email or sms.
33
- */
34
- 'include_external_user_ids'?: Array<string>;
30
+ 'include_subscription_ids'?: Array<string>;
35
31
  /**
36
32
  * Recommended for Sending Emails - Target specific email addresses. If an email does not correspond to an existing user, a new user will be created. Example: nick@catfac.ts Limit of 2,000 entries per REST API call
37
33
  */
@@ -41,30 +37,33 @@ export class Notification {
41
37
  */
42
38
  'include_phone_numbers'?: Array<string>;
43
39
  /**
44
- * Not Recommended: Please consider using include_player_ids or include_external_user_ids instead. Target using iOS device tokens. Warning: Only works with Production tokens. All non-alphanumeric characters must be removed from each token. If a token does not correspond to an existing user, a new user will be created. Example: ce777617da7f548fe7a9ab6febb56cf39fba6d38203... Limit of 2,000 entries per REST API call
40
+ * Not Recommended: Please consider using include_subscription_ids or include_aliases instead. Target using iOS device tokens. Warning: Only works with Production tokens. All non-alphanumeric characters must be removed from each token. If a token does not correspond to an existing user, a new user will be created. Example: ce777617da7f548fe7a9ab6febb56cf39fba6d38203... Limit of 2,000 entries per REST API call
45
41
  */
46
42
  'include_ios_tokens'?: Array<string>;
47
43
  /**
48
- * Not Recommended: Please consider using include_player_ids or include_external_user_ids instead. Target using Windows URIs. If a token does not correspond to an existing user, a new user will be created. Example: http://s.notify.live.net/u/1/bn1/HmQAAACPaLDr-... Limit of 2,000 entries per REST API call
44
+ * Not Recommended: Please consider using include_subscription_ids or include_aliases instead. Target using Windows URIs. If a token does not correspond to an existing user, a new user will be created. Example: http://s.notify.live.net/u/1/bn1/HmQAAACPaLDr-... Limit of 2,000 entries per REST API call
49
45
  */
50
46
  'include_wp_wns_uris'?: Array<string>;
51
47
  /**
52
- * Not Recommended: Please consider using include_player_ids or include_external_user_ids instead. Target using Amazon ADM registration IDs. If a token does not correspond to an existing user, a new user will be created. Example: amzn1.adm-registration.v1.XpvSSUk0Rc3hTVVV... Limit of 2,000 entries per REST API call
48
+ * Not Recommended: Please consider using include_subscription_ids or include_aliases instead. Target using Amazon ADM registration IDs. If a token does not correspond to an existing user, a new user will be created. Example: amzn1.adm-registration.v1.XpvSSUk0Rc3hTVVV... Limit of 2,000 entries per REST API call
53
49
  */
54
50
  'include_amazon_reg_ids'?: Array<string>;
55
51
  /**
56
- * Not Recommended: Please consider using include_player_ids or include_external_user_ids instead. Target using Chrome App registration IDs. If a token does not correspond to an existing user, a new user will be created. Example: APA91bEeiUeSukAAUdnw3O2RB45FWlSpgJ7Ji_... Limit of 2,000 entries per REST API call
52
+ * Not Recommended: Please consider using include_subscription_ids or include_aliases instead. Target using Chrome App registration IDs. If a token does not correspond to an existing user, a new user will be created. Example: APA91bEeiUeSukAAUdnw3O2RB45FWlSpgJ7Ji_... Limit of 2,000 entries per REST API call
57
53
  */
58
54
  'include_chrome_reg_ids'?: Array<string>;
59
55
  /**
60
- * Not Recommended: Please consider using include_player_ids or include_external_user_ids instead. Target using Chrome Web Push registration IDs. If a token does not correspond to an existing user, a new user will be created. Example: APA91bEeiUeSukAAUdnw3O2RB45FWlSpgJ7Ji_... Limit of 2,000 entries per REST API call
56
+ * Not Recommended: Please consider using include_subscription_ids or include_aliases instead. Target using Chrome Web Push registration IDs. If a token does not correspond to an existing user, a new user will be created. Example: APA91bEeiUeSukAAUdnw3O2RB45FWlSpgJ7Ji_... Limit of 2,000 entries per REST API call
61
57
  */
62
58
  'include_chrome_web_reg_ids'?: Array<string>;
63
59
  /**
64
- * Not Recommended: Please consider using include_player_ids or include_external_user_ids instead. Target using Android device registration IDs. If a token does not correspond to an existing user, a new user will be created. Example: APA91bEeiUeSukAAUdnw3O2RB45FWlSpgJ7Ji_... Limit of 2,000 entries per REST API call
60
+ * Not Recommended: Please consider using include_subscription_ids or include_aliases instead. Target using Android device registration IDs. If a token does not correspond to an existing user, a new user will be created. Example: APA91bEeiUeSukAAUdnw3O2RB45FWlSpgJ7Ji_... Limit of 2,000 entries per REST API call
65
61
  */
66
62
  'include_android_reg_ids'?: Array<string>;
67
- 'include_aliases'?: PlayerNotificationTargetIncludeAliases;
63
+ /**
64
+ * Target specific users by aliases assigned via API. An alias can be an external_id, onesignal_id, or a custom alias. Accepts an object where keys are alias labels and values are arrays of alias IDs to include Example usage: { \"external_id\": [\"exId1\", \"extId2\"], \"internal_label\": [\"id1\", \"id2\"] } Not compatible with any other targeting parameters. REQUIRED: REST API Key Authentication Limit of 2,000 entries per REST API call Note: If targeting push, email, or sms subscribers with same ids, use with target_channel to indicate you are sending a push or email or sms.
65
+ */
66
+ 'include_aliases'?: { [key: string]: Array<string>; };
68
67
  'target_channel'?: NotificationTargetChannelEnum;
69
68
  'id'?: string;
70
69
  'value'?: number;
@@ -114,10 +113,6 @@ export class Notification {
114
113
  */
115
114
  'is_chrome'?: boolean;
116
115
  /**
117
- * Indicates if the message type when targeting with include_external_user_ids for cases where an email, sms, and/or push subscribers have the same external user id. Example: Use the string \"push\" to indicate you are sending a push notification or the string \"email\"for sending emails or \"sms\"for sending SMS.
118
- */
119
- 'channel_for_external_user_ids'?: string;
120
- /**
121
116
  * Required: Your OneSignal Application ID, which can be found in Keys & IDs. It is a UUID and looks similar to 8250eaf6-1a58-489e-b136-7c74a864b434.
122
117
  */
123
118
  'app_id': string;
@@ -125,9 +120,9 @@ export class Notification {
125
120
  * Correlation and idempotency key. A request received with this parameter will first look for another notification with the same external_id. If one exists, a notification will not be sent, and result of the previous operation will instead be returned. Therefore, if you plan on using this feature, it\'s important to use a good source of randomness to generate the UUID passed here. This key is only idempotent for 30 days. After 30 days, the notification could be removed from our system and a notification with the same external_id will be sent again. See Idempotent Notification Requests for more details writeOnly: true
126
121
  */
127
122
  'external_id'?: string;
128
- 'contents'?: StringMap;
129
- 'headings'?: StringMap;
130
- 'subtitle'?: StringMap;
123
+ 'contents'?: LanguageStringMap;
124
+ 'headings'?: LanguageStringMap;
125
+ 'subtitle'?: LanguageStringMap;
131
126
  /**
132
127
  * Channel: Push Notifications Platform: Huawei A custom map of data that is passed back to your app. Same as using Additional Data within the dashboard. Can use up to 2048 bytes of data. Example: {\"abc\": 123, \"foo\": \"bar\", \"event_performed\": true, \"amount\": 12.1}
133
128
  */
@@ -195,7 +190,7 @@ export class Notification {
195
190
  /**
196
191
  * Channel: Push Notifications Platform: Chrome 48+ Add action buttons to the notification. The id field is required. Example: [{\"id\": \"like-button\", \"text\": \"Like\", \"icon\": \"http://i.imgur.com/N8SN8ZS.png\", \"url\": \"https://yoursite.com\"}, {\"id\": \"read-more-button\", \"text\": \"Read more\", \"icon\": \"http://i.imgur.com/MIxJp1L.png\", \"url\": \"https://yoursite.com\"}]
197
192
  */
198
- 'web_buttons'?: Array<Button>;
193
+ 'web_buttons'?: Array<WebButton>;
199
194
  /**
200
195
  * Channel: Push Notifications Platform: iOS Category APS payload, use with registerUserNotificationSettings:categories in your Objective-C / Swift code. Example: calendar category which contains actions like accept and decline iOS 10+ This will trigger your UNNotificationContentExtension whose ID matches this category.
201
196
  */
@@ -374,6 +369,14 @@ export class Notification {
374
369
  */
375
370
  'summary_arg_count'?: number;
376
371
  /**
372
+ * Channel: Push Notifications Platform: iOS 15+ A score to be set per notification to indicate how it should be displayed when grouped. Use a float between 0-1.
373
+ */
374
+ 'ios_relevance_score'?: number;
375
+ /**
376
+ * Channel: Push Notifications Platform: iOS 15+ Focus Modes and Interruption Levels indicate the priority and delivery timing of a notification, to \"interrupt\" the user. Can choose from options: [\'active\', \'passive\', \'time_sensitive\', \'critical\']. Default is active.
377
+ */
378
+ 'ios_interruption_level'?: string;
379
+ /**
377
380
  * Channel: Email Required. The subject of the email.
378
381
  */
379
382
  'email_subject'?: string;
@@ -405,7 +408,7 @@ export class Notification {
405
408
  * Channel: SMS URLs for the media files to be attached to the SMS content. Limit: 10 media urls with a total max. size of 5MBs.
406
409
  */
407
410
  'sms_media_urls'?: Array<string>;
408
- 'filters'?: Array<Filter>;
411
+ 'filters'?: Array<FilterExpression>;
409
412
  /**
410
413
  * Channel: All JSON object that can be used as a source of message personalization data for fields that support tag variable substitution. Push, SMS: Can accept up to 2048 bytes of valid JSON. Email: Can accept up to 10000 bytes of valid JSON. Example: {\"order_id\": 123, \"currency\": \"USD\", \"amount\": 25}
411
414
  */
@@ -431,14 +434,8 @@ export class Notification {
431
434
  "format": ""
432
435
  },
433
436
  {
434
- "name": "include_player_ids",
435
- "baseName": "include_player_ids",
436
- "type": "Array<string>",
437
- "format": ""
438
- },
439
- {
440
- "name": "include_external_user_ids",
441
- "baseName": "include_external_user_ids",
437
+ "name": "include_subscription_ids",
438
+ "baseName": "include_subscription_ids",
442
439
  "type": "Array<string>",
443
440
  "format": ""
444
441
  },
@@ -493,7 +490,7 @@ export class Notification {
493
490
  {
494
491
  "name": "include_aliases",
495
492
  "baseName": "include_aliases",
496
- "type": "PlayerNotificationTargetIncludeAliases",
493
+ "type": "{ [key: string]: Array<string>; }",
497
494
  "format": ""
498
495
  },
499
496
  {
@@ -586,12 +583,6 @@ export class Notification {
586
583
  "type": "boolean",
587
584
  "format": ""
588
585
  },
589
- {
590
- "name": "channel_for_external_user_ids",
591
- "baseName": "channel_for_external_user_ids",
592
- "type": "string",
593
- "format": ""
594
- },
595
586
  {
596
587
  "name": "app_id",
597
588
  "baseName": "app_id",
@@ -607,19 +598,19 @@ export class Notification {
607
598
  {
608
599
  "name": "contents",
609
600
  "baseName": "contents",
610
- "type": "StringMap",
601
+ "type": "LanguageStringMap",
611
602
  "format": ""
612
603
  },
613
604
  {
614
605
  "name": "headings",
615
606
  "baseName": "headings",
616
- "type": "StringMap",
607
+ "type": "LanguageStringMap",
617
608
  "format": ""
618
609
  },
619
610
  {
620
611
  "name": "subtitle",
621
612
  "baseName": "subtitle",
622
- "type": "StringMap",
613
+ "type": "LanguageStringMap",
623
614
  "format": ""
624
615
  },
625
616
  {
@@ -721,7 +712,7 @@ export class Notification {
721
712
  {
722
713
  "name": "web_buttons",
723
714
  "baseName": "web_buttons",
724
- "type": "Array<Button>",
715
+ "type": "Array<WebButton>",
725
716
  "format": ""
726
717
  },
727
718
  {
@@ -994,6 +985,18 @@ export class Notification {
994
985
  "type": "number",
995
986
  "format": ""
996
987
  },
988
+ {
989
+ "name": "ios_relevance_score",
990
+ "baseName": "ios_relevance_score",
991
+ "type": "number",
992
+ "format": ""
993
+ },
994
+ {
995
+ "name": "ios_interruption_level",
996
+ "baseName": "ios_interruption_level",
997
+ "type": "string",
998
+ "format": ""
999
+ },
997
1000
  {
998
1001
  "name": "email_subject",
999
1002
  "baseName": "email_subject",
@@ -1045,7 +1048,7 @@ export class Notification {
1045
1048
  {
1046
1049
  "name": "filters",
1047
1050
  "baseName": "filters",
1048
- "type": "Array<Filter>",
1051
+ "type": "Array<FilterExpression>",
1049
1052
  "format": ""
1050
1053
  },
1051
1054
  {
@@ -2,7 +2,7 @@
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.2
5
+ * API Version: 5.0.0-alpha-01
6
6
  * Contact: devrel@onesignal.com
7
7
  */
8
8
 
@@ -2,7 +2,7 @@
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.2
5
+ * API Version: 5.0.0-alpha-01
6
6
  * Contact: devrel@onesignal.com
7
7
  */
8
8
 
@@ -2,7 +2,7 @@
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.2
5
+ * API Version: 5.0.0-alpha-01
6
6
  * Contact: devrel@onesignal.com
7
7
  */
8
8