urbanairship 9.1.0 → 9.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4271dd0c7f5cc4da7c6438cfec017d10be9ddb8c28145f541cf026ec1c179258
-  data.tar.gz: 609aa096ad24c679a32ab69fca8487ebe7e939150505d9f91c506937ce8e8ac0
+  metadata.gz: d8a262b36f56dcbbe4cd38fb926cff9ec835900abf5cc5564d780c3ea655fc32
+  data.tar.gz: 7ffe155e6edd97f0a8899401b3bdc68a83e7cfd46073cf430dd129116a235111
 SHA512:
-  metadata.gz: d743974f8312e3d42f890873a3bd78f44483be14a4593c169f6587be560358771667127b1dabc30286cf3577161f573f9f73a13a9b6eb25840a686bf7d917e4f
-  data.tar.gz: 1abaa92b5fa0fea9afd3274ffac2bcc44a91280c514e05e11aab3612d0b886bfa11d4a9c1fa42ea887dd3638cdf6d336c187f6e8518f2618175e6b59f46fd3c2
+  metadata.gz: 7d3aaef8a3b3dea1058a9062b84c183bd8a9d97466c4f308c200f39f691cd6f510951541e5584a0ba0359c1f41cb10a5773ce4ef21925e6b38d4e67da35f1073
+  data.tar.gz: b93ed256288f1ec16f97fd3e8bd4b0eeae0c57a1070534302c2386deb8098131e70f55fc55396f34b0e20950c4170b6f0335d2a98b9d0c8301a047b641a4f3cd

data/.github/workflows/release.yaml

@@ -6,7 +6,6 @@ on:
 
 jobs:
   test:
-
     runs-on: ubuntu-latest
 
     strategy:
@@ -27,5 +26,5 @@ jobs:
         uses: cadwallion/publish-rubygems-action@master
         env:
           RUBYGEMS_API_KEY: ${{secrets.RUBYGEMS_API_KEY}}
-          GUTHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
-          RELEASE_COMMAND: rake release
+          GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
+          RELEASE_COMMAND: rake release

data/CHANGELOG

@@ -1,103 +1,130 @@
---------------------
-9.1.0
---------------------
+## 9.2.0
+
+- Adds support for iOS Live Activity and Android Live Update
+- Adds bypass_frequency_limits, bypass_holdout_groups, no_throttle, omit_from_activity_log, personalization, redact_payload parameters for push options
+
+---
+
+## 9.1.1
+
+- Adds thread_id Support
+
+---
+
+## 9.1.0
+
 - All requests will now automatically attempt to authenticate with bearer token auth if a
-token is included in the instantiation of the client. Previously, only custom events requests 
-could use bearer token auth in this library. You can find more information about how to use 
-bearer token auth in the README.
-- Also fixes an issue where a secret was required even when bearer token auth was being used 
-(it is no longer required).
-
---------------------
-9.0.0
---------------------
+  token is included in the instantiation of the client. Previously, only custom events requests
+  could use bearer token auth in this library. You can find more information about how to use
+  bearer token auth in the README.
+- Also fixes an issue where a secret was required even when bearer token auth was being used
+  (it is no longer required).
+
+---
+
+## 9.0.0
+
 - Adds Tag List API Support
 - Removes location lookup endpoints
 - Removes location-based audience selectors
 
---------------------
-8.0.1
---------------------
+---
+
+## 8.0.1
+
 - Adds app key to user agent string on request
 
---------------------
-8.0.0
---------------------
+---
+
+## 8.0.0
+
 - Updates officially supported versions to 2.6.7 and 2.7.2
 - Fixes headers to reduce warning messages
 - Fixes for multiple mis-set named user urls
 - Fix to automatically convert an integer named user to a string so it can be successfully submitted
 - Adds attribute support for named users
 
---------------------
-7.0.0
---------------------
+---
+
+## 7.0.0
+
 - Refactors base url naming
 
---------------------
-6.0.0
---------------------
+---
+
+## 6.0.0
+
 - Creates custom base url, and refactors urls within classes
 - Adds support for sending custom events
 
---------------------
-5.9.0
---------------------
+---
+
+## 5.9.0
+
 - Adds support for bearer token auth
 - Updates broken code for static lists
-- Adds support for update sms channel 
+- Adds support for update sms channel
+
+---
+
+## 5.8.0
 
---------------------
-5.8.0
---------------------
 - Adds scheudling support for PTSO
-- Adds attribute support 
+- Adds attribute support
+
+---
+
+## 5.7.0
 
---------------------
-5.7.0
---------------------
 - Adds Automation support
 - Adds A/B test support
 
---------------------
-5.6.1
---------------------
-- Updates EmailNotification templating 
+---
+
+## 5.6.1
+
+- Updates EmailNotification templating
+
+---
+
+## 5.6.0
 
---------------------
-5.6.0
---------------------
 - Refactors EmailNotification class
 - Adds Create and Send implementation to Open Channel class
 
---------------------
-5.5.1
---------------------
-- Updates validate_url method 
+---
+
+## 5.5.1
+
+- Updates validate_url method
+
+---
+
+## 5.5.0
 
---------------------
-5.5.0
---------------------
 - Add Create and Send Functionality for Email
 - Add endpoints for Create and Send Validation and Scheduling
 - Add Create and Send Functionality for SMS
 - Update Rake version from 10.0 to 12.3.3
 
---------------------
-5.4.0
---------------------
+---
+
+## 5.4.0
+
 - Change BASE_URL to go.airship.com
 
---------------------
-5.3.0
---------------------
+---
+
+## 5.3.0
+
 - Updates Sphinx version on Ruby Lib docs
 - Fixes date in footer
 - Updates instances of 'Urbain Airship' to 'Airship' excluding method names
 
---------------------
-5.2.0
---------------------
+---
+
+## 5.2.0
+
 - Updates automatic timeout for API request from 5 seconds to 60
 - Adds SMS Register implementation. Register, Opt-out, Uninstall, Lookup
 - Adds SMS Send functionality for Notification object
@@ -105,36 +132,42 @@ bearer token auth in the README.
 - Adds Email Send support
 - Adds Email Registration support
 
---------------------
-5.1.0
---------------------
+---
+
+## 5.1.0
+
 - Adds functionality for custom logger
 
---------------------
-5.0.1
---------------------
+---
+
+## 5.0.1
+
 - Fix bug with named user association/disassociation
 
---------------------
-5.0.0
---------------------
+---
+
+## 5.0.0
+
 - Add support for Web Notify, expand Open Platform support
 - Removing support for Feedback API (EOL July 2018)
 - Removing support for Device Token Count (also EOL in 2018)
 
---------------------
-4.1.1
---------------------
+---
+
+## 4.1.1
+
 - Added configuration value for timeout.
 
---------------------
-4.1.0
---------------------
+---
+
+## 4.1.0
+
 - Added support for Open Channels
 
---------------------
-4.0.0
---------------------
+---
+
+## 4.0.0
+
 - Added support for in-app messages
 - Added support for iOS priority
 - Added config class, allowing you to define log level and log location
@@ -144,41 +177,48 @@ bearer token auth in the README.
 - Removed support for Blackberry and MPNS platforms
 - Removed support for per-push reports
 
---------------------
-3.2.4
---------------------
+---
+
+## 3.2.4
+
 - Replace unirest dependency with rest-client
 
---------------------
-3.2.3
---------------------
+---
+
+## 3.2.3
+
 - Added support for named user audience selector
 
---------------------
-3.2.2
---------------------
+---
+
+## 3.2.2
+
 - Bug fix: only open a single copy of the log file
 
---------------------
-3.2.1
---------------------
+---
+
+## 3.2.1
+
 - Bug fix: allow audience tag selector to specify tag group if desired
 
---------------------
-3.2.0
---------------------
+---
+
+## 3.2.0
+
 - Added support for static lists
 - Added support for device tokens, APIDs, and Blackberry PINs
 - Added support for locations
 
---------------------
-3.1.1
---------------------
+---
+
+## 3.1.1
+
 - Changed UA to Urbanairship in client.rb to fix aliasing issue
 
---------------------
-3.1.0
---------------------
+---
+
+## 3.1.0
+
 - Added documentation files
 - Added support for ChannelInfo and ChannelList
 - Added support for segments
@@ -188,19 +228,22 @@ bearer token auth in the README.
 - Added support for named user
 - Added support for reports
 
---------------------
-3.0.2
---------------------
+---
+
+## 3.0.2
+
 - Resolve compatibility issues with Rails ActiveSupport
 
---------------------
-3.0.1
---------------------
+---
+
+## 3.0.1
+
 - Updating Gemspec to show required Ruby Version correctly
 
---------------------
-3.0.0
---------------------
+---
+
+## 3.0.0
+
 - added CHANGELOG
 - rewrite with v3 support for push and scheduled push
 - backwards incompatible with previous versions of library

data/docs/push.rst

@@ -218,6 +218,7 @@ platform-specific alerts, and we set a number of other platform-specific options
             extra: { 'key' => 'value', 'key2' => 'value2' },
             expiry: '2019-01-01 12:45:00',
             category: 'category_name',
+            thread_id: 'thread_test',
             interactive: UA.interactive(
                 type: 'ua_share',
                 button_actions: {

data/lib/urbanairship/push/payload.rb

@@ -34,7 +34,7 @@ module Urbanairship
       def ios(alert: nil, badge: nil, sound: nil, content_available: nil,
               extra: nil, expiry: nil, priority: nil, category: nil,
               interactive: nil, mutable_content: nil, media_attachment: nil,
-              title: nil, subtitle: nil, collapse_id: nil)
+              title: nil, subtitle: nil, collapse_id: nil, thread_id: nil, live_activity: nil)
         compact_helper({
           alert: alert,
           badge: badge,
@@ -49,7 +49,9 @@ module Urbanairship
           media_attachment: media_attachment,
           title: title,
           subtitle: subtitle,
-          collapse_id: collapse_id
+          collapse_id: collapse_id,
+          thread_id: thread_id,
+          live_activity: live_activity
         })
       end
 
@@ -76,7 +78,7 @@ module Urbanairship
                   public_notification: nil, sound: nil, priority: nil, collapse_key: nil,
                   time_to_live: nil, delivery_priority: nil, delay_while_idle: nil,
                   local_only: nil, wearable: nil, background_image: nil, extra_pages: nil,
-                  interactive: nil)
+                  interactive: nil, live_update: nil)
         compact_helper({
           title: title,
           alert: alert,
@@ -98,7 +100,8 @@ module Urbanairship
           delay_while_idle: delay_while_idle,
           local_only: local_only,
           wearable: wearable,
-          interactive: interactive
+          interactive: interactive,
+          live_update: live_update
         })
       end
 
@@ -214,10 +217,26 @@ module Urbanairship
         types
       end
 
-      # Expiry for a Rich Message
-      def options(expiry: required('expiry'))
-        { expiry: expiry }
-      end
+      # Options for a message
+      def options(
+        expiry: nil,
+        bypass_frequency_limits: nil,
+        bypass_holdout_groups: nil,
+        no_throttle: nil,
+        omit_from_activity_log: nil,
+        personalization: nil,
+        redact_payload: nil
+    )
+      compact_helper(
+        expiry: expiry,
+        bypass_frequency_limits: bypass_frequency_limits,
+        bypass_holdout_groups: bypass_holdout_groups,
+        no_throttle: no_throttle,
+        omit_from_activity_log: omit_from_activity_log,
+        personalization: personalization,
+        redact_payload: redact_payload
+      )
+    end
 
       # Actions for a Push Notification Object
       def actions(add_tag: nil, remove_tag: nil, open_: nil, share: nil,
@@ -295,6 +314,57 @@ module Urbanairship
           interactive: interactive,
         })
       end
+      
+      # iOS Live Activity
+      def live_activity(
+        event: required('event'), 
+        alert: nil, 
+        name: required('name'), 
+        priority: nil, 
+        content_state: nil, 
+        relevance_score: nil, 
+        stale_date: nil, 
+        dismissal_date: nil, 
+        timestamp: nil
+      )
+        valid_events = ['update', 'end']
+        fail ArgumentError, 'Invalid event type' unless valid_events.include?(event)
+        fail ArgumentError, 'priority must be 5 or 10' if priority && ![5, 10].include?(priority)
+      
+        compact_helper({
+          event: event,
+          alert: alert,
+          name: name,
+          priority: priority,
+          content_state: content_state,
+          relevance_score: relevance_score,
+          stale_date: stale_date,
+          dismissal_date: dismissal_date,
+          timestamp: timestamp
+        })
+      end
+      
+      # Android Live Update
+      def live_update(
+        event: required('event'), 
+        name: required('name'), 
+        content_state: nil, 
+        type: nil, 
+        dismissal_date: nil, 
+        timestamp: nil
+      )
+        valid_events = ['start', 'update', 'end']
+        fail ArgumentError, 'Invalid event type' unless valid_events.include?(event)
+      
+        compact_helper({
+          event: event,
+          name: name,
+          content_state: content_state,
+          type: type,
+          dismissal_date: dismissal_date,
+          timestamp: timestamp
+        })
+      end
     end
   end
 end

data/lib/urbanairship/version.rb

@@ -1,3 +1,3 @@
 module Urbanairship
-  VERSION = '9.1.0'
+  VERSION = '9.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: urbanairship
 version: !ruby/object:Gem::Version
-  version: 9.1.0
+  version: 9.2.0
 platform: ruby
 authors:
 - Airship
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-06-09 00:00:00.000000000 Z
+date: 2023-10-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -215,7 +215,7 @@ licenses:
 - Apache-2.0
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -230,8 +230,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3.1
-signing_key: 
+rubygems_version: 3.4.10
+signing_key:
 specification_version: 4
 summary: Ruby Gem for using the Airship API
 test_files: []