trycourier 4.7.1 → 4.9.0

data/lib/courier/models/tenant_template_input.rb

@@ -12,15 +12,15 @@ module Courier
       # @!attribute channels
       #   Channel-specific delivery configuration (email, SMS, push, etc.)
       #
-      #   @return [Hash{Symbol=>Courier::Models::TenantTemplateInput::Channel}, nil]
-      optional :channels, -> { Courier::Internal::Type::HashOf[Courier::TenantTemplateInput::Channel] }
+      #   @return [Hash{Symbol=>Courier::Models::Channel}, nil]
+      optional :channels, -> { Courier::Internal::Type::HashOf[Courier::Channel] }
 
       # @!attribute providers
       #   Provider-specific delivery configuration for routing to specific email/SMS
       #   providers
       #
-      #   @return [Hash{Symbol=>Courier::Models::TenantTemplateInput::Provider}, nil]
-      optional :providers, -> { Courier::Internal::Type::HashOf[Courier::TenantTemplateInput::Provider] }
+      #   @return [Hash{Symbol=>Courier::Models::MessageProvidersType}, nil]
+      optional :providers, -> { Courier::Internal::Type::HashOf[Courier::MessageProvidersType] }
 
       # @!attribute routing
       #   Message routing configuration for multi-channel delivery strategies
@@ -36,157 +36,11 @@ module Courier
       #
       #   @param content [Courier::Models::ElementalContent] Template content configuration including blocks, elements, and message structure
       #
-      #   @param channels [Hash{Symbol=>Courier::Models::TenantTemplateInput::Channel}] Channel-specific delivery configuration (email, SMS, push, etc.)
+      #   @param channels [Hash{Symbol=>Courier::Models::Channel}] Channel-specific delivery configuration (email, SMS, push, etc.)
       #
-      #   @param providers [Hash{Symbol=>Courier::Models::TenantTemplateInput::Provider}] Provider-specific delivery configuration for routing to specific email/SMS provi
+      #   @param providers [Hash{Symbol=>Courier::Models::MessageProvidersType}] Provider-specific delivery configuration for routing to specific email/SMS provi
       #
       #   @param routing [Courier::Models::MessageRouting] Message routing configuration for multi-channel delivery strategies
-
-      class Channel < Courier::Internal::Type::BaseModel
-        # @!attribute brand_id
-        #   Brand id used for rendering.
-        #
-        #   @return [String, nil]
-        optional :brand_id, String, nil?: true
-
-        # @!attribute if_
-        #   JS conditional with access to data/profile.
-        #
-        #   @return [String, nil]
-        optional :if_, String, api_name: :if, nil?: true
-
-        # @!attribute metadata
-        #
-        #   @return [Courier::Models::TenantTemplateInput::Channel::Metadata, nil]
-        optional :metadata, -> { Courier::TenantTemplateInput::Channel::Metadata }, nil?: true
-
-        # @!attribute override
-        #   Channel specific overrides.
-        #
-        #   @return [Hash{Symbol=>Object}, nil]
-        optional :override, Courier::Internal::Type::HashOf[Courier::Internal::Type::Unknown], nil?: true
-
-        # @!attribute providers
-        #   Providers enabled for this channel.
-        #
-        #   @return [Array<String>, nil]
-        optional :providers, Courier::Internal::Type::ArrayOf[String], nil?: true
-
-        # @!attribute routing_method
-        #   Defaults to `single`.
-        #
-        #   @return [Symbol, Courier::Models::TenantTemplateInput::Channel::RoutingMethod, nil]
-        optional :routing_method,
-                 enum: -> {
-                   Courier::TenantTemplateInput::Channel::RoutingMethod
-                 },
-                 nil?: true
-
-        # @!attribute timeouts
-        #
-        #   @return [Courier::Models::TenantTemplateInput::Channel::Timeouts, nil]
-        optional :timeouts, -> { Courier::TenantTemplateInput::Channel::Timeouts }, nil?: true
-
-        # @!method initialize(brand_id: nil, if_: nil, metadata: nil, override: nil, providers: nil, routing_method: nil, timeouts: nil)
-        #   @param brand_id [String, nil] Brand id used for rendering.
-        #
-        #   @param if_ [String, nil] JS conditional with access to data/profile.
-        #
-        #   @param metadata [Courier::Models::TenantTemplateInput::Channel::Metadata, nil]
-        #
-        #   @param override [Hash{Symbol=>Object}, nil] Channel specific overrides.
-        #
-        #   @param providers [Array<String>, nil] Providers enabled for this channel.
-        #
-        #   @param routing_method [Symbol, Courier::Models::TenantTemplateInput::Channel::RoutingMethod, nil] Defaults to `single`.
-        #
-        #   @param timeouts [Courier::Models::TenantTemplateInput::Channel::Timeouts, nil]
-
-        # @see Courier::Models::TenantTemplateInput::Channel#metadata
-        class Metadata < Courier::Internal::Type::BaseModel
-          # @!attribute utm
-          #
-          #   @return [Courier::Models::Utm, nil]
-          optional :utm, -> { Courier::Utm }, nil?: true
-
-          # @!method initialize(utm: nil)
-          #   @param utm [Courier::Models::Utm, nil]
-        end
-
-        # Defaults to `single`.
-        #
-        # @see Courier::Models::TenantTemplateInput::Channel#routing_method
-        module RoutingMethod
-          extend Courier::Internal::Type::Enum
-
-          ALL = :all
-          SINGLE = :single
-
-          # @!method self.values
-          #   @return [Array<Symbol>]
-        end
-
-        # @see Courier::Models::TenantTemplateInput::Channel#timeouts
-        class Timeouts < Courier::Internal::Type::BaseModel
-          # @!attribute channel
-          #
-          #   @return [Integer, nil]
-          optional :channel, Integer, nil?: true
-
-          # @!attribute provider
-          #
-          #   @return [Integer, nil]
-          optional :provider, Integer, nil?: true
-
-          # @!method initialize(channel: nil, provider: nil)
-          #   @param channel [Integer, nil]
-          #   @param provider [Integer, nil]
-        end
-      end
-
-      class Provider < Courier::Internal::Type::BaseModel
-        # @!attribute if_
-        #   JS conditional with access to data/profile.
-        #
-        #   @return [String, nil]
-        optional :if_, String, api_name: :if, nil?: true
-
-        # @!attribute metadata
-        #
-        #   @return [Courier::Models::TenantTemplateInput::Provider::Metadata, nil]
-        optional :metadata, -> { Courier::TenantTemplateInput::Provider::Metadata }, nil?: true
-
-        # @!attribute override
-        #   Provider-specific overrides.
-        #
-        #   @return [Hash{Symbol=>Object}, nil]
-        optional :override, Courier::Internal::Type::HashOf[Courier::Internal::Type::Unknown], nil?: true
-
-        # @!attribute timeouts
-        #
-        #   @return [Integer, nil]
-        optional :timeouts, Integer, nil?: true
-
-        # @!method initialize(if_: nil, metadata: nil, override: nil, timeouts: nil)
-        #   @param if_ [String, nil] JS conditional with access to data/profile.
-        #
-        #   @param metadata [Courier::Models::TenantTemplateInput::Provider::Metadata, nil]
-        #
-        #   @param override [Hash{Symbol=>Object}, nil] Provider-specific overrides.
-        #
-        #   @param timeouts [Integer, nil]
-
-        # @see Courier::Models::TenantTemplateInput::Provider#metadata
-        class Metadata < Courier::Internal::Type::BaseModel
-          # @!attribute utm
-          #
-          #   @return [Courier::Models::Utm, nil]
-          optional :utm, -> { Courier::Utm }, nil?: true
-
-          # @!method initialize(utm: nil)
-          #   @param utm [Courier::Models::Utm, nil]
-        end
-      end
     end
   end
 end

data/lib/courier/models/tenant_update_params.rb

@@ -7,6 +7,11 @@ module Courier
       extend Courier::Internal::Type::RequestParameters::Converter
       include Courier::Internal::Type::RequestParameters
 
+      # @!attribute tenant_id
+      #
+      #   @return [String]
+      required :tenant_id, String
+
       # @!attribute name
       #   Name of the tenant.
       #
@@ -44,10 +49,12 @@ module Courier
       #   @return [Hash{Symbol=>Object}, nil]
       optional :user_profile, Courier::Internal::Type::HashOf[Courier::Internal::Type::Unknown], nil?: true
 
-      # @!method initialize(name:, brand_id: nil, default_preferences: nil, parent_tenant_id: nil, properties: nil, user_profile: nil, request_options: {})
+      # @!method initialize(tenant_id:, name:, brand_id: nil, default_preferences: nil, parent_tenant_id: nil, properties: nil, user_profile: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {Courier::Models::TenantUpdateParams} for more details.
       #
+      #   @param tenant_id [String]
+      #
       #   @param name [String] Name of the tenant.
       #
       #   @param brand_id [String, nil] Brand to be used for the account when one is not specified by the send call.

data/lib/courier/models/tenants/preferences/item_delete_params.rb

@@ -14,8 +14,14 @@ module Courier
           #   @return [String]
           required :tenant_id, String
 
-          # @!method initialize(tenant_id:, request_options: {})
+          # @!attribute topic_id
+          #
+          #   @return [String]
+          required :topic_id, String
+
+          # @!method initialize(tenant_id:, topic_id:, request_options: {})
           #   @param tenant_id [String]
+          #   @param topic_id [String]
           #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
         end
       end

data/lib/courier/models/tenants/preferences/item_update_params.rb

@@ -14,8 +14,14 @@ module Courier
           #   @return [String]
           required :tenant_id, String
 
-          # @!method initialize(tenant_id:, request_options: {})
+          # @!attribute topic_id
+          #
+          #   @return [String]
+          required :topic_id, String
+
+          # @!method initialize(tenant_id:, topic_id:, request_options: {})
           #   @param tenant_id [String]
+          #   @param topic_id [String]
           #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
         end
       end

data/lib/courier/models/tenants/template_list_params.rb

@@ -8,6 +8,11 @@ module Courier
         extend Courier::Internal::Type::RequestParameters::Converter
         include Courier::Internal::Type::RequestParameters
 
+        # @!attribute tenant_id
+        #
+        #   @return [String]
+        required :tenant_id, String
+
         # @!attribute cursor
         #   Continue the pagination with the next cursor
         #
@@ -20,7 +25,9 @@ module Courier
         #   @return [Integer, nil]
         optional :limit, Integer, nil?: true
 
-        # @!method initialize(cursor: nil, limit: nil, request_options: {})
+        # @!method initialize(tenant_id:, cursor: nil, limit: nil, request_options: {})
+        #   @param tenant_id [String]
+        #
         #   @param cursor [String, nil] Continue the pagination with the next cursor
         #
         #   @param limit [Integer, nil] The number of templates to return (defaults to 20, maximum value of 100)

data/lib/courier/models/tenants/template_publish_params.rb

@@ -13,8 +13,14 @@ module Courier
         #   @return [String]
         required :tenant_id, String
 
-        # @!method initialize(tenant_id:, request_options: {})
+        # @!attribute template_id
+        #
+        #   @return [String]
+        required :template_id, String
+
+        # @!method initialize(tenant_id:, template_id:, request_options: {})
         #   @param tenant_id [String]
+        #   @param template_id [String]
         #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
       end
     end

data/lib/courier/models/tenants/template_replace_params.rb

@@ -13,8 +13,14 @@ module Courier
         #   @return [String]
         required :tenant_id, String
 
-        # @!method initialize(tenant_id:, request_options: {})
+        # @!attribute template_id
+        #
+        #   @return [String]
+        required :template_id, String
+
+        # @!method initialize(tenant_id:, template_id:, request_options: {})
         #   @param tenant_id [String]
+        #   @param template_id [String]
         #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
       end
     end

data/lib/courier/models/tenants/template_retrieve_params.rb

@@ -13,8 +13,14 @@ module Courier
         #   @return [String]
         required :tenant_id, String
 
-        # @!method initialize(tenant_id:, request_options: {})
+        # @!attribute template_id
+        #
+        #   @return [String]
+        required :template_id, String
+
+        # @!method initialize(tenant_id:, template_id:, request_options: {})
         #   @param tenant_id [String]
+        #   @param template_id [String]
         #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
       end
     end

data/lib/courier/models/tenants/templates/version_retrieve_params.rb

@@ -19,9 +19,15 @@ module Courier
           #   @return [String]
           required :template_id, String
 
-          # @!method initialize(tenant_id:, template_id:, request_options: {})
+          # @!attribute version
+          #
+          #   @return [String]
+          required :version, String
+
+          # @!method initialize(tenant_id:, template_id:, version:, request_options: {})
           #   @param tenant_id [String]
           #   @param template_id [String]
+          #   @param version [String]
           #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
         end
       end

data/lib/courier/models/timeouts.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    class Timeouts < Courier::Internal::Type::BaseModel
+      # @!attribute channel
+      #
+      #   @return [Integer, nil]
+      optional :channel, Integer, nil?: true
+
+      # @!attribute provider
+      #
+      #   @return [Integer, nil]
+      optional :provider, Integer, nil?: true
+
+      # @!method initialize(channel: nil, provider: nil)
+      #   @param channel [Integer, nil]
+      #   @param provider [Integer, nil]
+    end
+  end
+end

data/lib/courier/models/translation_retrieve_params.rb

@@ -12,8 +12,14 @@ module Courier
       #   @return [String]
       required :domain, String
 
-      # @!method initialize(domain:, request_options: {})
+      # @!attribute locale
+      #
+      #   @return [String]
+      required :locale, String
+
+      # @!method initialize(domain:, locale:, request_options: {})
       #   @param domain [String]
+      #   @param locale [String]
       #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/courier/models/translation_update_params.rb

@@ -12,13 +12,19 @@ module Courier
       #   @return [String]
       required :domain, String
 
+      # @!attribute locale
+      #
+      #   @return [String]
+      required :locale, String
+
       # @!attribute body
       #
       #   @return [String]
       required :body, String
 
-      # @!method initialize(domain:, body:, request_options: {})
+      # @!method initialize(domain:, locale:, body:, request_options: {})
       #   @param domain [String]
+      #   @param locale [String]
       #   @param body [String]
       #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
     end

data/lib/courier/models/users/preference_retrieve_params.rb

@@ -8,13 +8,20 @@ module Courier
         extend Courier::Internal::Type::RequestParameters::Converter
         include Courier::Internal::Type::RequestParameters
 
+        # @!attribute user_id
+        #
+        #   @return [String]
+        required :user_id, String
+
         # @!attribute tenant_id
         #   Query the preferences of a user for this specific tenant context.
         #
         #   @return [String, nil]
         optional :tenant_id, String, nil?: true
 
-        # @!method initialize(tenant_id: nil, request_options: {})
+        # @!method initialize(user_id:, tenant_id: nil, request_options: {})
+        #   @param user_id [String]
+        #
         #   @param tenant_id [String, nil] Query the preferences of a user for this specific tenant context.
         #
         #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]

data/lib/courier/models/users/preference_retrieve_topic_params.rb

@@ -13,15 +13,22 @@ module Courier
         #   @return [String]
         required :user_id, String
 
+        # @!attribute topic_id
+        #
+        #   @return [String]
+        required :topic_id, String
+
         # @!attribute tenant_id
         #   Query the preferences of a user for this specific tenant context.
         #
         #   @return [String, nil]
         optional :tenant_id, String, nil?: true
 
-        # @!method initialize(user_id:, tenant_id: nil, request_options: {})
+        # @!method initialize(user_id:, topic_id:, tenant_id: nil, request_options: {})
         #   @param user_id [String]
         #
+        #   @param topic_id [String]
+        #
         #   @param tenant_id [String, nil] Query the preferences of a user for this specific tenant context.
         #
         #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]

data/lib/courier/models/users/preference_update_or_create_topic_params.rb

@@ -13,6 +13,11 @@ module Courier
         #   @return [String]
         required :user_id, String
 
+        # @!attribute topic_id
+        #
+        #   @return [String]
+        required :topic_id, String
+
         # @!attribute topic
         #
         #   @return [Courier::Models::Users::PreferenceUpdateOrCreateTopicParams::Topic]
@@ -24,9 +29,11 @@ module Courier
         #   @return [String, nil]
         optional :tenant_id, String, nil?: true
 
-        # @!method initialize(user_id:, topic:, tenant_id: nil, request_options: {})
+        # @!method initialize(user_id:, topic_id:, topic:, tenant_id: nil, request_options: {})
         #   @param user_id [String]
         #
+        #   @param topic_id [String]
+        #
         #   @param topic [Courier::Models::Users::PreferenceUpdateOrCreateTopicParams::Topic]
         #
         #   @param tenant_id [String, nil] Update the preferences of a user for this specific tenant context.

data/lib/courier/models/users/tenant_add_multiple_params.rb

@@ -8,12 +8,18 @@ module Courier
         extend Courier::Internal::Type::RequestParameters::Converter
         include Courier::Internal::Type::RequestParameters
 
+        # @!attribute user_id
+        #
+        #   @return [String]
+        required :user_id, String
+
         # @!attribute tenants
         #
         #   @return [Array<Courier::Models::TenantAssociation>]
         required :tenants, -> { Courier::Internal::Type::ArrayOf[Courier::TenantAssociation] }
 
-        # @!method initialize(tenants:, request_options: {})
+        # @!method initialize(user_id:, tenants:, request_options: {})
+        #   @param user_id [String]
         #   @param tenants [Array<Courier::Models::TenantAssociation>]
         #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
       end

data/lib/courier/models/users/tenant_add_single_params.rb

@@ -13,13 +13,19 @@ module Courier
         #   @return [String]
         required :user_id, String
 
+        # @!attribute tenant_id
+        #
+        #   @return [String]
+        required :tenant_id, String
+
         # @!attribute profile
         #
         #   @return [Hash{Symbol=>Object}, nil]
         optional :profile, Courier::Internal::Type::HashOf[Courier::Internal::Type::Unknown], nil?: true
 
-        # @!method initialize(user_id:, profile: nil, request_options: {})
+        # @!method initialize(user_id:, tenant_id:, profile: nil, request_options: {})
         #   @param user_id [String]
+        #   @param tenant_id [String]
         #   @param profile [Hash{Symbol=>Object}, nil]
         #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
       end

data/lib/courier/models/users/tenant_list_params.rb

@@ -8,6 +8,11 @@ module Courier
         extend Courier::Internal::Type::RequestParameters::Converter
         include Courier::Internal::Type::RequestParameters
 
+        # @!attribute user_id
+        #
+        #   @return [String]
+        required :user_id, String
+
         # @!attribute cursor
         #   Continue the pagination with the next cursor
         #
@@ -20,10 +25,12 @@ module Courier
         #   @return [Integer, nil]
         optional :limit, Integer, nil?: true
 
-        # @!method initialize(cursor: nil, limit: nil, request_options: {})
+        # @!method initialize(user_id:, cursor: nil, limit: nil, request_options: {})
         #   Some parameter documentations has been truncated, see
         #   {Courier::Models::Users::TenantListParams} for more details.
         #
+        #   @param user_id [String]
+        #
         #   @param cursor [String, nil] Continue the pagination with the next cursor
         #
         #   @param limit [Integer, nil] The number of accounts to return

data/lib/courier/models/users/tenant_remove_all_params.rb

@@ -8,7 +8,13 @@ module Courier
         extend Courier::Internal::Type::RequestParameters::Converter
         include Courier::Internal::Type::RequestParameters
 
-        # @!method initialize(request_options: {})
+        # @!attribute user_id
+        #
+        #   @return [String]
+        required :user_id, String
+
+        # @!method initialize(user_id:, request_options: {})
+        #   @param user_id [String]
         #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
       end
     end

data/lib/courier/models/users/tenant_remove_single_params.rb

@@ -13,8 +13,14 @@ module Courier
         #   @return [String]
         required :user_id, String
 
-        # @!method initialize(user_id:, request_options: {})
+        # @!attribute tenant_id
+        #
+        #   @return [String]
+        required :tenant_id, String
+
+        # @!method initialize(user_id:, tenant_id:, request_options: {})
         #   @param user_id [String]
+        #   @param tenant_id [String]
         #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
       end
     end

data/lib/courier/models/users/token_add_multiple_params.rb

@@ -8,7 +8,13 @@ module Courier
         extend Courier::Internal::Type::RequestParameters::Converter
         include Courier::Internal::Type::RequestParameters
 
-        # @!method initialize(request_options: {})
+        # @!attribute user_id
+        #
+        #   @return [String]
+        required :user_id, String
+
+        # @!method initialize(user_id:, request_options: {})
+        #   @param user_id [String]
         #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
       end
     end