onesignal 5.17.0 → 5.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1b41bdc34e70437322c8bb7db670c5686f9832af8e78035907534a721c0e59d3
-  data.tar.gz: 2b1582c9da87273abced5b74127f9bfaeffda11354123cb342f6d2801656a556
+  metadata.gz: 3f913f0ad3fb26a447ee94a14fdc02d6c2b539e20a226664cbac357b81dd7857
+  data.tar.gz: 2cf7a7de8f23c4630c7c7797dbbe7dc2a40cc9f64633324ef9be01e894ac895c
 SHA512:
-  metadata.gz: 6457110df5fc0f411892d777064ef6c26b101d3b532482eb2fb8b01ef30c8d21a3780bf5ee9e84581f44bd0d21056764084224889f080cdedcaddda943b2e5e6
-  data.tar.gz: 53c79da8af5027cb2415d14fe086b5280d702c1e3650ebfb148cd4400c3c0d52ae5424d79d0e667e5b9ed7ef0d8fbb6a71c339ae2138dd568908f9451039c876
+  metadata.gz: b0103aa968b00d7757ca8dbb3a29c5b2ac66b7d4133397bbd294cdb290db0c441d433204392a6eb32995620190079b14ceac5f0ef348ac2f9b9ec5ae6d40c64d
+  data.tar.gz: 5abe54075e9d9bfb8dfbef376a38bdae885d0083e8b34f9899050ec84e22d681b3dd03e1c9f766dbca4329965b8dd05349789609faff2b66b8a3e92be7f1cdc7

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## [5.17.0](https://github.com/OneSignal/onesignal-ruby-api/compare/v5.16.0...v5.17.0) (2026-10-02)
+
+### Features
+
+* add v5.17.0 package updates ([aad9aa7](https://github.com/OneSignal/onesignal-ruby-api/commit/aad9aa71252c6f42c47cde91f4dcf5820fa25b56))
+* add v5.17.0 package updates ([#135](https://github.com/OneSignal/onesignal-ruby-api/issues/135)) ([34cbe92](https://github.com/OneSignal/onesignal-ruby-api/commit/34cbe92a91f2b20feba25e92cb40d26b4558d343)), closes [OneSignal/api-client-libraries#468](https://github.com/OneSignal/api-client-libraries/issues/468) [OneSignal/api-client-libraries#469](https://github.com/OneSignal/api-client-libraries/issues/469) [OneSignal/api-client-libraries#470](https://github.com/OneSignal/api-client-libraries/issues/470)
+
 ## [5.16.0](https://github.com/OneSignal/onesignal-ruby-api/compare/v5.15.0...v5.16.0) (2026-09-09)
 
 ### Features

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    onesignal (5.17.0)
+    onesignal (5.18.0)
       typhoeus (~> 1.0, >= 1.0.1)
 
 GEM
@@ -11,7 +11,7 @@ GEM
     byebug (13.0.0)
       reline (>= 0.6.0)
     coderay (1.1.3)
-    date (3.5.1)
+    date (3.6.0)
     diff-lcs (1.6.2)
     ethon (0.18.0)
       ffi (>= 1.15.0)

data/README.md

@@ -6,15 +6,15 @@ OneSignal - the Ruby gem for OneSignal
 
 A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com
 
-- API version: 5.17.0
-- Package version: 5.17.0
+- API version: 5.18.0
+- Package version: 5.18.0
 
 ## Installation
 
 Add to your `Gemfile`:
 
 ```ruby
-gem 'onesignal', '~> 5.17.0'
+gem 'onesignal', '~> 5.18.0'
 ```
 
 Then run `bundle install`.

data/docs/DefaultApi.md

@@ -32,6 +32,8 @@ All URIs are relative to *https://api.onesignal.com*
 | [**get_aliases_by_subscription**](DefaultApi.md#get_aliases_by_subscription) | **GET** /apps/{app_id}/subscriptions/{subscription_id}/user/identity |  |
 | [**get_app**](DefaultApi.md#get_app) | **GET** /apps/{app_id} | View an app |
 | [**get_apps**](DefaultApi.md#get_apps) | **GET** /apps | View apps |
+| [**get_email_provider_metrics**](DefaultApi.md#get_email_provider_metrics) | **GET** /apps/{app_id}/email_analytics/provider_metrics | Get email inbox provider metrics |
+| [**get_email_provider_metrics_timeseries**](DefaultApi.md#get_email_provider_metrics_timeseries) | **GET** /apps/{app_id}/email_analytics/provider_metrics_timeseries | Get email inbox provider metrics over time |
 | [**get_email_reputation**](DefaultApi.md#get_email_reputation) | **GET** /apps/{app_id}/email_analytics/delivery_metrics | Get email reputation statistics |
 | [**get_notification**](DefaultApi.md#get_notification) | **GET** /notifications/{notification_id} | View notification |
 | [**get_notification_history**](DefaultApi.md#get_notification_history) | **POST** /notifications/{notification_id}/history | Notification History |
@@ -198,7 +200,7 @@ end
 api_instance = OneSignal::DefaultApi.new
 template_id = 'e4d3c2b1-a09f-4f1e-8d7c-6b5a4f3e2d1c' # String | 
 app_id = 'YOUR_APP_ID' # String | 
-copy_template_request = OneSignal::CopyTemplateRequest.new({target_app_id: 'target_app_id_example'}) # CopyTemplateRequest | 
+copy_template_request = OneSignal::CopyTemplateRequest.new({target_app_id: 'YOUR_TARGET_APP_ID'}) # CopyTemplateRequest | 
 
 begin
   # Copy template to another app
@@ -593,7 +595,7 @@ end
 
 api_instance = OneSignal::DefaultApi.new
 app_id = 'YOUR_APP_ID' # String | Your OneSignal App ID in UUID v4 format.
-custom_events_request = OneSignal::CustomEventsRequest.new({events: [OneSignal::CustomEvent.new({name: 'name_example'})]}) # CustomEventsRequest | 
+custom_events_request = OneSignal::CustomEventsRequest.new({events: [OneSignal::CustomEvent.new({name: 'YOUR_NAME'})]}) # CustomEventsRequest | 
 
 begin
   # Create custom events
@@ -671,7 +673,7 @@ end
 
 api_instance = OneSignal::DefaultApi.new
 app_id = 'YOUR_APP_ID' # String | Your OneSignal App ID in UUID v4 format.
-create_journey_request = OneSignal::CreateJourneyRequest.new({name: 'name_example'}) # CreateJourneyRequest | 
+create_journey_request = OneSignal::CreateJourneyRequest.new({name: 'YOUR_NAME'}) # CreateJourneyRequest | 
 
 begin
   # Create journey
@@ -1044,7 +1046,7 @@ OneSignal.configure do |config|
 end
 
 api_instance = OneSignal::DefaultApi.new
-create_template_request = OneSignal::CreateTemplateRequest.new({app_id: 'app_id_example', name: 'name_example', contents: OneSignal::LanguageStringMap.new}) # CreateTemplateRequest | 
+create_template_request = OneSignal::CreateTemplateRequest.new({app_id: 'YOUR_APP_ID', name: 'YOUR_NAME', contents: OneSignal::LanguageStringMap.new}) # CreateTemplateRequest | 
 
 begin
   # Create template
@@ -1842,7 +1844,7 @@ OneSignal.configure do |config|
 end
 
 api_instance = OneSignal::DefaultApi.new
-estimate_notification_recipients_request = OneSignal::EstimateNotificationRecipientsRequest.new({app_id: 'app_id_example'}) # EstimateNotificationRecipientsRequest | 
+estimate_notification_recipients_request = OneSignal::EstimateNotificationRecipientsRequest.new({app_id: 'YOUR_APP_ID'}) # EstimateNotificationRecipientsRequest | 
 
 begin
   # Estimate notification recipients
@@ -2363,6 +2365,176 @@ This endpoint does not need any parameter.
 - **Accept**: application/json
 
 
+## get_email_provider_metrics
+
+> <EmailProviderMetricsResponse> get_email_provider_metrics(app_id, domain, start, _end)
+
+Get email inbox provider metrics
+
+Email delivery, opens, clicks, bounces, failures, and spam complaints broken down by inbox provider (Gmail, Outlook, Yahoo, Apple, and more) to pinpoint where deliverability problems are coming from. Metrics are reported for a single sending domain over the requested time range. `start` must be before `end` and no more than 365 days ago. `providers` is empty when the domain is not found for the app or is not currently active for sending. 
+
+### Examples
+
+```ruby
+require 'onesignal'
+# setup authorization
+OneSignal.configure do |config|
+  # Configure Bearer authorization: rest_api_key
+  config.rest_api_key = 'YOUR_REST_API_KEY'
+
+end
+
+api_instance = OneSignal::DefaultApi.new
+app_id = 'YOUR_APP_ID' # String | Your OneSignal App ID in UUID v4 format.
+domain = 'mail.example.com' # String | The sending domain to report on. Must be an email domain configured for this app.
+start = Time.parse('2026-08-01T00:00Z') # Time | Start of the reporting window, as an ISO 8601 timestamp (for example, `2026-08-01T00:00:00Z`).
+_end = Time.parse('2026-08-08T00:00Z') # Time | End of the reporting window, as an ISO 8601 timestamp (for example, `2026-08-08T00:00:00Z`).
+
+begin
+  # Get email inbox provider metrics
+  result = api_instance.get_email_provider_metrics(app_id, domain, start, _end)
+  p result
+rescue OneSignal::ApiError => e
+  puts "Error when calling DefaultApi->get_email_provider_metrics: #{e}"
+  puts "Status Code: #{e.code}"
+  # `e.error_messages` flattens any error-envelope shape to an Array<String>;
+  # the raw body remains on `e.response_body`.
+  puts "Error Messages: #{e.error_messages}"
+  puts "Response Body: #{e.response_body}"
+end
+```
+
+#### Using the get_email_provider_metrics_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<EmailProviderMetricsResponse>, Integer, Hash)> get_email_provider_metrics_with_http_info(app_id, domain, start, _end)
+
+```ruby
+begin
+  # Get email inbox provider metrics
+  data, status_code, headers = api_instance.get_email_provider_metrics_with_http_info(app_id, domain, start, _end)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <EmailProviderMetricsResponse>
+rescue OneSignal::ApiError => e
+  puts "Error when calling DefaultApi->get_email_provider_metrics_with_http_info: #{e}"
+  puts "Status Code: #{e.code}"
+  puts "Response Body: #{e.response_body}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **app_id** | **String** | Your OneSignal App ID in UUID v4 format. |  |
+| **domain** | **String** | The sending domain to report on. Must be an email domain configured for this app. |  |
+| **start** | **Time** | Start of the reporting window, as an ISO 8601 timestamp (for example, &#x60;2026-08-01T00:00:00Z&#x60;). |  |
+| **_end** | **Time** | End of the reporting window, as an ISO 8601 timestamp (for example, &#x60;2026-08-08T00:00:00Z&#x60;). |  |
+
+### Return type
+
+[**EmailProviderMetricsResponse**](EmailProviderMetricsResponse.md)
+
+### Authorization
+
+[rest_api_key](https://github.com/OneSignal/onesignal-ruby-api#configuration)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_email_provider_metrics_timeseries
+
+> <EmailProviderMetricsTimeseriesResponse> get_email_provider_metrics_timeseries(app_id, domain, start, _end, granularity, opts)
+
+Get email inbox provider metrics over time
+
+Email delivery, opens, clicks, bounces, failures, and spam complaints for a sending domain over time, bucketed by hour, day, or month. Use `providers[]` to narrow the totals to specific inbox providers (Gmail, Outlook, Yahoo, Apple, and more) and track how deliverability to them changes. Each event's metrics are totaled across the requested providers, or across all providers when none are given. `start` must be before `end` and no more than 365 days ago, or 60 days ago for `hourly` granularity. `events` is empty when the domain is not found for the app or is not currently active for sending. 
+
+### Examples
+
+```ruby
+require 'onesignal'
+# setup authorization
+OneSignal.configure do |config|
+  # Configure Bearer authorization: rest_api_key
+  config.rest_api_key = 'YOUR_REST_API_KEY'
+
+end
+
+api_instance = OneSignal::DefaultApi.new
+app_id = 'YOUR_APP_ID' # String | Your OneSignal App ID in UUID v4 format.
+domain = 'mail.example.com' # String | The sending domain to report on. Must be an email domain configured for this app.
+start = Time.parse('2026-08-01T00:00Z') # Time | Start of the reporting window, as an ISO 8601 timestamp (for example, `2026-08-01T00:00:00Z`).
+_end = Time.parse('2026-08-08T00:00Z') # Time | End of the reporting window, as an ISO 8601 timestamp (for example, `2026-08-08T00:00:00Z`).
+granularity = 'hourly' # String | The size of each time bucket. Hourly data is only available for the last 60 days.
+opts = {
+  providers: ['gmail'] # Array<String> | Inbox providers to include in the totals. Omit to include all providers. Accepted values: `apple`, `att`, `canadian`, `chinese`, `comcast`, `free_fr`, `french`, `german`, `gmail`, `google_workspace`, `googlers`, `inbox_lv`, `italian`, `japanese`, `outlook_365`, `outlook_eu`, `outlook_us`, `proton`, `rackspace`, `russian`, `uk`, `united_online`, `yahoo_eu`, `yahoo_us`, `other_eu`, `other_us`, and `other`. Example: providers[]=gmail&providers[]=yahoo_us 
+}
+
+begin
+  # Get email inbox provider metrics over time
+  result = api_instance.get_email_provider_metrics_timeseries(app_id, domain, start, _end, granularity, opts)
+  p result
+rescue OneSignal::ApiError => e
+  puts "Error when calling DefaultApi->get_email_provider_metrics_timeseries: #{e}"
+  puts "Status Code: #{e.code}"
+  # `e.error_messages` flattens any error-envelope shape to an Array<String>;
+  # the raw body remains on `e.response_body`.
+  puts "Error Messages: #{e.error_messages}"
+  puts "Response Body: #{e.response_body}"
+end
+```
+
+#### Using the get_email_provider_metrics_timeseries_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<EmailProviderMetricsTimeseriesResponse>, Integer, Hash)> get_email_provider_metrics_timeseries_with_http_info(app_id, domain, start, _end, granularity, opts)
+
+```ruby
+begin
+  # Get email inbox provider metrics over time
+  data, status_code, headers = api_instance.get_email_provider_metrics_timeseries_with_http_info(app_id, domain, start, _end, granularity, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <EmailProviderMetricsTimeseriesResponse>
+rescue OneSignal::ApiError => e
+  puts "Error when calling DefaultApi->get_email_provider_metrics_timeseries_with_http_info: #{e}"
+  puts "Status Code: #{e.code}"
+  puts "Response Body: #{e.response_body}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **app_id** | **String** | Your OneSignal App ID in UUID v4 format. |  |
+| **domain** | **String** | The sending domain to report on. Must be an email domain configured for this app. |  |
+| **start** | **Time** | Start of the reporting window, as an ISO 8601 timestamp (for example, &#x60;2026-08-01T00:00:00Z&#x60;). |  |
+| **_end** | **Time** | End of the reporting window, as an ISO 8601 timestamp (for example, &#x60;2026-08-08T00:00:00Z&#x60;). |  |
+| **granularity** | **String** | The size of each time bucket. Hourly data is only available for the last 60 days. |  |
+| **providers** | [**Array&lt;String&gt;**](String.md) | Inbox providers to include in the totals. Omit to include all providers. Accepted values: &#x60;apple&#x60;, &#x60;att&#x60;, &#x60;canadian&#x60;, &#x60;chinese&#x60;, &#x60;comcast&#x60;, &#x60;free_fr&#x60;, &#x60;french&#x60;, &#x60;german&#x60;, &#x60;gmail&#x60;, &#x60;google_workspace&#x60;, &#x60;googlers&#x60;, &#x60;inbox_lv&#x60;, &#x60;italian&#x60;, &#x60;japanese&#x60;, &#x60;outlook_365&#x60;, &#x60;outlook_eu&#x60;, &#x60;outlook_us&#x60;, &#x60;proton&#x60;, &#x60;rackspace&#x60;, &#x60;russian&#x60;, &#x60;uk&#x60;, &#x60;united_online&#x60;, &#x60;yahoo_eu&#x60;, &#x60;yahoo_us&#x60;, &#x60;other_eu&#x60;, &#x60;other_us&#x60;, and &#x60;other&#x60;. Example: providers[]&#x3D;gmail&amp;providers[]&#x3D;yahoo_us  | [optional] |
+
+### Return type
+
+[**EmailProviderMetricsTimeseriesResponse**](EmailProviderMetricsTimeseriesResponse.md)
+
+### Authorization
+
+[rest_api_key](https://github.com/OneSignal/onesignal-ruby-api#configuration)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## get_email_reputation
 
 > <EmailReputationResponse> get_email_reputation(app_id)
@@ -3035,17 +3207,17 @@ end
 api_instance = OneSignal::DefaultApi.new
 organization_id = 'YOUR_ORG_ID' # String | The UUID of the organization to retrieve audit logs for. Must match the authenticated Organization API Key.
 opts = {
-  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.
-  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.
-  cursor: 'cursor_example', # String | Pagination cursor returned in a previous response as next_cursor. When provided, start_time and end_time are ignored.
-  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.
-  app_ids: ['inner_example'], # Array<String> | Filter events by app UUID. Accepts up to 10 values. Org-level events are always included.
-  actions: ['inner_example'], # Array<String> | Filter by action type (e.g. notification.sent, segment.created). Accepts up to 20 values.
-  actor_ids: ['inner_example'], # Array<String> | Filter by actor UUID (the user or service that performed the action). Accepts up to 10 values.
-  actor_emails: ['inner_example'], # Array<String> | Filter by actor email address. Accepts up to 10 values.
-  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.
-  target_ids: ['inner_example'], # Array<String> | Filter by the UUID of the resource the action was performed on. Accepts up to 10 values.
-  ip_addresses: ['inner_example'] # Array<String> | Filter by the IP address the action originated from. Accepts up to 10 values.
+  start_time: '2026-02-01T00:00:00Z', # 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.
+  end_time: '2026-02-02T00:00:00Z', # String | End of the time range in ISO 8601 format. Defaults to the current time. Must be after start_time.
+  cursor: 'YOUR_NEXT_CURSOR', # String | Pagination cursor returned in a previous response as next_cursor. When provided, start_time and end_time are ignored.
+  limit: 50, # Integer | Maximum number of events to return per page. Minimum 1, maximum 100. Values outside this range are clamped automatically by the server.
+  app_ids: ['YOUR_APP_ID'], # Array<String> | Filter events by app UUID. Accepts up to 10 values. Org-level events are always included.
+  actions: ['notification.sent'], # Array<String> | Filter by action type (e.g. notification.sent, segment.created). Accepts up to 20 values.
+  actor_ids: ['YOUR_ACTOR_ID'], # Array<String> | Filter by actor UUID (the user or service that performed the action). Accepts up to 10 values.
+  actor_emails: ['admin@example.com'], # Array<String> | Filter by actor email address. Accepts up to 10 values.
+  target_types: ['notification'], # Array<String> | Filter by the type of resource the action was performed on (e.g. notification, segment, journey). Accepts up to 10 values.
+  target_ids: ['YOUR_TARGET_ID'], # Array<String> | Filter by the UUID of the resource the action was performed on. Accepts up to 10 values.
+  ip_addresses: ['203.0.113.42'] # Array<String> | Filter by the IP address the action originated from. Accepts up to 10 values.
 }
 
 begin
@@ -3213,7 +3385,7 @@ end
 api_instance = OneSignal::DefaultApi.new
 app_id = 'YOUR_APP_ID' # String | Your OneSignal App ID in UUID v4 format.
 activity_type = 'order_status' # String | The name of the Live Activity defined in your app. This should match the attributes struct used in your app's Live Activity implementation.
-start_live_activity_request = OneSignal::StartLiveActivityRequest.new({name: 'name_example', event: 'start', activity_id: 'activity_id_example', event_attributes: 3.56, event_updates: 3.56, contents: OneSignal::LanguageStringMap.new, headings: OneSignal::LanguageStringMap.new}) # StartLiveActivityRequest | 
+start_live_activity_request = OneSignal::StartLiveActivityRequest.new({name: 'YOUR_NAME', event: 'start', activity_id: 'YOUR_ACTIVITY_ID', event_attributes: {}, event_updates: {}, contents: OneSignal::LanguageStringMap.new, headings: OneSignal::LanguageStringMap.new}) # StartLiveActivityRequest | 
 
 begin
   # Start Live Activity
@@ -3773,7 +3945,7 @@ end
 api_instance = OneSignal::DefaultApi.new
 app_id = 'YOUR_APP_ID' # String | The OneSignal App ID for your app.  Available in Keys & IDs.
 activity_id = '12345' # String | Live Activity record ID
-update_live_activity_request = OneSignal::UpdateLiveActivityRequest.new({name: 'name_example', event: 'update', event_updates: 3.56}) # UpdateLiveActivityRequest | 
+update_live_activity_request = OneSignal::UpdateLiveActivityRequest.new({name: 'YOUR_NAME', event: 'update', event_updates: {}}) # UpdateLiveActivityRequest | 
 
 begin
   # Update a Live Activity via Push
@@ -3854,7 +4026,7 @@ api_instance = OneSignal::DefaultApi.new
 app_id = 'YOUR_APP_ID' # String | The OneSignal App ID for your app.  Available in Keys & IDs.
 segment_id = 'd6c5a3e1-9f17-44a1-9d10-7c0e4a2b1c8e' # String | The segment's unique identifier. In the dashboard, go to Audience > Segments, open the segment's options menu, and select Copy segment ID. You can also get it from the View Segments API or the segment's URL in the dashboard.
 opts = {
-  update_segment_request: OneSignal::UpdateSegmentRequest.new({name: 'name_example'}) # UpdateSegmentRequest | 
+  update_segment_request: OneSignal::UpdateSegmentRequest.new({name: 'YOUR_NAME'}) # UpdateSegmentRequest | 
 }
 
 begin
@@ -4490,7 +4662,7 @@ end
 api_instance = OneSignal::DefaultApi.new
 app_id = 'YOUR_APP_ID' # String | Your OneSignal App ID in UUID v4 format.
 opts = {
-  cursor: 'cursor_example', # String | Opaque pagination token from a previous response's next_cursor. Omit for the first page.
+  cursor: 'YOUR_NEXT_CURSOR', # String | Opaque pagination token from a previous response's next_cursor. Omit for the first page.
   limit: 50 # Integer | Maximum journeys to return per page. Minimum 1, maximum 50.
 }
 

data/docs/EmailMetrics.md

@@ -0,0 +1,34 @@
+# OneSignal::EmailMetrics
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **sent** | **Integer** | The number of emails sent. | [optional] |
+| **delivered** | **Integer** | The number of emails successfully delivered. | [optional] |
+| **opened** | **Integer** | The total number of email opens, including repeat opens by the same recipient. | [optional] |
+| **clicked** | **Integer** | The total number of email link clicks, including repeat clicks by the same recipient. | [optional] |
+| **unique_opened** | **Integer** | The number of emails opened at least once. | [optional] |
+| **unique_clicked** | **Integer** | The number of emails with at least one link click. | [optional] |
+| **failed** | **Integer** | The number of emails that failed to send. | [optional] |
+| **bounced** | **Integer** | The number of emails that bounced. | [optional] |
+| **complained** | **Integer** | The number of emails that recipients reported as spam. | [optional] |
+
+## Example
+
+```ruby
+require 'onesignal'
+
+instance = OneSignal::EmailMetrics.new(
+  sent: 100,
+  delivered: 95,
+  opened: 40,
+  clicked: 10,
+  unique_opened: 35,
+  unique_clicked: 8,
+  failed: 5,
+  bounced: 3,
+  complained: 1
+)
+```
+

data/docs/EmailProviderMetrics.md

@@ -0,0 +1,20 @@
+# OneSignal::EmailProviderMetrics
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **provider** | **String** | The inbox provider. Known values include `apple`, `att`, `canadian`, `chinese`, `comcast`, `free_fr`, `french`, `german`, `gmail`, `google_workspace`, `googlers`, `inbox_lv`, `italian`, `japanese`, `outlook_365`, `outlook_eu`, `outlook_us`, `proton`, `rackspace`, `russian`, `uk`, `united_online`, `yahoo_eu`, `yahoo_us`, `other_eu`, `other_us`, and `other`. New providers may be added over time. | [optional] |
+| **metrics** | [**EmailMetrics**](EmailMetrics.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'onesignal'
+
+instance = OneSignal::EmailProviderMetrics.new(
+  provider: 'gmail',
+  metrics: nil
+)
+```
+

data/docs/EmailProviderMetricsEvent.md

@@ -0,0 +1,20 @@
+# OneSignal::EmailProviderMetricsEvent
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **date** | **Time** | The start of the time bucket, aligned to the hour, day, or month in UTC. | [optional] |
+| **metrics** | [**EmailMetrics**](EmailMetrics.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'onesignal'
+
+instance = OneSignal::EmailProviderMetricsEvent.new(
+  date: 2026-08-01T00:00Z,
+  metrics: nil
+)
+```
+

data/docs/EmailProviderMetricsResponse.md

@@ -0,0 +1,18 @@
+# OneSignal::EmailProviderMetricsResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **providers** | [**Array<EmailProviderMetrics>**](EmailProviderMetrics.md) | One entry per inbox provider that received email from the domain during the reporting window. Empty when the domain is not found for the app or is not currently active for sending. | [optional] |
+
+## Example
+
+```ruby
+require 'onesignal'
+
+instance = OneSignal::EmailProviderMetricsResponse.new(
+  providers: nil
+)
+```
+

data/docs/EmailProviderMetricsTimeseriesResponse.md

@@ -0,0 +1,18 @@
+# OneSignal::EmailProviderMetricsTimeseriesResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **events** | [**Array<EmailProviderMetricsEvent>**](EmailProviderMetricsEvent.md) | One entry for every time bucket in the reporting window, oldest first. Buckets with no email activity are included with all metrics set to `0`. Empty when the domain is not found for the app or is not currently active for sending. | [optional] |
+
+## Example
+
+```ruby
+require 'onesignal'
+
+instance = OneSignal::EmailProviderMetricsTimeseriesResponse.new(
+  events: nil
+)
+```
+