knockapi 0.6.1 → 1.0.0

data/rbi/knockapi/models/recipients/preference_set_request.rbi

@@ -0,0 +1,234 @@
+# typed: strong
+
+module Knockapi
+  module Models
+    module Recipients
+      class PreferenceSetRequest < Knockapi::Internal::Type::BaseModel
+        # An object where the key is the category and the values are the preference
+        # settings for that category.
+        sig do
+          returns(
+            T.nilable(
+              T::Hash[
+                Symbol,
+                T.any(
+                  T::Boolean,
+                  Knockapi::Models::Recipients::PreferenceSetRequest::Category::PreferenceSetWorkflowCategorySettingObject
+                )
+              ]
+            )
+          )
+        end
+        attr_accessor :categories
+
+        # Channel type preferences.
+        sig { returns(T.nilable(Knockapi::Models::Recipients::PreferenceSetChannelTypes)) }
+        attr_reader :channel_types
+
+        sig do
+          params(
+            channel_types: T.nilable(T.any(Knockapi::Models::Recipients::PreferenceSetChannelTypes, Knockapi::Internal::AnyHash))
+          )
+            .void
+        end
+        attr_writer :channel_types
+
+        # An object where the key is the workflow key and the values are the preference
+        # settings for that workflow.
+        sig do
+          returns(
+            T.nilable(
+              T::Hash[
+                Symbol,
+                T.any(
+                  T::Boolean,
+                  Knockapi::Models::Recipients::PreferenceSetRequest::Workflow::PreferenceSetWorkflowCategorySettingObject
+                )
+              ]
+            )
+          )
+        end
+        attr_accessor :workflows
+
+        # A request to set a preference set for a recipient.
+        sig do
+          params(
+            categories: T.nilable(
+              T::Hash[
+                Symbol,
+                T.any(
+                  T::Boolean,
+                  Knockapi::Models::Recipients::PreferenceSetRequest::Category::PreferenceSetWorkflowCategorySettingObject,
+                  Knockapi::Internal::AnyHash
+                )
+              ]
+            ),
+            channel_types: T.nilable(T.any(Knockapi::Models::Recipients::PreferenceSetChannelTypes, Knockapi::Internal::AnyHash)),
+            workflows: T.nilable(
+              T::Hash[
+                Symbol,
+                T.any(
+                  T::Boolean,
+                  Knockapi::Models::Recipients::PreferenceSetRequest::Workflow::PreferenceSetWorkflowCategorySettingObject,
+                  Knockapi::Internal::AnyHash
+                )
+              ]
+            )
+          )
+            .returns(T.attached_class)
+        end
+        def self.new(
+          # An object where the key is the category and the values are the preference
+          # settings for that category.
+          categories: nil,
+          # Channel type preferences.
+          channel_types: nil,
+          # An object where the key is the workflow key and the values are the preference
+          # settings for that workflow.
+          workflows: nil
+        ); end
+        sig do
+          override
+            .returns(
+              {
+                categories: T.nilable(
+                  T::Hash[
+                    Symbol,
+                    T.any(
+                      T::Boolean,
+                      Knockapi::Models::Recipients::PreferenceSetRequest::Category::PreferenceSetWorkflowCategorySettingObject
+                    )
+                  ]
+                ),
+                channel_types: T.nilable(Knockapi::Models::Recipients::PreferenceSetChannelTypes),
+                workflows: T.nilable(
+                  T::Hash[
+                    Symbol,
+                    T.any(
+                      T::Boolean,
+                      Knockapi::Models::Recipients::PreferenceSetRequest::Workflow::PreferenceSetWorkflowCategorySettingObject
+                    )
+                  ]
+                )
+              }
+            )
+        end
+        def to_hash; end
+
+        # Workflow or category preferences within a preference set
+        module Category
+          extend Knockapi::Internal::Type::Union
+
+          class PreferenceSetWorkflowCategorySettingObject < Knockapi::Internal::Type::BaseModel
+            # Channel type preferences.
+            sig { returns(T.nilable(Knockapi::Models::Recipients::PreferenceSetChannelTypes)) }
+            attr_reader :channel_types
+
+            sig do
+              params(
+                channel_types: T.nilable(T.any(Knockapi::Models::Recipients::PreferenceSetChannelTypes, Knockapi::Internal::AnyHash))
+              )
+                .void
+            end
+            attr_writer :channel_types
+
+            # A list of conditions to apply to a channel type.
+            sig { returns(T.nilable(T::Array[Knockapi::Models::Condition])) }
+            attr_accessor :conditions
+
+            # The settings object for a workflow or category, where you can specify channel
+            # types or conditions.
+            sig do
+              params(
+                channel_types: T.nilable(T.any(Knockapi::Models::Recipients::PreferenceSetChannelTypes, Knockapi::Internal::AnyHash)),
+                conditions: T.nilable(T::Array[T.any(Knockapi::Models::Condition, Knockapi::Internal::AnyHash)])
+              )
+                .returns(T.attached_class)
+            end
+            def self.new(
+              # Channel type preferences.
+              channel_types: nil,
+              # A list of conditions to apply to a channel type.
+              conditions: nil
+            ); end
+            sig do
+              override
+                .returns(
+                  {
+                    channel_types: T.nilable(Knockapi::Models::Recipients::PreferenceSetChannelTypes),
+                    conditions: T.nilable(T::Array[Knockapi::Models::Condition])
+                  }
+                )
+            end
+            def to_hash; end
+          end
+
+          sig do
+            override
+              .returns(
+                [T::Boolean, Knockapi::Models::Recipients::PreferenceSetRequest::Category::PreferenceSetWorkflowCategorySettingObject]
+              )
+          end
+          def self.variants; end
+        end
+
+        # Workflow or category preferences within a preference set
+        module Workflow
+          extend Knockapi::Internal::Type::Union
+
+          class PreferenceSetWorkflowCategorySettingObject < Knockapi::Internal::Type::BaseModel
+            # Channel type preferences.
+            sig { returns(T.nilable(Knockapi::Models::Recipients::PreferenceSetChannelTypes)) }
+            attr_reader :channel_types
+
+            sig do
+              params(
+                channel_types: T.nilable(T.any(Knockapi::Models::Recipients::PreferenceSetChannelTypes, Knockapi::Internal::AnyHash))
+              )
+                .void
+            end
+            attr_writer :channel_types
+
+            # A list of conditions to apply to a channel type.
+            sig { returns(T.nilable(T::Array[Knockapi::Models::Condition])) }
+            attr_accessor :conditions
+
+            # The settings object for a workflow or category, where you can specify channel
+            # types or conditions.
+            sig do
+              params(
+                channel_types: T.nilable(T.any(Knockapi::Models::Recipients::PreferenceSetChannelTypes, Knockapi::Internal::AnyHash)),
+                conditions: T.nilable(T::Array[T.any(Knockapi::Models::Condition, Knockapi::Internal::AnyHash)])
+              )
+                .returns(T.attached_class)
+            end
+            def self.new(
+              # Channel type preferences.
+              channel_types: nil,
+              # A list of conditions to apply to a channel type.
+              conditions: nil
+            ); end
+            sig do
+              override
+                .returns(
+                  {
+                    channel_types: T.nilable(Knockapi::Models::Recipients::PreferenceSetChannelTypes),
+                    conditions: T.nilable(T::Array[Knockapi::Models::Condition])
+                  }
+                )
+            end
+            def to_hash; end
+          end
+
+          sig do
+            override
+              .returns(
+                [T::Boolean, Knockapi::Models::Recipients::PreferenceSetRequest::Workflow::PreferenceSetWorkflowCategorySettingObject]
+              )
+          end
+          def self.variants; end
+        end
+      end
+    end
+  end
+end

data/rbi/knockapi/models/recipients/push_channel_data.rbi

@@ -0,0 +1,22 @@
+# typed: strong
+
+module Knockapi
+  module Models
+    module Recipients
+      class PushChannelData < Knockapi::Internal::Type::BaseModel
+        # A list of push channel tokens.
+        sig { returns(T::Array[String]) }
+        attr_accessor :tokens
+
+        # The content of a push notification.
+        sig { params(tokens: T::Array[String]).returns(T.attached_class) }
+        def self.new(
+          # A list of push channel tokens.
+          tokens:
+        ); end
+        sig { override.returns({tokens: T::Array[String]}) }
+        def to_hash; end
+      end
+    end
+  end
+end

data/rbi/knockapi/models/recipients/slack_channel_data.rbi

@@ -0,0 +1,154 @@
+# typed: strong
+
+module Knockapi
+  module Models
+    module Recipients
+      class SlackChannelData < Knockapi::Internal::Type::BaseModel
+        # List of Slack channel connections.
+        sig do
+          returns(
+            T::Array[
+              T.any(
+                Knockapi::Models::Recipients::SlackChannelData::Connection::SlackTokenConnection,
+                Knockapi::Models::Recipients::SlackChannelData::Connection::SlackIncomingWebhookConnection
+              )
+            ]
+          )
+        end
+        attr_accessor :connections
+
+        # A Slack connection token.
+        sig { returns(T.nilable(Knockapi::Models::Recipients::SlackChannelData::Token)) }
+        attr_reader :token
+
+        sig do
+          params(
+            token: T.nilable(T.any(Knockapi::Models::Recipients::SlackChannelData::Token, Knockapi::Internal::AnyHash))
+          )
+            .void
+        end
+        attr_writer :token
+
+        # Slack channel data
+        sig do
+          params(
+            connections: T::Array[
+              T.any(
+                Knockapi::Models::Recipients::SlackChannelData::Connection::SlackTokenConnection,
+                Knockapi::Internal::AnyHash,
+                Knockapi::Models::Recipients::SlackChannelData::Connection::SlackIncomingWebhookConnection
+              )
+            ],
+            token: T.nilable(T.any(Knockapi::Models::Recipients::SlackChannelData::Token, Knockapi::Internal::AnyHash))
+          )
+            .returns(T.attached_class)
+        end
+        def self.new(
+          # List of Slack channel connections.
+          connections:,
+          # A Slack connection token.
+          token: nil
+        ); end
+        sig do
+          override
+            .returns(
+              {
+                connections: T::Array[
+                  T.any(
+                    Knockapi::Models::Recipients::SlackChannelData::Connection::SlackTokenConnection,
+                    Knockapi::Models::Recipients::SlackChannelData::Connection::SlackIncomingWebhookConnection
+                  )
+                ],
+                token: T.nilable(Knockapi::Models::Recipients::SlackChannelData::Token)
+              }
+            )
+        end
+        def to_hash; end
+
+        # A Slack connection, either an access token or an incoming webhook
+        module Connection
+          extend Knockapi::Internal::Type::Union
+
+          class SlackTokenConnection < Knockapi::Internal::Type::BaseModel
+            # A Slack access token.
+            sig { returns(T.nilable(String)) }
+            attr_accessor :access_token
+
+            # A Slack channel ID from the Slack provider.
+            sig { returns(T.nilable(String)) }
+            attr_accessor :channel_id
+
+            # A Slack user ID from the Slack provider.
+            sig { returns(T.nilable(String)) }
+            attr_accessor :user_id
+
+            # A Slack connection token.
+            sig do
+              params(
+                access_token: T.nilable(String),
+                channel_id: T.nilable(String),
+                user_id: T.nilable(String)
+              )
+                .returns(T.attached_class)
+            end
+            def self.new(
+              # A Slack access token.
+              access_token: nil,
+              # A Slack channel ID from the Slack provider.
+              channel_id: nil,
+              # A Slack user ID from the Slack provider.
+              user_id: nil
+            ); end
+            sig do
+              override
+                .returns({
+                           access_token: T.nilable(String),
+                           channel_id: T.nilable(String),
+                           user_id: T.nilable(String)
+                         })
+            end
+            def to_hash; end
+          end
+
+          class SlackIncomingWebhookConnection < Knockapi::Internal::Type::BaseModel
+            # The URL of the incoming webhook for a Slack connection.
+            sig { returns(String) }
+            attr_accessor :url
+
+            # A Slack connection incoming webhook.
+            sig { params(url: String).returns(T.attached_class) }
+            def self.new(
+              # The URL of the incoming webhook for a Slack connection.
+              url:
+            ); end
+            sig { override.returns({url: String}) }
+            def to_hash; end
+          end
+
+          sig do
+            override
+              .returns(
+                [Knockapi::Models::Recipients::SlackChannelData::Connection::SlackTokenConnection, Knockapi::Models::Recipients::SlackChannelData::Connection::SlackIncomingWebhookConnection]
+              )
+          end
+          def self.variants; end
+        end
+
+        class Token < Knockapi::Internal::Type::BaseModel
+          # A Slack access token.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :access_token
+
+          # A Slack connection token.
+          sig { params(access_token: T.nilable(String)).returns(T.attached_class) }
+          def self.new(
+            # A Slack access token.
+            access_token:
+          ); end
+          sig { override.returns({access_token: T.nilable(String)}) }
+          def to_hash; end
+        end
+      end
+    end
+  end
+end

data/rbi/knockapi/models/recipients/subscription.rbi

@@ -0,0 +1,77 @@
+# typed: strong
+
+module Knockapi
+  module Models
+    module Recipients
+      class Subscription < Knockapi::Internal::Type::BaseModel
+        # The typename of the schema.
+        sig { returns(String) }
+        attr_accessor :_typename
+
+        # Timestamp when the resource was created.
+        sig { returns(Time) }
+        attr_accessor :inserted_at
+
+        # A custom [Object](/concepts/objects) entity which belongs to a collection.
+        sig { returns(Knockapi::Models::Object) }
+        attr_reader :object
+
+        sig { params(object: T.any(Knockapi::Models::Object, Knockapi::Internal::AnyHash)).void }
+        attr_writer :object
+
+        # A recipient of a notification, which is either a user or an object.
+        sig { returns(T.any(Knockapi::Models::User, Knockapi::Models::Object)) }
+        attr_accessor :recipient
+
+        # The timestamp when the resource was last updated.
+        sig { returns(Time) }
+        attr_accessor :updated_at
+
+        # The custom properties associated with the subscription relationship.
+        sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
+        attr_accessor :properties
+
+        # A subscription object.
+        sig do
+          params(
+            _typename: String,
+            inserted_at: Time,
+            object: T.any(Knockapi::Models::Object, Knockapi::Internal::AnyHash),
+            recipient: T.any(Knockapi::Models::User, Knockapi::Internal::AnyHash, Knockapi::Models::Object),
+            updated_at: Time,
+            properties: T.nilable(T::Hash[Symbol, T.anything])
+          )
+            .returns(T.attached_class)
+        end
+        def self.new(
+          # The typename of the schema.
+          _typename:,
+          # Timestamp when the resource was created.
+          inserted_at:,
+          # A custom [Object](/concepts/objects) entity which belongs to a collection.
+          object:,
+          # A recipient of a notification, which is either a user or an object.
+          recipient:,
+          # The timestamp when the resource was last updated.
+          updated_at:,
+          # The custom properties associated with the subscription relationship.
+          properties: nil
+        ); end
+        sig do
+          override
+            .returns(
+              {
+                _typename: String,
+                inserted_at: Time,
+                object: Knockapi::Models::Object,
+                recipient: T.any(Knockapi::Models::User, Knockapi::Models::Object),
+                updated_at: Time,
+                properties: T.nilable(T::Hash[Symbol, T.anything])
+              }
+            )
+        end
+        def to_hash; end
+      end
+    end
+  end
+end

data/rbi/knockapi/models/schedule.rbi

@@ -0,0 +1,127 @@
+# typed: strong
+
+module Knockapi
+  module Models
+    class Schedule < Knockapi::Internal::Type::BaseModel
+      # Unique identifier for the schedule.
+      sig { returns(String) }
+      attr_accessor :id
+
+      # Timestamp when the resource was created.
+      sig { returns(Time) }
+      attr_accessor :inserted_at
+
+      # A recipient of a notification, which is either a user or an object.
+      sig { returns(T.any(Knockapi::Models::User, Knockapi::Models::Object)) }
+      attr_accessor :recipient
+
+      # The repeat rule for the schedule.
+      sig { returns(T::Array[Knockapi::Models::ScheduleRepeatRule]) }
+      attr_accessor :repeats
+
+      # The timestamp when the resource was last updated.
+      sig { returns(Time) }
+      attr_accessor :updated_at
+
+      # The workflow the schedule is applied to.
+      sig { returns(String) }
+      attr_accessor :workflow
+
+      # The typename of the schema.
+      sig { returns(T.nilable(String)) }
+      attr_reader :_typename
+
+      sig { params(_typename: String).void }
+      attr_writer :_typename
+
+      # A recipient of a notification, which is either a user or an object.
+      sig { returns(T.nilable(T.any(Knockapi::Models::User, Knockapi::Models::Object))) }
+      attr_accessor :actor
+
+      # An optional map of data to pass into the workflow execution.
+      sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
+      attr_accessor :data
+
+      # The last occurrence of the schedule.
+      sig { returns(T.nilable(Time)) }
+      attr_accessor :last_occurrence_at
+
+      # The next occurrence of the schedule.
+      sig { returns(T.nilable(Time)) }
+      attr_accessor :next_occurrence_at
+
+      # The tenant to trigger the workflow for. Triggering with a tenant will use any
+      # tenant-level overrides associated with the tenant object, and all messages
+      # produced from workflow runs will be tagged with the tenant.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :tenant
+
+      # A schedule represents a recurring workflow execution.
+      sig do
+        params(
+          id: String,
+          inserted_at: Time,
+          recipient: T.any(Knockapi::Models::User, Knockapi::Internal::AnyHash, Knockapi::Models::Object),
+          repeats: T::Array[T.any(Knockapi::Models::ScheduleRepeatRule, Knockapi::Internal::AnyHash)],
+          updated_at: Time,
+          workflow: String,
+          _typename: String,
+          actor: T.nilable(T.any(Knockapi::Models::User, Knockapi::Internal::AnyHash, Knockapi::Models::Object)),
+          data: T.nilable(T::Hash[Symbol, T.anything]),
+          last_occurrence_at: T.nilable(Time),
+          next_occurrence_at: T.nilable(Time),
+          tenant: T.nilable(String)
+        )
+          .returns(T.attached_class)
+      end
+      def self.new(
+        # Unique identifier for the schedule.
+        id:,
+        # Timestamp when the resource was created.
+        inserted_at:,
+        # A recipient of a notification, which is either a user or an object.
+        recipient:,
+        # The repeat rule for the schedule.
+        repeats:,
+        # The timestamp when the resource was last updated.
+        updated_at:,
+        # The workflow the schedule is applied to.
+        workflow:,
+        # The typename of the schema.
+        _typename: nil,
+        # A recipient of a notification, which is either a user or an object.
+        actor: nil,
+        # An optional map of data to pass into the workflow execution.
+        data: nil,
+        # The last occurrence of the schedule.
+        last_occurrence_at: nil,
+        # The next occurrence of the schedule.
+        next_occurrence_at: nil,
+        # The tenant to trigger the workflow for. Triggering with a tenant will use any
+        # tenant-level overrides associated with the tenant object, and all messages
+        # produced from workflow runs will be tagged with the tenant.
+        tenant: nil
+      ); end
+      sig do
+        override
+          .returns(
+            {
+              id: String,
+              inserted_at: Time,
+              recipient: T.any(Knockapi::Models::User, Knockapi::Models::Object),
+              repeats: T::Array[Knockapi::Models::ScheduleRepeatRule],
+              updated_at: Time,
+              workflow: String,
+              _typename: String,
+              actor: T.nilable(T.any(Knockapi::Models::User, Knockapi::Models::Object)),
+              data: T.nilable(T::Hash[Symbol, T.anything]),
+              last_occurrence_at: T.nilable(Time),
+              next_occurrence_at: T.nilable(Time),
+              tenant: T.nilable(String)
+            }
+          )
+      end
+      def to_hash; end
+    end
+  end
+end