trycourier 4.20.0 → 4.21.0

data/lib/courier/models/inbound_bulk_message.rb

@@ -1,91 +0,0 @@
-# frozen_string_literal: true
-
-module Courier
-  module Models
-    class InboundBulkMessage < Courier::Internal::Type::BaseModel
-      # @!attribute event
-      #   Event ID or Notification ID (required). Can be either a Notification ID (e.g.,
-      #   "FRH3QXM9E34W4RKP7MRC8NZ1T8V8") or a custom Event ID (e.g., "welcome-email")
-      #   mapped to a notification.
-      #
-      #   @return [String]
-      required :event, String
-
-      # @!attribute brand
-      #
-      #   @return [String, nil]
-      optional :brand, String, nil?: true
-
-      # @!attribute content
-      #   Elemental content (optional, for V2 format). When provided, this will be used
-      #   instead of the notification associated with the `event` field.
-      #
-      #   @return [Courier::Models::ElementalContentSugar, Courier::Models::ElementalContent, nil]
-      optional :content, union: -> { Courier::InboundBulkMessage::Content }, nil?: true
-
-      # @!attribute data
-      #
-      #   @return [Hash{Symbol=>Object}, nil]
-      optional :data, Courier::Internal::Type::HashOf[Courier::Internal::Type::Unknown], nil?: true
-
-      # @!attribute locale
-      #
-      #   @return [Hash{Symbol=>Hash{Symbol=>Object}}, nil]
-      optional :locale,
-               Courier::Internal::Type::HashOf[Courier::Internal::Type::HashOf[Courier::Internal::Type::Unknown]],
-               nil?: true
-
-      # @!attribute override
-      #
-      #   @return [Hash{Symbol=>Object}, nil]
-      optional :override, Courier::Internal::Type::HashOf[Courier::Internal::Type::Unknown], nil?: true
-
-      # @!attribute template
-      #   Notification ID or template ID (optional, for V2 format). When provided, this
-      #   will be used instead of the notification associated with the `event` field.
-      #
-      #   @return [String, nil]
-      optional :template, String, nil?: true
-
-      # @!method initialize(event:, brand: nil, content: nil, data: nil, locale: nil, override: nil, template: nil)
-      #   Some parameter documentations has been truncated, see
-      #   {Courier::Models::InboundBulkMessage} for more details.
-      #
-      #   Bulk message definition. Supports two formats:
-      #
-      #   - V1 format: Requires `event` field (event ID or notification ID)
-      #   - V2 format: Optionally use `template` (notification ID) or `content` (Elemental
-      #     content) in addition to `event`
-      #
-      #   @param event [String] Event ID or Notification ID (required). Can be either a
-      #
-      #   @param brand [String, nil]
-      #
-      #   @param content [Courier::Models::ElementalContentSugar, Courier::Models::ElementalContent, nil] Elemental content (optional, for V2 format). When provided, this will be used
-      #
-      #   @param data [Hash{Symbol=>Object}, nil]
-      #
-      #   @param locale [Hash{Symbol=>Hash{Symbol=>Object}}, nil]
-      #
-      #   @param override [Hash{Symbol=>Object}, nil]
-      #
-      #   @param template [String, nil] Notification ID or template ID (optional, for V2 format). When provided,
-
-      # Elemental content (optional, for V2 format). When provided, this will be used
-      # instead of the notification associated with the `event` field.
-      #
-      # @see Courier::Models::InboundBulkMessage#content
-      module Content
-        extend Courier::Internal::Type::Union
-
-        # Syntactic sugar to provide a fast shorthand for Courier Elemental Blocks.
-        variant -> { Courier::ElementalContentSugar }
-
-        variant -> { Courier::ElementalContent }
-
-        # @!method self.variants
-        #   @return [Array(Courier::Models::ElementalContentSugar, Courier::Models::ElementalContent)]
-      end
-    end
-  end
-end

data/lib/courier/models/inbound_bulk_message_user.rb

@@ -1,54 +0,0 @@
-# frozen_string_literal: true
-
-module Courier
-  module Models
-    class InboundBulkMessageUser < Courier::Internal::Type::BaseModel
-      # @!attribute data
-      #   User-specific data that will be merged with message.data
-      #
-      #   @return [Object, nil]
-      optional :data, Courier::Internal::Type::Unknown
-
-      # @!attribute preferences
-      #
-      #   @return [Courier::Models::RecipientPreferences, nil]
-      optional :preferences, -> { Courier::RecipientPreferences }, nil?: true
-
-      # @!attribute profile
-      #   User profile information. For email-based bulk jobs, `profile.email` is required
-      #   for provider routing to determine if the message can be delivered. The email
-      #   address should be provided here rather than in `to.email`.
-      #
-      #   @return [Hash{Symbol=>Object}, nil]
-      optional :profile, Courier::Internal::Type::HashOf[Courier::Internal::Type::Unknown], nil?: true
-
-      # @!attribute recipient
-      #   User ID (legacy field, use profile or to.user_id instead)
-      #
-      #   @return [String, nil]
-      optional :recipient, String, nil?: true
-
-      # @!attribute to
-      #   Optional recipient information. Note: For email provider routing, use
-      #   `profile.email` instead of `to.email`. The `to` field is primarily used for
-      #   recipient identification and data merging.
-      #
-      #   @return [Courier::Models::UserRecipient, nil]
-      optional :to, -> { Courier::UserRecipient }, nil?: true
-
-      # @!method initialize(data: nil, preferences: nil, profile: nil, recipient: nil, to: nil)
-      #   Some parameter documentations has been truncated, see
-      #   {Courier::Models::InboundBulkMessageUser} for more details.
-      #
-      #   @param data [Object] User-specific data that will be merged with message.data
-      #
-      #   @param preferences [Courier::Models::RecipientPreferences, nil]
-      #
-      #   @param profile [Hash{Symbol=>Object}, nil] User profile information. For email-based bulk jobs, `profile.email` is required
-      #
-      #   @param recipient [String, nil] User ID (legacy field, use profile or to.user_id instead)
-      #
-      #   @param to [Courier::Models::UserRecipient, nil] Optional recipient information. Note: For email provider routing, use
-    end
-  end
-end

data/lib/courier/resources/bulk.rb

@@ -1,141 +0,0 @@
-# frozen_string_literal: true
-
-module Courier
-  module Resources
-    class Bulk
-      # Ingest user data into a Bulk Job.
-      #
-      # **Important**: For email-based bulk jobs, each user must include `profile.email`
-      # for provider routing to work correctly. The `to.email` field is not sufficient
-      # for email provider routing.
-      #
-      # @overload add_users(job_id, users:, request_options: {})
-      #
-      # @param job_id [String] A unique identifier representing the bulk job
-      #
-      # @param users [Array<Courier::Models::InboundBulkMessageUser>]
-      #
-      # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}, nil]
-      #
-      # @return [nil]
-      #
-      # @see Courier::Models::BulkAddUsersParams
-      def add_users(job_id, params)
-        parsed, options = Courier::BulkAddUsersParams.dump_request(params)
-        @client.request(
-          method: :post,
-          path: ["bulk/%1$s", job_id],
-          body: parsed,
-          model: NilClass,
-          options: options
-        )
-      end
-
-      # Some parameter documentations has been truncated, see
-      # {Courier::Models::BulkCreateJobParams} for more details.
-      #
-      # Creates a new bulk job for sending messages to multiple recipients.
-      #
-      # **Required**: `message.event` (event ID or notification ID)
-      #
-      # **Optional (V2 format)**: `message.template` (notification ID) or
-      # `message.content` (Elemental content) can be provided to override the
-      # notification associated with the event.
-      #
-      # @overload create_job(message:, request_options: {})
-      #
-      # @param message [Courier::Models::InboundBulkMessage] Bulk message definition. Supports two formats:
-      #
-      # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}, nil]
-      #
-      # @return [Courier::Models::BulkCreateJobResponse]
-      #
-      # @see Courier::Models::BulkCreateJobParams
-      def create_job(params)
-        parsed, options = Courier::BulkCreateJobParams.dump_request(params)
-        @client.request(
-          method: :post,
-          path: "bulk",
-          body: parsed,
-          model: Courier::Models::BulkCreateJobResponse,
-          options: options
-        )
-      end
-
-      # Some parameter documentations has been truncated, see
-      # {Courier::Models::BulkListUsersParams} for more details.
-      #
-      # Get Bulk Job Users
-      #
-      # @overload list_users(job_id, cursor: nil, request_options: {})
-      #
-      # @param job_id [String] A unique identifier representing the bulk job
-      #
-      # @param cursor [String, nil] A unique identifier that allows for fetching the next set of users added to the
-      #
-      # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}, nil]
-      #
-      # @return [Courier::Models::BulkListUsersResponse]
-      #
-      # @see Courier::Models::BulkListUsersParams
-      def list_users(job_id, params = {})
-        parsed, options = Courier::BulkListUsersParams.dump_request(params)
-        query = Courier::Internal::Util.encode_query_params(parsed)
-        @client.request(
-          method: :get,
-          path: ["bulk/%1$s/users", job_id],
-          query: query,
-          model: Courier::Models::BulkListUsersResponse,
-          options: options
-        )
-      end
-
-      # Get a bulk job
-      #
-      # @overload retrieve_job(job_id, request_options: {})
-      #
-      # @param job_id [String] A unique identifier representing the bulk job
-      #
-      # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}, nil]
-      #
-      # @return [Courier::Models::BulkRetrieveJobResponse]
-      #
-      # @see Courier::Models::BulkRetrieveJobParams
-      def retrieve_job(job_id, params = {})
-        @client.request(
-          method: :get,
-          path: ["bulk/%1$s", job_id],
-          model: Courier::Models::BulkRetrieveJobResponse,
-          options: params[:request_options]
-        )
-      end
-
-      # Run a bulk job
-      #
-      # @overload run_job(job_id, request_options: {})
-      #
-      # @param job_id [String] A unique identifier representing the bulk job
-      #
-      # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}, nil]
-      #
-      # @return [nil]
-      #
-      # @see Courier::Models::BulkRunJobParams
-      def run_job(job_id, params = {})
-        @client.request(
-          method: :post,
-          path: ["bulk/%1$s/run", job_id],
-          model: NilClass,
-          options: params[:request_options]
-        )
-      end
-
-      # @api private
-      #
-      # @param client [Courier::Client]
-      def initialize(client:)
-        @client = client
-      end
-    end
-  end
-end

data/rbi/courier/models/bulk_add_users_params.rbi

@@ -1,43 +0,0 @@
-# typed: strong
-
-module Courier
-  module Models
-    class BulkAddUsersParams < Courier::Internal::Type::BaseModel
-      extend Courier::Internal::Type::RequestParameters::Converter
-      include Courier::Internal::Type::RequestParameters
-
-      OrHash =
-        T.type_alias do
-          T.any(Courier::BulkAddUsersParams, Courier::Internal::AnyHash)
-        end
-
-      sig { returns(String) }
-      attr_accessor :job_id
-
-      sig { returns(T::Array[Courier::InboundBulkMessageUser]) }
-      attr_accessor :users
-
-      sig do
-        params(
-          job_id: String,
-          users: T::Array[Courier::InboundBulkMessageUser::OrHash],
-          request_options: Courier::RequestOptions::OrHash
-        ).returns(T.attached_class)
-      end
-      def self.new(job_id:, users:, request_options: {})
-      end
-
-      sig do
-        override.returns(
-          {
-            job_id: String,
-            users: T::Array[Courier::InboundBulkMessageUser],
-            request_options: Courier::RequestOptions
-          }
-        )
-      end
-      def to_hash
-      end
-    end
-  end
-end

data/rbi/courier/models/bulk_create_job_params.rbi

@@ -1,54 +0,0 @@
-# typed: strong
-
-module Courier
-  module Models
-    class BulkCreateJobParams < Courier::Internal::Type::BaseModel
-      extend Courier::Internal::Type::RequestParameters::Converter
-      include Courier::Internal::Type::RequestParameters
-
-      OrHash =
-        T.type_alias do
-          T.any(Courier::BulkCreateJobParams, Courier::Internal::AnyHash)
-        end
-
-      # Bulk message definition. Supports two formats:
-      #
-      # - V1 format: Requires `event` field (event ID or notification ID)
-      # - V2 format: Optionally use `template` (notification ID) or `content` (Elemental
-      #   content) in addition to `event`
-      sig { returns(Courier::InboundBulkMessage) }
-      attr_reader :message
-
-      sig { params(message: Courier::InboundBulkMessage::OrHash).void }
-      attr_writer :message
-
-      sig do
-        params(
-          message: Courier::InboundBulkMessage::OrHash,
-          request_options: Courier::RequestOptions::OrHash
-        ).returns(T.attached_class)
-      end
-      def self.new(
-        # Bulk message definition. Supports two formats:
-        #
-        # - V1 format: Requires `event` field (event ID or notification ID)
-        # - V2 format: Optionally use `template` (notification ID) or `content` (Elemental
-        #   content) in addition to `event`
-        message:,
-        request_options: {}
-      )
-      end
-
-      sig do
-        override.returns(
-          {
-            message: Courier::InboundBulkMessage,
-            request_options: Courier::RequestOptions
-          }
-        )
-      end
-      def to_hash
-      end
-    end
-  end
-end

data/rbi/courier/models/bulk_create_job_response.rbi

@@ -1,26 +0,0 @@
-# typed: strong
-
-module Courier
-  module Models
-    class BulkCreateJobResponse < Courier::Internal::Type::BaseModel
-      OrHash =
-        T.type_alias do
-          T.any(
-            Courier::Models::BulkCreateJobResponse,
-            Courier::Internal::AnyHash
-          )
-        end
-
-      sig { returns(String) }
-      attr_accessor :job_id
-
-      sig { params(job_id: String).returns(T.attached_class) }
-      def self.new(job_id:)
-      end
-
-      sig { override.returns({ job_id: String }) }
-      def to_hash
-      end
-    end
-  end
-end

data/rbi/courier/models/bulk_list_users_params.rbi

@@ -1,51 +0,0 @@
-# typed: strong
-
-module Courier
-  module Models
-    class BulkListUsersParams < Courier::Internal::Type::BaseModel
-      extend Courier::Internal::Type::RequestParameters::Converter
-      include Courier::Internal::Type::RequestParameters
-
-      OrHash =
-        T.type_alias do
-          T.any(Courier::BulkListUsersParams, Courier::Internal::AnyHash)
-        end
-
-      sig { returns(String) }
-      attr_accessor :job_id
-
-      # A unique identifier that allows for fetching the next set of users added to the
-      # bulk job
-      sig { returns(T.nilable(String)) }
-      attr_accessor :cursor
-
-      sig do
-        params(
-          job_id: String,
-          cursor: T.nilable(String),
-          request_options: Courier::RequestOptions::OrHash
-        ).returns(T.attached_class)
-      end
-      def self.new(
-        job_id:,
-        # A unique identifier that allows for fetching the next set of users added to the
-        # bulk job
-        cursor: nil,
-        request_options: {}
-      )
-      end
-
-      sig do
-        override.returns(
-          {
-            job_id: String,
-            cursor: T.nilable(String),
-            request_options: Courier::RequestOptions
-          }
-        )
-      end
-      def to_hash
-      end
-    end
-  end
-end

data/rbi/courier/models/bulk_list_users_response.rbi

@@ -1,125 +0,0 @@
-# typed: strong
-
-module Courier
-  module Models
-    class BulkListUsersResponse < Courier::Internal::Type::BaseModel
-      OrHash =
-        T.type_alias do
-          T.any(
-            Courier::Models::BulkListUsersResponse,
-            Courier::Internal::AnyHash
-          )
-        end
-
-      sig { returns(T::Array[Courier::Models::BulkListUsersResponse::Item]) }
-      attr_accessor :items
-
-      sig { returns(Courier::Paging) }
-      attr_reader :paging
-
-      sig { params(paging: Courier::Paging::OrHash).void }
-      attr_writer :paging
-
-      sig do
-        params(
-          items: T::Array[Courier::Models::BulkListUsersResponse::Item::OrHash],
-          paging: Courier::Paging::OrHash
-        ).returns(T.attached_class)
-      end
-      def self.new(items:, paging:)
-      end
-
-      sig do
-        override.returns(
-          {
-            items: T::Array[Courier::Models::BulkListUsersResponse::Item],
-            paging: Courier::Paging
-          }
-        )
-      end
-      def to_hash
-      end
-
-      class Item < Courier::Models::InboundBulkMessageUser
-        OrHash =
-          T.type_alias do
-            T.any(
-              Courier::Models::BulkListUsersResponse::Item,
-              Courier::Internal::AnyHash
-            )
-          end
-
-        sig do
-          returns(
-            Courier::Models::BulkListUsersResponse::Item::Status::TaggedSymbol
-          )
-        end
-        attr_accessor :status
-
-        sig { returns(T.nilable(String)) }
-        attr_accessor :message_id
-
-        sig do
-          params(
-            status:
-              Courier::Models::BulkListUsersResponse::Item::Status::OrSymbol,
-            message_id: T.nilable(String)
-          ).returns(T.attached_class)
-        end
-        def self.new(status:, message_id: nil)
-        end
-
-        sig do
-          override.returns(
-            {
-              status:
-                Courier::Models::BulkListUsersResponse::Item::Status::TaggedSymbol,
-              message_id: T.nilable(String)
-            }
-          )
-        end
-        def to_hash
-        end
-
-        module Status
-          extend Courier::Internal::Type::Enum
-
-          TaggedSymbol =
-            T.type_alias do
-              T.all(
-                Symbol,
-                Courier::Models::BulkListUsersResponse::Item::Status
-              )
-            end
-          OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-          PENDING =
-            T.let(
-              :PENDING,
-              Courier::Models::BulkListUsersResponse::Item::Status::TaggedSymbol
-            )
-          ENQUEUED =
-            T.let(
-              :ENQUEUED,
-              Courier::Models::BulkListUsersResponse::Item::Status::TaggedSymbol
-            )
-          ERROR =
-            T.let(
-              :ERROR,
-              Courier::Models::BulkListUsersResponse::Item::Status::TaggedSymbol
-            )
-
-          sig do
-            override.returns(
-              T::Array[
-                Courier::Models::BulkListUsersResponse::Item::Status::TaggedSymbol
-              ]
-            )
-          end
-          def self.values
-          end
-        end
-      end
-    end
-  end
-end

data/rbi/courier/models/bulk_retrieve_job_params.rbi

@@ -1,35 +0,0 @@
-# typed: strong
-
-module Courier
-  module Models
-    class BulkRetrieveJobParams < Courier::Internal::Type::BaseModel
-      extend Courier::Internal::Type::RequestParameters::Converter
-      include Courier::Internal::Type::RequestParameters
-
-      OrHash =
-        T.type_alias do
-          T.any(Courier::BulkRetrieveJobParams, Courier::Internal::AnyHash)
-        end
-
-      sig { returns(String) }
-      attr_accessor :job_id
-
-      sig do
-        params(
-          job_id: String,
-          request_options: Courier::RequestOptions::OrHash
-        ).returns(T.attached_class)
-      end
-      def self.new(job_id:, request_options: {})
-      end
-
-      sig do
-        override.returns(
-          { job_id: String, request_options: Courier::RequestOptions }
-        )
-      end
-      def to_hash
-      end
-    end
-  end
-end