trycourier 3.4.0.pre.alpha3 → 3.4.0.pre.alpha5

data/rbi/trycourier/models/users/topic_preference.rbi

@@ -0,0 +1,80 @@
+# typed: strong
+
+module Trycourier
+  module Models
+    module Users
+      class TopicPreference < Trycourier::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Trycourier::Users::TopicPreference,
+              Trycourier::Internal::AnyHash
+            )
+          end
+
+        sig { returns(Trycourier::PreferenceStatus::TaggedSymbol) }
+        attr_accessor :default_status
+
+        sig { returns(Trycourier::PreferenceStatus::TaggedSymbol) }
+        attr_accessor :status
+
+        sig { returns(String) }
+        attr_accessor :topic_id
+
+        sig { returns(String) }
+        attr_accessor :topic_name
+
+        # The Channels a user has chosen to receive notifications through for this topic
+        sig do
+          returns(
+            T.nilable(T::Array[Trycourier::ChannelClassification::TaggedSymbol])
+          )
+        end
+        attr_accessor :custom_routing
+
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_accessor :has_custom_routing
+
+        sig do
+          params(
+            default_status: Trycourier::PreferenceStatus::OrSymbol,
+            status: Trycourier::PreferenceStatus::OrSymbol,
+            topic_id: String,
+            topic_name: String,
+            custom_routing:
+              T.nilable(T::Array[Trycourier::ChannelClassification::OrSymbol]),
+            has_custom_routing: T.nilable(T::Boolean)
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          default_status:,
+          status:,
+          topic_id:,
+          topic_name:,
+          # The Channels a user has chosen to receive notifications through for this topic
+          custom_routing: nil,
+          has_custom_routing: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              default_status: Trycourier::PreferenceStatus::TaggedSymbol,
+              status: Trycourier::PreferenceStatus::TaggedSymbol,
+              topic_id: String,
+              topic_name: String,
+              custom_routing:
+                T.nilable(
+                  T::Array[Trycourier::ChannelClassification::TaggedSymbol]
+                ),
+              has_custom_routing: T.nilable(T::Boolean)
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/trycourier/models/users/user_token.rbi

@@ -0,0 +1,291 @@
+# typed: strong
+
+module Trycourier
+  module Models
+    UserToken = Users::UserToken
+
+    module Users
+      class UserToken < Trycourier::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(Trycourier::Users::UserToken, Trycourier::Internal::AnyHash)
+          end
+
+        sig { returns(Trycourier::Users::UserToken::ProviderKey::TaggedSymbol) }
+        attr_accessor :provider_key
+
+        # Full body of the token. Must match token in URL.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :token
+
+        # Information about the device the token is associated with.
+        sig { returns(T.nilable(Trycourier::Users::UserToken::Device)) }
+        attr_reader :device
+
+        sig do
+          params(
+            device: T.nilable(Trycourier::Users::UserToken::Device::OrHash)
+          ).void
+        end
+        attr_writer :device
+
+        # ISO 8601 formatted date the token expires. Defaults to 2 months. Set to false to
+        # disable expiration.
+        sig do
+          returns(T.nilable(Trycourier::Users::UserToken::ExpiryDate::Variants))
+        end
+        attr_accessor :expiry_date
+
+        # Properties sent to the provider along with the token
+        sig { returns(T.nilable(T.anything)) }
+        attr_reader :properties
+
+        sig { params(properties: T.anything).void }
+        attr_writer :properties
+
+        # Information about the device the token is associated with.
+        sig { returns(T.nilable(Trycourier::Users::UserToken::Tracking)) }
+        attr_reader :tracking
+
+        sig do
+          params(
+            tracking: T.nilable(Trycourier::Users::UserToken::Tracking::OrHash)
+          ).void
+        end
+        attr_writer :tracking
+
+        sig do
+          params(
+            provider_key: Trycourier::Users::UserToken::ProviderKey::OrSymbol,
+            token: T.nilable(String),
+            device: T.nilable(Trycourier::Users::UserToken::Device::OrHash),
+            expiry_date:
+              T.nilable(Trycourier::Users::UserToken::ExpiryDate::Variants),
+            properties: T.anything,
+            tracking: T.nilable(Trycourier::Users::UserToken::Tracking::OrHash)
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          provider_key:,
+          # Full body of the token. Must match token in URL.
+          token: nil,
+          # Information about the device the token is associated with.
+          device: nil,
+          # ISO 8601 formatted date the token expires. Defaults to 2 months. Set to false to
+          # disable expiration.
+          expiry_date: nil,
+          # Properties sent to the provider along with the token
+          properties: nil,
+          # Information about the device the token is associated with.
+          tracking: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              provider_key:
+                Trycourier::Users::UserToken::ProviderKey::TaggedSymbol,
+              token: T.nilable(String),
+              device: T.nilable(Trycourier::Users::UserToken::Device),
+              expiry_date:
+                T.nilable(Trycourier::Users::UserToken::ExpiryDate::Variants),
+              properties: T.anything,
+              tracking: T.nilable(Trycourier::Users::UserToken::Tracking)
+            }
+          )
+        end
+        def to_hash
+        end
+
+        module ProviderKey
+          extend Trycourier::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, Trycourier::Users::UserToken::ProviderKey)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          FIREBASE_FCM =
+            T.let(
+              :"firebase-fcm",
+              Trycourier::Users::UserToken::ProviderKey::TaggedSymbol
+            )
+          APN =
+            T.let(:apn, Trycourier::Users::UserToken::ProviderKey::TaggedSymbol)
+          EXPO =
+            T.let(
+              :expo,
+              Trycourier::Users::UserToken::ProviderKey::TaggedSymbol
+            )
+          ONESIGNAL =
+            T.let(
+              :onesignal,
+              Trycourier::Users::UserToken::ProviderKey::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[Trycourier::Users::UserToken::ProviderKey::TaggedSymbol]
+            )
+          end
+          def self.values
+          end
+        end
+
+        class Device < Trycourier::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Trycourier::Users::UserToken::Device,
+                Trycourier::Internal::AnyHash
+              )
+            end
+
+          # Id of the advertising identifier
+          sig { returns(T.nilable(String)) }
+          attr_accessor :ad_id
+
+          # Id of the application the token is used for
+          sig { returns(T.nilable(String)) }
+          attr_accessor :app_id
+
+          # Id of the device the token is associated with
+          sig { returns(T.nilable(String)) }
+          attr_accessor :device_id
+
+          # The device manufacturer
+          sig { returns(T.nilable(String)) }
+          attr_accessor :manufacturer
+
+          # The device model
+          sig { returns(T.nilable(String)) }
+          attr_accessor :model
+
+          # The device platform i.e. android, ios, web
+          sig { returns(T.nilable(String)) }
+          attr_accessor :platform
+
+          # Information about the device the token is associated with.
+          sig do
+            params(
+              ad_id: T.nilable(String),
+              app_id: T.nilable(String),
+              device_id: T.nilable(String),
+              manufacturer: T.nilable(String),
+              model: T.nilable(String),
+              platform: T.nilable(String)
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # Id of the advertising identifier
+            ad_id: nil,
+            # Id of the application the token is used for
+            app_id: nil,
+            # Id of the device the token is associated with
+            device_id: nil,
+            # The device manufacturer
+            manufacturer: nil,
+            # The device model
+            model: nil,
+            # The device platform i.e. android, ios, web
+            platform: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                ad_id: T.nilable(String),
+                app_id: T.nilable(String),
+                device_id: T.nilable(String),
+                manufacturer: T.nilable(String),
+                model: T.nilable(String),
+                platform: T.nilable(String)
+              }
+            )
+          end
+          def to_hash
+          end
+        end
+
+        # ISO 8601 formatted date the token expires. Defaults to 2 months. Set to false to
+        # disable expiration.
+        module ExpiryDate
+          extend Trycourier::Internal::Type::Union
+
+          Variants = T.type_alias { T.any(String, T::Boolean) }
+
+          sig do
+            override.returns(
+              T::Array[Trycourier::Users::UserToken::ExpiryDate::Variants]
+            )
+          end
+          def self.variants
+          end
+        end
+
+        class Tracking < Trycourier::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Trycourier::Users::UserToken::Tracking,
+                Trycourier::Internal::AnyHash
+              )
+            end
+
+          # The IP address of the device
+          sig { returns(T.nilable(String)) }
+          attr_accessor :ip
+
+          # The latitude of the device
+          sig { returns(T.nilable(String)) }
+          attr_accessor :lat
+
+          # The longitude of the device
+          sig { returns(T.nilable(String)) }
+          attr_accessor :long
+
+          # The operating system version
+          sig { returns(T.nilable(String)) }
+          attr_accessor :os_version
+
+          # Information about the device the token is associated with.
+          sig do
+            params(
+              ip: T.nilable(String),
+              lat: T.nilable(String),
+              long: T.nilable(String),
+              os_version: T.nilable(String)
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # The IP address of the device
+            ip: nil,
+            # The latitude of the device
+            lat: nil,
+            # The longitude of the device
+            long: nil,
+            # The operating system version
+            os_version: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                ip: T.nilable(String),
+                lat: T.nilable(String),
+                long: T.nilable(String),
+                os_version: T.nilable(String)
+              }
+            )
+          end
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/trycourier/models.rbi

@@ -218,8 +218,6 @@ module Trycourier
 
   TextStyle = Trycourier::Models::TextStyle
 
-  TopicPreference = Trycourier::Models::TopicPreference
-
   TranslationRetrieveParams = Trycourier::Models::TranslationRetrieveParams
 
   TranslationUpdateParams = Trycourier::Models::TranslationUpdateParams
@@ -228,8 +226,6 @@ module Trycourier
 
   Users = Trycourier::Models::Users
 
-  UserToken = Trycourier::Models::UserToken
-
   Utm = Trycourier::Models::Utm
 
   WidgetBackground = Trycourier::Models::WidgetBackground

data/rbi/trycourier/resources/users/tokens.rbi

@@ -47,7 +47,7 @@ module Trycourier
           params(
             user_id: String,
             request_options: Trycourier::RequestOptions::OrHash
-          ).returns(T::Array[Trycourier::UserToken])
+          ).returns(T::Array[Trycourier::Users::UserToken])
         end
         def list(
           # The user's ID. This can be any uniquely identifiable string.
@@ -92,12 +92,13 @@ module Trycourier
           params(
             path_token: String,
             user_id: String,
-            provider_key: Trycourier::UserToken::ProviderKey::OrSymbol,
+            provider_key: Trycourier::Users::UserToken::ProviderKey::OrSymbol,
             body_token: T.nilable(String),
-            device: T.nilable(Trycourier::UserToken::Device::OrHash),
-            expiry_date: T.nilable(Trycourier::UserToken::ExpiryDate::Variants),
+            device: T.nilable(Trycourier::Users::UserToken::Device::OrHash),
+            expiry_date:
+              T.nilable(Trycourier::Users::UserToken::ExpiryDate::Variants),
             properties: T.anything,
-            tracking: T.nilable(Trycourier::UserToken::Tracking::OrHash),
+            tracking: T.nilable(Trycourier::Users::UserToken::Tracking::OrHash),
             request_options: Trycourier::RequestOptions::OrHash
           ).void
         end

data/sig/trycourier/models/users/preference_retrieve_response.rbs

@@ -3,22 +3,22 @@ module Trycourier
     module Users
       type preference_retrieve_response =
         {
-          items: ::Array[Trycourier::TopicPreference],
+          items: ::Array[Trycourier::Users::TopicPreference],
           paging: Trycourier::Paging
         }
 
       class PreferenceRetrieveResponse < Trycourier::Internal::Type::BaseModel
-        attr_accessor items: ::Array[Trycourier::TopicPreference]
+        attr_accessor items: ::Array[Trycourier::Users::TopicPreference]
 
         attr_accessor paging: Trycourier::Paging
 
         def initialize: (
-          items: ::Array[Trycourier::TopicPreference],
+          items: ::Array[Trycourier::Users::TopicPreference],
           paging: Trycourier::Paging
         ) -> void
 
         def to_hash: -> {
-          items: ::Array[Trycourier::TopicPreference],
+          items: ::Array[Trycourier::Users::TopicPreference],
           paging: Trycourier::Paging
         }
       end

data/sig/trycourier/models/users/preference_retrieve_topic_response.rbs

@@ -2,14 +2,14 @@ module Trycourier
   module Models
     module Users
       type preference_retrieve_topic_response =
-        { topic: Trycourier::TopicPreference }
+        { topic: Trycourier::Users::TopicPreference }
 
       class PreferenceRetrieveTopicResponse < Trycourier::Internal::Type::BaseModel
-        attr_accessor topic: Trycourier::TopicPreference
+        attr_accessor topic: Trycourier::Users::TopicPreference
 
-        def initialize: (topic: Trycourier::TopicPreference) -> void
+        def initialize: (topic: Trycourier::Users::TopicPreference) -> void
 
-        def to_hash: -> { topic: Trycourier::TopicPreference }
+        def to_hash: -> { topic: Trycourier::Users::TopicPreference }
       end
     end
   end

data/sig/trycourier/models/users/token_add_single_params.rbs

@@ -4,7 +4,7 @@ module Trycourier
       type token_add_single_params =
         { user_id: String } & Trycourier::Internal::Type::request_parameters
 
-      class TokenAddSingleParams < Trycourier::Models::UserToken
+      class TokenAddSingleParams < Trycourier::Models::Users::UserToken
         extend Trycourier::Internal::Type::RequestParameters::Converter
         include Trycourier::Internal::Type::RequestParameters
 

data/sig/trycourier/models/users/token_list_response.rbs

@@ -1,7 +1,7 @@
 module Trycourier
   module Models
     module Users
-      type token_list_response = ::Array[Trycourier::UserToken]
+      type token_list_response = ::Array[Trycourier::Users::UserToken]
 
       TokenListResponse: Trycourier::Internal::Type::Converter
     end

data/sig/trycourier/models/users/token_retrieve_response.rbs

@@ -7,7 +7,7 @@ module Trycourier
           status_reason: String?
         }
 
-      class TokenRetrieveResponse < Trycourier::Models::UserToken
+      class TokenRetrieveResponse < Trycourier::Models::Users::UserToken
         def status: -> Trycourier::Models::Users::TokenRetrieveResponse::status?
 
         def status=: (

data/sig/trycourier/models/users/topic_preference.rbs

@@ -0,0 +1,47 @@
+module Trycourier
+  module Models
+    module Users
+      type topic_preference =
+        {
+          default_status: Trycourier::Models::preference_status,
+          status: Trycourier::Models::preference_status,
+          topic_id: String,
+          topic_name: String,
+          custom_routing: ::Array[Trycourier::Models::channel_classification]?,
+          has_custom_routing: bool?
+        }
+
+      class TopicPreference < Trycourier::Internal::Type::BaseModel
+        attr_accessor default_status: Trycourier::Models::preference_status
+
+        attr_accessor status: Trycourier::Models::preference_status
+
+        attr_accessor topic_id: String
+
+        attr_accessor topic_name: String
+
+        attr_accessor custom_routing: ::Array[Trycourier::Models::channel_classification]?
+
+        attr_accessor has_custom_routing: bool?
+
+        def initialize: (
+          default_status: Trycourier::Models::preference_status,
+          status: Trycourier::Models::preference_status,
+          topic_id: String,
+          topic_name: String,
+          ?custom_routing: ::Array[Trycourier::Models::channel_classification]?,
+          ?has_custom_routing: bool?
+        ) -> void
+
+        def to_hash: -> {
+          default_status: Trycourier::Models::preference_status,
+          status: Trycourier::Models::preference_status,
+          topic_id: String,
+          topic_name: String,
+          custom_routing: ::Array[Trycourier::Models::channel_classification]?,
+          has_custom_routing: bool?
+        }
+      end
+    end
+  end
+end

data/sig/trycourier/models/users/user_token.rbs

@@ -0,0 +1,141 @@
+module Trycourier
+  module Models
+    class UserToken = Users::UserToken
+
+    module Users
+      type user_token =
+        {
+          provider_key: Trycourier::Models::Users::UserToken::provider_key,
+          token: String?,
+          device: Trycourier::Users::UserToken::Device?,
+          expiry_date: Trycourier::Models::Users::UserToken::expiry_date?,
+          properties: top,
+          tracking: Trycourier::Users::UserToken::Tracking?
+        }
+
+      class UserToken < Trycourier::Internal::Type::BaseModel
+        attr_accessor provider_key: Trycourier::Models::Users::UserToken::provider_key
+
+        attr_accessor token: String?
+
+        attr_accessor device: Trycourier::Users::UserToken::Device?
+
+        attr_accessor expiry_date: Trycourier::Models::Users::UserToken::expiry_date?
+
+        attr_reader properties: top?
+
+        def properties=: (top) -> top
+
+        attr_accessor tracking: Trycourier::Users::UserToken::Tracking?
+
+        def initialize: (
+          provider_key: Trycourier::Models::Users::UserToken::provider_key,
+          ?token: String?,
+          ?device: Trycourier::Users::UserToken::Device?,
+          ?expiry_date: Trycourier::Models::Users::UserToken::expiry_date?,
+          ?properties: top,
+          ?tracking: Trycourier::Users::UserToken::Tracking?
+        ) -> void
+
+        def to_hash: -> {
+          provider_key: Trycourier::Models::Users::UserToken::provider_key,
+          token: String?,
+          device: Trycourier::Users::UserToken::Device?,
+          expiry_date: Trycourier::Models::Users::UserToken::expiry_date?,
+          properties: top,
+          tracking: Trycourier::Users::UserToken::Tracking?
+        }
+
+        type provider_key = :"firebase-fcm" | :apn | :expo | :onesignal
+
+        module ProviderKey
+          extend Trycourier::Internal::Type::Enum
+
+          FIREBASE_FCM: :"firebase-fcm"
+          APN: :apn
+          EXPO: :expo
+          ONESIGNAL: :onesignal
+
+          def self?.values: -> ::Array[Trycourier::Models::Users::UserToken::provider_key]
+        end
+
+        type device =
+          {
+            ad_id: String?,
+            app_id: String?,
+            device_id: String?,
+            manufacturer: String?,
+            model: String?,
+            platform: String?
+          }
+
+        class Device < Trycourier::Internal::Type::BaseModel
+          attr_accessor ad_id: String?
+
+          attr_accessor app_id: String?
+
+          attr_accessor device_id: String?
+
+          attr_accessor manufacturer: String?
+
+          attr_accessor model: String?
+
+          attr_accessor platform: String?
+
+          def initialize: (
+            ?ad_id: String?,
+            ?app_id: String?,
+            ?device_id: String?,
+            ?manufacturer: String?,
+            ?model: String?,
+            ?platform: String?
+          ) -> void
+
+          def to_hash: -> {
+            ad_id: String?,
+            app_id: String?,
+            device_id: String?,
+            manufacturer: String?,
+            model: String?,
+            platform: String?
+          }
+        end
+
+        type expiry_date = String | bool
+
+        module ExpiryDate
+          extend Trycourier::Internal::Type::Union
+
+          def self?.variants: -> ::Array[Trycourier::Models::Users::UserToken::expiry_date]
+        end
+
+        type tracking =
+          { ip: String?, lat: String?, long: String?, os_version: String? }
+
+        class Tracking < Trycourier::Internal::Type::BaseModel
+          attr_accessor ip: String?
+
+          attr_accessor lat: String?
+
+          attr_accessor long: String?
+
+          attr_accessor os_version: String?
+
+          def initialize: (
+            ?ip: String?,
+            ?lat: String?,
+            ?long: String?,
+            ?os_version: String?
+          ) -> void
+
+          def to_hash: -> {
+            ip: String?,
+            lat: String?,
+            long: String?,
+            os_version: String?
+          }
+        end
+      end
+    end
+  end
+end

data/sig/trycourier/models.rbs

@@ -211,8 +211,6 @@ module Trycourier
 
   module TextStyle = Trycourier::Models::TextStyle
 
-  class TopicPreference = Trycourier::Models::TopicPreference
-
   class TranslationRetrieveParams = Trycourier::Models::TranslationRetrieveParams
 
   class TranslationUpdateParams = Trycourier::Models::TranslationUpdateParams
@@ -221,8 +219,6 @@ module Trycourier
 
   module Users = Trycourier::Models::Users
 
-  class UserToken = Trycourier::Models::UserToken
-
   class Utm = Trycourier::Models::Utm
 
   class WidgetBackground = Trycourier::Models::WidgetBackground