@onesignal/node-onesignal 5.0.0-alpha-01 → 5.1.0-beta1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (200) hide show
  1. package/.github/ISSUE_TEMPLATE/ask-question.yml +3 -3
  2. package/.github/ISSUE_TEMPLATE/bug-report.yml +2 -2
  3. package/.github/ISSUE_TEMPLATE/general-feedback.yml +3 -3
  4. package/.github/workflows/project.yml +17 -0
  5. package/DefaultApi.md +5 -5
  6. package/README.md +4 -4
  7. package/apis/DefaultApi.ts +40 -34
  8. package/auth/auth.ts +16 -16
  9. package/configuration.ts +5 -5
  10. package/dist/apis/DefaultApi.js +46 -39
  11. package/dist/apis/DefaultApi.js.map +1 -1
  12. package/dist/auth/auth.d.ts +4 -4
  13. package/dist/auth/auth.js +20 -20
  14. package/dist/auth/auth.js.map +1 -1
  15. package/dist/configuration.d.ts +1 -1
  16. package/dist/configuration.js +4 -4
  17. package/dist/configuration.js.map +1 -1
  18. package/dist/http/http.d.ts +1 -0
  19. package/dist/http/isomorphic-fetch.js +1 -2
  20. package/dist/http/isomorphic-fetch.js.map +1 -1
  21. package/dist/models/BasicNotification.d.ts +1 -0
  22. package/dist/models/BasicNotification.js +6 -0
  23. package/dist/models/BasicNotification.js.map +1 -1
  24. package/dist/models/BasicNotificationAllOf.d.ts +1 -0
  25. package/dist/models/BasicNotificationAllOf.js +6 -0
  26. package/dist/models/BasicNotificationAllOf.js.map +1 -1
  27. package/dist/models/BeginLiveActivityRequest.d.ts +18 -0
  28. package/dist/models/BeginLiveActivityRequest.js +28 -0
  29. package/dist/models/BeginLiveActivityRequest.js.map +1 -0
  30. package/dist/models/CancelNotificationSuccessResponse.d.ts +17 -0
  31. package/dist/models/CancelNotificationSuccessResponse.js +22 -0
  32. package/dist/models/CancelNotificationSuccessResponse.js.map +1 -0
  33. package/dist/models/CreatePlayerSuccessResponse.d.ts +18 -0
  34. package/dist/models/CreatePlayerSuccessResponse.js +28 -0
  35. package/dist/models/CreatePlayerSuccessResponse.js.map +1 -0
  36. package/dist/models/CreateSubscriptionRequestBody.d.ts +19 -0
  37. package/dist/models/CreateSubscriptionRequestBody.js +28 -0
  38. package/dist/models/CreateSubscriptionRequestBody.js.map +1 -0
  39. package/dist/models/DeletePlayerNotFoundResponse.d.ts +17 -0
  40. package/dist/models/DeletePlayerNotFoundResponse.js +22 -0
  41. package/dist/models/DeletePlayerNotFoundResponse.js.map +1 -0
  42. package/dist/models/DeletePlayerSuccessResponse.d.ts +17 -0
  43. package/dist/models/DeletePlayerSuccessResponse.js +22 -0
  44. package/dist/models/DeletePlayerSuccessResponse.js.map +1 -0
  45. package/dist/models/DeleteSegmentNotFoundResponse.d.ts +17 -0
  46. package/dist/models/DeleteSegmentNotFoundResponse.js +22 -0
  47. package/dist/models/DeleteSegmentNotFoundResponse.js.map +1 -0
  48. package/dist/models/DeleteSegmentSuccessResponse.d.ts +17 -0
  49. package/dist/models/DeleteSegmentSuccessResponse.js +22 -0
  50. package/dist/models/DeleteSegmentSuccessResponse.js.map +1 -0
  51. package/dist/models/ExportPlayersRequestBody.d.ts +19 -0
  52. package/dist/models/ExportPlayersRequestBody.js +34 -0
  53. package/dist/models/ExportPlayersRequestBody.js.map +1 -0
  54. package/dist/models/ExportPlayersSuccessResponse.d.ts +17 -0
  55. package/dist/models/ExportPlayersSuccessResponse.js +22 -0
  56. package/dist/models/ExportPlayersSuccessResponse.js.map +1 -0
  57. package/dist/models/FilterExpressions.d.ts +23 -0
  58. package/dist/models/FilterExpressions.js +46 -0
  59. package/dist/models/FilterExpressions.js.map +1 -0
  60. package/dist/models/GetNotificationRequestBody.d.ts +20 -0
  61. package/dist/models/GetNotificationRequestBody.js +34 -0
  62. package/dist/models/GetNotificationRequestBody.js.map +1 -0
  63. package/dist/models/InlineResponse200.d.ts +19 -0
  64. package/dist/models/InlineResponse200.js +22 -0
  65. package/dist/models/InlineResponse200.js.map +1 -0
  66. package/dist/models/InlineResponse2003.d.ts +17 -0
  67. package/dist/models/InlineResponse2003.js +22 -0
  68. package/dist/models/InlineResponse2003.js.map +1 -0
  69. package/dist/models/InlineResponse201.d.ts +18 -0
  70. package/dist/models/InlineResponse201.js +22 -0
  71. package/dist/models/InlineResponse201.js.map +1 -0
  72. package/dist/models/InlineResponse202.d.ts +18 -0
  73. package/dist/models/InlineResponse202.js +22 -0
  74. package/dist/models/InlineResponse202.js.map +1 -0
  75. package/dist/models/InvalidIdentifierError.d.ts +1 -1
  76. package/dist/models/InvalidIdentifierError.js +2 -2
  77. package/dist/models/InvalidIdentifierError.js.map +1 -1
  78. package/dist/models/Notification.d.ts +1 -0
  79. package/dist/models/Notification.js +6 -0
  80. package/dist/models/Notification.js.map +1 -1
  81. package/dist/models/Notification200Errors.d.ts +18 -0
  82. package/dist/models/Notification200Errors.js +28 -0
  83. package/dist/models/Notification200Errors.js.map +1 -0
  84. package/dist/models/NotificationWithMeta.d.ts +1 -0
  85. package/dist/models/NotificationWithMeta.js +6 -0
  86. package/dist/models/NotificationWithMeta.js.map +1 -1
  87. package/dist/models/ObjectSerializer.d.ts +0 -1
  88. package/dist/models/ObjectSerializer.js +0 -3
  89. package/dist/models/ObjectSerializer.js.map +1 -1
  90. package/dist/models/Player.d.ts +43 -0
  91. package/dist/models/Player.js +178 -0
  92. package/dist/models/Player.js.map +1 -0
  93. package/dist/models/PlayerNotificationTarget.d.ts +30 -0
  94. package/dist/models/PlayerNotificationTarget.js +88 -0
  95. package/dist/models/PlayerNotificationTarget.js.map +1 -0
  96. package/dist/models/PlayerNotificationTargetIncludeAliases.d.ts +17 -0
  97. package/dist/models/PlayerNotificationTargetIncludeAliases.js +22 -0
  98. package/dist/models/PlayerNotificationTargetIncludeAliases.js.map +1 -0
  99. package/dist/models/PlayerSlice.d.ts +21 -0
  100. package/dist/models/PlayerSlice.js +40 -0
  101. package/dist/models/PlayerSlice.js.map +1 -0
  102. package/dist/models/StringMap.d.ts +59 -0
  103. package/dist/models/StringMap.js +274 -0
  104. package/dist/models/StringMap.js.map +1 -0
  105. package/dist/models/SubscriptionObject.d.ts +34 -0
  106. package/dist/models/SubscriptionObject.js +118 -0
  107. package/dist/models/SubscriptionObject.js.map +1 -0
  108. package/dist/models/UpdatePlayerSuccessResponse.d.ts +17 -0
  109. package/dist/models/UpdatePlayerSuccessResponse.js +22 -0
  110. package/dist/models/UpdatePlayerSuccessResponse.js.map +1 -0
  111. package/dist/models/UpdatePlayerTagsRequestBody.d.ts +17 -0
  112. package/dist/models/UpdatePlayerTagsRequestBody.js +22 -0
  113. package/dist/models/UpdatePlayerTagsRequestBody.js.map +1 -0
  114. package/dist/models/UpdatePlayerTagsSuccessResponse.d.ts +17 -0
  115. package/dist/models/UpdatePlayerTagsSuccessResponse.js +22 -0
  116. package/dist/models/UpdatePlayerTagsSuccessResponse.js.map +1 -0
  117. package/dist/models/UpdateSubscriptionRequestBody.d.ts +18 -0
  118. package/dist/models/UpdateSubscriptionRequestBody.js +22 -0
  119. package/dist/models/UpdateSubscriptionRequestBody.js.map +1 -0
  120. package/dist/models/UserIdentityRequestBody.d.ts +19 -0
  121. package/dist/models/UserIdentityRequestBody.js +22 -0
  122. package/dist/models/UserIdentityRequestBody.js.map +1 -0
  123. package/dist/models/UserIdentityResponse.d.ts +19 -0
  124. package/dist/models/UserIdentityResponse.js +22 -0
  125. package/dist/models/UserIdentityResponse.js.map +1 -0
  126. package/dist/models/UserSubscriptionOptions.d.ts +17 -0
  127. package/dist/models/UserSubscriptionOptions.js +22 -0
  128. package/dist/models/UserSubscriptionOptions.js.map +1 -0
  129. package/dist/models/all.d.ts +0 -1
  130. package/dist/models/all.js +0 -1
  131. package/dist/models/all.js.map +1 -1
  132. package/dist/test.d.ts +1 -0
  133. package/dist/test.js +60 -0
  134. package/dist/test.js.map +1 -0
  135. package/dist/types/ObjectParamAPI.js.map +1 -1
  136. package/dist/types/ObservableAPI.js.map +1 -1
  137. package/dist/types/PromiseAPI.js.map +1 -1
  138. package/http/isomorphic-fetch.ts +0 -1
  139. package/models/App.ts +1 -1
  140. package/models/BasicNotification.ts +12 -2
  141. package/models/BasicNotificationAllOf.ts +12 -2
  142. package/models/BasicNotificationAllOfAndroidBackgroundLayout.ts +1 -1
  143. package/models/Button.ts +1 -1
  144. package/models/CreateNotificationSuccessResponse.ts +1 -1
  145. package/models/CreateSegmentConflictResponse.ts +1 -1
  146. package/models/CreateSegmentSuccessResponse.ts +1 -1
  147. package/models/CreateUserConflictResponse.ts +1 -1
  148. package/models/CreateUserConflictResponseErrorsInner.ts +1 -1
  149. package/models/CreateUserConflictResponseErrorsItemsMeta.ts +1 -1
  150. package/models/DeliveryData.ts +1 -1
  151. package/models/ExportEventsSuccessResponse.ts +1 -1
  152. package/models/ExportSubscriptionsRequestBody.ts +1 -1
  153. package/models/ExportSubscriptionsSuccessResponse.ts +1 -1
  154. package/models/Filter.ts +1 -1
  155. package/models/FilterExpression.ts +1 -1
  156. package/models/GenericError.ts +1 -1
  157. package/models/GenericSuccessBoolResponse.ts +1 -1
  158. package/models/GetNotificationHistoryRequestBody.ts +1 -1
  159. package/models/GetSegmentsSuccessResponse.ts +1 -1
  160. package/models/LanguageStringMap.ts +1 -1
  161. package/models/Notification.ts +12 -2
  162. package/models/NotificationAllOf.ts +1 -1
  163. package/models/NotificationHistorySuccessResponse.ts +1 -1
  164. package/models/NotificationSlice.ts +1 -1
  165. package/models/NotificationTarget.ts +1 -1
  166. package/models/NotificationWithMeta.ts +12 -2
  167. package/models/NotificationWithMetaAllOf.ts +1 -1
  168. package/models/ObjectSerializer.ts +4 -7
  169. package/models/Operator.ts +1 -1
  170. package/models/OutcomeData.ts +1 -1
  171. package/models/OutcomesData.ts +1 -1
  172. package/models/PlatformDeliveryData.ts +1 -1
  173. package/models/PlatformDeliveryDataEmailAllOf.ts +1 -1
  174. package/models/PlatformDeliveryDataSmsAllOf.ts +1 -1
  175. package/models/PropertiesBody.ts +1 -1
  176. package/models/PropertiesDeltas.ts +1 -1
  177. package/models/PropertiesObject.ts +1 -1
  178. package/models/Purchase.ts +1 -1
  179. package/models/RateLimitError.ts +1 -1
  180. package/models/Segment.ts +1 -1
  181. package/models/SegmentData.ts +1 -1
  182. package/models/SegmentNotificationTarget.ts +1 -1
  183. package/models/Subscription.ts +1 -1
  184. package/models/SubscriptionBody.ts +1 -1
  185. package/models/SubscriptionNotificationTarget.ts +1 -1
  186. package/models/TransferSubscriptionRequestBody.ts +1 -1
  187. package/models/UpdateLiveActivityRequest.ts +1 -1
  188. package/models/UpdateLiveActivitySuccessResponse.ts +1 -1
  189. package/models/UpdateUserRequest.ts +1 -1
  190. package/models/User.ts +1 -1
  191. package/models/UserIdentityBody.ts +1 -1
  192. package/models/WebButton.ts +1 -1
  193. package/models/all.ts +0 -1
  194. package/onesignal-node-onesignal-5.1.0-beta1.tgz +0 -0
  195. package/package.json +2 -4
  196. package/types/ObjectParamAPI.ts +0 -1
  197. package/types/ObservableAPI.ts +0 -1
  198. package/types/PromiseAPI.ts +0 -1
  199. package/models/InvalidIdentifierError.ts +0 -44
  200. package/models/RateLimiterError.ts +0 -32
@@ -1,7 +1,7 @@
1
1
  name: 🙋‍♂️ Ask a question
2
2
  description: Tell us what's on your mind
3
- title: "[question]: "
4
- labels: ["triage"]
3
+ title: "[Question]: "
4
+ labels: ["Question"]
5
5
  body:
6
6
  - type: markdown
7
7
  attributes:
@@ -22,4 +22,4 @@ body:
22
22
  description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/OneSignal/api/blob/main/CONTRIBUTING.md)
23
23
  options:
24
24
  - label: I agree to follow this project's Code of Conduct
25
- required: true
25
+ required: true
@@ -1,7 +1,7 @@
1
1
  name: 🪳 Bug report
2
2
  description: File a bug report
3
3
  title: "[Bug]: "
4
- labels: ["bug", "triage"]
4
+ labels: ["Bug"]
5
5
  body:
6
6
  - type: markdown
7
7
  attributes:
@@ -48,4 +48,4 @@ body:
48
48
  description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/OneSignal/api/blob/main/CONTRIBUTING.md)
49
49
  options:
50
50
  - label: I agree to follow this project's Code of Conduct
51
- required: true
51
+ required: true
@@ -1,7 +1,7 @@
1
1
  name: 📣 General feedback
2
2
  description: Tell us what's on your mind
3
- title: "[Bug]: "
4
- labels: ["triage"]
3
+ title: "[Feedback]: "
4
+ labels: ["Feedback"]
5
5
  body:
6
6
  - type: markdown
7
7
  attributes:
@@ -22,4 +22,4 @@ body:
22
22
  description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/OneSignal/api/blob/main/CONTRIBUTING.md)
23
23
  options:
24
24
  - label: I agree to follow this project's Code of Conduct
25
- required: true
25
+ required: true
@@ -0,0 +1,17 @@
1
+ name: Add issues to project
2
+
3
+ on:
4
+ issues:
5
+ types:
6
+ - opened
7
+
8
+ jobs:
9
+ add-to-project:
10
+ runs-on: ubuntu-latest
11
+ steps:
12
+ - name: Add issue to project
13
+ uses: actions/add-to-project@v1.0.2
14
+ with:
15
+ # SDK Server Project
16
+ project-url: https://github.com/orgs/OneSignal/projects/11
17
+ github-token: ${{ secrets.GH_PROJECTS_TOKEN }}
package/DefaultApi.md CHANGED
@@ -296,7 +296,7 @@ Name | Type | Description | Notes
296
296
 
297
297
  ### Authorization
298
298
 
299
- [user_auth_key](README.md#user_auth_key)
299
+ [organization_api_key](README.md#organization_api_key)
300
300
 
301
301
  ### HTTP request headers
302
302
 
@@ -863,7 +863,7 @@ Name | Type | Description | Notes
863
863
 
864
864
  ### Authorization
865
865
 
866
- No authorization required
866
+ [rest_api_key](README.md#rest_api_key)
867
867
 
868
868
  ### HTTP request headers
869
869
 
@@ -1167,7 +1167,7 @@ Name | Type | Description | Notes
1167
1167
 
1168
1168
  ### Authorization
1169
1169
 
1170
- [user_auth_key](README.md#user_auth_key)
1170
+ [organization_api_key](README.md#organization_api_key)
1171
1171
 
1172
1172
  ### HTTP request headers
1173
1173
 
@@ -1217,7 +1217,7 @@ This endpoint does not need any parameter.
1217
1217
 
1218
1218
  ### Authorization
1219
1219
 
1220
- [user_auth_key](README.md#user_auth_key)
1220
+ [organization_api_key](README.md#organization_api_key)
1221
1221
 
1222
1222
  ### HTTP request headers
1223
1223
 
@@ -1813,7 +1813,7 @@ Name | Type | Description | Notes
1813
1813
 
1814
1814
  ### Authorization
1815
1815
 
1816
- [user_auth_key](README.md#user_auth_key)
1816
+ [organization_api_key](README.md#organization_api_key)
1817
1817
 
1818
1818
  ### HTTP request headers
1819
1819
 
package/README.md CHANGED
@@ -61,8 +61,8 @@ You can configure auth parameters passing them like this:
61
61
 
62
62
  ```js
63
63
  const configuration = OneSignal.createConfiguration({
64
- userKey: '<YOUR_USER_KEY_TOKEN>',
65
- appKey: '<YOUR_APP_KEY_TOKEN>',
64
+ organizationApiKey: '<YOUR_ORGANIZATION_API_KEY>', // Organization key is only required for creating new apps and other top-level endpoints
65
+ restApiKey: '<YOUR_REST_API_KEY>', // App REST API key required for most endpoints
66
66
  });
67
67
 
68
68
  const client = new OneSignal.DefaultApi(configuration);
@@ -76,8 +76,8 @@ parameter. You can then use this to modify your configuration object and create
76
76
  const response = await client.createApp(newapp);
77
77
 
78
78
  const configuration = OneSignal.createConfiguration({
79
- userKey: '<YOUR_USER_KEY_TOKEN>',
80
- appKey: response.basic_auth_key,
79
+ organizationApiKey: '<YOUR_ORGANIZATION_API_KEY>', // Organization key is only required for creating new apps and other top-level endpoints
80
+ restApiKey: response.basic_auth_key,
81
81
  });
82
82
 
83
83
  const client = new OneSignal.DefaultApi(configuration);
@@ -73,7 +73,7 @@ export class DefaultApiRequestFactory extends BaseAPIRequestFactory {
73
73
  requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8")
74
74
 
75
75
  // Always add the One Signal telemetry to the request.
76
- requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.0.0-alpha-01");
76
+ requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.1.0-beta1");
77
77
 
78
78
  // Query Params
79
79
  if (appId !== undefined) {
@@ -141,7 +141,7 @@ export class DefaultApiRequestFactory extends BaseAPIRequestFactory {
141
141
  requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8")
142
142
 
143
143
  // Always add the One Signal telemetry to the request.
144
- requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.0.0-alpha-01");
144
+ requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.1.0-beta1");
145
145
 
146
146
 
147
147
  // Body Params
@@ -207,7 +207,7 @@ export class DefaultApiRequestFactory extends BaseAPIRequestFactory {
207
207
  requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8")
208
208
 
209
209
  // Always add the One Signal telemetry to the request.
210
- requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.0.0-alpha-01");
210
+ requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.1.0-beta1");
211
211
 
212
212
 
213
213
  // Body Params
@@ -258,7 +258,7 @@ export class DefaultApiRequestFactory extends BaseAPIRequestFactory {
258
258
  requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8")
259
259
 
260
260
  // Always add the One Signal telemetry to the request.
261
- requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.0.0-alpha-01");
261
+ requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.1.0-beta1");
262
262
 
263
263
 
264
264
  // Body Params
@@ -274,7 +274,7 @@ export class DefaultApiRequestFactory extends BaseAPIRequestFactory {
274
274
 
275
275
  let authMethod: SecurityAuthentication | undefined;
276
276
  // Apply auth methods
277
- authMethod = _config.authMethods["user_auth_key"]
277
+ authMethod = _config.authMethods["organization_api_key"]
278
278
  if (authMethod?.applySecurityAuthentication) {
279
279
  await authMethod?.applySecurityAuthentication(requestContext);
280
280
  }
@@ -309,7 +309,7 @@ export class DefaultApiRequestFactory extends BaseAPIRequestFactory {
309
309
  requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8")
310
310
 
311
311
  // Always add the One Signal telemetry to the request.
312
- requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.0.0-alpha-01");
312
+ requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.1.0-beta1");
313
313
 
314
314
 
315
315
  // Body Params
@@ -363,7 +363,7 @@ export class DefaultApiRequestFactory extends BaseAPIRequestFactory {
363
363
  requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8")
364
364
 
365
365
  // Always add the One Signal telemetry to the request.
366
- requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.0.0-alpha-01");
366
+ requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.1.0-beta1");
367
367
 
368
368
 
369
369
  // Body Params
@@ -437,7 +437,7 @@ export class DefaultApiRequestFactory extends BaseAPIRequestFactory {
437
437
  requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8")
438
438
 
439
439
  // Always add the One Signal telemetry to the request.
440
- requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.0.0-alpha-01");
440
+ requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.1.0-beta1");
441
441
 
442
442
 
443
443
  // Body Params
@@ -495,7 +495,7 @@ export class DefaultApiRequestFactory extends BaseAPIRequestFactory {
495
495
  requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8")
496
496
 
497
497
  // Always add the One Signal telemetry to the request.
498
- requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.0.0-alpha-01");
498
+ requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.1.0-beta1");
499
499
 
500
500
 
501
501
  // Body Params
@@ -570,7 +570,7 @@ export class DefaultApiRequestFactory extends BaseAPIRequestFactory {
570
570
  requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8")
571
571
 
572
572
  // Always add the One Signal telemetry to the request.
573
- requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.0.0-alpha-01");
573
+ requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.1.0-beta1");
574
574
 
575
575
 
576
576
  let authMethod: SecurityAuthentication | undefined;
@@ -619,7 +619,7 @@ export class DefaultApiRequestFactory extends BaseAPIRequestFactory {
619
619
  requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8")
620
620
 
621
621
  // Always add the One Signal telemetry to the request.
622
- requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.0.0-alpha-01");
622
+ requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.1.0-beta1");
623
623
 
624
624
 
625
625
  let authMethod: SecurityAuthentication | undefined;
@@ -667,7 +667,7 @@ export class DefaultApiRequestFactory extends BaseAPIRequestFactory {
667
667
  requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8")
668
668
 
669
669
  // Always add the One Signal telemetry to the request.
670
- requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.0.0-alpha-01");
670
+ requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.1.0-beta1");
671
671
 
672
672
 
673
673
  let authMethod: SecurityAuthentication | undefined;
@@ -723,9 +723,15 @@ export class DefaultApiRequestFactory extends BaseAPIRequestFactory {
723
723
  requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8")
724
724
 
725
725
  // Always add the One Signal telemetry to the request.
726
- requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.0.0-alpha-01");
726
+ requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.1.0-beta1");
727
727
 
728
728
 
729
+ let authMethod: SecurityAuthentication | undefined;
730
+ // Apply auth methods
731
+ authMethod = _config.authMethods["rest_api_key"]
732
+ if (authMethod?.applySecurityAuthentication) {
733
+ await authMethod?.applySecurityAuthentication(requestContext);
734
+ }
729
735
 
730
736
  const defaultAuth: SecurityAuthentication | undefined = _options?.authMethods?.default || this.configuration?.authMethods?.default
731
737
  if (defaultAuth?.applySecurityAuthentication) {
@@ -765,7 +771,7 @@ export class DefaultApiRequestFactory extends BaseAPIRequestFactory {
765
771
  requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8")
766
772
 
767
773
  // Always add the One Signal telemetry to the request.
768
- requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.0.0-alpha-01");
774
+ requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.1.0-beta1");
769
775
 
770
776
  // Query Params
771
777
  if (appId !== undefined) {
@@ -813,7 +819,7 @@ export class DefaultApiRequestFactory extends BaseAPIRequestFactory {
813
819
  requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8")
814
820
 
815
821
  // Always add the One Signal telemetry to the request.
816
- requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.0.0-alpha-01");
822
+ requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.1.0-beta1");
817
823
 
818
824
 
819
825
  // Body Params
@@ -880,7 +886,7 @@ export class DefaultApiRequestFactory extends BaseAPIRequestFactory {
880
886
  requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8")
881
887
 
882
888
  // Always add the One Signal telemetry to the request.
883
- requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.0.0-alpha-01");
889
+ requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.1.0-beta1");
884
890
 
885
891
 
886
892
  let authMethod: SecurityAuthentication | undefined;
@@ -928,7 +934,7 @@ export class DefaultApiRequestFactory extends BaseAPIRequestFactory {
928
934
  requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8")
929
935
 
930
936
  // Always add the One Signal telemetry to the request.
931
- requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.0.0-alpha-01");
937
+ requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.1.0-beta1");
932
938
 
933
939
 
934
940
  let authMethod: SecurityAuthentication | undefined;
@@ -969,12 +975,12 @@ export class DefaultApiRequestFactory extends BaseAPIRequestFactory {
969
975
  requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8")
970
976
 
971
977
  // Always add the One Signal telemetry to the request.
972
- requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.0.0-alpha-01");
978
+ requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.1.0-beta1");
973
979
 
974
980
 
975
981
  let authMethod: SecurityAuthentication | undefined;
976
982
  // Apply auth methods
977
- authMethod = _config.authMethods["user_auth_key"]
983
+ authMethod = _config.authMethods["organization_api_key"]
978
984
  if (authMethod?.applySecurityAuthentication) {
979
985
  await authMethod?.applySecurityAuthentication(requestContext);
980
986
  }
@@ -1002,12 +1008,12 @@ export class DefaultApiRequestFactory extends BaseAPIRequestFactory {
1002
1008
  requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8")
1003
1009
 
1004
1010
  // Always add the One Signal telemetry to the request.
1005
- requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.0.0-alpha-01");
1011
+ requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.1.0-beta1");
1006
1012
 
1007
1013
 
1008
1014
  let authMethod: SecurityAuthentication | undefined;
1009
1015
  // Apply auth methods
1010
- authMethod = _config.authMethods["user_auth_key"]
1016
+ authMethod = _config.authMethods["organization_api_key"]
1011
1017
  if (authMethod?.applySecurityAuthentication) {
1012
1018
  await authMethod?.applySecurityAuthentication(requestContext);
1013
1019
  }
@@ -1050,7 +1056,7 @@ export class DefaultApiRequestFactory extends BaseAPIRequestFactory {
1050
1056
  requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8")
1051
1057
 
1052
1058
  // Always add the One Signal telemetry to the request.
1053
- requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.0.0-alpha-01");
1059
+ requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.1.0-beta1");
1054
1060
 
1055
1061
  // Query Params
1056
1062
  if (appId !== undefined) {
@@ -1103,7 +1109,7 @@ export class DefaultApiRequestFactory extends BaseAPIRequestFactory {
1103
1109
  requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8")
1104
1110
 
1105
1111
  // Always add the One Signal telemetry to the request.
1106
- requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.0.0-alpha-01");
1112
+ requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.1.0-beta1");
1107
1113
 
1108
1114
 
1109
1115
  // Body Params
@@ -1160,7 +1166,7 @@ export class DefaultApiRequestFactory extends BaseAPIRequestFactory {
1160
1166
  requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8")
1161
1167
 
1162
1168
  // Always add the One Signal telemetry to the request.
1163
- requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.0.0-alpha-01");
1169
+ requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.1.0-beta1");
1164
1170
 
1165
1171
  // Query Params
1166
1172
  if (appId !== undefined) {
@@ -1236,7 +1242,7 @@ export class DefaultApiRequestFactory extends BaseAPIRequestFactory {
1236
1242
  requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8")
1237
1243
 
1238
1244
  // Always add the One Signal telemetry to the request.
1239
- requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.0.0-alpha-01");
1245
+ requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.1.0-beta1");
1240
1246
 
1241
1247
  // Query Params
1242
1248
  if (outcomeNames !== undefined) {
@@ -1306,7 +1312,7 @@ export class DefaultApiRequestFactory extends BaseAPIRequestFactory {
1306
1312
  requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8")
1307
1313
 
1308
1314
  // Always add the One Signal telemetry to the request.
1309
- requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.0.0-alpha-01");
1315
+ requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.1.0-beta1");
1310
1316
 
1311
1317
  // Query Params
1312
1318
  if (offset !== undefined) {
@@ -1372,7 +1378,7 @@ export class DefaultApiRequestFactory extends BaseAPIRequestFactory {
1372
1378
  requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8")
1373
1379
 
1374
1380
  // Always add the One Signal telemetry to the request.
1375
- requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.0.0-alpha-01");
1381
+ requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.1.0-beta1");
1376
1382
 
1377
1383
 
1378
1384
  let authMethod: SecurityAuthentication | undefined;
@@ -1427,7 +1433,7 @@ export class DefaultApiRequestFactory extends BaseAPIRequestFactory {
1427
1433
  requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8")
1428
1434
 
1429
1435
  // Always add the One Signal telemetry to the request.
1430
- requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.0.0-alpha-01");
1436
+ requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.1.0-beta1");
1431
1437
 
1432
1438
 
1433
1439
  // Body Params
@@ -1494,7 +1500,7 @@ export class DefaultApiRequestFactory extends BaseAPIRequestFactory {
1494
1500
  requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8")
1495
1501
 
1496
1502
  // Always add the One Signal telemetry to the request.
1497
- requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.0.0-alpha-01");
1503
+ requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.1.0-beta1");
1498
1504
 
1499
1505
  // Query Params
1500
1506
  if (token !== undefined) {
@@ -1547,7 +1553,7 @@ export class DefaultApiRequestFactory extends BaseAPIRequestFactory {
1547
1553
  requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8")
1548
1554
 
1549
1555
  // Always add the One Signal telemetry to the request.
1550
- requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.0.0-alpha-01");
1556
+ requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.1.0-beta1");
1551
1557
 
1552
1558
 
1553
1559
  // Body Params
@@ -1563,7 +1569,7 @@ export class DefaultApiRequestFactory extends BaseAPIRequestFactory {
1563
1569
 
1564
1570
  let authMethod: SecurityAuthentication | undefined;
1565
1571
  // Apply auth methods
1566
- authMethod = _config.authMethods["user_auth_key"]
1572
+ authMethod = _config.authMethods["organization_api_key"]
1567
1573
  if (authMethod?.applySecurityAuthentication) {
1568
1574
  await authMethod?.applySecurityAuthentication(requestContext);
1569
1575
  }
@@ -1614,7 +1620,7 @@ export class DefaultApiRequestFactory extends BaseAPIRequestFactory {
1614
1620
  requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8")
1615
1621
 
1616
1622
  // Always add the One Signal telemetry to the request.
1617
- requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.0.0-alpha-01");
1623
+ requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.1.0-beta1");
1618
1624
 
1619
1625
 
1620
1626
  // Body Params
@@ -1680,7 +1686,7 @@ export class DefaultApiRequestFactory extends BaseAPIRequestFactory {
1680
1686
  requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8")
1681
1687
 
1682
1688
  // Always add the One Signal telemetry to the request.
1683
- requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.0.0-alpha-01");
1689
+ requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.1.0-beta1");
1684
1690
 
1685
1691
 
1686
1692
  // Body Params
@@ -1754,7 +1760,7 @@ export class DefaultApiRequestFactory extends BaseAPIRequestFactory {
1754
1760
  requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8")
1755
1761
 
1756
1762
  // Always add the One Signal telemetry to the request.
1757
- requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.0.0-alpha-01");
1763
+ requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.1.0-beta1");
1758
1764
 
1759
1765
 
1760
1766
  // Body Params
package/auth/auth.ts CHANGED
@@ -27,7 +27,7 @@ export interface TokenProvider {
27
27
  /**
28
28
  * Applies http authentication to the request context.
29
29
  */
30
- export class RestApiKeyAuthentication implements SecurityAuthentication {
30
+ export class OrganizationApiKeyAuthentication implements SecurityAuthentication {
31
31
  /**
32
32
  * Configures the http authentication with the required details.
33
33
  *
@@ -36,18 +36,18 @@ export class RestApiKeyAuthentication implements SecurityAuthentication {
36
36
  public constructor(private tokenProvider: TokenProvider) {}
37
37
 
38
38
  public getName(): string {
39
- return "rest_api_key";
39
+ return "organization_api_key";
40
40
  }
41
41
 
42
42
  public async applySecurityAuthentication(context: RequestContext) {
43
- context.setHeaderParam("Authorization", "Bearer " + await this.tokenProvider.getToken());
43
+ context.setHeaderParam("Authorization", "Key " + await this.tokenProvider.getToken());
44
44
  }
45
45
  }
46
46
 
47
47
  /**
48
48
  * Applies http authentication to the request context.
49
49
  */
50
- export class UserAuthKeyAuthentication implements SecurityAuthentication {
50
+ export class RestApiKeyAuthentication implements SecurityAuthentication {
51
51
  /**
52
52
  * Configures the http authentication with the required details.
53
53
  *
@@ -56,19 +56,19 @@ export class UserAuthKeyAuthentication implements SecurityAuthentication {
56
56
  public constructor(private tokenProvider: TokenProvider) {}
57
57
 
58
58
  public getName(): string {
59
- return "user_auth_key";
59
+ return "rest_api_key";
60
60
  }
61
61
 
62
62
  public async applySecurityAuthentication(context: RequestContext) {
63
- context.setHeaderParam("Authorization", "Bearer " + await this.tokenProvider.getToken());
63
+ context.setHeaderParam("Authorization", "Key " + await this.tokenProvider.getToken());
64
64
  }
65
65
  }
66
66
 
67
67
 
68
68
  export type AuthMethods = {
69
69
  "default"?: SecurityAuthentication,
70
- "rest_api_key"?: SecurityAuthentication,
71
- "user_auth_key"?: SecurityAuthentication
70
+ "organization_api_key"?: SecurityAuthentication,
71
+ "rest_api_key"?: SecurityAuthentication
72
72
  }
73
73
 
74
74
  export type ApiKeyConfiguration = string;
@@ -78,8 +78,8 @@ export type OAuth2Configuration = { accessToken: string };
78
78
 
79
79
  export type AuthMethodsConfiguration = {
80
80
  "default"?: SecurityAuthentication,
81
- "rest_api_key"?: HttpBearerConfiguration,
82
- "user_auth_key"?: HttpBearerConfiguration
81
+ "organization_api_key"?: HttpBearerConfiguration,
82
+ "rest_api_key"?: HttpBearerConfiguration
83
83
  }
84
84
 
85
85
  /**
@@ -94,15 +94,15 @@ export function configureAuthMethods(config: AuthMethodsConfiguration | undefine
94
94
  }
95
95
  authMethods["default"] = config["default"]
96
96
 
97
- if (config["rest_api_key"]) {
98
- authMethods["rest_api_key"] = new RestApiKeyAuthentication(
99
- config["rest_api_key"]["tokenProvider"]
97
+ if (config["organization_api_key"]) {
98
+ authMethods["organization_api_key"] = new OrganizationApiKeyAuthentication(
99
+ config["organization_api_key"]["tokenProvider"]
100
100
  );
101
101
  }
102
102
 
103
- if (config["user_auth_key"]) {
104
- authMethods["user_auth_key"] = new UserAuthKeyAuthentication(
105
- config["user_auth_key"]["tokenProvider"]
103
+ if (config["rest_api_key"]) {
104
+ authMethods["rest_api_key"] = new RestApiKeyAuthentication(
105
+ config["rest_api_key"]["tokenProvider"]
106
106
  );
107
107
  }
108
108
 
package/configuration.ts CHANGED
@@ -39,8 +39,8 @@ export interface ConfigurationParameters {
39
39
  /**
40
40
  * Faster way to configure authentication methods
41
41
  */
42
+ organizationApiKey?: string;
42
43
  restApiKey?: string;
43
- userAuthKey?: string;
44
44
  }
45
45
 
46
46
  /**
@@ -58,14 +58,14 @@ export interface ConfigurationParameters {
58
58
  export function createConfiguration(conf: ConfigurationParameters): Configuration {
59
59
 
60
60
  const authMethods: AuthMethodsConfiguration = {
61
- 'rest_api_key': {
61
+ 'organization_api_key': {
62
62
  tokenProvider: {
63
- getToken: () => conf.restApiKey || ''
63
+ getToken: () => conf.organizationApiKey || ''
64
64
  }
65
65
  },
66
- 'user_auth_key': {
66
+ 'rest_api_key': {
67
67
  tokenProvider: {
68
- getToken: () => conf.userAuthKey || ''
68
+ getToken: () => conf.restApiKey || ''
69
69
  }
70
70
  },
71
71
  }