Skip to content
Closed
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
627 changes: 627 additions & 0 deletions api/openapi.yaml

Large diffs are not rendered by default.

18 changes: 18 additions & 0 deletions docs/AuditLogActor.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@


# AuditLogActor

The user or service that performed the action. Absent if the actor is unknown.

## 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] |



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


# AuditLogContext

Request context at the time of the event. Absent if context was not captured.

## 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] |
|**userAgent** | **String** | User agent of the client that made the request. | [optional] |



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


# 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] |
|**appId** | **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] |
|**occurredAt** | **String** | RFC 3339 timestamp of when the event occurred (e.g. 2026-02-18T12:34:56Z). | [optional] |
|**organizationId** | **String** | UUID of the organization the event belongs to. | [optional] |
|**targets** | [**List<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] |



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


# AuditLogTarget

A resource the action was performed on.

## 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] |



257 changes: 257 additions & 0 deletions docs/DefaultApi.md

Large diffs are not rendered by default.

14 changes: 14 additions & 0 deletions docs/GetSegmentSuccessResponse.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@


# GetSegmentSuccessResponse


## Properties

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**subscriberCount** | **Integer** | The number of subscribers matching this segment. | [optional] |
|**payload** | [**SegmentDetails**](SegmentDetails.md) | | [optional] |



15 changes: 15 additions & 0 deletions docs/ListAuditLogsSuccessResponse.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@


# ListAuditLogsSuccessResponse


## Properties

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**auditLogs** | [**List<AuditLogEvent>**](AuditLogEvent.md) | Array of audit log events, ordered by occurred_at ascending. | [optional] |
|**hasMore** | **Boolean** | True if additional events exist beyond this page. Use next_cursor to fetch the next page. | [optional] |
|**nextCursor** | **String** | Opaque cursor to pass as cursor in the next request. Only present when has_more is true. | [optional] |



29 changes: 29 additions & 0 deletions docs/SegmentDetails.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@


# SegmentDetails

Segment details. Only included when the include-segment-detail query parameter is set to true.

## Properties

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**id** | **String** | The unique identifier for the segment (UUID v4). | [optional] |
|**name** | **String** | The segment name. | [optional] |
|**description** | **String** | Human-readable description for the segment. `null` when unset. Maximum 255 characters. | [optional] |
|**createdAt** | **Integer** | Unix timestamp when the segment was created. | [optional] |
|**source** | [**SourceEnum**](#SourceEnum) | The source of the segment. | [optional] |
|**filters** | [**List<FilterExpression>**](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] |



## Enum: SourceEnum

| Name | Value |
|---- | -----|
| DEFAULT | "default" |
| CUSTOM | "custom" |
| QUICKSTART | "quickstart" |



15 changes: 15 additions & 0 deletions docs/UpdateSegmentRequest.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@


# UpdateSegmentRequest


## Properties

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**name** | **String** | Required. The segment name. Maximum 128 characters. | |
|**description** | **String** | Optional human-readable description for the segment. Maximum 255 characters. Pass an empty string to clear; omit to leave unchanged. | [optional] |
|**filters** | [**List<FilterExpression>**](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] |



14 changes: 14 additions & 0 deletions docs/UpdateSegmentSuccessResponse.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@


# UpdateSegmentSuccessResponse


## Properties

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**success** | **Boolean** | true if the segment was updated successfully, false otherwise. | [optional] |
|**id** | **String** | UUID of the updated segment. | [optional] |



9 changes: 9 additions & 0 deletions src/main/java/com/onesignal/client/JSON.java
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,10 @@ private static Class getClassByDiscriminator(Map classByDiscriminatorValue, Stri
.registerTypeAdapterFactory(new com.onesignal.client.model.ApiKeyToken.CustomTypeAdapterFactory())
.registerTypeAdapterFactory(new com.onesignal.client.model.ApiKeyTokensListResponse.CustomTypeAdapterFactory())
.registerTypeAdapterFactory(new com.onesignal.client.model.App.CustomTypeAdapterFactory())
.registerTypeAdapterFactory(new com.onesignal.client.model.AuditLogActor.CustomTypeAdapterFactory())
.registerTypeAdapterFactory(new com.onesignal.client.model.AuditLogContext.CustomTypeAdapterFactory())
.registerTypeAdapterFactory(new com.onesignal.client.model.AuditLogEvent.CustomTypeAdapterFactory())
.registerTypeAdapterFactory(new com.onesignal.client.model.AuditLogTarget.CustomTypeAdapterFactory())
.registerTypeAdapterFactory(new com.onesignal.client.model.BasicNotification.CustomTypeAdapterFactory())
.registerTypeAdapterFactory(new com.onesignal.client.model.BasicNotificationAllOf.CustomTypeAdapterFactory())
.registerTypeAdapterFactory(new com.onesignal.client.model.BasicNotificationAllOfAndroidBackgroundLayout.CustomTypeAdapterFactory())
Expand All @@ -121,8 +125,10 @@ private static Class getClassByDiscriminator(Map classByDiscriminatorValue, Stri
.registerTypeAdapterFactory(new com.onesignal.client.model.GenericError.CustomTypeAdapterFactory())
.registerTypeAdapterFactory(new com.onesignal.client.model.GenericSuccessBoolResponse.CustomTypeAdapterFactory())
.registerTypeAdapterFactory(new com.onesignal.client.model.GetNotificationHistoryRequestBody.CustomTypeAdapterFactory())
.registerTypeAdapterFactory(new com.onesignal.client.model.GetSegmentSuccessResponse.CustomTypeAdapterFactory())
.registerTypeAdapterFactory(new com.onesignal.client.model.GetSegmentsSuccessResponse.CustomTypeAdapterFactory())
.registerTypeAdapterFactory(new com.onesignal.client.model.LanguageStringMap.CustomTypeAdapterFactory())
.registerTypeAdapterFactory(new com.onesignal.client.model.ListAuditLogsSuccessResponse.CustomTypeAdapterFactory())
.registerTypeAdapterFactory(new com.onesignal.client.model.Notification.CustomTypeAdapterFactory())
.registerTypeAdapterFactory(new com.onesignal.client.model.NotificationAllOf.CustomTypeAdapterFactory())
.registerTypeAdapterFactory(new com.onesignal.client.model.NotificationHistorySuccessResponse.CustomTypeAdapterFactory())
Expand All @@ -143,6 +149,7 @@ private static Class getClassByDiscriminator(Map classByDiscriminatorValue, Stri
.registerTypeAdapterFactory(new com.onesignal.client.model.RateLimitError.CustomTypeAdapterFactory())
.registerTypeAdapterFactory(new com.onesignal.client.model.Segment.CustomTypeAdapterFactory())
.registerTypeAdapterFactory(new com.onesignal.client.model.SegmentData.CustomTypeAdapterFactory())
.registerTypeAdapterFactory(new com.onesignal.client.model.SegmentDetails.CustomTypeAdapterFactory())
.registerTypeAdapterFactory(new com.onesignal.client.model.SegmentNotificationTarget.CustomTypeAdapterFactory())
.registerTypeAdapterFactory(new com.onesignal.client.model.StartLiveActivityRequest.CustomTypeAdapterFactory())
.registerTypeAdapterFactory(new com.onesignal.client.model.StartLiveActivitySuccessResponse.CustomTypeAdapterFactory())
Expand All @@ -155,6 +162,8 @@ private static Class getClassByDiscriminator(Map classByDiscriminatorValue, Stri
.registerTypeAdapterFactory(new com.onesignal.client.model.UpdateApiKeyRequest.CustomTypeAdapterFactory())
.registerTypeAdapterFactory(new com.onesignal.client.model.UpdateLiveActivityRequest.CustomTypeAdapterFactory())
.registerTypeAdapterFactory(new com.onesignal.client.model.UpdateLiveActivitySuccessResponse.CustomTypeAdapterFactory())
.registerTypeAdapterFactory(new com.onesignal.client.model.UpdateSegmentRequest.CustomTypeAdapterFactory())
.registerTypeAdapterFactory(new com.onesignal.client.model.UpdateSegmentSuccessResponse.CustomTypeAdapterFactory())
.registerTypeAdapterFactory(new com.onesignal.client.model.UpdateTemplateRequest.CustomTypeAdapterFactory())
.registerTypeAdapterFactory(new com.onesignal.client.model.UpdateUserRequest.CustomTypeAdapterFactory())
.registerTypeAdapterFactory(new com.onesignal.client.model.User.CustomTypeAdapterFactory())
Expand Down
Loading