1616
1717A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com
1818
19- - API version: 1.4.0
20- - Package version: 2.2.0
19+ - API version: 5.0.1
20+ - Package version: 5.0.0-beta1
2121- Build package: org.openapitools.codegen.languages.PythonClientCodegen
2222
2323## Requirements.
@@ -66,8 +66,8 @@ from onesignal.api import default_api
6666# (also knows as REST_API_KEY). We recommend adding both of them in the configuration page so that you will not need
6767# to figure it yourself.
6868configuration = onesignal.Configuration(
69- app_key = " YOUR_REST_API_KEY " , # App REST API key required for most endpoints
70- user_key = " YOUR_ORGANIZATION_API_KEY " # Organization key is only required for creating new apps and other top-level endpoints
69+ app_key = " YOUR_APP_KEY " ,
70+ user_key = " YOUR_USER_KEY "
7171)
7272
7373
@@ -83,41 +83,34 @@ All URIs are relative to *https://api.onesignal.com*
8383
8484Class | Method | HTTP request | Description
8585------------ | ------------- | ------------- | -------------
86- * DefaultApi* | [ ** begin_live_activity** ] ( docs/DefaultApi.md#begin_live_activity ) | ** POST** /apps/{app_id}/live_activities/{activity_id}/token | Start Live Activity
8786* DefaultApi* | [ ** cancel_notification** ] ( docs/DefaultApi.md#cancel_notification ) | ** DELETE** /notifications/{notification_id} | Stop a scheduled or currently outgoing notification
87+ * DefaultApi* | [ ** create_alias** ] ( docs/DefaultApi.md#create_alias ) | ** PATCH** /apps/{app_id}/users/by/{alias_label}/{alias_id}/identity |
88+ * DefaultApi* | [ ** create_alias_by_subscription** ] ( docs/DefaultApi.md#create_alias_by_subscription ) | ** PATCH** /apps/{app_id}/subscriptions/{subscription_id}/user/identity |
8889* DefaultApi* | [ ** create_app** ] ( docs/DefaultApi.md#create_app ) | ** POST** /apps | Create an app
8990* DefaultApi* | [ ** create_notification** ] ( docs/DefaultApi.md#create_notification ) | ** POST** /notifications | Create notification
90- * DefaultApi* | [ ** create_player** ] ( docs/DefaultApi.md#create_player ) | ** POST** /players | Add a device
91- * DefaultApi* | [ ** create_segments** ] ( docs/DefaultApi.md#create_segments ) | ** POST** /apps/{app_id}/segments | Create Segments
91+ * DefaultApi* | [ ** create_segment** ] ( docs/DefaultApi.md#create_segment ) | ** POST** /apps/{app_id}/segments | Create Segment
9292* DefaultApi* | [ ** create_subscription** ] ( docs/DefaultApi.md#create_subscription ) | ** POST** /apps/{app_id}/users/by/{alias_label}/{alias_id}/subscriptions |
9393* DefaultApi* | [ ** create_user** ] ( docs/DefaultApi.md#create_user ) | ** POST** /apps/{app_id}/users |
9494* DefaultApi* | [ ** delete_alias** ] ( docs/DefaultApi.md#delete_alias ) | ** DELETE** /apps/{app_id}/users/by/{alias_label}/{alias_id}/identity/{alias_label_to_delete} |
95- * DefaultApi* | [ ** delete_player** ] ( docs/DefaultApi.md#delete_player ) | ** DELETE** /players/{player_id} | Delete a user record
96- * DefaultApi* | [ ** delete_segments** ] ( docs/DefaultApi.md#delete_segments ) | ** DELETE** /apps/{app_id}/segments/{segment_id} | Delete Segments
95+ * DefaultApi* | [ ** delete_segment** ] ( docs/DefaultApi.md#delete_segment ) | ** DELETE** /apps/{app_id}/segments/{segment_id} | Delete Segment
9796* DefaultApi* | [ ** delete_subscription** ] ( docs/DefaultApi.md#delete_subscription ) | ** DELETE** /apps/{app_id}/subscriptions/{subscription_id} |
9897* DefaultApi* | [ ** delete_user** ] ( docs/DefaultApi.md#delete_user ) | ** DELETE** /apps/{app_id}/users/by/{alias_label}/{alias_id} |
99- * DefaultApi* | [ ** end_live_activity** ] ( docs/DefaultApi.md#end_live_activity ) | ** DELETE** /apps/{app_id}/live_activities/{activity_id}/token/{subscription_id} | Stop Live Activity
10098* DefaultApi* | [ ** export_events** ] ( docs/DefaultApi.md#export_events ) | ** POST** /notifications/{notification_id}/export_events?app_id= ; {app_id} | Export CSV of Events
101- * DefaultApi* | [ ** export_players** ] ( docs/DefaultApi.md#export_players ) | ** POST** /players/csv_export?app_id= ; {app_id} | Export CSV of Players
102- * DefaultApi* | [ ** fetch_aliases** ] ( docs/DefaultApi.md#fetch_aliases ) | ** GET** /apps/{app_id}/subscriptions/{subscription_id}/user/identity |
103- * DefaultApi* | [ ** fetch_user** ] ( docs/DefaultApi.md#fetch_user ) | ** GET** /apps/{app_id}/users/by/{alias_label}/{alias_id} |
104- * DefaultApi* | [ ** fetch_user_identity** ] ( docs/DefaultApi.md#fetch_user_identity ) | ** GET** /apps/{app_id}/users/by/{alias_label}/{alias_id}/identity |
99+ * DefaultApi* | [ ** export_subscriptions** ] ( docs/DefaultApi.md#export_subscriptions ) | ** POST** /players/csv_export?app_id= ; {app_id} | Export CSV of Subscriptions
100+ * DefaultApi* | [ ** get_aliases** ] ( docs/DefaultApi.md#get_aliases ) | ** GET** /apps/{app_id}/users/by/{alias_label}/{alias_id}/identity |
101+ * DefaultApi* | [ ** get_aliases_by_subscription** ] ( docs/DefaultApi.md#get_aliases_by_subscription ) | ** GET** /apps/{app_id}/subscriptions/{subscription_id}/user/identity |
105102* DefaultApi* | [ ** get_app** ] ( docs/DefaultApi.md#get_app ) | ** GET** /apps/{app_id} | View an app
106103* DefaultApi* | [ ** get_apps** ] ( docs/DefaultApi.md#get_apps ) | ** GET** /apps | View apps
107- * DefaultApi* | [ ** get_eligible_iams** ] ( docs/DefaultApi.md#get_eligible_iams ) | ** GET** /apps/{app_id}/subscriptions/{subscription_id}/iams |
108104* DefaultApi* | [ ** get_notification** ] ( docs/DefaultApi.md#get_notification ) | ** GET** /notifications/{notification_id} | View notification
109105* DefaultApi* | [ ** get_notification_history** ] ( docs/DefaultApi.md#get_notification_history ) | ** POST** /notifications/{notification_id}/history | Notification History
110106* DefaultApi* | [ ** get_notifications** ] ( docs/DefaultApi.md#get_notifications ) | ** GET** /notifications | View notifications
111107* DefaultApi* | [ ** get_outcomes** ] ( docs/DefaultApi.md#get_outcomes ) | ** GET** /apps/{app_id}/outcomes | View Outcomes
112- * DefaultApi* | [ ** get_player** ] ( docs/DefaultApi.md#get_player ) | ** GET** /players/{player_id} | View device
113- * DefaultApi* | [ ** get_players** ] ( docs/DefaultApi.md#get_players ) | ** GET** /players | View devices
114- * DefaultApi* | [ ** identify_user_by_alias** ] ( docs/DefaultApi.md#identify_user_by_alias ) | ** PATCH** /apps/{app_id}/users/by/{alias_label}/{alias_id}/identity |
115- * DefaultApi* | [ ** identify_user_by_subscription_id** ] ( docs/DefaultApi.md#identify_user_by_subscription_id ) | ** PATCH** /apps/{app_id}/subscriptions/{subscription_id}/user/identity |
108+ * DefaultApi* | [ ** get_segments** ] ( docs/DefaultApi.md#get_segments ) | ** GET** /apps/{app_id}/segments | Get Segments
109+ * DefaultApi* | [ ** get_user** ] ( docs/DefaultApi.md#get_user ) | ** GET** /apps/{app_id}/users/by/{alias_label}/{alias_id} |
116110* DefaultApi* | [ ** transfer_subscription** ] ( docs/DefaultApi.md#transfer_subscription ) | ** PATCH** /apps/{app_id}/subscriptions/{subscription_id}/owner |
111+ * DefaultApi* | [ ** unsubscribe_email_with_token** ] ( docs/DefaultApi.md#unsubscribe_email_with_token ) | ** POST** /apps/{app_id}/notifications/{notification_id}/unsubscribe | Unsubscribe with token
117112* DefaultApi* | [ ** update_app** ] ( docs/DefaultApi.md#update_app ) | ** PUT** /apps/{app_id} | Update an app
118113* DefaultApi* | [ ** update_live_activity** ] ( docs/DefaultApi.md#update_live_activity ) | ** POST** /apps/{app_id}/live_activities/{activity_id}/notifications | Update a Live Activity via Push
119- * DefaultApi* | [ ** update_player** ] ( docs/DefaultApi.md#update_player ) | ** PUT** /players/{player_id} | Edit device
120- * DefaultApi* | [ ** update_player_tags** ] ( docs/DefaultApi.md#update_player_tags ) | ** PUT** /apps/{app_id}/users/{external_user_id} | Edit tags with external user id
121114* DefaultApi* | [ ** update_subscription** ] ( docs/DefaultApi.md#update_subscription ) | ** PATCH** /apps/{app_id}/subscriptions/{subscription_id} |
122115* DefaultApi* | [ ** update_user** ] ( docs/DefaultApi.md#update_user ) | ** PATCH** /apps/{app_id}/users/by/{alias_label}/{alias_id} |
123116
@@ -129,40 +122,26 @@ Class | Method | HTTP request | Description
129122 - [ BasicNotification] ( docs/BasicNotification.md )
130123 - [ BasicNotificationAllOf] ( docs/BasicNotificationAllOf.md )
131124 - [ BasicNotificationAllOfAndroidBackgroundLayout] ( docs/BasicNotificationAllOfAndroidBackgroundLayout.md )
132- - [ BeginLiveActivityRequest] ( docs/BeginLiveActivityRequest.md )
133125 - [ Button] ( docs/Button.md )
134- - [ Buttons] ( docs/Buttons.md )
135- - [ CancelNotificationSuccessResponse] ( docs/CancelNotificationSuccessResponse.md )
136126 - [ CreateNotificationSuccessResponse] ( docs/CreateNotificationSuccessResponse.md )
137- - [ CreatePlayerSuccessResponse] ( docs/CreatePlayerSuccessResponse.md )
138127 - [ CreateSegmentConflictResponse] ( docs/CreateSegmentConflictResponse.md )
139128 - [ CreateSegmentSuccessResponse] ( docs/CreateSegmentSuccessResponse.md )
140- - [ CreateSubscriptionRequestBody] ( docs/CreateSubscriptionRequestBody.md )
141129 - [ CreateUserConflictResponse] ( docs/CreateUserConflictResponse.md )
142130 - [ CreateUserConflictResponseErrorsInner] ( docs/CreateUserConflictResponseErrorsInner.md )
143131 - [ CreateUserConflictResponseErrorsItemsMeta] ( docs/CreateUserConflictResponseErrorsItemsMeta.md )
144- - [ DeletePlayerNotFoundResponse] ( docs/DeletePlayerNotFoundResponse.md )
145- - [ DeletePlayerSuccessResponse] ( docs/DeletePlayerSuccessResponse.md )
146- - [ DeleteSegmentNotFoundResponse] ( docs/DeleteSegmentNotFoundResponse.md )
147- - [ DeleteSegmentSuccessResponse] ( docs/DeleteSegmentSuccessResponse.md )
148132 - [ DeliveryData] ( docs/DeliveryData.md )
149133 - [ ExportEventsSuccessResponse] ( docs/ExportEventsSuccessResponse.md )
150- - [ ExportPlayersRequestBody ] ( docs/ExportPlayersRequestBody .md )
151- - [ ExportPlayersSuccessResponse ] ( docs/ExportPlayersSuccessResponse .md )
134+ - [ ExportSubscriptionsRequestBody ] ( docs/ExportSubscriptionsRequestBody .md )
135+ - [ ExportSubscriptionsSuccessResponse ] ( docs/ExportSubscriptionsSuccessResponse .md )
152136 - [ Filter] ( docs/Filter.md )
153- - [ FilterExpressions ] ( docs/FilterExpressions .md )
137+ - [ FilterExpression ] ( docs/FilterExpression .md )
154138 - [ GenericError] ( docs/GenericError.md )
155- - [ GenericErrorErrorsInner] ( docs/GenericErrorErrorsInner.md )
156- - [ GetNotificationRequestBody] ( docs/GetNotificationRequestBody.md )
139+ - [ GenericSuccessBoolResponse] ( docs/GenericSuccessBoolResponse.md )
140+ - [ GetNotificationHistoryRequestBody] ( docs/GetNotificationHistoryRequestBody.md )
141+ - [ GetSegmentsSuccessResponse] ( docs/GetSegmentsSuccessResponse.md )
157142 - [ IdentityObject] ( docs/IdentityObject.md )
158- - [ InlineResponse200] ( docs/InlineResponse200.md )
159- - [ InlineResponse2003] ( docs/InlineResponse2003.md )
160- - [ InlineResponse201] ( docs/InlineResponse201.md )
161- - [ InlineResponse202] ( docs/InlineResponse202.md )
162- - [ InvalidIdentifierError] ( docs/InvalidIdentifierError.md )
163- - [ NoSubscribersError] ( docs/NoSubscribersError.md )
143+ - [ LanguageStringMap] ( docs/LanguageStringMap.md )
164144 - [ Notification] ( docs/Notification.md )
165- - [ Notification200Errors] ( docs/Notification200Errors.md )
166145 - [ NotificationAllOf] ( docs/NotificationAllOf.md )
167146 - [ NotificationHistorySuccessResponse] ( docs/NotificationHistorySuccessResponse.md )
168147 - [ NotificationSlice] ( docs/NotificationSlice.md )
@@ -175,31 +154,24 @@ Class | Method | HTTP request | Description
175154 - [ PlatformDeliveryData] ( docs/PlatformDeliveryData.md )
176155 - [ PlatformDeliveryDataEmailAllOf] ( docs/PlatformDeliveryDataEmailAllOf.md )
177156 - [ PlatformDeliveryDataSmsAllOf] ( docs/PlatformDeliveryDataSmsAllOf.md )
178- - [ Player] ( docs/Player.md )
179- - [ PlayerNotificationTarget] ( docs/PlayerNotificationTarget.md )
180- - [ PlayerNotificationTargetIncludeAliases] ( docs/PlayerNotificationTargetIncludeAliases.md )
181- - [ PlayerSlice] ( docs/PlayerSlice.md )
182- - [ Players] ( docs/Players.md )
157+ - [ PropertiesBody] ( docs/PropertiesBody.md )
183158 - [ PropertiesDeltas] ( docs/PropertiesDeltas.md )
184159 - [ PropertiesObject] ( docs/PropertiesObject.md )
185160 - [ Purchase] ( docs/Purchase.md )
186- - [ RateLimiterError ] ( docs/RateLimiterError .md )
161+ - [ RateLimitError ] ( docs/RateLimitError .md )
187162 - [ Segment] ( docs/Segment.md )
163+ - [ SegmentData] ( docs/SegmentData.md )
188164 - [ SegmentNotificationTarget] ( docs/SegmentNotificationTarget.md )
189- - [ StringMap] ( docs/StringMap.md )
190- - [ SubscriptionObject] ( docs/SubscriptionObject.md )
165+ - [ Subscription] ( docs/Subscription.md )
166+ - [ SubscriptionBody] ( docs/SubscriptionBody.md )
167+ - [ SubscriptionNotificationTarget] ( docs/SubscriptionNotificationTarget.md )
191168 - [ TransferSubscriptionRequestBody] ( docs/TransferSubscriptionRequestBody.md )
192169 - [ UpdateLiveActivityRequest] ( docs/UpdateLiveActivityRequest.md )
193170 - [ UpdateLiveActivitySuccessResponse] ( docs/UpdateLiveActivitySuccessResponse.md )
194- - [ UpdatePlayerSuccessResponse] ( docs/UpdatePlayerSuccessResponse.md )
195- - [ UpdatePlayerTagsRequestBody] ( docs/UpdatePlayerTagsRequestBody.md )
196- - [ UpdatePlayerTagsSuccessResponse] ( docs/UpdatePlayerTagsSuccessResponse.md )
197- - [ UpdateSubscriptionRequestBody] ( docs/UpdateSubscriptionRequestBody.md )
198171 - [ UpdateUserRequest] ( docs/UpdateUserRequest.md )
199172 - [ User] ( docs/User.md )
200- - [ UserIdentityRequestBody] ( docs/UserIdentityRequestBody.md )
201- - [ UserIdentityResponse] ( docs/UserIdentityResponse.md )
202- - [ UserSubscriptionOptions] ( docs/UserSubscriptionOptions.md )
173+ - [ UserIdentityBody] ( docs/UserIdentityBody.md )
174+ - [ WebButton] ( docs/WebButton.md )
203175
204176
205177## Author
0 commit comments