trycourier 3.1.3 → 3.4.0.pre.alpha0

data/rbi/trycourier/models/message_content_response.rbi

@@ -0,0 +1,226 @@
+# typed: strong
+
+module Trycourier
+  module Models
+    class MessageContentResponse < Trycourier::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Trycourier::Models::MessageContentResponse,
+            Trycourier::Internal::AnyHash
+          )
+        end
+
+      # An array of render output of a previously sent message.
+      sig do
+        returns(T::Array[Trycourier::Models::MessageContentResponse::Result])
+      end
+      attr_accessor :results
+
+      sig do
+        params(
+          results:
+            T::Array[Trycourier::Models::MessageContentResponse::Result::OrHash]
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # An array of render output of a previously sent message.
+        results:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            results:
+              T::Array[Trycourier::Models::MessageContentResponse::Result]
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Result < Trycourier::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Trycourier::Models::MessageContentResponse::Result,
+              Trycourier::Internal::AnyHash
+            )
+          end
+
+        # The channel used for rendering the message.
+        sig { returns(String) }
+        attr_accessor :channel
+
+        # The ID of channel used for rendering the message.
+        sig { returns(String) }
+        attr_accessor :channel_id
+
+        # Content details of the rendered message.
+        sig do
+          returns(Trycourier::Models::MessageContentResponse::Result::Content)
+        end
+        attr_reader :content
+
+        sig do
+          params(
+            content:
+              Trycourier::Models::MessageContentResponse::Result::Content::OrHash
+          ).void
+        end
+        attr_writer :content
+
+        sig do
+          params(
+            channel: String,
+            channel_id: String,
+            content:
+              Trycourier::Models::MessageContentResponse::Result::Content::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The channel used for rendering the message.
+          channel:,
+          # The ID of channel used for rendering the message.
+          channel_id:,
+          # Content details of the rendered message.
+          content:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              channel: String,
+              channel_id: String,
+              content:
+                Trycourier::Models::MessageContentResponse::Result::Content
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class Content < Trycourier::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Trycourier::Models::MessageContentResponse::Result::Content,
+                Trycourier::Internal::AnyHash
+              )
+            end
+
+          # The blocks of the rendered message.
+          sig do
+            returns(
+              T::Array[
+                Trycourier::Models::MessageContentResponse::Result::Content::Block
+              ]
+            )
+          end
+          attr_accessor :blocks
+
+          # The body of the rendered message.
+          sig { returns(String) }
+          attr_accessor :body
+
+          # The html content of the rendered message.
+          sig { returns(String) }
+          attr_accessor :html
+
+          # The subject of the rendered message.
+          sig { returns(String) }
+          attr_accessor :subject
+
+          # The text of the rendered message.
+          sig { returns(String) }
+          attr_accessor :text
+
+          # The title of the rendered message.
+          sig { returns(String) }
+          attr_accessor :title
+
+          # Content details of the rendered message.
+          sig do
+            params(
+              blocks:
+                T::Array[
+                  Trycourier::Models::MessageContentResponse::Result::Content::Block::OrHash
+                ],
+              body: String,
+              html: String,
+              subject: String,
+              text: String,
+              title: String
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # The blocks of the rendered message.
+            blocks:,
+            # The body of the rendered message.
+            body:,
+            # The html content of the rendered message.
+            html:,
+            # The subject of the rendered message.
+            subject:,
+            # The text of the rendered message.
+            text:,
+            # The title of the rendered message.
+            title:
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                blocks:
+                  T::Array[
+                    Trycourier::Models::MessageContentResponse::Result::Content::Block
+                  ],
+                body: String,
+                html: String,
+                subject: String,
+                text: String,
+                title: String
+              }
+            )
+          end
+          def to_hash
+          end
+
+          class Block < Trycourier::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  Trycourier::Models::MessageContentResponse::Result::Content::Block,
+                  Trycourier::Internal::AnyHash
+                )
+              end
+
+            # The block text of the rendered message block.
+            sig { returns(String) }
+            attr_accessor :text
+
+            # The block type of the rendered message block.
+            sig { returns(String) }
+            attr_accessor :type
+
+            sig { params(text: String, type: String).returns(T.attached_class) }
+            def self.new(
+              # The block text of the rendered message block.
+              text:,
+              # The block type of the rendered message block.
+              type:
+            )
+            end
+
+            sig { override.returns({ text: String, type: String }) }
+            def to_hash
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/trycourier/models/message_context.rbi

@@ -0,0 +1,27 @@
+# typed: strong
+
+module Trycourier
+  module Models
+    class MessageContext < Trycourier::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Trycourier::MessageContext, Trycourier::Internal::AnyHash)
+        end
+
+      # Tenant id used to load brand/default preferences/context.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :tenant_id
+
+      sig { params(tenant_id: T.nilable(String)).returns(T.attached_class) }
+      def self.new(
+        # Tenant id used to load brand/default preferences/context.
+        tenant_id: nil
+      )
+      end
+
+      sig { override.returns({ tenant_id: T.nilable(String) }) }
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/trycourier/models/message_details.rbi

@@ -0,0 +1,231 @@
+# typed: strong
+
+module Trycourier
+  module Models
+    class MessageDetails < Trycourier::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Trycourier::MessageDetails, Trycourier::Internal::AnyHash)
+        end
+
+      # A unique identifier associated with the message you wish to retrieve (results
+      # from a send).
+      sig { returns(String) }
+      attr_accessor :id
+
+      # A UTC timestamp at which the recipient clicked on a tracked link for the first
+      # time. Stored as a millisecond representation of the Unix epoch.
+      sig { returns(Integer) }
+      attr_accessor :clicked
+
+      # A UTC timestamp at which the Integration provider delivered the message. Stored
+      # as a millisecond representation of the Unix epoch.
+      sig { returns(Integer) }
+      attr_accessor :delivered
+
+      # A UTC timestamp at which Courier received the message request. Stored as a
+      # millisecond representation of the Unix epoch.
+      sig { returns(Integer) }
+      attr_accessor :enqueued
+
+      # A unique identifier associated with the event of the delivered message.
+      sig { returns(String) }
+      attr_accessor :event
+
+      # A unique identifier associated with the notification of the delivered message.
+      sig { returns(String) }
+      attr_accessor :notification
+
+      # A UTC timestamp at which the recipient opened a message for the first time.
+      # Stored as a millisecond representation of the Unix epoch.
+      sig { returns(Integer) }
+      attr_accessor :opened
+
+      # A unique identifier associated with the recipient of the delivered message.
+      sig { returns(String) }
+      attr_accessor :recipient
+
+      # A UTC timestamp at which Courier passed the message to the Integration provider.
+      # Stored as a millisecond representation of the Unix epoch.
+      sig { returns(Integer) }
+      attr_accessor :sent
+
+      # The current status of the message.
+      sig { returns(Trycourier::MessageDetails::Status::TaggedSymbol) }
+      attr_accessor :status
+
+      # A message describing the error that occurred.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :error
+
+      # The reason for the current status of the message.
+      sig do
+        returns(T.nilable(Trycourier::MessageDetails::Reason::TaggedSymbol))
+      end
+      attr_accessor :reason
+
+      sig do
+        params(
+          id: String,
+          clicked: Integer,
+          delivered: Integer,
+          enqueued: Integer,
+          event: String,
+          notification: String,
+          opened: Integer,
+          recipient: String,
+          sent: Integer,
+          status: Trycourier::MessageDetails::Status::OrSymbol,
+          error: T.nilable(String),
+          reason: T.nilable(Trycourier::MessageDetails::Reason::OrSymbol)
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # A unique identifier associated with the message you wish to retrieve (results
+        # from a send).
+        id:,
+        # A UTC timestamp at which the recipient clicked on a tracked link for the first
+        # time. Stored as a millisecond representation of the Unix epoch.
+        clicked:,
+        # A UTC timestamp at which the Integration provider delivered the message. Stored
+        # as a millisecond representation of the Unix epoch.
+        delivered:,
+        # A UTC timestamp at which Courier received the message request. Stored as a
+        # millisecond representation of the Unix epoch.
+        enqueued:,
+        # A unique identifier associated with the event of the delivered message.
+        event:,
+        # A unique identifier associated with the notification of the delivered message.
+        notification:,
+        # A UTC timestamp at which the recipient opened a message for the first time.
+        # Stored as a millisecond representation of the Unix epoch.
+        opened:,
+        # A unique identifier associated with the recipient of the delivered message.
+        recipient:,
+        # A UTC timestamp at which Courier passed the message to the Integration provider.
+        # Stored as a millisecond representation of the Unix epoch.
+        sent:,
+        # The current status of the message.
+        status:,
+        # A message describing the error that occurred.
+        error: nil,
+        # The reason for the current status of the message.
+        reason: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            clicked: Integer,
+            delivered: Integer,
+            enqueued: Integer,
+            event: String,
+            notification: String,
+            opened: Integer,
+            recipient: String,
+            sent: Integer,
+            status: Trycourier::MessageDetails::Status::TaggedSymbol,
+            error: T.nilable(String),
+            reason: T.nilable(Trycourier::MessageDetails::Reason::TaggedSymbol)
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # The current status of the message.
+      module Status
+        extend Trycourier::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, Trycourier::MessageDetails::Status) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        CANCELED =
+          T.let(:CANCELED, Trycourier::MessageDetails::Status::TaggedSymbol)
+        CLICKED =
+          T.let(:CLICKED, Trycourier::MessageDetails::Status::TaggedSymbol)
+        DELAYED =
+          T.let(:DELAYED, Trycourier::MessageDetails::Status::TaggedSymbol)
+        DELIVERED =
+          T.let(:DELIVERED, Trycourier::MessageDetails::Status::TaggedSymbol)
+        DIGESTED =
+          T.let(:DIGESTED, Trycourier::MessageDetails::Status::TaggedSymbol)
+        ENQUEUED =
+          T.let(:ENQUEUED, Trycourier::MessageDetails::Status::TaggedSymbol)
+        FILTERED =
+          T.let(:FILTERED, Trycourier::MessageDetails::Status::TaggedSymbol)
+        OPENED =
+          T.let(:OPENED, Trycourier::MessageDetails::Status::TaggedSymbol)
+        ROUTED =
+          T.let(:ROUTED, Trycourier::MessageDetails::Status::TaggedSymbol)
+        SENT = T.let(:SENT, Trycourier::MessageDetails::Status::TaggedSymbol)
+        SIMULATED =
+          T.let(:SIMULATED, Trycourier::MessageDetails::Status::TaggedSymbol)
+        THROTTLED =
+          T.let(:THROTTLED, Trycourier::MessageDetails::Status::TaggedSymbol)
+        UNDELIVERABLE =
+          T.let(
+            :UNDELIVERABLE,
+            Trycourier::MessageDetails::Status::TaggedSymbol
+          )
+        UNMAPPED =
+          T.let(:UNMAPPED, Trycourier::MessageDetails::Status::TaggedSymbol)
+        UNROUTABLE =
+          T.let(:UNROUTABLE, Trycourier::MessageDetails::Status::TaggedSymbol)
+
+        sig do
+          override.returns(
+            T::Array[Trycourier::MessageDetails::Status::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+
+      # The reason for the current status of the message.
+      module Reason
+        extend Trycourier::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, Trycourier::MessageDetails::Reason) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        BOUNCED =
+          T.let(:BOUNCED, Trycourier::MessageDetails::Reason::TaggedSymbol)
+        FAILED =
+          T.let(:FAILED, Trycourier::MessageDetails::Reason::TaggedSymbol)
+        FILTERED =
+          T.let(:FILTERED, Trycourier::MessageDetails::Reason::TaggedSymbol)
+        NO_CHANNELS =
+          T.let(:NO_CHANNELS, Trycourier::MessageDetails::Reason::TaggedSymbol)
+        NO_PROVIDERS =
+          T.let(:NO_PROVIDERS, Trycourier::MessageDetails::Reason::TaggedSymbol)
+        OPT_IN_REQUIRED =
+          T.let(
+            :OPT_IN_REQUIRED,
+            Trycourier::MessageDetails::Reason::TaggedSymbol
+          )
+        PROVIDER_ERROR =
+          T.let(
+            :PROVIDER_ERROR,
+            Trycourier::MessageDetails::Reason::TaggedSymbol
+          )
+        UNPUBLISHED =
+          T.let(:UNPUBLISHED, Trycourier::MessageDetails::Reason::TaggedSymbol)
+        UNSUBSCRIBED =
+          T.let(:UNSUBSCRIBED, Trycourier::MessageDetails::Reason::TaggedSymbol)
+
+        sig do
+          override.returns(
+            T::Array[Trycourier::MessageDetails::Reason::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/trycourier/models/message_history_params.rbi

@@ -0,0 +1,43 @@
+# typed: strong
+
+module Trycourier
+  module Models
+    class MessageHistoryParams < Trycourier::Internal::Type::BaseModel
+      extend Trycourier::Internal::Type::RequestParameters::Converter
+      include Trycourier::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Trycourier::MessageHistoryParams, Trycourier::Internal::AnyHash)
+        end
+
+      # A supported Message History type that will filter the events returned.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :type
+
+      sig do
+        params(
+          type: T.nilable(String),
+          request_options: Trycourier::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # A supported Message History type that will filter the events returned.
+        type: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            type: T.nilable(String),
+            request_options: Trycourier::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/trycourier/models/message_history_response.rbi

@@ -0,0 +1,32 @@
+# typed: strong
+
+module Trycourier
+  module Models
+    class MessageHistoryResponse < Trycourier::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Trycourier::Models::MessageHistoryResponse,
+            Trycourier::Internal::AnyHash
+          )
+        end
+
+      sig { returns(T::Array[T::Hash[Symbol, T.anything]]) }
+      attr_accessor :results
+
+      sig do
+        params(results: T::Array[T::Hash[Symbol, T.anything]]).returns(
+          T.attached_class
+        )
+      end
+      def self.new(results:)
+      end
+
+      sig do
+        override.returns({ results: T::Array[T::Hash[Symbol, T.anything]] })
+      end
+      def to_hash
+      end
+    end
+  end
+end