knockapi 0.6.1 → 1.1.0

data/rbi/knockapi/models/tenant_set_params.rbi

@@ -0,0 +1,241 @@
+# typed: strong
+
+module Knockapi
+  module Models
+    class TenantSetParams < Knockapi::Internal::Type::BaseModel
+      extend Knockapi::Internal::Type::RequestParameters::Converter
+      include Knockapi::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Knockapi::TenantSetParams, Knockapi::Internal::AnyHash)
+        end
+
+      # 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::TenantSetParams::Settings)) }
+      attr_reader :settings
+
+      sig { params(settings: Knockapi::TenantSetParams::Settings::OrHash).void }
+      attr_writer :settings
+
+      sig do
+        params(
+          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::TenantSetParams::Settings::OrHash,
+          request_options: Knockapi::RequestOptions::OrHash
+        ).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,
+                  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::TenantSetParams::Settings,
+            request_options: Knockapi::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Settings < Knockapi::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Knockapi::TenantSetParams::Settings,
+              Knockapi::Internal::AnyHash
+            )
+          end
+
+        # The branding for the tenant.
+        sig do
+          returns(T.nilable(Knockapi::TenantSetParams::Settings::Branding))
+        end
+        attr_reader :branding
+
+        sig do
+          params(
+            branding: Knockapi::TenantSetParams::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::TenantSetParams::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::TenantSetParams::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::TenantSetParams::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/tenants/bulk_delete_params.rbi

@@ -0,0 +1,48 @@
+# 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
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Knockapi::Tenants::BulkDeleteParams,
+              Knockapi::Internal::AnyHash
+            )
+          end
+
+        # 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: Knockapi::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The IDs of the tenants to delete.
+          tenant_ids:,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              tenant_ids: T::Array[String],
+              request_options: Knockapi::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,45 @@
+# 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
+
+        OrHash =
+          T.type_alias do
+            T.any(Knockapi::Tenants::BulkSetParams, Knockapi::Internal::AnyHash)
+          end
+
+        # The tenants to be upserted.
+        sig { returns(T::Array[T.any(String, Knockapi::TenantRequest)]) }
+        attr_accessor :tenants
+
+        sig do
+          params(
+            tenants: T::Array[T.any(String, Knockapi::TenantRequest::OrHash)],
+            request_options: Knockapi::RequestOptions::OrHash
+          ).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::TenantRequest)],
+              request_options: Knockapi::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/knockapi/models/user.rbi

@@ -0,0 +1,110 @@
+# typed: strong
+
+module Knockapi
+  module Models
+    class User < Knockapi::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias { T.any(Knockapi::User, Knockapi::Internal::AnyHash) }
+
+      # The ID for the user that you set when identifying them in Knock.
+      sig { returns(String) }
+      attr_accessor :id
+
+      # The typename of the schema.
+      sig { returns(String) }
+      attr_accessor :_typename
+
+      # The timestamp when the resource was last updated.
+      sig { returns(Time) }
+      attr_accessor :updated_at
+
+      # URL to the user's avatar image.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :avatar
+
+      # The creation date of the user from your system.
+      sig { returns(T.nilable(Time)) }
+      attr_accessor :created_at
+
+      # The primary email address for the user.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :email
+
+      # Display name of the user.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :name
+
+      # The [E.164](https://www.twilio.com/docs/glossary/what-e164) phone number of the
+      # user (required for SMS channels).
+      sig { returns(T.nilable(String)) }
+      attr_accessor :phone_number
+
+      # The timezone of the user. Must be a
+      # valid [tz database time zone string](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).
+      # Used
+      # for [recurring schedules](/concepts/schedules#scheduling-workflows-with-recurring-schedules-for-recipients).
+      sig { returns(T.nilable(String)) }
+      attr_accessor :timezone
+
+      # A [User](/concepts/users) represents an individual in your system who can
+      # receive notifications through Knock. Users are the most common recipients of
+      # notifications and are always referenced by your internal identifier.
+      sig do
+        params(
+          id: String,
+          _typename: String,
+          updated_at: Time,
+          avatar: T.nilable(String),
+          created_at: T.nilable(Time),
+          email: T.nilable(String),
+          name: T.nilable(String),
+          phone_number: T.nilable(String),
+          timezone: T.nilable(String)
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The ID for the user that you set when identifying them in Knock.
+        id:,
+        # The typename of the schema.
+        _typename:,
+        # The timestamp when the resource was last updated.
+        updated_at:,
+        # URL to the user's avatar image.
+        avatar: nil,
+        # The creation date of the user from your system.
+        created_at: nil,
+        # The primary email address for the user.
+        email: nil,
+        # Display name of the user.
+        name: nil,
+        # The [E.164](https://www.twilio.com/docs/glossary/what-e164) phone number of the
+        # user (required for SMS channels).
+        phone_number: nil,
+        # The timezone of the user. Must be a
+        # valid [tz database time zone string](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).
+        # Used
+        # for [recurring schedules](/concepts/schedules#scheduling-workflows-with-recurring-schedules-for-recipients).
+        timezone: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            _typename: String,
+            updated_at: Time,
+            avatar: T.nilable(String),
+            created_at: T.nilable(Time),
+            email: T.nilable(String),
+            name: T.nilable(String),
+            phone_number: T.nilable(String),
+            timezone: T.nilable(String)
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/knockapi/models/user_delete_params.rbi

@@ -0,0 +1,27 @@
+# typed: strong
+
+module Knockapi
+  module Models
+    class UserDeleteParams < Knockapi::Internal::Type::BaseModel
+      extend Knockapi::Internal::Type::RequestParameters::Converter
+      include Knockapi::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Knockapi::UserDeleteParams, 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/user_delete_response.rbi

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

data/rbi/knockapi/models/user_get_channel_data_params.rbi

@@ -0,0 +1,27 @@
+# typed: strong
+
+module Knockapi
+  module Models
+    class UserGetChannelDataParams < Knockapi::Internal::Type::BaseModel
+      extend Knockapi::Internal::Type::RequestParameters::Converter
+      include Knockapi::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Knockapi::UserGetChannelDataParams, 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/user_get_params.rbi

@@ -0,0 +1,27 @@
+# typed: strong
+
+module Knockapi
+  module Models
+    class UserGetParams < Knockapi::Internal::Type::BaseModel
+      extend Knockapi::Internal::Type::RequestParameters::Converter
+      include Knockapi::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Knockapi::UserGetParams, 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/user_get_preferences_params.rbi

@@ -0,0 +1,43 @@
+# typed: strong
+
+module Knockapi
+  module Models
+    class UserGetPreferencesParams < Knockapi::Internal::Type::BaseModel
+      extend Knockapi::Internal::Type::RequestParameters::Converter
+      include Knockapi::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Knockapi::UserGetPreferencesParams, Knockapi::Internal::AnyHash)
+        end
+
+      # The unique identifier for the tenant.
+      sig { returns(T.nilable(String)) }
+      attr_reader :tenant
+
+      sig { params(tenant: String).void }
+      attr_writer :tenant
+
+      sig do
+        params(
+          tenant: String,
+          request_options: Knockapi::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The unique identifier for the tenant.
+        tenant: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          { tenant: String, request_options: Knockapi::RequestOptions }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end