onesignal 5.10.0 → 5.11.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 (186) 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/AuditLogActor.md +26 -0
  6. data/docs/AuditLogContext.md +24 -0
  7. data/docs/AuditLogEvent.md +36 -0
  8. data/docs/AuditLogTarget.md +24 -0
  9. data/docs/DefaultApi.md +267 -0
  10. data/docs/GetSegmentSuccessResponse.md +20 -0
  11. data/docs/ListAuditLogsSuccessResponse.md +22 -0
  12. data/docs/SegmentDetails.md +28 -0
  13. data/docs/UpdateSegmentRequest.md +22 -0
  14. data/docs/UpdateSegmentSuccessResponse.md +20 -0
  15. data/lib/onesignal/api/default_api.rb +273 -1
  16. data/lib/onesignal/api_client.rb +2 -2
  17. data/lib/onesignal/api_error.rb +1 -1
  18. data/lib/onesignal/configuration.rb +1 -1
  19. data/lib/onesignal/models/api_key_token.rb +1 -1
  20. data/lib/onesignal/models/api_key_tokens_list_response.rb +1 -1
  21. data/lib/onesignal/models/app.rb +1 -1
  22. data/lib/onesignal/models/audit_log_actor.rb +261 -0
  23. data/lib/onesignal/models/audit_log_context.rb +251 -0
  24. data/lib/onesignal/models/audit_log_event.rb +310 -0
  25. data/lib/onesignal/models/audit_log_target.rb +251 -0
  26. data/lib/onesignal/models/basic_notification.rb +1 -1
  27. data/lib/onesignal/models/basic_notification_all_of.rb +1 -1
  28. data/lib/onesignal/models/basic_notification_all_of_android_background_layout.rb +1 -1
  29. data/lib/onesignal/models/button.rb +1 -1
  30. data/lib/onesignal/models/copy_template_request.rb +1 -1
  31. data/lib/onesignal/models/create_api_key_request.rb +1 -1
  32. data/lib/onesignal/models/create_api_key_response.rb +1 -1
  33. data/lib/onesignal/models/create_notification_success_response.rb +1 -1
  34. data/lib/onesignal/models/create_segment_conflict_response.rb +1 -1
  35. data/lib/onesignal/models/create_segment_success_response.rb +1 -1
  36. data/lib/onesignal/models/create_template_request.rb +1 -1
  37. data/lib/onesignal/models/create_user_conflict_response.rb +1 -1
  38. data/lib/onesignal/models/create_user_conflict_response_errors_inner.rb +1 -1
  39. data/lib/onesignal/models/create_user_conflict_response_errors_items_meta.rb +1 -1
  40. data/lib/onesignal/models/custom_event.rb +1 -1
  41. data/lib/onesignal/models/custom_events_request.rb +1 -1
  42. data/lib/onesignal/models/delivery_data.rb +1 -1
  43. data/lib/onesignal/models/export_events_success_response.rb +1 -1
  44. data/lib/onesignal/models/export_subscriptions_request_body.rb +1 -1
  45. data/lib/onesignal/models/export_subscriptions_success_response.rb +1 -1
  46. data/lib/onesignal/models/filter.rb +1 -1
  47. data/lib/onesignal/models/filter_expression.rb +1 -1
  48. data/lib/onesignal/models/generic_error.rb +1 -1
  49. data/lib/onesignal/models/generic_success_bool_response.rb +1 -1
  50. data/lib/onesignal/models/get_notification_history_request_body.rb +1 -1
  51. data/lib/onesignal/models/get_segment_success_response.rb +229 -0
  52. data/lib/onesignal/models/get_segments_success_response.rb +1 -1
  53. data/lib/onesignal/models/language_string_map.rb +1 -1
  54. data/lib/onesignal/models/list_audit_logs_success_response.rb +242 -0
  55. data/lib/onesignal/models/notification.rb +1 -1
  56. data/lib/onesignal/models/notification_all_of.rb +1 -1
  57. data/lib/onesignal/models/notification_history_success_response.rb +1 -1
  58. data/lib/onesignal/models/notification_slice.rb +1 -1
  59. data/lib/onesignal/models/notification_target.rb +1 -1
  60. data/lib/onesignal/models/notification_with_meta.rb +1 -1
  61. data/lib/onesignal/models/notification_with_meta_all_of.rb +1 -1
  62. data/lib/onesignal/models/operator.rb +1 -1
  63. data/lib/onesignal/models/outcome_data.rb +1 -1
  64. data/lib/onesignal/models/outcomes_data.rb +1 -1
  65. data/lib/onesignal/models/platform_delivery_data.rb +1 -1
  66. data/lib/onesignal/models/platform_delivery_data_email_all_of.rb +1 -1
  67. data/lib/onesignal/models/platform_delivery_data_sms_all_of.rb +1 -1
  68. data/lib/onesignal/models/properties_body.rb +1 -1
  69. data/lib/onesignal/models/properties_deltas.rb +1 -1
  70. data/lib/onesignal/models/properties_object.rb +1 -1
  71. data/lib/onesignal/models/purchase.rb +1 -1
  72. data/lib/onesignal/models/rate_limit_error.rb +1 -1
  73. data/lib/onesignal/models/segment.rb +1 -1
  74. data/lib/onesignal/models/segment_data.rb +1 -1
  75. data/lib/onesignal/models/segment_details.rb +308 -0
  76. data/lib/onesignal/models/segment_notification_target.rb +1 -1
  77. data/lib/onesignal/models/start_live_activity_request.rb +1 -1
  78. data/lib/onesignal/models/start_live_activity_success_response.rb +1 -1
  79. data/lib/onesignal/models/subscription.rb +1 -1
  80. data/lib/onesignal/models/subscription_body.rb +1 -1
  81. data/lib/onesignal/models/subscription_notification_target.rb +1 -1
  82. data/lib/onesignal/models/template_resource.rb +1 -1
  83. data/lib/onesignal/models/templates_list_response.rb +1 -1
  84. data/lib/onesignal/models/transfer_subscription_request_body.rb +1 -1
  85. data/lib/onesignal/models/update_api_key_request.rb +1 -1
  86. data/lib/onesignal/models/update_live_activity_request.rb +1 -1
  87. data/lib/onesignal/models/update_live_activity_success_response.rb +1 -1
  88. data/lib/onesignal/models/update_segment_request.rb +281 -0
  89. data/lib/onesignal/models/update_segment_success_response.rb +230 -0
  90. data/lib/onesignal/models/update_template_request.rb +1 -1
  91. data/lib/onesignal/models/update_user_request.rb +1 -1
  92. data/lib/onesignal/models/user.rb +1 -1
  93. data/lib/onesignal/models/user_identity_body.rb +1 -1
  94. data/lib/onesignal/models/web_button.rb +1 -1
  95. data/lib/onesignal/version.rb +2 -2
  96. data/lib/onesignal.rb +10 -1
  97. data/onesignal.gemspec +1 -1
  98. data/spec/api/default_api_spec.rb +52 -1
  99. data/spec/api_client_spec.rb +1 -1
  100. data/spec/configuration_spec.rb +1 -1
  101. data/spec/models/api_key_token_spec.rb +1 -1
  102. data/spec/models/api_key_tokens_list_response_spec.rb +1 -1
  103. data/spec/models/app_spec.rb +1 -1
  104. data/spec/models/audit_log_actor_spec.rb +58 -0
  105. data/spec/models/audit_log_context_spec.rb +52 -0
  106. data/spec/models/audit_log_event_spec.rb +88 -0
  107. data/spec/models/audit_log_target_spec.rb +52 -0
  108. data/spec/models/basic_notification_all_of_android_background_layout_spec.rb +1 -1
  109. data/spec/models/basic_notification_all_of_spec.rb +1 -1
  110. data/spec/models/basic_notification_spec.rb +1 -1
  111. data/spec/models/button_spec.rb +1 -1
  112. data/spec/models/copy_template_request_spec.rb +1 -1
  113. data/spec/models/create_api_key_request_spec.rb +1 -1
  114. data/spec/models/create_api_key_response_spec.rb +1 -1
  115. data/spec/models/create_notification_success_response_spec.rb +1 -1
  116. data/spec/models/create_segment_conflict_response_spec.rb +1 -1
  117. data/spec/models/create_segment_success_response_spec.rb +1 -1
  118. data/spec/models/create_template_request_spec.rb +1 -1
  119. data/spec/models/create_user_conflict_response_errors_inner_spec.rb +1 -1
  120. data/spec/models/create_user_conflict_response_errors_items_meta_spec.rb +1 -1
  121. data/spec/models/create_user_conflict_response_spec.rb +1 -1
  122. data/spec/models/custom_event_spec.rb +1 -1
  123. data/spec/models/custom_events_request_spec.rb +1 -1
  124. data/spec/models/delivery_data_spec.rb +1 -1
  125. data/spec/models/export_events_success_response_spec.rb +1 -1
  126. data/spec/models/export_subscriptions_request_body_spec.rb +1 -1
  127. data/spec/models/export_subscriptions_success_response_spec.rb +1 -1
  128. data/spec/models/filter_expression_spec.rb +1 -1
  129. data/spec/models/filter_spec.rb +1 -1
  130. data/spec/models/generic_error_spec.rb +1 -1
  131. data/spec/models/generic_success_bool_response_spec.rb +1 -1
  132. data/spec/models/get_notification_history_request_body_spec.rb +1 -1
  133. data/spec/models/get_segment_success_response_spec.rb +40 -0
  134. data/spec/models/get_segments_success_response_spec.rb +1 -1
  135. data/spec/models/language_string_map_spec.rb +1 -1
  136. data/spec/models/list_audit_logs_success_response_spec.rb +46 -0
  137. data/spec/models/notification_all_of_spec.rb +1 -1
  138. data/spec/models/notification_history_success_response_spec.rb +1 -1
  139. data/spec/models/notification_slice_spec.rb +1 -1
  140. data/spec/models/notification_spec.rb +1 -1
  141. data/spec/models/notification_target_spec.rb +1 -1
  142. data/spec/models/notification_with_meta_all_of_spec.rb +1 -1
  143. data/spec/models/notification_with_meta_spec.rb +1 -1
  144. data/spec/models/operator_spec.rb +1 -1
  145. data/spec/models/outcome_data_spec.rb +1 -1
  146. data/spec/models/outcomes_data_spec.rb +1 -1
  147. data/spec/models/platform_delivery_data_email_all_of_spec.rb +1 -1
  148. data/spec/models/platform_delivery_data_sms_all_of_spec.rb +1 -1
  149. data/spec/models/platform_delivery_data_spec.rb +1 -1
  150. data/spec/models/properties_body_spec.rb +1 -1
  151. data/spec/models/properties_deltas_spec.rb +1 -1
  152. data/spec/models/properties_object_spec.rb +1 -1
  153. data/spec/models/purchase_spec.rb +1 -1
  154. data/spec/models/rate_limit_error_spec.rb +1 -1
  155. data/spec/models/segment_data_spec.rb +1 -1
  156. data/spec/models/segment_details_spec.rb +68 -0
  157. data/spec/models/segment_notification_target_spec.rb +1 -1
  158. data/spec/models/segment_spec.rb +1 -1
  159. data/spec/models/start_live_activity_request_spec.rb +1 -1
  160. data/spec/models/start_live_activity_success_response_spec.rb +1 -1
  161. data/spec/models/subscription_body_spec.rb +1 -1
  162. data/spec/models/subscription_notification_target_spec.rb +1 -1
  163. data/spec/models/subscription_spec.rb +1 -1
  164. data/spec/models/template_resource_spec.rb +1 -1
  165. data/spec/models/templates_list_response_spec.rb +1 -1
  166. data/spec/models/transfer_subscription_request_body_spec.rb +1 -1
  167. data/spec/models/update_api_key_request_spec.rb +1 -1
  168. data/spec/models/update_live_activity_request_spec.rb +1 -1
  169. data/spec/models/update_live_activity_success_response_spec.rb +1 -1
  170. data/spec/models/update_segment_request_spec.rb +46 -0
  171. data/spec/models/update_segment_success_response_spec.rb +40 -0
  172. data/spec/models/update_template_request_spec.rb +1 -1
  173. data/spec/models/update_user_request_spec.rb +1 -1
  174. data/spec/models/user_identity_body_spec.rb +1 -1
  175. data/spec/models/user_spec.rb +1 -1
  176. data/spec/models/web_button_spec.rb +1 -1
  177. data/spec/spec_helper.rb +1 -1
  178. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/byebug-13.0.0/gem_make.out +5 -5
  179. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/date-3.5.1/gem_make.out +5 -5
  180. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/io-console-0.8.2/gem_make.out +5 -5
  181. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/io-console-0.8.2/mkmf.log +3 -3
  182. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/jaro_winkler-1.5.6/gem_make.out +5 -5
  183. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/psych-5.4.0/gem_make.out +5 -5
  184. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/racc-1.8.1/gem_make.out +5 -5
  185. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/stringio-3.2.0/gem_make.out +5 -5
  186. metadata +94 -58
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 94dfc5df823ede3cceba9b84c58a355279c3a01a1c4f9e698212fdf800ec9254
4
- data.tar.gz: b8896164f30796660dfd0b47ecdef794f4b3d162359adc5210f57afb103672c8
3
+ metadata.gz: 3943ed5633f51d9bafeaf9b135edd336f4bcb5f52b275dc20dab33e0111a492f
4
+ data.tar.gz: bd21bb996fe1f016f7e624a274b2821057c2332f6bf977756f063e785e6f8796
5
5
  SHA512:
6
- metadata.gz: 3936ae5831fbdb1b42ffe41c748888b4dd0a5dc9b4b056eae47404a7742a5a363907216079966e92de6445f3de9b8570567d450d31d3d4a8af283567d03cb490
7
- data.tar.gz: 4f19c796f0e64ebf7aca8378d27b35a52f909743e6978277ae20307adf465769839ab9a902791d35621591164fcfd179492cc9eb2b74df4ec6ac95df4ac2779f
6
+ metadata.gz: 7fd06ba9522a1afd0f3791ac74b321b0ddfc71c4a30b9682302b1c6ee0f4c79cd1b4bd153e0b44c47a9c0d48513d152c963b12530c2b632cb815b431966fac9f
7
+ data.tar.gz: '013805de783e4a7b84823abe3091171b65bd234737e9ad6d2af88d2198ae1319d14406bc9cd24fc4c04c67e7a6d0450bc826ccf415b158715a94faaa6fd7f2ad'
data/CHANGELOG.md CHANGED
@@ -1,5 +1,7 @@
1
1
  # Changelog
2
2
 
3
+ ## [5.10.0](https://github.com/OneSignal/onesignal-ruby-api/compare/v5.9.0...v5.10.0) (2026-07-20)
4
+
3
5
  ## [5.9.0](https://github.com/OneSignal/onesignal-ruby-api/compare/v5.8.0...v5.9.0) (2026-07-09)
4
6
 
5
7
  ## [5.8.0](https://github.com/OneSignal/onesignal-ruby-api/compare/v5.7.0...v5.8.0) (2026-06-24)
data/Gemfile.lock CHANGED
@@ -1,7 +1,7 @@
1
1
  PATH
2
2
  remote: .
3
3
  specs:
4
- onesignal (5.10.0)
4
+ onesignal (5.11.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.10.0
10
- - Package version: 5.10.0
9
+ - API version: 5.11.0
10
+ - Package version: 5.11.0
11
11
 
12
12
  ## Installation
13
13
 
14
14
  Add to your `Gemfile`:
15
15
 
16
16
  ```ruby
17
- gem 'onesignal', '~> 5.10.0'
17
+ gem 'onesignal', '~> 5.11.0'
18
18
  ```
19
19
 
20
20
  Then run `bundle install`.
@@ -0,0 +1,26 @@
1
+ # OneSignal::AuditLogActor
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **email** | **String** | Email address of the actor. Absent if unavailable. | [optional] |
8
+ | **id** | **String** | UUID of the actor. | [optional] |
9
+ | **metadata** | **Object** | Additional actor-specific data. | [optional] |
10
+ | **name** | **String** | Display name of the actor. Absent if unavailable. | [optional] |
11
+ | **type** | **String** | Actor type (e.g. member, api_key, system). | [optional] |
12
+
13
+ ## Example
14
+
15
+ ```ruby
16
+ require 'onesignal'
17
+
18
+ instance = OneSignal::AuditLogActor.new(
19
+ email: nil,
20
+ id: nil,
21
+ metadata: nil,
22
+ name: nil,
23
+ type: nil
24
+ )
25
+ ```
26
+
@@ -0,0 +1,24 @@
1
+ # OneSignal::AuditLogContext
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **country** | **String** | Country code derived from the request IP. | [optional] |
8
+ | **ip** | **String** | IP address the request originated from. | [optional] |
9
+ | **metadata** | **Object** | Additional context-specific data. | [optional] |
10
+ | **user_agent** | **String** | User agent of the client that made the request. | [optional] |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'onesignal'
16
+
17
+ instance = OneSignal::AuditLogContext.new(
18
+ country: nil,
19
+ ip: nil,
20
+ metadata: nil,
21
+ user_agent: nil
22
+ )
23
+ ```
24
+
@@ -0,0 +1,36 @@
1
+ # OneSignal::AuditLogEvent
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **action** | **String** | The action that was performed (e.g. notification.sent, segment.created, member.invited). | [optional] |
8
+ | **actor** | [**AuditLogActor**](AuditLogActor.md) | | [optional] |
9
+ | **app_id** | **String** | UUID of the app the event is associated with. Absent for org-level events. | [optional] |
10
+ | **context** | [**AuditLogContext**](AuditLogContext.md) | | [optional] |
11
+ | **id** | **String** | UUID of the audit log event. | [optional] |
12
+ | **metadata** | **Object** | Additional event-specific data that does not fit into the standard fields. | [optional] |
13
+ | **occurred_at** | **String** | RFC 3339 timestamp of when the event occurred (e.g. 2026-02-18T12:34:56Z). | [optional] |
14
+ | **organization_id** | **String** | UUID of the organization the event belongs to. | [optional] |
15
+ | **targets** | [**Array<AuditLogTarget>**](AuditLogTarget.md) | The resources the action was performed on. May be empty for org-level events. | [optional] |
16
+ | **version** | **Integer** | Schema version of the event payload. | [optional] |
17
+
18
+ ## Example
19
+
20
+ ```ruby
21
+ require 'onesignal'
22
+
23
+ instance = OneSignal::AuditLogEvent.new(
24
+ action: nil,
25
+ actor: nil,
26
+ app_id: nil,
27
+ context: nil,
28
+ id: nil,
29
+ metadata: nil,
30
+ occurred_at: nil,
31
+ organization_id: nil,
32
+ targets: nil,
33
+ version: nil
34
+ )
35
+ ```
36
+
@@ -0,0 +1,24 @@
1
+ # OneSignal::AuditLogTarget
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **id** | **String** | UUID of the resource. | [optional] |
8
+ | **metadata** | **Object** | Additional resource-specific data. | [optional] |
9
+ | **name** | **String** | Display name of the resource. Absent if unavailable. | [optional] |
10
+ | **type** | **String** | Resource type (e.g. notification, segment, journey, app). | [optional] |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'onesignal'
16
+
17
+ instance = OneSignal::AuditLogTarget.new(
18
+ id: nil,
19
+ metadata: nil,
20
+ name: nil,
21
+ type: nil
22
+ )
23
+ ```
24
+
data/docs/DefaultApi.md CHANGED
@@ -32,8 +32,10 @@ All URIs are relative to *https://api.onesignal.com*
32
32
  | [**get_notification_history**](DefaultApi.md#get_notification_history) | **POST** /notifications/{notification_id}/history | Notification History |
33
33
  | [**get_notifications**](DefaultApi.md#get_notifications) | **GET** /notifications | View notifications |
34
34
  | [**get_outcomes**](DefaultApi.md#get_outcomes) | **GET** /apps/{app_id}/outcomes | View Outcomes |
35
+ | [**get_segment**](DefaultApi.md#get_segment) | **GET** /apps/{app_id}/segments/{segment_id} | View Segment |
35
36
  | [**get_segments**](DefaultApi.md#get_segments) | **GET** /apps/{app_id}/segments | Get Segments |
36
37
  | [**get_user**](DefaultApi.md#get_user) | **GET** /apps/{app_id}/users/by/{alias_label}/{alias_id} | |
38
+ | [**list_audit_logs**](DefaultApi.md#list_audit_logs) | **GET** /organizations/{organization_id}/audit_logs | List audit logs |
37
39
  | [**rotate_api_key**](DefaultApi.md#rotate_api_key) | **POST** /apps/{app_id}/auth/tokens/{token_id}/rotate | Rotate API key |
38
40
  | [**start_live_activity**](DefaultApi.md#start_live_activity) | **POST** /apps/{app_id}/activities/activity/{activity_type} | Start Live Activity |
39
41
  | [**transfer_subscription**](DefaultApi.md#transfer_subscription) | **PATCH** /apps/{app_id}/subscriptions/{subscription_id}/owner | |
@@ -41,6 +43,7 @@ All URIs are relative to *https://api.onesignal.com*
41
43
  | [**update_api_key**](DefaultApi.md#update_api_key) | **PATCH** /apps/{app_id}/auth/tokens/{token_id} | Update API key |
42
44
  | [**update_app**](DefaultApi.md#update_app) | **PUT** /apps/{app_id} | Update an app |
43
45
  | [**update_live_activity**](DefaultApi.md#update_live_activity) | **POST** /apps/{app_id}/live_activities/{activity_id}/notifications | Update a Live Activity via Push |
46
+ | [**update_segment**](DefaultApi.md#update_segment) | **PATCH** /apps/{app_id}/segments/{segment_id} | Update Segment |
44
47
  | [**update_subscription**](DefaultApi.md#update_subscription) | **PATCH** /apps/{app_id}/subscriptions/{subscription_id} | |
45
48
  | [**update_subscription_by_token**](DefaultApi.md#update_subscription_by_token) | **PATCH** /apps/{app_id}/subscriptions_by_token/{token_type}/{token} | Update subscription by token |
46
49
  | [**update_template**](DefaultApi.md#update_template) | **PATCH** /templates/{template_id} | Update template |
@@ -2366,6 +2369,88 @@ end
2366
2369
  - **Accept**: application/json
2367
2370
 
2368
2371
 
2372
+ ## get_segment
2373
+
2374
+ > <GetSegmentSuccessResponse> get_segment(app_id, segment_id, opts)
2375
+
2376
+ View Segment
2377
+
2378
+ Retrieve details for a single segment by its ID, including subscriber count and optionally segment metadata and filters.
2379
+
2380
+ ### Examples
2381
+
2382
+ ```ruby
2383
+ require 'onesignal'
2384
+ # setup authorization
2385
+ OneSignal.configure do |config|
2386
+ # Configure Bearer authorization: rest_api_key
2387
+ config.rest_api_key = 'YOUR_REST_API_KEY'
2388
+
2389
+ end
2390
+
2391
+ api_instance = OneSignal::DefaultApi.new
2392
+ app_id = 'YOUR_APP_ID' # String | The OneSignal App ID for your app. Available in Keys & IDs.
2393
+ segment_id = 'd6c5a3e1-9f17-44a1-9d10-7c0e4a2b1c8e' # String | The segment's unique identifier. Can be found using the View Segments API or in the URL of the segment when viewing it in the dashboard.
2394
+ opts = {
2395
+ include_segment_detail: true # Boolean | Set to true to include segment metadata and filters in the response.
2396
+ }
2397
+
2398
+ begin
2399
+ # View Segment
2400
+ result = api_instance.get_segment(app_id, segment_id, opts)
2401
+ p result
2402
+ rescue OneSignal::ApiError => e
2403
+ puts "Error when calling DefaultApi->get_segment: #{e}"
2404
+ puts "Status Code: #{e.code}"
2405
+ # `e.error_messages` flattens any error-envelope shape to an Array<String>;
2406
+ # the raw body remains on `e.response_body`.
2407
+ puts "Error Messages: #{e.error_messages}"
2408
+ puts "Response Body: #{e.response_body}"
2409
+ end
2410
+ ```
2411
+
2412
+ #### Using the get_segment_with_http_info variant
2413
+
2414
+ This returns an Array which contains the response data, status code and headers.
2415
+
2416
+ > <Array(<GetSegmentSuccessResponse>, Integer, Hash)> get_segment_with_http_info(app_id, segment_id, opts)
2417
+
2418
+ ```ruby
2419
+ begin
2420
+ # View Segment
2421
+ data, status_code, headers = api_instance.get_segment_with_http_info(app_id, segment_id, opts)
2422
+ p status_code # => 2xx
2423
+ p headers # => { ... }
2424
+ p data # => <GetSegmentSuccessResponse>
2425
+ rescue OneSignal::ApiError => e
2426
+ puts "Error when calling DefaultApi->get_segment_with_http_info: #{e}"
2427
+ puts "Status Code: #{e.code}"
2428
+ puts "Response Body: #{e.response_body}"
2429
+ end
2430
+ ```
2431
+
2432
+ ### Parameters
2433
+
2434
+ | Name | Type | Description | Notes |
2435
+ | ---- | ---- | ----------- | ----- |
2436
+ | **app_id** | **String** | The OneSignal App ID for your app. Available in Keys &amp; IDs. | |
2437
+ | **segment_id** | **String** | The segment&#39;s unique identifier. Can be found using the View Segments API or in the URL of the segment when viewing it in the dashboard. | |
2438
+ | **include_segment_detail** | **Boolean** | Set to true to include segment metadata and filters in the response. | [optional] |
2439
+
2440
+ ### Return type
2441
+
2442
+ [**GetSegmentSuccessResponse**](GetSegmentSuccessResponse.md)
2443
+
2444
+ ### Authorization
2445
+
2446
+ [rest_api_key](https://github.com/OneSignal/onesignal-ruby-api#configuration)
2447
+
2448
+ ### HTTP request headers
2449
+
2450
+ - **Content-Type**: Not defined
2451
+ - **Accept**: application/json
2452
+
2453
+
2369
2454
  ## get_segments
2370
2455
 
2371
2456
  > <GetSegmentsSuccessResponse> get_segments(app_id, opts)
@@ -2528,6 +2613,106 @@ end
2528
2613
  - **Accept**: application/json
2529
2614
 
2530
2615
 
2616
+ ## list_audit_logs
2617
+
2618
+ > <ListAuditLogsSuccessResponse> list_audit_logs(organization_id, opts)
2619
+
2620
+ List audit logs
2621
+
2622
+ Retrieve a paginated, time-scoped list of audit log events for an organization. Requires an Enterprise plan with the audit logs entitlement enabled.
2623
+
2624
+ ### Examples
2625
+
2626
+ ```ruby
2627
+ require 'onesignal'
2628
+ # setup authorization
2629
+ OneSignal.configure do |config|
2630
+ # Configure Bearer authorization: organization_api_key
2631
+ config.organization_api_key = 'YOUR_ORGANIZATION_API_KEY'
2632
+
2633
+ end
2634
+
2635
+ api_instance = OneSignal::DefaultApi.new
2636
+ organization_id = 'YOUR_ORG_ID' # String | The UUID of the organization to retrieve audit logs for. Must match the authenticated Organization API Key.
2637
+ opts = {
2638
+ start_time: 'start_time_example', # String | Start of the time range in ISO 8601 format (e.g. 2026-02-01T00:00:00Z). Required unless cursor is provided. Must be within the last 90 days.
2639
+ end_time: 'end_time_example', # String | End of the time range in ISO 8601 format. Defaults to the current time. Must be after start_time.
2640
+ cursor: 'cursor_example', # String | Pagination cursor returned in a previous response as next_cursor. When provided, start_time and end_time are ignored.
2641
+ limit: 56, # Integer | Maximum number of events to return per page. Minimum 1, maximum 100. Values outside this range are clamped automatically by the server.
2642
+ app_ids: ['inner_example'], # Array<String> | Filter events by app UUID. Accepts up to 10 values. Org-level events are always included.
2643
+ actions: ['inner_example'], # Array<String> | Filter by action type (e.g. notification.sent, segment.created). Accepts up to 20 values.
2644
+ actor_ids: ['inner_example'], # Array<String> | Filter by actor UUID (the user or service that performed the action). Accepts up to 10 values.
2645
+ actor_emails: ['inner_example'], # Array<String> | Filter by actor email address. Accepts up to 10 values.
2646
+ target_types: ['inner_example'], # Array<String> | Filter by the type of resource the action was performed on (e.g. notification, segment, journey). Accepts up to 10 values.
2647
+ target_ids: ['inner_example'], # Array<String> | Filter by the UUID of the resource the action was performed on. Accepts up to 10 values.
2648
+ ip_addresses: ['inner_example'] # Array<String> | Filter by the IP address the action originated from. Accepts up to 10 values.
2649
+ }
2650
+
2651
+ begin
2652
+ # List audit logs
2653
+ result = api_instance.list_audit_logs(organization_id, opts)
2654
+ p result
2655
+ rescue OneSignal::ApiError => e
2656
+ puts "Error when calling DefaultApi->list_audit_logs: #{e}"
2657
+ puts "Status Code: #{e.code}"
2658
+ # `e.error_messages` flattens any error-envelope shape to an Array<String>;
2659
+ # the raw body remains on `e.response_body`.
2660
+ puts "Error Messages: #{e.error_messages}"
2661
+ puts "Response Body: #{e.response_body}"
2662
+ end
2663
+ ```
2664
+
2665
+ #### Using the list_audit_logs_with_http_info variant
2666
+
2667
+ This returns an Array which contains the response data, status code and headers.
2668
+
2669
+ > <Array(<ListAuditLogsSuccessResponse>, Integer, Hash)> list_audit_logs_with_http_info(organization_id, opts)
2670
+
2671
+ ```ruby
2672
+ begin
2673
+ # List audit logs
2674
+ data, status_code, headers = api_instance.list_audit_logs_with_http_info(organization_id, opts)
2675
+ p status_code # => 2xx
2676
+ p headers # => { ... }
2677
+ p data # => <ListAuditLogsSuccessResponse>
2678
+ rescue OneSignal::ApiError => e
2679
+ puts "Error when calling DefaultApi->list_audit_logs_with_http_info: #{e}"
2680
+ puts "Status Code: #{e.code}"
2681
+ puts "Response Body: #{e.response_body}"
2682
+ end
2683
+ ```
2684
+
2685
+ ### Parameters
2686
+
2687
+ | Name | Type | Description | Notes |
2688
+ | ---- | ---- | ----------- | ----- |
2689
+ | **organization_id** | **String** | The UUID of the organization to retrieve audit logs for. Must match the authenticated Organization API Key. | |
2690
+ | **start_time** | **String** | Start of the time range in ISO 8601 format (e.g. 2026-02-01T00:00:00Z). Required unless cursor is provided. Must be within the last 90 days. | [optional] |
2691
+ | **end_time** | **String** | End of the time range in ISO 8601 format. Defaults to the current time. Must be after start_time. | [optional] |
2692
+ | **cursor** | **String** | Pagination cursor returned in a previous response as next_cursor. When provided, start_time and end_time are ignored. | [optional] |
2693
+ | **limit** | **Integer** | Maximum number of events to return per page. Minimum 1, maximum 100. Values outside this range are clamped automatically by the server. | [optional] |
2694
+ | **app_ids** | [**Array&lt;String&gt;**](String.md) | Filter events by app UUID. Accepts up to 10 values. Org-level events are always included. | [optional] |
2695
+ | **actions** | [**Array&lt;String&gt;**](String.md) | Filter by action type (e.g. notification.sent, segment.created). Accepts up to 20 values. | [optional] |
2696
+ | **actor_ids** | [**Array&lt;String&gt;**](String.md) | Filter by actor UUID (the user or service that performed the action). Accepts up to 10 values. | [optional] |
2697
+ | **actor_emails** | [**Array&lt;String&gt;**](String.md) | Filter by actor email address. Accepts up to 10 values. | [optional] |
2698
+ | **target_types** | [**Array&lt;String&gt;**](String.md) | Filter by the type of resource the action was performed on (e.g. notification, segment, journey). Accepts up to 10 values. | [optional] |
2699
+ | **target_ids** | [**Array&lt;String&gt;**](String.md) | Filter by the UUID of the resource the action was performed on. Accepts up to 10 values. | [optional] |
2700
+ | **ip_addresses** | [**Array&lt;String&gt;**](String.md) | Filter by the IP address the action originated from. Accepts up to 10 values. | [optional] |
2701
+
2702
+ ### Return type
2703
+
2704
+ [**ListAuditLogsSuccessResponse**](ListAuditLogsSuccessResponse.md)
2705
+
2706
+ ### Authorization
2707
+
2708
+ [organization_api_key](https://github.com/OneSignal/onesignal-ruby-api#configuration)
2709
+
2710
+ ### HTTP request headers
2711
+
2712
+ - **Content-Type**: Not defined
2713
+ - **Accept**: application/json
2714
+
2715
+
2531
2716
  ## rotate_api_key
2532
2717
 
2533
2718
  > <CreateApiKeyResponse> rotate_api_key(app_id, token_id)
@@ -3084,6 +3269,88 @@ end
3084
3269
  - **Accept**: application/json
3085
3270
 
3086
3271
 
3272
+ ## update_segment
3273
+
3274
+ > <UpdateSegmentSuccessResponse> update_segment(app_id, segment_id, opts)
3275
+
3276
+ Update Segment
3277
+
3278
+ Update an existing segment's name and/or filters. The name parameter is always required. When filters are provided, all existing filters are replaced with the new ones.
3279
+
3280
+ ### Examples
3281
+
3282
+ ```ruby
3283
+ require 'onesignal'
3284
+ # setup authorization
3285
+ OneSignal.configure do |config|
3286
+ # Configure Bearer authorization: rest_api_key
3287
+ config.rest_api_key = 'YOUR_REST_API_KEY'
3288
+
3289
+ end
3290
+
3291
+ api_instance = OneSignal::DefaultApi.new
3292
+ app_id = 'YOUR_APP_ID' # String | The OneSignal App ID for your app. Available in Keys & IDs.
3293
+ segment_id = 'd6c5a3e1-9f17-44a1-9d10-7c0e4a2b1c8e' # String | The segment's unique identifier. Can be found using the View Segments API or in the URL of the segment when viewing it in the dashboard.
3294
+ opts = {
3295
+ update_segment_request: OneSignal::UpdateSegmentRequest.new({name: 'name_example'}) # UpdateSegmentRequest |
3296
+ }
3297
+
3298
+ begin
3299
+ # Update Segment
3300
+ result = api_instance.update_segment(app_id, segment_id, opts)
3301
+ p result
3302
+ rescue OneSignal::ApiError => e
3303
+ puts "Error when calling DefaultApi->update_segment: #{e}"
3304
+ puts "Status Code: #{e.code}"
3305
+ # `e.error_messages` flattens any error-envelope shape to an Array<String>;
3306
+ # the raw body remains on `e.response_body`.
3307
+ puts "Error Messages: #{e.error_messages}"
3308
+ puts "Response Body: #{e.response_body}"
3309
+ end
3310
+ ```
3311
+
3312
+ #### Using the update_segment_with_http_info variant
3313
+
3314
+ This returns an Array which contains the response data, status code and headers.
3315
+
3316
+ > <Array(<UpdateSegmentSuccessResponse>, Integer, Hash)> update_segment_with_http_info(app_id, segment_id, opts)
3317
+
3318
+ ```ruby
3319
+ begin
3320
+ # Update Segment
3321
+ data, status_code, headers = api_instance.update_segment_with_http_info(app_id, segment_id, opts)
3322
+ p status_code # => 2xx
3323
+ p headers # => { ... }
3324
+ p data # => <UpdateSegmentSuccessResponse>
3325
+ rescue OneSignal::ApiError => e
3326
+ puts "Error when calling DefaultApi->update_segment_with_http_info: #{e}"
3327
+ puts "Status Code: #{e.code}"
3328
+ puts "Response Body: #{e.response_body}"
3329
+ end
3330
+ ```
3331
+
3332
+ ### Parameters
3333
+
3334
+ | Name | Type | Description | Notes |
3335
+ | ---- | ---- | ----------- | ----- |
3336
+ | **app_id** | **String** | The OneSignal App ID for your app. Available in Keys &amp; IDs. | |
3337
+ | **segment_id** | **String** | The segment&#39;s unique identifier. Can be found using the View Segments API or in the URL of the segment when viewing it in the dashboard. | |
3338
+ | **update_segment_request** | [**UpdateSegmentRequest**](UpdateSegmentRequest.md) | | [optional] |
3339
+
3340
+ ### Return type
3341
+
3342
+ [**UpdateSegmentSuccessResponse**](UpdateSegmentSuccessResponse.md)
3343
+
3344
+ ### Authorization
3345
+
3346
+ [rest_api_key](https://github.com/OneSignal/onesignal-ruby-api#configuration)
3347
+
3348
+ ### HTTP request headers
3349
+
3350
+ - **Content-Type**: application/json
3351
+ - **Accept**: application/json
3352
+
3353
+
3087
3354
  ## update_subscription
3088
3355
 
3089
3356
  > update_subscription(app_id, subscription_id, subscription_body)
@@ -0,0 +1,20 @@
1
+ # OneSignal::GetSegmentSuccessResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **subscriber_count** | **Integer** | The number of subscribers matching this segment. | [optional] |
8
+ | **payload** | [**SegmentDetails**](SegmentDetails.md) | | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'onesignal'
14
+
15
+ instance = OneSignal::GetSegmentSuccessResponse.new(
16
+ subscriber_count: nil,
17
+ payload: nil
18
+ )
19
+ ```
20
+
@@ -0,0 +1,22 @@
1
+ # OneSignal::ListAuditLogsSuccessResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **audit_logs** | [**Array&lt;AuditLogEvent&gt;**](AuditLogEvent.md) | Array of audit log events, ordered by occurred_at ascending. | [optional] |
8
+ | **has_more** | **Boolean** | True if additional events exist beyond this page. Use next_cursor to fetch the next page. | [optional] |
9
+ | **next_cursor** | **String** | Opaque cursor to pass as cursor in the next request. Only present when has_more is true. | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'onesignal'
15
+
16
+ instance = OneSignal::ListAuditLogsSuccessResponse.new(
17
+ audit_logs: nil,
18
+ has_more: nil,
19
+ next_cursor: nil
20
+ )
21
+ ```
22
+
@@ -0,0 +1,28 @@
1
+ # OneSignal::SegmentDetails
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **id** | **String** | The unique identifier for the segment (UUID v4). | [optional] |
8
+ | **name** | **String** | The segment name. | [optional] |
9
+ | **description** | **String** | Human-readable description for the segment. &#x60;null&#x60; when unset. Maximum 255 characters. | [optional] |
10
+ | **created_at** | **Integer** | Unix timestamp when the segment was created. | [optional] |
11
+ | **source** | **String** | The source of the segment. | [optional] |
12
+ | **filters** | [**Array&lt;FilterExpression&gt;**](FilterExpression.md) | Array of filter and operator objects defining the segment criteria. Uses the same format as the Create Segment API, so filters can be directly used to recreate or update the segment. | [optional] |
13
+
14
+ ## Example
15
+
16
+ ```ruby
17
+ require 'onesignal'
18
+
19
+ instance = OneSignal::SegmentDetails.new(
20
+ id: nil,
21
+ name: nil,
22
+ description: nil,
23
+ created_at: nil,
24
+ source: nil,
25
+ filters: nil
26
+ )
27
+ ```
28
+
@@ -0,0 +1,22 @@
1
+ # OneSignal::UpdateSegmentRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **name** | **String** | Required. The segment name. Maximum 128 characters. | |
8
+ | **description** | **String** | Optional human-readable description for the segment. Maximum 255 characters. Pass an empty string to clear; omit to leave unchanged. | [optional] |
9
+ | **filters** | [**Array&lt;FilterExpression&gt;**](FilterExpression.md) | Optional. When provided, replaces all existing filters. Filters define the segment based on user properties like tags, activity, or location using flexible AND/OR logic. Limited to 200 total entries, including fields and OR operators. | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'onesignal'
15
+
16
+ instance = OneSignal::UpdateSegmentRequest.new(
17
+ name: nil,
18
+ description: nil,
19
+ filters: nil
20
+ )
21
+ ```
22
+
@@ -0,0 +1,20 @@
1
+ # OneSignal::UpdateSegmentSuccessResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **success** | **Boolean** | true if the segment was updated successfully, false otherwise. | [optional] |
8
+ | **id** | **String** | UUID of the updated segment. | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'onesignal'
14
+
15
+ instance = OneSignal::UpdateSegmentSuccessResponse.new(
16
+ success: nil,
17
+ id: nil
18
+ )
19
+ ```
20
+