onesignal 5.11.2 → 5.12.0

data/docs/Journey.md

@@ -0,0 +1,48 @@
+# OneSignal::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** | [**JourneyAudience**](JourneyAudience.md) |  | [optional] |
+| **early_exit** | [**JourneyEarlyExit**](JourneyEarlyExit.md) |  | [optional] |
+| **reentry_rules** | [**JourneyReentryRules**](JourneyReentryRules.md) |  | [optional] |
+| **schedule** | [**JourneySchedule**](JourneySchedule.md) |  | [optional] |
+| **nodes** | [**Array<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] |
+
+## Example
+
+```ruby
+require 'onesignal'
+
+instance = OneSignal::Journey.new(
+  id: nil,
+  app_id: nil,
+  name: nil,
+  description: nil,
+  state: nil,
+  created_at: nil,
+  updated_at: nil,
+  started_at: nil,
+  archived_at: nil,
+  created_source: nil,
+  audience: nil,
+  early_exit: nil,
+  reentry_rules: nil,
+  schedule: nil,
+  nodes: nil,
+  concurrency_key: nil
+)
+```
+

data/docs/JourneyAudience.md

@@ -0,0 +1,28 @@
+# OneSignal::JourneyAudience
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **kind** | **String** | Audience kind. Selects which other fields apply. |  |
+| **included_segment_ids** | **Array<String>** | segment audiences: Segment UUIDs whose users enter the journey. | [optional] |
+| **excluded_segment_ids** | **Array<String>** | segment audiences: Segment UUIDs whose users are excluded. | [optional] |
+| **future_additions_only** | **Boolean** | 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** | **Array<Array<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] |
+
+## Example
+
+```ruby
+require 'onesignal'
+
+instance = OneSignal::JourneyAudience.new(
+  kind: nil,
+  included_segment_ids: nil,
+  excluded_segment_ids: nil,
+  future_additions_only: nil,
+  name: nil,
+  attributes: nil
+)
+```
+

data/docs/JourneyBranch.md

@@ -0,0 +1,24 @@
+# OneSignal::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** | [**JourneyCondition**](JourneyCondition.md) |  | [optional] |
+| **weight** | **Float** | Branch weight for split_range nodes. Weights across a node's branches must sum to 100. | [optional] |
+| **nodes** | [**Array<JourneyNode>**](JourneyNode.md) | Nodes run when this branch is taken, before flow converges to the next sibling node. | [optional] |
+
+## Example
+
+```ruby
+require 'onesignal'
+
+instance = OneSignal::JourneyBranch.new(
+  id: nil,
+  condition: nil,
+  weight: nil,
+  nodes: nil
+)
+```
+

data/docs/JourneyBranchStats.md

@@ -0,0 +1,18 @@
+# OneSignal::JourneyBranchStats
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **completed** | **Integer** | Users who took this branch. | [optional] |
+
+## Example
+
+```ruby
+require 'onesignal'
+
+instance = OneSignal::JourneyBranchStats.new(
+  completed: nil
+)
+```
+

data/docs/JourneyCondition.md

@@ -0,0 +1,34 @@
+# OneSignal::JourneyCondition
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **kind** | **String** | Condition kind. Selects which other fields apply. |  |
+| **included_segment_ids** | **Array<String>** | segment_membership conditions: Segment UUIDs the user must belong to. | [optional] |
+| **excluded_segment_ids** | **Array<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** | **Array<Array<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** | **Array<Object>** | event_trigger conditions: match incoming event properties against the journey's entry event. Only valid on event-triggered journeys. | [optional] |
+
+## Example
+
+```ruby
+require 'onesignal'
+
+instance = OneSignal::JourneyCondition.new(
+  kind: nil,
+  included_segment_ids: nil,
+  excluded_segment_ids: nil,
+  action: nil,
+  sending_node_id: nil,
+  client_node_id: nil,
+  name: nil,
+  attributes: nil,
+  entry_event_match_attributes: nil
+)
+```
+

data/docs/JourneyEarlyExit.md

@@ -0,0 +1,20 @@
+# OneSignal::JourneyEarlyExit
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **rules** | [**JourneyEarlyExitRules**](JourneyEarlyExitRules.md) |  | [optional] |
+| **tag_on_early_exit** | **Hash<String, String>** | Tag key-value pairs applied when a user exits early. | [optional] |
+
+## Example
+
+```ruby
+require 'onesignal'
+
+instance = OneSignal::JourneyEarlyExit.new(
+  rules: nil,
+  tag_on_early_exit: nil
+)
+```
+

data/docs/JourneyEarlyExitRules.md

@@ -0,0 +1,24 @@
+# OneSignal::JourneyEarlyExitRules
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **on_segment** | [**JourneyEarlyExitRulesOnSegment**](JourneyEarlyExitRulesOnSegment.md) |  | [optional] |
+| **when_not_in_audience** | **Boolean** | Exit when the user no longer matches the journey audience. Defaults to false. | [optional] |
+| **on_session** | **Boolean** | Exit on a new session start. Defaults to false. | [optional] |
+| **on_event** | [**JourneyEarlyExitRulesOnEvent**](JourneyEarlyExitRulesOnEvent.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'onesignal'
+
+instance = OneSignal::JourneyEarlyExitRules.new(
+  on_segment: nil,
+  when_not_in_audience: nil,
+  on_session: nil,
+  on_event: nil
+)
+```
+

data/docs/JourneyEarlyExitRulesOnEvent.md

@@ -0,0 +1,18 @@
+# OneSignal::JourneyEarlyExitRulesOnEvent
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | Exit when this event occurs. Up to 255 characters. |  |
+
+## Example
+
+```ruby
+require 'onesignal'
+
+instance = OneSignal::JourneyEarlyExitRulesOnEvent.new(
+  name: nil
+)
+```
+

data/docs/JourneyEarlyExitRulesOnSegment.md

@@ -0,0 +1,18 @@
+# OneSignal::JourneyEarlyExitRulesOnSegment
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **included_segment_ids** | **Array<String>** | Exit when the user enters any of these segments. | [optional] |
+
+## Example
+
+```ruby
+require 'onesignal'
+
+instance = OneSignal::JourneyEarlyExitRulesOnSegment.new(
+  included_segment_ids: nil
+)
+```
+

data/docs/JourneyEventAttribute.md

@@ -0,0 +1,22 @@
+# OneSignal::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] |
+
+## Example
+
+```ruby
+require 'onesignal'
+
+instance = OneSignal::JourneyEventAttribute.new(
+  key: nil,
+  operator: nil,
+  value: nil
+)
+```
+

data/docs/JourneyListAudience.md

@@ -0,0 +1,18 @@
+# OneSignal::JourneyListAudience
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **kind** | **String** | Audience kind. | [optional] |
+
+## Example
+
+```ruby
+require 'onesignal'
+
+instance = OneSignal::JourneyListAudience.new(
+  kind: nil
+)
+```
+

data/docs/JourneyListItem.md

@@ -0,0 +1,40 @@
+# OneSignal::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** | [**JourneySchedule**](JourneySchedule.md) |  | [optional] |
+| **audience** | [**JourneyListAudience**](JourneyListAudience.md) |  | [optional] |
+| **reentry_rules** | [**JourneyReentryRules**](JourneyReentryRules.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'onesignal'
+
+instance = OneSignal::JourneyListItem.new(
+  id: nil,
+  app_id: nil,
+  name: nil,
+  state: nil,
+  created_at: nil,
+  updated_at: nil,
+  started_at: nil,
+  archived_at: nil,
+  created_source: nil,
+  schedule: nil,
+  audience: nil,
+  reentry_rules: nil
+)
+```
+

data/docs/JourneyListResponse.md

@@ -0,0 +1,22 @@
+# OneSignal::JourneyListResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **journeys** | [**Array<JourneyListItem>**](JourneyListItem.md) | Journeys ordered by creation time, newest first. | [optional] |
+| **has_more** | **Boolean** | 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] |
+
+## Example
+
+```ruby
+require 'onesignal'
+
+instance = OneSignal::JourneyListResponse.new(
+  journeys: nil,
+  has_more: nil,
+  next_cursor: nil
+)
+```
+

data/docs/JourneyMessageStats.md

@@ -0,0 +1,18 @@
+# OneSignal::JourneyMessageStats
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **totals** | **Hash<String, Float>** | All-time totals for this node, keyed by channel-specific stat name. | [optional] |
+
+## Example
+
+```ruby
+require 'onesignal'
+
+instance = OneSignal::JourneyMessageStats.new(
+  totals: nil
+)
+```
+

data/docs/JourneyNode.md

@@ -0,0 +1,50 @@
+# OneSignal::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** | **Integer** | 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's last active time. | [optional] |
+| **windows** | [**Array<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's timezone is unavailable. | [optional] |
+| **use_user_time_zone** | **Boolean** | time_window nodes: when true, uses the user'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** | **Integer** | 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** | **Hash<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** | **Boolean** | split_range nodes: when true, assigns each user to a branch at random on entry. Defaults to false. | [optional] |
+| **branches** | [**Array<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** | [**JourneyWaitUntilExpiration**](JourneyWaitUntilExpiration.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'onesignal'
+
+instance = OneSignal::JourneyNode.new(
+  id: nil,
+  kind: nil,
+  client_node_id: nil,
+  annotation: nil,
+  duration_seconds: nil,
+  relative_to: nil,
+  windows: nil,
+  time_zone: nil,
+  use_user_time_zone: nil,
+  template_id: nil,
+  iam_id: nil,
+  user_ttl_seconds: nil,
+  webhook_id: nil,
+  assignments: nil,
+  randomize_on_entry: nil,
+  branches: nil,
+  expiration: nil
+)
+```
+

data/docs/JourneyNodeStats.md

@@ -0,0 +1,26 @@
+# OneSignal::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** | **Integer** | Users currently held at this node. | [optional] |
+| **completed** | **Integer** | Users who advanced past this node normally. | [optional] |
+| **exited_early** | **Integer** | Users who left the journey from this node through an early exit rule. | [optional] |
+| **message_stats** | [**JourneyMessageStats**](JourneyMessageStats.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'onesignal'
+
+instance = OneSignal::JourneyNodeStats.new(
+  kind: nil,
+  waiting: nil,
+  completed: nil,
+  exited_early: nil,
+  message_stats: nil
+)
+```
+

data/docs/JourneyReentryRules.md

@@ -0,0 +1,18 @@
+# OneSignal::JourneyReentryRules
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **duration_seconds** | **Integer** | Minimum seconds before a user can re-enter. Must be at least 600 (10 minutes). | [optional] |
+
+## Example
+
+```ruby
+require 'onesignal'
+
+instance = OneSignal::JourneyReentryRules.new(
+  duration_seconds: nil
+)
+```
+

data/docs/JourneySchedule.md

@@ -0,0 +1,22 @@
+# OneSignal::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] |
+
+## Example
+
+```ruby
+require 'onesignal'
+
+instance = OneSignal::JourneySchedule.new(
+  start_at: nil,
+  stop_at: nil,
+  error: nil
+)
+```
+

data/docs/JourneyStats.md

@@ -0,0 +1,28 @@
+# OneSignal::JourneyStats
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | UUID of the journey these stats belong to. | [optional] |
+| **started** | **Integer** | Users who entered the journey. | [optional] |
+| **completed** | **Integer** | Users who reached the end of the journey normally. | [optional] |
+| **exited_early** | **Integer** | Users who left the journey through an early exit rule. | [optional] |
+| **nodes** | [**Hash<String, JourneyNodeStats>**](JourneyNodeStats.md) | Node stats keyed by node id. Includes every node in the graph, at any nesting depth. | [optional] |
+| **branches** | [**Hash<String, JourneyBranchStats>**](JourneyBranchStats.md) | Branch stats keyed by branch id. Empty for a journey with no branching nodes. | [optional] |
+
+## Example
+
+```ruby
+require 'onesignal'
+
+instance = OneSignal::JourneyStats.new(
+  id: nil,
+  started: nil,
+  completed: nil,
+  exited_early: nil,
+  nodes: nil,
+  branches: nil
+)
+```
+

data/docs/JourneyTimePoint.md

@@ -0,0 +1,20 @@
+# OneSignal::JourneyTimePoint
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **hour** | **Integer** | Hour of day, 0-23. | [optional] |
+| **minute** | **Integer** | Minute of hour, 0-59. Defaults to 0. | [optional] |
+
+## Example
+
+```ruby
+require 'onesignal'
+
+instance = OneSignal::JourneyTimePoint.new(
+  hour: nil,
+  minute: nil
+)
+```
+

data/docs/JourneyTimeWindow.md

@@ -0,0 +1,22 @@
+# OneSignal::JourneyTimeWindow
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **start** | [**JourneyTimePoint**](JourneyTimePoint.md) | When the window opens. | [optional] |
+| **_end** | [**JourneyTimePoint**](JourneyTimePoint.md) | When the window closes. | [optional] |
+| **day_of_week** | **Integer** | Day of week, 1 = Monday. Omit to apply the window to every day. | [optional] |
+
+## Example
+
+```ruby
+require 'onesignal'
+
+instance = OneSignal::JourneyTimeWindow.new(
+  start: nil,
+  _end: nil,
+  day_of_week: nil
+)
+```
+

data/docs/JourneyWaitUntilExpiration.md

@@ -0,0 +1,20 @@
+# OneSignal::JourneyWaitUntilExpiration
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **duration_seconds** | **Integer** | Seconds to wait before the timer fires. Minimum 60, maximum 31556952 (1 year). | [optional] |
+| **exits** | **Boolean** | When true, the user exits the journey when the timer fires; when false, the user continues to convergence. | [optional] |
+
+## Example
+
+```ruby
+require 'onesignal'
+
+instance = OneSignal::JourneyWaitUntilExpiration.new(
+  duration_seconds: nil,
+  exits: nil
+)
+```
+

data/docs/UpdateJourneyNodeRequest.md

@@ -0,0 +1,48 @@
+# OneSignal::UpdateJourneyNodeRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **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** | **Integer** | 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's last active time. | [optional] |
+| **windows** | [**Array<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's timezone is unavailable. | [optional] |
+| **use_user_time_zone** | **Boolean** | time_window nodes: when true, uses the user'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** | **Integer** | 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** | **Hash<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** | **Boolean** | split_range nodes: when true, assigns each user to a branch at random on entry. Defaults to false. | [optional] |
+| **branches** | [**Array<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** | [**JourneyWaitUntilExpiration**](JourneyWaitUntilExpiration.md) |  | [optional] |
+| **concurrency_key** | **String** | Optional optimistic-concurrency token. Pass the concurrency_key from a prior fetch to reject the update with 409 if the journey changed. Omit to skip the check. It is not merged onto the node. | [optional] |
+
+## Example
+
+```ruby
+require 'onesignal'
+
+instance = OneSignal::UpdateJourneyNodeRequest.new(
+  client_node_id: nil,
+  annotation: nil,
+  duration_seconds: nil,
+  relative_to: nil,
+  windows: nil,
+  time_zone: nil,
+  use_user_time_zone: nil,
+  template_id: nil,
+  iam_id: nil,
+  user_ttl_seconds: nil,
+  webhook_id: nil,
+  assignments: nil,
+  randomize_on_entry: nil,
+  branches: nil,
+  expiration: nil,
+  concurrency_key: nil
+)
+```
+

data/docs/UpdateJourneyRequest.md

@@ -0,0 +1,34 @@
+# OneSignal::UpdateJourneyRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | Journey name. | [optional] |
+| **description** | **String** | Journey description. Send null to clear it. | [optional] |
+| **audience** | [**JourneyAudience**](JourneyAudience.md) |  | [optional] |
+| **early_exit** | [**JourneyEarlyExit**](JourneyEarlyExit.md) |  | [optional] |
+| **reentry_rules** | [**JourneyReentryRules**](JourneyReentryRules.md) |  | [optional] |
+| **schedule** | [**JourneySchedule**](JourneySchedule.md) |  | [optional] |
+| **nodes** | [**Array<JourneyNode>**](JourneyNode.md) | Full ordered list of nodes, which replaces the existing graph wholesale. Preserve each node's server-assigned id from a prior fetch to keep in-flight users on that node; omit id to add a new node. | [optional] |
+| **state** | **String** | Target state. Set active to activate a draft journey, or scheduled together with a future schedule.start_at to activate it later. Set archived to stop a running journey; archiving is permanent. Only scheduled and processing journeys can return to draft. | [optional] |
+| **concurrency_key** | **String** | Optional optimistic-concurrency token. Pass the concurrency_key from a prior fetch to reject the update with 409 if the journey changed. Omit to skip the check. | [optional] |
+
+## Example
+
+```ruby
+require 'onesignal'
+
+instance = OneSignal::UpdateJourneyRequest.new(
+  name: nil,
+  description: nil,
+  audience: nil,
+  early_exit: nil,
+  reentry_rules: nil,
+  schedule: nil,
+  nodes: nil,
+  state: nil,
+  concurrency_key: nil
+)
+```
+