onesignal 5.8.0 → 5.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c5f21652919d2dee3326e3cf1caa4d61af452c293c03267c10ffd8ba49204712
-  data.tar.gz: aab106e37eefe2a2434cce59310f49e18c17e7b1374c98b70b08d86235aade79
+  metadata.gz: 6f0c493c9776b8f47b129a89f0eafb238913d5c273fb9d862a6d8b8679a53175
+  data.tar.gz: 9a9c1449f271fa6d491b8c56ce26d4bef0a6ac096cf7e7bb92de386952efed5e
 SHA512:
-  metadata.gz: 1f316f47a20766af759310551a103afbdf209bbbb0a55c27199cbc94e3c7545481d66b18f16148dbc29d4141c6728263e9ea88485c49909e103aa94af94c8dae
-  data.tar.gz: ce896ee973a613861cde622de00802077df6d15379835bc532206888139410f4125c0929a979bdd5a1523892b7d2924ee5f19136a8864bf887c97dd451556fab
+  metadata.gz: 149da07e3088478de466abed41eb2b73ca48d304ca4dbcab483d24bca24028d689557003e1c6fb32a6e6d24e59f6d8f045ec39d89f403a3c17019c1461133ea8
+  data.tar.gz: '01682a3ca520c4e75655f2f537af2d5bee89aa199136ae1c0f54a4a00b5c2998c660e05e99b79892368eb605964913631ba3aba1ab7abb8309cc6a8d4161aaf0'

data/AGENTS.md

@@ -0,0 +1,66 @@
+# AGENTS.md — OneSignal Ruby SDK
+
+Integration guide for AI agents and LLMs using the `onesignal` gem, the OneSignal server SDK for Ruby. Human-oriented docs are in the [README](./README.md).
+
+## What this SDK does
+
+Server-side access to the OneSignal REST API: send push / email / SMS, manage users, subscriptions, segments, templates and live activities, and administer apps & API keys.
+
+- Gem: `onesignal`
+- Repository: https://github.com/OneSignal/onesignal-ruby-api
+
+## Install
+
+```sh
+gem install onesignal
+```
+
+## Authentication — two key types
+
+OneSignal uses two bearer credentials; each endpoint requires a specific one:
+
+- **REST API key** — used by almost every endpoint (notifications, users, subscriptions, segments, templates, live activities, custom events). Found in **App Settings → Keys & IDs**.
+- **Organization API key** — required *only* for organization-level endpoints: app management (list / create / get / update apps), API-key management (view / create / update / rotate / delete API keys), and copying a template to another app. Found in **Organization Settings**.
+
+Configure both; the SDK sends the correct credential per endpoint. Never hard-code keys — read them from environment variables or a secrets manager.
+
+```ruby
+require 'onesignal'
+
+OneSignal.configure do |config|
+  config.rest_api_key = ENV['ONESIGNAL_REST_API_KEY']
+  config.organization_api_key = ENV['ONESIGNAL_ORGANIZATION_API_KEY']
+end
+
+client = OneSignal::DefaultApi.new
+```
+
+## Calling convention
+
+Methods take **positional arguments**. Build the model object and pass it directly — do **not** wrap arguments in a request/options object.
+
+```ruby
+notification = OneSignal::Notification.new
+notification.app_id = 'YOUR_APP_ID'
+notification.contents = OneSignal::LanguageStringMap.new({ en: 'Hello from OneSignal!' })
+notification.include_aliases = { 'external_id' => ['YOUR_USER_EXTERNAL_ID'] }
+notification.target_channel = 'push'
+
+response = client.create_notification(notification)
+```
+
+## Idempotent sends & retries
+
+Set `idempotency_key` (a UUID) so a create-notification request can be safely retried — the server returns the original result instead of sending twice. The `create_notification_with_retry` helper handles this for you: it generates an `idempotency_key` when absent, retries `429` / `503` / transport errors with the **same** key (honoring `Retry-After`), and reports via `was_replayed` whether the server answered from a previously completed request.
+
+```ruby
+result = client.create_notification_with_retry(notification, max_retries: 5, base_delay: 1.0)
+puts "id: #{result.response.id}, replayed: #{result.was_replayed}"
+```
+
+> The notification-level `external_id` field is the **deprecated** idempotency mechanism — prefer `idempotency_key`. Don't confuse it with the `external_id` **alias label** (under `include_aliases`) used to target users.
+
+## Full API reference
+
+- [DefaultApi.md](https://github.com/OneSignal/onesignal-ruby-api/blob/master/docs/DefaultApi.md) — every endpoint, parameter, and model, with runnable examples.
+- [OneSignal REST API reference](https://documentation.onesignal.com/reference)

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## [5.8.0](https://github.com/OneSignal/onesignal-ruby-api/compare/v5.7.0...v5.8.0) (2026-06-24)
+
+### Features
+
+* add v5.8.0 package updates ([1650946](https://github.com/OneSignal/onesignal-ruby-api/commit/1650946a73bb8931013d03b9fa0f27e72f4c9611))
+* add v5.8.0 package updates ([#105](https://github.com/OneSignal/onesignal-ruby-api/issues/105)) ([9fa7d3b](https://github.com/OneSignal/onesignal-ruby-api/commit/9fa7d3bacf638218be26ffc47b57dbd6079c3f9f)), closes [OneSignal/api-client-libraries#402](https://github.com/OneSignal/api-client-libraries/issues/402) [OneSignal/api-client-libraries#401](https://github.com/OneSignal/api-client-libraries/issues/401) [OneSignal/api-client-libraries#400](https://github.com/OneSignal/api-client-libraries/issues/400)
+
 ## [5.7.0](https://github.com/OneSignal/onesignal-ruby-api/compare/v5.6.0...v5.7.0) (2026-06-18)
 
 ### Features

data/CLAUDE.md

@@ -0,0 +1,5 @@
+# CLAUDE.md
+
+AI agent and LLM integration guidance for this OneSignal server SDK lives in **[AGENTS.md](./AGENTS.md)** — authentication, calling conventions, idempotent retries, and the full API reference.
+
+See [AGENTS.md](./AGENTS.md).

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    onesignal (5.8.0)
+    onesignal (5.9.0)
       typhoeus (~> 1.0, >= 1.0.1)
 
 GEM

data/README.md

@@ -2,17 +2,19 @@
 
 OneSignal - the Ruby gem for OneSignal
 
+> **Building with an AI agent or LLM?** See [AGENTS.md](https://github.com/OneSignal/onesignal-ruby-api/blob/master/AGENTS.md) for an agent-oriented integration guide — authentication, calling conventions, idempotent retries, and the full API reference.
+
 A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com
 
-- API version: 5.8.0
-- Package version: 5.8.0
+- API version: 5.9.0
+- Package version: 5.9.0
 
 ## Installation
 
 Add to your `Gemfile`:
 
 ```ruby
-gem 'onesignal', '~> 5.8.0'
+gem 'onesignal', '~> 5.9.0'
 ```
 
 Then run `bundle install`.

data/docs/ApiKeyToken.md

@@ -17,12 +17,12 @@
 require 'onesignal'
 
 instance = OneSignal::ApiKeyToken.new(
-  token_id: null,
-  updated_at: null,
-  created_at: null,
-  name: null,
-  ip_allowlist_mode: null,
-  ip_allowlist: null
+  token_id: nil,
+  updated_at: nil,
+  created_at: nil,
+  name: nil,
+  ip_allowlist_mode: nil,
+  ip_allowlist: nil
 )
 ```
 

data/docs/ApiKeyTokensListResponse.md

@@ -12,7 +12,7 @@
 require 'onesignal'
 
 instance = OneSignal::ApiKeyTokensListResponse.new(
-  tokens: null
+  tokens: nil
 )
 ```
 

data/docs/App.md

@@ -45,40 +45,40 @@
 require 'onesignal'
 
 instance = OneSignal::App.new(
-  id: null,
-  name: null,
-  players: null,
-  messageable_players: null,
-  updated_at: null,
-  created_at: null,
-  android_gcm_sender_id: null,
-  gcm_key: null,
-  chrome_web_origin: null,
-  chrome_key: null,
-  chrome_web_default_notification_icon: null,
-  chrome_web_sub_domain: null,
-  apns_env: null,
-  apns_p12: null,
-  apns_p12_password: null,
-  apns_certificates: null,
-  safari_apns_certificates: null,
-  safari_apns_p12: null,
-  safari_apns_p12_password: null,
-  apns_key_id: null,
-  apns_team_id: null,
-  apns_bundle_id: null,
-  apns_p8: null,
-  safari_site_origin: null,
-  safari_push_id: null,
-  safari_icon_16_16: null,
-  safari_icon_32_32: null,
-  safari_icon_64_64: null,
-  safari_icon_128_128: null,
-  safari_icon_256_256: null,
-  site_name: null,
-  basic_auth_key: null,
-  organization_id: null,
-  additional_data_is_root_payload: null
+  id: nil,
+  name: nil,
+  players: nil,
+  messageable_players: nil,
+  updated_at: nil,
+  created_at: nil,
+  android_gcm_sender_id: nil,
+  gcm_key: nil,
+  chrome_web_origin: nil,
+  chrome_key: nil,
+  chrome_web_default_notification_icon: nil,
+  chrome_web_sub_domain: nil,
+  apns_env: nil,
+  apns_p12: nil,
+  apns_p12_password: nil,
+  apns_certificates: nil,
+  safari_apns_certificates: nil,
+  safari_apns_p12: nil,
+  safari_apns_p12_password: nil,
+  apns_key_id: nil,
+  apns_team_id: nil,
+  apns_bundle_id: nil,
+  apns_p8: nil,
+  safari_site_origin: nil,
+  safari_push_id: nil,
+  safari_icon_16_16: nil,
+  safari_icon_32_32: nil,
+  safari_icon_64_64: nil,
+  safari_icon_128_128: nil,
+  safari_icon_256_256: nil,
+  site_name: nil,
+  basic_auth_key: nil,
+  organization_id: nil,
+  additional_data_is_root_payload: nil
 )
 ```
 

data/docs/BasicNotification.md

@@ -128,123 +128,123 @@
 require 'onesignal'
 
 instance = OneSignal::BasicNotification.new(
-  included_segments: null,
-  excluded_segments: null,
-  include_subscription_ids: null,
-  include_email_tokens: null,
-  email_to: null,
-  include_phone_numbers: null,
-  include_ios_tokens: null,
-  include_wp_wns_uris: null,
-  include_amazon_reg_ids: null,
-  include_chrome_reg_ids: null,
-  include_chrome_web_reg_ids: null,
-  include_android_reg_ids: null,
-  include_aliases: null,
-  target_channel: null,
-  id: null,
-  value: null,
-  name: null,
-  aggregation: null,
-  is_ios: null,
-  is_android: null,
-  is_huawei: null,
-  is_any_web: null,
-  is_chrome_web: null,
-  is_firefox: null,
-  is_safari: null,
-  is_wp_wns: null,
-  is_adm: null,
-  is_chrome: null,
-  app_id: null,
-  external_id: null,
-  idempotency_key: null,
-  contents: null,
-  headings: null,
-  subtitle: null,
-  data: null,
-  huawei_msg_type: null,
-  url: null,
-  web_url: null,
-  app_url: null,
-  ios_attachments: null,
-  template_id: null,
-  content_available: null,
-  mutable_content: null,
-  target_content_identifier: null,
-  big_picture: null,
-  huawei_big_picture: null,
-  adm_big_picture: null,
-  chrome_big_picture: null,
-  chrome_web_image: null,
-  buttons: null,
-  web_buttons: null,
-  ios_category: null,
-  android_channel_id: null,
-  huawei_channel_id: null,
-  existing_android_channel_id: null,
-  huawei_existing_channel_id: null,
-  android_background_layout: null,
-  small_icon: null,
-  huawei_small_icon: null,
-  large_icon: null,
-  huawei_large_icon: null,
-  adm_small_icon: null,
-  adm_large_icon: null,
-  chrome_web_icon: null,
-  chrome_web_badge: null,
-  firefox_icon: null,
-  chrome_icon: null,
-  ios_sound: null,
-  android_sound: null,
-  huawei_sound: null,
-  adm_sound: null,
-  wp_wns_sound: null,
-  android_led_color: null,
-  huawei_led_color: null,
-  android_accent_color: null,
-  huawei_accent_color: null,
-  android_visibility: null,
-  huawei_visibility: null,
-  ios_badge_type: null,
-  ios_badge_count: null,
-  collapse_id: null,
-  web_push_topic: null,
-  apns_alert: null,
-  delayed_option: null,
-  delivery_time_of_day: null,
-  ttl: null,
-  priority: null,
-  apns_push_type_override: null,
-  throttle_rate_per_minute: null,
-  android_group: null,
-  android_group_message: null,
-  adm_group: null,
-  adm_group_message: null,
-  thread_id: null,
-  summary_arg: null,
-  summary_arg_count: null,
-  ios_relevance_score: null,
-  ios_interruption_level: null,
-  email_subject: null,
-  email_body: null,
-  email_from_name: null,
-  email_from_address: null,
-  email_reply_to_address: null,
-  email_preheader: null,
-  disable_email_click_tracking: null,
-  include_unsubscribed: null,
-  email_bcc: null,
-  email_sender_domain: null,
-  sms_from: null,
-  sms_media_urls: null,
-  filters: null,
-  custom_data: null,
-  huawei_badge_class: null,
-  huawei_badge_add_num: null,
-  huawei_badge_set_num: null,
-  huawei_category: null,
-  huawei_bi_tag: null
+  included_segments: nil,
+  excluded_segments: nil,
+  include_subscription_ids: nil,
+  include_email_tokens: nil,
+  email_to: nil,
+  include_phone_numbers: nil,
+  include_ios_tokens: nil,
+  include_wp_wns_uris: nil,
+  include_amazon_reg_ids: nil,
+  include_chrome_reg_ids: nil,
+  include_chrome_web_reg_ids: nil,
+  include_android_reg_ids: nil,
+  include_aliases: nil,
+  target_channel: nil,
+  id: nil,
+  value: nil,
+  name: nil,
+  aggregation: nil,
+  is_ios: nil,
+  is_android: nil,
+  is_huawei: nil,
+  is_any_web: nil,
+  is_chrome_web: nil,
+  is_firefox: nil,
+  is_safari: nil,
+  is_wp_wns: nil,
+  is_adm: nil,
+  is_chrome: nil,
+  app_id: nil,
+  external_id: nil,
+  idempotency_key: nil,
+  contents: nil,
+  headings: nil,
+  subtitle: nil,
+  data: nil,
+  huawei_msg_type: nil,
+  url: nil,
+  web_url: nil,
+  app_url: nil,
+  ios_attachments: nil,
+  template_id: nil,
+  content_available: nil,
+  mutable_content: nil,
+  target_content_identifier: nil,
+  big_picture: nil,
+  huawei_big_picture: nil,
+  adm_big_picture: nil,
+  chrome_big_picture: nil,
+  chrome_web_image: nil,
+  buttons: nil,
+  web_buttons: nil,
+  ios_category: nil,
+  android_channel_id: nil,
+  huawei_channel_id: nil,
+  existing_android_channel_id: nil,
+  huawei_existing_channel_id: nil,
+  android_background_layout: nil,
+  small_icon: nil,
+  huawei_small_icon: nil,
+  large_icon: nil,
+  huawei_large_icon: nil,
+  adm_small_icon: nil,
+  adm_large_icon: nil,
+  chrome_web_icon: nil,
+  chrome_web_badge: nil,
+  firefox_icon: nil,
+  chrome_icon: nil,
+  ios_sound: nil,
+  android_sound: nil,
+  huawei_sound: nil,
+  adm_sound: nil,
+  wp_wns_sound: nil,
+  android_led_color: nil,
+  huawei_led_color: nil,
+  android_accent_color: nil,
+  huawei_accent_color: nil,
+  android_visibility: nil,
+  huawei_visibility: nil,
+  ios_badge_type: nil,
+  ios_badge_count: nil,
+  collapse_id: nil,
+  web_push_topic: nil,
+  apns_alert: nil,
+  delayed_option: nil,
+  delivery_time_of_day: nil,
+  ttl: nil,
+  priority: nil,
+  apns_push_type_override: nil,
+  throttle_rate_per_minute: nil,
+  android_group: nil,
+  android_group_message: nil,
+  adm_group: nil,
+  adm_group_message: nil,
+  thread_id: nil,
+  summary_arg: nil,
+  summary_arg_count: nil,
+  ios_relevance_score: nil,
+  ios_interruption_level: nil,
+  email_subject: nil,
+  email_body: nil,
+  email_from_name: nil,
+  email_from_address: nil,
+  email_reply_to_address: nil,
+  email_preheader: nil,
+  disable_email_click_tracking: nil,
+  include_unsubscribed: nil,
+  email_bcc: nil,
+  email_sender_domain: nil,
+  sms_from: nil,
+  sms_media_urls: nil,
+  filters: nil,
+  custom_data: nil,
+  huawei_badge_class: nil,
+  huawei_badge_add_num: nil,
+  huawei_badge_set_num: nil,
+  huawei_category: nil,
+  huawei_bi_tag: nil
 )
 ```