@@ -5,8 +5,8 @@ A powerful way to send personalized messages at scale and build effective custom
5
5
## Overview
6
6
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.
7
7
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
10
10
- Build package: org.openapitools.codegen.languages.GoClientCodegen
11
11
For more information, please visit [ https://onesignal.com ] ( https://onesignal.com )
12
12
@@ -81,41 +81,34 @@ All URIs are relative to *https://api.onesignal.com*
81
81
82
82
Class | Method | HTTP request | Description
83
83
------------ | ------------- | ------------- | -------------
84
- * DefaultApi* | [ ** BeginLiveActivity** ] ( docs/DefaultApi.md#beginliveactivity ) | ** Post** /apps/{app_id}/live_activities/{activity_id}/token | Start Live Activity
85
84
* 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 |
86
87
* DefaultApi* | [ ** CreateApp** ] ( docs/DefaultApi.md#createapp ) | ** Post** /apps | Create an app
87
88
* 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
90
90
* DefaultApi* | [ ** CreateSubscription** ] ( docs/DefaultApi.md#createsubscription ) | ** Post** /apps/{app_id}/users/by/{alias_label}/{alias_id}/subscriptions |
91
91
* DefaultApi* | [ ** CreateUser** ] ( docs/DefaultApi.md#createuser ) | ** Post** /apps/{app_id}/users |
92
92
* 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
95
94
* DefaultApi* | [ ** DeleteSubscription** ] ( docs/DefaultApi.md#deletesubscription ) | ** Delete** /apps/{app_id}/subscriptions/{subscription_id} |
96
95
* 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
98
96
* 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 |
103
100
* DefaultApi* | [ ** GetApp** ] ( docs/DefaultApi.md#getapp ) | ** Get** /apps/{app_id} | View an app
104
101
* 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 |
106
102
* DefaultApi* | [ ** GetNotification** ] ( docs/DefaultApi.md#getnotification ) | ** Get** /notifications/{notification_id} | View notification
107
103
* DefaultApi* | [ ** GetNotificationHistory** ] ( docs/DefaultApi.md#getnotificationhistory ) | ** Post** /notifications/{notification_id}/history | Notification History
108
104
* DefaultApi* | [ ** GetNotifications** ] ( docs/DefaultApi.md#getnotifications ) | ** Get** /notifications | View notifications
109
105
* 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} |
114
108
* 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
115
110
* DefaultApi* | [ ** UpdateApp** ] ( docs/DefaultApi.md#updateapp ) | ** Put** /apps/{app_id} | Update an app
116
111
* 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
119
112
* DefaultApi* | [ ** UpdateSubscription** ] ( docs/DefaultApi.md#updatesubscription ) | ** Patch** /apps/{app_id}/subscriptions/{subscription_id} |
120
113
* DefaultApi* | [ ** UpdateUser** ] ( docs/DefaultApi.md#updateuser ) | ** Patch** /apps/{app_id}/users/by/{alias_label}/{alias_id} |
121
114
@@ -126,37 +119,25 @@ Class | Method | HTTP request | Description
126
119
- [ BasicNotification] ( docs/BasicNotification.md )
127
120
- [ BasicNotificationAllOf] ( docs/BasicNotificationAllOf.md )
128
121
- [ BasicNotificationAllOfAndroidBackgroundLayout] ( docs/BasicNotificationAllOfAndroidBackgroundLayout.md )
129
- - [ BeginLiveActivityRequest] ( docs/BeginLiveActivityRequest.md )
130
122
- [ Button] ( docs/Button.md )
131
- - [ CancelNotificationSuccessResponse] ( docs/CancelNotificationSuccessResponse.md )
132
123
- [ CreateNotificationSuccessResponse] ( docs/CreateNotificationSuccessResponse.md )
133
- - [ CreatePlayerSuccessResponse] ( docs/CreatePlayerSuccessResponse.md )
134
124
- [ CreateSegmentConflictResponse] ( docs/CreateSegmentConflictResponse.md )
135
125
- [ CreateSegmentSuccessResponse] ( docs/CreateSegmentSuccessResponse.md )
136
- - [ CreateSubscriptionRequestBody] ( docs/CreateSubscriptionRequestBody.md )
137
126
- [ CreateUserConflictResponse] ( docs/CreateUserConflictResponse.md )
138
127
- [ CreateUserConflictResponseErrorsInner] ( docs/CreateUserConflictResponseErrorsInner.md )
139
128
- [ CreateUserConflictResponseErrorsItemsMeta] ( docs/CreateUserConflictResponseErrorsItemsMeta.md )
140
- - [ DeletePlayerNotFoundResponse] ( docs/DeletePlayerNotFoundResponse.md )
141
- - [ DeletePlayerSuccessResponse] ( docs/DeletePlayerSuccessResponse.md )
142
- - [ DeleteSegmentNotFoundResponse] ( docs/DeleteSegmentNotFoundResponse.md )
143
- - [ DeleteSegmentSuccessResponse] ( docs/DeleteSegmentSuccessResponse.md )
144
129
- [ DeliveryData] ( docs/DeliveryData.md )
145
130
- [ ExportEventsSuccessResponse] ( docs/ExportEventsSuccessResponse.md )
146
- - [ ExportPlayersRequestBody ] ( docs/ExportPlayersRequestBody .md )
147
- - [ ExportPlayersSuccessResponse ] ( docs/ExportPlayersSuccessResponse .md )
131
+ - [ ExportSubscriptionsRequestBody ] ( docs/ExportSubscriptionsRequestBody .md )
132
+ - [ ExportSubscriptionsSuccessResponse ] ( docs/ExportSubscriptionsSuccessResponse .md )
148
133
- [ Filter] ( docs/Filter.md )
149
- - [ FilterExpressions ] ( docs/FilterExpressions .md )
134
+ - [ FilterExpression ] ( docs/FilterExpression .md )
150
135
- [ 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 )
158
140
- [ Notification] ( docs/Notification.md )
159
- - [ Notification200Errors] ( docs/Notification200Errors.md )
160
141
- [ NotificationAllOf] ( docs/NotificationAllOf.md )
161
142
- [ NotificationHistorySuccessResponse] ( docs/NotificationHistorySuccessResponse.md )
162
143
- [ NotificationSlice] ( docs/NotificationSlice.md )
@@ -169,53 +150,45 @@ Class | Method | HTTP request | Description
169
150
- [ PlatformDeliveryData] ( docs/PlatformDeliveryData.md )
170
151
- [ PlatformDeliveryDataEmailAllOf] ( docs/PlatformDeliveryDataEmailAllOf.md )
171
152
- [ 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 )
176
154
- [ PropertiesDeltas] ( docs/PropertiesDeltas.md )
177
155
- [ PropertiesObject] ( docs/PropertiesObject.md )
178
156
- [ Purchase] ( docs/Purchase.md )
179
- - [ RateLimiterError ] ( docs/RateLimiterError .md )
157
+ - [ RateLimitError ] ( docs/RateLimitError .md )
180
158
- [ Segment] ( docs/Segment.md )
159
+ - [ SegmentData] ( docs/SegmentData.md )
181
160
- [ 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 )
184
164
- [ TransferSubscriptionRequestBody] ( docs/TransferSubscriptionRequestBody.md )
185
165
- [ UpdateLiveActivityRequest] ( docs/UpdateLiveActivityRequest.md )
186
166
- [ UpdateLiveActivitySuccessResponse] ( docs/UpdateLiveActivitySuccessResponse.md )
187
- - [ UpdatePlayerSuccessResponse] ( docs/UpdatePlayerSuccessResponse.md )
188
- - [ UpdatePlayerTagsRequestBody] ( docs/UpdatePlayerTagsRequestBody.md )
189
- - [ UpdatePlayerTagsSuccessResponse] ( docs/UpdatePlayerTagsSuccessResponse.md )
190
- - [ UpdateSubscriptionRequestBody] ( docs/UpdateSubscriptionRequestBody.md )
191
167
- [ UpdateUserRequest] ( docs/UpdateUserRequest.md )
192
168
- [ 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 )
196
171
197
172
198
173
## Documentation For Authorization
199
174
Use a OneSignal authentication context for each auth type:
200
175
- ` AppAuth `
201
176
- ` UserAuth `
202
177
203
- ### app_key
178
+ ### rest_api_key
204
179
- ** Type** : HTTP Bearer token authentication
205
180
206
181
Example
207
182
208
183
``` golang
209
- appAuth := context.WithValue (context.Background (), onesignal.AppAuth , " APP_KEY_STRING" )
210
184
```
211
185
212
- ### user_key
186
+ ### user_auth_key
213
187
- ** Type** : HTTP Bearer token authentication
214
188
215
189
Example
216
190
217
191
``` golang
218
- userAuth := context.WithValue (context.Background (), onesignal.UserAuth , " USER_KEY_STRING" )
219
192
```
220
193
221
194
0 commit comments