Skip to content

feat: add v5.7.0 package updates #104

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.7.0 package updates #104

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
297 changes: 294 additions & 3 deletions api/openapi.yaml
View file
Open in desktop

Large diffs are not rendered by default.

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
50 changes: 48 additions & 2 deletions docs/DefaultApi.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -160,6 +160,7 @@ public class Example {
| **400** | Bad Request | - |
| **404** | Not Found | - |
| **429** | Rate Limit Exceeded | - |
| **0** | Unexpected error | - |

<a name="copyTemplateToApp"></a>
# **copyTemplateToApp**
Expand Down Expand Up @@ -235,6 +236,7 @@ public class Example {
|-------------|-------------|------------------|
| **200** | OK | - |
| **400** | Bad Request | - |
| **0** | Unexpected error | - |

<a name="createAlias"></a>
# **createAlias**
Expand Down Expand Up @@ -315,6 +317,7 @@ public class Example {
| **404** | Not Found | - |
| **409** | Conflict | - |
| **429** | Rate Limit Exceeded | - |
| **0** | Unexpected error | - |

<a name="createAliasBySubscription"></a>
# **createAliasBySubscription**
Expand Down Expand Up @@ -393,6 +396,7 @@ public class Example {
| **404** | Not Found | - |
| **409** | Conflict | - |
| **429** | Rate Limit Exceeded | - |
| **0** | Unexpected error | - |

<a name="createApiKey"></a>
# **createApiKey**
Expand Down Expand Up @@ -466,6 +470,7 @@ public class Example {
|-------------|-------------|------------------|
| **200** | OK | - |
| **400** | Bad Request | - |
| **0** | Unexpected error | - |

<a name="createApp"></a>
# **createApp**
Expand Down Expand Up @@ -538,6 +543,7 @@ public class Example {
| **200** | OK | - |
| **400** | Bad Request | - |
| **429** | Rate Limit Exceeded | - |
| **0** | Unexpected error | - |

<a name="createCustomEvents"></a>
# **createCustomEvents**
Expand Down Expand Up @@ -613,6 +619,7 @@ public class Example {
| **400** | Bad Request | - |
| **401** | Unauthorized | - |
| **429** | Rate Limit Exceeded | - |
| **0** | Unexpected error | - |

<a name="createNotification"></a>
# **createNotification**
Expand Down Expand Up @@ -770,6 +777,7 @@ public class Example {
| **200** | OK, invalid_aliases, or No Subscribed Players If a message was successfully created, you will get a 200 response with a non-empty &#x60;id&#x60; for the notification. If the 200 response contains &#x60;invalid_aliases&#x60;, that marks devices that exist in the provided app_id but are no longer subscribed. If &#x60;id&#x60; is an empty string, no notification was created: check the &#x60;errors&#x60; array (for example messages such as \&quot;All included players are not subscribed\&quot;) even though HTTP status is still 200. This can happen when alias keys are wrong, External IDs do not resolve to subscribed users, or other validation issues. If no id is returned, then a message was not created and the targeted User IDs do not exist under the provided app_id. Any User IDs sent in the request that do not exist under the specified app_id will be ignored. | - |
| **400** | Bad Request | - |
| **429** | Rate Limit Exceeded | - |
| **0** | Unexpected error | - |

<a name="createSegment"></a>
# **createSegment**
Expand Down Expand Up @@ -845,6 +853,7 @@ public class Example {
| **400** | Bad Request | - |
| **409** | Conflict | - |
| **429** | Rate Limit Exceeded | - |
| **0** | Unexpected error | - |

<a name="createSubscription"></a>
# **createSubscription**
Expand Down Expand Up @@ -926,6 +935,7 @@ public class Example {
| **404** | Not Found | - |
| **409** | Operation is not permitted due to user having the maximum number of subscriptions assigned | - |
| **429** | Rate Limit Exceeded | - |
| **0** | Unexpected error | - |

<a name="createTemplate"></a>
# **createTemplate**
Expand Down Expand Up @@ -998,6 +1008,7 @@ public class Example {
| **200** | OK | - |
| **400** | Bad Request | - |
| **422** | Unprocessable Entity | - |
| **0** | Unexpected error | - |

<a name="createUser"></a>
# **createUser**
Expand Down Expand Up @@ -1089,6 +1100,7 @@ if (e.getCode() == 409) {
| **400** | Bad Request | - |
| **409** | Multiple User Identity Conflict | - |
| **429** | Rate Limit Exceeded | - |
| **0** | Unexpected error | - |

<a name="deleteAlias"></a>
# **deleteAlias**
Expand Down Expand Up @@ -1169,6 +1181,7 @@ public class Example {
| **404** | Not Found | - |
| **409** | Conflict | - |
| **429** | Rate Limit Exceeded | - |
| **0** | Unexpected error | - |

<a name="deleteApiKey"></a>
# **deleteApiKey**
Expand Down Expand Up @@ -1242,6 +1255,7 @@ public class Example {
|-------------|-------------|------------------|
| **200** | OK | - |
| **400** | Bad Request | - |
| **0** | Unexpected error | - |

<a name="deleteSegment"></a>
# **deleteSegment**
Expand Down Expand Up @@ -1317,6 +1331,7 @@ public class Example {
| **400** | Bad Request | - |
| **404** | Not Found | - |
| **429** | Rate Limit Exceeded | - |
| **0** | Unexpected error | - |

<a name="deleteSubscription"></a>
# **deleteSubscription**
Expand Down Expand Up @@ -1392,6 +1407,7 @@ null (empty response body)
| **404** | Not Found | - |
| **409** | Conflict | - |
| **429** | Rate Limit Exceeded | - |
| **0** | Unexpected error | - |

<a name="deleteTemplate"></a>
# **deleteTemplate**
Expand Down Expand Up @@ -1466,6 +1482,7 @@ public class Example {
| **200** | OK | - |
| **400** | Bad Request | - |
| **404** | Not Found | - |
| **0** | Unexpected error | - |

<a name="deleteUser"></a>
# **deleteUser**
Expand Down Expand Up @@ -1542,6 +1559,7 @@ null (empty response body)
| **400** | Bad Request | - |
| **409** | Conflict | - |
| **429** | Rate Limit Exceeded | - |
| **0** | Unexpected error | - |

<a name="exportEvents"></a>
# **exportEvents**
Expand Down Expand Up @@ -1617,6 +1635,7 @@ public class Example {
| **400** | Bad Request | - |
| **404** | Not Found | - |
| **429** | Rate Limit Exceeded | - |
| **0** | Unexpected error | - |

<a name="exportSubscriptions"></a>
# **exportSubscriptions**
Expand Down Expand Up @@ -1691,6 +1710,7 @@ public class Example {
| **200** | OK | - |
| **400** | Bad Request | - |
| **429** | Rate Limit Exceeded | - |
| **0** | Unexpected error | - |

<a name="getAliases"></a>
# **getAliases**
Expand Down Expand Up @@ -1768,6 +1788,7 @@ public class Example {
| **400** | Bad Request | - |
| **404** | Not Found | - |
| **429** | Rate Limit Exceeded | - |
| **0** | Unexpected error | - |

<a name="getAliasesBySubscription"></a>
# **getAliasesBySubscription**
Expand Down Expand Up @@ -1842,6 +1863,7 @@ public class Example {
| **200** | OK | - |
| **400** | Bad Request | - |
| **404** | Not Found | - |
| **0** | Unexpected error | - |

<a name="getApp"></a>
# **getApp**
Expand Down Expand Up @@ -1914,6 +1936,7 @@ public class Example {
| **200** | OK | - |
| **400** | Bad Request | - |
| **429** | Rate Limit Exceeded | - |
| **0** | Unexpected error | - |

<a name="getApps"></a>
# **getApps**
Expand Down Expand Up @@ -1982,6 +2005,7 @@ This endpoint does not need any parameter.
| **200** | OK | - |
| **400** | Bad Request | - |
| **429** | Rate Limit Exceeded | - |
| **0** | Unexpected error | - |

<a name="getNotification"></a>
# **getNotification**
Expand Down Expand Up @@ -2057,6 +2081,7 @@ public class Example {
| **400** | Bad Request | - |
| **404** | Not Found | - |
| **429** | Rate Limit Exceeded | - |
| **0** | Unexpected error | - |

<a name="getNotificationHistory"></a>
# **getNotificationHistory**
Expand Down Expand Up @@ -2132,10 +2157,11 @@ public class Example {
| **400** | Bad Request | - |
| **404** | Not Found | - |
| **429** | Rate Limit Exceeded | - |
| **0** | Unexpected error | - |

<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 +2191,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 +2217,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 All @@ -2210,6 +2238,7 @@ public class Example {
| **200** | OK | - |
| **400** | Bad Request | - |
| **429** | Rate Limit Exceeded | - |
| **0** | Unexpected error | - |

<a name="getOutcomes"></a>
# **getOutcomes**
Expand Down Expand Up @@ -2292,6 +2321,7 @@ public class Example {
| **200** | OK | - |
| **400** | Bad Request | - |
| **429** | Rate Limit Exceeded | - |
| **0** | Unexpected error | - |

<a name="getSegments"></a>
# **getSegments**
Expand Down Expand Up @@ -2368,6 +2398,7 @@ public class Example {
| **201** | OK | - |
| **400** | Bad Request | - |
| **429** | Rate Limit Exceeded | - |
| **0** | Unexpected error | - |

<a name="getUser"></a>
# **getUser**
Expand Down Expand Up @@ -2445,6 +2476,7 @@ public class Example {
| **400** | Bad Request | - |
| **404** | Not Found | - |
| **429** | Rate Limit Exceeded | - |
| **0** | Unexpected error | - |

<a name="rotateApiKey"></a>
# **rotateApiKey**
Expand Down Expand Up @@ -2518,6 +2550,7 @@ public class Example {
|-------------|-------------|------------------|
| **200** | OK | - |
| **400** | Bad Request | - |
| **0** | Unexpected error | - |

<a name="startLiveActivity"></a>
# **startLiveActivity**
Expand Down Expand Up @@ -2594,6 +2627,7 @@ public class Example {
| **201** | Created | - |
| **400** | Bad Request | - |
| **429** | Rate Limit Exceeded | - |
| **0** | Unexpected error | - |

<a name="transferSubscription"></a>
# **transferSubscription**
Expand Down Expand Up @@ -2672,6 +2706,7 @@ public class Example {
| **404** | Not Found | - |
| **409** | Conflict | - |
| **429** | Rate Limit Exceeded | - |
| **0** | Unexpected error | - |

<a name="unsubscribeEmailWithToken"></a>
# **unsubscribeEmailWithToken**
Expand Down Expand Up @@ -2748,6 +2783,7 @@ public class Example {
| **202** | OK | - |
| **400** | Bad Request | - |
| **429** | Rate Limit Exceeded | - |
| **0** | Unexpected error | - |

<a name="updateApiKey"></a>
# **updateApiKey**
Expand Down Expand Up @@ -2823,6 +2859,7 @@ public class Example {
|-------------|-------------|------------------|
| **200** | OK | - |
| **400** | Bad Request | - |
| **0** | Unexpected error | - |

<a name="updateApp"></a>
# **updateApp**
Expand Down Expand Up @@ -2897,6 +2934,7 @@ public class Example {
| **200** | OK | - |
| **400** | Bad Request | - |
| **429** | Rate Limit Exceeded | - |
| **0** | Unexpected error | - |

<a name="updateLiveActivity"></a>
# **updateLiveActivity**
Expand Down Expand Up @@ -2973,6 +3011,7 @@ public class Example {
| **200** | OK | - |
| **400** | Bad Request | - |
| **429** | Rate Limit Exceeded | - |
| **0** | Unexpected error | - |

<a name="updateSubscription"></a>
# **updateSubscription**
Expand Down Expand Up @@ -3050,6 +3089,7 @@ null (empty response body)
| **404** | Not Found | - |
| **409** | Conflict | - |
| **429** | Rate Limit Exceeded | - |
| **0** | Unexpected error | - |

<a name="updateSubscriptionByToken"></a>
# **updateSubscriptionByToken**
Expand Down Expand Up @@ -3128,6 +3168,7 @@ public class Example {
| **202** | ACCEPTED | - |
| **400** | Bad Request | - |
| **404** | Not Found | - |
| **0** | Unexpected error | - |

<a name="updateTemplate"></a>
# **updateTemplate**
Expand Down Expand Up @@ -3203,6 +3244,7 @@ public class Example {
|-------------|-------------|------------------|
| **200** | OK | - |
| **400** | Bad Request | - |
| **0** | Unexpected error | - |

<a name="updateUser"></a>
# **updateUser**
Expand Down Expand Up @@ -3282,6 +3324,7 @@ public class Example {
| **400** | Bad Request | - |
| **409** | Conflict | - |
| **429** | Rate Limit Exceeded | - |
| **0** | Unexpected error | - |

<a name="viewApiKeys"></a>
# **viewApiKeys**
Expand Down Expand Up @@ -3353,6 +3396,7 @@ public class Example {
|-------------|-------------|------------------|
| **200** | OK | - |
| **400** | Bad Request | - |
| **0** | Unexpected error | - |

<a name="viewTemplate"></a>
# **viewTemplate**
Expand Down Expand Up @@ -3427,6 +3471,7 @@ public class Example {
| **200** | OK | - |
| **400** | Bad Request | - |
| **404** | Not Found | - |
| **0** | Unexpected error | - |

<a name="viewTemplates"></a>
# **viewTemplates**
Expand Down Expand Up @@ -3505,4 +3550,5 @@ public class Example {
| **200** | OK | - |
| **400** | Bad Request | - |
| **429** | Rate Limit Exceeded | - |
| **0** | Unexpected error | - |

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
Loading