knockapi 0.6.1 → 1.0.0

data/rbi/knockapi/models/providers/ms_team_list_teams_params.rbi

@@ -0,0 +1,107 @@
+# typed: strong
+
+module Knockapi
+  module Models
+    module Providers
+      class MsTeamListTeamsParams < Knockapi::Internal::Type::BaseModel
+        extend Knockapi::Internal::Type::RequestParameters::Converter
+        include Knockapi::Internal::Type::RequestParameters
+
+        # A JSON encoded string containing the Microsoft Teams tenant object reference.
+        sig { returns(String) }
+        attr_accessor :ms_teams_tenant_object
+
+        sig { returns(T.nilable(Knockapi::Models::Providers::MsTeamListTeamsParams::QueryOptions)) }
+        attr_reader :query_options
+
+        sig do
+          params(
+            query_options: T.any(Knockapi::Models::Providers::MsTeamListTeamsParams::QueryOptions, Knockapi::Internal::AnyHash)
+          )
+            .void
+        end
+        attr_writer :query_options
+
+        sig do
+          params(
+            ms_teams_tenant_object: String,
+            query_options: T.any(Knockapi::Models::Providers::MsTeamListTeamsParams::QueryOptions, Knockapi::Internal::AnyHash),
+            request_options: T.any(Knockapi::RequestOptions, Knockapi::Internal::AnyHash)
+          )
+            .returns(T.attached_class)
+        end
+        def self.new(
+          # A JSON encoded string containing the Microsoft Teams tenant object reference.
+          ms_teams_tenant_object:,
+          query_options: nil,
+          request_options: {}
+        ); end
+        sig do
+          override
+            .returns(
+              {
+                ms_teams_tenant_object: String,
+                query_options: Knockapi::Models::Providers::MsTeamListTeamsParams::QueryOptions,
+                request_options: Knockapi::RequestOptions
+              }
+            )
+        end
+        def to_hash; end
+
+        class QueryOptions < Knockapi::Internal::Type::BaseModel
+          # [OData param](https://learn.microsoft.com/en-us/graph/query-parameters) passed
+          # to the Microsoft Graph API to filter teams.
+          sig { returns(T.nilable(String)) }
+          attr_reader :filter
+
+          sig { params(filter: String).void }
+          attr_writer :filter
+
+          # [OData param](https://learn.microsoft.com/en-us/graph/query-parameters) passed
+          # to the Microsoft Graph API to select fields on a team.
+          sig { returns(T.nilable(String)) }
+          attr_reader :select_
+
+          sig { params(select_: String).void }
+          attr_writer :select_
+
+          # [OData param](https://learn.microsoft.com/en-us/graph/query-parameters) passed
+          # to the Microsoft Graph API to retrieve the next page of results.
+          sig { returns(T.nilable(String)) }
+          attr_reader :skiptoken
+
+          sig { params(skiptoken: String).void }
+          attr_writer :skiptoken
+
+          # [OData param](https://learn.microsoft.com/en-us/graph/query-parameters) passed
+          # to the Microsoft Graph API to limit the number of teams returned.
+          sig { returns(T.nilable(Integer)) }
+          attr_reader :top
+
+          sig { params(top: Integer).void }
+          attr_writer :top
+
+          sig do
+            params(filter: String, select_: String, skiptoken: String, top: Integer).returns(T.attached_class)
+          end
+          def self.new(
+            # [OData param](https://learn.microsoft.com/en-us/graph/query-parameters) passed
+            # to the Microsoft Graph API to filter teams.
+            filter: nil,
+            # [OData param](https://learn.microsoft.com/en-us/graph/query-parameters) passed
+            # to the Microsoft Graph API to select fields on a team.
+            select_: nil,
+            # [OData param](https://learn.microsoft.com/en-us/graph/query-parameters) passed
+            # to the Microsoft Graph API to retrieve the next page of results.
+            skiptoken: nil,
+            # [OData param](https://learn.microsoft.com/en-us/graph/query-parameters) passed
+            # to the Microsoft Graph API to limit the number of teams returned.
+            top: nil
+          ); end
+          sig { override.returns({filter: String, select_: String, skiptoken: String, top: Integer}) }
+          def to_hash; end
+        end
+      end
+    end
+  end
+end

data/rbi/knockapi/models/providers/ms_team_list_teams_response.rbi

@@ -0,0 +1,35 @@
+# typed: strong
+
+module Knockapi
+  module Models
+    module Providers
+      class MsTeamListTeamsResponse < Knockapi::Internal::Type::BaseModel
+        # Microsoft Teams team ID.
+        sig { returns(String) }
+        attr_accessor :id
+
+        # Microsoft Teams team display name.
+        sig { returns(String) }
+        attr_accessor :display_name
+
+        # Microsoft Teams team description.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :description
+
+        sig do
+          params(id: String, display_name: String, description: T.nilable(String)).returns(T.attached_class)
+        end
+        def self.new(
+          # Microsoft Teams team ID.
+          id:,
+          # Microsoft Teams team display name.
+          display_name:,
+          # Microsoft Teams team description.
+          description: nil
+        ); end
+        sig { override.returns({id: String, display_name: String, description: T.nilable(String)}) }
+        def to_hash; end
+      end
+    end
+  end
+end

data/rbi/knockapi/models/providers/ms_team_revoke_access_params.rbi

@@ -0,0 +1,31 @@
+# typed: strong
+
+module Knockapi
+  module Models
+    module Providers
+      class MsTeamRevokeAccessParams < Knockapi::Internal::Type::BaseModel
+        extend Knockapi::Internal::Type::RequestParameters::Converter
+        include Knockapi::Internal::Type::RequestParameters
+
+        # A JSON encoded string containing the Microsoft Teams tenant object reference.
+        sig { returns(String) }
+        attr_accessor :ms_teams_tenant_object
+
+        sig do
+          params(
+            ms_teams_tenant_object: String,
+            request_options: T.any(Knockapi::RequestOptions, Knockapi::Internal::AnyHash)
+          )
+            .returns(T.attached_class)
+        end
+        def self.new(
+          # A JSON encoded string containing the Microsoft Teams tenant object reference.
+          ms_teams_tenant_object:,
+          request_options: {}
+        ); end
+        sig { override.returns({ms_teams_tenant_object: String, request_options: Knockapi::RequestOptions}) }
+        def to_hash; end
+      end
+    end
+  end
+end

data/rbi/knockapi/models/providers/ms_team_revoke_access_response.rbi

@@ -0,0 +1,25 @@
+# typed: strong
+
+module Knockapi
+  module Models
+    module Providers
+      class MsTeamRevokeAccessResponse < Knockapi::Internal::Type::BaseModel
+        # OK response.
+        sig { returns(T.nilable(String)) }
+        attr_reader :ok
+
+        sig { params(ok: String).void }
+        attr_writer :ok
+
+        # A response indicating the operation was successful.
+        sig { params(ok: String).returns(T.attached_class) }
+        def self.new(
+          # OK response.
+          ok: nil
+        ); end
+        sig { override.returns({ok: String}) }
+        def to_hash; end
+      end
+    end
+  end
+end

data/rbi/knockapi/models/providers/slack_check_auth_params.rbi

@@ -0,0 +1,31 @@
+# typed: strong
+
+module Knockapi
+  module Models
+    module Providers
+      class SlackCheckAuthParams < Knockapi::Internal::Type::BaseModel
+        extend Knockapi::Internal::Type::RequestParameters::Converter
+        include Knockapi::Internal::Type::RequestParameters
+
+        # A JSON encoded string containing the access token object reference.
+        sig { returns(String) }
+        attr_accessor :access_token_object
+
+        sig do
+          params(
+            access_token_object: String,
+            request_options: T.any(Knockapi::RequestOptions, Knockapi::Internal::AnyHash)
+          )
+            .returns(T.attached_class)
+        end
+        def self.new(
+          # A JSON encoded string containing the access token object reference.
+          access_token_object:,
+          request_options: {}
+        ); end
+        sig { override.returns({access_token_object: String, request_options: Knockapi::RequestOptions}) }
+        def to_hash; end
+      end
+    end
+  end
+end

data/rbi/knockapi/models/providers/slack_check_auth_response.rbi

@@ -0,0 +1,56 @@
+# typed: strong
+
+module Knockapi
+  module Models
+    module Providers
+      class SlackCheckAuthResponse < Knockapi::Internal::Type::BaseModel
+        # A Slack connection object.
+        sig { returns(Knockapi::Models::Providers::SlackCheckAuthResponse::Connection) }
+        attr_reader :connection
+
+        sig do
+          params(
+            connection: T.any(Knockapi::Models::Providers::SlackCheckAuthResponse::Connection, Knockapi::Internal::AnyHash)
+          )
+            .void
+        end
+        attr_writer :connection
+
+        # The response from a Slack auth check request.
+        sig do
+          params(
+            connection: T.any(Knockapi::Models::Providers::SlackCheckAuthResponse::Connection, Knockapi::Internal::AnyHash)
+          )
+            .returns(T.attached_class)
+        end
+        def self.new(
+          # A Slack connection object.
+          connection:
+        ); end
+        sig { override.returns({connection: Knockapi::Models::Providers::SlackCheckAuthResponse::Connection}) }
+        def to_hash; end
+
+        class Connection < Knockapi::Internal::Type::BaseModel
+          # Whether the Slack connection is valid.
+          sig { returns(T::Boolean) }
+          attr_accessor :ok
+
+          # The reason for the Slack connection if it is not valid.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :reason
+
+          # A Slack connection object.
+          sig { params(ok: T::Boolean, reason: T.nilable(String)).returns(T.attached_class) }
+          def self.new(
+            # Whether the Slack connection is valid.
+            ok:,
+            # The reason for the Slack connection if it is not valid.
+            reason: nil
+          ); end
+          sig { override.returns({ok: T::Boolean, reason: T.nilable(String)}) }
+          def to_hash; end
+        end
+      end
+    end
+  end
+end

data/rbi/knockapi/models/providers/slack_list_channels_params.rbi

@@ -0,0 +1,130 @@
+# typed: strong
+
+module Knockapi
+  module Models
+    module Providers
+      class SlackListChannelsParams < Knockapi::Internal::Type::BaseModel
+        extend Knockapi::Internal::Type::RequestParameters::Converter
+        include Knockapi::Internal::Type::RequestParameters
+
+        # A JSON encoded string containing the access token object reference.
+        sig { returns(String) }
+        attr_accessor :access_token_object
+
+        sig { returns(T.nilable(Knockapi::Models::Providers::SlackListChannelsParams::QueryOptions)) }
+        attr_reader :query_options
+
+        sig do
+          params(
+            query_options: T.any(Knockapi::Models::Providers::SlackListChannelsParams::QueryOptions, Knockapi::Internal::AnyHash)
+          )
+            .void
+        end
+        attr_writer :query_options
+
+        sig do
+          params(
+            access_token_object: String,
+            query_options: T.any(Knockapi::Models::Providers::SlackListChannelsParams::QueryOptions, Knockapi::Internal::AnyHash),
+            request_options: T.any(Knockapi::RequestOptions, Knockapi::Internal::AnyHash)
+          )
+            .returns(T.attached_class)
+        end
+        def self.new(
+          # A JSON encoded string containing the access token object reference.
+          access_token_object:,
+          query_options: nil,
+          request_options: {}
+        ); end
+        sig do
+          override
+            .returns(
+              {
+                access_token_object: String,
+                query_options: Knockapi::Models::Providers::SlackListChannelsParams::QueryOptions,
+                request_options: Knockapi::RequestOptions
+              }
+            )
+        end
+        def to_hash; end
+
+        class QueryOptions < Knockapi::Internal::Type::BaseModel
+          # Paginate through collections of data by setting the cursor parameter to a
+          # next_cursor attribute returned by a previous request's response_metadata.
+          # Default value fetches the first "page" of the collection.
+          sig { returns(T.nilable(String)) }
+          attr_reader :cursor
+
+          sig { params(cursor: String).void }
+          attr_writer :cursor
+
+          # Set to true to exclude archived channels from the list.
+          sig { returns(T.nilable(T::Boolean)) }
+          attr_reader :exclude_archived
+
+          sig { params(exclude_archived: T::Boolean).void }
+          attr_writer :exclude_archived
+
+          # The maximum number of channels to return.
+          sig { returns(T.nilable(Integer)) }
+          attr_reader :limit
+
+          sig { params(limit: Integer).void }
+          attr_writer :limit
+
+          # Encoded team ID (T1234) to list channels in, required if org token is used.
+          sig { returns(T.nilable(String)) }
+          attr_reader :team_id
+
+          sig { params(team_id: String).void }
+          attr_writer :team_id
+
+          # Mix and match channel types by providing a comma-separated list of any
+          # combination of public_channel, private_channel, mpim, im.
+          sig { returns(T.nilable(String)) }
+          attr_reader :types
+
+          sig { params(types: String).void }
+          attr_writer :types
+
+          sig do
+            params(
+              cursor: String,
+              exclude_archived: T::Boolean,
+              limit: Integer,
+              team_id: String,
+              types: String
+            )
+              .returns(T.attached_class)
+          end
+          def self.new(
+            # Paginate through collections of data by setting the cursor parameter to a
+            # next_cursor attribute returned by a previous request's response_metadata.
+            # Default value fetches the first "page" of the collection.
+            cursor: nil,
+            # Set to true to exclude archived channels from the list.
+            exclude_archived: nil,
+            # The maximum number of channels to return.
+            limit: nil,
+            # Encoded team ID (T1234) to list channels in, required if org token is used.
+            team_id: nil,
+            # Mix and match channel types by providing a comma-separated list of any
+            # combination of public_channel, private_channel, mpim, im.
+            types: nil
+          ); end
+          sig do
+            override
+              .returns({
+                         cursor: String,
+                         exclude_archived: T::Boolean,
+                         limit: Integer,
+                         team_id: String,
+                         types: String
+                       })
+          end
+          def to_hash; end
+        end
+      end
+    end
+  end
+end

data/rbi/knockapi/models/providers/slack_list_channels_response.rbi

@@ -0,0 +1,58 @@
+# typed: strong
+
+module Knockapi
+  module Models
+    module Providers
+      class SlackListChannelsResponse < Knockapi::Internal::Type::BaseModel
+        # A Slack channel ID from the Slack provider.
+        sig { returns(String) }
+        attr_accessor :id
+
+        # The team ID that the Slack channel belongs to.
+        sig { returns(String) }
+        attr_accessor :context_team_id
+
+        # Whether the Slack channel is an IM channel.
+        sig { returns(T::Boolean) }
+        attr_accessor :is_im
+
+        # Whether the Slack channel is private.
+        sig { returns(T::Boolean) }
+        attr_accessor :is_private
+
+        # Slack channel name.
+        sig { returns(String) }
+        attr_accessor :name
+
+        # A Slack channel.
+        sig do
+          params(id: String, context_team_id: String, is_im: T::Boolean, is_private: T::Boolean, name: String)
+            .returns(T.attached_class)
+        end
+        def self.new(
+          # A Slack channel ID from the Slack provider.
+          id:,
+          # The team ID that the Slack channel belongs to.
+          context_team_id:,
+          # Whether the Slack channel is an IM channel.
+          is_im:,
+          # Whether the Slack channel is private.
+          is_private:,
+          # Slack channel name.
+          name:
+        ); end
+        sig do
+          override
+            .returns({
+                       id: String,
+                       context_team_id: String,
+                       is_im: T::Boolean,
+                       is_private: T::Boolean,
+                       name: String
+                     })
+        end
+        def to_hash; end
+      end
+    end
+  end
+end

data/rbi/knockapi/models/providers/slack_revoke_access_params.rbi

@@ -0,0 +1,31 @@
+# typed: strong
+
+module Knockapi
+  module Models
+    module Providers
+      class SlackRevokeAccessParams < Knockapi::Internal::Type::BaseModel
+        extend Knockapi::Internal::Type::RequestParameters::Converter
+        include Knockapi::Internal::Type::RequestParameters
+
+        # A JSON encoded string containing the access token object reference.
+        sig { returns(String) }
+        attr_accessor :access_token_object
+
+        sig do
+          params(
+            access_token_object: String,
+            request_options: T.any(Knockapi::RequestOptions, Knockapi::Internal::AnyHash)
+          )
+            .returns(T.attached_class)
+        end
+        def self.new(
+          # A JSON encoded string containing the access token object reference.
+          access_token_object:,
+          request_options: {}
+        ); end
+        sig { override.returns({access_token_object: String, request_options: Knockapi::RequestOptions}) }
+        def to_hash; end
+      end
+    end
+  end
+end

data/rbi/knockapi/models/providers/slack_revoke_access_response.rbi

@@ -0,0 +1,25 @@
+# typed: strong
+
+module Knockapi
+  module Models
+    module Providers
+      class SlackRevokeAccessResponse < Knockapi::Internal::Type::BaseModel
+        # OK response.
+        sig { returns(T.nilable(String)) }
+        attr_reader :ok
+
+        sig { params(ok: String).void }
+        attr_writer :ok
+
+        # A response indicating the operation was successful.
+        sig { params(ok: String).returns(T.attached_class) }
+        def self.new(
+          # OK response.
+          ok: nil
+        ); end
+        sig { override.returns({ok: String}) }
+        def to_hash; end
+      end
+    end
+  end
+end

data/rbi/knockapi/models/recipient.rbi

@@ -0,0 +1,13 @@
+# typed: strong
+
+module Knockapi
+  module Models
+    # A recipient of a notification, which is either a user or an object.
+    module Recipient
+      extend Knockapi::Internal::Type::Union
+
+      sig { override.returns([Knockapi::Models::User, Knockapi::Models::Object]) }
+      def self.variants; end
+    end
+  end
+end

data/rbi/knockapi/models/recipient_reference.rbi

@@ -0,0 +1,41 @@
+# typed: strong
+
+module Knockapi
+  module Models
+    # A reference to a recipient, either a user identifier (string) or an object
+    # reference (ID, collection).
+    module RecipientReference
+      extend Knockapi::Internal::Type::Union
+
+      class ObjectReference < Knockapi::Internal::Type::BaseModel
+        # An identifier for the recipient object.
+        sig { returns(T.nilable(String)) }
+        attr_reader :id
+
+        sig { params(id: String).void }
+        attr_writer :id
+
+        # The collection the recipient object belongs to.
+        sig { returns(T.nilable(String)) }
+        attr_reader :collection
+
+        sig { params(collection: String).void }
+        attr_writer :collection
+
+        # A reference to a recipient object.
+        sig { params(id: String, collection: String).returns(T.attached_class) }
+        def self.new(
+          # An identifier for the recipient object.
+          id: nil,
+          # The collection the recipient object belongs to.
+          collection: nil
+        ); end
+        sig { override.returns({id: String, collection: String}) }
+        def to_hash; end
+      end
+
+      sig { override.returns([String, Knockapi::Models::RecipientReference::ObjectReference]) }
+      def self.variants; end
+    end
+  end
+end

data/rbi/knockapi/models/recipient_request.rbi

@@ -0,0 +1,18 @@
+# typed: strong
+
+module Knockapi
+  module Models
+    # Specifies a recipient in a request. This can either be a user identifier
+    # (string), an inline user request (object), or an inline object request, which is
+    # determined by the presence of a `collection` property.
+    module RecipientRequest
+      extend Knockapi::Internal::Type::Union
+
+      sig do
+        override
+          .returns([String, Knockapi::Models::InlineIdentifyUserRequest, Knockapi::Models::InlineObjectRequest])
+      end
+      def self.variants; end
+    end
+  end
+end