trycourier 4.7.0 → 4.8.0

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

data/rbi/courier/models/users/token_retrieve_params.rbi

@@ -18,18 +18,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_update_params.rbi

@@ -15,23 +15,28 @@ module Courier
         sig { returns(String) }
         attr_accessor :user_id
 
+        sig { returns(String) }
+        attr_accessor :token
+
         sig { returns(T::Array[Courier::Users::TokenUpdateParams::Patch]) }
         attr_accessor :patch
 
         sig do
           params(
             user_id: String,
+            token: String,
             patch: T::Array[Courier::Users::TokenUpdateParams::Patch::OrHash],
             request_options: Courier::RequestOptions::OrHash
           ).returns(T.attached_class)
         end
-        def self.new(user_id:, patch:, request_options: {})
+        def self.new(user_id:, token:, patch:, request_options: {})
         end
 
         sig do
           override.returns(
             {
               user_id: String,
+              token: String,
               patch: T::Array[Courier::Users::TokenUpdateParams::Patch],
               request_options: Courier::RequestOptions
             }

data/rbi/courier/models.rbi

@@ -142,6 +142,18 @@ module Courier
 
   IntercomRecipient = Courier::Models::IntercomRecipient
 
+  Journey = Courier::Models::Journey
+
+  JourneyInvokeParams = Courier::Models::JourneyInvokeParams
+
+  JourneyListParams = Courier::Models::JourneyListParams
+
+  JourneysInvokeRequest = Courier::Models::JourneysInvokeRequest
+
+  JourneysInvokeResponse = Courier::Models::JourneysInvokeResponse
+
+  JourneysListResponse = Courier::Models::JourneysListResponse
+
   ListDeleteParams = Courier::Models::ListDeleteParams
 
   ListFilter = Courier::Models::ListFilter

data/rbi/courier/resources/journeys.rbi

@@ -0,0 +1,64 @@
+# typed: strong
+
+module Courier
+  module Resources
+    class Journeys
+      # Get the list of journeys.
+      sig do
+        params(
+          cursor: String,
+          version: Courier::JourneyListParams::Version::OrSymbol,
+          request_options: Courier::RequestOptions::OrHash
+        ).returns(Courier::JourneysListResponse)
+      end
+      def list(
+        # A cursor token for pagination. Use the cursor from the previous response to
+        # fetch the next page of results.
+        cursor: nil,
+        # The version of journeys to retrieve. Accepted values are published (for
+        # published journeys) or draft (for draft journeys). Defaults to published.
+        version: nil,
+        request_options: {}
+      )
+      end
+
+      # Invoke a journey run from a journey template.
+      sig do
+        params(
+          template_id: String,
+          data: T::Hash[Symbol, T.anything],
+          profile: T::Hash[Symbol, T.anything],
+          user_id: String,
+          request_options: Courier::RequestOptions::OrHash
+        ).returns(Courier::JourneysInvokeResponse)
+      end
+      def invoke(
+        # A unique identifier representing the journey template to be invoked. This could
+        # be the Journey Template ID or the Journey Template Alias.
+        template_id,
+        # Data payload passed to the journey. The expected shape can be predefined using
+        # the schema builder in the journey editor. This data is available in journey
+        # steps for condition evaluation and template variable interpolation. Can also
+        # contain user identifiers (user_id, userId, anonymousId) if not provided
+        # elsewhere.
+        data: nil,
+        # Profile data for the user. Can contain contact information (email,
+        # phone_number), user identifiers (user_id, userId, anonymousId), or any custom
+        # profile fields. Profile fields are merged with any existing stored profile for
+        # the user. Include context.tenant_id to load a tenant-scoped profile for
+        # multi-tenant scenarios.
+        profile: nil,
+        # A unique identifier for the user. If not provided, the system will attempt to
+        # resolve the user identifier from profile or data objects.
+        user_id: nil,
+        request_options: {}
+      )
+      end
+
+      # @api private
+      sig { params(client: Courier::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/courier/resources/users/tokens.rbi

@@ -89,25 +89,27 @@ module Courier
         # Adds a single token to a user and overwrites a matching existing token.
         sig do
           params(
-            path_token: String,
+            token: String,
             user_id: String,
-            body_token: String,
-            provider_key: Courier::Users::UserToken::ProviderKey::OrSymbol,
-            device: T.nilable(Courier::Users::UserToken::Device::OrHash),
+            provider_key:
+              Courier::Users::TokenAddSingleParams::ProviderKey::OrSymbol,
+            device:
+              T.nilable(Courier::Users::TokenAddSingleParams::Device::OrHash),
             expiry_date:
-              T.nilable(Courier::Users::UserToken::ExpiryDate::Variants),
+              T.nilable(
+                Courier::Users::TokenAddSingleParams::ExpiryDate::Variants
+              ),
             properties: T.anything,
-            tracking: T.nilable(Courier::Users::UserToken::Tracking::OrHash),
+            tracking:
+              T.nilable(Courier::Users::TokenAddSingleParams::Tracking::OrHash),
             request_options: Courier::RequestOptions::OrHash
           ).void
         end
         def add_single(
           # Path param: The full token string.
-          path_token,
+          token,
           # Path param: The user's ID. This can be any uniquely identifiable string.
           user_id:,
-          # Body param: Full body of the token. Must match token in URL path parameter.
-          body_token:,
           # Body param
           provider_key:,
           # Body param: Information about the device the token came from.

data/sig/courier/client.rbs

@@ -20,6 +20,8 @@ module Courier
 
     attr_reader automations: Courier::Resources::Automations
 
+    attr_reader journeys: Courier::Resources::Journeys
+
     attr_reader brands: Courier::Resources::Brands
 
     attr_reader bulk: Courier::Resources::Bulk

data/sig/courier/internal/util.rbs

@@ -106,6 +106,16 @@ module Courier
       JSON_CONTENT: Regexp
       JSONL_CONTENT: Regexp
 
+      def encode_query_params: (
+        ::Hash[Symbol, top] query
+      ) -> ::Hash[Symbol, top]
+
+      private def write_query_param_element!: (
+        ::Hash[Symbol, top] collection,
+        String key,
+        top element
+      ) -> nil
+
       def self?.write_multipart_content: (
         Enumerator::Yielder y,
         val: top,

data/sig/courier/models/audience_delete_params.rbs

@@ -1,15 +1,23 @@
 module Courier
   module Models
     type audience_delete_params =
-      {  } & Courier::Internal::Type::request_parameters
+      { audience_id: String } & Courier::Internal::Type::request_parameters
 
     class AudienceDeleteParams < Courier::Internal::Type::BaseModel
       extend Courier::Internal::Type::RequestParameters::Converter
       include Courier::Internal::Type::RequestParameters
 
-      def initialize: (?request_options: Courier::request_opts) -> void
+      attr_accessor audience_id: String
 
-      def to_hash: -> { request_options: Courier::RequestOptions }
+      def initialize: (
+        audience_id: String,
+        ?request_options: Courier::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        audience_id: String,
+        request_options: Courier::RequestOptions
+      }
     end
   end
 end

data/sig/courier/models/audience_list_members_params.rbs

@@ -1,20 +1,25 @@
 module Courier
   module Models
     type audience_list_members_params =
-      { cursor: String? } & Courier::Internal::Type::request_parameters
+      { audience_id: String, cursor: String? }
+      & Courier::Internal::Type::request_parameters
 
     class AudienceListMembersParams < Courier::Internal::Type::BaseModel
       extend Courier::Internal::Type::RequestParameters::Converter
       include Courier::Internal::Type::RequestParameters
 
+      attr_accessor audience_id: String
+
       attr_accessor cursor: String?
 
       def initialize: (
+        audience_id: String,
         ?cursor: String?,
         ?request_options: Courier::request_opts
       ) -> void
 
       def to_hash: -> {
+        audience_id: String,
         cursor: String?,
         request_options: Courier::RequestOptions
       }

data/sig/courier/models/audience_retrieve_params.rbs

@@ -1,15 +1,23 @@
 module Courier
   module Models
     type audience_retrieve_params =
-      {  } & Courier::Internal::Type::request_parameters
+      { audience_id: String } & Courier::Internal::Type::request_parameters
 
     class AudienceRetrieveParams < Courier::Internal::Type::BaseModel
       extend Courier::Internal::Type::RequestParameters::Converter
       include Courier::Internal::Type::RequestParameters
 
-      def initialize: (?request_options: Courier::request_opts) -> void
+      attr_accessor audience_id: String
 
-      def to_hash: -> { request_options: Courier::RequestOptions }
+      def initialize: (
+        audience_id: String,
+        ?request_options: Courier::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        audience_id: String,
+        request_options: Courier::RequestOptions
+      }
     end
   end
 end