knockapi 0.6.1 → 1.1.0

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

@@ -0,0 +1,33 @@
+# typed: strong
+
+module Knockapi
+  module Models
+    module Recipients
+      class PushChannelData < Knockapi::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Knockapi::Recipients::PushChannelData,
+              Knockapi::Internal::AnyHash
+            )
+          end
+
+        # 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,212 @@
+# typed: strong
+
+module Knockapi
+  module Models
+    module Recipients
+      class SlackChannelData < Knockapi::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Knockapi::Recipients::SlackChannelData,
+              Knockapi::Internal::AnyHash
+            )
+          end
+
+        # List of Slack channel connections.
+        sig do
+          returns(
+            T::Array[
+              T.any(
+                Knockapi::Recipients::SlackChannelData::Connection::SlackTokenConnection,
+                Knockapi::Recipients::SlackChannelData::Connection::SlackIncomingWebhookConnection
+              )
+            ]
+          )
+        end
+        attr_accessor :connections
+
+        # A Slack connection token.
+        sig do
+          returns(T.nilable(Knockapi::Recipients::SlackChannelData::Token))
+        end
+        attr_reader :token
+
+        sig do
+          params(
+            token:
+              T.nilable(Knockapi::Recipients::SlackChannelData::Token::OrHash)
+          ).void
+        end
+        attr_writer :token
+
+        # Slack channel data
+        sig do
+          params(
+            connections:
+              T::Array[
+                T.any(
+                  Knockapi::Recipients::SlackChannelData::Connection::SlackTokenConnection::OrHash,
+                  Knockapi::Recipients::SlackChannelData::Connection::SlackIncomingWebhookConnection::OrHash
+                )
+              ],
+            token:
+              T.nilable(Knockapi::Recipients::SlackChannelData::Token::OrHash)
+          ).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::Recipients::SlackChannelData::Connection::SlackTokenConnection,
+                    Knockapi::Recipients::SlackChannelData::Connection::SlackIncomingWebhookConnection
+                  )
+                ],
+              token: T.nilable(Knockapi::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
+
+          Variants =
+            T.type_alias do
+              T.any(
+                Knockapi::Recipients::SlackChannelData::Connection::SlackTokenConnection,
+                Knockapi::Recipients::SlackChannelData::Connection::SlackIncomingWebhookConnection
+              )
+            end
+
+          class SlackTokenConnection < Knockapi::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  Knockapi::Recipients::SlackChannelData::Connection::SlackTokenConnection,
+                  Knockapi::Internal::AnyHash
+                )
+              end
+
+            # 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
+            OrHash =
+              T.type_alias do
+                T.any(
+                  Knockapi::Recipients::SlackChannelData::Connection::SlackIncomingWebhookConnection,
+                  Knockapi::Internal::AnyHash
+                )
+              end
+
+            # 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(
+              T::Array[
+                Knockapi::Recipients::SlackChannelData::Connection::Variants
+              ]
+            )
+          end
+          def self.variants
+          end
+        end
+
+        class Token < Knockapi::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Knockapi::Recipients::SlackChannelData::Token,
+                Knockapi::Internal::AnyHash
+              )
+            end
+
+          # A Slack access token.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :access_token
+
+          # A Slack connection token.
+          sig do
+            params(access_token: T.nilable(String)).returns(T.attached_class)
+          end
+          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,86 @@
+# typed: strong
+
+module Knockapi
+  module Models
+    module Recipients
+      class Subscription < Knockapi::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Knockapi::Recipients::Subscription,
+              Knockapi::Internal::AnyHash
+            )
+          end
+
+        # 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::Object) }
+        attr_reader :object
+
+        sig { params(object: Knockapi::Object::OrHash).void }
+        attr_writer :object
+
+        # A recipient of a notification, which is either a user or an object.
+        sig { returns(T.any(Knockapi::User, Knockapi::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: Knockapi::Object::OrHash,
+            recipient: T.any(Knockapi::User::OrHash, Knockapi::Object::OrHash),
+            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::Object,
+              recipient: T.any(Knockapi::User, Knockapi::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,132 @@
+# typed: strong
+
+module Knockapi
+  module Models
+    class Schedule < Knockapi::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias { T.any(Knockapi::Schedule, Knockapi::Internal::AnyHash) }
+
+      # 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::User, Knockapi::Object)) }
+      attr_accessor :recipient
+
+      # The repeat rule for the schedule.
+      sig { returns(T::Array[Knockapi::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::User, Knockapi::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::User::OrHash, Knockapi::Object::OrHash),
+          repeats: T::Array[Knockapi::ScheduleRepeatRule::OrHash],
+          updated_at: Time,
+          workflow: String,
+          _typename: String,
+          actor:
+            T.nilable(T.any(Knockapi::User::OrHash, Knockapi::Object::OrHash)),
+          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::User, Knockapi::Object),
+            repeats: T::Array[Knockapi::ScheduleRepeatRule],
+            updated_at: Time,
+            workflow: String,
+            _typename: String,
+            actor: T.nilable(T.any(Knockapi::User, Knockapi::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

data/rbi/knockapi/models/schedule_create_params.rbi

@@ -0,0 +1,115 @@
+# typed: strong
+
+module Knockapi
+  module Models
+    class ScheduleCreateParams < Knockapi::Internal::Type::BaseModel
+      extend Knockapi::Internal::Type::RequestParameters::Converter
+      include Knockapi::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Knockapi::ScheduleCreateParams, Knockapi::Internal::AnyHash)
+        end
+
+      # The recipients to set the schedule for. Limited to 100 recipients per request.
+      sig do
+        returns(
+          T::Array[
+            T.any(
+              String,
+              Knockapi::InlineIdentifyUserRequest,
+              Knockapi::InlineObjectRequest
+            )
+          ]
+        )
+      end
+      attr_accessor :recipients
+
+      # The repeat rule for the schedule.
+      sig { returns(T::Array[Knockapi::ScheduleRepeatRule]) }
+      attr_accessor :repeats
+
+      # The key of the workflow.
+      sig { returns(String) }
+      attr_accessor :workflow
+
+      # An optional map of data to pass into the workflow execution.
+      sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
+      attr_accessor :data
+
+      # The ending date and time for the schedule.
+      sig { returns(T.nilable(Time)) }
+      attr_accessor :ending_at
+
+      # The starting date and time for the schedule.
+      sig { returns(T.nilable(Time)) }
+      attr_accessor :scheduled_at
+
+      # An request to set a tenant inline.
+      sig { returns(T.nilable(T.any(String, Knockapi::TenantRequest))) }
+      attr_accessor :tenant
+
+      sig do
+        params(
+          recipients:
+            T::Array[
+              T.any(
+                String,
+                Knockapi::InlineIdentifyUserRequest::OrHash,
+                Knockapi::InlineObjectRequest::OrHash
+              )
+            ],
+          repeats: T::Array[Knockapi::ScheduleRepeatRule::OrHash],
+          workflow: String,
+          data: T.nilable(T::Hash[Symbol, T.anything]),
+          ending_at: T.nilable(Time),
+          scheduled_at: T.nilable(Time),
+          tenant: T.nilable(T.any(String, Knockapi::TenantRequest::OrHash)),
+          request_options: Knockapi::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The recipients to set the schedule for. Limited to 100 recipients per request.
+        recipients:,
+        # The repeat rule for the schedule.
+        repeats:,
+        # The key of the workflow.
+        workflow:,
+        # An optional map of data to pass into the workflow execution.
+        data: nil,
+        # The ending date and time for the schedule.
+        ending_at: nil,
+        # The starting date and time for the schedule.
+        scheduled_at: nil,
+        # An request to set a tenant inline.
+        tenant: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            recipients:
+              T::Array[
+                T.any(
+                  String,
+                  Knockapi::InlineIdentifyUserRequest,
+                  Knockapi::InlineObjectRequest
+                )
+              ],
+            repeats: T::Array[Knockapi::ScheduleRepeatRule],
+            workflow: String,
+            data: T.nilable(T::Hash[Symbol, T.anything]),
+            ending_at: T.nilable(Time),
+            scheduled_at: T.nilable(Time),
+            tenant: T.nilable(T.any(String, Knockapi::TenantRequest)),
+            request_options: Knockapi::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/knockapi/models/schedule_create_response.rbi

@@ -0,0 +1,11 @@
+# typed: strong
+
+module Knockapi
+  module Models
+    ScheduleCreateResponse =
+      T.let(
+        Knockapi::Internal::Type::ArrayOf[Knockapi::Schedule],
+        Knockapi::Internal::Type::Converter
+      )
+  end
+end

data/rbi/knockapi/models/schedule_delete_params.rbi

@@ -0,0 +1,43 @@
+# typed: strong
+
+module Knockapi
+  module Models
+    class ScheduleDeleteParams < Knockapi::Internal::Type::BaseModel
+      extend Knockapi::Internal::Type::RequestParameters::Converter
+      include Knockapi::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Knockapi::ScheduleDeleteParams, Knockapi::Internal::AnyHash)
+        end
+
+      # A list of schedule IDs.
+      sig { returns(T::Array[String]) }
+      attr_accessor :schedule_ids
+
+      sig do
+        params(
+          schedule_ids: T::Array[String],
+          request_options: Knockapi::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # A list of schedule IDs.
+        schedule_ids:,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            schedule_ids: T::Array[String],
+            request_options: Knockapi::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/knockapi/models/schedule_delete_response.rbi

@@ -0,0 +1,11 @@
+# typed: strong
+
+module Knockapi
+  module Models
+    ScheduleDeleteResponse =
+      T.let(
+        Knockapi::Internal::Type::ArrayOf[Knockapi::Schedule],
+        Knockapi::Internal::Type::Converter
+      )
+  end
+end