Skip to content

Commit 083e436

Browse files
author
OneSignal
committed
feat: add v5.0.0-beta1 package updates
1 parent 96406d3 commit 083e436

File tree

142 files changed

+7235
-13372
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

142 files changed

+7235
-13372
lines changed

.github/ISSUE_TEMPLATE/ask-question.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
name: 🙋‍♂️ Ask a question
22
description: Tell us what's on your mind
3-
title: "[question]: "
4-
labels: ["triage"]
3+
title: "[Question]: "
4+
labels: ["Question"]
55
body:
66
- type: markdown
77
attributes:
@@ -22,4 +22,4 @@ body:
2222
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/OneSignal/api/blob/main/CONTRIBUTING.md)
2323
options:
2424
- label: I agree to follow this project's Code of Conduct
25-
required: true
25+
required: true

.github/ISSUE_TEMPLATE/bug-report.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
name: 🪳 Bug report
22
description: File a bug report
33
title: "[Bug]: "
4-
labels: ["bug", "triage"]
4+
labels: ["Bug"]
55
body:
66
- type: markdown
77
attributes:
@@ -48,4 +48,4 @@ body:
4848
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/OneSignal/api/blob/main/CONTRIBUTING.md)
4949
options:
5050
- label: I agree to follow this project's Code of Conduct
51-
required: true
51+
required: true

.github/ISSUE_TEMPLATE/general-feedback.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
name: 📣 General feedback
22
description: Tell us what's on your mind
3-
title: "[Bug]: "
4-
labels: ["triage"]
3+
title: "[Feedback]: "
4+
labels: ["Feedback"]
55
body:
66
- type: markdown
77
attributes:
@@ -22,4 +22,4 @@ body:
2222
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/OneSignal/api/blob/main/CONTRIBUTING.md)
2323
options:
2424
- label: I agree to follow this project's Code of Conduct
25-
required: true
25+
required: true

.github/workflows/project.yml

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -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/[email protected]
14+
with:
15+
# SDK Server Project
16+
project-url: https://github.com/orgs/OneSignal/projects/11
17+
github-token: ${{ secrets.GH_PROJECTS_TOKEN }}

README.md

Lines changed: 29 additions & 56 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@ A powerful way to send personalized messages at scale and build effective custom
55
## Overview
66
This API client was generated by the [OpenAPI Generator](https://openapi-generator.tech) project. By using the [OpenAPI-spec](https://www.openapis.org/) from a remote server, you can easily generate an API client.
77

8-
- API version: 1.4.0
9-
- Package version: 2.2.0
8+
- API version: 5.0.1
9+
- Package version: 5.0.0-beta1
1010
- Build package: org.openapitools.codegen.languages.GoClientCodegen
1111
For more information, please visit [https://onesignal.com](https://onesignal.com)
1212

@@ -81,41 +81,34 @@ All URIs are relative to *https://api.onesignal.com*
8181

8282
Class | Method | HTTP request | Description
8383
------------ | ------------- | ------------- | -------------
84-
*DefaultApi* | [**BeginLiveActivity**](docs/DefaultApi.md#beginliveactivity) | **Post** /apps/{app_id}/live_activities/{activity_id}/token | Start Live Activity
8584
*DefaultApi* | [**CancelNotification**](docs/DefaultApi.md#cancelnotification) | **Delete** /notifications/{notification_id} | Stop a scheduled or currently outgoing notification
85+
*DefaultApi* | [**CreateAlias**](docs/DefaultApi.md#createalias) | **Patch** /apps/{app_id}/users/by/{alias_label}/{alias_id}/identity |
86+
*DefaultApi* | [**CreateAliasBySubscription**](docs/DefaultApi.md#createaliasbysubscription) | **Patch** /apps/{app_id}/subscriptions/{subscription_id}/user/identity |
8687
*DefaultApi* | [**CreateApp**](docs/DefaultApi.md#createapp) | **Post** /apps | Create an app
8788
*DefaultApi* | [**CreateNotification**](docs/DefaultApi.md#createnotification) | **Post** /notifications | Create notification
88-
*DefaultApi* | [**CreatePlayer**](docs/DefaultApi.md#createplayer) | **Post** /players | Add a device
89-
*DefaultApi* | [**CreateSegments**](docs/DefaultApi.md#createsegments) | **Post** /apps/{app_id}/segments | Create Segments
89+
*DefaultApi* | [**CreateSegment**](docs/DefaultApi.md#createsegment) | **Post** /apps/{app_id}/segments | Create Segment
9090
*DefaultApi* | [**CreateSubscription**](docs/DefaultApi.md#createsubscription) | **Post** /apps/{app_id}/users/by/{alias_label}/{alias_id}/subscriptions |
9191
*DefaultApi* | [**CreateUser**](docs/DefaultApi.md#createuser) | **Post** /apps/{app_id}/users |
9292
*DefaultApi* | [**DeleteAlias**](docs/DefaultApi.md#deletealias) | **Delete** /apps/{app_id}/users/by/{alias_label}/{alias_id}/identity/{alias_label_to_delete} |
93-
*DefaultApi* | [**DeletePlayer**](docs/DefaultApi.md#deleteplayer) | **Delete** /players/{player_id} | Delete a user record
94-
*DefaultApi* | [**DeleteSegments**](docs/DefaultApi.md#deletesegments) | **Delete** /apps/{app_id}/segments/{segment_id} | Delete Segments
93+
*DefaultApi* | [**DeleteSegment**](docs/DefaultApi.md#deletesegment) | **Delete** /apps/{app_id}/segments/{segment_id} | Delete Segment
9594
*DefaultApi* | [**DeleteSubscription**](docs/DefaultApi.md#deletesubscription) | **Delete** /apps/{app_id}/subscriptions/{subscription_id} |
9695
*DefaultApi* | [**DeleteUser**](docs/DefaultApi.md#deleteuser) | **Delete** /apps/{app_id}/users/by/{alias_label}/{alias_id} |
97-
*DefaultApi* | [**EndLiveActivity**](docs/DefaultApi.md#endliveactivity) | **Delete** /apps/{app_id}/live_activities/{activity_id}/token/{subscription_id} | Stop Live Activity
9896
*DefaultApi* | [**ExportEvents**](docs/DefaultApi.md#exportevents) | **Post** /notifications/{notification_id}/export_events?app_id={app_id} | Export CSV of Events
99-
*DefaultApi* | [**ExportPlayers**](docs/DefaultApi.md#exportplayers) | **Post** /players/csv_export?app_id={app_id} | Export CSV of Players
100-
*DefaultApi* | [**FetchAliases**](docs/DefaultApi.md#fetchaliases) | **Get** /apps/{app_id}/subscriptions/{subscription_id}/user/identity |
101-
*DefaultApi* | [**FetchUser**](docs/DefaultApi.md#fetchuser) | **Get** /apps/{app_id}/users/by/{alias_label}/{alias_id} |
102-
*DefaultApi* | [**FetchUserIdentity**](docs/DefaultApi.md#fetchuseridentity) | **Get** /apps/{app_id}/users/by/{alias_label}/{alias_id}/identity |
97+
*DefaultApi* | [**ExportSubscriptions**](docs/DefaultApi.md#exportsubscriptions) | **Post** /players/csv_export?app_id={app_id} | Export CSV of Subscriptions
98+
*DefaultApi* | [**GetAliases**](docs/DefaultApi.md#getaliases) | **Get** /apps/{app_id}/users/by/{alias_label}/{alias_id}/identity |
99+
*DefaultApi* | [**GetAliasesBySubscription**](docs/DefaultApi.md#getaliasesbysubscription) | **Get** /apps/{app_id}/subscriptions/{subscription_id}/user/identity |
103100
*DefaultApi* | [**GetApp**](docs/DefaultApi.md#getapp) | **Get** /apps/{app_id} | View an app
104101
*DefaultApi* | [**GetApps**](docs/DefaultApi.md#getapps) | **Get** /apps | View apps
105-
*DefaultApi* | [**GetEligibleIams**](docs/DefaultApi.md#geteligibleiams) | **Get** /apps/{app_id}/subscriptions/{subscription_id}/iams |
106102
*DefaultApi* | [**GetNotification**](docs/DefaultApi.md#getnotification) | **Get** /notifications/{notification_id} | View notification
107103
*DefaultApi* | [**GetNotificationHistory**](docs/DefaultApi.md#getnotificationhistory) | **Post** /notifications/{notification_id}/history | Notification History
108104
*DefaultApi* | [**GetNotifications**](docs/DefaultApi.md#getnotifications) | **Get** /notifications | View notifications
109105
*DefaultApi* | [**GetOutcomes**](docs/DefaultApi.md#getoutcomes) | **Get** /apps/{app_id}/outcomes | View Outcomes
110-
*DefaultApi* | [**GetPlayer**](docs/DefaultApi.md#getplayer) | **Get** /players/{player_id} | View device
111-
*DefaultApi* | [**GetPlayers**](docs/DefaultApi.md#getplayers) | **Get** /players | View devices
112-
*DefaultApi* | [**IdentifyUserByAlias**](docs/DefaultApi.md#identifyuserbyalias) | **Patch** /apps/{app_id}/users/by/{alias_label}/{alias_id}/identity |
113-
*DefaultApi* | [**IdentifyUserBySubscriptionId**](docs/DefaultApi.md#identifyuserbysubscriptionid) | **Patch** /apps/{app_id}/subscriptions/{subscription_id}/user/identity |
106+
*DefaultApi* | [**GetSegments**](docs/DefaultApi.md#getsegments) | **Get** /apps/{app_id}/segments | Get Segments
107+
*DefaultApi* | [**GetUser**](docs/DefaultApi.md#getuser) | **Get** /apps/{app_id}/users/by/{alias_label}/{alias_id} |
114108
*DefaultApi* | [**TransferSubscription**](docs/DefaultApi.md#transfersubscription) | **Patch** /apps/{app_id}/subscriptions/{subscription_id}/owner |
109+
*DefaultApi* | [**UnsubscribeEmailWithToken**](docs/DefaultApi.md#unsubscribeemailwithtoken) | **Post** /apps/{app_id}/notifications/{notification_id}/unsubscribe | Unsubscribe with token
115110
*DefaultApi* | [**UpdateApp**](docs/DefaultApi.md#updateapp) | **Put** /apps/{app_id} | Update an app
116111
*DefaultApi* | [**UpdateLiveActivity**](docs/DefaultApi.md#updateliveactivity) | **Post** /apps/{app_id}/live_activities/{activity_id}/notifications | Update a Live Activity via Push
117-
*DefaultApi* | [**UpdatePlayer**](docs/DefaultApi.md#updateplayer) | **Put** /players/{player_id} | Edit device
118-
*DefaultApi* | [**UpdatePlayerTags**](docs/DefaultApi.md#updateplayertags) | **Put** /apps/{app_id}/users/{external_user_id} | Edit tags with external user id
119112
*DefaultApi* | [**UpdateSubscription**](docs/DefaultApi.md#updatesubscription) | **Patch** /apps/{app_id}/subscriptions/{subscription_id} |
120113
*DefaultApi* | [**UpdateUser**](docs/DefaultApi.md#updateuser) | **Patch** /apps/{app_id}/users/by/{alias_label}/{alias_id} |
121114

@@ -126,37 +119,25 @@ Class | Method | HTTP request | Description
126119
- [BasicNotification](docs/BasicNotification.md)
127120
- [BasicNotificationAllOf](docs/BasicNotificationAllOf.md)
128121
- [BasicNotificationAllOfAndroidBackgroundLayout](docs/BasicNotificationAllOfAndroidBackgroundLayout.md)
129-
- [BeginLiveActivityRequest](docs/BeginLiveActivityRequest.md)
130122
- [Button](docs/Button.md)
131-
- [CancelNotificationSuccessResponse](docs/CancelNotificationSuccessResponse.md)
132123
- [CreateNotificationSuccessResponse](docs/CreateNotificationSuccessResponse.md)
133-
- [CreatePlayerSuccessResponse](docs/CreatePlayerSuccessResponse.md)
134124
- [CreateSegmentConflictResponse](docs/CreateSegmentConflictResponse.md)
135125
- [CreateSegmentSuccessResponse](docs/CreateSegmentSuccessResponse.md)
136-
- [CreateSubscriptionRequestBody](docs/CreateSubscriptionRequestBody.md)
137126
- [CreateUserConflictResponse](docs/CreateUserConflictResponse.md)
138127
- [CreateUserConflictResponseErrorsInner](docs/CreateUserConflictResponseErrorsInner.md)
139128
- [CreateUserConflictResponseErrorsItemsMeta](docs/CreateUserConflictResponseErrorsItemsMeta.md)
140-
- [DeletePlayerNotFoundResponse](docs/DeletePlayerNotFoundResponse.md)
141-
- [DeletePlayerSuccessResponse](docs/DeletePlayerSuccessResponse.md)
142-
- [DeleteSegmentNotFoundResponse](docs/DeleteSegmentNotFoundResponse.md)
143-
- [DeleteSegmentSuccessResponse](docs/DeleteSegmentSuccessResponse.md)
144129
- [DeliveryData](docs/DeliveryData.md)
145130
- [ExportEventsSuccessResponse](docs/ExportEventsSuccessResponse.md)
146-
- [ExportPlayersRequestBody](docs/ExportPlayersRequestBody.md)
147-
- [ExportPlayersSuccessResponse](docs/ExportPlayersSuccessResponse.md)
131+
- [ExportSubscriptionsRequestBody](docs/ExportSubscriptionsRequestBody.md)
132+
- [ExportSubscriptionsSuccessResponse](docs/ExportSubscriptionsSuccessResponse.md)
148133
- [Filter](docs/Filter.md)
149-
- [FilterExpressions](docs/FilterExpressions.md)
134+
- [FilterExpression](docs/FilterExpression.md)
150135
- [GenericError](docs/GenericError.md)
151-
- [GenericErrorErrorsInner](docs/GenericErrorErrorsInner.md)
152-
- [GetNotificationRequestBody](docs/GetNotificationRequestBody.md)
153-
- [InlineResponse200](docs/InlineResponse200.md)
154-
- [InlineResponse2003](docs/InlineResponse2003.md)
155-
- [InlineResponse201](docs/InlineResponse201.md)
156-
- [InlineResponse202](docs/InlineResponse202.md)
157-
- [InvalidIdentifierError](docs/InvalidIdentifierError.md)
136+
- [GenericSuccessBoolResponse](docs/GenericSuccessBoolResponse.md)
137+
- [GetNotificationHistoryRequestBody](docs/GetNotificationHistoryRequestBody.md)
138+
- [GetSegmentsSuccessResponse](docs/GetSegmentsSuccessResponse.md)
139+
- [LanguageStringMap](docs/LanguageStringMap.md)
158140
- [Notification](docs/Notification.md)
159-
- [Notification200Errors](docs/Notification200Errors.md)
160141
- [NotificationAllOf](docs/NotificationAllOf.md)
161142
- [NotificationHistorySuccessResponse](docs/NotificationHistorySuccessResponse.md)
162143
- [NotificationSlice](docs/NotificationSlice.md)
@@ -169,53 +150,45 @@ Class | Method | HTTP request | Description
169150
- [PlatformDeliveryData](docs/PlatformDeliveryData.md)
170151
- [PlatformDeliveryDataEmailAllOf](docs/PlatformDeliveryDataEmailAllOf.md)
171152
- [PlatformDeliveryDataSmsAllOf](docs/PlatformDeliveryDataSmsAllOf.md)
172-
- [Player](docs/Player.md)
173-
- [PlayerNotificationTarget](docs/PlayerNotificationTarget.md)
174-
- [PlayerNotificationTargetIncludeAliases](docs/PlayerNotificationTargetIncludeAliases.md)
175-
- [PlayerSlice](docs/PlayerSlice.md)
153+
- [PropertiesBody](docs/PropertiesBody.md)
176154
- [PropertiesDeltas](docs/PropertiesDeltas.md)
177155
- [PropertiesObject](docs/PropertiesObject.md)
178156
- [Purchase](docs/Purchase.md)
179-
- [RateLimiterError](docs/RateLimiterError.md)
157+
- [RateLimitError](docs/RateLimitError.md)
180158
- [Segment](docs/Segment.md)
159+
- [SegmentData](docs/SegmentData.md)
181160
- [SegmentNotificationTarget](docs/SegmentNotificationTarget.md)
182-
- [StringMap](docs/StringMap.md)
183-
- [SubscriptionObject](docs/SubscriptionObject.md)
161+
- [Subscription](docs/Subscription.md)
162+
- [SubscriptionBody](docs/SubscriptionBody.md)
163+
- [SubscriptionNotificationTarget](docs/SubscriptionNotificationTarget.md)
184164
- [TransferSubscriptionRequestBody](docs/TransferSubscriptionRequestBody.md)
185165
- [UpdateLiveActivityRequest](docs/UpdateLiveActivityRequest.md)
186166
- [UpdateLiveActivitySuccessResponse](docs/UpdateLiveActivitySuccessResponse.md)
187-
- [UpdatePlayerSuccessResponse](docs/UpdatePlayerSuccessResponse.md)
188-
- [UpdatePlayerTagsRequestBody](docs/UpdatePlayerTagsRequestBody.md)
189-
- [UpdatePlayerTagsSuccessResponse](docs/UpdatePlayerTagsSuccessResponse.md)
190-
- [UpdateSubscriptionRequestBody](docs/UpdateSubscriptionRequestBody.md)
191167
- [UpdateUserRequest](docs/UpdateUserRequest.md)
192168
- [User](docs/User.md)
193-
- [UserIdentityRequestBody](docs/UserIdentityRequestBody.md)
194-
- [UserIdentityResponse](docs/UserIdentityResponse.md)
195-
- [UserSubscriptionOptions](docs/UserSubscriptionOptions.md)
169+
- [UserIdentityBody](docs/UserIdentityBody.md)
170+
- [WebButton](docs/WebButton.md)
196171

197172

198173
## Documentation For Authorization
199174
Use a OneSignal authentication context for each auth type:
200175
- `AppAuth`
201176
- `UserAuth`
202177

203-
### app_key
178+
### rest_api_key
204179
- **Type**: HTTP Bearer token authentication
205180

206181
Example
207182

208183
```golang
209-
appAuth := context.WithValue(context.Background(), onesignal.AppAuth, "APP_KEY_STRING")
210184
```
211185

212-
### user_key
186+
### user_auth_key
213187
- **Type**: HTTP Bearer token authentication
214188

215189
Example
216190

217191
```golang
218-
userAuth := context.WithValue(context.Background(), onesignal.UserAuth, "USER_KEY_STRING")
219192
```
220193

221194

0 commit comments

Comments
 (0)