Skip to content

feat: add v5.4.0 package updates #72

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
onesignal-deploy wants to merge 1 commit into from
Closed

feat: add v5.4.0 package updates #72

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/project.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,4 @@ jobs:
with:
# SDK Server Project
project-url: https://github.com/orgs/OneSignal/projects/11
github-token: ${{ secrets.GH_PROJECTS_TOKEN }}
github-token: ${{ secrets.GH_PUSH_TOKEN }}
1 change: 1 addition & 0 deletions docs/BasicNotification.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,7 @@ Name | Type | Description | Notes
**email_preheader** | **str, none_type** | Channel: Email The preheader text of the email. Preheader is the preview text displayed immediately after an email subject that provides additional context about the email content. If not specified, will default to null. | [optional]
**disable_email_click_tracking** | **bool, none_type** | Channel: Email Default is `false`. If set to `true`, the URLs sent within the email will not include link tracking and will be the same as originally set; otherwise, all the URLs in the email will be tracked. | [optional]
**include_unsubscribed** | **bool** | Channel: Email Default is `false`. This field is used to send transactional notifications. If set to `true`, this notification will also be sent to unsubscribed emails. If a `template_id` is provided, the `include_unsubscribed` value from the template will be inherited. If you are using a third-party ESP, this field requires the ESP's list of unsubscribed emails to be cleared. | [optional]
**email_bcc** | **[str], none_type** | Channel: Email BCC recipients for the email. Maximum 5 addresses. Only supported when the email service provider is OneSignal Email. | [optional]
**sms_from** | **str, none_type** | Channel: SMS Phone Number used to send SMS. Should be a registered Twilio phone number in E.164 format. | [optional]
**sms_media_urls** | **[str], none_type** | Channel: SMS URLs for the media files to be attached to the SMS content. Limit: 10 media urls with a total max. size of 5MBs. | [optional]
**filters** | [**[FilterExpression], none_type**](FilterExpression.md) | | [optional]
Expand Down
1 change: 1 addition & 0 deletions docs/BasicNotificationAllOf.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,7 @@ Name | Type | Description | Notes
**email_preheader** | **str, none_type** | Channel: Email The preheader text of the email. Preheader is the preview text displayed immediately after an email subject that provides additional context about the email content. If not specified, will default to null. | [optional]
**disable_email_click_tracking** | **bool, none_type** | Channel: Email Default is `false`. If set to `true`, the URLs sent within the email will not include link tracking and will be the same as originally set; otherwise, all the URLs in the email will be tracked. | [optional]
**include_unsubscribed** | **bool** | Channel: Email Default is `false`. This field is used to send transactional notifications. If set to `true`, this notification will also be sent to unsubscribed emails. If a `template_id` is provided, the `include_unsubscribed` value from the template will be inherited. If you are using a third-party ESP, this field requires the ESP's list of unsubscribed emails to be cleared. | [optional]
**email_bcc** | **[str], none_type** | Channel: Email BCC recipients for the email. Maximum 5 addresses. Only supported when the email service provider is OneSignal Email. | [optional]
**sms_from** | **str, none_type** | Channel: SMS Phone Number used to send SMS. Should be a registered Twilio phone number in E.164 format. | [optional]
**sms_media_urls** | **[str], none_type** | Channel: SMS URLs for the media files to be attached to the SMS content. Limit: 10 media urls with a total max. size of 5MBs. | [optional]
**filters** | [**[FilterExpression], none_type**](FilterExpression.md) | | [optional]
Expand Down
1 change: 1 addition & 0 deletions docs/CreateTemplateRequest.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ Name | Type | Description | Notes
**is_email** | **bool** | Set true for an Email template. | [optional]
**email_subject** | **str, none_type** | Subject of the email. | [optional]
**email_body** | **str, none_type** | Body of the email (HTML supported). | [optional]
**email_bcc** | **[str], none_type** | BCC recipients for the email template. Maximum 5 addresses. Only supported when the email service provider is OneSignal Email. | [optional]
**is_sms** | **bool** | Set true for an SMS template. | [optional]
**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]
Expand Down
6 changes: 6 additions & 0 deletions docs/DefaultApi.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1082,6 +1082,9 @@ with onesignal.ApiClient(configuration) as api_client:
is_email=True,
email_subject="email_subject_example",
email_body="email_body_example",
email_bcc=[
"email_bcc_example",
],
is_sms=True,
dynamic_content="dynamic_content_example",
)
Expand Down Expand Up @@ -3838,6 +3841,9 @@ with onesignal.ApiClient(configuration) as api_client:
is_email=True,
email_subject="email_subject_example",
email_body="email_body_example",
email_bcc=[
"email_bcc_example",
],
is_sms=True,
dynamic_content="dynamic_content_example",
)
Expand Down
1 change: 1 addition & 0 deletions docs/Notification.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,7 @@ Name | Type | Description | Notes
**email_preheader** | **str, none_type** | Channel: Email The preheader text of the email. Preheader is the preview text displayed immediately after an email subject that provides additional context about the email content. If not specified, will default to null. | [optional]
**disable_email_click_tracking** | **bool, none_type** | Channel: Email Default is `false`. If set to `true`, the URLs sent within the email will not include link tracking and will be the same as originally set; otherwise, all the URLs in the email will be tracked. | [optional]
**include_unsubscribed** | **bool** | Channel: Email Default is `false`. This field is used to send transactional notifications. If set to `true`, this notification will also be sent to unsubscribed emails. If a `template_id` is provided, the `include_unsubscribed` value from the template will be inherited. If you are using a third-party ESP, this field requires the ESP's list of unsubscribed emails to be cleared. | [optional]
**email_bcc** | **[str], none_type** | Channel: Email BCC recipients for the email. Maximum 5 addresses. Only supported when the email service provider is OneSignal Email. | [optional]
**sms_from** | **str, none_type** | Channel: SMS Phone Number used to send SMS. Should be a registered Twilio phone number in E.164 format. | [optional]
**sms_media_urls** | **[str], none_type** | Channel: SMS URLs for the media files to be attached to the SMS content. Limit: 10 media urls with a total max. size of 5MBs. | [optional]
**filters** | [**[FilterExpression], none_type**](FilterExpression.md) | | [optional]
Expand Down
2 changes: 2 additions & 0 deletions docs/NotificationWithMeta.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,7 @@ Name | Type | Description | Notes
**email_preheader** | **str, none_type** | Channel: Email The preheader text of the email. Preheader is the preview text displayed immediately after an email subject that provides additional context about the email content. If not specified, will default to null. | [optional]
**disable_email_click_tracking** | **bool, none_type** | Channel: Email Default is `false`. If set to `true`, the URLs sent within the email will not include link tracking and will be the same as originally set; otherwise, all the URLs in the email will be tracked. | [optional]
**include_unsubscribed** | **bool** | Channel: Email Default is `false`. This field is used to send transactional notifications. If set to `true`, this notification will also be sent to unsubscribed emails. If a `template_id` is provided, the `include_unsubscribed` value from the template will be inherited. If you are using a third-party ESP, this field requires the ESP's list of unsubscribed emails to be cleared. | [optional]
**email_bcc** | **[str], none_type** | BCC recipients that were set on this email notification. | [optional]
**sms_from** | **str, none_type** | Channel: SMS Phone Number used to send SMS. Should be a registered Twilio phone number in E.164 format. | [optional]
**sms_media_urls** | **[str], none_type** | Channel: SMS URLs for the media files to be attached to the SMS content. Limit: 10 media urls with a total max. size of 5MBs. | [optional]
**filters** | [**[FilterExpression], none_type**](FilterExpression.md) | | [optional]
Expand All @@ -130,6 +131,7 @@ Name | Type | Description | Notes
**completed_at** | **int, none_type** | Unix timestamp indicating when notification delivery completed. The delivery duration from start to finish can be calculated with completed_at - send_after. | [optional]
**platform_delivery_stats** | [**PlatformDeliveryData**](PlatformDeliveryData.md) | | [optional]
**canceled** | **bool** | Indicates whether the notification was canceled before it could be sent. | [optional]
**bcc_sent** | **int, none_type** | Number of BCC copies successfully sent for this notification. | [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 API list]](https://github.com/OneSignal/onesignal-python-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-python-api)
Expand Down
2 changes: 2 additions & 0 deletions docs/NotificationWithMetaAllOf.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@ Name | Type | Description | Notes
**received** | **int, none_type** | Confirmed Deliveries number of devices that received the push notification. Paid Feature Only. Free accounts will see 0. | [optional]
**throttle_rate_per_minute** | **int, none_type** | number of push notifications sent per minute. Paid Feature Only. If throttling is not enabled for the app or the notification, and for free accounts, null is returned. Refer to Throttling for more details. | [optional]
**canceled** | **bool** | Indicates whether the notification was canceled before it could be sent. | [optional]
**email_bcc** | **[str], none_type** | BCC recipients that were set on this email notification. | [optional]
**bcc_sent** | **int, none_type** | Number of BCC copies successfully sent for this notification. | [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 API list]](https://github.com/OneSignal/onesignal-python-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-python-api)
Expand Down
1 change: 1 addition & 0 deletions docs/UpdateTemplateRequest.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ Name | Type | Description | Notes
**is_email** | **bool** | Set true for an Email template. | [optional]
**email_subject** | **str, none_type** | Subject of the email. | [optional]
**email_body** | **str, none_type** | Body of the email (HTML supported). | [optional]
**email_bcc** | **[str], none_type** | BCC recipients for the email template. Maximum 5 addresses. Only supported when the email service provider is OneSignal Email. | [optional]
**is_sms** | **bool** | Set true for an SMS template. | [optional]
**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]
Expand Down
7 changes: 7 additions & 0 deletions onesignal/model/basic_notification.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,6 +101,9 @@ class BasicNotification(ModelComposed):
}

validations = {
('email_bcc',): {
'max_items': 5,
},
}

@cached_property
Expand Down Expand Up @@ -231,6 +234,7 @@ def openapi_types():
'email_preheader': (str, none_type,), # noqa: E501
'disable_email_click_tracking': (bool, none_type,), # noqa: E501
'include_unsubscribed': (bool,), # noqa: E501
'email_bcc': ([str], none_type,), # noqa: E501
'sms_from': (str, none_type,), # noqa: E501
'sms_media_urls': ([str], none_type,), # noqa: E501
'filters': ([FilterExpression], none_type,), # noqa: E501
Expand Down Expand Up @@ -353,6 +357,7 @@ def discriminator():
'email_preheader': 'email_preheader', # noqa: E501
'disable_email_click_tracking': 'disable_email_click_tracking', # noqa: E501
'include_unsubscribed': 'include_unsubscribed', # noqa: E501
'email_bcc': 'email_bcc', # noqa: E501
'sms_from': 'sms_from', # noqa: E501
'sms_media_urls': 'sms_media_urls', # noqa: E501
'filters': 'filters', # noqa: E501
Expand Down Expand Up @@ -510,6 +515,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
email_preheader (str, none_type): Channel: Email The preheader text of the email. Preheader is the preview text displayed immediately after an email subject that provides additional context about the email content. If not specified, will default to null. . [optional] # noqa: E501
disable_email_click_tracking (bool, none_type): Channel: Email Default is `false`. If set to `true`, the URLs sent within the email will not include link tracking and will be the same as originally set; otherwise, all the URLs in the email will be tracked.. [optional] # noqa: E501
include_unsubscribed (bool): Channel: Email Default is `false`. This field is used to send transactional notifications. If set to `true`, this notification will also be sent to unsubscribed emails. If a `template_id` is provided, the `include_unsubscribed` value from the template will be inherited. If you are using a third-party ESP, this field requires the ESP's list of unsubscribed emails to be cleared.. [optional] # noqa: E501
email_bcc ([str], none_type): Channel: Email BCC recipients for the email. Maximum 5 addresses. Only supported when the email service provider is OneSignal Email. . [optional] # noqa: E501
sms_from (str, none_type): Channel: SMS Phone Number used to send SMS. Should be a registered Twilio phone number in E.164 format. . [optional] # noqa: E501
sms_media_urls ([str], none_type): Channel: SMS URLs for the media files to be attached to the SMS content. Limit: 10 media urls with a total max. size of 5MBs. . [optional] # noqa: E501
filters ([FilterExpression], none_type): [optional] # noqa: E501
Expand Down Expand Up @@ -727,6 +733,7 @@ def __init__(self, *args, **kwargs): # noqa: E501
email_preheader (str, none_type): Channel: Email The preheader text of the email. Preheader is the preview text displayed immediately after an email subject that provides additional context about the email content. If not specified, will default to null. . [optional] # noqa: E501
disable_email_click_tracking (bool, none_type): Channel: Email Default is `false`. If set to `true`, the URLs sent within the email will not include link tracking and will be the same as originally set; otherwise, all the URLs in the email will be tracked.. [optional] # noqa: E501
include_unsubscribed (bool): Channel: Email Default is `false`. This field is used to send transactional notifications. If set to `true`, this notification will also be sent to unsubscribed emails. If a `template_id` is provided, the `include_unsubscribed` value from the template will be inherited. If you are using a third-party ESP, this field requires the ESP's list of unsubscribed emails to be cleared.. [optional] # noqa: E501
email_bcc ([str], none_type): Channel: Email BCC recipients for the email. Maximum 5 addresses. Only supported when the email service provider is OneSignal Email. . [optional] # noqa: E501
sms_from (str, none_type): Channel: SMS Phone Number used to send SMS. Should be a registered Twilio phone number in E.164 format. . [optional] # noqa: E501
sms_media_urls ([str], none_type): Channel: SMS URLs for the media files to be attached to the SMS content. Limit: 10 media urls with a total max. size of 5MBs. . [optional] # noqa: E501
filters ([FilterExpression], none_type): [optional] # noqa: E501
Expand Down
Loading
Loading