@onesignal/node-onesignal 5.0.0-alpha-02 → 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 (113) 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 +4 -4
  6. package/README.md +6 -6
  7. package/apis/DefaultApi.ts +34 -34
  8. package/auth/auth.ts +16 -16
  9. package/configuration.ts +5 -5
  10. package/dist/apis/DefaultApi.js +34 -34
  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/isomorphic-fetch.js +1 -2
  19. package/dist/http/isomorphic-fetch.js.map +1 -1
  20. package/dist/models/BasicNotification.d.ts +1 -0
  21. package/dist/models/BasicNotification.js +6 -0
  22. package/dist/models/BasicNotification.js.map +1 -1
  23. package/dist/models/BasicNotificationAllOf.d.ts +1 -0
  24. package/dist/models/BasicNotificationAllOf.js +6 -0
  25. package/dist/models/BasicNotificationAllOf.js.map +1 -1
  26. package/dist/models/InvalidIdentifierError.d.ts +1 -1
  27. package/dist/models/InvalidIdentifierError.js +2 -2
  28. package/dist/models/InvalidIdentifierError.js.map +1 -1
  29. package/dist/models/Notification.d.ts +1 -0
  30. package/dist/models/Notification.js +6 -0
  31. package/dist/models/Notification.js.map +1 -1
  32. package/dist/models/NotificationWithMeta.d.ts +1 -0
  33. package/dist/models/NotificationWithMeta.js +6 -0
  34. package/dist/models/NotificationWithMeta.js.map +1 -1
  35. package/dist/models/ObjectSerializer.d.ts +0 -1
  36. package/dist/models/ObjectSerializer.js +0 -3
  37. package/dist/models/ObjectSerializer.js.map +1 -1
  38. package/dist/models/all.d.ts +0 -1
  39. package/dist/models/all.js +0 -1
  40. package/dist/models/all.js.map +1 -1
  41. package/dist/{test/DefaultApi.test.js → test.js} +21 -10
  42. package/dist/test.js.map +1 -0
  43. package/dist/types/ObjectParamAPI.js.map +1 -1
  44. package/dist/types/ObservableAPI.js.map +1 -1
  45. package/dist/types/PromiseAPI.js.map +1 -1
  46. package/http/isomorphic-fetch.ts +0 -1
  47. package/models/App.ts +1 -1
  48. package/models/BasicNotification.ts +12 -2
  49. package/models/BasicNotificationAllOf.ts +12 -2
  50. package/models/BasicNotificationAllOfAndroidBackgroundLayout.ts +1 -1
  51. package/models/Button.ts +1 -1
  52. package/models/CreateNotificationSuccessResponse.ts +1 -1
  53. package/models/CreateSegmentConflictResponse.ts +1 -1
  54. package/models/CreateSegmentSuccessResponse.ts +1 -1
  55. package/models/CreateUserConflictResponse.ts +1 -1
  56. package/models/CreateUserConflictResponseErrorsInner.ts +1 -1
  57. package/models/CreateUserConflictResponseErrorsItemsMeta.ts +1 -1
  58. package/models/DeliveryData.ts +1 -1
  59. package/models/ExportEventsSuccessResponse.ts +1 -1
  60. package/models/ExportSubscriptionsRequestBody.ts +1 -1
  61. package/models/ExportSubscriptionsSuccessResponse.ts +1 -1
  62. package/models/Filter.ts +1 -1
  63. package/models/FilterExpression.ts +1 -1
  64. package/models/GenericError.ts +1 -1
  65. package/models/GenericSuccessBoolResponse.ts +1 -1
  66. package/models/GetNotificationHistoryRequestBody.ts +1 -1
  67. package/models/GetSegmentsSuccessResponse.ts +1 -1
  68. package/models/LanguageStringMap.ts +1 -1
  69. package/models/Notification.ts +12 -2
  70. package/models/NotificationAllOf.ts +1 -1
  71. package/models/NotificationHistorySuccessResponse.ts +1 -1
  72. package/models/NotificationSlice.ts +1 -1
  73. package/models/NotificationTarget.ts +1 -1
  74. package/models/NotificationWithMeta.ts +12 -2
  75. package/models/NotificationWithMetaAllOf.ts +1 -1
  76. package/models/ObjectSerializer.ts +4 -7
  77. package/models/Operator.ts +1 -1
  78. package/models/OutcomeData.ts +1 -1
  79. package/models/OutcomesData.ts +1 -1
  80. package/models/PlatformDeliveryData.ts +1 -1
  81. package/models/PlatformDeliveryDataEmailAllOf.ts +1 -1
  82. package/models/PlatformDeliveryDataSmsAllOf.ts +1 -1
  83. package/models/PropertiesBody.ts +1 -1
  84. package/models/PropertiesDeltas.ts +1 -1
  85. package/models/PropertiesObject.ts +1 -1
  86. package/models/Purchase.ts +1 -1
  87. package/models/RateLimitError.ts +1 -1
  88. package/models/Segment.ts +1 -1
  89. package/models/SegmentData.ts +1 -1
  90. package/models/SegmentNotificationTarget.ts +1 -1
  91. package/models/Subscription.ts +1 -1
  92. package/models/SubscriptionBody.ts +1 -1
  93. package/models/SubscriptionNotificationTarget.ts +1 -1
  94. package/models/TransferSubscriptionRequestBody.ts +1 -1
  95. package/models/UpdateLiveActivityRequest.ts +1 -1
  96. package/models/UpdateLiveActivitySuccessResponse.ts +1 -1
  97. package/models/UpdateUserRequest.ts +1 -1
  98. package/models/User.ts +1 -1
  99. package/models/UserIdentityBody.ts +1 -1
  100. package/models/WebButton.ts +1 -1
  101. package/models/all.ts +0 -1
  102. package/onesignal-node-onesignal-5.1.0-beta1.tgz +0 -0
  103. package/package.json +2 -4
  104. package/types/ObjectParamAPI.ts +0 -1
  105. package/types/ObservableAPI.ts +0 -1
  106. package/types/PromiseAPI.ts +0 -1
  107. package/dist/jest.config.d.ts +0 -15
  108. package/dist/jest.config.js +0 -17
  109. package/dist/jest.config.js.map +0 -1
  110. package/dist/test/DefaultApi.test.js.map +0 -1
  111. package/models/InvalidIdentifierError.ts +0 -44
  112. package/models/RateLimiterError.ts +0 -32
  113. /package/dist/{test/DefaultApi.test.d.ts → test.d.ts} +0 -0
@@ -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
 
@@ -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
- userAuthKey: '<YOUR_USER_AUTH_KEY>',
65
- restApiKey: '<YOUR_REST_API_KEY>',
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,7 +76,7 @@ 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
- userAuthKey: '<YOUR_USER_KEY_TOKEN>',
79
+ organizationApiKey: '<YOUR_ORGANIZATION_API_KEY>', // Organization key is only required for creating new apps and other top-level endpoints
80
80
  restApiKey: response.basic_auth_key,
81
81
  });
82
82
 
@@ -86,14 +86,14 @@ const client = new OneSignal.DefaultApi(configuration);
86
86
  ---
87
87
  ## API Reference
88
88
 
89
- > See the full list of [API Endpoints](DefaultApi.md).
89
+ > See the full list of [API Endpoints](DefaultApi.MD).
90
90
 
91
91
  To make stateful changes requests should take on the following pattern:
92
92
  1. create or get an object
93
93
  2. make changes to that object
94
94
  3. pass the object to the request function to make the changes
95
95
 
96
- Examples of important OneSignal objects include `App`, `Notification`, `User`, and `Segment`.
96
+ Examples of important OneSignal objects include `App`, `Notification`, `Player`, and `Segment`.
97
97
 
98
98
  For example, see the section below on creating an app. First an app object is created via the instantiation of the `App`
99
99
  class. Then, the app instance is modified directly. Finally, we use the `client` to create the app via a remote request.
@@ -586,4 +586,4 @@ Give a ⭐️ if this project helped you!
586
586
 
587
587
  Copyright © 2023 [OneSignal](https://github.com/OneSignal).
588
588
 
589
- This project is [MIT](https://github.com/OneSignal/node-onesignal/blob/main/LICENSE) licensed.
589
+ This project is [MIT](https://github.com/OneSignal/node-onesignal/blob/main/LICENSE) licensed.
@@ -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.1");
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.1");
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.1");
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.1");
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.1");
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.1");
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.1");
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.1");
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.1");
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.1");
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.1");
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,7 +723,7 @@ 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.1");
726
+ requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.1.0-beta1");
727
727
 
728
728
 
729
729
  let authMethod: SecurityAuthentication | undefined;
@@ -771,7 +771,7 @@ export class DefaultApiRequestFactory extends BaseAPIRequestFactory {
771
771
  requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8")
772
772
 
773
773
  // Always add the One Signal telemetry to the request.
774
- requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.0.1");
774
+ requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.1.0-beta1");
775
775
 
776
776
  // Query Params
777
777
  if (appId !== undefined) {
@@ -819,7 +819,7 @@ export class DefaultApiRequestFactory extends BaseAPIRequestFactory {
819
819
  requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8")
820
820
 
821
821
  // Always add the One Signal telemetry to the request.
822
- requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.0.1");
822
+ requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.1.0-beta1");
823
823
 
824
824
 
825
825
  // Body Params
@@ -886,7 +886,7 @@ export class DefaultApiRequestFactory extends BaseAPIRequestFactory {
886
886
  requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8")
887
887
 
888
888
  // Always add the One Signal telemetry to the request.
889
- requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.0.1");
889
+ requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.1.0-beta1");
890
890
 
891
891
 
892
892
  let authMethod: SecurityAuthentication | undefined;
@@ -934,7 +934,7 @@ export class DefaultApiRequestFactory extends BaseAPIRequestFactory {
934
934
  requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8")
935
935
 
936
936
  // Always add the One Signal telemetry to the request.
937
- requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.0.1");
937
+ requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.1.0-beta1");
938
938
 
939
939
 
940
940
  let authMethod: SecurityAuthentication | undefined;
@@ -975,12 +975,12 @@ export class DefaultApiRequestFactory extends BaseAPIRequestFactory {
975
975
  requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8")
976
976
 
977
977
  // Always add the One Signal telemetry to the request.
978
- requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.0.1");
978
+ requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.1.0-beta1");
979
979
 
980
980
 
981
981
  let authMethod: SecurityAuthentication | undefined;
982
982
  // Apply auth methods
983
- authMethod = _config.authMethods["user_auth_key"]
983
+ authMethod = _config.authMethods["organization_api_key"]
984
984
  if (authMethod?.applySecurityAuthentication) {
985
985
  await authMethod?.applySecurityAuthentication(requestContext);
986
986
  }
@@ -1008,12 +1008,12 @@ export class DefaultApiRequestFactory extends BaseAPIRequestFactory {
1008
1008
  requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8")
1009
1009
 
1010
1010
  // Always add the One Signal telemetry to the request.
1011
- requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.0.1");
1011
+ requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.1.0-beta1");
1012
1012
 
1013
1013
 
1014
1014
  let authMethod: SecurityAuthentication | undefined;
1015
1015
  // Apply auth methods
1016
- authMethod = _config.authMethods["user_auth_key"]
1016
+ authMethod = _config.authMethods["organization_api_key"]
1017
1017
  if (authMethod?.applySecurityAuthentication) {
1018
1018
  await authMethod?.applySecurityAuthentication(requestContext);
1019
1019
  }
@@ -1056,7 +1056,7 @@ export class DefaultApiRequestFactory extends BaseAPIRequestFactory {
1056
1056
  requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8")
1057
1057
 
1058
1058
  // Always add the One Signal telemetry to the request.
1059
- requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.0.1");
1059
+ requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.1.0-beta1");
1060
1060
 
1061
1061
  // Query Params
1062
1062
  if (appId !== undefined) {
@@ -1109,7 +1109,7 @@ export class DefaultApiRequestFactory extends BaseAPIRequestFactory {
1109
1109
  requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8")
1110
1110
 
1111
1111
  // Always add the One Signal telemetry to the request.
1112
- requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.0.1");
1112
+ requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.1.0-beta1");
1113
1113
 
1114
1114
 
1115
1115
  // Body Params
@@ -1166,7 +1166,7 @@ export class DefaultApiRequestFactory extends BaseAPIRequestFactory {
1166
1166
  requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8")
1167
1167
 
1168
1168
  // Always add the One Signal telemetry to the request.
1169
- requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.0.1");
1169
+ requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.1.0-beta1");
1170
1170
 
1171
1171
  // Query Params
1172
1172
  if (appId !== undefined) {
@@ -1242,7 +1242,7 @@ export class DefaultApiRequestFactory extends BaseAPIRequestFactory {
1242
1242
  requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8")
1243
1243
 
1244
1244
  // Always add the One Signal telemetry to the request.
1245
- requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.0.1");
1245
+ requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.1.0-beta1");
1246
1246
 
1247
1247
  // Query Params
1248
1248
  if (outcomeNames !== undefined) {
@@ -1312,7 +1312,7 @@ export class DefaultApiRequestFactory extends BaseAPIRequestFactory {
1312
1312
  requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8")
1313
1313
 
1314
1314
  // Always add the One Signal telemetry to the request.
1315
- requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.0.1");
1315
+ requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.1.0-beta1");
1316
1316
 
1317
1317
  // Query Params
1318
1318
  if (offset !== undefined) {
@@ -1378,7 +1378,7 @@ export class DefaultApiRequestFactory extends BaseAPIRequestFactory {
1378
1378
  requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8")
1379
1379
 
1380
1380
  // Always add the One Signal telemetry to the request.
1381
- requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.0.1");
1381
+ requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.1.0-beta1");
1382
1382
 
1383
1383
 
1384
1384
  let authMethod: SecurityAuthentication | undefined;
@@ -1433,7 +1433,7 @@ export class DefaultApiRequestFactory extends BaseAPIRequestFactory {
1433
1433
  requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8")
1434
1434
 
1435
1435
  // Always add the One Signal telemetry to the request.
1436
- requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.0.1");
1436
+ requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.1.0-beta1");
1437
1437
 
1438
1438
 
1439
1439
  // Body Params
@@ -1500,7 +1500,7 @@ export class DefaultApiRequestFactory extends BaseAPIRequestFactory {
1500
1500
  requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8")
1501
1501
 
1502
1502
  // Always add the One Signal telemetry to the request.
1503
- requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.0.1");
1503
+ requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.1.0-beta1");
1504
1504
 
1505
1505
  // Query Params
1506
1506
  if (token !== undefined) {
@@ -1553,7 +1553,7 @@ export class DefaultApiRequestFactory extends BaseAPIRequestFactory {
1553
1553
  requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8")
1554
1554
 
1555
1555
  // Always add the One Signal telemetry to the request.
1556
- requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.0.1");
1556
+ requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.1.0-beta1");
1557
1557
 
1558
1558
 
1559
1559
  // Body Params
@@ -1569,7 +1569,7 @@ export class DefaultApiRequestFactory extends BaseAPIRequestFactory {
1569
1569
 
1570
1570
  let authMethod: SecurityAuthentication | undefined;
1571
1571
  // Apply auth methods
1572
- authMethod = _config.authMethods["user_auth_key"]
1572
+ authMethod = _config.authMethods["organization_api_key"]
1573
1573
  if (authMethod?.applySecurityAuthentication) {
1574
1574
  await authMethod?.applySecurityAuthentication(requestContext);
1575
1575
  }
@@ -1620,7 +1620,7 @@ export class DefaultApiRequestFactory extends BaseAPIRequestFactory {
1620
1620
  requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8")
1621
1621
 
1622
1622
  // Always add the One Signal telemetry to the request.
1623
- requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.0.1");
1623
+ requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.1.0-beta1");
1624
1624
 
1625
1625
 
1626
1626
  // Body Params
@@ -1686,7 +1686,7 @@ export class DefaultApiRequestFactory extends BaseAPIRequestFactory {
1686
1686
  requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8")
1687
1687
 
1688
1688
  // Always add the One Signal telemetry to the request.
1689
- requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.0.1");
1689
+ requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.1.0-beta1");
1690
1690
 
1691
1691
 
1692
1692
  // Body Params
@@ -1760,7 +1760,7 @@ export class DefaultApiRequestFactory extends BaseAPIRequestFactory {
1760
1760
  requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8")
1761
1761
 
1762
1762
  // Always add the One Signal telemetry to the request.
1763
- requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.0.1");
1763
+ requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.1.0-beta1");
1764
1764
 
1765
1765
 
1766
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
  }