knockapi 0.6.1 → 1.1.0

data/sig/knockapi/resources/objects.rbs

@@ -0,0 +1,144 @@
+module Knockapi
+  module Resources
+    class Objects
+      attr_reader bulk: Knockapi::Resources::Objects::Bulk
+
+      def list: (
+        String collection,
+        ?after: String,
+        ?before: String,
+        ?include: ::Array[Knockapi::ObjectListParams::include_],
+        ?page_size: Integer,
+        ?request_options: Knockapi::request_opts
+      ) -> Knockapi::Internal::EntriesCursor[Knockapi::Object]
+
+      def delete: (
+        String collection,
+        String id,
+        ?request_options: Knockapi::request_opts
+      ) -> String
+
+      def add_subscriptions: (
+        String collection,
+        String object_id_,
+        recipients: ::Array[Knockapi::Models::recipient_request],
+        ?properties: ::Hash[Symbol, top]?,
+        ?request_options: Knockapi::request_opts
+      ) -> Knockapi::Models::object_add_subscriptions_response
+
+      def delete_subscriptions: (
+        String collection,
+        String object_id_,
+        recipients: ::Array[Knockapi::Models::recipient_reference],
+        ?request_options: Knockapi::request_opts
+      ) -> Knockapi::Models::object_delete_subscriptions_response
+
+      def get: (
+        String collection,
+        String id,
+        ?request_options: Knockapi::request_opts
+      ) -> Knockapi::Object
+
+      def get_channel_data: (
+        String collection,
+        String object_id_,
+        String channel_id,
+        ?request_options: Knockapi::request_opts
+      ) -> Knockapi::Recipients::RecipientsChannelData
+
+      def get_preferences: (
+        String collection,
+        String object_id_,
+        String id,
+        ?request_options: Knockapi::request_opts
+      ) -> Knockapi::Recipients::PreferenceSet
+
+      def list_messages: (
+        String collection,
+        String id,
+        ?after: String,
+        ?before: String,
+        ?channel_id: String,
+        ?engagement_status: ::Array[Knockapi::ObjectListMessagesParams::engagement_status],
+        ?inserted_at: Knockapi::ObjectListMessagesParams::InsertedAt,
+        ?message_ids: ::Array[String],
+        ?page_size: Integer,
+        ?source: String,
+        ?status: ::Array[Knockapi::ObjectListMessagesParams::status],
+        ?tenant: String,
+        ?trigger_data: String,
+        ?workflow_categories: ::Array[String],
+        ?workflow_recipient_run_id: String,
+        ?workflow_run_id: String,
+        ?request_options: Knockapi::request_opts
+      ) -> Knockapi::Internal::EntriesCursor[Knockapi::Message]
+
+      def list_preferences: (
+        String collection,
+        String object_id_,
+        ?request_options: Knockapi::request_opts
+      ) -> Knockapi::Models::object_list_preferences_response
+
+      def list_schedules: (
+        String collection,
+        String id,
+        ?after: String,
+        ?before: String,
+        ?page_size: Integer,
+        ?tenant: String,
+        ?workflow: String,
+        ?request_options: Knockapi::request_opts
+      ) -> Knockapi::Internal::EntriesCursor[Knockapi::Schedule]
+
+      def list_subscriptions: (
+        String collection,
+        String object_id_,
+        ?after: String,
+        ?before: String,
+        ?include: ::Array[Knockapi::ObjectListSubscriptionsParams::include_],
+        ?mode: Knockapi::Models::ObjectListSubscriptionsParams::mode,
+        ?objects: ::Array[Knockapi::ObjectListSubscriptionsParams::Object],
+        ?page_size: Integer,
+        ?recipients: ::Array[Knockapi::Models::recipient_reference],
+        ?request_options: Knockapi::request_opts
+      ) -> Knockapi::Internal::EntriesCursor[Knockapi::Recipients::Subscription]
+
+      def set: (
+        String collection,
+        String id,
+        ?channel_data: Knockapi::Models::Recipients::inline_channel_data_request,
+        ?locale: String?,
+        ?preferences: Knockapi::Models::Recipients::inline_preference_set_request,
+        ?timezone: String?,
+        ?request_options: Knockapi::request_opts
+      ) -> Knockapi::Object
+
+      def set_channel_data: (
+        String collection,
+        String object_id_,
+        String channel_id,
+        data: Knockapi::Models::Recipients::ChannelDataRequest::data,
+        ?request_options: Knockapi::request_opts
+      ) -> Knockapi::Recipients::RecipientsChannelData
+
+      def set_preferences: (
+        String collection,
+        String object_id_,
+        String id,
+        ?categories: ::Hash[Symbol, Knockapi::Recipients::PreferenceSetRequest::category]?,
+        ?channel_types: Knockapi::Recipients::PreferenceSetChannelTypes?,
+        ?workflows: ::Hash[Symbol, Knockapi::Recipients::PreferenceSetRequest::workflow]?,
+        ?request_options: Knockapi::request_opts
+      ) -> Knockapi::Recipients::PreferenceSet
+
+      def unset_channel_data: (
+        String collection,
+        String object_id_,
+        String channel_id,
+        ?request_options: Knockapi::request_opts
+      ) -> String
+
+      def initialize: (client: Knockapi::Client) -> void
+    end
+  end
+end

data/sig/knockapi/resources/providers/ms_teams.rbs

@@ -0,0 +1,36 @@
+module Knockapi
+  module Resources
+    class Providers
+      class MsTeams
+        def check_auth: (
+          String channel_id,
+          ms_teams_tenant_object: String,
+          ?request_options: Knockapi::request_opts
+        ) -> Knockapi::Models::Providers::MsTeamCheckAuthResponse
+
+        def list_channels: (
+          String channel_id,
+          ms_teams_tenant_object: String,
+          team_id: String,
+          ?query_options: Knockapi::Providers::MsTeamListChannelsParams::QueryOptions,
+          ?request_options: Knockapi::request_opts
+        ) -> Knockapi::Models::Providers::MsTeamListChannelsResponse
+
+        def list_teams: (
+          String channel_id,
+          ms_teams_tenant_object: String,
+          ?query_options: Knockapi::Providers::MsTeamListTeamsParams::QueryOptions,
+          ?request_options: Knockapi::request_opts
+        ) -> Knockapi::Internal::MsTeamsPagination[Knockapi::Models::Providers::MsTeamListTeamsResponse]
+
+        def revoke_access: (
+          String channel_id,
+          ms_teams_tenant_object: String,
+          ?request_options: Knockapi::request_opts
+        ) -> Knockapi::Models::Providers::MsTeamRevokeAccessResponse
+
+        def initialize: (client: Knockapi::Client) -> void
+      end
+    end
+  end
+end

data/sig/knockapi/resources/providers/slack.rbs

@@ -0,0 +1,28 @@
+module Knockapi
+  module Resources
+    class Providers
+      class Slack
+        def check_auth: (
+          String channel_id,
+          access_token_object: String,
+          ?request_options: Knockapi::request_opts
+        ) -> Knockapi::Models::Providers::SlackCheckAuthResponse
+
+        def list_channels: (
+          String channel_id,
+          access_token_object: String,
+          ?query_options: Knockapi::Providers::SlackListChannelsParams::QueryOptions,
+          ?request_options: Knockapi::request_opts
+        ) -> Knockapi::Internal::SlackChannelsCursor[Knockapi::Models::Providers::SlackListChannelsResponse]
+
+        def revoke_access: (
+          String channel_id,
+          access_token_object: String,
+          ?request_options: Knockapi::request_opts
+        ) -> Knockapi::Models::Providers::SlackRevokeAccessResponse
+
+        def initialize: (client: Knockapi::Client) -> void
+      end
+    end
+  end
+end

data/sig/knockapi/resources/providers.rbs

@@ -0,0 +1,11 @@
+module Knockapi
+  module Resources
+    class Providers
+      attr_reader slack: Knockapi::Resources::Providers::Slack
+
+      attr_reader ms_teams: Knockapi::Resources::Providers::MsTeams
+
+      def initialize: (client: Knockapi::Client) -> void
+    end
+  end
+end

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

@@ -0,0 +1,9 @@
+module Knockapi
+  module Resources
+    class Recipients
+      class ChannelData
+        def initialize: (client: Knockapi::Client) -> void
+      end
+    end
+  end
+end

data/sig/knockapi/resources/recipients/preferences.rbs

@@ -0,0 +1,9 @@
+module Knockapi
+  module Resources
+    class Recipients
+      class Preferences
+        def initialize: (client: Knockapi::Client) -> void
+      end
+    end
+  end
+end

data/sig/knockapi/resources/recipients/subscriptions.rbs

@@ -0,0 +1,9 @@
+module Knockapi
+  module Resources
+    class Recipients
+      class Subscriptions
+        def initialize: (client: Knockapi::Client) -> void
+      end
+    end
+  end
+end

data/sig/knockapi/resources/recipients.rbs

@@ -0,0 +1,13 @@
+module Knockapi
+  module Resources
+    class Recipients
+      attr_reader subscriptions: Knockapi::Resources::Recipients::Subscriptions
+
+      attr_reader preferences: Knockapi::Resources::Recipients::Preferences
+
+      attr_reader channel_data: Knockapi::Resources::Recipients::ChannelData
+
+      def initialize: (client: Knockapi::Client) -> void
+    end
+  end
+end

data/sig/knockapi/resources/schedules/bulk.rbs

@@ -0,0 +1,14 @@
+module Knockapi
+  module Resources
+    class Schedules
+      class Bulk
+        def create: (
+          schedules: ::Array[Knockapi::Schedules::BulkCreateParams::Schedule],
+          ?request_options: Knockapi::request_opts
+        ) -> Knockapi::BulkOperation
+
+        def initialize: (client: Knockapi::Client) -> void
+      end
+    end
+  end
+end

data/sig/knockapi/resources/schedules.rbs

@@ -0,0 +1,46 @@
+module Knockapi
+  module Resources
+    class Schedules
+      attr_reader bulk: Knockapi::Resources::Schedules::Bulk
+
+      def create: (
+        recipients: ::Array[Knockapi::Models::recipient_request],
+        repeats: ::Array[Knockapi::ScheduleRepeatRule],
+        workflow: String,
+        ?data: ::Hash[Symbol, top]?,
+        ?ending_at: Time?,
+        ?scheduled_at: Time?,
+        ?tenant: Knockapi::Models::inline_tenant_request?,
+        ?request_options: Knockapi::request_opts
+      ) -> Knockapi::Models::schedule_create_response
+
+      def update: (
+        schedule_ids: ::Array[String],
+        ?actor: Knockapi::Models::recipient_reference?,
+        ?data: ::Hash[Symbol, top]?,
+        ?ending_at: Time?,
+        ?repeats: ::Array[Knockapi::ScheduleRepeatRule],
+        ?scheduled_at: Time?,
+        ?tenant: Knockapi::Models::inline_tenant_request?,
+        ?request_options: Knockapi::request_opts
+      ) -> Knockapi::Models::schedule_update_response
+
+      def list: (
+        workflow: String,
+        ?after: String,
+        ?before: String,
+        ?page_size: Integer,
+        ?recipients: ::Array[String],
+        ?tenant: String,
+        ?request_options: Knockapi::request_opts
+      ) -> Knockapi::Internal::EntriesCursor[Knockapi::Schedule]
+
+      def delete: (
+        schedule_ids: ::Array[String],
+        ?request_options: Knockapi::request_opts
+      ) -> Knockapi::Models::schedule_delete_response
+
+      def initialize: (client: Knockapi::Client) -> void
+    end
+  end
+end

data/sig/knockapi/resources/shared.rbs

@@ -0,0 +1,7 @@
+module Knockapi
+  module Resources
+    class Shared
+      def initialize: (client: Knockapi::Client) -> void
+    end
+  end
+end

data/sig/knockapi/resources/tenants/bulk.rbs

@@ -0,0 +1,19 @@
+module Knockapi
+  module Resources
+    class Tenants
+      class Bulk
+        def delete: (
+          tenant_ids: ::Array[String],
+          ?request_options: Knockapi::request_opts
+        ) -> Knockapi::BulkOperation
+
+        def set: (
+          tenants: ::Array[Knockapi::Models::inline_tenant_request],
+          ?request_options: Knockapi::request_opts
+        ) -> Knockapi::BulkOperation
+
+        def initialize: (client: Knockapi::Client) -> void
+      end
+    end
+  end
+end

data/sig/knockapi/resources/tenants.rbs

@@ -0,0 +1,36 @@
+module Knockapi
+  module Resources
+    class Tenants
+      attr_reader bulk: Knockapi::Resources::Tenants::Bulk
+
+      def list: (
+        ?after: String,
+        ?before: String,
+        ?name: String,
+        ?page_size: Integer,
+        ?tenant_id: String,
+        ?request_options: Knockapi::request_opts
+      ) -> Knockapi::Internal::EntriesCursor[Knockapi::Tenant]
+
+      def delete: (
+        String id,
+        ?request_options: Knockapi::request_opts
+      ) -> String
+
+      def get: (
+        String id,
+        ?request_options: Knockapi::request_opts
+      ) -> Knockapi::Tenant
+
+      def set: (
+        String id,
+        ?channel_data: Knockapi::Models::Recipients::inline_channel_data_request?,
+        ?preferences: Knockapi::Models::Recipients::inline_preference_set_request?,
+        ?settings: Knockapi::TenantSetParams::Settings,
+        ?request_options: Knockapi::request_opts
+      ) -> Knockapi::Tenant
+
+      def initialize: (client: Knockapi::Client) -> void
+    end
+  end
+end

data/sig/knockapi/resources/users/bulk.rbs

@@ -0,0 +1,25 @@
+module Knockapi
+  module Resources
+    class Users
+      class Bulk
+        def delete: (
+          user_ids: ::Array[String],
+          ?request_options: Knockapi::request_opts
+        ) -> Knockapi::BulkOperation
+
+        def identify: (
+          users: ::Array[Knockapi::InlineIdentifyUserRequest],
+          ?request_options: Knockapi::request_opts
+        ) -> Knockapi::BulkOperation
+
+        def set_preferences: (
+          preferences: Knockapi::Recipients::PreferenceSetRequest,
+          user_ids: ::Array[String],
+          ?request_options: Knockapi::request_opts
+        ) -> Knockapi::BulkOperation
+
+        def initialize: (client: Knockapi::Client) -> void
+      end
+    end
+  end
+end

data/sig/knockapi/resources/users/feeds.rbs

@@ -0,0 +1,31 @@
+module Knockapi
+  module Resources
+    class Users
+      class Feeds
+        def get_settings: (
+          String user_id,
+          String id,
+          ?request_options: Knockapi::request_opts
+        ) -> Knockapi::Models::Users::FeedGetSettingsResponse
+
+        def list_items: (
+          String user_id,
+          String id,
+          ?after: String,
+          ?archived: Knockapi::Models::Users::FeedListItemsParams::archived,
+          ?before: String,
+          ?has_tenant: bool,
+          ?page_size: Integer,
+          ?source: String,
+          ?status: Knockapi::Models::Users::FeedListItemsParams::status,
+          ?tenant: String,
+          ?trigger_data: String,
+          ?workflow_categories: ::Array[String],
+          ?request_options: Knockapi::request_opts
+        ) -> Knockapi::Internal::EntriesCursor[Knockapi::Models::Users::FeedListItemsResponse]
+
+        def initialize: (client: Knockapi::Client) -> void
+      end
+    end
+  end
+end

data/sig/knockapi/resources/users/guides.rbs

@@ -0,0 +1,63 @@
+module Knockapi
+  module Resources
+    class Users
+      class Guides
+        def get_channel: (
+          String user_id,
+          String channel_id,
+          ?data: String,
+          ?tenant: String,
+          ?type: String,
+          ?request_options: Knockapi::request_opts
+        ) -> Knockapi::Models::Users::GuideGetChannelResponse
+
+        def mark_message_as_archived: (
+          String user_id,
+          String message_id,
+          channel_id: String,
+          guide_id: String,
+          guide_key: String,
+          guide_step_ref: String,
+          ?content: ::Hash[Symbol, top],
+          ?data: ::Hash[Symbol, top],
+          ?is_final: bool,
+          ?metadata: ::Hash[Symbol, top],
+          ?tenant: String?,
+          ?request_options: Knockapi::request_opts
+        ) -> Knockapi::Models::Users::GuideMarkMessageAsArchivedResponse
+
+        def mark_message_as_interacted: (
+          String user_id,
+          String message_id,
+          channel_id: String,
+          guide_id: String,
+          guide_key: String,
+          guide_step_ref: String,
+          ?content: ::Hash[Symbol, top],
+          ?data: ::Hash[Symbol, top],
+          ?is_final: bool,
+          ?metadata: ::Hash[Symbol, top],
+          ?tenant: String?,
+          ?request_options: Knockapi::request_opts
+        ) -> Knockapi::Models::Users::GuideMarkMessageAsInteractedResponse
+
+        def mark_message_as_seen: (
+          String user_id,
+          String message_id,
+          channel_id: String,
+          guide_id: String,
+          guide_key: String,
+          guide_step_ref: String,
+          ?content: ::Hash[Symbol, top],
+          ?data: ::Hash[Symbol, top],
+          ?is_final: bool,
+          ?metadata: ::Hash[Symbol, top],
+          ?tenant: String?,
+          ?request_options: Knockapi::request_opts
+        ) -> Knockapi::Models::Users::GuideMarkMessageAsSeenResponse
+
+        def initialize: (client: Knockapi::Client) -> void
+      end
+    end
+  end
+end

data/sig/knockapi/resources/users.rbs

@@ -0,0 +1,130 @@
+module Knockapi
+  module Resources
+    class Users
+      attr_reader feeds: Knockapi::Resources::Users::Feeds
+
+      attr_reader guides: Knockapi::Resources::Users::Guides
+
+      attr_reader bulk: Knockapi::Resources::Users::Bulk
+
+      def update: (
+        String user_id,
+        ?avatar: String?,
+        ?channel_data: Knockapi::Models::Recipients::inline_channel_data_request?,
+        ?created_at: Time?,
+        ?email: String?,
+        ?locale: String?,
+        ?name: String?,
+        ?phone_number: String?,
+        ?preferences: Knockapi::Models::Recipients::inline_preference_set_request?,
+        ?timezone: String?,
+        ?request_options: Knockapi::request_opts
+      ) -> Knockapi::User
+
+      def list: (
+        ?after: String,
+        ?before: String,
+        ?include: ::Array[Knockapi::UserListParams::include_],
+        ?page_size: Integer,
+        ?request_options: Knockapi::request_opts
+      ) -> Knockapi::Internal::EntriesCursor[Knockapi::User]
+
+      def delete: (
+        String user_id,
+        ?request_options: Knockapi::request_opts
+      ) -> String
+
+      def get: (
+        String user_id,
+        ?request_options: Knockapi::request_opts
+      ) -> Knockapi::User
+
+      def get_channel_data: (
+        String user_id,
+        String channel_id,
+        ?request_options: Knockapi::request_opts
+      ) -> Knockapi::Recipients::RecipientsChannelData
+
+      def get_preferences: (
+        String user_id,
+        String id,
+        ?tenant: String,
+        ?request_options: Knockapi::request_opts
+      ) -> Knockapi::Recipients::PreferenceSet
+
+      def list_messages: (
+        String user_id,
+        ?after: String,
+        ?before: String,
+        ?channel_id: String,
+        ?engagement_status: ::Array[Knockapi::UserListMessagesParams::engagement_status],
+        ?inserted_at: Knockapi::UserListMessagesParams::InsertedAt,
+        ?message_ids: ::Array[String],
+        ?page_size: Integer,
+        ?source: String,
+        ?status: ::Array[Knockapi::UserListMessagesParams::status],
+        ?tenant: String,
+        ?trigger_data: String,
+        ?workflow_categories: ::Array[String],
+        ?workflow_recipient_run_id: String,
+        ?workflow_run_id: String,
+        ?request_options: Knockapi::request_opts
+      ) -> Knockapi::Internal::EntriesCursor[Knockapi::Message]
+
+      def list_preferences: (
+        String user_id,
+        ?request_options: Knockapi::request_opts
+      ) -> Knockapi::Models::user_list_preferences_response
+
+      def list_schedules: (
+        String user_id,
+        ?after: String,
+        ?before: String,
+        ?page_size: Integer,
+        ?tenant: String,
+        ?workflow: String,
+        ?request_options: Knockapi::request_opts
+      ) -> Knockapi::Internal::EntriesCursor[Knockapi::Schedule]
+
+      def list_subscriptions: (
+        String user_id,
+        ?after: String,
+        ?before: String,
+        ?include: ::Array[Knockapi::UserListSubscriptionsParams::include_],
+        ?objects: ::Array[String],
+        ?page_size: Integer,
+        ?request_options: Knockapi::request_opts
+      ) -> Knockapi::Internal::EntriesCursor[Knockapi::Recipients::Subscription]
+
+      def merge: (
+        String user_id,
+        from_user_id: String,
+        ?request_options: Knockapi::request_opts
+      ) -> Knockapi::User
+
+      def set_channel_data: (
+        String user_id,
+        String channel_id,
+        data: Knockapi::Models::Recipients::ChannelDataRequest::data,
+        ?request_options: Knockapi::request_opts
+      ) -> Knockapi::Recipients::RecipientsChannelData
+
+      def set_preferences: (
+        String user_id,
+        String id,
+        ?categories: ::Hash[Symbol, Knockapi::Recipients::PreferenceSetRequest::category]?,
+        ?channel_types: Knockapi::Recipients::PreferenceSetChannelTypes?,
+        ?workflows: ::Hash[Symbol, Knockapi::Recipients::PreferenceSetRequest::workflow]?,
+        ?request_options: Knockapi::request_opts
+      ) -> Knockapi::Recipients::PreferenceSet
+
+      def unset_channel_data: (
+        String user_id,
+        String channel_id,
+        ?request_options: Knockapi::request_opts
+      ) -> String
+
+      def initialize: (client: Knockapi::Client) -> void
+    end
+  end
+end

data/sig/knockapi/resources/workflows.rbs

@@ -0,0 +1,24 @@
+module Knockapi
+  module Resources
+    class Workflows
+      def cancel: (
+        String key,
+        cancellation_key: String,
+        ?recipients: ::Array[Knockapi::Models::recipient_reference]?,
+        ?request_options: Knockapi::request_opts
+      ) -> String
+
+      def trigger: (
+        String key,
+        recipients: ::Array[Knockapi::Models::recipient_request],
+        ?actor: Knockapi::Models::recipient_request?,
+        ?cancellation_key: String?,
+        ?data: ::Hash[Symbol, top]?,
+        ?tenant: Knockapi::Models::inline_tenant_request?,
+        ?request_options: Knockapi::request_opts
+      ) -> Knockapi::Models::WorkflowTriggerResponse
+
+      def initialize: (client: Knockapi::Client) -> void
+    end
+  end
+end

data/sig/knockapi/version.rbs

@@ -0,0 +1,3 @@
+module Knockapi
+  VERSION: String
+end