knockapi 0.6.1 → 1.1.0

data/sig/knockapi/models/providers/ms_team_check_auth_params.rbs

@@ -0,0 +1,21 @@
+module Knockapi
+  module Models
+    module Providers
+      type ms_team_check_auth_params =
+        { ms_teams_tenant_object: String }
+        & Knockapi::Internal::Type::request_parameters
+
+      class MsTeamCheckAuthParams < Knockapi::Internal::Type::BaseModel
+        extend Knockapi::Internal::Type::RequestParameters::Converter
+        include Knockapi::Internal::Type::RequestParameters
+
+        attr_accessor ms_teams_tenant_object: String
+
+        def initialize: (
+          ms_teams_tenant_object: String,
+          ?request_options: Knockapi::request_opts
+        ) -> void
+      end
+    end
+  end
+end

data/sig/knockapi/models/providers/ms_team_check_auth_response.rbs

@@ -0,0 +1,28 @@
+module Knockapi
+  module Models
+    module Providers
+      type ms_team_check_auth_response =
+        {
+          connection: Knockapi::Models::Providers::MsTeamCheckAuthResponse::Connection
+        }
+
+      class MsTeamCheckAuthResponse < Knockapi::Internal::Type::BaseModel
+        attr_accessor connection: Knockapi::Models::Providers::MsTeamCheckAuthResponse::Connection
+
+        def initialize: (
+          connection: Knockapi::Models::Providers::MsTeamCheckAuthResponse::Connection
+        ) -> void
+
+        type connection = { ok: bool, reason: String? }
+
+        class Connection < Knockapi::Internal::Type::BaseModel
+          attr_accessor ok: bool
+
+          attr_accessor reason: String?
+
+          def initialize: (ok: bool, ?reason: String?) -> void
+        end
+      end
+    end
+  end
+end

data/sig/knockapi/models/providers/ms_team_list_channels_params.rbs

@@ -0,0 +1,49 @@
+module Knockapi
+  module Models
+    module Providers
+      type ms_team_list_channels_params =
+        {
+          ms_teams_tenant_object: String,
+          team_id: String,
+          query_options: Knockapi::Providers::MsTeamListChannelsParams::QueryOptions
+        }
+        & Knockapi::Internal::Type::request_parameters
+
+      class MsTeamListChannelsParams < Knockapi::Internal::Type::BaseModel
+        extend Knockapi::Internal::Type::RequestParameters::Converter
+        include Knockapi::Internal::Type::RequestParameters
+
+        attr_accessor ms_teams_tenant_object: String
+
+        attr_accessor team_id: String
+
+        attr_reader query_options: Knockapi::Providers::MsTeamListChannelsParams::QueryOptions?
+
+        def query_options=: (
+          Knockapi::Providers::MsTeamListChannelsParams::QueryOptions
+        ) -> Knockapi::Providers::MsTeamListChannelsParams::QueryOptions
+
+        def initialize: (
+          ms_teams_tenant_object: String,
+          team_id: String,
+          ?query_options: Knockapi::Providers::MsTeamListChannelsParams::QueryOptions,
+          ?request_options: Knockapi::request_opts
+        ) -> void
+
+        type query_options = { filter: String, select_: String }
+
+        class QueryOptions < Knockapi::Internal::Type::BaseModel
+          attr_reader filter: String?
+
+          def filter=: (String) -> String
+
+          attr_reader select_: String?
+
+          def select_=: (String) -> String
+
+          def initialize: (?filter: String, ?select_: String) -> void
+        end
+      end
+    end
+  end
+end

data/sig/knockapi/models/providers/ms_team_list_channels_response.rbs

@@ -0,0 +1,57 @@
+module Knockapi
+  module Models
+    module Providers
+      type ms_team_list_channels_response =
+        {
+          ms_teams_channels: ::Array[Knockapi::Models::Providers::MsTeamListChannelsResponse::MsTeamsChannel]
+        }
+
+      class MsTeamListChannelsResponse < Knockapi::Internal::Type::BaseModel
+        attr_accessor ms_teams_channels: ::Array[Knockapi::Models::Providers::MsTeamListChannelsResponse::MsTeamsChannel]
+
+        def initialize: (
+          ms_teams_channels: ::Array[Knockapi::Models::Providers::MsTeamListChannelsResponse::MsTeamsChannel]
+        ) -> void
+
+        type ms_teams_channel =
+          {
+            id: String,
+            display_name: String,
+            created_date_time: String,
+            description: String?,
+            is_archived: bool,
+            membership_type: String
+          }
+
+        class MsTeamsChannel < Knockapi::Internal::Type::BaseModel
+          attr_accessor id: String
+
+          attr_accessor display_name: String
+
+          attr_reader created_date_time: String?
+
+          def created_date_time=: (String) -> String
+
+          attr_accessor description: String?
+
+          attr_reader is_archived: bool?
+
+          def is_archived=: (bool) -> bool
+
+          attr_reader membership_type: String?
+
+          def membership_type=: (String) -> String
+
+          def initialize: (
+            id: String,
+            display_name: String,
+            ?created_date_time: String,
+            ?description: String?,
+            ?is_archived: bool,
+            ?membership_type: String
+          ) -> void
+        end
+      end
+    end
+  end
+end

data/sig/knockapi/models/providers/ms_team_list_teams_params.rbs

@@ -0,0 +1,59 @@
+module Knockapi
+  module Models
+    module Providers
+      type ms_team_list_teams_params =
+        {
+          ms_teams_tenant_object: String,
+          query_options: Knockapi::Providers::MsTeamListTeamsParams::QueryOptions
+        }
+        & Knockapi::Internal::Type::request_parameters
+
+      class MsTeamListTeamsParams < Knockapi::Internal::Type::BaseModel
+        extend Knockapi::Internal::Type::RequestParameters::Converter
+        include Knockapi::Internal::Type::RequestParameters
+
+        attr_accessor ms_teams_tenant_object: String
+
+        attr_reader query_options: Knockapi::Providers::MsTeamListTeamsParams::QueryOptions?
+
+        def query_options=: (
+          Knockapi::Providers::MsTeamListTeamsParams::QueryOptions
+        ) -> Knockapi::Providers::MsTeamListTeamsParams::QueryOptions
+
+        def initialize: (
+          ms_teams_tenant_object: String,
+          ?query_options: Knockapi::Providers::MsTeamListTeamsParams::QueryOptions,
+          ?request_options: Knockapi::request_opts
+        ) -> void
+
+        type query_options =
+          { filter: String, select_: String, skiptoken: String, top: Integer }
+
+        class QueryOptions < Knockapi::Internal::Type::BaseModel
+          attr_reader filter: String?
+
+          def filter=: (String) -> String
+
+          attr_reader select_: String?
+
+          def select_=: (String) -> String
+
+          attr_reader skiptoken: String?
+
+          def skiptoken=: (String) -> String
+
+          attr_reader top: Integer?
+
+          def top=: (Integer) -> Integer
+
+          def initialize: (
+            ?filter: String,
+            ?select_: String,
+            ?skiptoken: String,
+            ?top: Integer
+          ) -> void
+        end
+      end
+    end
+  end
+end

data/sig/knockapi/models/providers/ms_team_list_teams_response.rbs

@@ -0,0 +1,22 @@
+module Knockapi
+  module Models
+    module Providers
+      type ms_team_list_teams_response =
+        { id: String, display_name: String, description: String? }
+
+      class MsTeamListTeamsResponse < Knockapi::Internal::Type::BaseModel
+        attr_accessor id: String
+
+        attr_accessor display_name: String
+
+        attr_accessor description: String?
+
+        def initialize: (
+          id: String,
+          display_name: String,
+          ?description: String?
+        ) -> void
+      end
+    end
+  end
+end

data/sig/knockapi/models/providers/ms_team_revoke_access_params.rbs

@@ -0,0 +1,21 @@
+module Knockapi
+  module Models
+    module Providers
+      type ms_team_revoke_access_params =
+        { ms_teams_tenant_object: String }
+        & Knockapi::Internal::Type::request_parameters
+
+      class MsTeamRevokeAccessParams < Knockapi::Internal::Type::BaseModel
+        extend Knockapi::Internal::Type::RequestParameters::Converter
+        include Knockapi::Internal::Type::RequestParameters
+
+        attr_accessor ms_teams_tenant_object: String
+
+        def initialize: (
+          ms_teams_tenant_object: String,
+          ?request_options: Knockapi::request_opts
+        ) -> void
+      end
+    end
+  end
+end

data/sig/knockapi/models/providers/ms_team_revoke_access_response.rbs

@@ -0,0 +1,15 @@
+module Knockapi
+  module Models
+    module Providers
+      type ms_team_revoke_access_response = { ok: String }
+
+      class MsTeamRevokeAccessResponse < Knockapi::Internal::Type::BaseModel
+        attr_reader ok: String?
+
+        def ok=: (String) -> String
+
+        def initialize: (?ok: String) -> void
+      end
+    end
+  end
+end

data/sig/knockapi/models/providers/slack_check_auth_params.rbs

@@ -0,0 +1,21 @@
+module Knockapi
+  module Models
+    module Providers
+      type slack_check_auth_params =
+        { access_token_object: String }
+        & Knockapi::Internal::Type::request_parameters
+
+      class SlackCheckAuthParams < Knockapi::Internal::Type::BaseModel
+        extend Knockapi::Internal::Type::RequestParameters::Converter
+        include Knockapi::Internal::Type::RequestParameters
+
+        attr_accessor access_token_object: String
+
+        def initialize: (
+          access_token_object: String,
+          ?request_options: Knockapi::request_opts
+        ) -> void
+      end
+    end
+  end
+end

data/sig/knockapi/models/providers/slack_check_auth_response.rbs

@@ -0,0 +1,28 @@
+module Knockapi
+  module Models
+    module Providers
+      type slack_check_auth_response =
+        {
+          connection: Knockapi::Models::Providers::SlackCheckAuthResponse::Connection
+        }
+
+      class SlackCheckAuthResponse < Knockapi::Internal::Type::BaseModel
+        attr_accessor connection: Knockapi::Models::Providers::SlackCheckAuthResponse::Connection
+
+        def initialize: (
+          connection: Knockapi::Models::Providers::SlackCheckAuthResponse::Connection
+        ) -> void
+
+        type connection = { ok: bool, reason: String? }
+
+        class Connection < Knockapi::Internal::Type::BaseModel
+          attr_accessor ok: bool
+
+          attr_accessor reason: String?
+
+          def initialize: (ok: bool, ?reason: String?) -> void
+        end
+      end
+    end
+  end
+end

data/sig/knockapi/models/providers/slack_list_channels_params.rbs

@@ -0,0 +1,70 @@
+module Knockapi
+  module Models
+    module Providers
+      type slack_list_channels_params =
+        {
+          access_token_object: String,
+          query_options: Knockapi::Providers::SlackListChannelsParams::QueryOptions
+        }
+        & Knockapi::Internal::Type::request_parameters
+
+      class SlackListChannelsParams < Knockapi::Internal::Type::BaseModel
+        extend Knockapi::Internal::Type::RequestParameters::Converter
+        include Knockapi::Internal::Type::RequestParameters
+
+        attr_accessor access_token_object: String
+
+        attr_reader query_options: Knockapi::Providers::SlackListChannelsParams::QueryOptions?
+
+        def query_options=: (
+          Knockapi::Providers::SlackListChannelsParams::QueryOptions
+        ) -> Knockapi::Providers::SlackListChannelsParams::QueryOptions
+
+        def initialize: (
+          access_token_object: String,
+          ?query_options: Knockapi::Providers::SlackListChannelsParams::QueryOptions,
+          ?request_options: Knockapi::request_opts
+        ) -> void
+
+        type query_options =
+          {
+            cursor: String,
+            exclude_archived: bool,
+            limit: Integer,
+            team_id: String,
+            types: String
+          }
+
+        class QueryOptions < Knockapi::Internal::Type::BaseModel
+          attr_reader cursor: String?
+
+          def cursor=: (String) -> String
+
+          attr_reader exclude_archived: bool?
+
+          def exclude_archived=: (bool) -> bool
+
+          attr_reader limit: Integer?
+
+          def limit=: (Integer) -> Integer
+
+          attr_reader team_id: String?
+
+          def team_id=: (String) -> String
+
+          attr_reader types: String?
+
+          def types=: (String) -> String
+
+          def initialize: (
+            ?cursor: String,
+            ?exclude_archived: bool,
+            ?limit: Integer,
+            ?team_id: String,
+            ?types: String
+          ) -> void
+        end
+      end
+    end
+  end
+end

data/sig/knockapi/models/providers/slack_list_channels_response.rbs

@@ -0,0 +1,34 @@
+module Knockapi
+  module Models
+    module Providers
+      type slack_list_channels_response =
+        {
+          id: String,
+          context_team_id: String,
+          is_im: bool,
+          is_private: bool,
+          name: String
+        }
+
+      class SlackListChannelsResponse < Knockapi::Internal::Type::BaseModel
+        attr_accessor id: String
+
+        attr_accessor context_team_id: String
+
+        attr_accessor is_im: bool
+
+        attr_accessor is_private: bool
+
+        attr_accessor name: String
+
+        def initialize: (
+          id: String,
+          context_team_id: String,
+          is_im: bool,
+          is_private: bool,
+          name: String
+        ) -> void
+      end
+    end
+  end
+end

data/sig/knockapi/models/providers/slack_revoke_access_params.rbs

@@ -0,0 +1,21 @@
+module Knockapi
+  module Models
+    module Providers
+      type slack_revoke_access_params =
+        { access_token_object: String }
+        & Knockapi::Internal::Type::request_parameters
+
+      class SlackRevokeAccessParams < Knockapi::Internal::Type::BaseModel
+        extend Knockapi::Internal::Type::RequestParameters::Converter
+        include Knockapi::Internal::Type::RequestParameters
+
+        attr_accessor access_token_object: String
+
+        def initialize: (
+          access_token_object: String,
+          ?request_options: Knockapi::request_opts
+        ) -> void
+      end
+    end
+  end
+end

data/sig/knockapi/models/providers/slack_revoke_access_response.rbs

@@ -0,0 +1,15 @@
+module Knockapi
+  module Models
+    module Providers
+      type slack_revoke_access_response = { ok: String }
+
+      class SlackRevokeAccessResponse < Knockapi::Internal::Type::BaseModel
+        attr_reader ok: String?
+
+        def ok=: (String) -> String
+
+        def initialize: (?ok: String) -> void
+      end
+    end
+  end
+end

data/sig/knockapi/models/recipient.rbs

@@ -0,0 +1,11 @@
+module Knockapi
+  module Models
+    type recipient = Knockapi::User | Knockapi::Object
+
+    module Recipient
+      extend Knockapi::Internal::Type::Union
+
+      def self?.variants: -> ::Array[Knockapi::Models::recipient]
+    end
+  end
+end

data/sig/knockapi/models/recipient_reference.rbs

@@ -0,0 +1,26 @@
+module Knockapi
+  module Models
+    type recipient_reference =
+      String | Knockapi::RecipientReference::ObjectReference
+
+    module RecipientReference
+      extend Knockapi::Internal::Type::Union
+
+      type object_reference = { id: String, collection: String }
+
+      class ObjectReference < Knockapi::Internal::Type::BaseModel
+        attr_reader id: String?
+
+        def id=: (String) -> String
+
+        attr_reader collection: String?
+
+        def collection=: (String) -> String
+
+        def initialize: (?id: String, ?collection: String) -> void
+      end
+
+      def self?.variants: -> ::Array[Knockapi::Models::recipient_reference]
+    end
+  end
+end

data/sig/knockapi/models/recipient_request.rbs

@@ -0,0 +1,14 @@
+module Knockapi
+  module Models
+    type recipient_request =
+      String
+      | Knockapi::InlineIdentifyUserRequest
+      | Knockapi::InlineObjectRequest
+
+    module RecipientRequest
+      extend Knockapi::Internal::Type::Union
+
+      def self?.variants: -> ::Array[Knockapi::Models::recipient_request]
+    end
+  end
+end

data/sig/knockapi/models/recipients/channel_data.rbs

@@ -0,0 +1,72 @@
+module Knockapi
+  module Models
+    module Recipients
+      type recipients_channel_data =
+        {
+          _typename: String,
+          channel_id: String,
+          data: Knockapi::Recipients::RecipientsChannelData::data,
+          provider: Knockapi::Recipients::RecipientsChannelData::provider
+        }
+
+      class RecipientsChannelData < Knockapi::Internal::Type::BaseModel
+        attr_accessor _typename: String
+
+        attr_accessor channel_id: String
+
+        attr_accessor data: Knockapi::Recipients::RecipientsChannelData::data
+
+        attr_reader provider: Knockapi::Recipients::RecipientsChannelData::provider?
+
+        def provider=: (
+          Knockapi::Recipients::RecipientsChannelData::provider
+        ) -> Knockapi::Recipients::RecipientsChannelData::provider
+
+        def initialize: (
+          _typename: String,
+          channel_id: String,
+          data: Knockapi::Recipients::RecipientsChannelData::data,
+          ?provider: Knockapi::Recipients::RecipientsChannelData::provider
+        ) -> void
+
+        type data =
+          Knockapi::Recipients::PushChannelData
+          | Knockapi::Recipients::SlackChannelData
+          | Knockapi::Recipients::MsTeamsChannelData
+          | Knockapi::Recipients::DiscordChannelData
+          | Knockapi::Recipients::OneSignalChannelData
+
+        module Data
+          extend Knockapi::Internal::Type::Union
+
+          def self?.variants: -> ::Array[Knockapi::Recipients::RecipientsChannelData::data]
+        end
+
+        type provider =
+          :push_fcm
+          | :push_apns
+          | :push_expo
+          | :push_one_signal
+          | :chat_slack
+          | :chat_ms_teams
+          | :chat_discord
+          | :http_knock_webhook
+
+        module Provider
+          extend Knockapi::Internal::Type::Enum
+
+          PUSH_FCM: :push_fcm
+          PUSH_APNS: :push_apns
+          PUSH_EXPO: :push_expo
+          PUSH_ONE_SIGNAL: :push_one_signal
+          CHAT_SLACK: :chat_slack
+          CHAT_MS_TEAMS: :chat_ms_teams
+          CHAT_DISCORD: :chat_discord
+          HTTP_KNOCK_WEBHOOK: :http_knock_webhook
+
+          def self?.values: -> ::Array[Knockapi::Recipients::RecipientsChannelData::provider]
+        end
+      end
+    end
+  end
+end

data/sig/knockapi/models/recipients/channel_data_request.rbs

@@ -0,0 +1,29 @@
+module Knockapi
+  module Models
+    module Recipients
+      type channel_data_request =
+        { data: Knockapi::Recipients::ChannelDataRequest::data }
+
+      class ChannelDataRequest < Knockapi::Internal::Type::BaseModel
+        attr_accessor data: Knockapi::Recipients::ChannelDataRequest::data
+
+        def initialize: (
+          data: Knockapi::Recipients::ChannelDataRequest::data
+        ) -> void
+
+        type data =
+          Knockapi::Recipients::PushChannelData
+          | Knockapi::Recipients::OneSignalChannelData
+          | Knockapi::Recipients::SlackChannelData
+          | Knockapi::Recipients::MsTeamsChannelData
+          | Knockapi::Recipients::DiscordChannelData
+
+        module Data
+          extend Knockapi::Internal::Type::Union
+
+          def self?.variants: -> ::Array[Knockapi::Recipients::ChannelDataRequest::data]
+        end
+      end
+    end
+  end
+end

data/sig/knockapi/models/recipients/discord_channel_data.rbs

@@ -0,0 +1,57 @@
+module Knockapi
+  module Models
+    module Recipients
+      type discord_channel_data =
+        {
+          connections: ::Array[Knockapi::Recipients::DiscordChannelData::connection]
+        }
+
+      class DiscordChannelData < Knockapi::Internal::Type::BaseModel
+        attr_accessor connections: ::Array[Knockapi::Recipients::DiscordChannelData::connection]
+
+        def initialize: (
+          connections: ::Array[Knockapi::Recipients::DiscordChannelData::connection]
+        ) -> void
+
+        type connection =
+          Knockapi::Recipients::DiscordChannelData::Connection::DiscordChannelConnection
+          | Knockapi::Recipients::DiscordChannelData::Connection::DiscordIncomingWebhookConnection
+
+        module Connection
+          extend Knockapi::Internal::Type::Union
+
+          type discord_channel_connection = { channel_id: String }
+
+          class DiscordChannelConnection < Knockapi::Internal::Type::BaseModel
+            attr_accessor channel_id: String
+
+            def initialize: (channel_id: String) -> void
+          end
+
+          type discord_incoming_webhook_connection =
+            {
+              incoming_webhook: Knockapi::Recipients::DiscordChannelData::Connection::DiscordIncomingWebhookConnection::IncomingWebhook
+            }
+
+          class DiscordIncomingWebhookConnection < Knockapi::Internal::Type::BaseModel
+            attr_accessor incoming_webhook: Knockapi::Recipients::DiscordChannelData::Connection::DiscordIncomingWebhookConnection::IncomingWebhook
+
+            def initialize: (
+              incoming_webhook: Knockapi::Recipients::DiscordChannelData::Connection::DiscordIncomingWebhookConnection::IncomingWebhook
+            ) -> void
+
+            type incoming_webhook = { url: String }
+
+            class IncomingWebhook < Knockapi::Internal::Type::BaseModel
+              attr_accessor url: String
+
+              def initialize: (url: String) -> void
+            end
+          end
+
+          def self?.variants: -> ::Array[Knockapi::Recipients::DiscordChannelData::connection]
+        end
+      end
+    end
+  end
+end