onesignal 0.3.0 → 1.0.0.beta1

data/docs/Operator.md

@@ -0,0 +1,18 @@
+# OneSignal::Operator
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **operator** | **String** | Strictly, this must be either `\"OR\"`, or `\"AND\"`.  It can be used to compose Filters as part of a Filters object. | [optional] |
+
+## Example
+
+```ruby
+require 'onesignal'
+
+instance = OneSignal::Operator.new(
+  operator: null
+)
+```
+

data/docs/OutcomeData.md

@@ -0,0 +1,22 @@
+# OneSignal::OutcomeData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **value** | **Integer** |  |  |
+| **aggregation** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'onesignal'
+
+instance = OneSignal::OutcomeData.new(
+  id: null,
+  value: null,
+  aggregation: null
+)
+```
+

data/docs/PlatformDeliveryData.md

@@ -0,0 +1,28 @@
+# OneSignal::PlatformDeliveryData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **edge_web_push** | [**DeliveryData**](DeliveryData.md) |  | [optional] |
+| **chrome_web_push** | [**DeliveryData**](DeliveryData.md) |  | [optional] |
+| **firefox_web_push** | [**DeliveryData**](DeliveryData.md) |  | [optional] |
+| **safari_web_push** | [**DeliveryData**](DeliveryData.md) |  | [optional] |
+| **android** | [**DeliveryData**](DeliveryData.md) |  | [optional] |
+| **ios** | [**DeliveryData**](DeliveryData.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'onesignal'
+
+instance = OneSignal::PlatformDeliveryData.new(
+  edge_web_push: null,
+  chrome_web_push: null,
+  firefox_web_push: null,
+  safari_web_push: null,
+  android: null,
+  ios: null
+)
+```
+

data/docs/Player.md

@@ -0,0 +1,70 @@
+# OneSignal::Player
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The device's OneSignal ID | [readonly] |
+| **invalid_identifier** | **Boolean** | If true, this is the equivalent of a user being Unsubscribed | [optional][readonly] |
+| **app_id** | **String** |  |  |
+| **device_type** | **Integer** | Required The device's platform:   0 = iOS   1 = Android   2 = Amazon   3 = WindowsPhone (MPNS)   4 = Chrome Apps / Extensions   5 = Chrome Web Push   6 = Windows (WNS)   7 = Safari   8 = Firefox   9 = MacOS   10 = Alexa   11 = Email   13 = For Huawei App Gallery Builds SDK Setup. Not for Huawei Devices using FCM   14 = SMS  |  |
+| **external_user_id** | **String** | a custom user ID | [optional] |
+| **external_user_id_auth_hash** | **String** | Only required if you have enabled Identity Verification and device_type is NOT 11 email. | [optional] |
+| **email_auth_hash** | **String** | Email - Only required if you have enabled Identity Verification and device_type is email (11). | [optional] |
+| **identifier** | **String** | Recommended: For Push Notifications, this is the Push Token Identifier from Google or Apple. For Apple Push identifiers, you must strip all non alphanumeric characters. Examples: iOS: 7abcd558f29d0b1f048083e2834ad8ea4b3d87d8ad9c088b33c132706ff445f0 Android: APA91bHbYHk7aq-Uam_2pyJ2qbZvqllyyh2wjfPRaw5gLEX2SUlQBRvOc6sck1sa7H7nGeLNlDco8lXj83HWWwzV... For Email Addresses, set the full email address email@email.com and make sure to set device_type to 11.  | [optional] |
+| **language** | **String** | Language code. Typically lower case two letters, except for Chinese where it must be one of zh-Hans or zh-Hant. Example: en  | [optional] |
+| **timezone** | **Integer** | Number of seconds away from UTC. Example: -28800  | [optional] |
+| **game_version** | **String** | Version of your app. Example: 1.1  | [optional] |
+| **device_model** | **String** | Device make and model. Example: iPhone5,1  | [optional] |
+| **device_os** | **String** | Device operating system version. Example: 7.0.4  | [optional] |
+| **ad_id** | **String** | The ad id for the device's platform: Android = Advertising Id iOS = identifierForVendor WP8.0 = DeviceUniqueId WP8.1 = AdvertisingId  | [optional] |
+| **sdk** | **String** | Name and version of the sdk/plugin that's calling this API method (if any) | [optional] |
+| **session_count** | **Integer** | Number of times the user has played the game, defaults to 1 | [optional] |
+| **tags** | **Object** | Custom tags for the player. Only support string and integer key value pairs. Does not support arrays or other nested objects. Setting a tag value to null or an empty string will remove the tag. Example: {\"foo\":\"bar\",\"this\":\"that\"} Limitations: - 100 tags per call - Android SDK users: tags cannot be removed or changed via API if set through SDK sendTag methods. Recommended to only tag devices with 1 kilobyte of data Please consider using your own Database to save more than 1 kilobyte of data. See: Internal Database & CRM  | [optional] |
+| **amount_spent** | **String** | Amount the user has spent in USD, up to two decimal places | [optional] |
+| **created_at** | **Integer** | Unixtime when the player joined the game | [optional] |
+| **playtime** | **Integer** | Seconds player was running your app. | [optional] |
+| **badge_count** | **Integer** | Current iOS badge count displayed on the app icon NOTE: Not supported for apps created after June 2018, since badge count for apps created after this date are handled on the client.  | [optional] |
+| **last_active** | **Integer** | Unixtime when the player was last active | [optional] |
+| **notification_types** | **Integer** | 1 = subscribed -2 = unsubscribed iOS - These values are set each time the user opens the app from the SDK. Use the SDK function set Subscription instead. Android - You may set this but you can no longer use the SDK method setSubscription later in your app as it will create synchronization issues.  | [optional] |
+| **test_type** | **Integer** | This is used in deciding whether to use your iOS Sandbox or Production push certificate when sending a push when both have been uploaded. Set to the iOS provisioning profile that was used to build your app. 1 = Development 2 = Ad-Hoc Omit this field for App Store builds.  | [optional] |
+| **long** | **Float** | Longitude of the device, used for geotagging to segment on. | [optional] |
+| **lat** | **Float** | Latitude of the device, used for geotagging to segment on. | [optional] |
+| **country** | **String** | Country code in the ISO 3166-1 Alpha 2 format | [optional] |
+
+## Example
+
+```ruby
+require 'onesignal'
+
+instance = OneSignal::Player.new(
+  id: null,
+  invalid_identifier: null,
+  app_id: null,
+  device_type: null,
+  external_user_id: null,
+  external_user_id_auth_hash: null,
+  email_auth_hash: null,
+  identifier: null,
+  language: null,
+  timezone: null,
+  game_version: null,
+  device_model: null,
+  device_os: null,
+  ad_id: null,
+  sdk: null,
+  session_count: null,
+  tags: null,
+  amount_spent: null,
+  created_at: null,
+  playtime: null,
+  badge_count: null,
+  last_active: null,
+  notification_types: null,
+  test_type: null,
+  long: null,
+  lat: null,
+  country: null
+)
+```
+

data/docs/PlayerNotificationTarget.md

@@ -0,0 +1,36 @@
+# OneSignal::PlayerNotificationTarget
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **include_player_ids** | **Array<String>** | 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: [\"1dd608f2-c6a1-11e3-851d-000c2940e62c\"] Limit of 2,000 entries per REST API call  | [optional] |
+| **include_external_user_ids** | **Array<String>** | Target specific devices by custom user IDs assigned via API. Not compatible with any other targeting parameters Example: [“custom-id-assigned-by-api”] 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] |
+| **include_email_tokens** | **Array<String>** | 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] |
+| **include_phone_numbers** | **Array<String>** | Recommended for Sending SMS - Target specific phone numbers. The phone number should be in the E.164 format. Phone number should be an existing subscriber on OneSignal. Refer our docs to learn how to add phone numbers to OneSignal. Example phone number: +1999999999 Limit of 2,000 entries per REST API call  | [optional] |
+| **include_ios_tokens** | **Array<String>** | Not Recommended: Please consider using include_player_ids or include_external_user_ids instead. Target using iOS device tokens. Warning: Only works with Production tokens. All non-alphanumeric characters must be removed from each token. If a token does not correspond to an existing user, a new user will be created. Example: ce777617da7f548fe7a9ab6febb56cf39fba6d38203... Limit of 2,000 entries per REST API call  | [optional] |
+| **include_wp_wns_uris** | **Array<String>** | Not Recommended: Please consider using include_player_ids or include_external_user_ids instead. Target using Windows URIs. If a token does not correspond to an existing user, a new user will be created. Example: http://s.notify.live.net/u/1/bn1/HmQAAACPaLDr-... Limit of 2,000 entries per REST API call  | [optional] |
+| **include_amazon_reg_ids** | **Array<String>** | Not Recommended: Please consider using include_player_ids or include_external_user_ids instead. Target using Amazon ADM registration IDs. If a token does not correspond to an existing user, a new user will be created. Example: amzn1.adm-registration.v1.XpvSSUk0Rc3hTVVV... Limit of 2,000 entries per REST API call  | [optional] |
+| **include_chrome_reg_ids** | **Array<String>** | 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<String>** | 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<String>** | 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] |
+
+## Example
+
+```ruby
+require 'onesignal'
+
+instance = OneSignal::PlayerNotificationTarget.new(
+  include_player_ids: null,
+  include_external_user_ids: null,
+  include_email_tokens: null,
+  include_phone_numbers: null,
+  include_ios_tokens: null,
+  include_wp_wns_uris: null,
+  include_amazon_reg_ids: null,
+  include_chrome_reg_ids: null,
+  include_chrome_web_reg_ids: null,
+  include_android_reg_ids: null
+)
+```
+

data/docs/PlayerSlice.md

@@ -0,0 +1,24 @@
+# OneSignal::PlayerSlice
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **total_count** | **Integer** |  | [optional] |
+| **offset** | **Integer** |  | [optional] |
+| **limit** | **Integer** |  | [optional] |
+| **players** | [**Array<Player>**](Player.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'onesignal'
+
+instance = OneSignal::PlayerSlice.new(
+  total_count: null,
+  offset: null,
+  limit: null,
+  players: null
+)
+```
+

data/docs/Purchase.md

@@ -0,0 +1,22 @@
+# OneSignal::Purchase
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **sku** | **String** | The unique identifier of the purchased item. |  |
+| **amount** | **Float** | The amount, in USD, spent purchasing the item. |  |
+| **iso** | **String** | The 3-letter ISO 4217 currency code. Required for correct storage and conversion of amount. |  |
+
+## Example
+
+```ruby
+require 'onesignal'
+
+instance = OneSignal::Purchase.new(
+  sku: null,
+  amount: null,
+  iso: null
+)
+```
+

data/docs/Segment.md

@@ -0,0 +1,22 @@
+# OneSignal::Segment
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | UUID of the segment.  If left empty, it will be assigned automaticaly. | [optional] |
+| **name** | **String** | Name of the segment.  You'll see this name on the Web UI. |  |
+| **filters** | [**Array<FilterExpressions>**](FilterExpressions.md) | Filter or operators the segment will have.  For a list of available filters with details, please see Send to Users Based on Filters. |  |
+
+## Example
+
+```ruby
+require 'onesignal'
+
+instance = OneSignal::Segment.new(
+  id: null,
+  name: null,
+  filters: null
+)
+```
+

data/docs/SegmentNotificationTarget.md

@@ -0,0 +1,20 @@
+# OneSignal::SegmentNotificationTarget
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **included_segments** | **Array<String>** | 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: [\"Active Users\", \"Inactive Users\"]  | [optional] |
+| **excluded_segments** | **Array<String>** | 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: [\"Active Users\", \"Inactive Users\"]  | [optional] |
+
+## Example
+
+```ruby
+require 'onesignal'
+
+instance = OneSignal::SegmentNotificationTarget.new(
+  included_segments: null,
+  excluded_segments: null
+)
+```
+

data/docs/StringMap.md

@@ -0,0 +1,102 @@
+# OneSignal::StringMap
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **en** | **String** | Text in English.  Will be used as a fallback |  |
+| **ar** | **String** | Text in Arabic. | [optional] |
+| **bs** | **String** | Text in Bosnian. | [optional] |
+| **bg** | **String** | Text in Bulgarian. | [optional] |
+| **ca** | **String** | Text in Catalan. | [optional] |
+| **zh_hans** | **String** | Text in Chinese (Simplified). | [optional] |
+| **zh_hant** | **String** | Text in Chinese (Traditional). | [optional] |
+| **zh** | **String** | Alias for zh-Hans. | [optional] |
+| **hr** | **String** | Text in Croatian. | [optional] |
+| **cs** | **String** | Text in Czech. | [optional] |
+| **da** | **String** | Text in Danish. | [optional] |
+| **nl** | **String** | Text in Dutch. | [optional] |
+| **et** | **String** | Text in Estonian. | [optional] |
+| **fi** | **String** | Text in Finnish. | [optional] |
+| **fr** | **String** | Text in French. | [optional] |
+| **ka** | **String** | Text in Georgian. | [optional] |
+| **de** | **String** | Text in German. | [optional] |
+| **el** | **String** | Text in Greek. | [optional] |
+| **hi** | **String** | Text in Hindi. | [optional] |
+| **he** | **String** | Text in Hebrew. | [optional] |
+| **hu** | **String** | Text in Hungarian. | [optional] |
+| **id** | **String** | Text in Indonesian. | [optional] |
+| **it** | **String** | Text in Italian. | [optional] |
+| **ja** | **String** | Text in Japanese. | [optional] |
+| **ko** | **String** | Text in Korean. | [optional] |
+| **lv** | **String** | Text in Latvian. | [optional] |
+| **lt** | **String** | Text in Lithuanian. | [optional] |
+| **ms** | **String** | Text in Malay. | [optional] |
+| **nb** | **String** | Text in Norwegian. | [optional] |
+| **pl** | **String** | Text in Polish. | [optional] |
+| **fa** | **String** | Text in Persian. | [optional] |
+| **pt** | **String** | Text in Portugese. | [optional] |
+| **pa** | **String** | Text in Punjabi. | [optional] |
+| **ro** | **String** | Text in Romanian. | [optional] |
+| **ru** | **String** | Text in Russian. | [optional] |
+| **sr** | **String** | Text in Serbian. | [optional] |
+| **sk** | **String** | Text in Slovak. | [optional] |
+| **es** | **String** | Text in Spanish. | [optional] |
+| **sv** | **String** | Text in Swedish. | [optional] |
+| **th** | **String** | Text in Thai. | [optional] |
+| **tr** | **String** | Text in Turkish. | [optional] |
+| **uk** | **String** | Text in Ukrainian. | [optional] |
+| **vi** | **String** | Text in Vietnamese. | [optional] |
+
+## Example
+
+```ruby
+require 'onesignal'
+
+instance = OneSignal::StringMap.new(
+  en: null,
+  ar: null,
+  bs: null,
+  bg: null,
+  ca: null,
+  zh_hans: null,
+  zh_hant: null,
+  zh: null,
+  hr: null,
+  cs: null,
+  da: null,
+  nl: null,
+  et: null,
+  fi: null,
+  fr: null,
+  ka: null,
+  de: null,
+  el: null,
+  hi: null,
+  he: null,
+  hu: null,
+  id: null,
+  it: null,
+  ja: null,
+  ko: null,
+  lv: null,
+  lt: null,
+  ms: null,
+  nb: null,
+  pl: null,
+  fa: null,
+  pt: null,
+  pa: null,
+  ro: null,
+  ru: null,
+  sr: null,
+  sk: null,
+  es: null,
+  sv: null,
+  th: null,
+  tr: null,
+  uk: null,
+  vi: null
+)
+```
+

data/docs/UpdatePlayerTagsRequestBody.md

@@ -0,0 +1,18 @@
+# OneSignal::UpdatePlayerTagsRequestBody
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **tags** | **Object** | Custom tags for the device record.  Only support string key value pairs.  Does not support arrays or other nested objects.  Example `{\"foo\":\"bar\",\"this\":\"that\"}`. Limitations: - 100 tags per call - Android SDK users: tags cannot be removed or changed via API if set through SDK sendTag methods. Recommended to only tag devices with 1 kilobyte of ata Please consider using your own Database to save more than 1 kilobyte of data.  See: Internal Database & CRM  | [optional] |
+
+## Example
+
+```ruby
+require 'onesignal'
+
+instance = OneSignal::UpdatePlayerTagsRequestBody.new(
+  tags: null
+)
+```
+

data/git_push.sh

@@ -0,0 +1,58 @@
+#!/bin/sh
+# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/
+#
+# Usage example: /bin/sh ./git_push.sh wing328 openapi-pestore-perl "minor update" "gitlab.com"
+
+git_user_id=$1
+git_repo_id=$2
+release_note=$3
+git_host=$4
+
+if [ "$git_host" = "" ]; then
+    git_host="github.com"
+    echo "[INFO] No command line input provided. Set \$git_host to $git_host"
+fi
+
+if [ "$git_user_id" = "" ]; then
+    git_user_id="GIT_USER_ID"
+    echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id"
+fi
+
+if [ "$git_repo_id" = "" ]; then
+    git_repo_id="GIT_REPO_ID"
+    echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id"
+fi
+
+if [ "$release_note" = "" ]; then
+    release_note="Minor update"
+    echo "[INFO] No command line input provided. Set \$release_note to $release_note"
+fi
+
+# Initialize the local directory as a Git repository
+git init
+
+# Adds the files in the local repository and stages them for commit.
+git add .
+
+# Commits the tracked changes and prepares them to be pushed to a remote repository.
+git commit -m "$release_note"
+
+# Sets the new remote
+git_remote=`git remote`
+if [ "$git_remote" = "" ]; then # git remote not defined
+
+    if [ "$GIT_TOKEN" = "" ]; then
+        echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment."
+        git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git
+    else
+        git remote add origin https://${git_user_id}:${GIT_TOKEN}@${git_host}/${git_user_id}/${git_repo_id}.git
+    fi
+
+fi
+
+git pull origin master
+
+# Pushes (Forces) the changes in the local repository up to the remote repository
+echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git"
+git push origin master 2>&1 | grep -v 'To https'
+

data/lib/OneSignal.rb

@@ -0,0 +1,75 @@
+=begin
+#OneSignal
+
+#A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com
+
+The version of the OpenAPI document: 1.0.0
+Contact: devrel@onesignal.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.2.0-SNAPSHOT
+
+=end
+
+# Common files
+require 'onesignal/api_client'
+require 'onesignal/api_error'
+require 'onesignal/version'
+require 'onesignal/configuration'
+
+# Models
+require 'onesignal/models/app'
+require 'onesignal/models/button'
+require 'onesignal/models/delivery_data'
+require 'onesignal/models/export_players_request_body'
+require 'onesignal/models/filter'
+require 'onesignal/models/filter_expressions'
+require 'onesignal/models/filter_notification_target'
+require 'onesignal/models/get_notification_request_body'
+require 'onesignal/models/inline_response200'
+require 'onesignal/models/inline_response2001'
+require 'onesignal/models/inline_response2002'
+require 'onesignal/models/inline_response2003'
+require 'onesignal/models/inline_response2004'
+require 'onesignal/models/inline_response2005'
+require 'onesignal/models/inline_response201'
+require 'onesignal/models/inline_response400'
+require 'onesignal/models/inline_response4001'
+require 'onesignal/models/inline_response4002'
+require 'onesignal/models/inline_response409'
+require 'onesignal/models/notification'
+require 'onesignal/models/notification_all_of'
+require 'onesignal/models/notification_all_of_android_background_layout'
+require 'onesignal/models/notification_slice'
+require 'onesignal/models/notification_target'
+require 'onesignal/models/operator'
+require 'onesignal/models/outcome_data'
+require 'onesignal/models/platform_delivery_data'
+require 'onesignal/models/player'
+require 'onesignal/models/player_notification_target'
+require 'onesignal/models/player_slice'
+require 'onesignal/models/purchase'
+require 'onesignal/models/segment'
+require 'onesignal/models/segment_notification_target'
+require 'onesignal/models/string_map'
+require 'onesignal/models/update_player_tags_request_body'
+
+# APIs
+require 'onesignal/api/default_api'
+
+module OneSignal
+  class << self
+    # Customize default settings for the SDK using block.
+    #   OneSignal.configure do |config|
+    #     config.username = "xxx"
+    #     config.password = "xxx"
+    #   end
+    # If no block given, return the default Configuration object.
+    def configure
+      if block_given?
+        yield(Configuration.default)
+      else
+        Configuration.default
+      end
+    end
+  end
+end