trycourier 4.7.1 → 4.9.0

data/rbi/courier/models/translation_update_params.rbi

@@ -14,23 +14,28 @@ module Courier
       sig { returns(String) }
       attr_accessor :domain
 
+      sig { returns(String) }
+      attr_accessor :locale
+
       sig { returns(String) }
       attr_accessor :body
 
       sig do
         params(
           domain: String,
+          locale: String,
           body: String,
           request_options: Courier::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
-      def self.new(domain:, body:, request_options: {})
+      def self.new(domain:, locale:, body:, request_options: {})
       end
 
       sig do
         override.returns(
           {
             domain: String,
+            locale: String,
             body: String,
             request_options: Courier::RequestOptions
           }

data/rbi/courier/models/users/preference_retrieve_params.rbi

@@ -15,17 +15,22 @@ module Courier
             )
           end
 
+        sig { returns(String) }
+        attr_accessor :user_id
+
         # Query the preferences of a user for this specific tenant context.
         sig { returns(T.nilable(String)) }
         attr_accessor :tenant_id
 
         sig do
           params(
+            user_id: String,
             tenant_id: T.nilable(String),
             request_options: Courier::RequestOptions::OrHash
           ).returns(T.attached_class)
         end
         def self.new(
+          user_id:,
           # Query the preferences of a user for this specific tenant context.
           tenant_id: nil,
           request_options: {}
@@ -35,6 +40,7 @@ module Courier
         sig do
           override.returns(
             {
+              user_id: String,
               tenant_id: T.nilable(String),
               request_options: Courier::RequestOptions
             }

data/rbi/courier/models/users/preference_retrieve_topic_params.rbi

@@ -18,6 +18,9 @@ module Courier
         sig { returns(String) }
         attr_accessor :user_id
 
+        sig { returns(String) }
+        attr_accessor :topic_id
+
         # Query the preferences of a user for this specific tenant context.
         sig { returns(T.nilable(String)) }
         attr_accessor :tenant_id
@@ -25,12 +28,14 @@ module Courier
         sig do
           params(
             user_id: String,
+            topic_id: String,
             tenant_id: T.nilable(String),
             request_options: Courier::RequestOptions::OrHash
           ).returns(T.attached_class)
         end
         def self.new(
           user_id:,
+          topic_id:,
           # Query the preferences of a user for this specific tenant context.
           tenant_id: nil,
           request_options: {}
@@ -41,6 +46,7 @@ module Courier
           override.returns(
             {
               user_id: String,
+              topic_id: String,
               tenant_id: T.nilable(String),
               request_options: Courier::RequestOptions
             }

data/rbi/courier/models/users/preference_update_or_create_topic_params.rbi

@@ -18,6 +18,9 @@ module Courier
         sig { returns(String) }
         attr_accessor :user_id
 
+        sig { returns(String) }
+        attr_accessor :topic_id
+
         sig do
           returns(Courier::Users::PreferenceUpdateOrCreateTopicParams::Topic)
         end
@@ -38,6 +41,7 @@ module Courier
         sig do
           params(
             user_id: String,
+            topic_id: String,
             topic:
               Courier::Users::PreferenceUpdateOrCreateTopicParams::Topic::OrHash,
             tenant_id: T.nilable(String),
@@ -46,6 +50,7 @@ module Courier
         end
         def self.new(
           user_id:,
+          topic_id:,
           topic:,
           # Update the preferences of a user for this specific tenant context.
           tenant_id: nil,
@@ -57,6 +62,7 @@ module Courier
           override.returns(
             {
               user_id: String,
+              topic_id: String,
               topic: Courier::Users::PreferenceUpdateOrCreateTopicParams::Topic,
               tenant_id: T.nilable(String),
               request_options: Courier::RequestOptions

data/rbi/courier/models/users/tenant_add_multiple_params.rbi

@@ -15,21 +15,26 @@ module Courier
             )
           end
 
+        sig { returns(String) }
+        attr_accessor :user_id
+
         sig { returns(T::Array[Courier::TenantAssociation]) }
         attr_accessor :tenants
 
         sig do
           params(
+            user_id: String,
             tenants: T::Array[Courier::TenantAssociation::OrHash],
             request_options: Courier::RequestOptions::OrHash
           ).returns(T.attached_class)
         end
-        def self.new(tenants:, request_options: {})
+        def self.new(user_id:, tenants:, request_options: {})
         end
 
         sig do
           override.returns(
             {
+              user_id: String,
               tenants: T::Array[Courier::TenantAssociation],
               request_options: Courier::RequestOptions
             }

data/rbi/courier/models/users/tenant_add_single_params.rbi

@@ -18,23 +18,28 @@ module Courier
         sig { returns(String) }
         attr_accessor :user_id
 
+        sig { returns(String) }
+        attr_accessor :tenant_id
+
         sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
         attr_accessor :profile
 
         sig do
           params(
             user_id: String,
+            tenant_id: String,
             profile: T.nilable(T::Hash[Symbol, T.anything]),
             request_options: Courier::RequestOptions::OrHash
           ).returns(T.attached_class)
         end
-        def self.new(user_id:, profile: nil, request_options: {})
+        def self.new(user_id:, tenant_id:, profile: nil, request_options: {})
         end
 
         sig do
           override.returns(
             {
               user_id: String,
+              tenant_id: String,
               profile: T.nilable(T::Hash[Symbol, T.anything]),
               request_options: Courier::RequestOptions
             }

data/rbi/courier/models/users/tenant_list_params.rbi

@@ -12,6 +12,9 @@ module Courier
             T.any(Courier::Users::TenantListParams, Courier::Internal::AnyHash)
           end
 
+        sig { returns(String) }
+        attr_accessor :user_id
+
         # Continue the pagination with the next cursor
         sig { returns(T.nilable(String)) }
         attr_accessor :cursor
@@ -22,12 +25,14 @@ module Courier
 
         sig do
           params(
+            user_id: String,
             cursor: T.nilable(String),
             limit: T.nilable(Integer),
             request_options: Courier::RequestOptions::OrHash
           ).returns(T.attached_class)
         end
         def self.new(
+          user_id:,
           # Continue the pagination with the next cursor
           cursor: nil,
           # The number of accounts to return (defaults to 20, maximum value of 100)
@@ -39,6 +44,7 @@ module Courier
         sig do
           override.returns(
             {
+              user_id: String,
               cursor: T.nilable(String),
               limit: T.nilable(Integer),
               request_options: Courier::RequestOptions

data/rbi/courier/models/users/tenant_remove_all_params.rbi

@@ -15,15 +15,23 @@ module Courier
             )
           end
 
+        sig { returns(String) }
+        attr_accessor :user_id
+
         sig do
-          params(request_options: Courier::RequestOptions::OrHash).returns(
-            T.attached_class
-          )
+          params(
+            user_id: String,
+            request_options: Courier::RequestOptions::OrHash
+          ).returns(T.attached_class)
         end
-        def self.new(request_options: {})
+        def self.new(user_id:, request_options: {})
         end
 
-        sig { override.returns({ request_options: Courier::RequestOptions }) }
+        sig do
+          override.returns(
+            { user_id: String, request_options: Courier::RequestOptions }
+          )
+        end
         def to_hash
         end
       end

data/rbi/courier/models/users/tenant_remove_single_params.rbi

@@ -18,18 +18,26 @@ module Courier
         sig { returns(String) }
         attr_accessor :user_id
 
+        sig { returns(String) }
+        attr_accessor :tenant_id
+
         sig do
           params(
             user_id: String,
+            tenant_id: String,
             request_options: Courier::RequestOptions::OrHash
           ).returns(T.attached_class)
         end
-        def self.new(user_id:, request_options: {})
+        def self.new(user_id:, tenant_id:, request_options: {})
         end
 
         sig do
           override.returns(
-            { user_id: String, request_options: Courier::RequestOptions }
+            {
+              user_id: String,
+              tenant_id: String,
+              request_options: Courier::RequestOptions
+            }
           )
         end
         def to_hash

data/rbi/courier/models/users/token_add_multiple_params.rbi

@@ -15,15 +15,23 @@ module Courier
             )
           end
 
+        sig { returns(String) }
+        attr_accessor :user_id
+
         sig do
-          params(request_options: Courier::RequestOptions::OrHash).returns(
-            T.attached_class
-          )
+          params(
+            user_id: String,
+            request_options: Courier::RequestOptions::OrHash
+          ).returns(T.attached_class)
         end
-        def self.new(request_options: {})
+        def self.new(user_id:, request_options: {})
         end
 
-        sig { override.returns({ request_options: Courier::RequestOptions }) }
+        sig do
+          override.returns(
+            { user_id: String, request_options: Courier::RequestOptions }
+          )
+        end
         def to_hash
         end
       end

data/rbi/courier/models/users/token_add_single_params.rbi

@@ -3,7 +3,7 @@
 module Courier
   module Models
     module Users
-      class TokenAddSingleParams < Courier::Models::Users::UserToken
+      class TokenAddSingleParams < Courier::Internal::Type::BaseModel
         extend Courier::Internal::Type::RequestParameters::Converter
         include Courier::Internal::Type::RequestParameters
 
@@ -18,22 +18,309 @@ module Courier
         sig { returns(String) }
         attr_accessor :user_id
 
+        sig { returns(String) }
+        attr_accessor :token
+
+        sig do
+          returns(Courier::Users::TokenAddSingleParams::ProviderKey::OrSymbol)
+        end
+        attr_accessor :provider_key
+
+        # Information about the device the token came from.
+        sig { returns(T.nilable(Courier::Users::TokenAddSingleParams::Device)) }
+        attr_reader :device
+
+        sig do
+          params(
+            device:
+              T.nilable(Courier::Users::TokenAddSingleParams::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(
+              Courier::Users::TokenAddSingleParams::ExpiryDate::Variants
+            )
+          )
+        end
+        attr_accessor :expiry_date
+
+        # Properties about the token.
+        sig { returns(T.nilable(T.anything)) }
+        attr_reader :properties
+
+        sig { params(properties: T.anything).void }
+        attr_writer :properties
+
+        # Tracking information about the device the token came from.
+        sig do
+          returns(T.nilable(Courier::Users::TokenAddSingleParams::Tracking))
+        end
+        attr_reader :tracking
+
+        sig do
+          params(
+            tracking:
+              T.nilable(Courier::Users::TokenAddSingleParams::Tracking::OrHash)
+          ).void
+        end
+        attr_writer :tracking
+
         sig do
           params(
             user_id: String,
+            token: String,
+            provider_key:
+              Courier::Users::TokenAddSingleParams::ProviderKey::OrSymbol,
+            device:
+              T.nilable(Courier::Users::TokenAddSingleParams::Device::OrHash),
+            expiry_date:
+              T.nilable(
+                Courier::Users::TokenAddSingleParams::ExpiryDate::Variants
+              ),
+            properties: T.anything,
+            tracking:
+              T.nilable(Courier::Users::TokenAddSingleParams::Tracking::OrHash),
             request_options: Courier::RequestOptions::OrHash
           ).returns(T.attached_class)
         end
-        def self.new(user_id:, request_options: {})
+        def self.new(
+          user_id:,
+          token:,
+          provider_key:,
+          # Information about the device the token came from.
+          device: nil,
+          # ISO 8601 formatted date the token expires. Defaults to 2 months. Set to false to
+          # disable expiration.
+          expiry_date: nil,
+          # Properties about the token.
+          properties: nil,
+          # Tracking information about the device the token came from.
+          tracking: nil,
+          request_options: {}
+        )
         end
 
         sig do
           override.returns(
-            { user_id: String, request_options: Courier::RequestOptions }
+            {
+              user_id: String,
+              token: String,
+              provider_key:
+                Courier::Users::TokenAddSingleParams::ProviderKey::OrSymbol,
+              device: T.nilable(Courier::Users::TokenAddSingleParams::Device),
+              expiry_date:
+                T.nilable(
+                  Courier::Users::TokenAddSingleParams::ExpiryDate::Variants
+                ),
+              properties: T.anything,
+              tracking:
+                T.nilable(Courier::Users::TokenAddSingleParams::Tracking),
+              request_options: Courier::RequestOptions
+            }
           )
         end
         def to_hash
         end
+
+        module ProviderKey
+          extend Courier::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, Courier::Users::TokenAddSingleParams::ProviderKey)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          FIREBASE_FCM =
+            T.let(
+              :"firebase-fcm",
+              Courier::Users::TokenAddSingleParams::ProviderKey::TaggedSymbol
+            )
+          APN =
+            T.let(
+              :apn,
+              Courier::Users::TokenAddSingleParams::ProviderKey::TaggedSymbol
+            )
+          EXPO =
+            T.let(
+              :expo,
+              Courier::Users::TokenAddSingleParams::ProviderKey::TaggedSymbol
+            )
+          ONESIGNAL =
+            T.let(
+              :onesignal,
+              Courier::Users::TokenAddSingleParams::ProviderKey::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Courier::Users::TokenAddSingleParams::ProviderKey::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+
+        class Device < Courier::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Courier::Users::TokenAddSingleParams::Device,
+                Courier::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 came from.
+          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 Courier::Internal::Type::Union
+
+          Variants = T.type_alias { T.any(String, T::Boolean) }
+
+          sig do
+            override.returns(
+              T::Array[
+                Courier::Users::TokenAddSingleParams::ExpiryDate::Variants
+              ]
+            )
+          end
+          def self.variants
+          end
+        end
+
+        class Tracking < Courier::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Courier::Users::TokenAddSingleParams::Tracking,
+                Courier::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
+
+          # Tracking information about the device the token came from.
+          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

data/rbi/courier/models/users/token_delete_params.rbi

@@ -15,18 +15,26 @@ module Courier
         sig { returns(String) }
         attr_accessor :user_id
 
+        sig { returns(String) }
+        attr_accessor :token
+
         sig do
           params(
             user_id: String,
+            token: String,
             request_options: Courier::RequestOptions::OrHash
           ).returns(T.attached_class)
         end
-        def self.new(user_id:, request_options: {})
+        def self.new(user_id:, token:, request_options: {})
         end
 
         sig do
           override.returns(
-            { user_id: String, request_options: Courier::RequestOptions }
+            {
+              user_id: String,
+              token: String,
+              request_options: Courier::RequestOptions
+            }
           )
         end
         def to_hash

data/rbi/courier/models/users/token_list_params.rbi

@@ -12,15 +12,23 @@ module Courier
             T.any(Courier::Users::TokenListParams, Courier::Internal::AnyHash)
           end
 
+        sig { returns(String) }
+        attr_accessor :user_id
+
         sig do
-          params(request_options: Courier::RequestOptions::OrHash).returns(
-            T.attached_class
-          )
+          params(
+            user_id: String,
+            request_options: Courier::RequestOptions::OrHash
+          ).returns(T.attached_class)
         end
-        def self.new(request_options: {})
+        def self.new(user_id:, request_options: {})
         end
 
-        sig { override.returns({ request_options: Courier::RequestOptions }) }
+        sig do
+          override.returns(
+            { user_id: String, request_options: Courier::RequestOptions }
+          )
+        end
         def to_hash
         end
       end