knockapi 0.6.1 → 1.1.0

data/rbi/knockapi/models/tenant.rbi

@@ -0,0 +1,188 @@
+# typed: strong
+
+module Knockapi
+  module Models
+    class Tenant < Knockapi::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias { T.any(Knockapi::Tenant, Knockapi::Internal::AnyHash) }
+
+      # 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::Tenant::Settings)) }
+      attr_reader :settings
+
+      sig do
+        params(settings: T.nilable(Knockapi::Tenant::Settings::OrHash)).void
+      end
+      attr_writer :settings
+
+      # A tenant entity.
+      sig do
+        params(
+          id: String,
+          _typename: String,
+          name: T.nilable(String),
+          settings: T.nilable(Knockapi::Tenant::Settings::OrHash)
+        ).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::Tenant::Settings)
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Settings < Knockapi::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(Knockapi::Tenant::Settings, Knockapi::Internal::AnyHash)
+          end
+
+        # The branding for the tenant.
+        sig { returns(T.nilable(Knockapi::Tenant::Settings::Branding)) }
+        attr_reader :branding
+
+        sig do
+          params(
+            branding: T.nilable(Knockapi::Tenant::Settings::Branding::OrHash)
+          ).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::Recipients::PreferenceSet)) }
+        attr_reader :preference_set
+
+        sig do
+          params(
+            preference_set:
+              T.nilable(Knockapi::Recipients::PreferenceSet::OrHash)
+          ).void
+        end
+        attr_writer :preference_set
+
+        # The settings for the tenant. Includes branding and preference set.
+        sig do
+          params(
+            branding: T.nilable(Knockapi::Tenant::Settings::Branding::OrHash),
+            preference_set:
+              T.nilable(Knockapi::Recipients::PreferenceSet::OrHash)
+          ).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::Tenant::Settings::Branding),
+              preference_set: T.nilable(Knockapi::Recipients::PreferenceSet)
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class Branding < Knockapi::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Knockapi::Tenant::Settings::Branding,
+                Knockapi::Internal::AnyHash
+              )
+            end
+
+          # 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,27 @@
+# typed: strong
+
+module Knockapi
+  module Models
+    class TenantDeleteParams < Knockapi::Internal::Type::BaseModel
+      extend Knockapi::Internal::Type::RequestParameters::Converter
+      include Knockapi::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Knockapi::TenantDeleteParams, Knockapi::Internal::AnyHash)
+        end
+
+      sig do
+        params(request_options: Knockapi::RequestOptions::OrHash).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_delete_response.rbi

@@ -0,0 +1,7 @@
+# typed: strong
+
+module Knockapi
+  module Models
+    TenantDeleteResponse = String
+  end
+end

data/rbi/knockapi/models/tenant_get_params.rbi

@@ -0,0 +1,27 @@
+# typed: strong
+
+module Knockapi
+  module Models
+    class TenantGetParams < Knockapi::Internal::Type::BaseModel
+      extend Knockapi::Internal::Type::RequestParameters::Converter
+      include Knockapi::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Knockapi::TenantGetParams, Knockapi::Internal::AnyHash)
+        end
+
+      sig do
+        params(request_options: Knockapi::RequestOptions::OrHash).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,90 @@
+# typed: strong
+
+module Knockapi
+  module Models
+    class TenantListParams < Knockapi::Internal::Type::BaseModel
+      extend Knockapi::Internal::Type::RequestParameters::Converter
+      include Knockapi::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Knockapi::TenantListParams, Knockapi::Internal::AnyHash)
+        end
+
+      # 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: Knockapi::RequestOptions::OrHash
+        ).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,243 @@
+# typed: strong
+
+module Knockapi
+  module Models
+    class TenantRequest < Knockapi::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Knockapi::TenantRequest, Knockapi::Internal::AnyHash)
+        end
+
+      # 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 do
+        returns(
+          T.nilable(
+            T::Hash[
+              Symbol,
+              T.any(
+                Knockapi::Recipients::PushChannelData,
+                Knockapi::Recipients::OneSignalChannelData,
+                Knockapi::Recipients::SlackChannelData,
+                Knockapi::Recipients::MsTeamsChannelData,
+                Knockapi::Recipients::DiscordChannelData
+              )
+            ]
+          )
+        )
+      end
+      attr_accessor :channel_data
+
+      # Inline set preferences for a recipient, where the key is the preference set id.
+      sig do
+        returns(
+          T.nilable(T::Hash[Symbol, Knockapi::Recipients::PreferenceSetRequest])
+        )
+      end
+      attr_accessor :preferences
+
+      # The settings for the tenant. Includes branding and preference set.
+      sig { returns(T.nilable(Knockapi::TenantRequest::Settings)) }
+      attr_reader :settings
+
+      sig { params(settings: Knockapi::TenantRequest::Settings::OrHash).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::Recipients::PushChannelData::OrHash,
+                  Knockapi::Recipients::OneSignalChannelData::OrHash,
+                  Knockapi::Recipients::SlackChannelData::OrHash,
+                  Knockapi::Recipients::MsTeamsChannelData::OrHash,
+                  Knockapi::Recipients::DiscordChannelData::OrHash
+                )
+              ]
+            ),
+          preferences:
+            T.nilable(
+              T::Hash[
+                Symbol,
+                Knockapi::Recipients::PreferenceSetRequest::OrHash
+              ]
+            ),
+          settings: Knockapi::TenantRequest::Settings::OrHash
+        ).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,
+                  T.any(
+                    Knockapi::Recipients::PushChannelData,
+                    Knockapi::Recipients::OneSignalChannelData,
+                    Knockapi::Recipients::SlackChannelData,
+                    Knockapi::Recipients::MsTeamsChannelData,
+                    Knockapi::Recipients::DiscordChannelData
+                  )
+                ]
+              ),
+            preferences:
+              T.nilable(
+                T::Hash[Symbol, Knockapi::Recipients::PreferenceSetRequest]
+              ),
+            settings: Knockapi::TenantRequest::Settings
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Settings < Knockapi::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Knockapi::TenantRequest::Settings,
+              Knockapi::Internal::AnyHash
+            )
+          end
+
+        # The branding for the tenant.
+        sig { returns(T.nilable(Knockapi::TenantRequest::Settings::Branding)) }
+        attr_reader :branding
+
+        sig do
+          params(
+            branding: Knockapi::TenantRequest::Settings::Branding::OrHash
+          ).void
+        end
+        attr_writer :branding
+
+        # A request to set a preference set for a recipient.
+        sig { returns(T.nilable(Knockapi::Recipients::PreferenceSetRequest)) }
+        attr_reader :preference_set
+
+        sig do
+          params(
+            preference_set:
+              T.nilable(Knockapi::Recipients::PreferenceSetRequest::OrHash)
+          ).void
+        end
+        attr_writer :preference_set
+
+        # The settings for the tenant. Includes branding and preference set.
+        sig do
+          params(
+            branding: Knockapi::TenantRequest::Settings::Branding::OrHash,
+            preference_set:
+              T.nilable(Knockapi::Recipients::PreferenceSetRequest::OrHash)
+          ).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::TenantRequest::Settings::Branding,
+              preference_set:
+                T.nilable(Knockapi::Recipients::PreferenceSetRequest)
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class Branding < Knockapi::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Knockapi::TenantRequest::Settings::Branding,
+                Knockapi::Internal::AnyHash
+              )
+            end
+
+          # 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