Skip to content

Commit 6e9bcde

Browse files
onesignal-deployOneSignal
andauthored
Dependency Update (#19)
Update Java API Co-authored-by: OneSignal <noreply@onesignal.com>
1 parent 5318603 commit 6e9bcde

68 files changed

Lines changed: 243 additions & 1316 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

README.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
OneSignal
44
- API version: 1.0.1
5-
- Build date: 2022-11-03T18:39:49.442Z[Etc/UTC]
5+
- Build date: 2022-11-10T01:03:22.700Z[Etc/UTC]
66

77
A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com
88

@@ -180,7 +180,6 @@ Class | Method | HTTP request | Description
180180
- [ExportPlayersSuccessResponse](docs/ExportPlayersSuccessResponse.md)
181181
- [Filter](docs/Filter.md)
182182
- [FilterExpressions](docs/FilterExpressions.md)
183-
- [FilterNotificationTarget](docs/FilterNotificationTarget.md)
184183
- [GetNotificationRequestBody](docs/GetNotificationRequestBody.md)
185184
- [InvalidIdentifierError](docs/InvalidIdentifierError.md)
186185
- [Notification](docs/Notification.md)

api/openapi.yaml

Lines changed: 7 additions & 65 deletions
Original file line numberDiff line numberDiff line change
@@ -1046,8 +1046,6 @@ components:
10461046
\ to read the payload."
10471047
type: boolean
10481048
writeOnly: true
1049-
required:
1050-
- id
10511049
type: object
10521050
Apps:
10531051
items:
@@ -1072,66 +1070,6 @@ components:
10721070
type: string
10731071
type: array
10741072
type: object
1075-
FilterNotificationTarget:
1076-
properties:
1077-
last_session:
1078-
description: "relation = \">\" or \"<\"\nhours_ago = number of hours before\
1079-
\ or after the users last session. Example: \"1.1\"\n"
1080-
type: string
1081-
first_session:
1082-
description: "relation = \">\" or \"<\"\nhours_ago = number of hours before\
1083-
\ or after the users first session. Example: \"1.1\"\n"
1084-
type: string
1085-
session_count:
1086-
description: "relation = \">\", \"<\", \"=\" or \"!=\"\nvalue = number sessions.\
1087-
\ Example: \"1\"\n"
1088-
type: string
1089-
session_time:
1090-
description: "relation = \">\", \"<\", \"=\" or \"!=\"\nvalue = Time in\
1091-
\ seconds the user has been in your app. Example: \"3600\"\n"
1092-
type: string
1093-
amount_spent:
1094-
description: "relation = \">\", \"<\", or \"=\"\nvalue = Amount in USD a\
1095-
\ user has spent on IAP (In App Purchases). Example: \"0.99\"\n"
1096-
type: string
1097-
bought_sku:
1098-
description: "relation = \">\", \"<\" or \"=\"\nkey = SKU purchased in your\
1099-
\ app as an IAP (In App Purchases). Example: \"com.domain.100coinpack\"\
1100-
\nvalue = value of SKU to compare to. Example: \"0.99\"\n"
1101-
type: string
1102-
tag:
1103-
description: "relation = \">\", \"<\", \"=\", \"!=\", \"exists\", \"not_exists\"\
1104-
, \"time_elapsed_gt\" (paid plan only) or \"time_elapsed_lt\" (paid plan\
1105-
\ only) See Time Operators\nkey = Tag key to compare.\nvalue = Tag value\
1106-
\ to compare. Not required for \"exists\" or \"not_exists\". Example:\
1107-
\ See Formatting Filters\n"
1108-
type: string
1109-
language:
1110-
description: "relation = \"=\" or \"!=\"\nvalue = 2 character language code.\
1111-
\ Example: \"en\". For a list of all language codes see Language & Localization.\n"
1112-
type: string
1113-
app_version:
1114-
description: "relation = \">\", \"<\", \"=\" or \"!=\"\nvalue = app version.\
1115-
\ Example: \"1.0.0\"\n"
1116-
type: string
1117-
location:
1118-
description: |
1119-
radius = in meters
1120-
lat = latitude
1121-
long = longitude
1122-
type: string
1123-
email:
1124-
description: |
1125-
value = email address
1126-
Only for sending Push Notifications
1127-
Use this for targeting push subscribers associated with an email set with all SDK setEmail methods
1128-
To send emails to specific email addresses use include_email_tokens parameter
1129-
type: string
1130-
country:
1131-
description: "relation = \"=\"\nvalue = 2-digit Country code\nExample: \"\
1132-
field\": \"country\", \"relation\": \"=\", \"value\", \"US\"\n"
1133-
type: string
1134-
type: object
11351073
PlayerNotificationTarget:
11361074
properties:
11371075
include_player_ids:
@@ -1230,7 +1168,6 @@ components:
12301168
NotificationTarget:
12311169
anyOf:
12321170
- $ref: '#/components/schemas/SegmentNotificationTarget'
1233-
- $ref: '#/components/schemas/FilterNotificationTarget'
12341171
- $ref: '#/components/schemas/PlayerNotificationTarget'
12351172
BasicNotification:
12361173
allOf:
@@ -1526,8 +1463,8 @@ components:
15261463
\ inside the tags."
15271464
type: string
15281465
value:
1529-
description: Constant value to use as the second operand in the filter expression. This
1530-
value is *required* when the relation operator is a binary operator.
1466+
description: Constant value to use as the second operand in the filter expression.
1467+
This value is *required* when the relation operator is a binary operator.
15311468
type: string
15321469
relation:
15331470
description: Operator of a filter expression.
@@ -2773,6 +2710,11 @@ components:
27732710
nullable: true
27742711
type: array
27752712
writeOnly: true
2713+
filters:
2714+
items:
2715+
$ref: '#/components/schemas/Filter'
2716+
nullable: true
2717+
type: array
27762718
type: object
27772719
Notification_allOf:
27782720
properties:

docs/App.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77

88
| Name | Type | Description | Notes |
99
|------------ | ------------- | ------------- | -------------|
10-
|**id** | **String** | | [readonly] |
10+
|**id** | **String** | | [optional] [readonly] |
1111
|**name** | **String** | The name of your app, as displayed on your apps list on the dashboard. This can be renamed. | [optional] |
1212
|**players** | **Integer** | | [optional] [readonly] |
1313
|**messageablePlayers** | **Integer** | | [optional] [readonly] |

docs/BasicNotification.md

Lines changed: 1 addition & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -9,18 +9,6 @@
99
|------------ | ------------- | ------------- | -------------|
1010
|**includedSegments** | **List&lt;String&gt;** | The segment names you want to target. Users in these segments will receive a notification. This targeting parameter is only compatible with excluded_segments. Example: [\&quot;Active Users\&quot;, \&quot;Inactive Users\&quot;] | [optional] |
1111
|**excludedSegments** | **List&lt;String&gt;** | Segment that will be excluded when sending. Users in these segments will not receive a notification, even if they were included in included_segments. This targeting parameter is only compatible with included_segments. Example: [\&quot;Active Users\&quot;, \&quot;Inactive Users\&quot;] | [optional] |
12-
|**lastSession** | **String** | relation &#x3D; \&quot;&gt;\&quot; or \&quot;&lt;\&quot; hours_ago &#x3D; number of hours before or after the users last session. Example: \&quot;1.1\&quot; | [optional] |
13-
|**firstSession** | **String** | relation &#x3D; \&quot;&gt;\&quot; or \&quot;&lt;\&quot; hours_ago &#x3D; number of hours before or after the users first session. Example: \&quot;1.1\&quot; | [optional] |
14-
|**sessionCount** | **String** | relation &#x3D; \&quot;&gt;\&quot;, \&quot;&lt;\&quot;, \&quot;&#x3D;\&quot; or \&quot;!&#x3D;\&quot; value &#x3D; number sessions. Example: \&quot;1\&quot; | [optional] |
15-
|**sessionTime** | **String** | relation &#x3D; \&quot;&gt;\&quot;, \&quot;&lt;\&quot;, \&quot;&#x3D;\&quot; or \&quot;!&#x3D;\&quot; value &#x3D; Time in seconds the user has been in your app. Example: \&quot;3600\&quot; | [optional] |
16-
|**amountSpent** | **String** | relation &#x3D; \&quot;&gt;\&quot;, \&quot;&lt;\&quot;, or \&quot;&#x3D;\&quot; value &#x3D; Amount in USD a user has spent on IAP (In App Purchases). Example: \&quot;0.99\&quot; | [optional] |
17-
|**boughtSku** | **String** | relation &#x3D; \&quot;&gt;\&quot;, \&quot;&lt;\&quot; or \&quot;&#x3D;\&quot; key &#x3D; SKU purchased in your app as an IAP (In App Purchases). Example: \&quot;com.domain.100coinpack\&quot; value &#x3D; value of SKU to compare to. Example: \&quot;0.99\&quot; | [optional] |
18-
|**tag** | **String** | relation &#x3D; \&quot;&gt;\&quot;, \&quot;&lt;\&quot;, \&quot;&#x3D;\&quot;, \&quot;!&#x3D;\&quot;, \&quot;exists\&quot;, \&quot;not_exists\&quot;, \&quot;time_elapsed_gt\&quot; (paid plan only) or \&quot;time_elapsed_lt\&quot; (paid plan only) See Time Operators key &#x3D; Tag key to compare. value &#x3D; Tag value to compare. Not required for \&quot;exists\&quot; or \&quot;not_exists\&quot;. Example: See Formatting Filters | [optional] |
19-
|**language** | **String** | relation &#x3D; \&quot;&#x3D;\&quot; or \&quot;!&#x3D;\&quot; value &#x3D; 2 character language code. Example: \&quot;en\&quot;. For a list of all language codes see Language &amp; Localization. | [optional] |
20-
|**appVersion** | **String** | relation &#x3D; \&quot;&gt;\&quot;, \&quot;&lt;\&quot;, \&quot;&#x3D;\&quot; or \&quot;!&#x3D;\&quot; value &#x3D; app version. Example: \&quot;1.0.0\&quot; | [optional] |
21-
|**location** | **String** | radius &#x3D; in meters lat &#x3D; latitude long &#x3D; longitude | [optional] |
22-
|**email** | **String** | value &#x3D; email address Only for sending Push Notifications Use this for targeting push subscribers associated with an email set with all SDK setEmail methods To send emails to specific email addresses use include_email_tokens parameter | [optional] |
23-
|**country** | **String** | relation &#x3D; \&quot;&#x3D;\&quot; value &#x3D; 2-digit Country code Example: \&quot;field\&quot;: \&quot;country\&quot;, \&quot;relation\&quot;: \&quot;&#x3D;\&quot;, \&quot;value\&quot;, \&quot;US\&quot; | [optional] |
2412
|**includePlayerIds** | **List&lt;String&gt;** | Specific playerids to send your notification to. _Does not require API Auth Key. Do not combine with other targeting parameters. Not compatible with any other targeting parameters. Example: [\&quot;1dd608f2-c6a1-11e3-851d-000c2940e62c\&quot;] Limit of 2,000 entries per REST API call | [optional] |
2513
|**includeExternalUserIds** | **List&lt;String&gt;** | Target specific devices by custom user IDs assigned via API. Not compatible with any other targeting parameters Example: [\&quot;custom-id-assigned-by-api\&quot;] REQUIRED: REST API Key Authentication Limit of 2,000 entries per REST API call. Note: If targeting push, email, or sms subscribers with same ids, use with channel_for_external_user_ids to indicate you are sending a push or email or sms. | [optional] |
2614
|**includeEmailTokens** | **List&lt;String&gt;** | Recommended for Sending Emails - Target specific email addresses. If an email does not correspond to an existing user, a new user will be created. Example: nick@catfac.ts Limit of 2,000 entries per REST API call | [optional] |
@@ -119,6 +107,7 @@
119107
|**emailFromAddress** | **String** | Channel: Email The email address the email is from. If not specified, will default to \&quot;from email\&quot; set in the OneSignal Dashboard Email Settings. | [optional] |
120108
|**smsFrom** | **String** | Channel: SMS Phone Number used to send SMS. Should be a registered Twilio phone number in E.164 format. | [optional] |
121109
|**smsMediaUrls** | **List&lt;String&gt;** | Channel: SMS URLs for the media files to be attached to the SMS content. Limit: 10 media urls with a total max. size of 5MBs. | [optional] |
110+
|**filters** | [**List&lt;Filter&gt;**](Filter.md) | | [optional] |
122111

123112

124113

docs/BasicNotificationAllOf.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -95,6 +95,7 @@
9595
|**emailFromAddress** | **String** | Channel: Email The email address the email is from. If not specified, will default to \&quot;from email\&quot; set in the OneSignal Dashboard Email Settings. | [optional] |
9696
|**smsFrom** | **String** | Channel: SMS Phone Number used to send SMS. Should be a registered Twilio phone number in E.164 format. | [optional] |
9797
|**smsMediaUrls** | **List&lt;String&gt;** | Channel: SMS URLs for the media files to be attached to the SMS content. Limit: 10 media urls with a total max. size of 5MBs. | [optional] |
98+
|**filters** | [**List&lt;Filter&gt;**](Filter.md) | | [optional] |
9899

99100

100101

docs/Filter.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
|------------ | ------------- | ------------- | -------------|
1010
|**field** | **String** | Name of the field to use as the first operand in the filter expression. | |
1111
|**key** | **String** | If &#x60;field&#x60; is &#x60;tag&#x60;, this field is *required* to specify &#x60;key&#x60; inside the tags. | [optional] |
12-
|**value** | **String** | Constant value to use as the second operand in the filter expression. This value is *required* when the relation operator is a binary operator. | [optional] |
12+
|**value** | **String** | Constant value to use as the second operand in the filter expression. This value is *required* when the relation operator is a binary operator. | [optional] |
1313
|**relation** | [**RelationEnum**](#RelationEnum) | Operator of a filter expression. | |
1414

1515

docs/FilterExpressions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
|------------ | ------------- | ------------- | -------------|
1010
|**field** | **String** | Name of the field to use as the first operand in the filter expression. | |
1111
|**key** | **String** | If &#x60;field&#x60; is &#x60;tag&#x60;, this field is *required* to specify &#x60;key&#x60; inside the tags. | [optional] |
12-
|**value** | **String** | Constant value to use as the second operand in the filter expression. This value is *required* when the relation operator is a binary operator. | [optional] |
12+
|**value** | **String** | Constant value to use as the second operand in the filter expression. This value is *required* when the relation operator is a binary operator. | [optional] |
1313
|**relation** | [**RelationEnum**](#RelationEnum) | Operator of a filter expression. | |
1414
|**operator** | [**OperatorEnum**](#OperatorEnum) | Strictly, this must be either &#x60;\&quot;OR\&quot;&#x60;, or &#x60;\&quot;AND\&quot;&#x60;. It can be used to compose Filters as part of a Filters object. | [optional] |
1515

docs/Notification.md

Lines changed: 1 addition & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -9,18 +9,6 @@
99
|------------ | ------------- | ------------- | -------------|
1010
|**includedSegments** | **List&lt;String&gt;** | The segment names you want to target. Users in these segments will receive a notification. This targeting parameter is only compatible with excluded_segments. Example: [\&quot;Active Users\&quot;, \&quot;Inactive Users\&quot;] | [optional] |
1111
|**excludedSegments** | **List&lt;String&gt;** | Segment that will be excluded when sending. Users in these segments will not receive a notification, even if they were included in included_segments. This targeting parameter is only compatible with included_segments. Example: [\&quot;Active Users\&quot;, \&quot;Inactive Users\&quot;] | [optional] |
12-
|**lastSession** | **String** | relation &#x3D; \&quot;&gt;\&quot; or \&quot;&lt;\&quot; hours_ago &#x3D; number of hours before or after the users last session. Example: \&quot;1.1\&quot; | [optional] |
13-
|**firstSession** | **String** | relation &#x3D; \&quot;&gt;\&quot; or \&quot;&lt;\&quot; hours_ago &#x3D; number of hours before or after the users first session. Example: \&quot;1.1\&quot; | [optional] |
14-
|**sessionCount** | **String** | relation &#x3D; \&quot;&gt;\&quot;, \&quot;&lt;\&quot;, \&quot;&#x3D;\&quot; or \&quot;!&#x3D;\&quot; value &#x3D; number sessions. Example: \&quot;1\&quot; | [optional] |
15-
|**sessionTime** | **String** | relation &#x3D; \&quot;&gt;\&quot;, \&quot;&lt;\&quot;, \&quot;&#x3D;\&quot; or \&quot;!&#x3D;\&quot; value &#x3D; Time in seconds the user has been in your app. Example: \&quot;3600\&quot; | [optional] |
16-
|**amountSpent** | **String** | relation &#x3D; \&quot;&gt;\&quot;, \&quot;&lt;\&quot;, or \&quot;&#x3D;\&quot; value &#x3D; Amount in USD a user has spent on IAP (In App Purchases). Example: \&quot;0.99\&quot; | [optional] |
17-
|**boughtSku** | **String** | relation &#x3D; \&quot;&gt;\&quot;, \&quot;&lt;\&quot; or \&quot;&#x3D;\&quot; key &#x3D; SKU purchased in your app as an IAP (In App Purchases). Example: \&quot;com.domain.100coinpack\&quot; value &#x3D; value of SKU to compare to. Example: \&quot;0.99\&quot; | [optional] |
18-
|**tag** | **String** | relation &#x3D; \&quot;&gt;\&quot;, \&quot;&lt;\&quot;, \&quot;&#x3D;\&quot;, \&quot;!&#x3D;\&quot;, \&quot;exists\&quot;, \&quot;not_exists\&quot;, \&quot;time_elapsed_gt\&quot; (paid plan only) or \&quot;time_elapsed_lt\&quot; (paid plan only) See Time Operators key &#x3D; Tag key to compare. value &#x3D; Tag value to compare. Not required for \&quot;exists\&quot; or \&quot;not_exists\&quot;. Example: See Formatting Filters | [optional] |
19-
|**language** | **String** | relation &#x3D; \&quot;&#x3D;\&quot; or \&quot;!&#x3D;\&quot; value &#x3D; 2 character language code. Example: \&quot;en\&quot;. For a list of all language codes see Language &amp; Localization. | [optional] |
20-
|**appVersion** | **String** | relation &#x3D; \&quot;&gt;\&quot;, \&quot;&lt;\&quot;, \&quot;&#x3D;\&quot; or \&quot;!&#x3D;\&quot; value &#x3D; app version. Example: \&quot;1.0.0\&quot; | [optional] |
21-
|**location** | **String** | radius &#x3D; in meters lat &#x3D; latitude long &#x3D; longitude | [optional] |
22-
|**email** | **String** | value &#x3D; email address Only for sending Push Notifications Use this for targeting push subscribers associated with an email set with all SDK setEmail methods To send emails to specific email addresses use include_email_tokens parameter | [optional] |
23-
|**country** | **String** | relation &#x3D; \&quot;&#x3D;\&quot; value &#x3D; 2-digit Country code Example: \&quot;field\&quot;: \&quot;country\&quot;, \&quot;relation\&quot;: \&quot;&#x3D;\&quot;, \&quot;value\&quot;, \&quot;US\&quot; | [optional] |
2412
|**includePlayerIds** | **List&lt;String&gt;** | Specific playerids to send your notification to. _Does not require API Auth Key. Do not combine with other targeting parameters. Not compatible with any other targeting parameters. Example: [\&quot;1dd608f2-c6a1-11e3-851d-000c2940e62c\&quot;] Limit of 2,000 entries per REST API call | [optional] |
2513
|**includeExternalUserIds** | **List&lt;String&gt;** | Target specific devices by custom user IDs assigned via API. Not compatible with any other targeting parameters Example: [\&quot;custom-id-assigned-by-api\&quot;] REQUIRED: REST API Key Authentication Limit of 2,000 entries per REST API call. Note: If targeting push, email, or sms subscribers with same ids, use with channel_for_external_user_ids to indicate you are sending a push or email or sms. | [optional] |
2614
|**includeEmailTokens** | **List&lt;String&gt;** | Recommended for Sending Emails - Target specific email addresses. If an email does not correspond to an existing user, a new user will be created. Example: nick@catfac.ts Limit of 2,000 entries per REST API call | [optional] |
@@ -119,6 +107,7 @@
119107
|**emailFromAddress** | **String** | Channel: Email The email address the email is from. If not specified, will default to \&quot;from email\&quot; set in the OneSignal Dashboard Email Settings. | [optional] |
120108
|**smsFrom** | **String** | Channel: SMS Phone Number used to send SMS. Should be a registered Twilio phone number in E.164 format. | [optional] |
121109
|**smsMediaUrls** | **List&lt;String&gt;** | Channel: SMS URLs for the media files to be attached to the SMS content. Limit: 10 media urls with a total max. size of 5MBs. | [optional] |
110+
|**filters** | [**List&lt;Filter&gt;**](Filter.md) | | [optional] |
122111
|**sendAfter** | **OffsetDateTime** | Channel: All Schedule notification for future delivery. API defaults to UTC -1100 Examples: All examples are the exact same date &amp; time. \&quot;Thu Sep 24 2015 14:00:00 GMT-0700 (PDT)\&quot; \&quot;September 24th 2015, 2:00:00 pm UTC-07:00\&quot; \&quot;2015-09-24 14:00:00 GMT-0700\&quot; \&quot;Sept 24 2015 14:00:00 GMT-0700\&quot; \&quot;Thu Sep 24 2015 14:00:00 GMT-0700 (Pacific Daylight Time)\&quot; Note: SMS currently only supports send_after parameter. | [optional] |
123112

124113

0 commit comments

Comments
 (0)