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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (234) hide show
  1. package/.github/ISSUE_TEMPLATE/ask-question.yml +25 -0
  2. package/.github/ISSUE_TEMPLATE/bug-report.yml +51 -0
  3. package/.github/ISSUE_TEMPLATE/general-feedback.yml +25 -0
  4. package/.github/pull_request_template.md +44 -0
  5. package/.github/workflows/npm_deploy.yml +23 -0
  6. package/CHANGELOG.md +29 -0
  7. package/DefaultApi.md +1232 -0
  8. package/LICENSE +24 -0
  9. package/README.md +205 -102
  10. package/RELEASE_INSTRUCTIONS.md +2 -0
  11. package/apis/DefaultApi.ts +519 -532
  12. package/apis/baseapi.ts +4 -4
  13. package/apis/exception.ts +4 -3
  14. package/auth/auth.ts +4 -1
  15. package/configuration.ts +21 -2
  16. package/http/http.ts +26 -26
  17. package/index.ts +1 -0
  18. package/middleware.ts +1 -1
  19. package/models/App.ts +8 -8
  20. package/models/BasicNotification.ts +1019 -0
  21. package/models/BasicNotificationAllOf.ts +897 -0
  22. package/models/{NotificationAllOfAndroidBackgroundLayout.ts → BasicNotificationAllOfAndroidBackgroundLayout.ts} +4 -4
  23. package/models/Button.ts +2 -2
  24. package/models/CancelNotificationSuccessResponse.ts +31 -0
  25. package/models/{InlineResponse400.ts → CreateNotificationBadRequestResponse.ts} +4 -4
  26. package/models/{InlineResponse200.ts → CreateNotificationSuccessResponse.ts} +7 -6
  27. package/models/{InlineResponse2004.ts → CreatePlayerSuccessResponse.ts} +4 -4
  28. package/models/CreateSegmentBadRequestResponse.ts +38 -0
  29. package/models/{InlineResponse409.ts → CreateSegmentConflictResponse.ts} +4 -4
  30. package/models/{InlineResponse201.ts → CreateSegmentSuccessResponse.ts} +4 -4
  31. package/models/DeletePlayerBadRequestResponse.ts +31 -0
  32. package/models/DeletePlayerNotFoundResponse.ts +31 -0
  33. package/models/{InlineResponse2003.ts → DeletePlayerSuccessResponse.ts} +4 -4
  34. package/models/{InlineResponse4002.ts → DeleteSegmentBadRequestResponse.ts} +4 -4
  35. package/models/DeleteSegmentNotFoundResponse.ts +31 -0
  36. package/models/DeleteSegmentSuccessResponse.ts +31 -0
  37. package/models/DeliveryData.ts +17 -2
  38. package/models/ExportPlayersRequestBody.ts +5 -5
  39. package/models/{InlineResponse2005.ts → ExportPlayersSuccessResponse.ts} +4 -4
  40. package/models/Filter.ts +4 -4
  41. package/models/FilterExpressions.ts +4 -4
  42. package/models/FilterNotificationTarget.ts +2 -2
  43. package/models/GetNotificationRequestBody.ts +2 -2
  44. package/models/InvalidIdentifierError.ts +44 -0
  45. package/models/Notification.ts +72 -174
  46. package/models/Notification200Errors.ts +45 -0
  47. package/models/NotificationAllOf.ts +3 -858
  48. package/models/{InlineResponse4001.ts → NotificationHistoryBadRequestResponse.ts} +4 -4
  49. package/models/{InlineResponse2002.ts → NotificationHistorySuccessResponse.ts} +6 -6
  50. package/models/NotificationSlice.ts +5 -5
  51. package/models/NotificationTarget.ts +3 -124
  52. package/models/NotificationWithMeta.ts +1127 -0
  53. package/models/NotificationWithMetaAllOf.ts +132 -0
  54. package/models/ObjectSerializer.ts +97 -46
  55. package/models/Operator.ts +2 -2
  56. package/models/OutcomeData.ts +2 -2
  57. package/models/OutcomesData.ts +32 -0
  58. package/models/PlatformDeliveryData.ts +18 -2
  59. package/models/PlatformDeliveryDataEmailAllOf.ts +94 -0
  60. package/models/PlatformDeliveryDataSmsAllOf.ts +54 -0
  61. package/models/Player.ts +14 -14
  62. package/models/PlayerNotificationTarget.ts +3 -3
  63. package/models/PlayerSlice.ts +2 -2
  64. package/models/Purchase.ts +2 -2
  65. package/models/Segment.ts +3 -3
  66. package/models/SegmentNotificationTarget.ts +2 -2
  67. package/models/StringMap.ts +3 -3
  68. package/models/{InlineResponse2001.ts → UpdatePlayerSuccessResponse.ts} +6 -6
  69. package/models/UpdatePlayerTagsRequestBody.ts +4 -4
  70. package/models/UpdatePlayerTagsSuccessResponse.ts +31 -0
  71. package/models/all.ts +28 -13
  72. package/package.json +14 -9
  73. package/tsconfig.json +1 -2
  74. package/types/ObjectParamAPI.ts +101 -86
  75. package/types/ObservableAPI.ts +116 -101
  76. package/types/PromiseAPI.ts +97 -82
  77. package/util.ts +10 -1
  78. package/dist/apis/DefaultApi.d.ts +0 -62
  79. package/dist/apis/DefaultApi.js +0 -1317
  80. package/dist/apis/DefaultApi.js.map +0 -1
  81. package/dist/apis/baseapi.d.ts +0 -16
  82. package/dist/apis/baseapi.js +0 -42
  83. package/dist/apis/baseapi.js.map +0 -1
  84. package/dist/apis/exception.d.ts +0 -5
  85. package/dist/apis/exception.js +0 -28
  86. package/dist/apis/exception.js.map +0 -1
  87. package/dist/auth/auth.d.ts +0 -40
  88. package/dist/auth/auth.js +0 -108
  89. package/dist/auth/auth.js.map +0 -1
  90. package/dist/configuration.d.ts +0 -18
  91. package/dist/configuration.js +0 -21
  92. package/dist/configuration.js.map +0 -1
  93. package/dist/http/http.d.ts +0 -72
  94. package/dist/http/http.js +0 -205
  95. package/dist/http/http.js.map +0 -1
  96. package/dist/http/isomorphic-fetch.d.ts +0 -5
  97. package/dist/http/isomorphic-fetch.js +0 -33
  98. package/dist/http/isomorphic-fetch.js.map +0 -1
  99. package/dist/index.d.ts +0 -9
  100. package/dist/index.js +0 -22
  101. package/dist/index.js.map +0 -1
  102. package/dist/middleware.d.ts +0 -16
  103. package/dist/middleware.js +0 -18
  104. package/dist/middleware.js.map +0 -1
  105. package/dist/models/App.d.ts +0 -47
  106. package/dist/models/App.js +0 -196
  107. package/dist/models/App.js.map +0 -1
  108. package/dist/models/Button.d.ts +0 -19
  109. package/dist/models/Button.js +0 -34
  110. package/dist/models/Button.js.map +0 -1
  111. package/dist/models/DeliveryData.d.ts +0 -21
  112. package/dist/models/DeliveryData.js +0 -46
  113. package/dist/models/DeliveryData.js.map +0 -1
  114. package/dist/models/ExportPlayersRequestBody.d.ts +0 -19
  115. package/dist/models/ExportPlayersRequestBody.js +0 -34
  116. package/dist/models/ExportPlayersRequestBody.js.map +0 -1
  117. package/dist/models/Filter.d.ts +0 -21
  118. package/dist/models/Filter.js +0 -40
  119. package/dist/models/Filter.js.map +0 -1
  120. package/dist/models/FilterExpressions.d.ts +0 -23
  121. package/dist/models/FilterExpressions.js +0 -46
  122. package/dist/models/FilterExpressions.js.map +0 -1
  123. package/dist/models/FilterNotificationTarget.d.ts +0 -28
  124. package/dist/models/FilterNotificationTarget.js +0 -88
  125. package/dist/models/FilterNotificationTarget.js.map +0 -1
  126. package/dist/models/GetNotificationRequestBody.d.ts +0 -20
  127. package/dist/models/GetNotificationRequestBody.js +0 -34
  128. package/dist/models/GetNotificationRequestBody.js.map +0 -1
  129. package/dist/models/InlineResponse200.d.ts +0 -20
  130. package/dist/models/InlineResponse200.js +0 -40
  131. package/dist/models/InlineResponse200.js.map +0 -1
  132. package/dist/models/InlineResponse2001.d.ts +0 -17
  133. package/dist/models/InlineResponse2001.js +0 -22
  134. package/dist/models/InlineResponse2001.js.map +0 -1
  135. package/dist/models/InlineResponse2002.d.ts +0 -18
  136. package/dist/models/InlineResponse2002.js +0 -28
  137. package/dist/models/InlineResponse2002.js.map +0 -1
  138. package/dist/models/InlineResponse2003.d.ts +0 -17
  139. package/dist/models/InlineResponse2003.js +0 -22
  140. package/dist/models/InlineResponse2003.js.map +0 -1
  141. package/dist/models/InlineResponse2004.d.ts +0 -18
  142. package/dist/models/InlineResponse2004.js +0 -28
  143. package/dist/models/InlineResponse2004.js.map +0 -1
  144. package/dist/models/InlineResponse2005.d.ts +0 -17
  145. package/dist/models/InlineResponse2005.js +0 -22
  146. package/dist/models/InlineResponse2005.js.map +0 -1
  147. package/dist/models/InlineResponse201.d.ts +0 -18
  148. package/dist/models/InlineResponse201.js +0 -28
  149. package/dist/models/InlineResponse201.js.map +0 -1
  150. package/dist/models/InlineResponse400.d.ts +0 -17
  151. package/dist/models/InlineResponse400.js +0 -22
  152. package/dist/models/InlineResponse400.js.map +0 -1
  153. package/dist/models/InlineResponse4001.d.ts +0 -18
  154. package/dist/models/InlineResponse4001.js +0 -28
  155. package/dist/models/InlineResponse4001.js.map +0 -1
  156. package/dist/models/InlineResponse4002.d.ts +0 -17
  157. package/dist/models/InlineResponse4002.js +0 -22
  158. package/dist/models/InlineResponse4002.js.map +0 -1
  159. package/dist/models/InlineResponse409.d.ts +0 -18
  160. package/dist/models/InlineResponse409.js +0 -28
  161. package/dist/models/InlineResponse409.js.map +0 -1
  162. package/dist/models/Notification.d.ts +0 -132
  163. package/dist/models/Notification.js +0 -688
  164. package/dist/models/Notification.js.map +0 -1
  165. package/dist/models/NotificationAllOf.d.ts +0 -108
  166. package/dist/models/NotificationAllOf.js +0 -544
  167. package/dist/models/NotificationAllOf.js.map +0 -1
  168. package/dist/models/NotificationAllOfAndroidBackgroundLayout.d.ts +0 -19
  169. package/dist/models/NotificationAllOfAndroidBackgroundLayout.js +0 -34
  170. package/dist/models/NotificationAllOfAndroidBackgroundLayout.js.map +0 -1
  171. package/dist/models/NotificationSlice.d.ts +0 -21
  172. package/dist/models/NotificationSlice.js +0 -40
  173. package/dist/models/NotificationSlice.js.map +0 -1
  174. package/dist/models/NotificationTarget.d.ts +0 -40
  175. package/dist/models/NotificationTarget.js +0 -160
  176. package/dist/models/NotificationTarget.js.map +0 -1
  177. package/dist/models/ObjectSerializer.d.ts +0 -44
  178. package/dist/models/ObjectSerializer.js +0 -312
  179. package/dist/models/ObjectSerializer.js.map +0 -1
  180. package/dist/models/Operator.d.ts +0 -18
  181. package/dist/models/Operator.js +0 -22
  182. package/dist/models/Operator.js.map +0 -1
  183. package/dist/models/OutcomeData.d.ts +0 -20
  184. package/dist/models/OutcomeData.js +0 -34
  185. package/dist/models/OutcomeData.js.map +0 -1
  186. package/dist/models/PlatformDeliveryData.d.ts +0 -23
  187. package/dist/models/PlatformDeliveryData.js +0 -52
  188. package/dist/models/PlatformDeliveryData.js.map +0 -1
  189. package/dist/models/Player.d.ts +0 -43
  190. package/dist/models/Player.js +0 -178
  191. package/dist/models/Player.js.map +0 -1
  192. package/dist/models/PlayerNotificationTarget.d.ts +0 -26
  193. package/dist/models/PlayerNotificationTarget.js +0 -76
  194. package/dist/models/PlayerNotificationTarget.js.map +0 -1
  195. package/dist/models/PlayerSlice.d.ts +0 -21
  196. package/dist/models/PlayerSlice.js +0 -40
  197. package/dist/models/PlayerSlice.js.map +0 -1
  198. package/dist/models/Purchase.d.ts +0 -19
  199. package/dist/models/Purchase.js +0 -34
  200. package/dist/models/Purchase.js.map +0 -1
  201. package/dist/models/Segment.d.ts +0 -20
  202. package/dist/models/Segment.js +0 -34
  203. package/dist/models/Segment.js.map +0 -1
  204. package/dist/models/SegmentNotificationTarget.d.ts +0 -18
  205. package/dist/models/SegmentNotificationTarget.js +0 -28
  206. package/dist/models/SegmentNotificationTarget.js.map +0 -1
  207. package/dist/models/StringMap.d.ts +0 -59
  208. package/dist/models/StringMap.js +0 -274
  209. package/dist/models/StringMap.js.map +0 -1
  210. package/dist/models/UpdatePlayerTagsRequestBody.d.ts +0 -17
  211. package/dist/models/UpdatePlayerTagsRequestBody.js +0 -22
  212. package/dist/models/UpdatePlayerTagsRequestBody.js.map +0 -1
  213. package/dist/models/all.d.ts +0 -35
  214. package/dist/models/all.js +0 -48
  215. package/dist/models/all.js.map +0 -1
  216. package/dist/rxjsStub.d.ts +0 -10
  217. package/dist/rxjsStub.js +0 -33
  218. package/dist/rxjsStub.js.map +0 -1
  219. package/dist/servers.d.ts +0 -17
  220. package/dist/servers.js +0 -32
  221. package/dist/servers.js.map +0 -1
  222. package/dist/types/ObjectParamAPI.d.ts +0 -121
  223. package/dist/types/ObjectParamAPI.js +0 -69
  224. package/dist/types/ObjectParamAPI.js.map +0 -1
  225. package/dist/types/ObservableAPI.d.ts +0 -45
  226. package/dist/types/ObservableAPI.js +0 -472
  227. package/dist/types/ObservableAPI.js.map +0 -1
  228. package/dist/types/PromiseAPI.d.ts +0 -42
  229. package/dist/types/PromiseAPI.js +0 -88
  230. package/dist/types/PromiseAPI.js.map +0 -1
  231. package/dist/util.d.ts +0 -1
  232. package/dist/util.js +0 -25
  233. package/dist/util.js.map +0 -1
  234. package/git_push.sh +0 -52
@@ -0,0 +1,25 @@
1
+ name: 🙋‍♂️ Ask a question
2
+ description: Tell us what's on your mind
3
+ title: "[question]: "
4
+ labels: ["triage"]
5
+ body:
6
+ - type: markdown
7
+ attributes:
8
+ value: |
9
+ Having issues integrating this API library?
10
+ - type: textarea
11
+ id: question
12
+ attributes:
13
+ label: How can we help?
14
+ description: Specific question regarding integrating this API library.
15
+ placeholder: How do I...?
16
+ validations:
17
+ required: true
18
+ - type: checkboxes
19
+ id: terms
20
+ attributes:
21
+ label: Code of Conduct
22
+ description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/OneSignal/api/blob/main/CONTRIBUTING.md)
23
+ options:
24
+ - label: I agree to follow this project's Code of Conduct
25
+ required: true
@@ -0,0 +1,51 @@
1
+ name: 🪳 Bug report
2
+ description: File a bug report
3
+ title: "[Bug]: "
4
+ labels: ["bug", "triage"]
5
+ body:
6
+ - type: markdown
7
+ attributes:
8
+ value: |
9
+ Thanks for taking the time to fill out this bug report!
10
+ - type: textarea
11
+ id: what-happened
12
+ attributes:
13
+ label: What happened?
14
+ description: Provide a thorough description of whats going on.
15
+ placeholder: The latest version of the API library throws an exception when creating a notification targetting all Active Users.
16
+ validations:
17
+ required: true
18
+ - type: textarea
19
+ id: reproduction-steps
20
+ attributes:
21
+ label: Steps to reproduce?
22
+ description: Provide as much detail as posible to reproduce the issue.
23
+ placeholder: |
24
+ 1. Install vX.Y.Z of dependency
25
+ 2. Run provided code snippet
26
+ 3. Note that the app crashes
27
+ render: Markdown
28
+ validations:
29
+ required: true
30
+ - type: textarea
31
+ id: what-are-expectations
32
+ attributes:
33
+ label: What did you expect to happen?
34
+ description: Also tell us, what did you expect to happen?
35
+ placeholder: I expected the API library to properly deserialize any response returned by OneSignal.
36
+ validations:
37
+ required: true
38
+ - type: textarea
39
+ id: logs
40
+ attributes:
41
+ label: Relevant log output
42
+ description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
43
+ render: Shell
44
+ - type: checkboxes
45
+ id: terms
46
+ attributes:
47
+ label: Code of Conduct
48
+ description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/OneSignal/api/blob/main/CONTRIBUTING.md)
49
+ options:
50
+ - label: I agree to follow this project's Code of Conduct
51
+ required: true
@@ -0,0 +1,25 @@
1
+ name: 📣 General feedback
2
+ description: Tell us what's on your mind
3
+ title: "[Bug]: "
4
+ labels: ["triage"]
5
+ body:
6
+ - type: markdown
7
+ attributes:
8
+ value: |
9
+ Thanks for sharing your valuable feedback!
10
+ - type: textarea
11
+ id: feedback
12
+ attributes:
13
+ label: What's on your mind?
14
+ description: Feedback regarding this API library.
15
+ placeholder: Share your feedback...
16
+ validations:
17
+ required: true
18
+ - type: checkboxes
19
+ id: terms
20
+ attributes:
21
+ label: Code of Conduct
22
+ description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/OneSignal/api/blob/main/CONTRIBUTING.md)
23
+ options:
24
+ - label: I agree to follow this project's Code of Conduct
25
+ required: true
@@ -0,0 +1,44 @@
1
+ <!-- START -->
2
+ # READ AND DELETE THIS SECTION BEFORE SUBMITTING PR
3
+ * **Fill out each _REQUIRED_ section**
4
+ * **Fill out _OPTIONAL_ sections, remove section if it doesn't apply to your PR**
5
+ * **Read and fill out each of the checklists below**
6
+ * **Remove this section after reading**
7
+ <!-- END -->
8
+
9
+ # Description
10
+ ## One Line Summary
11
+ **REQUIRED** - Very short description that summaries the changes in this PR.
12
+
13
+ ## Details
14
+
15
+ ### Motivation
16
+ **REQUIRED -** Why is this code change being made? Or what is the goal of this PR? Examples: Fixes a specific bug, provides additional logging to debug future issues, feature to allow X.
17
+
18
+ ### Scope
19
+ **RECOMMEND - OPTIONAL -** What is intended to be effected. What is known not to change. Example: Notifications are grouped when parameter X is set, not enabled by default.
20
+
21
+ ### OPTIONAL - Other
22
+ **OPTIONAL -** Feel free to add any other sections or sub-sections that can explain your PR better.
23
+
24
+ # Testing
25
+
26
+ ## Manual testing
27
+ **REQUIRED -** Explain what scenarios were tested and the environment.
28
+
29
+
30
+ # Checklist
31
+ ## Overview
32
+ - [ ] I have filled out all **REQUIRED** sections above
33
+ - [ ] PR does one thing
34
+ - If it is hard to explain how any codes changes are related to each other then it most likely needs to be more than one PR
35
+ - [ ] Any Public API changes are explained in the PR details and conform to existing APIs
36
+
37
+ ## Testing
38
+ - [ ] I have personally tested this on my device, or explained why that is not possible
39
+
40
+ ## Final pass
41
+ - [ ] Code is as readable as possible.
42
+ - Simplify with less code, followed by splitting up code into well named functions and variables, followed by adding comments to the code.
43
+ - [ ] I have reviewed this PR myself, ensuring it meets each checklist item
44
+ - WIP (Work In Progress) is ok, but explain what is still in progress and what you would like feedback on. Start the PR title with "WIP" to indicate this.
@@ -0,0 +1,23 @@
1
+ name: NPM Publish
2
+
3
+ on:
4
+ release:
5
+ types: [created]
6
+
7
+ jobs:
8
+ publish:
9
+ runs-on: ubuntu-latest
10
+ steps:
11
+ - uses: actions/checkout@v3
12
+ - uses: actions/setup-node@v3
13
+ with:
14
+ node-version: 18
15
+ - name: Install Node types
16
+ run: npm install @types/node
17
+ - name: Run build
18
+ run: npm run build
19
+ - name: Publish package
20
+ if: github.event_name == 'release' && github.event.action == 'created'
21
+ uses: JS-DevTools/npm-publish@v1
22
+ with:
23
+ token: ${{ secrets.NPM }}
package/CHANGELOG.md ADDED
@@ -0,0 +1,29 @@
1
+ # Changelog
2
+ All notable changes to this project will be documented in this file.
3
+
4
+ ## November 2022
5
+ ### `1.0.0-beta5` - 11/14/2022
6
+ #### Api Changes
7
+ - Configuration setup has been simplified and streamlined. Now it looks like this:
8
+ ```js
9
+ const configuration = OneSignal.createConfiguration({
10
+ userKey: USER_KEY_TOKEN,
11
+ appKey: APP_KEY_TOKEN,
12
+ });
13
+ ```
14
+ - Player ID is no longer required when creating a player
15
+
16
+ #### Fixed
17
+ - Bug in the OpenAPI schema not allowing users to use filters when creating a notification.
18
+ - Bug in the OpenAPI schema not allowing to set the notification name.
19
+
20
+
21
+ ## February 2022
22
+
23
+ ### `1.0.0-beta4` - 02/25/2022
24
+ #### Added
25
+ - .npmignore file
26
+
27
+ #### Fixed
28
+ - Missing `dist` directory since npm was ignoring it due to lack of .npmignore
29
+