trycourier 3.1.4 → 3.4.0.pre.alpha1

data/rbi/trycourier/models/tenant_list_users_response.rbi

@@ -0,0 +1,112 @@
+# typed: strong
+
+module Trycourier
+  module Models
+    class TenantListUsersResponse < Trycourier::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Trycourier::Models::TenantListUsersResponse,
+            Trycourier::Internal::AnyHash
+          )
+        end
+
+      # Set to true when there are more pages that can be retrieved.
+      sig { returns(T::Boolean) }
+      attr_accessor :has_more
+
+      # Always set to `list`. Represents the type of this object.
+      sig do
+        returns(Trycourier::Models::TenantListUsersResponse::Type::TaggedSymbol)
+      end
+      attr_accessor :type
+
+      # A url that may be used to generate these results.
+      sig { returns(String) }
+      attr_accessor :url
+
+      # A pointer to the next page of results. Defined only when `has_more` is set to
+      # true
+      sig { returns(T.nilable(String)) }
+      attr_accessor :cursor
+
+      sig { returns(T.nilable(T::Array[Trycourier::TenantAssociation])) }
+      attr_accessor :items
+
+      # A url that may be used to generate fetch the next set of results. Defined only
+      # when `has_more` is set to true
+      sig { returns(T.nilable(String)) }
+      attr_accessor :next_url
+
+      sig do
+        params(
+          has_more: T::Boolean,
+          type: Trycourier::Models::TenantListUsersResponse::Type::OrSymbol,
+          url: String,
+          cursor: T.nilable(String),
+          items: T.nilable(T::Array[Trycourier::TenantAssociation::OrHash]),
+          next_url: T.nilable(String)
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Set to true when there are more pages that can be retrieved.
+        has_more:,
+        # Always set to `list`. Represents the type of this object.
+        type:,
+        # A url that may be used to generate these results.
+        url:,
+        # A pointer to the next page of results. Defined only when `has_more` is set to
+        # true
+        cursor: nil,
+        items: nil,
+        # A url that may be used to generate fetch the next set of results. Defined only
+        # when `has_more` is set to true
+        next_url: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            has_more: T::Boolean,
+            type:
+              Trycourier::Models::TenantListUsersResponse::Type::TaggedSymbol,
+            url: String,
+            cursor: T.nilable(String),
+            items: T.nilable(T::Array[Trycourier::TenantAssociation]),
+            next_url: T.nilable(String)
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # Always set to `list`. Represents the type of this object.
+      module Type
+        extend Trycourier::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Trycourier::Models::TenantListUsersResponse::Type)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        LIST =
+          T.let(
+            :list,
+            Trycourier::Models::TenantListUsersResponse::Type::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              Trycourier::Models::TenantListUsersResponse::Type::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/trycourier/models/tenant_retrieve_params.rbi

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

data/rbi/trycourier/models/tenant_update_params.rbi

@@ -0,0 +1,93 @@
+# typed: strong
+
+module Trycourier
+  module Models
+    class TenantUpdateParams < Trycourier::Internal::Type::BaseModel
+      extend Trycourier::Internal::Type::RequestParameters::Converter
+      include Trycourier::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Trycourier::TenantUpdateParams, Trycourier::Internal::AnyHash)
+        end
+
+      # Name of the tenant.
+      sig { returns(String) }
+      attr_accessor :name
+
+      # Brand to be used for the account when one is not specified by the send call.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :brand_id
+
+      # Defines the preferences used for the tenant when the user hasn't specified their
+      # own.
+      sig { returns(T.nilable(Trycourier::DefaultPreferences)) }
+      attr_reader :default_preferences
+
+      sig do
+        params(
+          default_preferences: T.nilable(Trycourier::DefaultPreferences::OrHash)
+        ).void
+      end
+      attr_writer :default_preferences
+
+      # Tenant's parent id (if any).
+      sig { returns(T.nilable(String)) }
+      attr_accessor :parent_tenant_id
+
+      # Arbitrary properties accessible to a template.
+      sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
+      attr_accessor :properties
+
+      # A user profile object merged with user profile on send.
+      sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
+      attr_accessor :user_profile
+
+      sig do
+        params(
+          name: String,
+          brand_id: T.nilable(String),
+          default_preferences:
+            T.nilable(Trycourier::DefaultPreferences::OrHash),
+          parent_tenant_id: T.nilable(String),
+          properties: T.nilable(T::Hash[Symbol, T.anything]),
+          user_profile: T.nilable(T::Hash[Symbol, T.anything]),
+          request_options: Trycourier::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Name of the tenant.
+        name:,
+        # Brand to be used for the account when one is not specified by the send call.
+        brand_id: nil,
+        # Defines the preferences used for the tenant when the user hasn't specified their
+        # own.
+        default_preferences: nil,
+        # Tenant's parent id (if any).
+        parent_tenant_id: nil,
+        # Arbitrary properties accessible to a template.
+        properties: nil,
+        # A user profile object merged with user profile on send.
+        user_profile: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            name: String,
+            brand_id: T.nilable(String),
+            default_preferences: T.nilable(Trycourier::DefaultPreferences),
+            parent_tenant_id: T.nilable(String),
+            properties: T.nilable(T::Hash[Symbol, T.anything]),
+            user_profile: T.nilable(T::Hash[Symbol, T.anything]),
+            request_options: Trycourier::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/trycourier/models/tenants/default_preferences/item_delete_params.rbi

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

data/rbi/trycourier/models/tenants/default_preferences/item_update_params.rbi

@@ -0,0 +1,42 @@
+# typed: strong
+
+module Trycourier
+  module Models
+    module Tenants
+      module DefaultPreferences
+        class ItemUpdateParams < Trycourier::Models::SubscriptionTopicNew
+          extend Trycourier::Internal::Type::RequestParameters::Converter
+          include Trycourier::Internal::Type::RequestParameters
+
+          OrHash =
+            T.type_alias do
+              T.any(
+                Trycourier::Tenants::DefaultPreferences::ItemUpdateParams,
+                Trycourier::Internal::AnyHash
+              )
+            end
+
+          sig { returns(String) }
+          attr_accessor :tenant_id
+
+          sig do
+            params(
+              tenant_id: String,
+              request_options: Trycourier::RequestOptions::OrHash
+            ).returns(T.attached_class)
+          end
+          def self.new(tenant_id:, request_options: {})
+          end
+
+          sig do
+            override.returns(
+              { tenant_id: String, request_options: Trycourier::RequestOptions }
+            )
+          end
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/trycourier/models/tenants/template_list_params.rbi

@@ -0,0 +1,56 @@
+# typed: strong
+
+module Trycourier
+  module Models
+    module Tenants
+      class TemplateListParams < Trycourier::Internal::Type::BaseModel
+        extend Trycourier::Internal::Type::RequestParameters::Converter
+        include Trycourier::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Trycourier::Tenants::TemplateListParams,
+              Trycourier::Internal::AnyHash
+            )
+          end
+
+        # Continue the pagination with the next cursor
+        sig { returns(T.nilable(String)) }
+        attr_accessor :cursor
+
+        # The number of templates to return (defaults to 20, maximum value of 100)
+        sig { returns(T.nilable(Integer)) }
+        attr_accessor :limit
+
+        sig do
+          params(
+            cursor: T.nilable(String),
+            limit: T.nilable(Integer),
+            request_options: Trycourier::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Continue the pagination with the next cursor
+          cursor: nil,
+          # The number of templates to return (defaults to 20, maximum value of 100)
+          limit: nil,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              cursor: T.nilable(String),
+              limit: T.nilable(Integer),
+              request_options: Trycourier::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/trycourier/models/tenants/template_list_response.rbi

@@ -0,0 +1,214 @@
+# typed: strong
+
+module Trycourier
+  module Models
+    module Tenants
+      class TemplateListResponse < Trycourier::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Trycourier::Models::Tenants::TemplateListResponse,
+              Trycourier::Internal::AnyHash
+            )
+          end
+
+        # Set to true when there are more pages that can be retrieved.
+        sig { returns(T::Boolean) }
+        attr_accessor :has_more
+
+        # Always set to `list`. Represents the type of this object.
+        sig do
+          returns(
+            Trycourier::Models::Tenants::TemplateListResponse::Type::TaggedSymbol
+          )
+        end
+        attr_accessor :type
+
+        # A url that may be used to generate these results.
+        sig { returns(String) }
+        attr_accessor :url
+
+        # A pointer to the next page of results. Defined only when `has_more` is set to
+        # true
+        sig { returns(T.nilable(String)) }
+        attr_accessor :cursor
+
+        sig do
+          returns(
+            T.nilable(
+              T::Array[Trycourier::Models::Tenants::TemplateListResponse::Item]
+            )
+          )
+        end
+        attr_accessor :items
+
+        # A url that may be used to generate fetch the next set of results. Defined only
+        # when `has_more` is set to true
+        sig { returns(T.nilable(String)) }
+        attr_accessor :next_url
+
+        sig do
+          params(
+            has_more: T::Boolean,
+            type:
+              Trycourier::Models::Tenants::TemplateListResponse::Type::OrSymbol,
+            url: String,
+            cursor: T.nilable(String),
+            items:
+              T.nilable(
+                T::Array[
+                  Trycourier::Models::Tenants::TemplateListResponse::Item::OrHash
+                ]
+              ),
+            next_url: T.nilable(String)
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Set to true when there are more pages that can be retrieved.
+          has_more:,
+          # Always set to `list`. Represents the type of this object.
+          type:,
+          # A url that may be used to generate these results.
+          url:,
+          # A pointer to the next page of results. Defined only when `has_more` is set to
+          # true
+          cursor: nil,
+          items: nil,
+          # A url that may be used to generate fetch the next set of results. Defined only
+          # when `has_more` is set to true
+          next_url: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              has_more: T::Boolean,
+              type:
+                Trycourier::Models::Tenants::TemplateListResponse::Type::TaggedSymbol,
+              url: String,
+              cursor: T.nilable(String),
+              items:
+                T.nilable(
+                  T::Array[
+                    Trycourier::Models::Tenants::TemplateListResponse::Item
+                  ]
+                ),
+              next_url: T.nilable(String)
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # Always set to `list`. Represents the type of this object.
+        module Type
+          extend Trycourier::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                Trycourier::Models::Tenants::TemplateListResponse::Type
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          LIST =
+            T.let(
+              :list,
+              Trycourier::Models::Tenants::TemplateListResponse::Type::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Trycourier::Models::Tenants::TemplateListResponse::Type::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+
+        class Item < Trycourier::Models::BaseTemplateTenantAssociation
+          OrHash =
+            T.type_alias do
+              T.any(
+                Trycourier::Models::Tenants::TemplateListResponse::Item,
+                Trycourier::Internal::AnyHash
+              )
+            end
+
+          # The template's data containing it's routing configs
+          sig do
+            returns(
+              Trycourier::Models::Tenants::TemplateListResponse::Item::Data
+            )
+          end
+          attr_reader :data
+
+          sig do
+            params(
+              data:
+                Trycourier::Models::Tenants::TemplateListResponse::Item::Data::OrHash
+            ).void
+          end
+          attr_writer :data
+
+          sig do
+            params(
+              data:
+                Trycourier::Models::Tenants::TemplateListResponse::Item::Data::OrHash
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # The template's data containing it's routing configs
+            data:
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                data:
+                  Trycourier::Models::Tenants::TemplateListResponse::Item::Data
+              }
+            )
+          end
+          def to_hash
+          end
+
+          class Data < Trycourier::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  Trycourier::Models::Tenants::TemplateListResponse::Item::Data,
+                  Trycourier::Internal::AnyHash
+                )
+              end
+
+            sig { returns(Trycourier::MessageRouting) }
+            attr_reader :routing
+
+            sig { params(routing: Trycourier::MessageRouting::OrHash).void }
+            attr_writer :routing
+
+            # The template's data containing it's routing configs
+            sig do
+              params(routing: Trycourier::MessageRouting::OrHash).returns(
+                T.attached_class
+              )
+            end
+            def self.new(routing:)
+            end
+
+            sig { override.returns({ routing: Trycourier::MessageRouting }) }
+            def to_hash
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/trycourier/models/tenants/template_retrieve_params.rbi

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

data/rbi/trycourier/models/text_style.rbi

@@ -0,0 +1,21 @@
+# typed: strong
+
+module Trycourier
+  module Models
+    module TextStyle
+      extend Trycourier::Internal::Type::Enum
+
+      TaggedSymbol = T.type_alias { T.all(Symbol, Trycourier::TextStyle) }
+      OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+      TEXT = T.let(:text, Trycourier::TextStyle::TaggedSymbol)
+      H1 = T.let(:h1, Trycourier::TextStyle::TaggedSymbol)
+      H2 = T.let(:h2, Trycourier::TextStyle::TaggedSymbol)
+      SUBTEXT = T.let(:subtext, Trycourier::TextStyle::TaggedSymbol)
+
+      sig { override.returns(T::Array[Trycourier::TextStyle::TaggedSymbol]) }
+      def self.values
+      end
+    end
+  end
+end