From 93fe9056f1b900e9e3b1c2f2f6142b0c7c93683d Mon Sep 17 00:00:00 2001 From: OneSignal Date: Thu, 9 Apr 2026 21:33:14 +0000 Subject: [PATCH] docs: update README and DefaultApi.md snippets --- README.md | 229 ++----- docs/ApiKeyToken.md | 2 +- docs/ApiKeyTokensListResponse.md | 2 +- docs/App.md | 2 +- docs/Apps.md | 2 +- docs/BasicNotification.md | 2 +- docs/BasicNotificationAllOf.md | 2 +- ...otificationAllOfAndroidBackgroundLayout.md | 2 +- docs/Button.md | 2 +- docs/CopyTemplateRequest.md | 2 +- docs/CreateApiKeyRequest.md | 2 +- docs/CreateApiKeyResponse.md | 2 +- docs/CreateNotificationSuccessResponse.md | 2 +- docs/CreateSegmentConflictResponse.md | 2 +- docs/CreateSegmentSuccessResponse.md | 2 +- docs/CreateTemplateRequest.md | 2 +- docs/CreateUserConflictResponse.md | 2 +- docs/CreateUserConflictResponseErrorsInner.md | 2 +- ...eateUserConflictResponseErrorsItemsMeta.md | 2 +- docs/CustomEvent.md | 2 +- docs/CustomEventsRequest.md | 2 +- docs/DefaultApi.md | 572 +++++++++++++++--- docs/DeliveryData.md | 2 +- docs/ExportEventsSuccessResponse.md | 2 +- docs/ExportSubscriptionsRequestBody.md | 2 +- docs/ExportSubscriptionsSuccessResponse.md | 2 +- docs/Filter.md | 2 +- docs/FilterExpression.md | 2 +- docs/GenericError.md | 2 +- docs/GenericSuccessBoolResponse.md | 2 +- docs/GetNotificationHistoryRequestBody.md | 2 +- docs/GetSegmentsSuccessResponse.md | 2 +- docs/IdentityObject.md | 2 +- docs/IncludeAliases.md | 2 +- docs/LanguageStringMap.md | 2 +- docs/Notification.md | 2 +- docs/NotificationAllOf.md | 2 +- docs/NotificationHistorySuccessResponse.md | 2 +- docs/NotificationSlice.md | 2 +- docs/NotificationTarget.md | 2 +- docs/NotificationWithMeta.md | 2 +- docs/NotificationWithMetaAllOf.md | 2 +- docs/Operator.md | 2 +- docs/OutcomeData.md | 2 +- docs/OutcomesData.md | 2 +- docs/PlatformDeliveryData.md | 2 +- docs/PlatformDeliveryDataEmailAllOf.md | 2 +- docs/PlatformDeliveryDataSmsAllOf.md | 2 +- docs/PropertiesBody.md | 2 +- docs/PropertiesDeltas.md | 2 +- docs/PropertiesObject.md | 2 +- docs/Purchase.md | 2 +- docs/RateLimitError.md | 2 +- docs/Segment.md | 2 +- docs/SegmentData.md | 2 +- docs/SegmentNotificationTarget.md | 2 +- docs/StartLiveActivityRequest.md | 2 +- docs/StartLiveActivitySuccessResponse.md | 2 +- docs/Subscription.md | 2 +- docs/SubscriptionBody.md | 2 +- docs/SubscriptionNotificationTarget.md | 2 +- docs/TemplateResource.md | 2 +- docs/TemplatesListResponse.md | 2 +- docs/TransferSubscriptionRequestBody.md | 2 +- docs/UpdateApiKeyRequest.md | 2 +- docs/UpdateLiveActivityRequest.md | 2 +- docs/UpdateLiveActivitySuccessResponse.md | 2 +- docs/UpdateTemplateRequest.md | 2 +- docs/UpdateUserRequest.md | 2 +- docs/User.md | 2 +- docs/UserIdentityBody.md | 2 +- docs/WebButton.md | 2 +- 72 files changed, 613 insertions(+), 328 deletions(-) diff --git a/README.md b/README.md index 6f5241e..af1935b 100644 --- a/README.md +++ b/README.md @@ -1,208 +1,97 @@ -

Welcome to @onesignal/python-onesignal 👋

+

Welcome to onesignal-python-api

Version - + Documentation - + Maintenance - - Twitter: onesignal -

A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com - API version: 5.3.0 - Package version: 5.3.0 -- Build package: org.openapitools.codegen.languages.PythonClientCodegen -## Requirements. +## Requirements Python >=3.6 -## Installation & Usage -### pip install +## Installation + ```sh pip install onesignal-python-api ``` -You can also install directly from GitHub using: +## Configuration -```sh -pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git -``` +Every SDK requires authentication via API keys. Two key types are available: -You may need to run `pip` with root permission: -```sh -sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git -``` -### Setuptools +- **REST API Key** — required for most endpoints (sending notifications, managing users, etc.). Found in your app's **Settings > Keys & IDs**. +- **Organization API Key** — only required for organization-level endpoints like creating or listing apps. Found in **Organization Settings**. -Install via [Setuptools](http://pypi.python.org/pypi/setuptools). +> **Warning:** Store your API keys in environment variables or a secrets manager. Never commit them to source control. -```sh -python setup.py install --user -``` +```python +import onesignal +from onesignal.api import default_api -To install the package for all users: -```sh -sudo python setup.py install -``` +configuration = onesignal.Configuration( + rest_api_key='YOUR_REST_API_KEY', + organization_api_key='YOUR_ORGANIZATION_API_KEY', +) -## Getting Started +with onesignal.ApiClient(configuration) as api_client: + client = default_api.DefaultApi(api_client) +``` -Please follow the [installation procedure](#installation--usage) and then run the following: +## Send a push notification ```python -import onesignal -from onesignal.api import default_api +notification = onesignal.Notification( + app_id='YOUR_APP_ID', + contents=onesignal.StringMap(en='Hello from OneSignal!'), + headings=onesignal.StringMap(en='Push Notification'), + included_segments=['Subscribed Users'], +) -# See configuration.py for a list of all supported configuration parameters. -# Some of the OneSignal endpoints require ORGANIZATION_API_KEY token for authorization, while others require REST_API_KEY. -# We recommend adding both of them in the configuration page so that you will not need to figure it out yourself. -configuration = onesignal.Configuration( - rest_api_key = "YOUR_REST_API_KEY", # App REST API key required for most endpoints - organization_api_key = "YOUR_ORGANIZATION_KEY" # Organization key is only required for creating new apps and other top-level endpoints +response = client.create_notification(notification) +print('Notification ID:', response.id) +``` + +## Send an email + +```python +notification = onesignal.Notification( + app_id='YOUR_APP_ID', + email_subject='Important Update', + email_body='

Hello!

This is an HTML email.

', + included_segments=['Subscribed Users'], + channel_for_external_user_ids='email', ) +response = client.create_notification(notification) +``` + +## Send an SMS -# Enter a context with an instance of the API client -with onesignal.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = default_api.DefaultApi(api_client) +```python +notification = onesignal.Notification( + app_id='YOUR_APP_ID', + contents=onesignal.StringMap(en='Your SMS message content here'), + included_segments=['Subscribed Users'], + channel_for_external_user_ids='sms', + sms_from='+15551234567', +) + +response = client.create_notification(notification) ``` -## Documentation for API Endpoints - -All URIs are relative to *https://api.onesignal.com* - -Class | Method | HTTP request | Description ------------- | ------------- | ------------- | ------------- -*DefaultApi* | [**cancel_notification**](docs/DefaultApi.md#cancel_notification) | **DELETE** /notifications/{notification_id} | Stop a scheduled or currently outgoing notification -*DefaultApi* | [**copy_template_to_app**](docs/DefaultApi.md#copy_template_to_app) | **POST** /templates/{template_id}/copy_to_app | Copy template to another app -*DefaultApi* | [**create_alias**](docs/DefaultApi.md#create_alias) | **PATCH** /apps/{app_id}/users/by/{alias_label}/{alias_id}/identity | -*DefaultApi* | [**create_alias_by_subscription**](docs/DefaultApi.md#create_alias_by_subscription) | **PATCH** /apps/{app_id}/subscriptions/{subscription_id}/user/identity | -*DefaultApi* | [**create_api_key**](docs/DefaultApi.md#create_api_key) | **POST** /apps/{app_id}/auth/tokens | Create API key -*DefaultApi* | [**create_app**](docs/DefaultApi.md#create_app) | **POST** /apps | Create an app -*DefaultApi* | [**create_custom_events**](docs/DefaultApi.md#create_custom_events) | **POST** /apps/{app_id}/integrations/custom_events | Create custom events -*DefaultApi* | [**create_notification**](docs/DefaultApi.md#create_notification) | **POST** /notifications | Create notification -*DefaultApi* | [**create_segment**](docs/DefaultApi.md#create_segment) | **POST** /apps/{app_id}/segments | Create Segment -*DefaultApi* | [**create_subscription**](docs/DefaultApi.md#create_subscription) | **POST** /apps/{app_id}/users/by/{alias_label}/{alias_id}/subscriptions | -*DefaultApi* | [**create_template**](docs/DefaultApi.md#create_template) | **POST** /templates | Create template -*DefaultApi* | [**create_user**](docs/DefaultApi.md#create_user) | **POST** /apps/{app_id}/users | -*DefaultApi* | [**delete_alias**](docs/DefaultApi.md#delete_alias) | **DELETE** /apps/{app_id}/users/by/{alias_label}/{alias_id}/identity/{alias_label_to_delete} | -*DefaultApi* | [**delete_api_key**](docs/DefaultApi.md#delete_api_key) | **DELETE** /apps/{app_id}/auth/tokens/{token_id} | Delete API key -*DefaultApi* | [**delete_segment**](docs/DefaultApi.md#delete_segment) | **DELETE** /apps/{app_id}/segments/{segment_id} | Delete Segment -*DefaultApi* | [**delete_subscription**](docs/DefaultApi.md#delete_subscription) | **DELETE** /apps/{app_id}/subscriptions/{subscription_id} | -*DefaultApi* | [**delete_template**](docs/DefaultApi.md#delete_template) | **DELETE** /templates/{template_id} | Delete template -*DefaultApi* | [**delete_user**](docs/DefaultApi.md#delete_user) | **DELETE** /apps/{app_id}/users/by/{alias_label}/{alias_id} | -*DefaultApi* | [**export_events**](docs/DefaultApi.md#export_events) | **POST** /notifications/{notification_id}/export_events?app_id={app_id} | Export CSV of Events -*DefaultApi* | [**export_subscriptions**](docs/DefaultApi.md#export_subscriptions) | **POST** /players/csv_export?app_id={app_id} | Export CSV of Subscriptions -*DefaultApi* | [**get_aliases**](docs/DefaultApi.md#get_aliases) | **GET** /apps/{app_id}/users/by/{alias_label}/{alias_id}/identity | -*DefaultApi* | [**get_aliases_by_subscription**](docs/DefaultApi.md#get_aliases_by_subscription) | **GET** /apps/{app_id}/subscriptions/{subscription_id}/user/identity | -*DefaultApi* | [**get_app**](docs/DefaultApi.md#get_app) | **GET** /apps/{app_id} | View an app -*DefaultApi* | [**get_apps**](docs/DefaultApi.md#get_apps) | **GET** /apps | View apps -*DefaultApi* | [**get_notification**](docs/DefaultApi.md#get_notification) | **GET** /notifications/{notification_id} | View notification -*DefaultApi* | [**get_notification_history**](docs/DefaultApi.md#get_notification_history) | **POST** /notifications/{notification_id}/history | Notification History -*DefaultApi* | [**get_notifications**](docs/DefaultApi.md#get_notifications) | **GET** /notifications | View notifications -*DefaultApi* | [**get_outcomes**](docs/DefaultApi.md#get_outcomes) | **GET** /apps/{app_id}/outcomes | View Outcomes -*DefaultApi* | [**get_segments**](docs/DefaultApi.md#get_segments) | **GET** /apps/{app_id}/segments | Get Segments -*DefaultApi* | [**get_user**](docs/DefaultApi.md#get_user) | **GET** /apps/{app_id}/users/by/{alias_label}/{alias_id} | -*DefaultApi* | [**rotate_api_key**](docs/DefaultApi.md#rotate_api_key) | **POST** /apps/{app_id}/auth/tokens/{token_id}/rotate | Rotate API key -*DefaultApi* | [**start_live_activity**](docs/DefaultApi.md#start_live_activity) | **POST** /apps/{app_id}/activities/activity/{activity_type} | Start Live Activity -*DefaultApi* | [**transfer_subscription**](docs/DefaultApi.md#transfer_subscription) | **PATCH** /apps/{app_id}/subscriptions/{subscription_id}/owner | -*DefaultApi* | [**unsubscribe_email_with_token**](docs/DefaultApi.md#unsubscribe_email_with_token) | **POST** /apps/{app_id}/notifications/{notification_id}/unsubscribe | Unsubscribe with token -*DefaultApi* | [**update_api_key**](docs/DefaultApi.md#update_api_key) | **PATCH** /apps/{app_id}/auth/tokens/{token_id} | Update API key -*DefaultApi* | [**update_app**](docs/DefaultApi.md#update_app) | **PUT** /apps/{app_id} | Update an app -*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 -*DefaultApi* | [**update_subscription**](docs/DefaultApi.md#update_subscription) | **PATCH** /apps/{app_id}/subscriptions/{subscription_id} | -*DefaultApi* | [**update_subscription_by_token**](docs/DefaultApi.md#update_subscription_by_token) | **PATCH** /apps/{app_id}/subscriptions_by_token/{token_type}/{token} | Update subscription by token -*DefaultApi* | [**update_template**](docs/DefaultApi.md#update_template) | **PATCH** /templates/{template_id} | Update template -*DefaultApi* | [**update_user**](docs/DefaultApi.md#update_user) | **PATCH** /apps/{app_id}/users/by/{alias_label}/{alias_id} | -*DefaultApi* | [**view_api_keys**](docs/DefaultApi.md#view_api_keys) | **GET** /apps/{app_id}/auth/tokens | View API keys -*DefaultApi* | [**view_template**](docs/DefaultApi.md#view_template) | **GET** /templates/{template_id} | View template -*DefaultApi* | [**view_templates**](docs/DefaultApi.md#view_templates) | **GET** /templates | View templates - - -## Documentation For Models - - - [ApiKeyToken](docs/ApiKeyToken.md) - - [ApiKeyTokensListResponse](docs/ApiKeyTokensListResponse.md) - - [App](docs/App.md) - - [Apps](docs/Apps.md) - - [BasicNotification](docs/BasicNotification.md) - - [BasicNotificationAllOf](docs/BasicNotificationAllOf.md) - - [BasicNotificationAllOfAndroidBackgroundLayout](docs/BasicNotificationAllOfAndroidBackgroundLayout.md) - - [Button](docs/Button.md) - - [CopyTemplateRequest](docs/CopyTemplateRequest.md) - - [CreateApiKeyRequest](docs/CreateApiKeyRequest.md) - - [CreateApiKeyResponse](docs/CreateApiKeyResponse.md) - - [CreateNotificationSuccessResponse](docs/CreateNotificationSuccessResponse.md) - - [CreateSegmentConflictResponse](docs/CreateSegmentConflictResponse.md) - - [CreateSegmentSuccessResponse](docs/CreateSegmentSuccessResponse.md) - - [CreateTemplateRequest](docs/CreateTemplateRequest.md) - - [CreateUserConflictResponse](docs/CreateUserConflictResponse.md) - - [CreateUserConflictResponseErrorsInner](docs/CreateUserConflictResponseErrorsInner.md) - - [CreateUserConflictResponseErrorsItemsMeta](docs/CreateUserConflictResponseErrorsItemsMeta.md) - - [CustomEvent](docs/CustomEvent.md) - - [CustomEventsRequest](docs/CustomEventsRequest.md) - - [DeliveryData](docs/DeliveryData.md) - - [ExportEventsSuccessResponse](docs/ExportEventsSuccessResponse.md) - - [ExportSubscriptionsRequestBody](docs/ExportSubscriptionsRequestBody.md) - - [ExportSubscriptionsSuccessResponse](docs/ExportSubscriptionsSuccessResponse.md) - - [Filter](docs/Filter.md) - - [FilterExpression](docs/FilterExpression.md) - - [GenericError](docs/GenericError.md) - - [GenericSuccessBoolResponse](docs/GenericSuccessBoolResponse.md) - - [GetNotificationHistoryRequestBody](docs/GetNotificationHistoryRequestBody.md) - - [GetSegmentsSuccessResponse](docs/GetSegmentsSuccessResponse.md) - - [IdentityObject](docs/IdentityObject.md) - - [IncludeAliases](docs/IncludeAliases.md) - - [LanguageStringMap](docs/LanguageStringMap.md) - - [Notification](docs/Notification.md) - - [NotificationAllOf](docs/NotificationAllOf.md) - - [NotificationHistorySuccessResponse](docs/NotificationHistorySuccessResponse.md) - - [NotificationSlice](docs/NotificationSlice.md) - - [NotificationTarget](docs/NotificationTarget.md) - - [NotificationWithMeta](docs/NotificationWithMeta.md) - - [NotificationWithMetaAllOf](docs/NotificationWithMetaAllOf.md) - - [Operator](docs/Operator.md) - - [OutcomeData](docs/OutcomeData.md) - - [OutcomesData](docs/OutcomesData.md) - - [PlatformDeliveryData](docs/PlatformDeliveryData.md) - - [PlatformDeliveryDataEmailAllOf](docs/PlatformDeliveryDataEmailAllOf.md) - - [PlatformDeliveryDataSmsAllOf](docs/PlatformDeliveryDataSmsAllOf.md) - - [PropertiesBody](docs/PropertiesBody.md) - - [PropertiesDeltas](docs/PropertiesDeltas.md) - - [PropertiesObject](docs/PropertiesObject.md) - - [Purchase](docs/Purchase.md) - - [RateLimitError](docs/RateLimitError.md) - - [Segment](docs/Segment.md) - - [SegmentData](docs/SegmentData.md) - - [SegmentNotificationTarget](docs/SegmentNotificationTarget.md) - - [StartLiveActivityRequest](docs/StartLiveActivityRequest.md) - - [StartLiveActivitySuccessResponse](docs/StartLiveActivitySuccessResponse.md) - - [Subscription](docs/Subscription.md) - - [SubscriptionBody](docs/SubscriptionBody.md) - - [SubscriptionNotificationTarget](docs/SubscriptionNotificationTarget.md) - - [TemplateResource](docs/TemplateResource.md) - - [TemplatesListResponse](docs/TemplatesListResponse.md) - - [TransferSubscriptionRequestBody](docs/TransferSubscriptionRequestBody.md) - - [UpdateApiKeyRequest](docs/UpdateApiKeyRequest.md) - - [UpdateLiveActivityRequest](docs/UpdateLiveActivityRequest.md) - - [UpdateLiveActivitySuccessResponse](docs/UpdateLiveActivitySuccessResponse.md) - - [UpdateTemplateRequest](docs/UpdateTemplateRequest.md) - - [UpdateUserRequest](docs/UpdateUserRequest.md) - - [User](docs/User.md) - - [UserIdentityBody](docs/UserIdentityBody.md) - - [WebButton](docs/WebButton.md) - - -## Author - -devrel@onesignal.com +## Full API reference + +The complete list of API endpoints and their parameters is available in the [DefaultApi documentation](https://github.com/OneSignal/onesignal-python-api/blob/main/docs/DefaultApi.md). +For the underlying REST API, see the [OneSignal API reference](https://documentation.onesignal.com/reference). diff --git a/docs/ApiKeyToken.md b/docs/ApiKeyToken.md index 0d1f177..f0a2c06 100644 --- a/docs/ApiKeyToken.md +++ b/docs/ApiKeyToken.md @@ -12,6 +12,6 @@ Name | Type | Description | Notes **ip_allowlist** | **[str]** | | [optional] **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-python-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-python-api) diff --git a/docs/ApiKeyTokensListResponse.md b/docs/ApiKeyTokensListResponse.md index 635e8fd..fe7f096 100644 --- a/docs/ApiKeyTokensListResponse.md +++ b/docs/ApiKeyTokensListResponse.md @@ -7,6 +7,6 @@ Name | Type | Description | Notes **tokens** | [**[ApiKeyToken]**](ApiKeyToken.md) | | [optional] **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-python-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-python-api) diff --git a/docs/App.md b/docs/App.md index 7e2813e..0e46e07 100644 --- a/docs/App.md +++ b/docs/App.md @@ -40,6 +40,6 @@ Name | Type | Description | Notes **additional_data_is_root_payload** | **bool** | iOS: Notification data (additional data) values will be added to the root of the apns payload when sent to the device. Ignore if you're not using any other plugins, or not using OneSignal SDK methods to read the payload. | [optional] **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-python-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-python-api) diff --git a/docs/Apps.md b/docs/Apps.md index 7a47b08..426c9bd 100644 --- a/docs/Apps.md +++ b/docs/Apps.md @@ -6,6 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **value** | [**[App]**](App.md) | | -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-python-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-python-api) diff --git a/docs/BasicNotification.md b/docs/BasicNotification.md index 6817ec7..5bdc885 100644 --- a/docs/BasicNotification.md +++ b/docs/BasicNotification.md @@ -120,6 +120,6 @@ Name | Type | Description | Notes **huawei_bi_tag** | **str, none_type** | Channel: Push Notifications Platform: Huawei A tag used for Huawei business intelligence and analytics. | [optional] **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-python-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-python-api) diff --git a/docs/BasicNotificationAllOf.md b/docs/BasicNotificationAllOf.md index d031712..d3c7a09 100644 --- a/docs/BasicNotificationAllOf.md +++ b/docs/BasicNotificationAllOf.md @@ -107,6 +107,6 @@ Name | Type | Description | Notes **huawei_bi_tag** | **str, none_type** | Channel: Push Notifications Platform: Huawei A tag used for Huawei business intelligence and analytics. | [optional] **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-python-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-python-api) diff --git a/docs/BasicNotificationAllOfAndroidBackgroundLayout.md b/docs/BasicNotificationAllOfAndroidBackgroundLayout.md index 1cb0d03..0f72889 100644 --- a/docs/BasicNotificationAllOfAndroidBackgroundLayout.md +++ b/docs/BasicNotificationAllOfAndroidBackgroundLayout.md @@ -10,6 +10,6 @@ Name | Type | Description | Notes **contents_color** | **str** | Body text color ARGB Hex format. Example(Red) \"FFFF0000\". | [optional] **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-python-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-python-api) diff --git a/docs/Button.md b/docs/Button.md index 4881263..608a17b 100644 --- a/docs/Button.md +++ b/docs/Button.md @@ -9,6 +9,6 @@ Name | Type | Description | Notes **icon** | **str** | | [optional] **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-python-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-python-api) diff --git a/docs/CopyTemplateRequest.md b/docs/CopyTemplateRequest.md index 0b39299..dded338 100644 --- a/docs/CopyTemplateRequest.md +++ b/docs/CopyTemplateRequest.md @@ -7,6 +7,6 @@ Name | Type | Description | Notes **target_app_id** | **str** | Destination OneSignal App ID in UUID v4 format. | **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-python-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-python-api) diff --git a/docs/CreateApiKeyRequest.md b/docs/CreateApiKeyRequest.md index e7a7775..e649050 100644 --- a/docs/CreateApiKeyRequest.md +++ b/docs/CreateApiKeyRequest.md @@ -9,6 +9,6 @@ Name | Type | Description | Notes **ip_allowlist** | **[str]** | | [optional] **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-python-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-python-api) diff --git a/docs/CreateApiKeyResponse.md b/docs/CreateApiKeyResponse.md index df68152..6454f03 100644 --- a/docs/CreateApiKeyResponse.md +++ b/docs/CreateApiKeyResponse.md @@ -8,6 +8,6 @@ Name | Type | Description | Notes **formatted_token** | **str** | | [optional] **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-python-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-python-api) diff --git a/docs/CreateNotificationSuccessResponse.md b/docs/CreateNotificationSuccessResponse.md index 9fafa7f..2087947 100644 --- a/docs/CreateNotificationSuccessResponse.md +++ b/docs/CreateNotificationSuccessResponse.md @@ -9,6 +9,6 @@ Name | Type | Description | Notes **errors** | **bool, date, datetime, dict, float, int, list, str, none_type** | Errors include the identifiers that are invalid, or that there are no subscribers. | [optional] **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-python-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-python-api) diff --git a/docs/CreateSegmentConflictResponse.md b/docs/CreateSegmentConflictResponse.md index 78a99f9..a584c49 100644 --- a/docs/CreateSegmentConflictResponse.md +++ b/docs/CreateSegmentConflictResponse.md @@ -8,6 +8,6 @@ Name | Type | Description | Notes **errors** | **[str]** | | [optional] **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-python-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-python-api) diff --git a/docs/CreateSegmentSuccessResponse.md b/docs/CreateSegmentSuccessResponse.md index 2a613c0..f565dcf 100644 --- a/docs/CreateSegmentSuccessResponse.md +++ b/docs/CreateSegmentSuccessResponse.md @@ -8,6 +8,6 @@ Name | Type | Description | Notes **id** | **str** | UUID of created segment | [optional] **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-python-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-python-api) diff --git a/docs/CreateTemplateRequest.md b/docs/CreateTemplateRequest.md index e1bba80..1ae2abc 100644 --- a/docs/CreateTemplateRequest.md +++ b/docs/CreateTemplateRequest.md @@ -14,6 +14,6 @@ Name | Type | Description | Notes **dynamic_content** | **str, none_type** | JSON string for dynamic content personalization. | [optional] **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-python-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-python-api) diff --git a/docs/CreateUserConflictResponse.md b/docs/CreateUserConflictResponse.md index 40c5171..4368174 100644 --- a/docs/CreateUserConflictResponse.md +++ b/docs/CreateUserConflictResponse.md @@ -7,6 +7,6 @@ Name | Type | Description | Notes **errors** | [**[CreateUserConflictResponseErrorsInner]**](CreateUserConflictResponseErrorsInner.md) | | [optional] **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-python-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-python-api) diff --git a/docs/CreateUserConflictResponseErrorsInner.md b/docs/CreateUserConflictResponseErrorsInner.md index d105be4..347a1ab 100644 --- a/docs/CreateUserConflictResponseErrorsInner.md +++ b/docs/CreateUserConflictResponseErrorsInner.md @@ -9,6 +9,6 @@ Name | Type | Description | Notes **meta** | [**CreateUserConflictResponseErrorsItemsMeta**](CreateUserConflictResponseErrorsItemsMeta.md) | | [optional] **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-python-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-python-api) diff --git a/docs/CreateUserConflictResponseErrorsItemsMeta.md b/docs/CreateUserConflictResponseErrorsItemsMeta.md index 62b8bea..6708d8d 100644 --- a/docs/CreateUserConflictResponseErrorsItemsMeta.md +++ b/docs/CreateUserConflictResponseErrorsItemsMeta.md @@ -7,6 +7,6 @@ Name | Type | Description | Notes **conflicting_aliases** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** | | [optional] **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-python-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-python-api) diff --git a/docs/CustomEvent.md b/docs/CustomEvent.md index a9ad8de..9bc81e0 100644 --- a/docs/CustomEvent.md +++ b/docs/CustomEvent.md @@ -11,6 +11,6 @@ Name | Type | Description | Notes **payload** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** | Properties or data related to the event, like {\"geography\": \"USA\"} | [optional] **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-python-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-python-api) diff --git a/docs/CustomEventsRequest.md b/docs/CustomEventsRequest.md index 81fe03d..cdab04b 100644 --- a/docs/CustomEventsRequest.md +++ b/docs/CustomEventsRequest.md @@ -7,6 +7,6 @@ Name | Type | Description | Notes **events** | [**[CustomEvent]**](CustomEvent.md) | | **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-python-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-python-api) diff --git a/docs/DefaultApi.md b/docs/DefaultApi.md index 17be4a3..672ad06 100644 --- a/docs/DefaultApi.md +++ b/docs/DefaultApi.md @@ -69,6 +69,15 @@ from onesignal.model.generic_error import GenericError from onesignal.model.generic_success_bool_response import GenericSuccessBoolResponse from pprint import pprint +# See configuration.py for a list of all supported configuration parameters. +# Some of the OneSignal endpoints require ORGANIZATION_API_KEY token for authorization, while others require REST_API_KEY. +# We recommend adding both of them in the configuration page so that you will not need to figure it out yourself. +configuration = onesignal.Configuration( + rest_api_key = "YOUR_REST_API_KEY", # App REST API key required for most endpoints + organization_api_key = "YOUR_ORGANIZATION_KEY" # Organization key is only required for creating new apps and other top-level endpoints +) + + # Enter a context with an instance of the API client with onesignal.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -99,7 +108,7 @@ Name | Type | Description | Notes ### Authorization -[rest_api_key](../README.md#rest_api_key) +[rest_api_key](https://github.com/OneSignal/onesignal-python-api#configuration) ### HTTP request headers @@ -116,7 +125,7 @@ Name | Type | Description | Notes **404** | Not Found | - | **429** | Rate Limit Exceeded | - | -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) [[Back to API list]](https://github.com/OneSignal/onesignal-python-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-python-api) # **copy_template_to_app** > TemplateResource copy_template_to_app(template_id, app_id, copy_template_request) @@ -137,6 +146,15 @@ from onesignal.model.template_resource import TemplateResource from onesignal.model.generic_error import GenericError from pprint import pprint +# See configuration.py for a list of all supported configuration parameters. +# Some of the OneSignal endpoints require ORGANIZATION_API_KEY token for authorization, while others require REST_API_KEY. +# We recommend adding both of them in the configuration page so that you will not need to figure it out yourself. +configuration = onesignal.Configuration( + rest_api_key = "YOUR_REST_API_KEY", # App REST API key required for most endpoints + organization_api_key = "YOUR_ORGANIZATION_KEY" # Organization key is only required for creating new apps and other top-level endpoints +) + + # Enter a context with an instance of the API client with onesignal.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -171,7 +189,7 @@ Name | Type | Description | Notes ### Authorization -[organization_api_key](../README.md#organization_api_key) +[organization_api_key](https://github.com/OneSignal/onesignal-python-api#configuration) ### HTTP request headers @@ -186,7 +204,7 @@ Name | Type | Description | Notes **200** | OK | - | **400** | Bad Request | - | -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) [[Back to API list]](https://github.com/OneSignal/onesignal-python-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-python-api) # **create_alias** > UserIdentityBody create_alias(app_id, alias_label, alias_id, user_identity_body) @@ -207,6 +225,15 @@ from onesignal.model.generic_error import GenericError from onesignal.model.user_identity_body import UserIdentityBody from pprint import pprint +# See configuration.py for a list of all supported configuration parameters. +# Some of the OneSignal endpoints require ORGANIZATION_API_KEY token for authorization, while others require REST_API_KEY. +# We recommend adding both of them in the configuration page so that you will not need to figure it out yourself. +configuration = onesignal.Configuration( + rest_api_key = "YOUR_REST_API_KEY", # App REST API key required for most endpoints + organization_api_key = "YOUR_ORGANIZATION_KEY" # Organization key is only required for creating new apps and other top-level endpoints +) + + # Enter a context with an instance of the API client with onesignal.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -244,7 +271,7 @@ Name | Type | Description | Notes ### Authorization -[rest_api_key](../README.md#rest_api_key) +[rest_api_key](https://github.com/OneSignal/onesignal-python-api#configuration) ### HTTP request headers @@ -262,7 +289,7 @@ Name | Type | Description | Notes **409** | Conflict | - | **429** | Rate Limit Exceeded | - | -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) [[Back to API list]](https://github.com/OneSignal/onesignal-python-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-python-api) # **create_alias_by_subscription** > UserIdentityBody create_alias_by_subscription(app_id, subscription_id, user_identity_body) @@ -283,6 +310,15 @@ from onesignal.model.generic_error import GenericError from onesignal.model.user_identity_body import UserIdentityBody from pprint import pprint +# See configuration.py for a list of all supported configuration parameters. +# Some of the OneSignal endpoints require ORGANIZATION_API_KEY token for authorization, while others require REST_API_KEY. +# We recommend adding both of them in the configuration page so that you will not need to figure it out yourself. +configuration = onesignal.Configuration( + rest_api_key = "YOUR_REST_API_KEY", # App REST API key required for most endpoints + organization_api_key = "YOUR_ORGANIZATION_KEY" # Organization key is only required for creating new apps and other top-level endpoints +) + + # Enter a context with an instance of the API client with onesignal.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -318,7 +354,7 @@ Name | Type | Description | Notes ### Authorization -[rest_api_key](../README.md#rest_api_key) +[rest_api_key](https://github.com/OneSignal/onesignal-python-api#configuration) ### HTTP request headers @@ -336,7 +372,7 @@ Name | Type | Description | Notes **409** | Conflict | - | **429** | Rate Limit Exceeded | - | -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) [[Back to API list]](https://github.com/OneSignal/onesignal-python-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-python-api) # **create_api_key** > CreateApiKeyResponse create_api_key(app_id, create_api_key_request) @@ -357,6 +393,15 @@ from onesignal.model.create_api_key_request import CreateApiKeyRequest from onesignal.model.generic_error import GenericError from pprint import pprint +# See configuration.py for a list of all supported configuration parameters. +# Some of the OneSignal endpoints require ORGANIZATION_API_KEY token for authorization, while others require REST_API_KEY. +# We recommend adding both of them in the configuration page so that you will not need to figure it out yourself. +configuration = onesignal.Configuration( + rest_api_key = "YOUR_REST_API_KEY", # App REST API key required for most endpoints + organization_api_key = "YOUR_ORGANIZATION_KEY" # Organization key is only required for creating new apps and other top-level endpoints +) + + # Enter a context with an instance of the API client with onesignal.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -393,7 +438,7 @@ Name | Type | Description | Notes ### Authorization -[organization_api_key](../README.md#organization_api_key) +[organization_api_key](https://github.com/OneSignal/onesignal-python-api#configuration) ### HTTP request headers @@ -408,7 +453,7 @@ Name | Type | Description | Notes **200** | OK | - | **400** | Bad Request | - | -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) [[Back to API list]](https://github.com/OneSignal/onesignal-python-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-python-api) # **create_app** > App create_app(app) @@ -429,6 +474,15 @@ from onesignal.model.rate_limit_error import RateLimitError from onesignal.model.generic_error import GenericError from pprint import pprint +# See configuration.py for a list of all supported configuration parameters. +# Some of the OneSignal endpoints require ORGANIZATION_API_KEY token for authorization, while others require REST_API_KEY. +# We recommend adding both of them in the configuration page so that you will not need to figure it out yourself. +configuration = onesignal.Configuration( + rest_api_key = "YOUR_REST_API_KEY", # App REST API key required for most endpoints + organization_api_key = "YOUR_ORGANIZATION_KEY" # Organization key is only required for creating new apps and other top-level endpoints +) + + # Enter a context with an instance of the API client with onesignal.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -479,7 +533,7 @@ Name | Type | Description | Notes ### Authorization -[organization_api_key](../README.md#organization_api_key) +[organization_api_key](https://github.com/OneSignal/onesignal-python-api#configuration) ### HTTP request headers @@ -495,7 +549,7 @@ Name | Type | Description | Notes **400** | Bad Request | - | **429** | Rate Limit Exceeded | - | -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) [[Back to API list]](https://github.com/OneSignal/onesignal-python-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-python-api) # **create_custom_events** > {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_custom_events(app_id, custom_events_request) @@ -516,6 +570,15 @@ from onesignal.model.rate_limit_error import RateLimitError from onesignal.model.generic_error import GenericError from pprint import pprint +# See configuration.py for a list of all supported configuration parameters. +# Some of the OneSignal endpoints require ORGANIZATION_API_KEY token for authorization, while others require REST_API_KEY. +# We recommend adding both of them in the configuration page so that you will not need to figure it out yourself. +configuration = onesignal.Configuration( + rest_api_key = "YOUR_REST_API_KEY", # App REST API key required for most endpoints + organization_api_key = "YOUR_ORGANIZATION_KEY" # Organization key is only required for creating new apps and other top-level endpoints +) + + # Enter a context with an instance of the API client with onesignal.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -556,7 +619,7 @@ Name | Type | Description | Notes ### Authorization -[rest_api_key](../README.md#rest_api_key) +[rest_api_key](https://github.com/OneSignal/onesignal-python-api#configuration) ### HTTP request headers @@ -573,7 +636,7 @@ Name | Type | Description | Notes **401** | Unauthorized | - | **429** | Rate Limit Exceeded | - | -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) [[Back to API list]](https://github.com/OneSignal/onesignal-python-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-python-api) # **create_notification** > CreateNotificationSuccessResponse create_notification(notification) @@ -595,6 +658,15 @@ from onesignal.model.notification import Notification from onesignal.model.create_notification_success_response import CreateNotificationSuccessResponse from pprint import pprint +# See configuration.py for a list of all supported configuration parameters. +# Some of the OneSignal endpoints require ORGANIZATION_API_KEY token for authorization, while others require REST_API_KEY. +# We recommend adding both of them in the configuration page so that you will not need to figure it out yourself. +configuration = onesignal.Configuration( + rest_api_key = "YOUR_REST_API_KEY", # App REST API key required for most endpoints + organization_api_key = "YOUR_ORGANIZATION_KEY" # Organization key is only required for creating new apps and other top-level endpoints +) + + # Enter a context with an instance of the API client with onesignal.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -623,7 +695,7 @@ Name | Type | Description | Notes ### Authorization -[rest_api_key](../README.md#rest_api_key) +[rest_api_key](https://github.com/OneSignal/onesignal-python-api#configuration) ### HTTP request headers @@ -639,7 +711,7 @@ Name | Type | Description | Notes **400** | Bad Request | - | **429** | Rate Limit Exceeded | - | -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) [[Back to API list]](https://github.com/OneSignal/onesignal-python-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-python-api) # **create_segment** > CreateSegmentSuccessResponse create_segment(app_id) @@ -662,6 +734,15 @@ from onesignal.model.rate_limit_error import RateLimitError from onesignal.model.generic_error import GenericError from pprint import pprint +# See configuration.py for a list of all supported configuration parameters. +# Some of the OneSignal endpoints require ORGANIZATION_API_KEY token for authorization, while others require REST_API_KEY. +# We recommend adding both of them in the configuration page so that you will not need to figure it out yourself. +configuration = onesignal.Configuration( + rest_api_key = "YOUR_REST_API_KEY", # App REST API key required for most endpoints + organization_api_key = "YOUR_ORGANIZATION_KEY" # Organization key is only required for creating new apps and other top-level endpoints +) + + # Enter a context with an instance of the API client with onesignal.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -707,7 +788,7 @@ Name | Type | Description | Notes ### Authorization -[rest_api_key](../README.md#rest_api_key) +[rest_api_key](https://github.com/OneSignal/onesignal-python-api#configuration) ### HTTP request headers @@ -724,7 +805,7 @@ Name | Type | Description | Notes **409** | Conflict | - | **429** | Rate Limit Exceeded | - | -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) [[Back to API list]](https://github.com/OneSignal/onesignal-python-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-python-api) # **create_subscription** > SubscriptionBody create_subscription(app_id, alias_label, alias_id, subscription_body) @@ -745,6 +826,15 @@ from onesignal.model.generic_error import GenericError from onesignal.model.subscription_body import SubscriptionBody from pprint import pprint +# See configuration.py for a list of all supported configuration parameters. +# Some of the OneSignal endpoints require ORGANIZATION_API_KEY token for authorization, while others require REST_API_KEY. +# We recommend adding both of them in the configuration page so that you will not need to figure it out yourself. +configuration = onesignal.Configuration( + rest_api_key = "YOUR_REST_API_KEY", # App REST API key required for most endpoints + organization_api_key = "YOUR_ORGANIZATION_KEY" # Organization key is only required for creating new apps and other top-level endpoints +) + + # Enter a context with an instance of the API client with onesignal.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -798,7 +888,7 @@ Name | Type | Description | Notes ### Authorization -[rest_api_key](../README.md#rest_api_key) +[rest_api_key](https://github.com/OneSignal/onesignal-python-api#configuration) ### HTTP request headers @@ -817,7 +907,7 @@ Name | Type | Description | Notes **409** | Operation is not permitted due to user having the maximum number of subscriptions assigned | - | **429** | Rate Limit Exceeded | - | -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) [[Back to API list]](https://github.com/OneSignal/onesignal-python-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-python-api) # **create_template** > TemplateResource create_template(create_template_request) @@ -838,6 +928,15 @@ from onesignal.model.template_resource import TemplateResource from onesignal.model.generic_error import GenericError from pprint import pprint +# See configuration.py for a list of all supported configuration parameters. +# Some of the OneSignal endpoints require ORGANIZATION_API_KEY token for authorization, while others require REST_API_KEY. +# We recommend adding both of them in the configuration page so that you will not need to figure it out yourself. +configuration = onesignal.Configuration( + rest_api_key = "YOUR_REST_API_KEY", # App REST API key required for most endpoints + organization_api_key = "YOUR_ORGANIZATION_KEY" # Organization key is only required for creating new apps and other top-level endpoints +) + + # Enter a context with an instance of the API client with onesignal.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -919,7 +1018,7 @@ Name | Type | Description | Notes ### Authorization -[rest_api_key](../README.md#rest_api_key) +[rest_api_key](https://github.com/OneSignal/onesignal-python-api#configuration) ### HTTP request headers @@ -935,7 +1034,7 @@ Name | Type | Description | Notes **400** | Bad Request | - | **422** | Unprocessable Entity | - | -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) [[Back to API list]](https://github.com/OneSignal/onesignal-python-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-python-api) # **create_user** > User create_user(app_id, user) @@ -957,6 +1056,15 @@ from onesignal.model.generic_error import GenericError from onesignal.model.create_user_conflict_response import CreateUserConflictResponse from pprint import pprint +# See configuration.py for a list of all supported configuration parameters. +# Some of the OneSignal endpoints require ORGANIZATION_API_KEY token for authorization, while others require REST_API_KEY. +# We recommend adding both of them in the configuration page so that you will not need to figure it out yourself. +configuration = onesignal.Configuration( + rest_api_key = "YOUR_REST_API_KEY", # App REST API key required for most endpoints + organization_api_key = "YOUR_ORGANIZATION_KEY" # Organization key is only required for creating new apps and other top-level endpoints +) + + # Enter a context with an instance of the API client with onesignal.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -1031,7 +1139,7 @@ Name | Type | Description | Notes ### Authorization -[rest_api_key](../README.md#rest_api_key) +[rest_api_key](https://github.com/OneSignal/onesignal-python-api#configuration) ### HTTP request headers @@ -1050,7 +1158,7 @@ Name | Type | Description | Notes **409** | Multiple User Identity Conflict | - | **429** | Rate Limit Exceeded | - | -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) [[Back to API list]](https://github.com/OneSignal/onesignal-python-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-python-api) # **delete_alias** > UserIdentityBody delete_alias(app_id, alias_label, alias_id, alias_label_to_delete) @@ -1071,6 +1179,15 @@ from onesignal.model.generic_error import GenericError from onesignal.model.user_identity_body import UserIdentityBody from pprint import pprint +# See configuration.py for a list of all supported configuration parameters. +# Some of the OneSignal endpoints require ORGANIZATION_API_KEY token for authorization, while others require REST_API_KEY. +# We recommend adding both of them in the configuration page so that you will not need to figure it out yourself. +configuration = onesignal.Configuration( + rest_api_key = "YOUR_REST_API_KEY", # App REST API key required for most endpoints + organization_api_key = "YOUR_ORGANIZATION_KEY" # Organization key is only required for creating new apps and other top-level endpoints +) + + # Enter a context with an instance of the API client with onesignal.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -1104,7 +1221,7 @@ Name | Type | Description | Notes ### Authorization -[rest_api_key](../README.md#rest_api_key) +[rest_api_key](https://github.com/OneSignal/onesignal-python-api#configuration) ### HTTP request headers @@ -1122,7 +1239,7 @@ Name | Type | Description | Notes **409** | Conflict | - | **429** | Rate Limit Exceeded | - | -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) [[Back to API list]](https://github.com/OneSignal/onesignal-python-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-python-api) # **delete_api_key** > {str: (bool, date, datetime, dict, float, int, list, str, none_type)} delete_api_key(app_id, token_id) @@ -1141,6 +1258,15 @@ from onesignal.api import default_api from onesignal.model.generic_error import GenericError from pprint import pprint +# See configuration.py for a list of all supported configuration parameters. +# Some of the OneSignal endpoints require ORGANIZATION_API_KEY token for authorization, while others require REST_API_KEY. +# We recommend adding both of them in the configuration page so that you will not need to figure it out yourself. +configuration = onesignal.Configuration( + rest_api_key = "YOUR_REST_API_KEY", # App REST API key required for most endpoints + organization_api_key = "YOUR_ORGANIZATION_KEY" # Organization key is only required for creating new apps and other top-level endpoints +) + + # Enter a context with an instance of the API client with onesignal.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -1171,7 +1297,7 @@ Name | Type | Description | Notes ### Authorization -[organization_api_key](../README.md#organization_api_key) +[organization_api_key](https://github.com/OneSignal/onesignal-python-api#configuration) ### HTTP request headers @@ -1186,7 +1312,7 @@ Name | Type | Description | Notes **200** | OK | - | **400** | Bad Request | - | -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) [[Back to API list]](https://github.com/OneSignal/onesignal-python-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-python-api) # **delete_segment** > GenericSuccessBoolResponse delete_segment(app_id, segment_id) @@ -1207,6 +1333,15 @@ from onesignal.model.generic_error import GenericError from onesignal.model.generic_success_bool_response import GenericSuccessBoolResponse from pprint import pprint +# See configuration.py for a list of all supported configuration parameters. +# Some of the OneSignal endpoints require ORGANIZATION_API_KEY token for authorization, while others require REST_API_KEY. +# We recommend adding both of them in the configuration page so that you will not need to figure it out yourself. +configuration = onesignal.Configuration( + rest_api_key = "YOUR_REST_API_KEY", # App REST API key required for most endpoints + organization_api_key = "YOUR_ORGANIZATION_KEY" # Organization key is only required for creating new apps and other top-level endpoints +) + + # Enter a context with an instance of the API client with onesignal.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -1237,7 +1372,7 @@ Name | Type | Description | Notes ### Authorization -[rest_api_key](../README.md#rest_api_key) +[rest_api_key](https://github.com/OneSignal/onesignal-python-api#configuration) ### HTTP request headers @@ -1254,7 +1389,7 @@ Name | Type | Description | Notes **404** | Not Found | - | **429** | Rate Limit Exceeded | - | -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) [[Back to API list]](https://github.com/OneSignal/onesignal-python-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-python-api) # **delete_subscription** > delete_subscription(app_id, subscription_id) @@ -1274,6 +1409,15 @@ from onesignal.model.rate_limit_error import RateLimitError from onesignal.model.generic_error import GenericError from pprint import pprint +# See configuration.py for a list of all supported configuration parameters. +# Some of the OneSignal endpoints require ORGANIZATION_API_KEY token for authorization, while others require REST_API_KEY. +# We recommend adding both of them in the configuration page so that you will not need to figure it out yourself. +configuration = onesignal.Configuration( + rest_api_key = "YOUR_REST_API_KEY", # App REST API key required for most endpoints + organization_api_key = "YOUR_ORGANIZATION_KEY" # Organization key is only required for creating new apps and other top-level endpoints +) + + # Enter a context with an instance of the API client with onesignal.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -1302,7 +1446,7 @@ void (empty response body) ### Authorization -[rest_api_key](../README.md#rest_api_key) +[rest_api_key](https://github.com/OneSignal/onesignal-python-api#configuration) ### HTTP request headers @@ -1320,7 +1464,7 @@ void (empty response body) **409** | Conflict | - | **429** | Rate Limit Exceeded | - | -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) [[Back to API list]](https://github.com/OneSignal/onesignal-python-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-python-api) # **delete_template** > GenericSuccessBoolResponse delete_template(template_id, app_id) @@ -1340,6 +1484,15 @@ from onesignal.model.generic_error import GenericError from onesignal.model.generic_success_bool_response import GenericSuccessBoolResponse from pprint import pprint +# See configuration.py for a list of all supported configuration parameters. +# Some of the OneSignal endpoints require ORGANIZATION_API_KEY token for authorization, while others require REST_API_KEY. +# We recommend adding both of them in the configuration page so that you will not need to figure it out yourself. +configuration = onesignal.Configuration( + rest_api_key = "YOUR_REST_API_KEY", # App REST API key required for most endpoints + organization_api_key = "YOUR_ORGANIZATION_KEY" # Organization key is only required for creating new apps and other top-level endpoints +) + + # Enter a context with an instance of the API client with onesignal.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -1370,7 +1523,7 @@ Name | Type | Description | Notes ### Authorization -[rest_api_key](../README.md#rest_api_key) +[rest_api_key](https://github.com/OneSignal/onesignal-python-api#configuration) ### HTTP request headers @@ -1386,7 +1539,7 @@ Name | Type | Description | Notes **400** | Bad Request | - | **404** | Not Found | - | -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) [[Back to API list]](https://github.com/OneSignal/onesignal-python-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-python-api) # **delete_user** > delete_user(app_id, alias_label, alias_id) @@ -1406,6 +1559,15 @@ from onesignal.model.rate_limit_error import RateLimitError from onesignal.model.generic_error import GenericError from pprint import pprint +# See configuration.py for a list of all supported configuration parameters. +# Some of the OneSignal endpoints require ORGANIZATION_API_KEY token for authorization, while others require REST_API_KEY. +# We recommend adding both of them in the configuration page so that you will not need to figure it out yourself. +configuration = onesignal.Configuration( + rest_api_key = "YOUR_REST_API_KEY", # App REST API key required for most endpoints + organization_api_key = "YOUR_ORGANIZATION_KEY" # Organization key is only required for creating new apps and other top-level endpoints +) + + # Enter a context with an instance of the API client with onesignal.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -1436,7 +1598,7 @@ void (empty response body) ### Authorization -[rest_api_key](../README.md#rest_api_key) +[rest_api_key](https://github.com/OneSignal/onesignal-python-api#configuration) ### HTTP request headers @@ -1453,7 +1615,7 @@ void (empty response body) **409** | Conflict | - | **429** | Rate Limit Exceeded | - | -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) [[Back to API list]](https://github.com/OneSignal/onesignal-python-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-python-api) # **export_events** > ExportEventsSuccessResponse export_events(notification_id, app_id) @@ -1474,6 +1636,15 @@ from onesignal.model.rate_limit_error import RateLimitError from onesignal.model.generic_error import GenericError from pprint import pprint +# See configuration.py for a list of all supported configuration parameters. +# Some of the OneSignal endpoints require ORGANIZATION_API_KEY token for authorization, while others require REST_API_KEY. +# We recommend adding both of them in the configuration page so that you will not need to figure it out yourself. +configuration = onesignal.Configuration( + rest_api_key = "YOUR_REST_API_KEY", # App REST API key required for most endpoints + organization_api_key = "YOUR_ORGANIZATION_KEY" # Organization key is only required for creating new apps and other top-level endpoints +) + + # Enter a context with an instance of the API client with onesignal.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -1504,7 +1675,7 @@ Name | Type | Description | Notes ### Authorization -[rest_api_key](../README.md#rest_api_key) +[rest_api_key](https://github.com/OneSignal/onesignal-python-api#configuration) ### HTTP request headers @@ -1521,7 +1692,7 @@ Name | Type | Description | Notes **404** | Not Found | - | **429** | Rate Limit Exceeded | - | -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) [[Back to API list]](https://github.com/OneSignal/onesignal-python-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-python-api) # **export_subscriptions** > ExportSubscriptionsSuccessResponse export_subscriptions(app_id) @@ -1543,6 +1714,15 @@ from onesignal.model.rate_limit_error import RateLimitError from onesignal.model.generic_error import GenericError from pprint import pprint +# See configuration.py for a list of all supported configuration parameters. +# Some of the OneSignal endpoints require ORGANIZATION_API_KEY token for authorization, while others require REST_API_KEY. +# We recommend adding both of them in the configuration page so that you will not need to figure it out yourself. +configuration = onesignal.Configuration( + rest_api_key = "YOUR_REST_API_KEY", # App REST API key required for most endpoints + organization_api_key = "YOUR_ORGANIZATION_KEY" # Organization key is only required for creating new apps and other top-level endpoints +) + + # Enter a context with an instance of the API client with onesignal.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -1588,7 +1768,7 @@ Name | Type | Description | Notes ### Authorization -[rest_api_key](../README.md#rest_api_key) +[rest_api_key](https://github.com/OneSignal/onesignal-python-api#configuration) ### HTTP request headers @@ -1604,7 +1784,7 @@ Name | Type | Description | Notes **400** | Bad Request | - | **429** | Rate Limit Exceeded | - | -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) [[Back to API list]](https://github.com/OneSignal/onesignal-python-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-python-api) # **get_aliases** > UserIdentityBody get_aliases(app_id, alias_label, alias_id) @@ -1625,6 +1805,15 @@ from onesignal.model.generic_error import GenericError from onesignal.model.user_identity_body import UserIdentityBody from pprint import pprint +# See configuration.py for a list of all supported configuration parameters. +# Some of the OneSignal endpoints require ORGANIZATION_API_KEY token for authorization, while others require REST_API_KEY. +# We recommend adding both of them in the configuration page so that you will not need to figure it out yourself. +configuration = onesignal.Configuration( + rest_api_key = "YOUR_REST_API_KEY", # App REST API key required for most endpoints + organization_api_key = "YOUR_ORGANIZATION_KEY" # Organization key is only required for creating new apps and other top-level endpoints +) + + # Enter a context with an instance of the API client with onesignal.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -1656,7 +1845,7 @@ Name | Type | Description | Notes ### Authorization -[rest_api_key](../README.md#rest_api_key) +[rest_api_key](https://github.com/OneSignal/onesignal-python-api#configuration) ### HTTP request headers @@ -1673,7 +1862,7 @@ Name | Type | Description | Notes **404** | Not Found | - | **429** | Rate Limit Exceeded | - | -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) [[Back to API list]](https://github.com/OneSignal/onesignal-python-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-python-api) # **get_aliases_by_subscription** > UserIdentityBody get_aliases_by_subscription(app_id, subscription_id) @@ -1693,6 +1882,15 @@ from onesignal.model.generic_error import GenericError from onesignal.model.user_identity_body import UserIdentityBody from pprint import pprint +# See configuration.py for a list of all supported configuration parameters. +# Some of the OneSignal endpoints require ORGANIZATION_API_KEY token for authorization, while others require REST_API_KEY. +# We recommend adding both of them in the configuration page so that you will not need to figure it out yourself. +configuration = onesignal.Configuration( + rest_api_key = "YOUR_REST_API_KEY", # App REST API key required for most endpoints + organization_api_key = "YOUR_ORGANIZATION_KEY" # Organization key is only required for creating new apps and other top-level endpoints +) + + # Enter a context with an instance of the API client with onesignal.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -1722,7 +1920,7 @@ Name | Type | Description | Notes ### Authorization -[rest_api_key](../README.md#rest_api_key) +[rest_api_key](https://github.com/OneSignal/onesignal-python-api#configuration) ### HTTP request headers @@ -1738,7 +1936,7 @@ Name | Type | Description | Notes **400** | Bad Request | - | **404** | Not Found | - | -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) [[Back to API list]](https://github.com/OneSignal/onesignal-python-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-python-api) # **get_app** > App get_app(app_id) @@ -1759,6 +1957,15 @@ from onesignal.model.rate_limit_error import RateLimitError from onesignal.model.generic_error import GenericError from pprint import pprint +# See configuration.py for a list of all supported configuration parameters. +# Some of the OneSignal endpoints require ORGANIZATION_API_KEY token for authorization, while others require REST_API_KEY. +# We recommend adding both of them in the configuration page so that you will not need to figure it out yourself. +configuration = onesignal.Configuration( + rest_api_key = "YOUR_REST_API_KEY", # App REST API key required for most endpoints + organization_api_key = "YOUR_ORGANIZATION_KEY" # Organization key is only required for creating new apps and other top-level endpoints +) + + # Enter a context with an instance of the API client with onesignal.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -1787,7 +1994,7 @@ Name | Type | Description | Notes ### Authorization -[organization_api_key](../README.md#organization_api_key) +[organization_api_key](https://github.com/OneSignal/onesignal-python-api#configuration) ### HTTP request headers @@ -1803,7 +2010,7 @@ Name | Type | Description | Notes **400** | Bad Request | - | **429** | Rate Limit Exceeded | - | -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) [[Back to API list]](https://github.com/OneSignal/onesignal-python-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-python-api) # **get_apps** > Apps get_apps() @@ -1824,6 +2031,15 @@ from onesignal.model.rate_limit_error import RateLimitError from onesignal.model.generic_error import GenericError from pprint import pprint +# See configuration.py for a list of all supported configuration parameters. +# Some of the OneSignal endpoints require ORGANIZATION_API_KEY token for authorization, while others require REST_API_KEY. +# We recommend adding both of them in the configuration page so that you will not need to figure it out yourself. +configuration = onesignal.Configuration( + rest_api_key = "YOUR_REST_API_KEY", # App REST API key required for most endpoints + organization_api_key = "YOUR_ORGANIZATION_KEY" # Organization key is only required for creating new apps and other top-level endpoints +) + + # Enter a context with an instance of the API client with onesignal.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -1848,7 +2064,7 @@ This endpoint does not need any parameter. ### Authorization -[organization_api_key](../README.md#organization_api_key) +[organization_api_key](https://github.com/OneSignal/onesignal-python-api#configuration) ### HTTP request headers @@ -1864,7 +2080,7 @@ This endpoint does not need any parameter. **400** | Bad Request | - | **429** | Rate Limit Exceeded | - | -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) [[Back to API list]](https://github.com/OneSignal/onesignal-python-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-python-api) # **get_notification** > NotificationWithMeta get_notification(app_id, notification_id) @@ -1885,6 +2101,15 @@ from onesignal.model.generic_error import GenericError from onesignal.model.notification_with_meta import NotificationWithMeta from pprint import pprint +# See configuration.py for a list of all supported configuration parameters. +# Some of the OneSignal endpoints require ORGANIZATION_API_KEY token for authorization, while others require REST_API_KEY. +# We recommend adding both of them in the configuration page so that you will not need to figure it out yourself. +configuration = onesignal.Configuration( + rest_api_key = "YOUR_REST_API_KEY", # App REST API key required for most endpoints + organization_api_key = "YOUR_ORGANIZATION_KEY" # Organization key is only required for creating new apps and other top-level endpoints +) + + # Enter a context with an instance of the API client with onesignal.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -1915,7 +2140,7 @@ Name | Type | Description | Notes ### Authorization -[rest_api_key](../README.md#rest_api_key) +[rest_api_key](https://github.com/OneSignal/onesignal-python-api#configuration) ### HTTP request headers @@ -1932,7 +2157,7 @@ Name | Type | Description | Notes **404** | Not Found | - | **429** | Rate Limit Exceeded | - | -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) [[Back to API list]](https://github.com/OneSignal/onesignal-python-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-python-api) # **get_notification_history** > NotificationHistorySuccessResponse get_notification_history(notification_id, get_notification_history_request_body) @@ -1954,6 +2179,15 @@ from onesignal.model.generic_error import GenericError from onesignal.model.get_notification_history_request_body import GetNotificationHistoryRequestBody from pprint import pprint +# See configuration.py for a list of all supported configuration parameters. +# Some of the OneSignal endpoints require ORGANIZATION_API_KEY token for authorization, while others require REST_API_KEY. +# We recommend adding both of them in the configuration page so that you will not need to figure it out yourself. +configuration = onesignal.Configuration( + rest_api_key = "YOUR_REST_API_KEY", # App REST API key required for most endpoints + organization_api_key = "YOUR_ORGANIZATION_KEY" # Organization key is only required for creating new apps and other top-level endpoints +) + + # Enter a context with an instance of the API client with onesignal.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -1988,7 +2222,7 @@ Name | Type | Description | Notes ### Authorization -[rest_api_key](../README.md#rest_api_key) +[rest_api_key](https://github.com/OneSignal/onesignal-python-api#configuration) ### HTTP request headers @@ -2005,7 +2239,7 @@ Name | Type | Description | Notes **404** | Not Found | - | **429** | Rate Limit Exceeded | - | -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) [[Back to API list]](https://github.com/OneSignal/onesignal-python-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-python-api) # **get_notifications** > NotificationSlice get_notifications(app_id) @@ -2026,6 +2260,15 @@ from onesignal.model.rate_limit_error import RateLimitError from onesignal.model.generic_error import GenericError from pprint import pprint +# See configuration.py for a list of all supported configuration parameters. +# Some of the OneSignal endpoints require ORGANIZATION_API_KEY token for authorization, while others require REST_API_KEY. +# We recommend adding both of them in the configuration page so that you will not need to figure it out yourself. +configuration = onesignal.Configuration( + rest_api_key = "YOUR_REST_API_KEY", # App REST API key required for most endpoints + organization_api_key = "YOUR_ORGANIZATION_KEY" # Organization key is only required for creating new apps and other top-level endpoints +) + + # Enter a context with an instance of the API client with onesignal.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -2069,7 +2312,7 @@ Name | Type | Description | Notes ### Authorization -[rest_api_key](../README.md#rest_api_key) +[rest_api_key](https://github.com/OneSignal/onesignal-python-api#configuration) ### HTTP request headers @@ -2085,7 +2328,7 @@ Name | Type | Description | Notes **400** | Bad Request | - | **429** | Rate Limit Exceeded | - | -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) [[Back to API list]](https://github.com/OneSignal/onesignal-python-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-python-api) # **get_outcomes** > OutcomesData get_outcomes(app_id, outcome_names) @@ -2106,6 +2349,15 @@ from onesignal.model.rate_limit_error import RateLimitError from onesignal.model.generic_error import GenericError from pprint import pprint +# See configuration.py for a list of all supported configuration parameters. +# Some of the OneSignal endpoints require ORGANIZATION_API_KEY token for authorization, while others require REST_API_KEY. +# We recommend adding both of them in the configuration page so that you will not need to figure it out yourself. +configuration = onesignal.Configuration( + rest_api_key = "YOUR_REST_API_KEY", # App REST API key required for most endpoints + organization_api_key = "YOUR_ORGANIZATION_KEY" # Organization key is only required for creating new apps and other top-level endpoints +) + + # Enter a context with an instance of the API client with onesignal.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -2153,7 +2405,7 @@ Name | Type | Description | Notes ### Authorization -[rest_api_key](../README.md#rest_api_key) +[rest_api_key](https://github.com/OneSignal/onesignal-python-api#configuration) ### HTTP request headers @@ -2169,7 +2421,7 @@ Name | Type | Description | Notes **400** | Bad Request | - | **429** | Rate Limit Exceeded | - | -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) [[Back to API list]](https://github.com/OneSignal/onesignal-python-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-python-api) # **get_segments** > GetSegmentsSuccessResponse get_segments(app_id) @@ -2190,6 +2442,15 @@ from onesignal.model.rate_limit_error import RateLimitError from onesignal.model.generic_error import GenericError from pprint import pprint +# See configuration.py for a list of all supported configuration parameters. +# Some of the OneSignal endpoints require ORGANIZATION_API_KEY token for authorization, while others require REST_API_KEY. +# We recommend adding both of them in the configuration page so that you will not need to figure it out yourself. +configuration = onesignal.Configuration( + rest_api_key = "YOUR_REST_API_KEY", # App REST API key required for most endpoints + organization_api_key = "YOUR_ORGANIZATION_KEY" # Organization key is only required for creating new apps and other top-level endpoints +) + + # Enter a context with an instance of the API client with onesignal.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -2231,7 +2492,7 @@ Name | Type | Description | Notes ### Authorization -[rest_api_key](../README.md#rest_api_key) +[rest_api_key](https://github.com/OneSignal/onesignal-python-api#configuration) ### HTTP request headers @@ -2247,7 +2508,7 @@ Name | Type | Description | Notes **400** | Bad Request | - | **429** | Rate Limit Exceeded | - | -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) [[Back to API list]](https://github.com/OneSignal/onesignal-python-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-python-api) # **get_user** > User get_user(app_id, alias_label, alias_id) @@ -2268,6 +2529,15 @@ from onesignal.model.rate_limit_error import RateLimitError from onesignal.model.generic_error import GenericError from pprint import pprint +# See configuration.py for a list of all supported configuration parameters. +# Some of the OneSignal endpoints require ORGANIZATION_API_KEY token for authorization, while others require REST_API_KEY. +# We recommend adding both of them in the configuration page so that you will not need to figure it out yourself. +configuration = onesignal.Configuration( + rest_api_key = "YOUR_REST_API_KEY", # App REST API key required for most endpoints + organization_api_key = "YOUR_ORGANIZATION_KEY" # Organization key is only required for creating new apps and other top-level endpoints +) + + # Enter a context with an instance of the API client with onesignal.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -2299,7 +2569,7 @@ Name | Type | Description | Notes ### Authorization -[rest_api_key](../README.md#rest_api_key) +[rest_api_key](https://github.com/OneSignal/onesignal-python-api#configuration) ### HTTP request headers @@ -2316,7 +2586,7 @@ Name | Type | Description | Notes **404** | Not Found | - | **429** | Rate Limit Exceeded | - | -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) [[Back to API list]](https://github.com/OneSignal/onesignal-python-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-python-api) # **rotate_api_key** > CreateApiKeyResponse rotate_api_key(app_id, token_id) @@ -2336,6 +2606,15 @@ from onesignal.model.create_api_key_response import CreateApiKeyResponse from onesignal.model.generic_error import GenericError from pprint import pprint +# See configuration.py for a list of all supported configuration parameters. +# Some of the OneSignal endpoints require ORGANIZATION_API_KEY token for authorization, while others require REST_API_KEY. +# We recommend adding both of them in the configuration page so that you will not need to figure it out yourself. +configuration = onesignal.Configuration( + rest_api_key = "YOUR_REST_API_KEY", # App REST API key required for most endpoints + organization_api_key = "YOUR_ORGANIZATION_KEY" # Organization key is only required for creating new apps and other top-level endpoints +) + + # Enter a context with an instance of the API client with onesignal.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -2366,7 +2645,7 @@ Name | Type | Description | Notes ### Authorization -[organization_api_key](../README.md#organization_api_key) +[organization_api_key](https://github.com/OneSignal/onesignal-python-api#configuration) ### HTTP request headers @@ -2381,7 +2660,7 @@ Name | Type | Description | Notes **200** | OK | - | **400** | Bad Request | - | -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) [[Back to API list]](https://github.com/OneSignal/onesignal-python-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-python-api) # **start_live_activity** > StartLiveActivitySuccessResponse start_live_activity(app_id, activity_type, start_live_activity_request) @@ -2403,6 +2682,15 @@ from onesignal.model.generic_error import GenericError from onesignal.model.start_live_activity_request import StartLiveActivityRequest from pprint import pprint +# See configuration.py for a list of all supported configuration parameters. +# Some of the OneSignal endpoints require ORGANIZATION_API_KEY token for authorization, while others require REST_API_KEY. +# We recommend adding both of them in the configuration page so that you will not need to figure it out yourself. +configuration = onesignal.Configuration( + rest_api_key = "YOUR_REST_API_KEY", # App REST API key required for most endpoints + organization_api_key = "YOUR_ORGANIZATION_KEY" # Organization key is only required for creating new apps and other top-level endpoints +) + + # Enter a context with an instance of the API client with onesignal.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -2552,7 +2840,7 @@ Name | Type | Description | Notes ### Authorization -[rest_api_key](../README.md#rest_api_key) +[rest_api_key](https://github.com/OneSignal/onesignal-python-api#configuration) ### HTTP request headers @@ -2568,7 +2856,7 @@ Name | Type | Description | Notes **400** | Bad Request | - | **429** | Rate Limit Exceeded | - | -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) [[Back to API list]](https://github.com/OneSignal/onesignal-python-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-python-api) # **transfer_subscription** > UserIdentityBody transfer_subscription(app_id, subscription_id, transfer_subscription_request_body) @@ -2590,6 +2878,15 @@ from onesignal.model.generic_error import GenericError from onesignal.model.user_identity_body import UserIdentityBody from pprint import pprint +# See configuration.py for a list of all supported configuration parameters. +# Some of the OneSignal endpoints require ORGANIZATION_API_KEY token for authorization, while others require REST_API_KEY. +# We recommend adding both of them in the configuration page so that you will not need to figure it out yourself. +configuration = onesignal.Configuration( + rest_api_key = "YOUR_REST_API_KEY", # App REST API key required for most endpoints + organization_api_key = "YOUR_ORGANIZATION_KEY" # Organization key is only required for creating new apps and other top-level endpoints +) + + # Enter a context with an instance of the API client with onesignal.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -2625,7 +2922,7 @@ Name | Type | Description | Notes ### Authorization -[rest_api_key](../README.md#rest_api_key) +[rest_api_key](https://github.com/OneSignal/onesignal-python-api#configuration) ### HTTP request headers @@ -2643,7 +2940,7 @@ Name | Type | Description | Notes **409** | Conflict | - | **429** | Rate Limit Exceeded | - | -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) [[Back to API list]](https://github.com/OneSignal/onesignal-python-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-python-api) # **unsubscribe_email_with_token** > GenericSuccessBoolResponse unsubscribe_email_with_token(app_id, notification_id, token) @@ -2664,6 +2961,15 @@ from onesignal.model.generic_error import GenericError from onesignal.model.generic_success_bool_response import GenericSuccessBoolResponse from pprint import pprint +# See configuration.py for a list of all supported configuration parameters. +# Some of the OneSignal endpoints require ORGANIZATION_API_KEY token for authorization, while others require REST_API_KEY. +# We recommend adding both of them in the configuration page so that you will not need to figure it out yourself. +configuration = onesignal.Configuration( + rest_api_key = "YOUR_REST_API_KEY", # App REST API key required for most endpoints + organization_api_key = "YOUR_ORGANIZATION_KEY" # Organization key is only required for creating new apps and other top-level endpoints +) + + # Enter a context with an instance of the API client with onesignal.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -2696,7 +3002,7 @@ Name | Type | Description | Notes ### Authorization -[rest_api_key](../README.md#rest_api_key) +[rest_api_key](https://github.com/OneSignal/onesignal-python-api#configuration) ### HTTP request headers @@ -2712,7 +3018,7 @@ Name | Type | Description | Notes **400** | Bad Request | - | **429** | Rate Limit Exceeded | - | -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) [[Back to API list]](https://github.com/OneSignal/onesignal-python-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-python-api) # **update_api_key** > {str: (bool, date, datetime, dict, float, int, list, str, none_type)} update_api_key(app_id, token_id, update_api_key_request) @@ -2732,6 +3038,15 @@ from onesignal.model.update_api_key_request import UpdateApiKeyRequest from onesignal.model.generic_error import GenericError from pprint import pprint +# See configuration.py for a list of all supported configuration parameters. +# Some of the OneSignal endpoints require ORGANIZATION_API_KEY token for authorization, while others require REST_API_KEY. +# We recommend adding both of them in the configuration page so that you will not need to figure it out yourself. +configuration = onesignal.Configuration( + rest_api_key = "YOUR_REST_API_KEY", # App REST API key required for most endpoints + organization_api_key = "YOUR_ORGANIZATION_KEY" # Organization key is only required for creating new apps and other top-level endpoints +) + + # Enter a context with an instance of the API client with onesignal.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -2770,7 +3085,7 @@ Name | Type | Description | Notes ### Authorization -[organization_api_key](../README.md#organization_api_key) +[organization_api_key](https://github.com/OneSignal/onesignal-python-api#configuration) ### HTTP request headers @@ -2785,7 +3100,7 @@ Name | Type | Description | Notes **200** | OK | - | **400** | Bad Request | - | -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) [[Back to API list]](https://github.com/OneSignal/onesignal-python-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-python-api) # **update_app** > App update_app(app_id, app) @@ -2806,6 +3121,15 @@ from onesignal.model.rate_limit_error import RateLimitError from onesignal.model.generic_error import GenericError from pprint import pprint +# See configuration.py for a list of all supported configuration parameters. +# Some of the OneSignal endpoints require ORGANIZATION_API_KEY token for authorization, while others require REST_API_KEY. +# We recommend adding both of them in the configuration page so that you will not need to figure it out yourself. +configuration = onesignal.Configuration( + rest_api_key = "YOUR_REST_API_KEY", # App REST API key required for most endpoints + organization_api_key = "YOUR_ORGANIZATION_KEY" # Organization key is only required for creating new apps and other top-level endpoints +) + + # Enter a context with an instance of the API client with onesignal.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -2858,7 +3182,7 @@ Name | Type | Description | Notes ### Authorization -[organization_api_key](../README.md#organization_api_key) +[organization_api_key](https://github.com/OneSignal/onesignal-python-api#configuration) ### HTTP request headers @@ -2874,7 +3198,7 @@ Name | Type | Description | Notes **400** | Bad Request | - | **429** | Rate Limit Exceeded | - | -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) [[Back to API list]](https://github.com/OneSignal/onesignal-python-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-python-api) # **update_live_activity** > UpdateLiveActivitySuccessResponse update_live_activity(app_id, activity_id, update_live_activity_request) @@ -2896,6 +3220,15 @@ from onesignal.model.rate_limit_error import RateLimitError from onesignal.model.generic_error import GenericError from pprint import pprint +# See configuration.py for a list of all supported configuration parameters. +# Some of the OneSignal endpoints require ORGANIZATION_API_KEY token for authorization, while others require REST_API_KEY. +# We recommend adding both of them in the configuration page so that you will not need to figure it out yourself. +configuration = onesignal.Configuration( + rest_api_key = "YOUR_REST_API_KEY", # App REST API key required for most endpoints + organization_api_key = "YOUR_ORGANIZATION_KEY" # Organization key is only required for creating new apps and other top-level endpoints +) + + # Enter a context with an instance of the API client with onesignal.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -3026,7 +3359,7 @@ Name | Type | Description | Notes ### Authorization -[rest_api_key](../README.md#rest_api_key) +[rest_api_key](https://github.com/OneSignal/onesignal-python-api#configuration) ### HTTP request headers @@ -3042,7 +3375,7 @@ Name | Type | Description | Notes **400** | Bad Request | - | **429** | Rate Limit Exceeded | - | -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) [[Back to API list]](https://github.com/OneSignal/onesignal-python-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-python-api) # **update_subscription** > update_subscription(app_id, subscription_id, subscription_body) @@ -3063,6 +3396,15 @@ from onesignal.model.generic_error import GenericError from onesignal.model.subscription_body import SubscriptionBody from pprint import pprint +# See configuration.py for a list of all supported configuration parameters. +# Some of the OneSignal endpoints require ORGANIZATION_API_KEY token for authorization, while others require REST_API_KEY. +# We recommend adding both of them in the configuration page so that you will not need to figure it out yourself. +configuration = onesignal.Configuration( + rest_api_key = "YOUR_REST_API_KEY", # App REST API key required for most endpoints + organization_api_key = "YOUR_ORGANIZATION_KEY" # Organization key is only required for creating new apps and other top-level endpoints +) + + # Enter a context with an instance of the API client with onesignal.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -3113,7 +3455,7 @@ void (empty response body) ### Authorization -[rest_api_key](../README.md#rest_api_key) +[rest_api_key](https://github.com/OneSignal/onesignal-python-api#configuration) ### HTTP request headers @@ -3131,7 +3473,7 @@ void (empty response body) **409** | Conflict | - | **429** | Rate Limit Exceeded | - | -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) [[Back to API list]](https://github.com/OneSignal/onesignal-python-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-python-api) # **update_subscription_by_token** > {str: (bool, date, datetime, dict, float, int, list, str, none_type)} update_subscription_by_token(app_id, token_type, token, subscription_body) @@ -3151,6 +3493,15 @@ from onesignal.model.generic_error import GenericError from onesignal.model.subscription_body import SubscriptionBody from pprint import pprint +# See configuration.py for a list of all supported configuration parameters. +# Some of the OneSignal endpoints require ORGANIZATION_API_KEY token for authorization, while others require REST_API_KEY. +# We recommend adding both of them in the configuration page so that you will not need to figure it out yourself. +configuration = onesignal.Configuration( + rest_api_key = "YOUR_REST_API_KEY", # App REST API key required for most endpoints + organization_api_key = "YOUR_ORGANIZATION_KEY" # Organization key is only required for creating new apps and other top-level endpoints +) + + # Enter a context with an instance of the API client with onesignal.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -3205,7 +3556,7 @@ Name | Type | Description | Notes ### Authorization -[rest_api_key](../README.md#rest_api_key) +[rest_api_key](https://github.com/OneSignal/onesignal-python-api#configuration) ### HTTP request headers @@ -3221,7 +3572,7 @@ Name | Type | Description | Notes **400** | Bad Request | - | **404** | Not Found | - | -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) [[Back to API list]](https://github.com/OneSignal/onesignal-python-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-python-api) # **update_template** > TemplateResource update_template(template_id, app_id, update_template_request) @@ -3242,6 +3593,15 @@ from onesignal.model.template_resource import TemplateResource from onesignal.model.generic_error import GenericError from pprint import pprint +# See configuration.py for a list of all supported configuration parameters. +# Some of the OneSignal endpoints require ORGANIZATION_API_KEY token for authorization, while others require REST_API_KEY. +# We recommend adding both of them in the configuration page so that you will not need to figure it out yourself. +configuration = onesignal.Configuration( + rest_api_key = "YOUR_REST_API_KEY", # App REST API key required for most endpoints + organization_api_key = "YOUR_ORGANIZATION_KEY" # Organization key is only required for creating new apps and other top-level endpoints +) + + # Enter a context with an instance of the API client with onesignal.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -3326,7 +3686,7 @@ Name | Type | Description | Notes ### Authorization -[rest_api_key](../README.md#rest_api_key) +[rest_api_key](https://github.com/OneSignal/onesignal-python-api#configuration) ### HTTP request headers @@ -3341,7 +3701,7 @@ Name | Type | Description | Notes **200** | OK | - | **400** | Bad Request | - | -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) [[Back to API list]](https://github.com/OneSignal/onesignal-python-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-python-api) # **update_user** > PropertiesBody update_user(app_id, alias_label, alias_id, update_user_request) @@ -3363,6 +3723,15 @@ from onesignal.model.rate_limit_error import RateLimitError from onesignal.model.generic_error import GenericError from pprint import pprint +# See configuration.py for a list of all supported configuration parameters. +# Some of the OneSignal endpoints require ORGANIZATION_API_KEY token for authorization, while others require REST_API_KEY. +# We recommend adding both of them in the configuration page so that you will not need to figure it out yourself. +configuration = onesignal.Configuration( + rest_api_key = "YOUR_REST_API_KEY", # App REST API key required for most endpoints + organization_api_key = "YOUR_ORGANIZATION_KEY" # Organization key is only required for creating new apps and other top-level endpoints +) + + # Enter a context with an instance of the API client with onesignal.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -3430,7 +3799,7 @@ Name | Type | Description | Notes ### Authorization -[rest_api_key](../README.md#rest_api_key) +[rest_api_key](https://github.com/OneSignal/onesignal-python-api#configuration) ### HTTP request headers @@ -3447,7 +3816,7 @@ Name | Type | Description | Notes **409** | Conflict | - | **429** | Rate Limit Exceeded | - | -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) [[Back to API list]](https://github.com/OneSignal/onesignal-python-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-python-api) # **view_api_keys** > ApiKeyTokensListResponse view_api_keys(app_id) @@ -3467,6 +3836,15 @@ from onesignal.model.api_key_tokens_list_response import ApiKeyTokensListRespons from onesignal.model.generic_error import GenericError from pprint import pprint +# See configuration.py for a list of all supported configuration parameters. +# Some of the OneSignal endpoints require ORGANIZATION_API_KEY token for authorization, while others require REST_API_KEY. +# We recommend adding both of them in the configuration page so that you will not need to figure it out yourself. +configuration = onesignal.Configuration( + rest_api_key = "YOUR_REST_API_KEY", # App REST API key required for most endpoints + organization_api_key = "YOUR_ORGANIZATION_KEY" # Organization key is only required for creating new apps and other top-level endpoints +) + + # Enter a context with an instance of the API client with onesignal.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -3495,7 +3873,7 @@ Name | Type | Description | Notes ### Authorization -[organization_api_key](../README.md#organization_api_key) +[organization_api_key](https://github.com/OneSignal/onesignal-python-api#configuration) ### HTTP request headers @@ -3510,7 +3888,7 @@ Name | Type | Description | Notes **200** | OK | - | **400** | Bad Request | - | -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) [[Back to API list]](https://github.com/OneSignal/onesignal-python-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-python-api) # **view_template** > TemplateResource view_template(template_id, app_id) @@ -3530,6 +3908,15 @@ from onesignal.model.template_resource import TemplateResource from onesignal.model.generic_error import GenericError from pprint import pprint +# See configuration.py for a list of all supported configuration parameters. +# Some of the OneSignal endpoints require ORGANIZATION_API_KEY token for authorization, while others require REST_API_KEY. +# We recommend adding both of them in the configuration page so that you will not need to figure it out yourself. +configuration = onesignal.Configuration( + rest_api_key = "YOUR_REST_API_KEY", # App REST API key required for most endpoints + organization_api_key = "YOUR_ORGANIZATION_KEY" # Organization key is only required for creating new apps and other top-level endpoints +) + + # Enter a context with an instance of the API client with onesignal.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -3560,7 +3947,7 @@ Name | Type | Description | Notes ### Authorization -[rest_api_key](../README.md#rest_api_key) +[rest_api_key](https://github.com/OneSignal/onesignal-python-api#configuration) ### HTTP request headers @@ -3576,7 +3963,7 @@ Name | Type | Description | Notes **400** | Bad Request | - | **404** | Not Found | - | -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) [[Back to API list]](https://github.com/OneSignal/onesignal-python-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-python-api) # **view_templates** > TemplatesListResponse view_templates(app_id) @@ -3597,6 +3984,15 @@ from onesignal.model.rate_limit_error import RateLimitError from onesignal.model.generic_error import GenericError from pprint import pprint +# See configuration.py for a list of all supported configuration parameters. +# Some of the OneSignal endpoints require ORGANIZATION_API_KEY token for authorization, while others require REST_API_KEY. +# We recommend adding both of them in the configuration page so that you will not need to figure it out yourself. +configuration = onesignal.Configuration( + rest_api_key = "YOUR_REST_API_KEY", # App REST API key required for most endpoints + organization_api_key = "YOUR_ORGANIZATION_KEY" # Organization key is only required for creating new apps and other top-level endpoints +) + + # Enter a context with an instance of the API client with onesignal.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -3640,7 +4036,7 @@ Name | Type | Description | Notes ### Authorization -[rest_api_key](../README.md#rest_api_key) +[rest_api_key](https://github.com/OneSignal/onesignal-python-api#configuration) ### HTTP request headers @@ -3656,5 +4052,5 @@ Name | Type | Description | Notes **400** | Bad Request | - | **429** | Rate Limit Exceeded | - | -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) [[Back to API list]](https://github.com/OneSignal/onesignal-python-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-python-api) diff --git a/docs/DeliveryData.md b/docs/DeliveryData.md index 3010f8f..031f9dd 100644 --- a/docs/DeliveryData.md +++ b/docs/DeliveryData.md @@ -11,6 +11,6 @@ Name | Type | Description | Notes **received** | **int, none_type** | Number of devices that received the message. | [optional] **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-python-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-python-api) diff --git a/docs/ExportEventsSuccessResponse.md b/docs/ExportEventsSuccessResponse.md index cf0bc56..fe22e40 100644 --- a/docs/ExportEventsSuccessResponse.md +++ b/docs/ExportEventsSuccessResponse.md @@ -7,6 +7,6 @@ Name | Type | Description | Notes **csv_file_url** | **str** | | [optional] **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-python-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-python-api) diff --git a/docs/ExportSubscriptionsRequestBody.md b/docs/ExportSubscriptionsRequestBody.md index 5cdec25..d6f1cd5 100644 --- a/docs/ExportSubscriptionsRequestBody.md +++ b/docs/ExportSubscriptionsRequestBody.md @@ -9,6 +9,6 @@ Name | Type | Description | Notes **segment_name** | **str** | Export all devices belonging to the segment. | [optional] **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-python-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-python-api) diff --git a/docs/ExportSubscriptionsSuccessResponse.md b/docs/ExportSubscriptionsSuccessResponse.md index 3ff93a4..21738de 100644 --- a/docs/ExportSubscriptionsSuccessResponse.md +++ b/docs/ExportSubscriptionsSuccessResponse.md @@ -7,6 +7,6 @@ Name | Type | Description | Notes **csv_file_url** | **str** | | [optional] **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-python-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-python-api) diff --git a/docs/Filter.md b/docs/Filter.md index fe69e3a..09e3a50 100644 --- a/docs/Filter.md +++ b/docs/Filter.md @@ -14,6 +14,6 @@ Name | Type | Description | Notes **relation** | **str** | Required. Operator of a filter expression. | [optional] **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-python-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-python-api) diff --git a/docs/FilterExpression.md b/docs/FilterExpression.md index d8c9202..080a0c0 100644 --- a/docs/FilterExpression.md +++ b/docs/FilterExpression.md @@ -15,6 +15,6 @@ Name | Type | Description | Notes **operator** | **str** | Strictly, this must be either `\"OR\"`, or `\"AND\"`. It can be used to compose Filters as part of a Filters object. | [optional] **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-python-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-python-api) diff --git a/docs/GenericError.md b/docs/GenericError.md index 3c9b82a..fdc2322 100644 --- a/docs/GenericError.md +++ b/docs/GenericError.md @@ -9,6 +9,6 @@ Name | Type | Description | Notes **reference** | **bool, date, datetime, dict, float, int, list, str, none_type** | | [optional] **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-python-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-python-api) diff --git a/docs/GenericSuccessBoolResponse.md b/docs/GenericSuccessBoolResponse.md index c2a4f97..ab52ee2 100644 --- a/docs/GenericSuccessBoolResponse.md +++ b/docs/GenericSuccessBoolResponse.md @@ -7,6 +7,6 @@ Name | Type | Description | Notes **success** | **bool** | | [optional] **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-python-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-python-api) diff --git a/docs/GetNotificationHistoryRequestBody.md b/docs/GetNotificationHistoryRequestBody.md index 5fdf7e4..9b46b3a 100644 --- a/docs/GetNotificationHistoryRequestBody.md +++ b/docs/GetNotificationHistoryRequestBody.md @@ -9,6 +9,6 @@ Name | Type | Description | Notes **app_id** | **str** | | [optional] **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-python-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-python-api) diff --git a/docs/GetSegmentsSuccessResponse.md b/docs/GetSegmentsSuccessResponse.md index fec8250..0909537 100644 --- a/docs/GetSegmentsSuccessResponse.md +++ b/docs/GetSegmentsSuccessResponse.md @@ -10,6 +10,6 @@ Name | Type | Description | Notes **segments** | [**[SegmentData]**](SegmentData.md) | An array containing the Segment information. | [optional] **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-python-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-python-api) diff --git a/docs/IdentityObject.md b/docs/IdentityObject.md index 2cf3b22..2d453a3 100644 --- a/docs/IdentityObject.md +++ b/docs/IdentityObject.md @@ -6,6 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **any string name** | **str** | any string name can be used but the value must be the correct type | [optional] -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-python-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-python-api) diff --git a/docs/IncludeAliases.md b/docs/IncludeAliases.md index 0e92e9e..9d49175 100644 --- a/docs/IncludeAliases.md +++ b/docs/IncludeAliases.md @@ -7,6 +7,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **any string name** | **[str]** | any string name can be used but the value must be the correct type | [optional] -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-python-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-python-api) diff --git a/docs/LanguageStringMap.md b/docs/LanguageStringMap.md index 7c9b791..2d12efd 100644 --- a/docs/LanguageStringMap.md +++ b/docs/LanguageStringMap.md @@ -49,6 +49,6 @@ Name | Type | Description | Notes **vi** | **str** | Text in Vietnamese. | [optional] **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-python-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-python-api) diff --git a/docs/Notification.md b/docs/Notification.md index bdf9446..48694d4 100644 --- a/docs/Notification.md +++ b/docs/Notification.md @@ -121,6 +121,6 @@ Name | Type | Description | Notes **send_after** | **datetime, none_type** | Channel: All Schedule notification for future delivery. API defaults to UTC -1100 Examples: All examples are the exact same date & time. \"Thu Sep 24 2015 14:00:00 GMT-0700 (PDT)\" \"September 24th 2015, 2:00:00 pm UTC-07:00\" \"2015-09-24 14:00:00 GMT-0700\" \"Sept 24 2015 14:00:00 GMT-0700\" \"Thu Sep 24 2015 14:00:00 GMT-0700 (Pacific Daylight Time)\" Note: SMS currently only supports send_after parameter. | [optional] **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-python-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-python-api) diff --git a/docs/NotificationAllOf.md b/docs/NotificationAllOf.md index 60669cc..333c265 100644 --- a/docs/NotificationAllOf.md +++ b/docs/NotificationAllOf.md @@ -7,6 +7,6 @@ Name | Type | Description | Notes **send_after** | **datetime, none_type** | Channel: All Schedule notification for future delivery. API defaults to UTC -1100 Examples: All examples are the exact same date & time. \"Thu Sep 24 2015 14:00:00 GMT-0700 (PDT)\" \"September 24th 2015, 2:00:00 pm UTC-07:00\" \"2015-09-24 14:00:00 GMT-0700\" \"Sept 24 2015 14:00:00 GMT-0700\" \"Thu Sep 24 2015 14:00:00 GMT-0700 (Pacific Daylight Time)\" Note: SMS currently only supports send_after parameter. | [optional] **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-python-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-python-api) diff --git a/docs/NotificationHistorySuccessResponse.md b/docs/NotificationHistorySuccessResponse.md index 39d47e9..6c738b0 100644 --- a/docs/NotificationHistorySuccessResponse.md +++ b/docs/NotificationHistorySuccessResponse.md @@ -8,6 +8,6 @@ Name | Type | Description | Notes **destination_url** | **str** | | [optional] **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-python-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-python-api) diff --git a/docs/NotificationSlice.md b/docs/NotificationSlice.md index 8f5232c..f6ba919 100644 --- a/docs/NotificationSlice.md +++ b/docs/NotificationSlice.md @@ -10,6 +10,6 @@ Name | Type | Description | Notes **notifications** | [**[NotificationWithMeta]**](NotificationWithMeta.md) | | [optional] **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-python-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-python-api) diff --git a/docs/NotificationTarget.md b/docs/NotificationTarget.md index 1e31ded..65a0929 100644 --- a/docs/NotificationTarget.md +++ b/docs/NotificationTarget.md @@ -19,6 +19,6 @@ Name | Type | Description | Notes **target_channel** | **str** | | [optional] **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-python-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-python-api) diff --git a/docs/NotificationWithMeta.md b/docs/NotificationWithMeta.md index 5d9f43e..ff1a7ab 100644 --- a/docs/NotificationWithMeta.md +++ b/docs/NotificationWithMeta.md @@ -132,6 +132,6 @@ Name | Type | Description | Notes **canceled** | **bool** | Indicates whether the notification was canceled before it could be sent. | [optional] **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-python-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-python-api) diff --git a/docs/NotificationWithMetaAllOf.md b/docs/NotificationWithMetaAllOf.md index 6ffa2f6..d8c96d7 100644 --- a/docs/NotificationWithMetaAllOf.md +++ b/docs/NotificationWithMetaAllOf.md @@ -18,6 +18,6 @@ Name | Type | Description | Notes **canceled** | **bool** | Indicates whether the notification was canceled before it could be sent. | [optional] **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-python-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-python-api) diff --git a/docs/Operator.md b/docs/Operator.md index 2627243..d131fd2 100644 --- a/docs/Operator.md +++ b/docs/Operator.md @@ -7,6 +7,6 @@ Name | Type | Description | Notes **operator** | **str** | Strictly, this must be either `\"OR\"`, or `\"AND\"`. It can be used to compose Filters as part of a Filters object. | [optional] **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-python-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-python-api) diff --git a/docs/OutcomeData.md b/docs/OutcomeData.md index 6fb477c..584388d 100644 --- a/docs/OutcomeData.md +++ b/docs/OutcomeData.md @@ -9,6 +9,6 @@ Name | Type | Description | Notes **aggregation** | **str** | | **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-python-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-python-api) diff --git a/docs/OutcomesData.md b/docs/OutcomesData.md index b3e0c4f..5e7bfd0 100644 --- a/docs/OutcomesData.md +++ b/docs/OutcomesData.md @@ -7,6 +7,6 @@ Name | Type | Description | Notes **outcomes** | [**[OutcomeData]**](OutcomeData.md) | | [optional] **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-python-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-python-api) diff --git a/docs/PlatformDeliveryData.md b/docs/PlatformDeliveryData.md index a6d14bf..f558ea7 100644 --- a/docs/PlatformDeliveryData.md +++ b/docs/PlatformDeliveryData.md @@ -15,6 +15,6 @@ Name | Type | Description | Notes **email** | **bool, date, datetime, dict, float, int, list, str, none_type** | | [optional] **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-python-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-python-api) diff --git a/docs/PlatformDeliveryDataEmailAllOf.md b/docs/PlatformDeliveryDataEmailAllOf.md index 7c6e858..1e06921 100644 --- a/docs/PlatformDeliveryDataEmailAllOf.md +++ b/docs/PlatformDeliveryDataEmailAllOf.md @@ -13,6 +13,6 @@ Name | Type | Description | Notes **unsubscribed** | **int, none_type** | Number of recipients who opted out of your emails using the unsubscribe link in this email. | [optional] **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-python-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-python-api) diff --git a/docs/PlatformDeliveryDataSmsAllOf.md b/docs/PlatformDeliveryDataSmsAllOf.md index 8e8324c..82abb98 100644 --- a/docs/PlatformDeliveryDataSmsAllOf.md +++ b/docs/PlatformDeliveryDataSmsAllOf.md @@ -9,6 +9,6 @@ Name | Type | Description | Notes **provider_errored** | **int, none_type** | Number of errors reported by the SMS service provider. | [optional] **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-python-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-python-api) diff --git a/docs/PropertiesBody.md b/docs/PropertiesBody.md index 11d5a87..64b29cb 100644 --- a/docs/PropertiesBody.md +++ b/docs/PropertiesBody.md @@ -7,6 +7,6 @@ Name | Type | Description | Notes **properties** | [**PropertiesObject**](PropertiesObject.md) | | [optional] **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-python-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-python-api) diff --git a/docs/PropertiesDeltas.md b/docs/PropertiesDeltas.md index 19b148c..4664b30 100644 --- a/docs/PropertiesDeltas.md +++ b/docs/PropertiesDeltas.md @@ -9,6 +9,6 @@ Name | Type | Description | Notes **purchases** | [**[Purchase]**](Purchase.md) | | [optional] **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-python-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-python-api) diff --git a/docs/PropertiesObject.md b/docs/PropertiesObject.md index 7450623..b1c2a44 100644 --- a/docs/PropertiesObject.md +++ b/docs/PropertiesObject.md @@ -17,6 +17,6 @@ Name | Type | Description | Notes **ip** | **str** | | [optional] **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-python-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-python-api) diff --git a/docs/Purchase.md b/docs/Purchase.md index 5b54829..0d519c2 100644 --- a/docs/Purchase.md +++ b/docs/Purchase.md @@ -10,6 +10,6 @@ Name | Type | Description | Notes **count** | **int** | | [optional] **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-python-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-python-api) diff --git a/docs/RateLimitError.md b/docs/RateLimitError.md index 86aa138..574e85b 100644 --- a/docs/RateLimitError.md +++ b/docs/RateLimitError.md @@ -8,6 +8,6 @@ Name | Type | Description | Notes **limit** | **str** | | [optional] **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-python-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-python-api) diff --git a/docs/Segment.md b/docs/Segment.md index 631aedc..fc7e8e2 100644 --- a/docs/Segment.md +++ b/docs/Segment.md @@ -9,6 +9,6 @@ Name | Type | Description | Notes **id** | **str** | UUID of the segment. If left empty, it will be assigned automaticaly. | [optional] **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-python-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-python-api) diff --git a/docs/SegmentData.md b/docs/SegmentData.md index 3ca260a..2f3dc4d 100644 --- a/docs/SegmentData.md +++ b/docs/SegmentData.md @@ -13,6 +13,6 @@ Name | Type | Description | Notes **is_active** | **bool** | Is the segment active? | [optional] **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-python-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-python-api) diff --git a/docs/SegmentNotificationTarget.md b/docs/SegmentNotificationTarget.md index f155eb2..ab8c075 100644 --- a/docs/SegmentNotificationTarget.md +++ b/docs/SegmentNotificationTarget.md @@ -8,6 +8,6 @@ Name | Type | Description | Notes **excluded_segments** | **[str]** | Segment that will be excluded when sending. Users in these segments will not receive a notification, even if they were included in included_segments. This targeting parameter is only compatible with included_segments. Example: [\"Active Users\", \"Inactive Users\"] | [optional] **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-python-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-python-api) diff --git a/docs/StartLiveActivityRequest.md b/docs/StartLiveActivityRequest.md index 60bfdc4..7cdcd92 100644 --- a/docs/StartLiveActivityRequest.md +++ b/docs/StartLiveActivityRequest.md @@ -22,6 +22,6 @@ Name | Type | Description | Notes **filters** | [**[FilterExpression], none_type**](FilterExpression.md) | | [optional] **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-python-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-python-api) diff --git a/docs/StartLiveActivitySuccessResponse.md b/docs/StartLiveActivitySuccessResponse.md index 8bee77d..0c9eeae 100644 --- a/docs/StartLiveActivitySuccessResponse.md +++ b/docs/StartLiveActivitySuccessResponse.md @@ -7,6 +7,6 @@ Name | Type | Description | Notes **notification_id** | **str** | | [optional] **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-python-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-python-api) diff --git a/docs/Subscription.md b/docs/Subscription.md index 8b871ee..db26caf 100644 --- a/docs/Subscription.md +++ b/docs/Subscription.md @@ -23,6 +23,6 @@ Name | Type | Description | Notes **web_p256** | **str** | | [optional] **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-python-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-python-api) diff --git a/docs/SubscriptionBody.md b/docs/SubscriptionBody.md index e05809e..911754d 100644 --- a/docs/SubscriptionBody.md +++ b/docs/SubscriptionBody.md @@ -7,6 +7,6 @@ Name | Type | Description | Notes **subscription** | [**Subscription**](Subscription.md) | | [optional] **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-python-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-python-api) diff --git a/docs/SubscriptionNotificationTarget.md b/docs/SubscriptionNotificationTarget.md index 401cc75..a979af2 100644 --- a/docs/SubscriptionNotificationTarget.md +++ b/docs/SubscriptionNotificationTarget.md @@ -17,6 +17,6 @@ Name | Type | Description | Notes **target_channel** | **str** | | [optional] **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-python-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-python-api) diff --git a/docs/TemplateResource.md b/docs/TemplateResource.md index 840970a..1c4d36d 100644 --- a/docs/TemplateResource.md +++ b/docs/TemplateResource.md @@ -12,6 +12,6 @@ Name | Type | Description | Notes **content** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** | Rendered content and channel/platform flags for the template. | [optional] **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-python-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-python-api) diff --git a/docs/TemplatesListResponse.md b/docs/TemplatesListResponse.md index 3cb828d..ec2f9e6 100644 --- a/docs/TemplatesListResponse.md +++ b/docs/TemplatesListResponse.md @@ -7,6 +7,6 @@ Name | Type | Description | Notes **templates** | [**[TemplateResource]**](TemplateResource.md) | | [optional] **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-python-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-python-api) diff --git a/docs/TransferSubscriptionRequestBody.md b/docs/TransferSubscriptionRequestBody.md index 915f1a9..11ed994 100644 --- a/docs/TransferSubscriptionRequestBody.md +++ b/docs/TransferSubscriptionRequestBody.md @@ -7,6 +7,6 @@ Name | Type | Description | Notes **identity** | **{str: (str,)}** | | [optional] **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-python-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-python-api) diff --git a/docs/UpdateApiKeyRequest.md b/docs/UpdateApiKeyRequest.md index 70ad092..f88772e 100644 --- a/docs/UpdateApiKeyRequest.md +++ b/docs/UpdateApiKeyRequest.md @@ -9,6 +9,6 @@ Name | Type | Description | Notes **ip_allowlist** | **[str]** | | [optional] **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-python-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-python-api) diff --git a/docs/UpdateLiveActivityRequest.md b/docs/UpdateLiveActivityRequest.md index b4dd339..7908810 100644 --- a/docs/UpdateLiveActivityRequest.md +++ b/docs/UpdateLiveActivityRequest.md @@ -15,6 +15,6 @@ Name | Type | Description | Notes **priority** | **int** | Delivery priority through the the push provider (APNs). Pass 10 for higher priority notifications, or 5 for lower priority notifications. Lower priority notifications are sent based on the power considerations of the end user's device. If not set, defaults to 10. Some providers (APNs) allow for a limited budget of high priority notifications per hour, and if that budget is exceeded, the provider may throttle notification delivery. | [optional] **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-python-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-python-api) diff --git a/docs/UpdateLiveActivitySuccessResponse.md b/docs/UpdateLiveActivitySuccessResponse.md index 83cfc2a..1796527 100644 --- a/docs/UpdateLiveActivitySuccessResponse.md +++ b/docs/UpdateLiveActivitySuccessResponse.md @@ -7,6 +7,6 @@ Name | Type | Description | Notes **id** | **str** | | [optional] **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-python-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-python-api) diff --git a/docs/UpdateTemplateRequest.md b/docs/UpdateTemplateRequest.md index 9c9875f..58404f5 100644 --- a/docs/UpdateTemplateRequest.md +++ b/docs/UpdateTemplateRequest.md @@ -13,6 +13,6 @@ Name | Type | Description | Notes **dynamic_content** | **str, none_type** | JSON string for dynamic content personalization. | [optional] **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-python-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-python-api) diff --git a/docs/UpdateUserRequest.md b/docs/UpdateUserRequest.md index 809d7f3..2cad955 100644 --- a/docs/UpdateUserRequest.md +++ b/docs/UpdateUserRequest.md @@ -9,6 +9,6 @@ Name | Type | Description | Notes **deltas** | [**PropertiesDeltas**](PropertiesDeltas.md) | | [optional] **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-python-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-python-api) diff --git a/docs/User.md b/docs/User.md index d3edd22..ac7f774 100644 --- a/docs/User.md +++ b/docs/User.md @@ -9,6 +9,6 @@ Name | Type | Description | Notes **subscriptions** | [**[Subscription]**](Subscription.md) | | [optional] **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-python-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-python-api) diff --git a/docs/UserIdentityBody.md b/docs/UserIdentityBody.md index 7146afd..7ba5b7e 100644 --- a/docs/UserIdentityBody.md +++ b/docs/UserIdentityBody.md @@ -7,6 +7,6 @@ Name | Type | Description | Notes **identity** | [**IdentityObject**](IdentityObject.md) | | [optional] **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-python-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-python-api) diff --git a/docs/WebButton.md b/docs/WebButton.md index 99cc7a5..fa3ab1c 100644 --- a/docs/WebButton.md +++ b/docs/WebButton.md @@ -10,6 +10,6 @@ Name | Type | Description | Notes **url** | **str** | | [optional] **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) +[[Back to API list]](https://github.com/OneSignal/onesignal-python-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-python-api)