Skip to content

feat: add v5.7.0 package updates #103

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

Open
onesignal-deploy wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat: add v5.7.0 package updates #103

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
33 changes: 30 additions & 3 deletions api/openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,20 @@ paths:
example: 0
type: integer
style: form
- description: "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."
explode: true
in: query
name: time_offset
required: false
schema:
example: 2025-01-01T00:00:00.000Z
type: string
style: form
responses:
"200":
content:
Expand Down Expand Up @@ -3000,8 +3014,10 @@ components:
NotificationSlice:
example:
offset: 6
time_offset: time_offset
total_count: 0
limit: 1
next_time_offset: next_time_offset
notifications:
- null
- null
Expand All @@ -3012,6 +3028,14 @@ components:
type: integer
limit:
type: integer
time_offset:
description: "The time_offset cursor specified in the request, if any."
type: string
next_time_offset:
description: 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.
type: string
notifications:
items:
$ref: '#/components/schemas/NotificationWithMeta'
Expand Down Expand Up @@ -3685,9 +3709,12 @@ components:
errors: ""
properties:
id:
description: 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).
description: "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."
type: string
external_id:
description: Optional correlation / idempotency-related value from the API
Expand Down
2 changes: 1 addition & 1 deletion docs/CreateNotificationSuccessResponse.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**id** | **String** | 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** | **String** | 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] |
|**externalId** | **String** | 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** | **Object** | 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] |

Expand Down
6 changes: 4 additions & 2 deletions docs/DefaultApi.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2135,7 +2135,7 @@ public class Example {

<a name="getNotifications"></a>
# **getNotifications**
> NotificationSlice getNotifications(appId, limit, offset, kind)
> NotificationSlice getNotifications(appId, limit, offset, kind, timeOffset)

View notifications

Expand Down Expand Up @@ -2165,8 +2165,9 @@ public class Example {
Integer limit = 10; // Integer | How many notifications to return. Max is 50. Default is 50.
Integer offset = 0; // Integer | 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.
Integer kind = 0; // Integer | Kind of notifications returned: * unset - All notification types (default) * `0` - Dashboard only * `1` - API only * `3` - Automated only
String timeOffset = "2025-01-01T00:00:00.000Z"; // String | 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.
try {
NotificationSlice result = apiInstance.getNotifications(appId, limit, offset, kind);
NotificationSlice result = apiInstance.getNotifications(appId, limit, offset, kind, timeOffset);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DefaultApi#getNotifications");
Expand All @@ -2190,6 +2191,7 @@ public class Example {
| **limit** | **Integer**| How many notifications to return. Max is 50. Default is 50. | [optional] |
| **offset** | **Integer**| 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** | **Integer**| Kind of notifications returned: * unset - All notification types (default) * &#x60;0&#x60; - Dashboard only * &#x60;1&#x60; - API only * &#x60;3&#x60; - Automated only | [optional] [enum: 0, 1, 3] |
| **timeOffset** | **String**| Time-offset pagination cursor for sequential pulls of all messages. Accepts either an ISO 8601 formatted timestamp (e.g. &#x60;2025-01-01T00:00:00.000Z&#x60;) or the opaque Base64 cursor token returned as &#x60;next_time_offset&#x60; in a prior response. When set, results are sorted ascending by send_after and the standard &#x60;offset&#x60; parameter cannot be used. Repeat the request with each &#x60;next_time_offset&#x60; until an empty notifications array is returned. | [optional] |

### Return type

Expand Down
2 changes: 2 additions & 0 deletions docs/NotificationSlice.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@
|**totalCount** | **Integer** | | [optional] |
|**offset** | **Integer** | | [optional] |
|**limit** | **Integer** | | [optional] |
|**timeOffset** | **String** | The time_offset cursor specified in the request, if any. | [optional] |
|**nextTimeOffset** | **String** | 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** | [**List&lt;NotificationWithMeta&gt;**](NotificationWithMeta.md) | | [optional] |


Expand Down
28 changes: 28 additions & 0 deletions src/main/java/com/onesignal/client/NotificationHelpers.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,34 @@ public static CreateNotificationWithRetryResult createNotificationWithRetry(Defa
}
}

/**
* Whether a POST /notifications 200 response is the "message sent" branch.
*
* <p>POST /notifications returns 200 in two cases that share the
* {@link CreateNotificationSuccessResponse} shape: a notification was
* created (non-empty {@code id}), or none was (empty {@code id}, with
* {@code errors} carrying the reason). Prefer this guard over inspecting
* {@code id} directly.
*
* @param response a create-notification success response
* @return {@code true} when a notification was created
*/
public static boolean isMessageSent(CreateNotificationSuccessResponse response) {
return response != null && response.getId() != null && !response.getId().isEmpty();
}

/**
* Whether a POST /notifications 200 response is the "message not sent"
* branch -- no notification was created ({@code id} absent or empty);
* inspect {@code errors} for why.
*
* @param response a create-notification success response
* @return {@code true} when no notification was created
*/
public static boolean isMessageNotSent(CreateNotificationSuccessResponse response) {
return !isMessageSent(response);
}

private static String headerValue(Map<String, List<String>> headers, String name) {
if (headers == null) {
return null;
Expand Down
26 changes: 17 additions & 9 deletions src/main/java/com/onesignal/client/api/DefaultApi.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4069,6 +4069,7 @@ public okhttp3.Call getNotificationHistoryAsync(String notificationId, GetNotifi
* @param limit How many notifications to return. Max is 50. Default is 50. (optional)
* @param offset 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)
* @param kind Kind of notifications returned: * unset - All notification types (default) * &#x60;0&#x60; - Dashboard only * &#x60;1&#x60; - API only * &#x60;3&#x60; - Automated only (optional)
* @param timeOffset Time-offset pagination cursor for sequential pulls of all messages. Accepts either an ISO 8601 formatted timestamp (e.g. &#x60;2025-01-01T00:00:00.000Z&#x60;) or the opaque Base64 cursor token returned as &#x60;next_time_offset&#x60; in a prior response. When set, results are sorted ascending by send_after and the standard &#x60;offset&#x60; parameter cannot be used. Repeat the request with each &#x60;next_time_offset&#x60; until an empty notifications array is returned. (optional)
* @param _callback Callback for upload/download progress
* @return Call to execute
* @throws ApiException If fail to serialize the request body object
Expand All @@ -4080,7 +4081,7 @@ public okhttp3.Call getNotificationHistoryAsync(String notificationId, GetNotifi
<tr><td> 429 </td><td> Rate Limit Exceeded </td><td> - </td></tr>
</table>
*/
public okhttp3.Call getNotificationsCall(String appId, Integer limit, Integer offset, Integer kind, final ApiCallback _callback) throws ApiException {
public okhttp3.Call getNotificationsCall(String appId, Integer limit, Integer offset, Integer kind, String timeOffset, final ApiCallback _callback) throws ApiException {
String basePath = null;
// Operation Servers
String[] localBasePaths = new String[] { };
Expand Down Expand Up @@ -4124,6 +4125,10 @@ public okhttp3.Call getNotificationsCall(String appId, Integer limit, Integer of
localVarQueryParams.addAll(localVarApiClient.parameterToPair("kind", kind));
}

if (timeOffset != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("time_offset", timeOffset));
}

final String[] localVarAccepts = {
"application/json"
};
Expand All @@ -4145,15 +4150,15 @@ public okhttp3.Call getNotificationsCall(String appId, Integer limit, Integer of
}

@SuppressWarnings("rawtypes")
private okhttp3.Call getNotificationsValidateBeforeCall(String appId, Integer limit, Integer offset, Integer kind, final ApiCallback _callback) throws ApiException {
private okhttp3.Call getNotificationsValidateBeforeCall(String appId, Integer limit, Integer offset, Integer kind, String timeOffset, final ApiCallback _callback) throws ApiException {

// verify the required parameter 'appId' is set
if (appId == null) {
throw new ApiException("Missing the required parameter 'appId' when calling getNotifications(Async)");
}


okhttp3.Call localVarCall = getNotificationsCall(appId, limit, offset, kind, _callback);
okhttp3.Call localVarCall = getNotificationsCall(appId, limit, offset, kind, timeOffset, _callback);
return localVarCall;

}
Expand All @@ -4165,6 +4170,7 @@ private okhttp3.Call getNotificationsValidateBeforeCall(String appId, Integer li
* @param limit How many notifications to return. Max is 50. Default is 50. (optional)
* @param offset 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)
* @param kind Kind of notifications returned: * unset - All notification types (default) * &#x60;0&#x60; - Dashboard only * &#x60;1&#x60; - API only * &#x60;3&#x60; - Automated only (optional)
* @param timeOffset Time-offset pagination cursor for sequential pulls of all messages. Accepts either an ISO 8601 formatted timestamp (e.g. &#x60;2025-01-01T00:00:00.000Z&#x60;) or the opaque Base64 cursor token returned as &#x60;next_time_offset&#x60; in a prior response. When set, results are sorted ascending by send_after and the standard &#x60;offset&#x60; parameter cannot be used. Repeat the request with each &#x60;next_time_offset&#x60; until an empty notifications array is returned. (optional)
* @return NotificationSlice
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
Expand All @@ -4175,8 +4181,8 @@ private okhttp3.Call getNotificationsValidateBeforeCall(String appId, Integer li
<tr><td> 429 </td><td> Rate Limit Exceeded </td><td> - </td></tr>
</table>
*/
public NotificationSlice getNotifications(String appId, Integer limit, Integer offset, Integer kind) throws ApiException {
ApiResponse<NotificationSlice> localVarResp = getNotificationsWithHttpInfo(appId, limit, offset, kind);
public NotificationSlice getNotifications(String appId, Integer limit, Integer offset, Integer kind, String timeOffset) throws ApiException {
ApiResponse<NotificationSlice> localVarResp = getNotificationsWithHttpInfo(appId, limit, offset, kind, timeOffset);
return localVarResp.getData();
}

Expand All @@ -4187,6 +4193,7 @@ public NotificationSlice getNotifications(String appId, Integer limit, Integer o
* @param limit How many notifications to return. Max is 50. Default is 50. (optional)
* @param offset 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)
* @param kind Kind of notifications returned: * unset - All notification types (default) * &#x60;0&#x60; - Dashboard only * &#x60;1&#x60; - API only * &#x60;3&#x60; - Automated only (optional)
* @param timeOffset Time-offset pagination cursor for sequential pulls of all messages. Accepts either an ISO 8601 formatted timestamp (e.g. &#x60;2025-01-01T00:00:00.000Z&#x60;) or the opaque Base64 cursor token returned as &#x60;next_time_offset&#x60; in a prior response. When set, results are sorted ascending by send_after and the standard &#x60;offset&#x60; parameter cannot be used. Repeat the request with each &#x60;next_time_offset&#x60; until an empty notifications array is returned. (optional)
* @return ApiResponse&lt;NotificationSlice&gt;
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
Expand All @@ -4197,8 +4204,8 @@ public NotificationSlice getNotifications(String appId, Integer limit, Integer o
<tr><td> 429 </td><td> Rate Limit Exceeded </td><td> - </td></tr>
</table>
*/
public ApiResponse<NotificationSlice> getNotificationsWithHttpInfo(String appId, Integer limit, Integer offset, Integer kind) throws ApiException {
okhttp3.Call localVarCall = getNotificationsValidateBeforeCall(appId, limit, offset, kind, null);
public ApiResponse<NotificationSlice> getNotificationsWithHttpInfo(String appId, Integer limit, Integer offset, Integer kind, String timeOffset) throws ApiException {
okhttp3.Call localVarCall = getNotificationsValidateBeforeCall(appId, limit, offset, kind, timeOffset, null);
Type localVarReturnType = new TypeToken<NotificationSlice>(){}.getType();
return localVarApiClient.execute(localVarCall, localVarReturnType);
}
Expand All @@ -4210,6 +4217,7 @@ public ApiResponse<NotificationSlice> getNotificationsWithHttpInfo(String appId,
* @param limit How many notifications to return. Max is 50. Default is 50. (optional)
* @param offset 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)
* @param kind Kind of notifications returned: * unset - All notification types (default) * &#x60;0&#x60; - Dashboard only * &#x60;1&#x60; - API only * &#x60;3&#x60; - Automated only (optional)
* @param timeOffset Time-offset pagination cursor for sequential pulls of all messages. Accepts either an ISO 8601 formatted timestamp (e.g. &#x60;2025-01-01T00:00:00.000Z&#x60;) or the opaque Base64 cursor token returned as &#x60;next_time_offset&#x60; in a prior response. When set, results are sorted ascending by send_after and the standard &#x60;offset&#x60; parameter cannot be used. Repeat the request with each &#x60;next_time_offset&#x60; until an empty notifications array is returned. (optional)
* @param _callback The callback to be executed when the API call finishes
* @return The request call
* @throws ApiException If fail to process the API call, e.g. serializing the request body object
Expand All @@ -4221,9 +4229,9 @@ public ApiResponse<NotificationSlice> getNotificationsWithHttpInfo(String appId,
<tr><td> 429 </td><td> Rate Limit Exceeded </td><td> - </td></tr>
</table>
*/
public okhttp3.Call getNotificationsAsync(String appId, Integer limit, Integer offset, Integer kind, final ApiCallback<NotificationSlice> _callback) throws ApiException {
public okhttp3.Call getNotificationsAsync(String appId, Integer limit, Integer offset, Integer kind, String timeOffset, final ApiCallback<NotificationSlice> _callback) throws ApiException {

okhttp3.Call localVarCall = getNotificationsValidateBeforeCall(appId, limit, offset, kind, _callback);
okhttp3.Call localVarCall = getNotificationsValidateBeforeCall(appId, limit, offset, kind, timeOffset, _callback);
Type localVarReturnType = new TypeToken<NotificationSlice>(){}.getType();
localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback);
return localVarCall;
Expand Down
Loading