trycourier 3.1.4 → 3.4.0.pre.alpha1

data/rbi/trycourier/models/brand_settings_email.rbi

@@ -0,0 +1,117 @@
+# typed: strong
+
+module Trycourier
+  module Models
+    class BrandSettingsEmail < Trycourier::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Trycourier::BrandSettingsEmail, Trycourier::Internal::AnyHash)
+        end
+
+      sig { returns(T.nilable(Trycourier::EmailFooter)) }
+      attr_reader :footer
+
+      sig { params(footer: T.nilable(Trycourier::EmailFooter::OrHash)).void }
+      attr_writer :footer
+
+      sig { returns(T.nilable(Trycourier::EmailHead)) }
+      attr_reader :head
+
+      sig { params(head: T.nilable(Trycourier::EmailHead::OrHash)).void }
+      attr_writer :head
+
+      sig { returns(T.nilable(Trycourier::EmailHeader)) }
+      attr_reader :header
+
+      sig { params(header: T.nilable(Trycourier::EmailHeader::OrHash)).void }
+      attr_writer :header
+
+      sig do
+        returns(T.nilable(Trycourier::BrandSettingsEmail::TemplateOverride))
+      end
+      attr_reader :template_override
+
+      sig do
+        params(
+          template_override:
+            T.nilable(Trycourier::BrandSettingsEmail::TemplateOverride::OrHash)
+        ).void
+      end
+      attr_writer :template_override
+
+      sig do
+        params(
+          footer: T.nilable(Trycourier::EmailFooter::OrHash),
+          head: T.nilable(Trycourier::EmailHead::OrHash),
+          header: T.nilable(Trycourier::EmailHeader::OrHash),
+          template_override:
+            T.nilable(Trycourier::BrandSettingsEmail::TemplateOverride::OrHash)
+        ).returns(T.attached_class)
+      end
+      def self.new(footer: nil, head: nil, header: nil, template_override: nil)
+      end
+
+      sig do
+        override.returns(
+          {
+            footer: T.nilable(Trycourier::EmailFooter),
+            head: T.nilable(Trycourier::EmailHead),
+            header: T.nilable(Trycourier::EmailHeader),
+            template_override:
+              T.nilable(Trycourier::BrandSettingsEmail::TemplateOverride)
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class TemplateOverride < Trycourier::Models::BrandTemplate
+        OrHash =
+          T.type_alias do
+            T.any(
+              Trycourier::BrandSettingsEmail::TemplateOverride,
+              Trycourier::Internal::AnyHash
+            )
+          end
+
+        sig { returns(Trycourier::BrandTemplate) }
+        attr_reader :mjml
+
+        sig { params(mjml: Trycourier::BrandTemplate::OrHash).void }
+        attr_writer :mjml
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :footer_background_color
+
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_accessor :footer_full_width
+
+        sig do
+          params(
+            mjml: Trycourier::BrandTemplate::OrHash,
+            footer_background_color: T.nilable(String),
+            footer_full_width: T.nilable(T::Boolean)
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          mjml:,
+          footer_background_color: nil,
+          footer_full_width: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              mjml: Trycourier::BrandTemplate,
+              footer_background_color: T.nilable(String),
+              footer_full_width: T.nilable(T::Boolean)
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/trycourier/models/brand_settings_in_app.rbi

@@ -0,0 +1,116 @@
+# typed: strong
+
+module Trycourier
+  module Models
+    class BrandSettingsInApp < Trycourier::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Trycourier::BrandSettingsInApp, Trycourier::Internal::AnyHash)
+        end
+
+      sig { returns(Trycourier::BrandColors) }
+      attr_reader :colors
+
+      sig { params(colors: Trycourier::BrandColors::OrHash).void }
+      attr_writer :colors
+
+      sig { returns(Trycourier::Icons) }
+      attr_reader :icons
+
+      sig { params(icons: Trycourier::Icons::OrHash).void }
+      attr_writer :icons
+
+      sig { returns(Trycourier::WidgetBackground) }
+      attr_reader :widget_background
+
+      sig do
+        params(widget_background: Trycourier::WidgetBackground::OrHash).void
+      end
+      attr_writer :widget_background
+
+      sig { returns(T.nilable(String)) }
+      attr_accessor :border_radius
+
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_accessor :disable_message_icon
+
+      sig { returns(T.nilable(String)) }
+      attr_accessor :font_family
+
+      sig do
+        returns(T.nilable(Trycourier::BrandSettingsInApp::Placement::OrSymbol))
+      end
+      attr_accessor :placement
+
+      sig do
+        params(
+          colors: Trycourier::BrandColors::OrHash,
+          icons: Trycourier::Icons::OrHash,
+          widget_background: Trycourier::WidgetBackground::OrHash,
+          border_radius: T.nilable(String),
+          disable_message_icon: T.nilable(T::Boolean),
+          font_family: T.nilable(String),
+          placement:
+            T.nilable(Trycourier::BrandSettingsInApp::Placement::OrSymbol)
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        colors:,
+        icons:,
+        widget_background:,
+        border_radius: nil,
+        disable_message_icon: nil,
+        font_family: nil,
+        placement: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            colors: Trycourier::BrandColors,
+            icons: Trycourier::Icons,
+            widget_background: Trycourier::WidgetBackground,
+            border_radius: T.nilable(String),
+            disable_message_icon: T.nilable(T::Boolean),
+            font_family: T.nilable(String),
+            placement:
+              T.nilable(Trycourier::BrandSettingsInApp::Placement::OrSymbol)
+          }
+        )
+      end
+      def to_hash
+      end
+
+      module Placement
+        extend Trycourier::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Trycourier::BrandSettingsInApp::Placement)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        TOP =
+          T.let(:top, Trycourier::BrandSettingsInApp::Placement::TaggedSymbol)
+        BOTTOM =
+          T.let(
+            :bottom,
+            Trycourier::BrandSettingsInApp::Placement::TaggedSymbol
+          )
+        LEFT =
+          T.let(:left, Trycourier::BrandSettingsInApp::Placement::TaggedSymbol)
+        RIGHT =
+          T.let(:right, Trycourier::BrandSettingsInApp::Placement::TaggedSymbol)
+
+        sig do
+          override.returns(
+            T::Array[Trycourier::BrandSettingsInApp::Placement::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/trycourier/models/brand_snippet.rbi

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

data/rbi/trycourier/models/brand_snippets.rbi

@@ -0,0 +1,31 @@
+# typed: strong
+
+module Trycourier
+  module Models
+    class BrandSnippets < Trycourier::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Trycourier::BrandSnippets, Trycourier::Internal::AnyHash)
+        end
+
+      sig { returns(T.nilable(T::Array[Trycourier::BrandSnippet])) }
+      attr_accessor :items
+
+      sig do
+        params(
+          items: T.nilable(T::Array[Trycourier::BrandSnippet::OrHash])
+        ).returns(T.attached_class)
+      end
+      def self.new(items: nil)
+      end
+
+      sig do
+        override.returns(
+          { items: T.nilable(T::Array[Trycourier::BrandSnippet]) }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/trycourier/models/brand_template.rbi

@@ -0,0 +1,71 @@
+# typed: strong
+
+module Trycourier
+  module Models
+    class BrandTemplate < Trycourier::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Trycourier::BrandTemplate, Trycourier::Internal::AnyHash)
+        end
+
+      sig { returns(T::Boolean) }
+      attr_accessor :enabled
+
+      sig { returns(T.nilable(String)) }
+      attr_accessor :background_color
+
+      sig { returns(T.nilable(String)) }
+      attr_accessor :blocks_background_color
+
+      sig { returns(T.nilable(String)) }
+      attr_accessor :footer
+
+      sig { returns(T.nilable(String)) }
+      attr_accessor :head
+
+      sig { returns(T.nilable(String)) }
+      attr_accessor :header
+
+      sig { returns(T.nilable(String)) }
+      attr_accessor :width
+
+      sig do
+        params(
+          enabled: T::Boolean,
+          background_color: T.nilable(String),
+          blocks_background_color: T.nilable(String),
+          footer: T.nilable(String),
+          head: T.nilable(String),
+          header: T.nilable(String),
+          width: T.nilable(String)
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        enabled:,
+        background_color: nil,
+        blocks_background_color: nil,
+        footer: nil,
+        head: nil,
+        header: nil,
+        width: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            enabled: T::Boolean,
+            background_color: T.nilable(String),
+            blocks_background_color: T.nilable(String),
+            footer: T.nilable(String),
+            head: T.nilable(String),
+            header: T.nilable(String),
+            width: T.nilable(String)
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/trycourier/models/brand_update_params.rbi

@@ -0,0 +1,65 @@
+# typed: strong
+
+module Trycourier
+  module Models
+    class BrandUpdateParams < Trycourier::Internal::Type::BaseModel
+      extend Trycourier::Internal::Type::RequestParameters::Converter
+      include Trycourier::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Trycourier::BrandUpdateParams, Trycourier::Internal::AnyHash)
+        end
+
+      # The name of the brand.
+      sig { returns(String) }
+      attr_accessor :name
+
+      sig { returns(T.nilable(Trycourier::BrandSettings)) }
+      attr_reader :settings
+
+      sig do
+        params(settings: T.nilable(Trycourier::BrandSettings::OrHash)).void
+      end
+      attr_writer :settings
+
+      sig { returns(T.nilable(Trycourier::BrandSnippets)) }
+      attr_reader :snippets
+
+      sig do
+        params(snippets: T.nilable(Trycourier::BrandSnippets::OrHash)).void
+      end
+      attr_writer :snippets
+
+      sig do
+        params(
+          name: String,
+          settings: T.nilable(Trycourier::BrandSettings::OrHash),
+          snippets: T.nilable(Trycourier::BrandSnippets::OrHash),
+          request_options: Trycourier::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The name of the brand.
+        name:,
+        settings: nil,
+        snippets: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            name: String,
+            settings: T.nilable(Trycourier::BrandSettings),
+            snippets: T.nilable(Trycourier::BrandSnippets),
+            request_options: Trycourier::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/trycourier/models/bulk_add_users_params.rbi

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

data/rbi/trycourier/models/bulk_create_job_params.rbi

@@ -0,0 +1,53 @@
+# typed: strong
+
+module Trycourier
+  module Models
+    class BulkCreateJobParams < Trycourier::Internal::Type::BaseModel
+      extend Trycourier::Internal::Type::RequestParameters::Converter
+      include Trycourier::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Trycourier::BulkCreateJobParams, Trycourier::Internal::AnyHash)
+        end
+
+      sig do
+        returns(
+          T.any(
+            Trycourier::InboundBulkMessage::InboundBulkTemplateMessage,
+            Trycourier::InboundBulkMessage::InboundBulkContentMessage
+          )
+        )
+      end
+      attr_accessor :message
+
+      sig do
+        params(
+          message:
+            T.any(
+              Trycourier::InboundBulkMessage::InboundBulkTemplateMessage::OrHash,
+              Trycourier::InboundBulkMessage::InboundBulkContentMessage::OrHash
+            ),
+          request_options: Trycourier::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(message:, request_options: {})
+      end
+
+      sig do
+        override.returns(
+          {
+            message:
+              T.any(
+                Trycourier::InboundBulkMessage::InboundBulkTemplateMessage,
+                Trycourier::InboundBulkMessage::InboundBulkContentMessage
+              ),
+            request_options: Trycourier::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/trycourier/models/bulk_create_job_response.rbi

@@ -0,0 +1,26 @@
+# typed: strong
+
+module Trycourier
+  module Models
+    class BulkCreateJobResponse < Trycourier::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Trycourier::Models::BulkCreateJobResponse,
+            Trycourier::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/trycourier/models/bulk_list_users_params.rbi

@@ -0,0 +1,45 @@
+# typed: strong
+
+module Trycourier
+  module Models
+    class BulkListUsersParams < Trycourier::Internal::Type::BaseModel
+      extend Trycourier::Internal::Type::RequestParameters::Converter
+      include Trycourier::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Trycourier::BulkListUsersParams, Trycourier::Internal::AnyHash)
+        end
+
+      # 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(
+          cursor: T.nilable(String),
+          request_options: Trycourier::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # 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(
+          {
+            cursor: T.nilable(String),
+            request_options: Trycourier::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end