onesignal 5.11.2 → 5.12.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (94) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +2 -0
  3. data/Gemfile.lock +1 -1
  4. data/README.md +3 -3
  5. data/docs/CreateJourneyRequest.md +30 -0
  6. data/docs/DefaultApi.md +563 -0
  7. data/docs/Journey.md +48 -0
  8. data/docs/JourneyAudience.md +28 -0
  9. data/docs/JourneyBranch.md +24 -0
  10. data/docs/JourneyBranchStats.md +18 -0
  11. data/docs/JourneyCondition.md +34 -0
  12. data/docs/JourneyEarlyExit.md +20 -0
  13. data/docs/JourneyEarlyExitRules.md +24 -0
  14. data/docs/JourneyEarlyExitRulesOnEvent.md +18 -0
  15. data/docs/JourneyEarlyExitRulesOnSegment.md +18 -0
  16. data/docs/JourneyEventAttribute.md +22 -0
  17. data/docs/JourneyListAudience.md +18 -0
  18. data/docs/JourneyListItem.md +40 -0
  19. data/docs/JourneyListResponse.md +22 -0
  20. data/docs/JourneyMessageStats.md +18 -0
  21. data/docs/JourneyNode.md +50 -0
  22. data/docs/JourneyNodeStats.md +26 -0
  23. data/docs/JourneyReentryRules.md +18 -0
  24. data/docs/JourneySchedule.md +22 -0
  25. data/docs/JourneyStats.md +28 -0
  26. data/docs/JourneyTimePoint.md +20 -0
  27. data/docs/JourneyTimeWindow.md +22 -0
  28. data/docs/JourneyWaitUntilExpiration.md +20 -0
  29. data/docs/UpdateJourneyNodeRequest.md +48 -0
  30. data/docs/UpdateJourneyRequest.md +34 -0
  31. data/lib/onesignal/api/default_api.rb +524 -0
  32. data/lib/onesignal/api_client.rb +1 -1
  33. data/lib/onesignal/models/create_journey_request.rb +287 -0
  34. data/lib/onesignal/models/journey.rb +409 -0
  35. data/lib/onesignal/models/journey_audience.rb +316 -0
  36. data/lib/onesignal/models/journey_branch.rb +250 -0
  37. data/lib/onesignal/models/journey_branch_stats.rb +220 -0
  38. data/lib/onesignal/models/journey_condition.rb +360 -0
  39. data/lib/onesignal/models/journey_early_exit.rb +231 -0
  40. data/lib/onesignal/models/journey_early_exit_rules.rb +251 -0
  41. data/lib/onesignal/models/journey_early_exit_rules_on_event.rb +224 -0
  42. data/lib/onesignal/models/journey_early_exit_rules_on_segment.rb +221 -0
  43. data/lib/onesignal/models/journey_event_attribute.rb +283 -0
  44. data/lib/onesignal/models/journey_list_audience.rb +254 -0
  45. data/lib/onesignal/models/journey_list_item.rb +366 -0
  46. data/lib/onesignal/models/journey_list_response.rb +241 -0
  47. data/lib/onesignal/models/journey_message_stats.rb +222 -0
  48. data/lib/onesignal/models/journey_node.rb +480 -0
  49. data/lib/onesignal/models/journey_node_stats.rb +293 -0
  50. data/lib/onesignal/models/journey_reentry_rules.rb +236 -0
  51. data/lib/onesignal/models/journey_schedule.rb +243 -0
  52. data/lib/onesignal/models/journey_stats.rb +274 -0
  53. data/lib/onesignal/models/journey_time_point.rb +277 -0
  54. data/lib/onesignal/models/journey_time_window.rb +266 -0
  55. data/lib/onesignal/models/journey_wait_until_expiration.rb +256 -0
  56. data/lib/onesignal/models/update_journey_node_request.rb +454 -0
  57. data/lib/onesignal/models/update_journey_request.rb +337 -0
  58. data/lib/onesignal/version.rb +1 -1
  59. data/lib/onesignal.rb +25 -0
  60. data/spec/api/default_api_spec.rb +95 -0
  61. data/spec/models/create_journey_request_spec.rb +69 -0
  62. data/spec/models/journey_audience_spec.rb +67 -0
  63. data/spec/models/journey_branch_spec.rb +51 -0
  64. data/spec/models/journey_branch_stats_spec.rb +33 -0
  65. data/spec/models/journey_condition_spec.rb +89 -0
  66. data/spec/models/journey_early_exit_rules_on_event_spec.rb +33 -0
  67. data/spec/models/journey_early_exit_rules_on_segment_spec.rb +33 -0
  68. data/spec/models/journey_early_exit_rules_spec.rb +51 -0
  69. data/spec/models/journey_early_exit_spec.rb +39 -0
  70. data/spec/models/journey_event_attribute_spec.rb +49 -0
  71. data/spec/models/journey_list_audience_spec.rb +37 -0
  72. data/spec/models/journey_list_item_spec.rb +103 -0
  73. data/spec/models/journey_list_response_spec.rb +45 -0
  74. data/spec/models/journey_message_stats_spec.rb +33 -0
  75. data/spec/models/journey_node_spec.rb +137 -0
  76. data/spec/models/journey_node_stats_spec.rb +61 -0
  77. data/spec/models/journey_reentry_rules_spec.rb +33 -0
  78. data/spec/models/journey_schedule_spec.rb +45 -0
  79. data/spec/models/journey_spec.rb +127 -0
  80. data/spec/models/journey_stats_spec.rb +63 -0
  81. data/spec/models/journey_time_point_spec.rb +39 -0
  82. data/spec/models/journey_time_window_spec.rb +45 -0
  83. data/spec/models/journey_wait_until_expiration_spec.rb +39 -0
  84. data/spec/models/update_journey_node_request_spec.rb +127 -0
  85. data/spec/models/update_journey_request_spec.rb +85 -0
  86. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/byebug-13.0.0/gem_make.out +5 -5
  87. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/date-3.5.1/gem_make.out +5 -5
  88. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/io-console-0.9.2/gem_make.out +5 -5
  89. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/io-console-0.9.2/mkmf.log +3 -3
  90. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/jaro_winkler-1.5.6/gem_make.out +5 -5
  91. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/psych-5.4.0/gem_make.out +5 -5
  92. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/racc-1.8.1/gem_make.out +5 -5
  93. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/stringio-3.2.0/gem_make.out +5 -5
  94. metadata +102 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 54b2a62f0fe5276c23dd4830e357f026f084cd880f1703ecf32b5fe86e25b899
4
- data.tar.gz: 889a59c5672fec79653a9d3737583673e24b6e5a53878dacec66bb6be1d80f4c
3
+ metadata.gz: 27bd25cedecc4400ebd5c5b3ba54705730aa708b4e061342044d05369864056c
4
+ data.tar.gz: fa05c3df694bafe71db0473036e303ea99db1a6eae2c9cc92b8dc83622599725
5
5
  SHA512:
6
- metadata.gz: adcf6b1ffa27fb65b7b284d17996facb9d36e2ed8960d5183e0ef660f3a872cb9b9ba5fa69fe83f4efcbf7b761bc9eebe0126f8366fa142a5248764aa69f5171
7
- data.tar.gz: 601d573c75a3296a42e87290aadbc45dda761337f2e5725452a336d3d30ed5d14a2a1e868cff7dfbd5bacb1bb41e43ca827be53eba44a12315ce3f7a1df4c3ad
6
+ metadata.gz: '00911ff2d2543fa8e34a01a9592f77255355c371c980274bfabe14616f14a5616005f75f06b164d8b2ad4a52c258ce820c76519e078d424ccf972f7175bc49cb'
7
+ data.tar.gz: b4656a05741829e8ed2b95056a1094ab002460cd161ae9afac540e0ab51695fba3d699b94239a2a34b88673017e491dd70db2064b29b1f4ad3c6bc461385fa89
data/CHANGELOG.md CHANGED
@@ -1,5 +1,7 @@
1
1
  # Changelog
2
2
 
3
+ ## [5.11.2](https://github.com/OneSignal/onesignal-ruby-api/compare/v5.11.1...v5.11.2) (2026-08-12)
4
+
3
5
  ## [5.11.1](https://github.com/OneSignal/onesignal-ruby-api/compare/v5.11.0...v5.11.1) (2026-07-29)
4
6
 
5
7
  ## [5.11.0](https://github.com/OneSignal/onesignal-ruby-api/compare/v5.10.0...v5.11.0) (2026-07-28)
data/Gemfile.lock CHANGED
@@ -1,7 +1,7 @@
1
1
  PATH
2
2
  remote: .
3
3
  specs:
4
- onesignal (5.11.2)
4
+ onesignal (5.12.0)
5
5
  typhoeus (~> 1.0, >= 1.0.1)
6
6
 
7
7
  GEM
data/README.md CHANGED
@@ -6,15 +6,15 @@ OneSignal - the Ruby gem for OneSignal
6
6
 
7
7
  A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com
8
8
 
9
- - API version: 5.11.2
10
- - Package version: 5.11.2
9
+ - API version: 5.12.0
10
+ - Package version: 5.12.0
11
11
 
12
12
  ## Installation
13
13
 
14
14
  Add to your `Gemfile`:
15
15
 
16
16
  ```ruby
17
- gem 'onesignal', '~> 5.11.2'
17
+ gem 'onesignal', '~> 5.12.0'
18
18
  ```
19
19
 
20
20
  Then run `bundle install`.
@@ -0,0 +1,30 @@
1
+ # OneSignal::CreateJourneyRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **name** | **String** | Journey name, up to 300 characters. | |
8
+ | **description** | **String** | Optional journey description, up to 1024 characters. | [optional] |
9
+ | **audience** | [**JourneyAudience**](JourneyAudience.md) | | [optional] |
10
+ | **early_exit** | [**JourneyEarlyExit**](JourneyEarlyExit.md) | | [optional] |
11
+ | **reentry_rules** | [**JourneyReentryRules**](JourneyReentryRules.md) | | [optional] |
12
+ | **schedule** | [**JourneySchedule**](JourneySchedule.md) | | [optional] |
13
+ | **nodes** | [**Array<JourneyNode>**](JourneyNode.md) | Ordered list of journey nodes. Server-assigned id fields are rejected on create. | [optional] |
14
+
15
+ ## Example
16
+
17
+ ```ruby
18
+ require 'onesignal'
19
+
20
+ instance = OneSignal::CreateJourneyRequest.new(
21
+ name: nil,
22
+ description: nil,
23
+ audience: nil,
24
+ early_exit: nil,
25
+ reentry_rules: nil,
26
+ schedule: nil,
27
+ nodes: nil
28
+ )
29
+ ```
30
+
data/docs/DefaultApi.md CHANGED
@@ -11,6 +11,7 @@ All URIs are relative to *https://api.onesignal.com*
11
11
  | [**create_api_key**](DefaultApi.md#create_api_key) | **POST** /apps/{app_id}/auth/tokens | Create API key |
12
12
  | [**create_app**](DefaultApi.md#create_app) | **POST** /apps | Create an app |
13
13
  | [**create_custom_events**](DefaultApi.md#create_custom_events) | **POST** /apps/{app_id}/custom_events | Create custom events |
14
+ | [**create_journey**](DefaultApi.md#create_journey) | **POST** /apps/{app_id}/journeys | Create journey |
14
15
  | [**create_notification**](DefaultApi.md#create_notification) | **POST** /notifications | Create notification |
15
16
  | [**create_segment**](DefaultApi.md#create_segment) | **POST** /apps/{app_id}/segments | Create Segment |
16
17
  | [**create_subscription**](DefaultApi.md#create_subscription) | **POST** /apps/{app_id}/users/by/{alias_label}/{alias_id}/subscriptions | |
@@ -18,6 +19,7 @@ All URIs are relative to *https://api.onesignal.com*
18
19
  | [**create_user**](DefaultApi.md#create_user) | **POST** /apps/{app_id}/users | |
19
20
  | [**delete_alias**](DefaultApi.md#delete_alias) | **DELETE** /apps/{app_id}/users/by/{alias_label}/{alias_id}/identity/{alias_label_to_delete} | |
20
21
  | [**delete_api_key**](DefaultApi.md#delete_api_key) | **DELETE** /apps/{app_id}/auth/tokens/{token_id} | Delete API key |
22
+ | [**delete_journey**](DefaultApi.md#delete_journey) | **DELETE** /apps/{app_id}/journeys/{journey_id} | Delete journey |
21
23
  | [**delete_segment**](DefaultApi.md#delete_segment) | **DELETE** /apps/{app_id}/segments/{segment_id} | Delete Segment |
22
24
  | [**delete_subscription**](DefaultApi.md#delete_subscription) | **DELETE** /apps/{app_id}/subscriptions/{subscription_id} | |
23
25
  | [**delete_template**](DefaultApi.md#delete_template) | **DELETE** /templates/{template_id} | Delete template |
@@ -42,6 +44,8 @@ All URIs are relative to *https://api.onesignal.com*
42
44
  | [**unsubscribe_email_with_token**](DefaultApi.md#unsubscribe_email_with_token) | **POST** /apps/{app_id}/notifications/{notification_id}/unsubscribe | Unsubscribe with token |
43
45
  | [**update_api_key**](DefaultApi.md#update_api_key) | **PATCH** /apps/{app_id}/auth/tokens/{token_id} | Update API key |
44
46
  | [**update_app**](DefaultApi.md#update_app) | **PUT** /apps/{app_id} | Update an app |
47
+ | [**update_journey**](DefaultApi.md#update_journey) | **PATCH** /apps/{app_id}/journeys/{journey_id} | Update journey |
48
+ | [**update_journey_node**](DefaultApi.md#update_journey_node) | **PATCH** /apps/{app_id}/journeys/{journey_id}/nodes/{node_id} | Update journey node |
45
49
  | [**update_live_activity**](DefaultApi.md#update_live_activity) | **POST** /apps/{app_id}/live_activities/{activity_id}/notifications | Update a Live Activity via Push |
46
50
  | [**update_segment**](DefaultApi.md#update_segment) | **PATCH** /apps/{app_id}/segments/{segment_id} | Update Segment |
47
51
  | [**update_subscription**](DefaultApi.md#update_subscription) | **PATCH** /apps/{app_id}/subscriptions/{subscription_id} | |
@@ -49,6 +53,9 @@ All URIs are relative to *https://api.onesignal.com*
49
53
  | [**update_template**](DefaultApi.md#update_template) | **PATCH** /templates/{template_id} | Update template |
50
54
  | [**update_user**](DefaultApi.md#update_user) | **PATCH** /apps/{app_id}/users/by/{alias_label}/{alias_id} | |
51
55
  | [**view_api_keys**](DefaultApi.md#view_api_keys) | **GET** /apps/{app_id}/auth/tokens | View API keys |
56
+ | [**view_journey**](DefaultApi.md#view_journey) | **GET** /apps/{app_id}/journeys/{journey_id} | View journey |
57
+ | [**view_journey_stats**](DefaultApi.md#view_journey_stats) | **GET** /apps/{app_id}/journeys/{journey_id}/stats | View journey stats |
58
+ | [**view_journeys**](DefaultApi.md#view_journeys) | **GET** /apps/{app_id}/journeys | View journeys |
52
59
  | [**view_template**](DefaultApi.md#view_template) | **GET** /templates/{template_id} | View template |
53
60
  | [**view_templates**](DefaultApi.md#view_templates) | **GET** /templates | View templates |
54
61
 
@@ -640,6 +647,84 @@ end
640
647
  - **Accept**: application/json
641
648
 
642
649
 
650
+ ## create_journey
651
+
652
+ > <Journey> create_journey(app_id, create_journey_request)
653
+
654
+ Create journey
655
+
656
+ The Journeys API is in beta. Endpoints and response fields can still change. Create a new journey with an audience and a node graph. Journeys are always created in the draft state. The authenticated App API key must have permission to create journeys.
657
+
658
+ ### Examples
659
+
660
+ ```ruby
661
+ require 'onesignal'
662
+ # setup authorization
663
+ OneSignal.configure do |config|
664
+ # Configure Bearer authorization: rest_api_key
665
+ config.rest_api_key = 'YOUR_REST_API_KEY'
666
+
667
+ end
668
+
669
+ api_instance = OneSignal::DefaultApi.new
670
+ app_id = 'YOUR_APP_ID' # String | Your OneSignal App ID in UUID v4 format.
671
+ create_journey_request = OneSignal::CreateJourneyRequest.new({name: 'name_example'}) # CreateJourneyRequest |
672
+
673
+ begin
674
+ # Create journey
675
+ result = api_instance.create_journey(app_id, create_journey_request)
676
+ p result
677
+ rescue OneSignal::ApiError => e
678
+ puts "Error when calling DefaultApi->create_journey: #{e}"
679
+ puts "Status Code: #{e.code}"
680
+ # `e.error_messages` flattens any error-envelope shape to an Array<String>;
681
+ # the raw body remains on `e.response_body`.
682
+ puts "Error Messages: #{e.error_messages}"
683
+ puts "Response Body: #{e.response_body}"
684
+ end
685
+ ```
686
+
687
+ #### Using the create_journey_with_http_info variant
688
+
689
+ This returns an Array which contains the response data, status code and headers.
690
+
691
+ > <Array(<Journey>, Integer, Hash)> create_journey_with_http_info(app_id, create_journey_request)
692
+
693
+ ```ruby
694
+ begin
695
+ # Create journey
696
+ data, status_code, headers = api_instance.create_journey_with_http_info(app_id, create_journey_request)
697
+ p status_code # => 2xx
698
+ p headers # => { ... }
699
+ p data # => <Journey>
700
+ rescue OneSignal::ApiError => e
701
+ puts "Error when calling DefaultApi->create_journey_with_http_info: #{e}"
702
+ puts "Status Code: #{e.code}"
703
+ puts "Response Body: #{e.response_body}"
704
+ end
705
+ ```
706
+
707
+ ### Parameters
708
+
709
+ | Name | Type | Description | Notes |
710
+ | ---- | ---- | ----------- | ----- |
711
+ | **app_id** | **String** | Your OneSignal App ID in UUID v4 format. | |
712
+ | **create_journey_request** | [**CreateJourneyRequest**](CreateJourneyRequest.md) | | |
713
+
714
+ ### Return type
715
+
716
+ [**Journey**](Journey.md)
717
+
718
+ ### Authorization
719
+
720
+ [rest_api_key](https://github.com/OneSignal/onesignal-ruby-api#configuration)
721
+
722
+ ### HTTP request headers
723
+
724
+ - **Content-Type**: application/json
725
+ - **Accept**: application/json
726
+
727
+
643
728
  ## create_notification
644
729
 
645
730
  > <CreateNotificationSuccessResponse> create_notification(notification)
@@ -1262,6 +1347,84 @@ end
1262
1347
  - **Accept**: application/json
1263
1348
 
1264
1349
 
1350
+ ## delete_journey
1351
+
1352
+ > <GenericSuccessBoolResponse> delete_journey(app_id, journey_id)
1353
+
1354
+ Delete journey
1355
+
1356
+ The Journeys API is in beta. Endpoints and response fields can still change. Permanently delete a journey by its UUID. Returns { \"success\": true } on success. The authenticated App API key must have permission to delete journeys. Deleting a journey stops any in-flight users and cannot be undone. Archive a running journey instead if you need to keep its data.
1357
+
1358
+ ### Examples
1359
+
1360
+ ```ruby
1361
+ require 'onesignal'
1362
+ # setup authorization
1363
+ OneSignal.configure do |config|
1364
+ # Configure Bearer authorization: rest_api_key
1365
+ config.rest_api_key = 'YOUR_REST_API_KEY'
1366
+
1367
+ end
1368
+
1369
+ api_instance = OneSignal::DefaultApi.new
1370
+ app_id = 'YOUR_APP_ID' # String | Your OneSignal App ID in UUID v4 format.
1371
+ journey_id = 'YOUR_JOURNEY_ID' # String | UUID of the journey to delete.
1372
+
1373
+ begin
1374
+ # Delete journey
1375
+ result = api_instance.delete_journey(app_id, journey_id)
1376
+ p result
1377
+ rescue OneSignal::ApiError => e
1378
+ puts "Error when calling DefaultApi->delete_journey: #{e}"
1379
+ puts "Status Code: #{e.code}"
1380
+ # `e.error_messages` flattens any error-envelope shape to an Array<String>;
1381
+ # the raw body remains on `e.response_body`.
1382
+ puts "Error Messages: #{e.error_messages}"
1383
+ puts "Response Body: #{e.response_body}"
1384
+ end
1385
+ ```
1386
+
1387
+ #### Using the delete_journey_with_http_info variant
1388
+
1389
+ This returns an Array which contains the response data, status code and headers.
1390
+
1391
+ > <Array(<GenericSuccessBoolResponse>, Integer, Hash)> delete_journey_with_http_info(app_id, journey_id)
1392
+
1393
+ ```ruby
1394
+ begin
1395
+ # Delete journey
1396
+ data, status_code, headers = api_instance.delete_journey_with_http_info(app_id, journey_id)
1397
+ p status_code # => 2xx
1398
+ p headers # => { ... }
1399
+ p data # => <GenericSuccessBoolResponse>
1400
+ rescue OneSignal::ApiError => e
1401
+ puts "Error when calling DefaultApi->delete_journey_with_http_info: #{e}"
1402
+ puts "Status Code: #{e.code}"
1403
+ puts "Response Body: #{e.response_body}"
1404
+ end
1405
+ ```
1406
+
1407
+ ### Parameters
1408
+
1409
+ | Name | Type | Description | Notes |
1410
+ | ---- | ---- | ----------- | ----- |
1411
+ | **app_id** | **String** | Your OneSignal App ID in UUID v4 format. | |
1412
+ | **journey_id** | **String** | UUID of the journey to delete. | |
1413
+
1414
+ ### Return type
1415
+
1416
+ [**GenericSuccessBoolResponse**](GenericSuccessBoolResponse.md)
1417
+
1418
+ ### Authorization
1419
+
1420
+ [rest_api_key](https://github.com/OneSignal/onesignal-ruby-api#configuration)
1421
+
1422
+ ### HTTP request headers
1423
+
1424
+ - **Content-Type**: Not defined
1425
+ - **Accept**: application/json
1426
+
1427
+
1265
1428
  ## delete_segment
1266
1429
 
1267
1430
  > <GenericSuccessBoolResponse> delete_segment(app_id, segment_id)
@@ -3189,6 +3352,168 @@ end
3189
3352
  - **Accept**: application/json
3190
3353
 
3191
3354
 
3355
+ ## update_journey
3356
+
3357
+ > <Journey> update_journey(app_id, journey_id, update_journey_request)
3358
+
3359
+ Update journey
3360
+
3361
+ The Journeys API is in beta. Endpoints and response fields can still change. Apply a partial update to a journey using JSON Merge Patch (RFC 7396). Send only the fields you want to change; omitted fields are left unchanged. A null value clears a nullable field, and arrays such as nodes are replaced wholesale. Set state to active to activate a draft journey.
3362
+
3363
+ ### Examples
3364
+
3365
+ ```ruby
3366
+ require 'onesignal'
3367
+ # setup authorization
3368
+ OneSignal.configure do |config|
3369
+ # Configure Bearer authorization: rest_api_key
3370
+ config.rest_api_key = 'YOUR_REST_API_KEY'
3371
+
3372
+ end
3373
+
3374
+ api_instance = OneSignal::DefaultApi.new
3375
+ app_id = 'YOUR_APP_ID' # String | Your OneSignal App ID in UUID v4 format.
3376
+ journey_id = 'YOUR_JOURNEY_ID' # String | UUID of the journey to update.
3377
+ update_journey_request = OneSignal::UpdateJourneyRequest.new # UpdateJourneyRequest |
3378
+
3379
+ begin
3380
+ # Update journey
3381
+ result = api_instance.update_journey(app_id, journey_id, update_journey_request)
3382
+ p result
3383
+ rescue OneSignal::ApiError => e
3384
+ puts "Error when calling DefaultApi->update_journey: #{e}"
3385
+ puts "Status Code: #{e.code}"
3386
+ # `e.error_messages` flattens any error-envelope shape to an Array<String>;
3387
+ # the raw body remains on `e.response_body`.
3388
+ puts "Error Messages: #{e.error_messages}"
3389
+ puts "Response Body: #{e.response_body}"
3390
+ end
3391
+ ```
3392
+
3393
+ #### Using the update_journey_with_http_info variant
3394
+
3395
+ This returns an Array which contains the response data, status code and headers.
3396
+
3397
+ > <Array(<Journey>, Integer, Hash)> update_journey_with_http_info(app_id, journey_id, update_journey_request)
3398
+
3399
+ ```ruby
3400
+ begin
3401
+ # Update journey
3402
+ data, status_code, headers = api_instance.update_journey_with_http_info(app_id, journey_id, update_journey_request)
3403
+ p status_code # => 2xx
3404
+ p headers # => { ... }
3405
+ p data # => <Journey>
3406
+ rescue OneSignal::ApiError => e
3407
+ puts "Error when calling DefaultApi->update_journey_with_http_info: #{e}"
3408
+ puts "Status Code: #{e.code}"
3409
+ puts "Response Body: #{e.response_body}"
3410
+ end
3411
+ ```
3412
+
3413
+ ### Parameters
3414
+
3415
+ | Name | Type | Description | Notes |
3416
+ | ---- | ---- | ----------- | ----- |
3417
+ | **app_id** | **String** | Your OneSignal App ID in UUID v4 format. | |
3418
+ | **journey_id** | **String** | UUID of the journey to update. | |
3419
+ | **update_journey_request** | [**UpdateJourneyRequest**](UpdateJourneyRequest.md) | | |
3420
+
3421
+ ### Return type
3422
+
3423
+ [**Journey**](Journey.md)
3424
+
3425
+ ### Authorization
3426
+
3427
+ [rest_api_key](https://github.com/OneSignal/onesignal-ruby-api#configuration)
3428
+
3429
+ ### HTTP request headers
3430
+
3431
+ - **Content-Type**: application/json
3432
+ - **Accept**: application/json
3433
+
3434
+
3435
+ ## update_journey_node
3436
+
3437
+ > <Journey> update_journey_node(app_id, journey_id, node_id, update_journey_node_request)
3438
+
3439
+ Update journey node
3440
+
3441
+ The Journeys API is in beta. Endpoints and response fields can still change. Apply a partial update to a single node, located by its server-assigned id, using JSON Merge Patch (RFC 7396). Send only the node fields you want to change; the rest of the node and the rest of the journey graph are left untouched. Returns the full updated journey.
3442
+
3443
+ ### Examples
3444
+
3445
+ ```ruby
3446
+ require 'onesignal'
3447
+ # setup authorization
3448
+ OneSignal.configure do |config|
3449
+ # Configure Bearer authorization: rest_api_key
3450
+ config.rest_api_key = 'YOUR_REST_API_KEY'
3451
+
3452
+ end
3453
+
3454
+ api_instance = OneSignal::DefaultApi.new
3455
+ app_id = 'YOUR_APP_ID' # String | Your OneSignal App ID in UUID v4 format.
3456
+ journey_id = 'YOUR_JOURNEY_ID' # String | UUID of the journey that owns the node.
3457
+ node_id = 'YOUR_NODE_ID' # String | Server-assigned UUID of the node to update, from a prior View journey fetch.
3458
+ update_journey_node_request = OneSignal::UpdateJourneyNodeRequest.new # UpdateJourneyNodeRequest |
3459
+
3460
+ begin
3461
+ # Update journey node
3462
+ result = api_instance.update_journey_node(app_id, journey_id, node_id, update_journey_node_request)
3463
+ p result
3464
+ rescue OneSignal::ApiError => e
3465
+ puts "Error when calling DefaultApi->update_journey_node: #{e}"
3466
+ puts "Status Code: #{e.code}"
3467
+ # `e.error_messages` flattens any error-envelope shape to an Array<String>;
3468
+ # the raw body remains on `e.response_body`.
3469
+ puts "Error Messages: #{e.error_messages}"
3470
+ puts "Response Body: #{e.response_body}"
3471
+ end
3472
+ ```
3473
+
3474
+ #### Using the update_journey_node_with_http_info variant
3475
+
3476
+ This returns an Array which contains the response data, status code and headers.
3477
+
3478
+ > <Array(<Journey>, Integer, Hash)> update_journey_node_with_http_info(app_id, journey_id, node_id, update_journey_node_request)
3479
+
3480
+ ```ruby
3481
+ begin
3482
+ # Update journey node
3483
+ data, status_code, headers = api_instance.update_journey_node_with_http_info(app_id, journey_id, node_id, update_journey_node_request)
3484
+ p status_code # => 2xx
3485
+ p headers # => { ... }
3486
+ p data # => <Journey>
3487
+ rescue OneSignal::ApiError => e
3488
+ puts "Error when calling DefaultApi->update_journey_node_with_http_info: #{e}"
3489
+ puts "Status Code: #{e.code}"
3490
+ puts "Response Body: #{e.response_body}"
3491
+ end
3492
+ ```
3493
+
3494
+ ### Parameters
3495
+
3496
+ | Name | Type | Description | Notes |
3497
+ | ---- | ---- | ----------- | ----- |
3498
+ | **app_id** | **String** | Your OneSignal App ID in UUID v4 format. | |
3499
+ | **journey_id** | **String** | UUID of the journey that owns the node. | |
3500
+ | **node_id** | **String** | Server-assigned UUID of the node to update, from a prior View journey fetch. | |
3501
+ | **update_journey_node_request** | [**UpdateJourneyNodeRequest**](UpdateJourneyNodeRequest.md) | | |
3502
+
3503
+ ### Return type
3504
+
3505
+ [**Journey**](Journey.md)
3506
+
3507
+ ### Authorization
3508
+
3509
+ [rest_api_key](https://github.com/OneSignal/onesignal-ruby-api#configuration)
3510
+
3511
+ ### HTTP request headers
3512
+
3513
+ - **Content-Type**: application/json
3514
+ - **Accept**: application/json
3515
+
3516
+
3192
3517
  ## update_live_activity
3193
3518
 
3194
3519
  > <UpdateLiveActivitySuccessResponse> update_live_activity(app_id, activity_id, update_live_activity_request)
@@ -3750,6 +4075,244 @@ end
3750
4075
  - **Accept**: application/json
3751
4076
 
3752
4077
 
4078
+ ## view_journey
4079
+
4080
+ > <Journey> view_journey(app_id, journey_id)
4081
+
4082
+ View journey
4083
+
4084
+ The Journeys API is in beta. Endpoints and response fields can still change. Retrieve the full configuration of a single journey by its UUID, including its audience and node graph.
4085
+
4086
+ ### Examples
4087
+
4088
+ ```ruby
4089
+ require 'onesignal'
4090
+ # setup authorization
4091
+ OneSignal.configure do |config|
4092
+ # Configure Bearer authorization: rest_api_key
4093
+ config.rest_api_key = 'YOUR_REST_API_KEY'
4094
+
4095
+ end
4096
+
4097
+ api_instance = OneSignal::DefaultApi.new
4098
+ app_id = 'YOUR_APP_ID' # String | Your OneSignal App ID in UUID v4 format.
4099
+ journey_id = 'YOUR_JOURNEY_ID' # String | UUID of the journey to retrieve.
4100
+
4101
+ begin
4102
+ # View journey
4103
+ result = api_instance.view_journey(app_id, journey_id)
4104
+ p result
4105
+ rescue OneSignal::ApiError => e
4106
+ puts "Error when calling DefaultApi->view_journey: #{e}"
4107
+ puts "Status Code: #{e.code}"
4108
+ # `e.error_messages` flattens any error-envelope shape to an Array<String>;
4109
+ # the raw body remains on `e.response_body`.
4110
+ puts "Error Messages: #{e.error_messages}"
4111
+ puts "Response Body: #{e.response_body}"
4112
+ end
4113
+ ```
4114
+
4115
+ #### Using the view_journey_with_http_info variant
4116
+
4117
+ This returns an Array which contains the response data, status code and headers.
4118
+
4119
+ > <Array(<Journey>, Integer, Hash)> view_journey_with_http_info(app_id, journey_id)
4120
+
4121
+ ```ruby
4122
+ begin
4123
+ # View journey
4124
+ data, status_code, headers = api_instance.view_journey_with_http_info(app_id, journey_id)
4125
+ p status_code # => 2xx
4126
+ p headers # => { ... }
4127
+ p data # => <Journey>
4128
+ rescue OneSignal::ApiError => e
4129
+ puts "Error when calling DefaultApi->view_journey_with_http_info: #{e}"
4130
+ puts "Status Code: #{e.code}"
4131
+ puts "Response Body: #{e.response_body}"
4132
+ end
4133
+ ```
4134
+
4135
+ ### Parameters
4136
+
4137
+ | Name | Type | Description | Notes |
4138
+ | ---- | ---- | ----------- | ----- |
4139
+ | **app_id** | **String** | Your OneSignal App ID in UUID v4 format. | |
4140
+ | **journey_id** | **String** | UUID of the journey to retrieve. | |
4141
+
4142
+ ### Return type
4143
+
4144
+ [**Journey**](Journey.md)
4145
+
4146
+ ### Authorization
4147
+
4148
+ [rest_api_key](https://github.com/OneSignal/onesignal-ruby-api#configuration)
4149
+
4150
+ ### HTTP request headers
4151
+
4152
+ - **Content-Type**: Not defined
4153
+ - **Accept**: application/json
4154
+
4155
+
4156
+ ## view_journey_stats
4157
+
4158
+ > <JourneyStats> view_journey_stats(app_id, journey_id)
4159
+
4160
+ View journey stats
4161
+
4162
+ The Journeys API is in beta. Endpoints and response fields can still change. Retrieve performance stats for a single journey: journey-level entry and exit counts, per-node counts keyed by node id, per-branch counts keyed by branch id, and channel delivery stats for message-sending nodes. The response carries no definition detail, so join it by id against the journey from View journey.
4163
+
4164
+ ### Examples
4165
+
4166
+ ```ruby
4167
+ require 'onesignal'
4168
+ # setup authorization
4169
+ OneSignal.configure do |config|
4170
+ # Configure Bearer authorization: rest_api_key
4171
+ config.rest_api_key = 'YOUR_REST_API_KEY'
4172
+
4173
+ end
4174
+
4175
+ api_instance = OneSignal::DefaultApi.new
4176
+ app_id = 'YOUR_APP_ID' # String | Your OneSignal App ID in UUID v4 format.
4177
+ journey_id = 'YOUR_JOURNEY_ID' # String | UUID of the journey to retrieve stats for.
4178
+
4179
+ begin
4180
+ # View journey stats
4181
+ result = api_instance.view_journey_stats(app_id, journey_id)
4182
+ p result
4183
+ rescue OneSignal::ApiError => e
4184
+ puts "Error when calling DefaultApi->view_journey_stats: #{e}"
4185
+ puts "Status Code: #{e.code}"
4186
+ # `e.error_messages` flattens any error-envelope shape to an Array<String>;
4187
+ # the raw body remains on `e.response_body`.
4188
+ puts "Error Messages: #{e.error_messages}"
4189
+ puts "Response Body: #{e.response_body}"
4190
+ end
4191
+ ```
4192
+
4193
+ #### Using the view_journey_stats_with_http_info variant
4194
+
4195
+ This returns an Array which contains the response data, status code and headers.
4196
+
4197
+ > <Array(<JourneyStats>, Integer, Hash)> view_journey_stats_with_http_info(app_id, journey_id)
4198
+
4199
+ ```ruby
4200
+ begin
4201
+ # View journey stats
4202
+ data, status_code, headers = api_instance.view_journey_stats_with_http_info(app_id, journey_id)
4203
+ p status_code # => 2xx
4204
+ p headers # => { ... }
4205
+ p data # => <JourneyStats>
4206
+ rescue OneSignal::ApiError => e
4207
+ puts "Error when calling DefaultApi->view_journey_stats_with_http_info: #{e}"
4208
+ puts "Status Code: #{e.code}"
4209
+ puts "Response Body: #{e.response_body}"
4210
+ end
4211
+ ```
4212
+
4213
+ ### Parameters
4214
+
4215
+ | Name | Type | Description | Notes |
4216
+ | ---- | ---- | ----------- | ----- |
4217
+ | **app_id** | **String** | Your OneSignal App ID in UUID v4 format. | |
4218
+ | **journey_id** | **String** | UUID of the journey to retrieve stats for. | |
4219
+
4220
+ ### Return type
4221
+
4222
+ [**JourneyStats**](JourneyStats.md)
4223
+
4224
+ ### Authorization
4225
+
4226
+ [rest_api_key](https://github.com/OneSignal/onesignal-ruby-api#configuration)
4227
+
4228
+ ### HTTP request headers
4229
+
4230
+ - **Content-Type**: Not defined
4231
+ - **Accept**: application/json
4232
+
4233
+
4234
+ ## view_journeys
4235
+
4236
+ > <JourneyListResponse> view_journeys(app_id, opts)
4237
+
4238
+ View journeys
4239
+
4240
+ The Journeys API is in beta. Endpoints and response fields can still change. Retrieve a paginated list of journeys for an app. Returns a summary representation of each journey; use View journey for the full configuration. Uses forward-only cursor-based pagination.
4241
+
4242
+ ### Examples
4243
+
4244
+ ```ruby
4245
+ require 'onesignal'
4246
+ # setup authorization
4247
+ OneSignal.configure do |config|
4248
+ # Configure Bearer authorization: rest_api_key
4249
+ config.rest_api_key = 'YOUR_REST_API_KEY'
4250
+
4251
+ end
4252
+
4253
+ api_instance = OneSignal::DefaultApi.new
4254
+ app_id = 'YOUR_APP_ID' # String | Your OneSignal App ID in UUID v4 format.
4255
+ opts = {
4256
+ cursor: 'cursor_example', # String | Opaque pagination token from a previous response's next_cursor. Omit for the first page.
4257
+ limit: 50 # Integer | Maximum journeys to return per page. Minimum 1, maximum 50.
4258
+ }
4259
+
4260
+ begin
4261
+ # View journeys
4262
+ result = api_instance.view_journeys(app_id, opts)
4263
+ p result
4264
+ rescue OneSignal::ApiError => e
4265
+ puts "Error when calling DefaultApi->view_journeys: #{e}"
4266
+ puts "Status Code: #{e.code}"
4267
+ # `e.error_messages` flattens any error-envelope shape to an Array<String>;
4268
+ # the raw body remains on `e.response_body`.
4269
+ puts "Error Messages: #{e.error_messages}"
4270
+ puts "Response Body: #{e.response_body}"
4271
+ end
4272
+ ```
4273
+
4274
+ #### Using the view_journeys_with_http_info variant
4275
+
4276
+ This returns an Array which contains the response data, status code and headers.
4277
+
4278
+ > <Array(<JourneyListResponse>, Integer, Hash)> view_journeys_with_http_info(app_id, opts)
4279
+
4280
+ ```ruby
4281
+ begin
4282
+ # View journeys
4283
+ data, status_code, headers = api_instance.view_journeys_with_http_info(app_id, opts)
4284
+ p status_code # => 2xx
4285
+ p headers # => { ... }
4286
+ p data # => <JourneyListResponse>
4287
+ rescue OneSignal::ApiError => e
4288
+ puts "Error when calling DefaultApi->view_journeys_with_http_info: #{e}"
4289
+ puts "Status Code: #{e.code}"
4290
+ puts "Response Body: #{e.response_body}"
4291
+ end
4292
+ ```
4293
+
4294
+ ### Parameters
4295
+
4296
+ | Name | Type | Description | Notes |
4297
+ | ---- | ---- | ----------- | ----- |
4298
+ | **app_id** | **String** | Your OneSignal App ID in UUID v4 format. | |
4299
+ | **cursor** | **String** | Opaque pagination token from a previous response&#39;s next_cursor. Omit for the first page. | [optional] |
4300
+ | **limit** | **Integer** | Maximum journeys to return per page. Minimum 1, maximum 50. | [optional][default to 50] |
4301
+
4302
+ ### Return type
4303
+
4304
+ [**JourneyListResponse**](JourneyListResponse.md)
4305
+
4306
+ ### Authorization
4307
+
4308
+ [rest_api_key](https://github.com/OneSignal/onesignal-ruby-api#configuration)
4309
+
4310
+ ### HTTP request headers
4311
+
4312
+ - **Content-Type**: Not defined
4313
+ - **Accept**: application/json
4314
+
4315
+
3753
4316
  ## view_template
3754
4317
 
3755
4318
  > <TemplateResource> view_template(template_id, app_id)