Skip to content

feat: add v5.12.0 package updates #98

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

Merged
sherwinski merged 1 commit into from
Aug 20, 2026
Merged

feat: add v5.12.0 package updates #98

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
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ A powerful way to send personalized messages at scale and build effective custom

For more information, please visit [https://onesignal.com](https://onesignal.com).

- API version: 5.11.2
- Package version: 5.11.2
- API version: 5.12.0
- Package version: 5.12.0

## Requirements

Expand Down
2 changes: 1 addition & 1 deletion composer.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "onesignal/onesignal-php-api",
"version": "5.11.2",
"version": "5.12.0",
"description": "A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com",
"keywords": [
"onesignal",
Expand Down
512 changes: 512 additions & 0 deletions docs/Api/DefaultApi.md
View file
Open in desktop

Large diffs are not rendered by default.

15 changes: 15 additions & 0 deletions docs/Model/CreateJourneyRequest.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# # CreateJourneyRequest

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **string** | Journey name, up to 300 characters. |
**description** | **string** | Optional journey description, up to 1024 characters. | [optional]
**audience** | [**\onesignal\client\model\JourneyAudience**](JourneyAudience.md) | | [optional]
**early_exit** | [**\onesignal\client\model\JourneyEarlyExit**](JourneyEarlyExit.md) | | [optional]
**reentry_rules** | [**\onesignal\client\model\JourneyReentryRules**](JourneyReentryRules.md) | | [optional]
**schedule** | [**\onesignal\client\model\JourneySchedule**](JourneySchedule.md) | | [optional]
**nodes** | [**\onesignal\client\model\JourneyNode[]**](JourneyNode.md) | Ordered list of journey nodes. Server-assigned id fields are rejected on create. | [optional]

[[Back to API list]](https://github.com/OneSignal/onesignal-php-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-php-api)
24 changes: 24 additions & 0 deletions docs/Model/Journey.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# # Journey

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **string** | Journey UUID. Read-only. | [optional]
**app_id** | **string** | UUID of the app the journey belongs to. Read-only. | [optional]
**name** | **string** | Journey name, up to 300 characters. | [optional]
**description** | **string** | Journey description, up to 1024 characters. Defaults to an empty string. | [optional]
**state** | **string** | Journey state. New journeys are created as draft. processing is transient while activation is in progress. archived is a journey that has been stopped. Change it through the state field on Update journey. | [optional]
**created_at** | **string** | ISO 8601 creation time. Read-only. | [optional]
**updated_at** | **string** | ISO 8601 last-update time. Read-only. | [optional]
**started_at** | **string** | ISO 8601 time the journey was activated, or null. Read-only. May stay null briefly after you set state to active: activation is enqueued, and started_at populates once the journey finishes processing. | [optional]
**archived_at** | **string** | ISO 8601 time the journey was archived, or null. Read-only. | [optional]
**created_source** | **string** | Origin of the journey, for example public_api or dashboard. Read-only. | [optional]
**audience** | [**\onesignal\client\model\JourneyAudience**](JourneyAudience.md) | | [optional]
**early_exit** | [**\onesignal\client\model\JourneyEarlyExit**](JourneyEarlyExit.md) | | [optional]
**reentry_rules** | [**\onesignal\client\model\JourneyReentryRules**](JourneyReentryRules.md) | | [optional]
**schedule** | [**\onesignal\client\model\JourneySchedule**](JourneySchedule.md) | | [optional]
**nodes** | [**\onesignal\client\model\JourneyNode[]**](JourneyNode.md) | Ordered list of journey nodes. | [optional]
**concurrency_key** | **string** | Opaque optimistic-concurrency token. Read-only. Pass it back on update to guard against overwriting a concurrent change (409). Send it back exactly as read; do not construct or parse it. | [optional]

[[Back to API list]](https://github.com/OneSignal/onesignal-php-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-php-api)
14 changes: 14 additions & 0 deletions docs/Model/JourneyAudience.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# # JourneyAudience

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**kind** | **string** | Audience kind. Selects which other fields apply. |
**included_segment_ids** | **string[]** | segment audiences: Segment UUIDs whose users enter the journey. | [optional]
**excluded_segment_ids** | **string[]** | segment audiences: Segment UUIDs whose users are excluded. | [optional]
**future_additions_only** | **bool** | segment audiences: when true, only users who newly match the segment after activation enter the journey. Defaults to false. | [optional]
**name** | **string** | event_trigger audiences: event name that triggers entry, up to 255 characters. | [optional]
**attributes** | **\onesignal\client\model\JourneyEventAttribute[][]** | Event attribute matchers, as a list of condition groups. Send a single group whose conditions are AND'd together. More than one group is rejected. | [optional]

[[Back to API list]](https://github.com/OneSignal/onesignal-php-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-php-api)
12 changes: 12 additions & 0 deletions docs/Model/JourneyBranch.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# # JourneyBranch

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **string** | Server-assigned branch identifier. Read-only on create; echo it on update to keep the branch. | [optional]
**condition** | [**\onesignal\client\model\JourneyCondition**](JourneyCondition.md) | | [optional]
**weight** | **float** | Branch weight for split_range nodes. Weights across a node's branches must sum to 100. | [optional]
**nodes** | [**\onesignal\client\model\JourneyNode[]**](JourneyNode.md) | Nodes run when this branch is taken, before flow converges to the next sibling node. | [optional]

[[Back to API list]](https://github.com/OneSignal/onesignal-php-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-php-api)
9 changes: 9 additions & 0 deletions docs/Model/JourneyBranchStats.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# # JourneyBranchStats

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**completed** | **int** | Users who took this branch. | [optional]

[[Back to API list]](https://github.com/OneSignal/onesignal-php-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-php-api)
17 changes: 17 additions & 0 deletions docs/Model/JourneyCondition.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# # JourneyCondition

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**kind** | **string** | Condition kind. Selects which other fields apply. |
**included_segment_ids** | **string[]** | segment_membership conditions: Segment UUIDs the user must belong to. | [optional]
**excluded_segment_ids** | **string[]** | segment_membership conditions: Segment UUIDs the user must not belong to. | [optional]
**action** | **string** | on_notification_action conditions: the notification action to branch on. Which actions apply depends on the sending node's channel. | [optional]
**sending_node_id** | **string** | on_notification_action conditions: id of the sending node this action refers to. Returned on reads; accepted on write. | [optional]
**client_node_id** | **string** | on_notification_action conditions: write-only alternative to sending_node_id. References the sending node by its client_node_id. | [optional]
**name** | **string** | event_trigger conditions: event name, up to 255 characters. | [optional]
**attributes** | **\onesignal\client\model\JourneyEventAttribute[][]** | Event attribute matchers, as a list of condition groups. Send a single group whose conditions are AND'd together. More than one group is rejected. | [optional]
**entry_event_match_attributes** | **object[]** | event_trigger conditions: match incoming event properties against the journey's entry event. Only valid on event-triggered journeys. | [optional]

[[Back to API list]](https://github.com/OneSignal/onesignal-php-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-php-api)
10 changes: 10 additions & 0 deletions docs/Model/JourneyEarlyExit.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# # JourneyEarlyExit

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**rules** | [**\onesignal\client\model\JourneyEarlyExitRules**](JourneyEarlyExitRules.md) | | [optional]
**tag_on_early_exit** | **array<string,string>** | Tag key-value pairs applied when a user exits early. | [optional]

[[Back to API list]](https://github.com/OneSignal/onesignal-php-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-php-api)
12 changes: 12 additions & 0 deletions docs/Model/JourneyEarlyExitRules.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# # JourneyEarlyExitRules

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**on_segment** | [**\onesignal\client\model\JourneyEarlyExitRulesOnSegment**](JourneyEarlyExitRulesOnSegment.md) | | [optional]
**when_not_in_audience** | **bool** | Exit when the user no longer matches the journey audience. Defaults to false. | [optional]
**on_session** | **bool** | Exit on a new session start. Defaults to false. | [optional]
**on_event** | [**\onesignal\client\model\JourneyEarlyExitRulesOnEvent**](JourneyEarlyExitRulesOnEvent.md) | | [optional]

[[Back to API list]](https://github.com/OneSignal/onesignal-php-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-php-api)
9 changes: 9 additions & 0 deletions docs/Model/JourneyEarlyExitRulesOnEvent.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# # JourneyEarlyExitRulesOnEvent

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **string** | Exit when this event occurs. Up to 255 characters. |

[[Back to API list]](https://github.com/OneSignal/onesignal-php-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-php-api)
9 changes: 9 additions & 0 deletions docs/Model/JourneyEarlyExitRulesOnSegment.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# # JourneyEarlyExitRulesOnSegment

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**included_segment_ids** | **string[]** | Exit when the user enters any of these segments. | [optional]

[[Back to API list]](https://github.com/OneSignal/onesignal-php-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-php-api)
11 changes: 11 additions & 0 deletions docs/Model/JourneyEventAttribute.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# # JourneyEventAttribute

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**key** | **string** | Event attribute key. |
**operator** | **string** | Comparison operator. |
**value** | **string** | Value to compare against. Not required for exists and not_exists. | [optional]

[[Back to API list]](https://github.com/OneSignal/onesignal-php-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-php-api)
9 changes: 9 additions & 0 deletions docs/Model/JourneyListAudience.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# # JourneyListAudience

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**kind** | **string** | Audience kind. | [optional]

[[Back to API list]](https://github.com/OneSignal/onesignal-php-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-php-api)
20 changes: 20 additions & 0 deletions docs/Model/JourneyListItem.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# # JourneyListItem

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **string** | Journey UUID. Read-only. | [optional]
**app_id** | **string** | UUID of the app the journey belongs to. Read-only. | [optional]
**name** | **string** | Journey name, up to 300 characters. | [optional]
**state** | **string** | Journey state. New journeys are created as draft. processing is transient while activation is in progress. archived is a journey that has been stopped. Change it through the state field on Update journey. | [optional]
**created_at** | **string** | ISO 8601 creation time. Read-only. | [optional]
**updated_at** | **string** | ISO 8601 last-update time. Read-only. | [optional]
**started_at** | **string** | ISO 8601 time the journey was activated, or null. Read-only. | [optional]
**archived_at** | **string** | ISO 8601 time the journey was archived, or null. Read-only. | [optional]
**created_source** | **string** | Origin of the journey, for example public_api or dashboard. Read-only. | [optional]
**schedule** | [**\onesignal\client\model\JourneySchedule**](JourneySchedule.md) | | [optional]
**audience** | [**\onesignal\client\model\JourneyListAudience**](JourneyListAudience.md) | | [optional]
**reentry_rules** | [**\onesignal\client\model\JourneyReentryRules**](JourneyReentryRules.md) | | [optional]

[[Back to API list]](https://github.com/OneSignal/onesignal-php-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-php-api)
11 changes: 11 additions & 0 deletions docs/Model/JourneyListResponse.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# # JourneyListResponse

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**journeys** | [**\onesignal\client\model\JourneyListItem[]**](JourneyListItem.md) | Journeys ordered by creation time, newest first. | [optional]
**has_more** | **bool** | true if more journeys exist beyond this page. | [optional]
**next_cursor** | **string** | Cursor for the next page. Present only when has_more is true. | [optional]

[[Back to API list]](https://github.com/OneSignal/onesignal-php-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-php-api)
9 changes: 9 additions & 0 deletions docs/Model/JourneyMessageStats.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# # JourneyMessageStats

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**totals** | **array<string,float>** | All-time totals for this node, keyed by channel-specific stat name. | [optional]

[[Back to API list]](https://github.com/OneSignal/onesignal-php-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-php-api)
25 changes: 25 additions & 0 deletions docs/Model/JourneyNode.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# # JourneyNode

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **string** | Server-assigned node UUID. Returned on reads. Required on update to keep an existing node. Rejected on create with a 400 validation error. | [optional]
**kind** | **string** | Node kind. Selects which other fields apply. |
**client_node_id** | **string** | Optional client-assigned identifier, unique within the journey. Use it to reference this node from elsewhere in the same request. Persisted and returned on reads. | [optional]
**annotation** | **string** | Optional free-text label, up to 255 characters. Stored and returned as-is with no effect on journey behavior. | [optional]
**duration_seconds** | **int** | wait nodes: seconds to hold the user. Minimum 60, maximum 31556952 (1 year). | [optional]
**relative_to** | **string** | time_window nodes: schedule_in_timezone uses the configured windows; last_active_time holds relative to the user&#39;s last active time. | [optional]
**windows** | [**\onesignal\client\model\JourneyTimeWindow[]**](JourneyTimeWindow.md) | time_window nodes: one or more time windows. A window with no day_of_week applies to every day. Required when relative_to is schedule_in_timezone; omit when it is last_active_time. | [optional]
**time_zone** | **string** | time_window nodes: IANA timezone identifier used when the user&#39;s timezone is unavailable. | [optional]
**use_user_time_zone** | **bool** | time_window nodes: when true, uses the user&#39;s timezone if available. | [optional]
**template_id** | **string** | send_push, send_email, and send_sms nodes: UUID of the template to send. | [optional]
**iam_id** | **string** | send_iam nodes: UUID of the in-app message to send. | [optional]
**user_ttl_seconds** | **int** | send_iam nodes: optional time-to-live for the in-app message, in seconds. | [optional]
**webhook_id** | **string** | send_webhook nodes: UUID of the webhook to send. | [optional]
**assignments** | **array<string,string>** | tag nodes: tag key-value pairs to assign. An empty string value removes the tag. Keys are limited to 255 characters and values to 1024. | [optional]
**randomize_on_entry** | **bool** | split_range nodes: when true, assigns each user to a branch at random on entry. Defaults to false. | [optional]
**branches** | [**\onesignal\client\model\JourneyBranch[]**](JourneyBranch.md) | Branching nodes: nested branches. split_range requires 2-20 weighted branches that sum to 100. yes_no requires exactly 2 branches. wait_until requires 1-10 condition branches. | [optional]
**expiration** | [**\onesignal\client\model\JourneyWaitUntilExpiration**](JourneyWaitUntilExpiration.md) | | [optional]

[[Back to API list]](https://github.com/OneSignal/onesignal-php-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-php-api)
13 changes: 13 additions & 0 deletions docs/Model/JourneyNodeStats.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# # JourneyNodeStats

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**kind** | **string** | Node kind, repeated here so stats can be read without joining against the journey definition. | [optional]
**waiting** | **int** | Users currently held at this node. | [optional]
**completed** | **int** | Users who advanced past this node normally. | [optional]
**exited_early** | **int** | Users who left the journey from this node through an early exit rule. | [optional]
**message_stats** | [**\onesignal\client\model\JourneyMessageStats**](JourneyMessageStats.md) | | [optional]

[[Back to API list]](https://github.com/OneSignal/onesignal-php-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-php-api)
9 changes: 9 additions & 0 deletions docs/Model/JourneyReentryRules.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# # JourneyReentryRules

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**duration_seconds** | **int** | Minimum seconds before a user can re-enter. Must be at least 600 (10 minutes). | [optional]

[[Back to API list]](https://github.com/OneSignal/onesignal-php-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-php-api)
11 changes: 11 additions & 0 deletions docs/Model/JourneySchedule.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# # JourneySchedule

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**start_at** | **string** | ISO 8601 start time. Use UTC (Z or +00:00). Must be at least 5 minutes in the future. | [optional]
**stop_at** | **string** | ISO 8601 stop time. Use UTC (Z or +00:00). Must be in the future and later than start_at. | [optional]
**error** | **string** | Read-only. Present when a scheduling error occurred. | [optional]

[[Back to API list]](https://github.com/OneSignal/onesignal-php-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-php-api)
14 changes: 14 additions & 0 deletions docs/Model/JourneyStats.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# # JourneyStats

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **string** | UUID of the journey these stats belong to. | [optional]
**started** | **int** | Users who entered the journey. | [optional]
**completed** | **int** | Users who reached the end of the journey normally. | [optional]
**exited_early** | **int** | Users who left the journey through an early exit rule. | [optional]
**nodes** | [**array<string,\onesignal\client\model\JourneyNodeStats>**](JourneyNodeStats.md) | Node stats keyed by node id. Includes every node in the graph, at any nesting depth. | [optional]
**branches** | [**array<string,\onesignal\client\model\JourneyBranchStats>**](JourneyBranchStats.md) | Branch stats keyed by branch id. Empty for a journey with no branching nodes. | [optional]

[[Back to API list]](https://github.com/OneSignal/onesignal-php-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-php-api)
10 changes: 10 additions & 0 deletions docs/Model/JourneyTimePoint.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# # JourneyTimePoint

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**hour** | **int** | Hour of day, 0-23. | [optional]
**minute** | **int** | Minute of hour, 0-59. Defaults to 0. | [optional]

[[Back to API list]](https://github.com/OneSignal/onesignal-php-api#full-api-reference) [[Back to README]](https://github.com/OneSignal/onesignal-php-api)
Loading