trycourier 4.19.2 → 4.21.0

data/rbi/courier/resources/bulk.rbi

@@ -1,102 +0,0 @@
-# typed: strong
-
-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.
-      sig do
-        params(
-          job_id: String,
-          users: T::Array[Courier::InboundBulkMessageUser::OrHash],
-          request_options: Courier::RequestOptions::OrHash
-        ).void
-      end
-      def add_users(
-        # A unique identifier representing the bulk job
-        job_id,
-        users:,
-        request_options: {}
-      )
-      end
-
-      # 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.
-      sig do
-        params(
-          message: Courier::InboundBulkMessage::OrHash,
-          request_options: Courier::RequestOptions::OrHash
-        ).returns(Courier::Models::BulkCreateJobResponse)
-      end
-      def create_job(
-        # 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
-
-      # Get Bulk Job Users
-      sig do
-        params(
-          job_id: String,
-          cursor: T.nilable(String),
-          request_options: Courier::RequestOptions::OrHash
-        ).returns(Courier::Models::BulkListUsersResponse)
-      end
-      def list_users(
-        # A unique identifier representing the bulk job
-        job_id,
-        # A unique identifier that allows for fetching the next set of users added to the
-        # bulk job
-        cursor: nil,
-        request_options: {}
-      )
-      end
-
-      # Get a bulk job
-      sig do
-        params(
-          job_id: String,
-          request_options: Courier::RequestOptions::OrHash
-        ).returns(Courier::Models::BulkRetrieveJobResponse)
-      end
-      def retrieve_job(
-        # A unique identifier representing the bulk job
-        job_id,
-        request_options: {}
-      )
-      end
-
-      # Run a bulk job
-      sig do
-        params(
-          job_id: String,
-          request_options: Courier::RequestOptions::OrHash
-        ).void
-      end
-      def run_job(
-        # A unique identifier representing the bulk job
-        job_id,
-        request_options: {}
-      )
-      end
-
-      # @api private
-      sig { params(client: Courier::Client).returns(T.attached_class) }
-      def self.new(client:)
-      end
-    end
-  end
-end

data/sig/courier/models/bulk_add_users_params.rbs

@@ -1,28 +0,0 @@
-module Courier
-  module Models
-    type bulk_add_users_params =
-      { job_id: String, users: ::Array[Courier::InboundBulkMessageUser] }
-      & Courier::Internal::Type::request_parameters
-
-    class BulkAddUsersParams < Courier::Internal::Type::BaseModel
-      extend Courier::Internal::Type::RequestParameters::Converter
-      include Courier::Internal::Type::RequestParameters
-
-      attr_accessor job_id: String
-
-      attr_accessor users: ::Array[Courier::InboundBulkMessageUser]
-
-      def initialize: (
-        job_id: String,
-        users: ::Array[Courier::InboundBulkMessageUser],
-        ?request_options: Courier::request_opts
-      ) -> void
-
-      def to_hash: -> {
-        job_id: String,
-        users: ::Array[Courier::InboundBulkMessageUser],
-        request_options: Courier::RequestOptions
-      }
-    end
-  end
-end

data/sig/courier/models/bulk_create_job_params.rbs

@@ -1,24 +0,0 @@
-module Courier
-  module Models
-    type bulk_create_job_params =
-      { message: Courier::InboundBulkMessage }
-      & Courier::Internal::Type::request_parameters
-
-    class BulkCreateJobParams < Courier::Internal::Type::BaseModel
-      extend Courier::Internal::Type::RequestParameters::Converter
-      include Courier::Internal::Type::RequestParameters
-
-      attr_accessor message: Courier::InboundBulkMessage
-
-      def initialize: (
-        message: Courier::InboundBulkMessage,
-        ?request_options: Courier::request_opts
-      ) -> void
-
-      def to_hash: -> {
-        message: Courier::InboundBulkMessage,
-        request_options: Courier::RequestOptions
-      }
-    end
-  end
-end

data/sig/courier/models/bulk_create_job_response.rbs

@@ -1,13 +0,0 @@
-module Courier
-  module Models
-    type bulk_create_job_response = { job_id: String }
-
-    class BulkCreateJobResponse < Courier::Internal::Type::BaseModel
-      attr_accessor job_id: String
-
-      def initialize: (job_id: String) -> void
-
-      def to_hash: -> { job_id: String }
-    end
-  end
-end

data/sig/courier/models/bulk_list_users_params.rbs

@@ -1,28 +0,0 @@
-module Courier
-  module Models
-    type bulk_list_users_params =
-      { job_id: String, cursor: String? }
-      & Courier::Internal::Type::request_parameters
-
-    class BulkListUsersParams < Courier::Internal::Type::BaseModel
-      extend Courier::Internal::Type::RequestParameters::Converter
-      include Courier::Internal::Type::RequestParameters
-
-      attr_accessor job_id: String
-
-      attr_accessor cursor: String?
-
-      def initialize: (
-        job_id: String,
-        ?cursor: String?,
-        ?request_options: Courier::request_opts
-      ) -> void
-
-      def to_hash: -> {
-        job_id: String,
-        cursor: String?,
-        request_options: Courier::RequestOptions
-      }
-    end
-  end
-end

data/sig/courier/models/bulk_list_users_response.rbs

@@ -1,65 +0,0 @@
-module Courier
-  module Models
-    type bulk_list_users_response =
-      {
-        items: ::Array[Courier::Models::BulkListUsersResponse::Item],
-        paging: Courier::Paging
-      }
-
-    class BulkListUsersResponse < Courier::Internal::Type::BaseModel
-      attr_accessor items: ::Array[Courier::Models::BulkListUsersResponse::Item]
-
-      attr_accessor paging: Courier::Paging
-
-      def initialize: (
-        items: ::Array[Courier::Models::BulkListUsersResponse::Item],
-        paging: Courier::Paging
-      ) -> void
-
-      def to_hash: -> {
-        items: ::Array[Courier::Models::BulkListUsersResponse::Item],
-        paging: Courier::Paging
-      }
-
-      type item =
-        {
-          status: Courier::Models::BulkListUsersResponse::Item::status,
-          message_id: String?
-        }
-
-      class Item < Courier::Models::InboundBulkMessageUser
-        def status: -> Courier::Models::BulkListUsersResponse::Item::status
-
-        def status=: (
-          Courier::Models::BulkListUsersResponse::Item::status _
-        ) -> Courier::Models::BulkListUsersResponse::Item::status
-
-        def message_id: -> String?
-
-        def message_id=: (String? _) -> String?
-
-        def initialize: (
-          status: Courier::Models::BulkListUsersResponse::Item::status,
-          ?message_id: String?
-        ) -> void
-
-        def to_hash: -> {
-          status: Courier::Models::BulkListUsersResponse::Item::status,
-          message_id: String?
-        }
-
-        type status = :PENDING | :ENQUEUED | :ERROR
-
-        module Status
-          extend Courier::Internal::Type::Enum
-
-          PENDING: :PENDING
-          ENQUEUED: :ENQUEUED
-          ERROR: :ERROR
-
-          def self?.values: -> ::Array[Courier::Models::BulkListUsersResponse::Item::status]
-        end
-      end
-    end
-  end
-end

data/sig/courier/models/bulk_retrieve_job_params.rbs

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

data/sig/courier/models/bulk_retrieve_job_response.rbs

@@ -1,66 +0,0 @@
-module Courier
-  module Models
-    type bulk_retrieve_job_response =
-      { job: Courier::Models::BulkRetrieveJobResponse::Job }
-
-    class BulkRetrieveJobResponse < Courier::Internal::Type::BaseModel
-      attr_accessor job: Courier::Models::BulkRetrieveJobResponse::Job
-
-      def initialize: (
-        job: Courier::Models::BulkRetrieveJobResponse::Job
-      ) -> void
-
-      def to_hash: -> { job: Courier::Models::BulkRetrieveJobResponse::Job }
-
-      type job =
-        {
-          definition: Courier::InboundBulkMessage,
-          enqueued: Integer,
-          failures: Integer,
-          received: Integer,
-          status: Courier::Models::BulkRetrieveJobResponse::Job::status
-        }
-
-      class Job < Courier::Internal::Type::BaseModel
-        attr_accessor definition: Courier::InboundBulkMessage
-
-        attr_accessor enqueued: Integer
-
-        attr_accessor failures: Integer
-
-        attr_accessor received: Integer
-
-        attr_accessor status: Courier::Models::BulkRetrieveJobResponse::Job::status
-
-        def initialize: (
-          definition: Courier::InboundBulkMessage,
-          enqueued: Integer,
-          failures: Integer,
-          received: Integer,
-          status: Courier::Models::BulkRetrieveJobResponse::Job::status
-        ) -> void
-
-        def to_hash: -> {
-          definition: Courier::InboundBulkMessage,
-          enqueued: Integer,
-          failures: Integer,
-          received: Integer,
-          status: Courier::Models::BulkRetrieveJobResponse::Job::status
-        }
-
-        type status = :CREATED | :PROCESSING | :COMPLETED | :ERROR
-
-        module Status
-          extend Courier::Internal::Type::Enum
-
-          CREATED: :CREATED
-          PROCESSING: :PROCESSING
-          COMPLETED: :COMPLETED
-          ERROR: :ERROR
-
-          def self?.values: -> ::Array[Courier::Models::BulkRetrieveJobResponse::Job::status]
-        end
-      end
-    end
-  end
-end

data/sig/courier/models/bulk_run_job_params.rbs

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

data/sig/courier/models/inbound_bulk_message.rbs

@@ -1,58 +0,0 @@
-module Courier
-  module Models
-    type inbound_bulk_message =
-      {
-        event: String,
-        brand: String?,
-        content: Courier::Models::InboundBulkMessage::content?,
-        data: ::Hash[Symbol, top]?,
-        locale: ::Hash[Symbol, ::Hash[Symbol, top]]?,
-        override: ::Hash[Symbol, top]?,
-        template: String?
-      }
-
-    class InboundBulkMessage < Courier::Internal::Type::BaseModel
-      attr_accessor event: String
-
-      attr_accessor brand: String?
-
-      attr_accessor content: Courier::Models::InboundBulkMessage::content?
-
-      attr_accessor data: ::Hash[Symbol, top]?
-
-      attr_accessor locale: ::Hash[Symbol, ::Hash[Symbol, top]]?
-
-      attr_accessor override: ::Hash[Symbol, top]?
-
-      attr_accessor template: String?
-
-      def initialize: (
-        event: String,
-        ?brand: String?,
-        ?content: Courier::Models::InboundBulkMessage::content?,
-        ?data: ::Hash[Symbol, top]?,
-        ?locale: ::Hash[Symbol, ::Hash[Symbol, top]]?,
-        ?override: ::Hash[Symbol, top]?,
-        ?template: String?
-      ) -> void
-
-      def to_hash: -> {
-        event: String,
-        brand: String?,
-        content: Courier::Models::InboundBulkMessage::content?,
-        data: ::Hash[Symbol, top]?,
-        locale: ::Hash[Symbol, ::Hash[Symbol, top]]?,
-        override: ::Hash[Symbol, top]?,
-        template: String?
-      }
-
-      type content = Courier::ElementalContentSugar | Courier::ElementalContent
-
-      module Content
-        extend Courier::Internal::Type::Union
-
-        def self?.variants: -> ::Array[Courier::Models::InboundBulkMessage::content]
-      end
-    end
-  end
-end

data/sig/courier/models/inbound_bulk_message_user.rbs

@@ -1,42 +0,0 @@
-module Courier
-  module Models
-    type inbound_bulk_message_user =
-      {
-        data: top,
-        preferences: Courier::RecipientPreferences?,
-        profile: ::Hash[Symbol, top]?,
-        recipient: String?,
-        to: Courier::UserRecipient?
-      }
-
-    class InboundBulkMessageUser < Courier::Internal::Type::BaseModel
-      attr_reader data: top?
-
-      def data=: (top) -> top
-
-      attr_accessor preferences: Courier::RecipientPreferences?
-
-      attr_accessor profile: ::Hash[Symbol, top]?
-
-      attr_accessor recipient: String?
-
-      attr_accessor to: Courier::UserRecipient?
-
-      def initialize: (
-        ?data: top,
-        ?preferences: Courier::RecipientPreferences?,
-        ?profile: ::Hash[Symbol, top]?,
-        ?recipient: String?,
-        ?to: Courier::UserRecipient?
-      ) -> void
-
-      def to_hash: -> {
-        data: top,
-        preferences: Courier::RecipientPreferences?,
-        profile: ::Hash[Symbol, top]?,
-        recipient: String?,
-        to: Courier::UserRecipient?
-      }
-    end
-  end
-end

data/sig/courier/resources/bulk.rbs

@@ -1,34 +0,0 @@
-module Courier
-  module Resources
-    class Bulk
-      def add_users: (
-        String job_id,
-        users: ::Array[Courier::InboundBulkMessageUser],
-        ?request_options: Courier::request_opts
-      ) -> nil
-
-      def create_job: (
-        message: Courier::InboundBulkMessage,
-        ?request_options: Courier::request_opts
-      ) -> Courier::Models::BulkCreateJobResponse
-
-      def list_users: (
-        String job_id,
-        ?cursor: String?,
-        ?request_options: Courier::request_opts
-      ) -> Courier::Models::BulkListUsersResponse
-
-      def retrieve_job: (
-        String job_id,
-        ?request_options: Courier::request_opts
-      ) -> Courier::Models::BulkRetrieveJobResponse
-
-      def run_job: (
-        String job_id,
-        ?request_options: Courier::request_opts
-      ) -> nil
-
-      def initialize: (client: Courier::Client) -> void
-    end
-  end
-end