feat: add v5.8.0 package updates

README.md

@@ -13,8 +13,8 @@
 
 A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com
 
-- API version: 5.7.0
-- Package version: 5.7.0
+- API version: 5.8.0
+- Package version: 5.8.0
 
 ## Requirements
 

docs/CreateNotificationSuccessResponse.md

@@ -4,7 +4,7 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **str** | Notification identifier when the request created a notification. An empty string means no notification was created; read `errors` for details (HTTP may still be 200). | [optional] 
+**id** | **str** | Notification identifier when the request created a notification. An empty string means no notification was created; read `errors` for details (HTTP may still be 200). All OneSignal server SDKs expose message-sent / message-not-sent narrowing helpers (named idiomatically per language — e.g. `isMessageSent`, `is_message_sent`, `message_sent?`); prefer them over comparing `id` directly. | [optional] 
 **external_id** | **str, none_type** | Optional correlation / idempotency-related value from the API response. This is not the end-user External ID used for targeting recipients (that lives under `include_aliases.external_id`). | [optional] 
 **errors** | **bool, date, datetime, dict, float, int, list, str, none_type** | Polymorphic field: may be an array of human-readable strings and/or an object (for example with `invalid_aliases`, `invalid_external_user_ids`, or `invalid_player_ids`) depending on the API response; HTTP may still be 200 with partial success. Typed SDKs model this loosely so both shapes deserialize. | [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]

docs/NotificationSlice.md

@@ -7,6 +7,8 @@ Name | Type | Description | Notes
 **total_count** | **int** |  | [optional] 
 **offset** | **int** |  | [optional] 
 **limit** | **int** |  | [optional] 
+**time_offset** | **str** | The time_offset cursor specified in the request, if any. | [optional] 
+**next_time_offset** | **str** | An opaque Base64 cursor token representing the next page of messages to fetch.  Present when time_offset was provided in the request.  Pass this value as time_offset on the next request to continue paginating. | [optional] 
 **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]
 

onesignal/__init__.py

@@ -5,13 +5,13 @@
 
     A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com  # noqa: E501
 
-    The version of the OpenAPI document: 5.7.0
+    The version of the OpenAPI document: 5.8.0
     Contact: devrel@onesignal.com
     Generated by: https://openapi-generator.tech
 """
 
 
-__version__ = "5.7.0"
+__version__ = "5.8.0"
 
 # import ApiClient
 from onesignal.api_client import ApiClient

onesignal/api/default_api.py

@@ -3,7 +3,7 @@
 
     A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com  # noqa: E501
 
-    The version of the OpenAPI document: 5.7.0
+    The version of the OpenAPI document: 5.8.0
     Contact: devrel@onesignal.com
     Generated by: https://openapi-generator.tech
 """
@@ -1608,6 +1608,7 @@ def __init__(self, api_client=None):
                     'limit',
                     'offset',
                     'kind',
+                    'time_offset',
                 ],
                 'required': [
                     'app_id',
@@ -1640,18 +1641,22 @@ def __init__(self, api_client=None):
                         (int,),
                     'kind':
                         (int,),
+                    'time_offset':
+                        (str,),
                 },
                 'attribute_map': {
                     'app_id': 'app_id',
                     'limit': 'limit',
                     'offset': 'offset',
                     'kind': 'kind',
+                    'time_offset': 'time_offset',
                 },
                 'location_map': {
                     'app_id': 'query',
                     'limit': 'query',
                     'offset': 'query',
                     'kind': 'query',
+                    'time_offset': 'query',
                 },
                 'collection_format_map': {
                 }
@@ -5041,6 +5046,7 @@ def get_notifications(
             limit (int): How many notifications to return.  Max is 50.  Default is 50.. [optional]
             offset (int): Page offset.  Default is 0.  Results are sorted by queued_at in descending order.  queued_at is a representation of the time that the notification was queued at.. [optional]
             kind (int): Kind of notifications returned:   * unset - All notification types (default)   * `0` - Dashboard only   * `1` - API only   * `3` - Automated only . [optional]
+            time_offset (str): Time-offset pagination cursor for sequential pulls of all messages.  Accepts either an ISO 8601 formatted timestamp (e.g. `2025-01-01T00:00:00.000Z`) or the opaque Base64 cursor token returned as `next_time_offset` in a prior response.  When set, results are sorted ascending by send_after and the standard `offset` parameter cannot be used.  Repeat the request with each `next_time_offset` until an empty notifications array is returned.. [optional]
             _return_http_data_only (bool): response data without head status
                 code and headers. Default is True.
             _preload_content (bool): if False, the urllib3.HTTPResponse object

onesignal/api_client.py

@@ -3,7 +3,7 @@
 
     A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com  # noqa: E501
 
-    The version of the OpenAPI document: 5.7.0
+    The version of the OpenAPI document: 5.8.0
     Contact: devrel@onesignal.com
     Generated by: https://openapi-generator.tech
 """
@@ -77,7 +77,7 @@ def __init__(self, configuration=None, header_name=None, header_value=None,
             self.default_headers[header_name] = header_value
         self.cookie = cookie
         # Set default User-Agent.
-        self.user_agent = 'OpenAPI-Generator/5.7.0/python'
+        self.user_agent = 'OpenAPI-Generator/5.8.0/python'
 
     def __enter__(self):
         return self
@@ -142,7 +142,7 @@ def __call_api(
         # header parameters
         header_params = header_params or {}
         header_params.update(self.default_headers)
-        header_params['OS-Usage-Data'] = "kind=sdk, sdk-name=onesignal-python, version=5.7.0"
+        header_params['OS-Usage-Data'] = "kind=sdk, sdk-name=onesignal-python, version=5.8.0"
         if self.cookie:
             header_params['Cookie'] = self.cookie
         if header_params:

onesignal/configuration.py

@@ -3,7 +3,7 @@
 
     A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com  # noqa: E501
 
-    The version of the OpenAPI document: 5.7.0
+    The version of the OpenAPI document: 5.8.0
     Contact: devrel@onesignal.com
     Generated by: https://openapi-generator.tech
 """
@@ -399,8 +399,8 @@ def to_debug_report(self):
         return "Python SDK Debug Report:\n"\
                "OS: {env}\n"\
                "Python Version: {pyversion}\n"\
-               "Version of the API: 5.7.0\n"\
-               "SDK Package Version: 5.7.0".\
+               "Version of the API: 5.8.0\n"\
+               "SDK Package Version: 5.8.0".\
                format(env=sys.platform, pyversion=sys.version)
 
     def get_host_settings(self):

onesignal/exceptions.py

@@ -3,7 +3,7 @@
 
     A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com  # noqa: E501
 
-    The version of the OpenAPI document: 5.7.0
+    The version of the OpenAPI document: 5.8.0
     Contact: devrel@onesignal.com
     Generated by: https://openapi-generator.tech
 """

onesignal/helpers.py

@@ -96,3 +96,30 @@ def create_notification_with_retry(api, notification, max_retries=3, base_delay=
         if delay > 0:
             time.sleep(delay)
         attempt += 1
+
+
+def is_message_sent(response):
+    """Return True when a POST /notifications 200 response is the "message
+    sent" branch -- a notification was created and ``id`` is a non-empty string.
+
+    POST /notifications returns 200 in two cases that share the
+    ``CreateNotificationSuccessResponse`` shape: a notification was created
+    (non-empty ``id``), or none was (empty ``id``, with ``errors`` carrying the
+    reason). Prefer this guard over inspecting ``id`` directly.
+
+    :param response: a ``CreateNotificationSuccessResponse``
+    :return: True if a notification was created
+    """
+    notification_id = getattr(response, 'id', None)
+    return isinstance(notification_id, str) and len(notification_id) > 0
+
+
+def is_message_not_sent(response):
+    """Return True when a POST /notifications 200 response is the "message not
+    sent" branch -- no notification was created (``id`` is absent or empty);
+    inspect ``errors`` for why.
+
+    :param response: a ``CreateNotificationSuccessResponse``
+    :return: True if no notification was created
+    """
+    return not is_message_sent(response)

onesignal/model/api_key_token.py

@@ -3,7 +3,7 @@
 
     A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com  # noqa: E501
 
-    The version of the OpenAPI document: 5.7.0
+    The version of the OpenAPI document: 5.8.0
     Contact: devrel@onesignal.com
     Generated by: https://openapi-generator.tech
 """

onesignal/model/api_key_tokens_list_response.py

@@ -3,7 +3,7 @@
 
     A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com  # noqa: E501
 
-    The version of the OpenAPI document: 5.7.0
+    The version of the OpenAPI document: 5.8.0
     Contact: devrel@onesignal.com
     Generated by: https://openapi-generator.tech
 """

onesignal/model/app.py

@@ -3,7 +3,7 @@
 
     A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com  # noqa: E501
 
-    The version of the OpenAPI document: 5.7.0
+    The version of the OpenAPI document: 5.8.0
     Contact: devrel@onesignal.com
     Generated by: https://openapi-generator.tech
 """

onesignal/model/apps.py

@@ -3,7 +3,7 @@
 
     A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com  # noqa: E501
 
-    The version of the OpenAPI document: 5.7.0
+    The version of the OpenAPI document: 5.8.0
     Contact: devrel@onesignal.com
     Generated by: https://openapi-generator.tech
 """

onesignal/model/basic_notification.py

@@ -3,7 +3,7 @@
 
     A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com  # noqa: E501
 
-    The version of the OpenAPI document: 5.7.0
+    The version of the OpenAPI document: 5.8.0
     Contact: devrel@onesignal.com
     Generated by: https://openapi-generator.tech
 """

onesignal/model/basic_notification_all_of.py

@@ -3,7 +3,7 @@
 
     A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com  # noqa: E501
 
-    The version of the OpenAPI document: 5.7.0
+    The version of the OpenAPI document: 5.8.0
     Contact: devrel@onesignal.com
     Generated by: https://openapi-generator.tech
 """

onesignal/model/basic_notification_all_of_android_background_layout.py

@@ -3,7 +3,7 @@
 
     A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com  # noqa: E501
 
-    The version of the OpenAPI document: 5.7.0
+    The version of the OpenAPI document: 5.8.0
     Contact: devrel@onesignal.com
     Generated by: https://openapi-generator.tech
 """

onesignal/model/button.py

@@ -3,7 +3,7 @@
 
     A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com  # noqa: E501
 
-    The version of the OpenAPI document: 5.7.0
+    The version of the OpenAPI document: 5.8.0
     Contact: devrel@onesignal.com
     Generated by: https://openapi-generator.tech
 """

onesignal/model/copy_template_request.py

@@ -3,7 +3,7 @@
 
     A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com  # noqa: E501
 
-    The version of the OpenAPI document: 5.7.0
+    The version of the OpenAPI document: 5.8.0
     Contact: devrel@onesignal.com
     Generated by: https://openapi-generator.tech
 """

onesignal/model/create_api_key_request.py

@@ -3,7 +3,7 @@
 
     A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com  # noqa: E501
 
-    The version of the OpenAPI document: 5.7.0
+    The version of the OpenAPI document: 5.8.0
     Contact: devrel@onesignal.com
     Generated by: https://openapi-generator.tech
 """

onesignal/model/create_api_key_response.py

@@ -3,7 +3,7 @@
 
     A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com  # noqa: E501
 
-    The version of the OpenAPI document: 5.7.0
+    The version of the OpenAPI document: 5.8.0
     Contact: devrel@onesignal.com
     Generated by: https://openapi-generator.tech
 """

onesignal/model/create_notification_success_response.py

@@ -3,7 +3,7 @@
 
     A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com  # noqa: E501
 
-    The version of the OpenAPI document: 5.7.0
+    The version of the OpenAPI document: 5.8.0
     Contact: devrel@onesignal.com
     Generated by: https://openapi-generator.tech
 """
@@ -139,7 +139,7 @@ def _from_openapi_data(cls, *args, **kwargs):  # noqa: E501
                                 Animal class but this time we won't travel
                                 through its discriminator because we passed in
                                 _visited_composed_classes = (Animal,)
-            id (str): Notification identifier when the request created a notification. An empty string means no notification was created; read `errors` for details (HTTP may still be 200).. [optional]  # noqa: E501
+            id (str): Notification identifier when the request created a notification. An empty string means no notification was created; read `errors` for details (HTTP may still be 200). All OneSignal server SDKs expose message-sent / message-not-sent narrowing helpers (named idiomatically per language — e.g. `isMessageSent`, `is_message_sent`, `message_sent?`); prefer them over comparing `id` directly.. [optional]  # noqa: E501
             external_id (str, none_type): Optional correlation / idempotency-related value from the API response. This is not the end-user External ID used for targeting recipients (that lives under `include_aliases.external_id`).. [optional]  # noqa: E501
             errors (bool, date, datetime, dict, float, int, list, str, none_type): Polymorphic field: may be an array of human-readable strings and/or an object (for example with `invalid_aliases`, `invalid_external_user_ids`, or `invalid_player_ids`) depending on the API response; HTTP may still be 200 with partial success. Typed SDKs model this loosely so both shapes deserialize.. [optional]  # noqa: E501
         """
@@ -227,7 +227,7 @@ def __init__(self, *args, **kwargs):  # noqa: E501
                                 Animal class but this time we won't travel
                                 through its discriminator because we passed in
                                 _visited_composed_classes = (Animal,)
-            id (str): Notification identifier when the request created a notification. An empty string means no notification was created; read `errors` for details (HTTP may still be 200).. [optional]  # noqa: E501
+            id (str): Notification identifier when the request created a notification. An empty string means no notification was created; read `errors` for details (HTTP may still be 200). All OneSignal server SDKs expose message-sent / message-not-sent narrowing helpers (named idiomatically per language — e.g. `isMessageSent`, `is_message_sent`, `message_sent?`); prefer them over comparing `id` directly.. [optional]  # noqa: E501
             external_id (str, none_type): Optional correlation / idempotency-related value from the API response. This is not the end-user External ID used for targeting recipients (that lives under `include_aliases.external_id`).. [optional]  # noqa: E501
             errors (bool, date, datetime, dict, float, int, list, str, none_type): Polymorphic field: may be an array of human-readable strings and/or an object (for example with `invalid_aliases`, `invalid_external_user_ids`, or `invalid_player_ids`) depending on the API response; HTTP may still be 200 with partial success. Typed SDKs model this loosely so both shapes deserialize.. [optional]  # noqa: E501
         """

onesignal/model/create_segment_conflict_response.py

@@ -3,7 +3,7 @@
 
     A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com  # noqa: E501
 
-    The version of the OpenAPI document: 5.7.0
+    The version of the OpenAPI document: 5.8.0
     Contact: devrel@onesignal.com
     Generated by: https://openapi-generator.tech
 """

onesignal/model/create_segment_success_response.py

@@ -3,7 +3,7 @@
 
     A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com  # noqa: E501
 
-    The version of the OpenAPI document: 5.7.0
+    The version of the OpenAPI document: 5.8.0
     Contact: devrel@onesignal.com
     Generated by: https://openapi-generator.tech
 """

onesignal/model/create_template_request.py

@@ -3,7 +3,7 @@
 
     A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com  # noqa: E501
 
-    The version of the OpenAPI document: 5.7.0
+    The version of the OpenAPI document: 5.8.0
     Contact: devrel@onesignal.com
     Generated by: https://openapi-generator.tech
 """

onesignal/model/create_user_conflict_response.py

@@ -3,7 +3,7 @@
 
     A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com  # noqa: E501
 
-    The version of the OpenAPI document: 5.7.0
+    The version of the OpenAPI document: 5.8.0
     Contact: devrel@onesignal.com
     Generated by: https://openapi-generator.tech
 """

onesignal/model/create_user_conflict_response_errors_inner.py

@@ -3,7 +3,7 @@
 
     A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com  # noqa: E501
 
-    The version of the OpenAPI document: 5.7.0
+    The version of the OpenAPI document: 5.8.0
     Contact: devrel@onesignal.com
     Generated by: https://openapi-generator.tech
 """

onesignal/model/create_user_conflict_response_errors_items_meta.py

@@ -3,7 +3,7 @@
 
     A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com  # noqa: E501
 
-    The version of the OpenAPI document: 5.7.0
+    The version of the OpenAPI document: 5.8.0
     Contact: devrel@onesignal.com
     Generated by: https://openapi-generator.tech
 """

onesignal/model/custom_event.py

@@ -3,7 +3,7 @@
 
     A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com  # noqa: E501
 
-    The version of the OpenAPI document: 5.7.0
+    The version of the OpenAPI document: 5.8.0
     Contact: devrel@onesignal.com
     Generated by: https://openapi-generator.tech
 """

onesignal/model/custom_events_request.py

@@ -3,7 +3,7 @@
 
     A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com  # noqa: E501
 
-    The version of the OpenAPI document: 5.7.0
+    The version of the OpenAPI document: 5.8.0
     Contact: devrel@onesignal.com
     Generated by: https://openapi-generator.tech
 """

onesignal/model/delivery_data.py

@@ -3,7 +3,7 @@
 
     A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com  # noqa: E501
 
-    The version of the OpenAPI document: 5.7.0
+    The version of the OpenAPI document: 5.8.0
     Contact: devrel@onesignal.com
     Generated by: https://openapi-generator.tech
 """