knockapi 0.6.1 → 1.0.0

data/rbi/knockapi/models/tenant.rbi

@@ -0,0 +1,162 @@
+# typed: strong
+
+module Knockapi
+  module Models
+    class Tenant < Knockapi::Internal::Type::BaseModel
+      # The unique identifier for the tenant.
+      sig { returns(String) }
+      attr_accessor :id
+
+      # The typename of the schema.
+      sig { returns(String) }
+      attr_accessor :_typename
+
+      # An optional name for the tenant.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :name
+
+      # The settings for the tenant. Includes branding and preference set.
+      sig { returns(T.nilable(Knockapi::Models::Tenant::Settings)) }
+      attr_reader :settings
+
+      sig { params(settings: T.nilable(T.any(Knockapi::Models::Tenant::Settings, Knockapi::Internal::AnyHash))).void }
+      attr_writer :settings
+
+      # A tenant entity.
+      sig do
+        params(
+          id: String,
+          _typename: String,
+          name: T.nilable(String),
+          settings: T.nilable(T.any(Knockapi::Models::Tenant::Settings, Knockapi::Internal::AnyHash))
+        )
+          .returns(T.attached_class)
+      end
+      def self.new(
+        # The unique identifier for the tenant.
+        id:,
+        # The typename of the schema.
+        _typename:,
+        # An optional name for the tenant.
+        name: nil,
+        # The settings for the tenant. Includes branding and preference set.
+        settings: nil
+      ); end
+      sig do
+        override
+          .returns(
+            {id: String, _typename: String, name: T.nilable(String), settings: T.nilable(Knockapi::Models::Tenant::Settings)}
+          )
+      end
+      def to_hash; end
+
+      class Settings < Knockapi::Internal::Type::BaseModel
+        # The branding for the tenant.
+        sig { returns(T.nilable(Knockapi::Models::Tenant::Settings::Branding)) }
+        attr_reader :branding
+
+        sig do
+          params(
+            branding: T.nilable(T.any(Knockapi::Models::Tenant::Settings::Branding, Knockapi::Internal::AnyHash))
+          )
+            .void
+        end
+        attr_writer :branding
+
+        # A preference set represents a specific set of notification preferences for a
+        # recipient. A recipient can have multiple preference sets.
+        sig { returns(T.nilable(Knockapi::Models::Recipients::PreferenceSet)) }
+        attr_reader :preference_set
+
+        sig do
+          params(
+            preference_set: T.nilable(T.any(Knockapi::Models::Recipients::PreferenceSet, Knockapi::Internal::AnyHash))
+          )
+            .void
+        end
+        attr_writer :preference_set
+
+        # The settings for the tenant. Includes branding and preference set.
+        sig do
+          params(
+            branding: T.nilable(T.any(Knockapi::Models::Tenant::Settings::Branding, Knockapi::Internal::AnyHash)),
+            preference_set: T.nilable(T.any(Knockapi::Models::Recipients::PreferenceSet, Knockapi::Internal::AnyHash))
+          )
+            .returns(T.attached_class)
+        end
+        def self.new(
+          # The branding for the tenant.
+          branding: nil,
+          # A preference set represents a specific set of notification preferences for a
+          # recipient. A recipient can have multiple preference sets.
+          preference_set: nil
+        ); end
+        sig do
+          override
+            .returns(
+              {
+                branding: T.nilable(Knockapi::Models::Tenant::Settings::Branding),
+                preference_set: T.nilable(Knockapi::Models::Recipients::PreferenceSet)
+              }
+            )
+        end
+        def to_hash; end
+
+        class Branding < Knockapi::Internal::Type::BaseModel
+          # The icon URL for the tenant. Must point to a valid image with an image MIME
+          # type.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :icon_url
+
+          # The logo URL for the tenant. Must point to a valid image with an image MIME
+          # type.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :logo_url
+
+          # The primary color for the tenant, provided as a hex value.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :primary_color
+
+          # The primary color contrast for the tenant, provided as a hex value.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :primary_color_contrast
+
+          # The branding for the tenant.
+          sig do
+            params(
+              icon_url: T.nilable(String),
+              logo_url: T.nilable(String),
+              primary_color: T.nilable(String),
+              primary_color_contrast: T.nilable(String)
+            )
+              .returns(T.attached_class)
+          end
+          def self.new(
+            # The icon URL for the tenant. Must point to a valid image with an image MIME
+            # type.
+            icon_url: nil,
+            # The logo URL for the tenant. Must point to a valid image with an image MIME
+            # type.
+            logo_url: nil,
+            # The primary color for the tenant, provided as a hex value.
+            primary_color: nil,
+            # The primary color contrast for the tenant, provided as a hex value.
+            primary_color_contrast: nil
+          ); end
+          sig do
+            override
+              .returns(
+                {
+                  icon_url: T.nilable(String),
+                  logo_url: T.nilable(String),
+                  primary_color: T.nilable(String),
+                  primary_color_contrast: T.nilable(String)
+                }
+              )
+          end
+          def to_hash; end
+        end
+      end
+    end
+  end
+end

data/rbi/knockapi/models/tenant_delete_params.rbi

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

data/rbi/knockapi/models/tenant_get_params.rbi

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

data/rbi/knockapi/models/tenant_list_params.rbi

@@ -0,0 +1,84 @@
+# typed: strong
+
+module Knockapi
+  module Models
+    class TenantListParams < Knockapi::Internal::Type::BaseModel
+      extend Knockapi::Internal::Type::RequestParameters::Converter
+      include Knockapi::Internal::Type::RequestParameters
+
+      # The cursor to fetch entries after.
+      sig { returns(T.nilable(String)) }
+      attr_reader :after
+
+      sig { params(after: String).void }
+      attr_writer :after
+
+      # The cursor to fetch entries before.
+      sig { returns(T.nilable(String)) }
+      attr_reader :before
+
+      sig { params(before: String).void }
+      attr_writer :before
+
+      # Filter tenants by name.
+      sig { returns(T.nilable(String)) }
+      attr_reader :name
+
+      sig { params(name: String).void }
+      attr_writer :name
+
+      # The number of items per page.
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :page_size
+
+      sig { params(page_size: Integer).void }
+      attr_writer :page_size
+
+      # Filter tenants by ID.
+      sig { returns(T.nilable(String)) }
+      attr_reader :tenant_id
+
+      sig { params(tenant_id: String).void }
+      attr_writer :tenant_id
+
+      sig do
+        params(
+          after: String,
+          before: String,
+          name: String,
+          page_size: Integer,
+          tenant_id: String,
+          request_options: T.any(Knockapi::RequestOptions, Knockapi::Internal::AnyHash)
+        )
+          .returns(T.attached_class)
+      end
+      def self.new(
+        # The cursor to fetch entries after.
+        after: nil,
+        # The cursor to fetch entries before.
+        before: nil,
+        # Filter tenants by name.
+        name: nil,
+        # The number of items per page.
+        page_size: nil,
+        # Filter tenants by ID.
+        tenant_id: nil,
+        request_options: {}
+      ); end
+      sig do
+        override
+          .returns(
+            {
+              after: String,
+              before: String,
+              name: String,
+              page_size: Integer,
+              tenant_id: String,
+              request_options: Knockapi::RequestOptions
+            }
+          )
+      end
+      def to_hash; end
+    end
+  end
+end

data/rbi/knockapi/models/tenant_request.rbi

@@ -0,0 +1,168 @@
+# typed: strong
+
+module Knockapi
+  module Models
+    class TenantRequest < Knockapi::Internal::Type::BaseModel
+      # The unique identifier for the tenant.
+      sig { returns(String) }
+      attr_accessor :id
+
+      # A request to set channel data for a type of channel inline.
+      sig { returns(T.nilable(T::Hash[Symbol, Knockapi::Models::Recipients::ChannelDataRequest])) }
+      attr_accessor :channel_data
+
+      # Inline set preferences for a recipient, where the key is the preference set id.
+      sig { returns(T.nilable(T::Hash[Symbol, Knockapi::Models::Recipients::PreferenceSetRequest])) }
+      attr_accessor :preferences
+
+      # The settings for the tenant. Includes branding and preference set.
+      sig { returns(T.nilable(Knockapi::Models::TenantRequest::Settings)) }
+      attr_reader :settings
+
+      sig { params(settings: T.any(Knockapi::Models::TenantRequest::Settings, Knockapi::Internal::AnyHash)).void }
+      attr_writer :settings
+
+      # A tenant to be set in the system. You can supply any additional properties on
+      # the tenant object.
+      sig do
+        params(
+          id: String,
+          channel_data: T.nilable(
+            T::Hash[Symbol, T.any(Knockapi::Models::Recipients::ChannelDataRequest, Knockapi::Internal::AnyHash)]
+          ),
+          preferences: T.nilable(
+            T::Hash[Symbol, T.any(Knockapi::Models::Recipients::PreferenceSetRequest, Knockapi::Internal::AnyHash)]
+          ),
+          settings: T.any(Knockapi::Models::TenantRequest::Settings, Knockapi::Internal::AnyHash)
+        )
+          .returns(T.attached_class)
+      end
+      def self.new(
+        # The unique identifier for the tenant.
+        id:,
+        # A request to set channel data for a type of channel inline.
+        channel_data: nil,
+        # Inline set preferences for a recipient, where the key is the preference set id.
+        preferences: nil,
+        # The settings for the tenant. Includes branding and preference set.
+        settings: nil
+      ); end
+      sig do
+        override
+          .returns(
+            {
+              id: String,
+              channel_data: T.nilable(T::Hash[Symbol, Knockapi::Models::Recipients::ChannelDataRequest]),
+              preferences: T.nilable(T::Hash[Symbol, Knockapi::Models::Recipients::PreferenceSetRequest]),
+              settings: Knockapi::Models::TenantRequest::Settings
+            }
+          )
+      end
+      def to_hash; end
+
+      class Settings < Knockapi::Internal::Type::BaseModel
+        # The branding for the tenant.
+        sig { returns(T.nilable(Knockapi::Models::TenantRequest::Settings::Branding)) }
+        attr_reader :branding
+
+        sig do
+          params(branding: T.any(Knockapi::Models::TenantRequest::Settings::Branding, Knockapi::Internal::AnyHash))
+            .void
+        end
+        attr_writer :branding
+
+        # A request to set a preference set for a recipient.
+        sig { returns(T.nilable(Knockapi::Models::Recipients::PreferenceSetRequest)) }
+        attr_reader :preference_set
+
+        sig do
+          params(
+            preference_set: T.nilable(T.any(Knockapi::Models::Recipients::PreferenceSetRequest, Knockapi::Internal::AnyHash))
+          )
+            .void
+        end
+        attr_writer :preference_set
+
+        # The settings for the tenant. Includes branding and preference set.
+        sig do
+          params(
+            branding: T.any(Knockapi::Models::TenantRequest::Settings::Branding, Knockapi::Internal::AnyHash),
+            preference_set: T.nilable(T.any(Knockapi::Models::Recipients::PreferenceSetRequest, Knockapi::Internal::AnyHash))
+          )
+            .returns(T.attached_class)
+        end
+        def self.new(
+          # The branding for the tenant.
+          branding: nil,
+          # A request to set a preference set for a recipient.
+          preference_set: nil
+        ); end
+        sig do
+          override
+            .returns(
+              {
+                branding: Knockapi::Models::TenantRequest::Settings::Branding,
+                preference_set: T.nilable(Knockapi::Models::Recipients::PreferenceSetRequest)
+              }
+            )
+        end
+        def to_hash; end
+
+        class Branding < Knockapi::Internal::Type::BaseModel
+          # The icon URL for the tenant. Must point to a valid image with an image MIME
+          # type.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :icon_url
+
+          # The logo URL for the tenant. Must point to a valid image with an image MIME
+          # type.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :logo_url
+
+          # The primary color for the tenant, provided as a hex value.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :primary_color
+
+          # The primary color contrast for the tenant, provided as a hex value.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :primary_color_contrast
+
+          # The branding for the tenant.
+          sig do
+            params(
+              icon_url: T.nilable(String),
+              logo_url: T.nilable(String),
+              primary_color: T.nilable(String),
+              primary_color_contrast: T.nilable(String)
+            )
+              .returns(T.attached_class)
+          end
+          def self.new(
+            # The icon URL for the tenant. Must point to a valid image with an image MIME
+            # type.
+            icon_url: nil,
+            # The logo URL for the tenant. Must point to a valid image with an image MIME
+            # type.
+            logo_url: nil,
+            # The primary color for the tenant, provided as a hex value.
+            primary_color: nil,
+            # The primary color contrast for the tenant, provided as a hex value.
+            primary_color_contrast: nil
+          ); end
+          sig do
+            override
+              .returns(
+                {
+                  icon_url: T.nilable(String),
+                  logo_url: T.nilable(String),
+                  primary_color: T.nilable(String),
+                  primary_color_contrast: T.nilable(String)
+                }
+              )
+          end
+          def to_hash; end
+        end
+      end
+    end
+  end
+end

data/rbi/knockapi/models/tenant_set_params.rbi

@@ -0,0 +1,166 @@
+# typed: strong
+
+module Knockapi
+  module Models
+    class TenantSetParams < Knockapi::Internal::Type::BaseModel
+      extend Knockapi::Internal::Type::RequestParameters::Converter
+      include Knockapi::Internal::Type::RequestParameters
+
+      # A request to set channel data for a type of channel inline.
+      sig { returns(T.nilable(T::Hash[Symbol, Knockapi::Models::Recipients::ChannelDataRequest])) }
+      attr_accessor :channel_data
+
+      # Inline set preferences for a recipient, where the key is the preference set id.
+      sig { returns(T.nilable(T::Hash[Symbol, Knockapi::Models::Recipients::PreferenceSetRequest])) }
+      attr_accessor :preferences
+
+      # The settings for the tenant. Includes branding and preference set.
+      sig { returns(T.nilable(Knockapi::Models::TenantSetParams::Settings)) }
+      attr_reader :settings
+
+      sig { params(settings: T.any(Knockapi::Models::TenantSetParams::Settings, Knockapi::Internal::AnyHash)).void }
+      attr_writer :settings
+
+      sig do
+        params(
+          channel_data: T.nilable(
+            T::Hash[Symbol, T.any(Knockapi::Models::Recipients::ChannelDataRequest, Knockapi::Internal::AnyHash)]
+          ),
+          preferences: T.nilable(
+            T::Hash[Symbol, T.any(Knockapi::Models::Recipients::PreferenceSetRequest, Knockapi::Internal::AnyHash)]
+          ),
+          settings: T.any(Knockapi::Models::TenantSetParams::Settings, Knockapi::Internal::AnyHash),
+          request_options: T.any(Knockapi::RequestOptions, Knockapi::Internal::AnyHash)
+        )
+          .returns(T.attached_class)
+      end
+      def self.new(
+        # A request to set channel data for a type of channel inline.
+        channel_data: nil,
+        # Inline set preferences for a recipient, where the key is the preference set id.
+        preferences: nil,
+        # The settings for the tenant. Includes branding and preference set.
+        settings: nil,
+        request_options: {}
+      ); end
+      sig do
+        override
+          .returns(
+            {
+              channel_data: T.nilable(T::Hash[Symbol, Knockapi::Models::Recipients::ChannelDataRequest]),
+              preferences: T.nilable(T::Hash[Symbol, Knockapi::Models::Recipients::PreferenceSetRequest]),
+              settings: Knockapi::Models::TenantSetParams::Settings,
+              request_options: Knockapi::RequestOptions
+            }
+          )
+      end
+      def to_hash; end
+
+      class Settings < Knockapi::Internal::Type::BaseModel
+        # The branding for the tenant.
+        sig { returns(T.nilable(Knockapi::Models::TenantSetParams::Settings::Branding)) }
+        attr_reader :branding
+
+        sig do
+          params(
+            branding: T.any(Knockapi::Models::TenantSetParams::Settings::Branding, Knockapi::Internal::AnyHash)
+          )
+            .void
+        end
+        attr_writer :branding
+
+        # A request to set a preference set for a recipient.
+        sig { returns(T.nilable(Knockapi::Models::Recipients::PreferenceSetRequest)) }
+        attr_reader :preference_set
+
+        sig do
+          params(
+            preference_set: T.nilable(T.any(Knockapi::Models::Recipients::PreferenceSetRequest, Knockapi::Internal::AnyHash))
+          )
+            .void
+        end
+        attr_writer :preference_set
+
+        # The settings for the tenant. Includes branding and preference set.
+        sig do
+          params(
+            branding: T.any(Knockapi::Models::TenantSetParams::Settings::Branding, Knockapi::Internal::AnyHash),
+            preference_set: T.nilable(T.any(Knockapi::Models::Recipients::PreferenceSetRequest, Knockapi::Internal::AnyHash))
+          )
+            .returns(T.attached_class)
+        end
+        def self.new(
+          # The branding for the tenant.
+          branding: nil,
+          # A request to set a preference set for a recipient.
+          preference_set: nil
+        ); end
+        sig do
+          override
+            .returns(
+              {
+                branding: Knockapi::Models::TenantSetParams::Settings::Branding,
+                preference_set: T.nilable(Knockapi::Models::Recipients::PreferenceSetRequest)
+              }
+            )
+        end
+        def to_hash; end
+
+        class Branding < Knockapi::Internal::Type::BaseModel
+          # The icon URL for the tenant. Must point to a valid image with an image MIME
+          # type.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :icon_url
+
+          # The logo URL for the tenant. Must point to a valid image with an image MIME
+          # type.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :logo_url
+
+          # The primary color for the tenant, provided as a hex value.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :primary_color
+
+          # The primary color contrast for the tenant, provided as a hex value.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :primary_color_contrast
+
+          # The branding for the tenant.
+          sig do
+            params(
+              icon_url: T.nilable(String),
+              logo_url: T.nilable(String),
+              primary_color: T.nilable(String),
+              primary_color_contrast: T.nilable(String)
+            )
+              .returns(T.attached_class)
+          end
+          def self.new(
+            # The icon URL for the tenant. Must point to a valid image with an image MIME
+            # type.
+            icon_url: nil,
+            # The logo URL for the tenant. Must point to a valid image with an image MIME
+            # type.
+            logo_url: nil,
+            # The primary color for the tenant, provided as a hex value.
+            primary_color: nil,
+            # The primary color contrast for the tenant, provided as a hex value.
+            primary_color_contrast: nil
+          ); end
+          sig do
+            override
+              .returns(
+                {
+                  icon_url: T.nilable(String),
+                  logo_url: T.nilable(String),
+                  primary_color: T.nilable(String),
+                  primary_color_contrast: T.nilable(String)
+                }
+              )
+          end
+          def to_hash; end
+        end
+      end
+    end
+  end
+end

data/rbi/knockapi/models/tenants/bulk_delete_params.rbi

@@ -0,0 +1,31 @@
+# typed: strong
+
+module Knockapi
+  module Models
+    module Tenants
+      class BulkDeleteParams < Knockapi::Internal::Type::BaseModel
+        extend Knockapi::Internal::Type::RequestParameters::Converter
+        include Knockapi::Internal::Type::RequestParameters
+
+        # The IDs of the tenants to delete.
+        sig { returns(T::Array[String]) }
+        attr_accessor :tenant_ids
+
+        sig do
+          params(
+            tenant_ids: T::Array[String],
+            request_options: T.any(Knockapi::RequestOptions, Knockapi::Internal::AnyHash)
+          )
+            .returns(T.attached_class)
+        end
+        def self.new(
+          # The IDs of the tenants to delete.
+          tenant_ids:,
+          request_options: {}
+        ); end
+        sig { override.returns({tenant_ids: T::Array[String], request_options: Knockapi::RequestOptions}) }
+        def to_hash; end
+      end
+    end
+  end
+end

data/rbi/knockapi/models/tenants/bulk_set_params.rbi

@@ -0,0 +1,36 @@
+# typed: strong
+
+module Knockapi
+  module Models
+    module Tenants
+      class BulkSetParams < Knockapi::Internal::Type::BaseModel
+        extend Knockapi::Internal::Type::RequestParameters::Converter
+        include Knockapi::Internal::Type::RequestParameters
+
+        # The tenants to be upserted.
+        sig { returns(T::Array[T.any(String, Knockapi::Models::TenantRequest)]) }
+        attr_accessor :tenants
+
+        sig do
+          params(
+            tenants: T::Array[T.any(String, Knockapi::Models::TenantRequest, Knockapi::Internal::AnyHash)],
+            request_options: T.any(Knockapi::RequestOptions, Knockapi::Internal::AnyHash)
+          )
+            .returns(T.attached_class)
+        end
+        def self.new(
+          # The tenants to be upserted.
+          tenants:,
+          request_options: {}
+        ); end
+        sig do
+          override
+            .returns(
+              {tenants: T::Array[T.any(String, Knockapi::Models::TenantRequest)], request_options: Knockapi::RequestOptions}
+            )
+        end
+        def to_hash; end
+      end
+    end
+  end
+end