Merge pull request #27 from OneSignal/api

Dependency Update
OneSignal · Apr 18, 2023 · e2cd095 · e2cd095
2 parents efbd6b1 + 438a1f7
commit e2cd095
Show file tree

Hide file tree

Showing 182 changed files with 9,697 additions and 680 deletions.
diff --git a/.github/workflows/Zapier.yml b/.github/workflows/Zapier.yml
@@ -7,7 +7,7 @@ on:
   # Triggers the workflow on push or pull request events but only for the "main" branch
   issues:
     types: [closed]
-    
+
 permissions:
   issues: read
 
@@ -31,4 +31,4 @@ jobs:
           --header 'Accept: application/json' \
           --data-raw '{
             "task_name" : "$ISSUE_TITLE"
-          }'
+          }'
diff --git a/README.md b/README.md
@@ -6,8 +6,8 @@ A powerful way to send personalized messages at scale and build effective custom
 
 This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
-- API version: 1.0.2
-- Package version: 1.0.2
+- API version: 1.2.1
+- Package version: 2.0.0
 - Build package: org.openapitools.codegen.languages.RubyClientCodegen
 For more information, please visit [https://onesignal.com](https://onesignal.com)
 
@@ -24,16 +24,16 @@ gem build onesignal.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./onesignal-1.0.2.gem
+gem install ./onesignal-2.0.0.gem
 ```
 
-(for development, run `gem install --dev ./onesignal-1.0.2.gem` to install the development dependencies)
+(for development, run `gem install --dev ./onesignal-2.0.0.gem` to install the development dependencies)
 
 or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
 
 Finally add this to the Gemfile:
 
-    gem 'onesignal', '~> 1.0.2'
+    gem 'onesignal', '~> 2.0.0'
 
 ### Install from Git
 
@@ -89,22 +89,36 @@ Class | Method | HTTP request | Description
 *OneSignal::DefaultApi* | [**create_notification**](docs/DefaultApi.md#create_notification) | **POST** /notifications | Create notification
 *OneSignal::DefaultApi* | [**create_player**](docs/DefaultApi.md#create_player) | **POST** /players | Add a device
 *OneSignal::DefaultApi* | [**create_segments**](docs/DefaultApi.md#create_segments) | **POST** /apps/{app_id}/segments | Create Segments
+*OneSignal::DefaultApi* | [**create_subscription**](docs/DefaultApi.md#create_subscription) | **POST** /apps/{app_id}/users/by/{alias_label}/{alias_id}/subscriptions | 
+*OneSignal::DefaultApi* | [**create_user**](docs/DefaultApi.md#create_user) | **POST** /apps/{app_id}/users | 
+*OneSignal::DefaultApi* | [**delete_alias**](docs/DefaultApi.md#delete_alias) | **DELETE** /apps/{app_id}/users/by/{alias_label}/{alias_id}/identity/{alias_label_to_delete} | 
 *OneSignal::DefaultApi* | [**delete_player**](docs/DefaultApi.md#delete_player) | **DELETE** /players/{player_id} | Delete a user record
 *OneSignal::DefaultApi* | [**delete_segments**](docs/DefaultApi.md#delete_segments) | **DELETE** /apps/{app_id}/segments/{segment_id} | Delete Segments
+*OneSignal::DefaultApi* | [**delete_subscription**](docs/DefaultApi.md#delete_subscription) | **DELETE** /apps/{app_id}/subscriptions/{subscription_id} | 
+*OneSignal::DefaultApi* | [**delete_user**](docs/DefaultApi.md#delete_user) | **DELETE** /apps/{app_id}/users/by/{alias_label}/{alias_id} | 
 *OneSignal::DefaultApi* | [**end_live_activity**](docs/DefaultApi.md#end_live_activity) | **DELETE** /apps/{app_id}/live_activities/{activity_id}/token/{subscription_id} | Stop Live Activity
 *OneSignal::DefaultApi* | [**export_players**](docs/DefaultApi.md#export_players) | **POST** /players/csv_export?app_id&#x3D;{app_id} | CSV export
+*OneSignal::DefaultApi* | [**fetch_aliases**](docs/DefaultApi.md#fetch_aliases) | **GET** /apps/{app_id}/subscriptions/{subscription_id}/user/identity | 
+*OneSignal::DefaultApi* | [**fetch_user**](docs/DefaultApi.md#fetch_user) | **GET** /apps/{app_id}/users/by/{alias_label}/{alias_id} | 
+*OneSignal::DefaultApi* | [**fetch_user_identity**](docs/DefaultApi.md#fetch_user_identity) | **GET** /apps/{app_id}/users/by/{alias_label}/{alias_id}/identity | 
 *OneSignal::DefaultApi* | [**get_app**](docs/DefaultApi.md#get_app) | **GET** /apps/{app_id} | View an app
 *OneSignal::DefaultApi* | [**get_apps**](docs/DefaultApi.md#get_apps) | **GET** /apps | View apps
+*OneSignal::DefaultApi* | [**get_eligible_iams**](docs/DefaultApi.md#get_eligible_iams) | **GET** /apps/{app_id}/subscriptions/{subscription_id}/iams | 
 *OneSignal::DefaultApi* | [**get_notification**](docs/DefaultApi.md#get_notification) | **GET** /notifications/{notification_id} | View notification
 *OneSignal::DefaultApi* | [**get_notification_history**](docs/DefaultApi.md#get_notification_history) | **POST** /notifications/{notification_id}/history | Notification History
 *OneSignal::DefaultApi* | [**get_notifications**](docs/DefaultApi.md#get_notifications) | **GET** /notifications | View notifications
 *OneSignal::DefaultApi* | [**get_outcomes**](docs/DefaultApi.md#get_outcomes) | **GET** /apps/{app_id}/outcomes | View Outcomes
 *OneSignal::DefaultApi* | [**get_player**](docs/DefaultApi.md#get_player) | **GET** /players/{player_id} | View device
 *OneSignal::DefaultApi* | [**get_players**](docs/DefaultApi.md#get_players) | **GET** /players | View devices
+*OneSignal::DefaultApi* | [**identify_user_by_alias**](docs/DefaultApi.md#identify_user_by_alias) | **PATCH** /apps/{app_id}/users/by/{alias_label}/{alias_id}/identity | 
+*OneSignal::DefaultApi* | [**identify_user_by_subscription_id**](docs/DefaultApi.md#identify_user_by_subscription_id) | **PATCH** /apps/{app_id}/subscriptions/{subscription_id}/user/identity | 
+*OneSignal::DefaultApi* | [**transfer_subscription**](docs/DefaultApi.md#transfer_subscription) | **PATCH** /apps/{app_id}/subscriptions/{subscription_id}/owner | 
 *OneSignal::DefaultApi* | [**update_app**](docs/DefaultApi.md#update_app) | **PUT** /apps/{app_id} | Update an app
 *OneSignal::DefaultApi* | [**update_live_activity**](docs/DefaultApi.md#update_live_activity) | **POST** /apps/{app_id}/live_activities/{activity_id}/notifications | Update a Live Activity via Push
 *OneSignal::DefaultApi* | [**update_player**](docs/DefaultApi.md#update_player) | **PUT** /players/{player_id} | Edit device
 *OneSignal::DefaultApi* | [**update_player_tags**](docs/DefaultApi.md#update_player_tags) | **PUT** /apps/{app_id}/users/{external_user_id} | Edit tags with external user id
+*OneSignal::DefaultApi* | [**update_subscription**](docs/DefaultApi.md#update_subscription) | **PATCH** /apps/{app_id}/subscriptions/{subscription_id} | 
+*OneSignal::DefaultApi* | [**update_user**](docs/DefaultApi.md#update_user) | **PATCH** /apps/{app_id}/users/by/{alias_label}/{alias_id} | 
 
 
 ## Documentation for Models
@@ -121,6 +135,10 @@ Class | Method | HTTP request | Description
  - [OneSignal::CreatePlayerSuccessResponse](docs/CreatePlayerSuccessResponse.md)
  - [OneSignal::CreateSegmentConflictResponse](docs/CreateSegmentConflictResponse.md)
  - [OneSignal::CreateSegmentSuccessResponse](docs/CreateSegmentSuccessResponse.md)
+ - [OneSignal::CreateSubscriptionRequestBody](docs/CreateSubscriptionRequestBody.md)
+ - [OneSignal::CreateUserConflictResponse](docs/CreateUserConflictResponse.md)
+ - [OneSignal::CreateUserConflictResponseErrorsInner](docs/CreateUserConflictResponseErrorsInner.md)
+ - [OneSignal::CreateUserConflictResponseErrorsItemsMeta](docs/CreateUserConflictResponseErrorsItemsMeta.md)
  - [OneSignal::DeletePlayerNotFoundResponse](docs/DeletePlayerNotFoundResponse.md)
  - [OneSignal::DeletePlayerSuccessResponse](docs/DeletePlayerSuccessResponse.md)
  - [OneSignal::DeleteSegmentNotFoundResponse](docs/DeleteSegmentNotFoundResponse.md)
@@ -131,6 +149,12 @@ Class | Method | HTTP request | Description
  - [OneSignal::Filter](docs/Filter.md)
  - [OneSignal::FilterExpressions](docs/FilterExpressions.md)
  - [OneSignal::GetNotificationRequestBody](docs/GetNotificationRequestBody.md)
+ - [OneSignal::IdentifyUserConflictResponse](docs/IdentifyUserConflictResponse.md)
+ - [OneSignal::IdentifyUserConflictResponseErrorsInner](docs/IdentifyUserConflictResponseErrorsInner.md)
+ - [OneSignal::InlineResponse200](docs/InlineResponse200.md)
+ - [OneSignal::InlineResponse2003](docs/InlineResponse2003.md)
+ - [OneSignal::InlineResponse201](docs/InlineResponse201.md)
+ - [OneSignal::InlineResponse202](docs/InlineResponse202.md)
  - [OneSignal::InvalidIdentifierError](docs/InvalidIdentifierError.md)
  - [OneSignal::Notification](docs/Notification.md)
  - [OneSignal::Notification200Errors](docs/Notification200Errors.md)
@@ -148,16 +172,27 @@ Class | Method | HTTP request | Description
  - [OneSignal::PlatformDeliveryDataSmsAllOf](docs/PlatformDeliveryDataSmsAllOf.md)
  - [OneSignal::Player](docs/Player.md)
  - [OneSignal::PlayerNotificationTarget](docs/PlayerNotificationTarget.md)
+ - [OneSignal::PlayerNotificationTargetIncludeAliases](docs/PlayerNotificationTargetIncludeAliases.md)
  - [OneSignal::PlayerSlice](docs/PlayerSlice.md)
+ - [OneSignal::PropertiesDeltas](docs/PropertiesDeltas.md)
+ - [OneSignal::PropertiesObject](docs/PropertiesObject.md)
  - [OneSignal::Purchase](docs/Purchase.md)
  - [OneSignal::Segment](docs/Segment.md)
  - [OneSignal::SegmentNotificationTarget](docs/SegmentNotificationTarget.md)
  - [OneSignal::StringMap](docs/StringMap.md)
+ - [OneSignal::SubscriptionObject](docs/SubscriptionObject.md)
+ - [OneSignal::TransferSubscriptionRequestBody](docs/TransferSubscriptionRequestBody.md)
  - [OneSignal::UpdateLiveActivityRequest](docs/UpdateLiveActivityRequest.md)
  - [OneSignal::UpdateLiveActivitySuccessResponse](docs/UpdateLiveActivitySuccessResponse.md)
  - [OneSignal::UpdatePlayerSuccessResponse](docs/UpdatePlayerSuccessResponse.md)
  - [OneSignal::UpdatePlayerTagsRequestBody](docs/UpdatePlayerTagsRequestBody.md)
  - [OneSignal::UpdatePlayerTagsSuccessResponse](docs/UpdatePlayerTagsSuccessResponse.md)
+ - [OneSignal::UpdateSubscriptionRequestBody](docs/UpdateSubscriptionRequestBody.md)
+ - [OneSignal::UpdateUserRequest](docs/UpdateUserRequest.md)
+ - [OneSignal::User](docs/User.md)
+ - [OneSignal::UserIdentityRequestBody](docs/UserIdentityRequestBody.md)
+ - [OneSignal::UserIdentityResponse](docs/UserIdentityResponse.md)
+ - [OneSignal::UserSubscriptionOptions](docs/UserSubscriptionOptions.md)
 
 
 ## Documentation for Authorization

diff --git a/docs/BasicNotification.md b/docs/BasicNotification.md
@@ -16,6 +16,8 @@
 | **include_chrome_reg_ids** | **Array&lt;String&gt;** | Not Recommended: Please consider using include_player_ids or include_external_user_ids instead. Target using Chrome App registration IDs. If a token does not correspond to an existing user, a new user will be created. Example: APA91bEeiUeSukAAUdnw3O2RB45FWlSpgJ7Ji_... Limit of 2,000 entries per REST API call  | [optional] |
 | **include_chrome_web_reg_ids** | **Array&lt;String&gt;** | Not Recommended: Please consider using include_player_ids or include_external_user_ids instead. Target using Chrome Web Push registration IDs. If a token does not correspond to an existing user, a new user will be created. Example: APA91bEeiUeSukAAUdnw3O2RB45FWlSpgJ7Ji_... Limit of 2,000 entries per REST API call  | [optional] |
 | **include_android_reg_ids** | **Array&lt;String&gt;** | Not Recommended: Please consider using include_player_ids or include_external_user_ids instead. Target using Android device registration IDs. If a token does not correspond to an existing user, a new user will be created. Example: APA91bEeiUeSukAAUdnw3O2RB45FWlSpgJ7Ji_... Limit of 2,000 entries per REST API call  | [optional] |
+| **include_aliases** | [**PlayerNotificationTargetIncludeAliases**](PlayerNotificationTargetIncludeAliases.md) |  | [optional] |
+| **target_channel** | **String** |  | [optional] |
 | **id** | **String** |  | [optional] |
 | **value** | **Integer** |  | [optional][readonly] |
 | **name** | **String** | Required for SMS Messages. An identifier for tracking message within the OneSignal dashboard or export analytics. Not shown to end user. | [optional] |
@@ -124,6 +126,8 @@ instance = OneSignal::BasicNotification.new(
   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,

diff --git a/docs/CreateNotificationSuccessResponse.md b/docs/CreateNotificationSuccessResponse.md
@@ -4,8 +4,8 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **id** | **String** |  |  |
-| **recipients** | **Integer** | Estimated number of subscribers targetted by notification. |  |
+| **id** | **String** |  | [optional] |
+| **recipients** | **Integer** | Estimated number of subscribers targetted by notification. | [optional] |
 | **external_id** | **String** |  | [optional] |
 | **errors** | [**Notification200Errors**](Notification200Errors.md) |  | [optional] |
 

diff --git a/docs/CreateSubscriptionRequestBody.md b/docs/CreateSubscriptionRequestBody.md
@@ -0,0 +1,20 @@
+# OneSignal::CreateSubscriptionRequestBody
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **subscription** | [**SubscriptionObject**](SubscriptionObject.md) |  | [optional] |
+| **retain_previous_owner** | **Boolean** |  | [optional] |
+
+## Example
+
+```ruby
+require 'onesignal'
+
+instance = OneSignal::CreateSubscriptionRequestBody.new(
+  subscription: null,
+  retain_previous_owner: null
+)
+```
+
diff --git a/docs/CreateUserConflictResponse.md b/docs/CreateUserConflictResponse.md
@@ -0,0 +1,18 @@
+# OneSignal::CreateUserConflictResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **errors** | [**Array&lt;CreateUserConflictResponseErrorsInner&gt;**](CreateUserConflictResponseErrorsInner.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'onesignal'
+
+instance = OneSignal::CreateUserConflictResponse.new(
+  errors: null
+)
+```
+
diff --git a/docs/CreateUserConflictResponseErrorsInner.md b/docs/CreateUserConflictResponseErrorsInner.md
@@ -0,0 +1,22 @@
+# OneSignal::CreateUserConflictResponseErrorsInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **code** | **String** |  | [optional] |
+| **title** | **String** |  | [optional] |
+| **meta** | [**CreateUserConflictResponseErrorsItemsMeta**](CreateUserConflictResponseErrorsItemsMeta.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'onesignal'
+
+instance = OneSignal::CreateUserConflictResponseErrorsInner.new(
+  code: null,
+  title: null,
+  meta: null
+)
+```
+
diff --git a/docs/CreateUserConflictResponseErrorsItemsMeta.md b/docs/CreateUserConflictResponseErrorsItemsMeta.md
@@ -0,0 +1,18 @@
+# OneSignal::CreateUserConflictResponseErrorsItemsMeta
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **conflicting_aliases** | **Object** |  | [optional] |
+
+## Example
+
+```ruby
+require 'onesignal'
+
+instance = OneSignal::CreateUserConflictResponseErrorsItemsMeta.new(
+  conflicting_aliases: null
+)
+```
+