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
356 changes: 198 additions & 158 deletions api/openapi.yaml

Large diffs are not rendered by default.

84 changes: 45 additions & 39 deletions docs/DefaultApi.md

Large diffs are not rendered by default.

8 changes: 4 additions & 4 deletions src/main/java/com/onesignal/client/model/Filter.java
Original file line number Diff line number Diff line change
Expand Up @@ -158,7 +158,7 @@ public Filter field(String field) {
* @return field
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "Required. Name of the field to use as the first operand in the filter expression.")
@ApiModelProperty(example = "tag", value = "Required. Name of the field to use as the first operand in the filter expression.")

public String getField() {
return field;
Expand All @@ -181,7 +181,7 @@ public Filter key(String key) {
* @return key
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "If `field` is `tag`, this field is *required* to specify `key` inside the tags.")
@ApiModelProperty(example = "level", value = "If `field` is `tag`, this field is *required* to specify `key` inside the tags.")

public String getKey() {
return key;
Expand All @@ -204,7 +204,7 @@ public Filter value(String value) {
* @return value
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "Constant value to use as the second operand in the filter expression. This value is *required* when the relation operator is a binary operator.")
@ApiModelProperty(example = "10", value = "Constant value to use as the second operand in the filter expression. This value is *required* when the relation operator is a binary operator.")

public String getValue() {
return value;
Expand All @@ -227,7 +227,7 @@ public Filter hoursAgo(String hoursAgo) {
* @return hoursAgo
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "If `field` is session-related, this is *required* to specify the number of hours before or after the user's session.")
@ApiModelProperty(example = "24", value = "If `field` is session-related, this is *required* to specify the number of hours before or after the user's session.")

public String getHoursAgo() {
return hoursAgo;
Expand Down
10 changes: 5 additions & 5 deletions src/main/java/com/onesignal/client/model/PropertiesObject.java
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,7 @@ public PropertiesObject putTagsItem(String key, Object tagsItem) {
* @return tags
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "")
@ApiModelProperty(example = "{\"level\":\"10\",\"vip\":\"true\"}", value = "")

public Map<String, Object> getTags() {
return tags;
Expand All @@ -147,7 +147,7 @@ public PropertiesObject language(String language) {
* @return language
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "")
@ApiModelProperty(example = "en", value = "")

public String getLanguage() {
return language;
Expand All @@ -170,7 +170,7 @@ public PropertiesObject timezoneId(String timezoneId) {
* @return timezoneId
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "")
@ApiModelProperty(example = "America/Los_Angeles", value = "")

public String getTimezoneId() {
return timezoneId;
Expand Down Expand Up @@ -239,7 +239,7 @@ public PropertiesObject country(String country) {
* @return country
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "")
@ApiModelProperty(example = "US", value = "")

public String getCountry() {
return country;
Expand Down Expand Up @@ -362,7 +362,7 @@ public PropertiesObject ip(String ip) {
* @return ip
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "")
@ApiModelProperty(example = "203.0.113.10", value = "")

public String getIp() {
return ip;
Expand Down
6 changes: 3 additions & 3 deletions src/main/java/com/onesignal/client/model/Purchase.java
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ public Purchase sku(String sku) {
* @return sku
**/
@javax.annotation.Nonnull
@ApiModelProperty(required = true, value = "The unique identifier of the purchased item.")
@ApiModelProperty(example = "com.example.coins100", required = true, value = "The unique identifier of the purchased item.")

public String getSku() {
return sku;
Expand All @@ -105,7 +105,7 @@ public Purchase amount(String amount) {
* @return amount
**/
@javax.annotation.Nonnull
@ApiModelProperty(required = true, value = "The amount, in USD, spent purchasing the item.")
@ApiModelProperty(example = "0.99", required = true, value = "The amount, in USD, spent purchasing the item.")

public String getAmount() {
return amount;
Expand All @@ -128,7 +128,7 @@ public Purchase iso(String iso) {
* @return iso
**/
@javax.annotation.Nonnull
@ApiModelProperty(required = true, value = "The 3-letter ISO 4217 currency code. Required for correct storage and conversion of amount.")
@ApiModelProperty(example = "USD", required = true, value = "The 3-letter ISO 4217 currency code. Required for correct storage and conversion of amount.")

public String getIso() {
return iso;
Expand Down
4 changes: 2 additions & 2 deletions src/main/java/com/onesignal/client/model/Segment.java
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ public Segment id(String id) {
* @return id
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "UUID of the segment. If left empty, it will be assigned automaticaly.")
@ApiModelProperty(example = "d5d4d1a8-1c9e-42fb-b3f2-56d3a5a9a8b7", value = "UUID of the segment. If left empty, it will be assigned automaticaly.")

public String getId() {
return id;
Expand All @@ -104,7 +104,7 @@ public Segment name(String name) {
* @return name
**/
@javax.annotation.Nonnull
@ApiModelProperty(required = true, value = "Name of the segment. You'll see this name on the Web UI.")
@ApiModelProperty(example = "Inactive 30 days", required = true, value = "Name of the segment. You'll see this name on the Web UI.")

public String getName() {
return name;
Expand Down
26 changes: 13 additions & 13 deletions src/main/java/com/onesignal/client/model/Subscription.java
Original file line number Diff line number Diff line change
Expand Up @@ -203,7 +203,7 @@ public Subscription id(String id) {
* @return id
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "")
@ApiModelProperty(example = "e4e87830-b954-4363-b7bc-1f01dbaee5c8", value = "")

public String getId() {
return id;
Expand Down Expand Up @@ -249,7 +249,7 @@ public Subscription token(String token) {
* @return token
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "")
@ApiModelProperty(example = "d5d4d1a8-1c9e-42fb-b3f2-56d3a5a9a8b7", value = "")

public String getToken() {
return token;
Expand All @@ -272,7 +272,7 @@ public Subscription enabled(Boolean enabled) {
* @return enabled
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "")
@ApiModelProperty(example = "true", value = "")

public Boolean getEnabled() {
return enabled;
Expand All @@ -295,7 +295,7 @@ public Subscription notificationTypes(Integer notificationTypes) {
* @return notificationTypes
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "")
@ApiModelProperty(example = "1", value = "")

public Integer getNotificationTypes() {
return notificationTypes;
Expand All @@ -318,7 +318,7 @@ public Subscription sessionTime(Integer sessionTime) {
* @return sessionTime
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "")
@ApiModelProperty(example = "60", value = "")

public Integer getSessionTime() {
return sessionTime;
Expand All @@ -341,7 +341,7 @@ public Subscription sessionCount(Integer sessionCount) {
* @return sessionCount
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "")
@ApiModelProperty(example = "1", value = "")

public Integer getSessionCount() {
return sessionCount;
Expand All @@ -364,7 +364,7 @@ public Subscription sdk(String sdk) {
* @return sdk
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "")
@ApiModelProperty(example = "5.2.0", value = "")

public String getSdk() {
return sdk;
Expand All @@ -387,7 +387,7 @@ public Subscription deviceModel(String deviceModel) {
* @return deviceModel
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "")
@ApiModelProperty(example = "iPhone14,2", value = "")

public String getDeviceModel() {
return deviceModel;
Expand All @@ -410,7 +410,7 @@ public Subscription deviceOs(String deviceOs) {
* @return deviceOs
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "")
@ApiModelProperty(example = "17.1", value = "")

public String getDeviceOs() {
return deviceOs;
Expand Down Expand Up @@ -479,7 +479,7 @@ public Subscription appVersion(String appVersion) {
* @return appVersion
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "")
@ApiModelProperty(example = "1.0.0", value = "")

public String getAppVersion() {
return appVersion;
Expand Down Expand Up @@ -525,7 +525,7 @@ public Subscription carrier(String carrier) {
* @return carrier
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "")
@ApiModelProperty(example = "Verizon", value = "")

public String getCarrier() {
return carrier;
Expand All @@ -548,7 +548,7 @@ public Subscription webAuth(String webAuth) {
* @return webAuth
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "")
@ApiModelProperty(example = "5DUmpGmLuTxWCLj5lJpwLQ", value = "")

public String getWebAuth() {
return webAuth;
Expand All @@ -571,7 +571,7 @@ public Subscription webP256(String webP256) {
* @return webP256
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "")
@ApiModelProperty(example = "BM5-r8DauQXOb2E-3PgLPjSvjT0Ao9v5oJhw8bZ0cW7Vh6BbmPYcqbbCEJ1P2sK0hZ7HxSh9zGyU5pQk1jJmZ8A", value = "")

public String getWebP256() {
return webP256;
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/com/onesignal/client/model/User.java
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@ public User putIdentityItem(String key, String identityItem) {
* @return identity
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "")
@ApiModelProperty(example = "{\"external_id\":\"YOUR_USER_EXTERNAL_ID\"}", value = "")

public Map<String, String> getIdentity() {
return identity;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ public UserIdentityBody putIdentityItem(String key, String identityItem) {
* @return identity
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "")
@ApiModelProperty(example = "{\"external_id\":\"YOUR_USER_EXTERNAL_ID\"}", value = "")

public Map<String, String> getIdentity() {
return identity;
Expand Down