trycourier 4.7.1 → 4.9.0

data/lib/courier/models/profiles/list_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 cursor
         #   A unique identifier that allows for fetching the next set of message statuses.
         #
         #   @return [String, nil]
         optional :cursor, String, nil?: true
 
-        # @!method initialize(cursor: nil, request_options: {})
+        # @!method initialize(user_id:, cursor: nil, request_options: {})
+        #   @param user_id [String]
+        #
         #   @param cursor [String, nil] A unique identifier that allows for fetching the next set of message statuses.
         #
         #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]

data/lib/courier/models/profiles/list_subscribe_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 lists
         #
         #   @return [Array<Courier::Models::SubscribeToListsRequestItem>]
         required :lists, -> { Courier::Internal::Type::ArrayOf[Courier::SubscribeToListsRequestItem] }
 
-        # @!method initialize(lists:, request_options: {})
+        # @!method initialize(user_id:, lists:, request_options: {})
+        #   @param user_id [String]
         #   @param lists [Array<Courier::Models::SubscribeToListsRequestItem>]
         #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
       end

data/lib/courier/models/provider.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    # @see Courier::Resources::Providers#create
+    class Provider < Courier::Internal::Type::BaseModel
+      # @!attribute id
+      #   A unique identifier for the provider configuration.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute created
+      #   Unix timestamp (ms) of when the provider was created.
+      #
+      #   @return [Integer]
+      required :created, Integer
+
+      # @!attribute provider
+      #   The provider key (e.g. "sendgrid", "twilio", "slack").
+      #
+      #   @return [String]
+      required :provider, String
+
+      # @!attribute settings
+      #   Provider-specific settings (snake_case keys on the wire).
+      #
+      #   @return [Hash{Symbol=>Object}]
+      required :settings, Courier::Internal::Type::HashOf[Courier::Internal::Type::Unknown]
+
+      # @!attribute title
+      #   Display title. Defaults to "Default Configuration" when not explicitly set.
+      #
+      #   @return [String]
+      required :title, String
+
+      # @!attribute alias_
+      #   Optional alias for this configuration.
+      #
+      #   @return [String, nil]
+      optional :alias_, String, api_name: :alias
+
+      # @!attribute updated
+      #   Unix timestamp (ms) of when the provider was last updated.
+      #
+      #   @return [Integer, nil]
+      optional :updated, Integer, nil?: true
+
+      # @!method initialize(id:, created:, provider:, settings:, title:, alias_: nil, updated: nil)
+      #   A configured provider in the workspace.
+      #
+      #   @param id [String] A unique identifier for the provider configuration.
+      #
+      #   @param created [Integer] Unix timestamp (ms) of when the provider was created.
+      #
+      #   @param provider [String] The provider key (e.g. "sendgrid", "twilio", "slack").
+      #
+      #   @param settings [Hash{Symbol=>Object}] Provider-specific settings (snake_case keys on the wire).
+      #
+      #   @param title [String] Display title. Defaults to "Default Configuration" when not explicitly set.
+      #
+      #   @param alias_ [String] Optional alias for this configuration.
+      #
+      #   @param updated [Integer, nil] Unix timestamp (ms) of when the provider was last updated.
+    end
+  end
+end

data/lib/courier/models/provider_create_params.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    # @see Courier::Resources::Providers#create
+    class ProviderCreateParams < Courier::Internal::Type::BaseModel
+      extend Courier::Internal::Type::RequestParameters::Converter
+      include Courier::Internal::Type::RequestParameters
+
+      # @!attribute provider
+      #   The provider key identifying the type (e.g. "sendgrid", "twilio"). Must be a
+      #   known Courier provider — see the catalog endpoint for valid keys.
+      #
+      #   @return [String]
+      required :provider, String
+
+      # @!attribute alias_
+      #   Optional alias for this configuration.
+      #
+      #   @return [String, nil]
+      optional :alias_, String, api_name: :alias
+
+      # @!attribute settings
+      #   Provider-specific settings (snake_case keys). Defaults to an empty object when
+      #   omitted. Use the catalog endpoint to discover required fields for a given
+      #   provider — omitting a required field returns a 400 validation error.
+      #
+      #   @return [Hash{Symbol=>Object}, nil]
+      optional :settings, Courier::Internal::Type::HashOf[Courier::Internal::Type::Unknown]
+
+      # @!attribute title
+      #   Optional display title. Omit to use "Default Configuration".
+      #
+      #   @return [String, nil]
+      optional :title, String
+
+      # @!method initialize(provider:, alias_: nil, settings: nil, title: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Courier::Models::ProviderCreateParams} for more details.
+      #
+      #   @param provider [String] The provider key identifying the type (e.g. "sendgrid", "twilio"). Must be a kno
+      #
+      #   @param alias_ [String] Optional alias for this configuration.
+      #
+      #   @param settings [Hash{Symbol=>Object}] Provider-specific settings (snake_case keys). Defaults to an empty object when o
+      #
+      #   @param title [String] Optional display title. Omit to use "Default Configuration".
+      #
+      #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/courier/models/provider_delete_params.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    # @see Courier::Resources::Providers#delete
+    class ProviderDeleteParams < Courier::Internal::Type::BaseModel
+      extend Courier::Internal::Type::RequestParameters::Converter
+      include Courier::Internal::Type::RequestParameters
+
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!method initialize(id:, request_options: {})
+      #   @param id [String]
+      #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/courier/models/provider_list_params.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    # @see Courier::Resources::Providers#list
+    class ProviderListParams < Courier::Internal::Type::BaseModel
+      extend Courier::Internal::Type::RequestParameters::Converter
+      include Courier::Internal::Type::RequestParameters
+
+      # @!attribute cursor
+      #   Opaque cursor for fetching the next page.
+      #
+      #   @return [String, nil]
+      optional :cursor, String
+
+      # @!method initialize(cursor: nil, request_options: {})
+      #   @param cursor [String] Opaque cursor for fetching the next page.
+      #
+      #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/courier/models/provider_list_response.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    # @see Courier::Resources::Providers#list
+    class ProviderListResponse < Courier::Internal::Type::BaseModel
+      # @!attribute paging
+      #
+      #   @return [Courier::Models::Paging]
+      required :paging, -> { Courier::Paging }
+
+      # @!attribute results
+      #
+      #   @return [Array<Courier::Models::Provider>]
+      required :results, -> { Courier::Internal::Type::ArrayOf[Courier::Provider] }
+
+      # @!method initialize(paging:, results:)
+      #   Paginated list of provider configurations.
+      #
+      #   @param paging [Courier::Models::Paging]
+      #   @param results [Array<Courier::Models::Provider>]
+    end
+  end
+end

data/lib/courier/models/provider_retrieve_params.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    # @see Courier::Resources::Providers#retrieve
+    class ProviderRetrieveParams < Courier::Internal::Type::BaseModel
+      extend Courier::Internal::Type::RequestParameters::Converter
+      include Courier::Internal::Type::RequestParameters
+
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!method initialize(id:, request_options: {})
+      #   @param id [String]
+      #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/courier/models/provider_update_params.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    # @see Courier::Resources::Providers#update
+    class ProviderUpdateParams < Courier::Internal::Type::BaseModel
+      extend Courier::Internal::Type::RequestParameters::Converter
+      include Courier::Internal::Type::RequestParameters
+
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute provider
+      #   The provider key identifying the type.
+      #
+      #   @return [String]
+      required :provider, String
+
+      # @!attribute alias_
+      #   Updated alias. Omit to clear.
+      #
+      #   @return [String, nil]
+      optional :alias_, String, api_name: :alias
+
+      # @!attribute settings
+      #   Provider-specific settings (snake_case keys). Replaces the full settings object
+      #   — omitted settings fields are removed. Use the catalog endpoint to check
+      #   required fields.
+      #
+      #   @return [Hash{Symbol=>Object}, nil]
+      optional :settings, Courier::Internal::Type::HashOf[Courier::Internal::Type::Unknown]
+
+      # @!attribute title
+      #   Updated display title.
+      #
+      #   @return [String, nil]
+      optional :title, String
+
+      # @!method initialize(id:, provider:, alias_: nil, settings: nil, title: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Courier::Models::ProviderUpdateParams} for more details.
+      #
+      #   @param id [String]
+      #
+      #   @param provider [String] The provider key identifying the type.
+      #
+      #   @param alias_ [String] Updated alias. Omit to clear.
+      #
+      #   @param settings [Hash{Symbol=>Object}] Provider-specific settings (snake_case keys). Replaces the full settings object
+      #
+      #   @param title [String] Updated display title.
+      #
+      #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/courier/models/providers/catalog_list_params.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    module Providers
+      # @see Courier::Resources::Providers::Catalog#list
+      class CatalogListParams < Courier::Internal::Type::BaseModel
+        extend Courier::Internal::Type::RequestParameters::Converter
+        include Courier::Internal::Type::RequestParameters
+
+        # @!attribute channel
+        #   Exact match (case-insensitive) against the provider channel taxonomy (e.g.
+        #   `email`, `sms`, `push`).
+        #
+        #   @return [String, nil]
+        optional :channel, String
+
+        # @!attribute keys
+        #   Comma-separated provider keys to filter by (e.g. `sendgrid,twilio`).
+        #
+        #   @return [String, nil]
+        optional :keys, String
+
+        # @!attribute name
+        #   Case-insensitive substring match against the provider display name.
+        #
+        #   @return [String, nil]
+        optional :name, String
+
+        # @!method initialize(channel: nil, keys: nil, name: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {Courier::Models::Providers::CatalogListParams} for more details.
+        #
+        #   @param channel [String] Exact match (case-insensitive) against the provider channel taxonomy (e.g. `emai
+        #
+        #   @param keys [String] Comma-separated provider keys to filter by (e.g. `sendgrid,twilio`).
+        #
+        #   @param name [String] Case-insensitive substring match against the provider display name.
+        #
+        #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/courier/models/providers/catalog_list_response.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    module Providers
+      # @see Courier::Resources::Providers::Catalog#list
+      class CatalogListResponse < Courier::Internal::Type::BaseModel
+        # @!attribute paging
+        #
+        #   @return [Courier::Models::Paging]
+        required :paging, -> { Courier::Paging }
+
+        # @!attribute results
+        #
+        #   @return [Array<Courier::Models::ProvidersCatalogEntry>]
+        required :results, -> { Courier::Internal::Type::ArrayOf[Courier::ProvidersCatalogEntry] }
+
+        # @!method initialize(paging:, results:)
+        #   Paginated list of available provider types with their configuration schemas.
+        #
+        #   @param paging [Courier::Models::Paging]
+        #   @param results [Array<Courier::Models::ProvidersCatalogEntry>]
+      end
+    end
+  end
+end

data/lib/courier/models/providers_catalog_entry.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    class ProvidersCatalogEntry < Courier::Internal::Type::BaseModel
+      # @!attribute channel
+      #   Courier taxonomy channel (e.g. email, push, sms, direct_message, inbox,
+      #   webhook).
+      #
+      #   @return [String]
+      required :channel, String
+
+      # @!attribute description
+      #   Short description of the provider.
+      #
+      #   @return [String]
+      required :description, String
+
+      # @!attribute name
+      #   Human-readable display name.
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute provider
+      #   The provider key (e.g. "sendgrid", "twilio").
+      #
+      #   @return [String]
+      required :provider, String
+
+      # @!attribute settings
+      #   Map of setting field names (snake_case) to their schema descriptors. Each
+      #   descriptor has `type` and `required`. Empty when the provider has no
+      #   configurable schema.
+      #
+      #   @return [Hash{Symbol=>Courier::Models::ProvidersCatalogEntry::Setting}]
+      required :settings, -> { Courier::Internal::Type::HashOf[Courier::ProvidersCatalogEntry::Setting] }
+
+      # @!method initialize(channel:, description:, name:, provider:, settings:)
+      #   Some parameter documentations has been truncated, see
+      #   {Courier::Models::ProvidersCatalogEntry} for more details.
+      #
+      #   A provider type from the catalog. Contains the key, display name, description,
+      #   and a `settings` object describing configuration schema fields.
+      #
+      #   @param channel [String] Courier taxonomy channel (e.g. email, push, sms, direct_message, inbox, webhook)
+      #
+      #   @param description [String] Short description of the provider.
+      #
+      #   @param name [String] Human-readable display name.
+      #
+      #   @param provider [String] The provider key (e.g. "sendgrid", "twilio").
+      #
+      #   @param settings [Hash{Symbol=>Courier::Models::ProvidersCatalogEntry::Setting}] Map of setting field names (snake_case) to their schema descriptors. Each descri
+
+      class Setting < Courier::Internal::Type::BaseModel
+        # @!attribute required
+        #   Whether this field is required when configuring the provider.
+        #
+        #   @return [Boolean]
+        required :required, Courier::Internal::Type::Boolean
+
+        # @!attribute type
+        #   The field's data type (e.g. "string", "boolean", "enum").
+        #
+        #   @return [String]
+        required :type, String
+
+        # @!attribute values
+        #   Allowed values when `type` is "enum".
+        #
+        #   @return [Array<String>, nil]
+        optional :values, Courier::Internal::Type::ArrayOf[String]
+
+        # @!method initialize(required:, type:, values: nil)
+        #   Describes a single configuration field in the provider catalog.
+        #
+        #   @param required [Boolean] Whether this field is required when configuring the provider.
+        #
+        #   @param type [String] The field's data type (e.g. "string", "boolean", "enum").
+        #
+        #   @param values [Array<String>] Allowed values when `type` is "enum".
+      end
+    end
+  end
+end

data/lib/courier/models/request_archive_params.rb

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

data/lib/courier/models/routing_strategy_archive_params.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    # @see Courier::Resources::RoutingStrategies#archive
+    class RoutingStrategyArchiveParams < Courier::Internal::Type::BaseModel
+      extend Courier::Internal::Type::RequestParameters::Converter
+      include Courier::Internal::Type::RequestParameters
+
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!method initialize(id:, request_options: {})
+      #   @param id [String]
+      #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/courier/models/routing_strategy_create_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    # @see Courier::Resources::RoutingStrategies#create
+    class RoutingStrategyCreateParams < Courier::Models::RoutingStrategyCreateRequest
+      extend Courier::Internal::Type::RequestParameters::Converter
+      include Courier::Internal::Type::RequestParameters
+
+      # @!method initialize(request_options: {})
+      #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/courier/models/routing_strategy_create_request.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    class RoutingStrategyCreateRequest < Courier::Internal::Type::BaseModel
+      # @!attribute name
+      #   Human-readable name for the routing strategy.
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute routing
+      #   Routing tree defining channel selection method and order.
+      #
+      #   @return [Courier::Models::MessageRouting]
+      required :routing, -> { Courier::MessageRouting }
+
+      # @!attribute channels
+      #   Per-channel delivery configuration. Defaults to empty if omitted.
+      #
+      #   @return [Hash{Symbol=>Courier::Models::Channel}, nil]
+      optional :channels, -> { Courier::Internal::Type::HashOf[Courier::Channel] }, nil?: true
+
+      # @!attribute description
+      #   Optional description of the routing strategy.
+      #
+      #   @return [String, nil]
+      optional :description, String, nil?: true
+
+      # @!attribute providers
+      #   Per-provider delivery configuration. Defaults to empty if omitted.
+      #
+      #   @return [Hash{Symbol=>Courier::Models::MessageProvidersType}, nil]
+      optional :providers, -> { Courier::Internal::Type::HashOf[Courier::MessageProvidersType] }, nil?: true
+
+      # @!attribute tags
+      #   Optional tags for categorization.
+      #
+      #   @return [Array<String>, nil]
+      optional :tags, Courier::Internal::Type::ArrayOf[String], nil?: true
+
+      # @!method initialize(name:, routing:, channels: nil, description: nil, providers: nil, tags: nil)
+      #   Request body for creating a routing strategy.
+      #
+      #   @param name [String] Human-readable name for the routing strategy.
+      #
+      #   @param routing [Courier::Models::MessageRouting] Routing tree defining channel selection method and order.
+      #
+      #   @param channels [Hash{Symbol=>Courier::Models::Channel}, nil] Per-channel delivery configuration. Defaults to empty if omitted.
+      #
+      #   @param description [String, nil] Optional description of the routing strategy.
+      #
+      #   @param providers [Hash{Symbol=>Courier::Models::MessageProvidersType}, nil] Per-provider delivery configuration. Defaults to empty if omitted.
+      #
+      #   @param tags [Array<String>, nil] Optional tags for categorization.
+    end
+  end
+end

data/lib/courier/models/routing_strategy_get_response.rb

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    # @see Courier::Resources::RoutingStrategies#retrieve
+    class RoutingStrategyGetResponse < Courier::Internal::Type::BaseModel
+      # @!attribute id
+      #   The routing strategy ID (rs\_ prefix).
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute channels
+      #   Per-channel delivery configuration. May be empty.
+      #
+      #   @return [Hash{Symbol=>Courier::Models::Channel}]
+      required :channels, -> { Courier::Internal::Type::HashOf[Courier::Channel] }
+
+      # @!attribute created
+      #   Epoch milliseconds when the strategy was created.
+      #
+      #   @return [Integer]
+      required :created, Integer
+
+      # @!attribute creator
+      #   User ID of the creator.
+      #
+      #   @return [String]
+      required :creator, String
+
+      # @!attribute name
+      #   Human-readable name.
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute providers
+      #   Per-provider delivery configuration. May be empty.
+      #
+      #   @return [Hash{Symbol=>Courier::Models::MessageProvidersType}]
+      required :providers, -> { Courier::Internal::Type::HashOf[Courier::MessageProvidersType] }
+
+      # @!attribute routing
+      #   Routing tree defining channel selection method and order.
+      #
+      #   @return [Courier::Models::MessageRouting]
+      required :routing, -> { Courier::MessageRouting }
+
+      # @!attribute description
+      #   Description of the routing strategy.
+      #
+      #   @return [String, nil]
+      optional :description, String, nil?: true
+
+      # @!attribute tags
+      #   Tags for categorization.
+      #
+      #   @return [Array<String>, nil]
+      optional :tags, Courier::Internal::Type::ArrayOf[String], nil?: true
+
+      # @!attribute updated
+      #   Epoch milliseconds of last update.
+      #
+      #   @return [Integer, nil]
+      optional :updated, Integer, nil?: true
+
+      # @!attribute updater
+      #   User ID of the last updater.
+      #
+      #   @return [String, nil]
+      optional :updater, String, nil?: true
+
+      # @!method initialize(id:, channels:, created:, creator:, name:, providers:, routing:, description: nil, tags: nil, updated: nil, updater: nil)
+      #   Full routing strategy entity returned by GET.
+      #
+      #   @param id [String] The routing strategy ID (rs\_ prefix).
+      #
+      #   @param channels [Hash{Symbol=>Courier::Models::Channel}] Per-channel delivery configuration. May be empty.
+      #
+      #   @param created [Integer] Epoch milliseconds when the strategy was created.
+      #
+      #   @param creator [String] User ID of the creator.
+      #
+      #   @param name [String] Human-readable name.
+      #
+      #   @param providers [Hash{Symbol=>Courier::Models::MessageProvidersType}] Per-provider delivery configuration. May be empty.
+      #
+      #   @param routing [Courier::Models::MessageRouting] Routing tree defining channel selection method and order.
+      #
+      #   @param description [String, nil] Description of the routing strategy.
+      #
+      #   @param tags [Array<String>, nil] Tags for categorization.
+      #
+      #   @param updated [Integer, nil] Epoch milliseconds of last update.
+      #
+      #   @param updater [String, nil] User ID of the last updater.
+    end
+  end
+end