Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.10.0
- Package version: 5.10.0
- API version: 5.11.0
- Package version: 5.11.0

## Installation

Add to your `Gemfile`:

```ruby
gem 'onesignal', '~> 5.10.0'
gem 'onesignal', '~> 5.11.0'
```

Then run `bundle install`.
Expand Down
26 changes: 26 additions & 0 deletions docs/AuditLogActor.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# OneSignal::AuditLogActor

## Properties

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **email** | **String** | Email address of the actor. Absent if unavailable. | [optional] |
| **id** | **String** | UUID of the actor. | [optional] |
| **metadata** | **Object** | Additional actor-specific data. | [optional] |
| **name** | **String** | Display name of the actor. Absent if unavailable. | [optional] |
| **type** | **String** | Actor type (e.g. member, api_key, system). | [optional] |

## Example

```ruby
require 'onesignal'

instance = OneSignal::AuditLogActor.new(
email: nil,
id: nil,
metadata: nil,
name: nil,
type: nil
)
```

24 changes: 24 additions & 0 deletions docs/AuditLogContext.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# OneSignal::AuditLogContext

## Properties

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **country** | **String** | Country code derived from the request IP. | [optional] |
| **ip** | **String** | IP address the request originated from. | [optional] |
| **metadata** | **Object** | Additional context-specific data. | [optional] |
| **user_agent** | **String** | User agent of the client that made the request. | [optional] |

## Example

```ruby
require 'onesignal'

instance = OneSignal::AuditLogContext.new(
country: nil,
ip: nil,
metadata: nil,
user_agent: nil
)
```

36 changes: 36 additions & 0 deletions docs/AuditLogEvent.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# OneSignal::AuditLogEvent

## Properties

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **action** | **String** | The action that was performed (e.g. notification.sent, segment.created, member.invited). | [optional] |
| **actor** | [**AuditLogActor**](AuditLogActor.md) | | [optional] |
| **app_id** | **String** | UUID of the app the event is associated with. Absent for org-level events. | [optional] |
| **context** | [**AuditLogContext**](AuditLogContext.md) | | [optional] |
| **id** | **String** | UUID of the audit log event. | [optional] |
| **metadata** | **Object** | Additional event-specific data that does not fit into the standard fields. | [optional] |
| **occurred_at** | **String** | RFC 3339 timestamp of when the event occurred (e.g. 2026-02-18T12:34:56Z). | [optional] |
| **organization_id** | **String** | UUID of the organization the event belongs to. | [optional] |
| **targets** | [**Array<AuditLogTarget>**](AuditLogTarget.md) | The resources the action was performed on. May be empty for org-level events. | [optional] |
| **version** | **Integer** | Schema version of the event payload. | [optional] |

## Example

```ruby
require 'onesignal'

instance = OneSignal::AuditLogEvent.new(
action: nil,
actor: nil,
app_id: nil,
context: nil,
id: nil,
metadata: nil,
occurred_at: nil,
organization_id: nil,
targets: nil,
version: nil
)
```

24 changes: 24 additions & 0 deletions docs/AuditLogTarget.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# OneSignal::AuditLogTarget

## Properties

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **id** | **String** | UUID of the resource. | [optional] |
| **metadata** | **Object** | Additional resource-specific data. | [optional] |
| **name** | **String** | Display name of the resource. Absent if unavailable. | [optional] |
| **type** | **String** | Resource type (e.g. notification, segment, journey, app). | [optional] |

## Example

```ruby
require 'onesignal'

instance = OneSignal::AuditLogTarget.new(
id: nil,
metadata: nil,
name: nil,
type: nil
)
```

Loading