knockapi 0.6.1 → 1.1.0

data/sig/knockapi/models/workflow_trigger_params.rbs

@@ -0,0 +1,37 @@
+module Knockapi
+  module Models
+    type workflow_trigger_params =
+      {
+        recipients: ::Array[Knockapi::Models::recipient_request],
+        actor: Knockapi::Models::recipient_request?,
+        cancellation_key: String?,
+        data: ::Hash[Symbol, top]?,
+        tenant: Knockapi::Models::inline_tenant_request?
+      }
+      & Knockapi::Internal::Type::request_parameters
+
+    class WorkflowTriggerParams < Knockapi::Internal::Type::BaseModel
+      extend Knockapi::Internal::Type::RequestParameters::Converter
+      include Knockapi::Internal::Type::RequestParameters
+
+      attr_accessor recipients: ::Array[Knockapi::Models::recipient_request]
+
+      attr_accessor actor: Knockapi::Models::recipient_request?
+
+      attr_accessor cancellation_key: String?
+
+      attr_accessor data: ::Hash[Symbol, top]?
+
+      attr_accessor tenant: Knockapi::Models::inline_tenant_request?
+
+      def initialize: (
+        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
+      ) -> void
+    end
+  end
+end

data/sig/knockapi/models/workflow_trigger_response.rbs

@@ -0,0 +1,11 @@
+module Knockapi
+  module Models
+    type workflow_trigger_response = { workflow_run_id: String }
+
+    class WorkflowTriggerResponse < Knockapi::Internal::Type::BaseModel
+      attr_accessor workflow_run_id: String
+
+      def initialize: (workflow_run_id: String) -> void
+    end
+  end
+end

data/sig/knockapi/models.rbs

@@ -0,0 +1,173 @@
+module Knockapi
+  class Activity = Knockapi::Models::Activity
+
+  class AudienceAddMembersParams = Knockapi::Models::AudienceAddMembersParams
+
+  class AudienceListMembersParams = Knockapi::Models::AudienceListMembersParams
+
+  class AudienceMember = Knockapi::Models::AudienceMember
+
+  class AudienceRemoveMembersParams = Knockapi::Models::AudienceRemoveMembersParams
+
+  class BulkOperation = Knockapi::Models::BulkOperation
+
+  class BulkOperationGetParams = Knockapi::Models::BulkOperationGetParams
+
+  module Channels = Knockapi::Models::Channels
+
+  class Condition = Knockapi::Models::Condition
+
+  class IdentifyUserRequest = Knockapi::Models::IdentifyUserRequest
+
+  class InlineIdentifyUserRequest = Knockapi::Models::InlineIdentifyUserRequest
+
+  class InlineObjectRequest = Knockapi::Models::InlineObjectRequest
+
+  module InlineTenantRequest = Knockapi::Models::InlineTenantRequest
+
+  module Integrations = Knockapi::Models::Integrations
+
+  class Message = Knockapi::Models::Message
+
+  class MessageArchiveParams = Knockapi::Models::MessageArchiveParams
+
+  class MessageDeliveryLog = Knockapi::Models::MessageDeliveryLog
+
+  class MessageEvent = Knockapi::Models::MessageEvent
+
+  class MessageGetContentParams = Knockapi::Models::MessageGetContentParams
+
+  class MessageGetParams = Knockapi::Models::MessageGetParams
+
+  class MessageListActivitiesParams = Knockapi::Models::MessageListActivitiesParams
+
+  class MessageListDeliveryLogsParams = Knockapi::Models::MessageListDeliveryLogsParams
+
+  class MessageListEventsParams = Knockapi::Models::MessageListEventsParams
+
+  class MessageListParams = Knockapi::Models::MessageListParams
+
+  class MessageMarkAsInteractedParams = Knockapi::Models::MessageMarkAsInteractedParams
+
+  class MessageMarkAsReadParams = Knockapi::Models::MessageMarkAsReadParams
+
+  class MessageMarkAsSeenParams = Knockapi::Models::MessageMarkAsSeenParams
+
+  class MessageMarkAsUnreadParams = Knockapi::Models::MessageMarkAsUnreadParams
+
+  class MessageMarkAsUnseenParams = Knockapi::Models::MessageMarkAsUnseenParams
+
+  module Messages = Knockapi::Models::Messages
+
+  class MessageUnarchiveParams = Knockapi::Models::MessageUnarchiveParams
+
+  class Object = Knockapi::Models::Object
+
+  class ObjectAddSubscriptionsParams = Knockapi::Models::ObjectAddSubscriptionsParams
+
+  class ObjectDeleteParams = Knockapi::Models::ObjectDeleteParams
+
+  class ObjectDeleteSubscriptionsParams = Knockapi::Models::ObjectDeleteSubscriptionsParams
+
+  class ObjectGetChannelDataParams = Knockapi::Models::ObjectGetChannelDataParams
+
+  class ObjectGetParams = Knockapi::Models::ObjectGetParams
+
+  class ObjectGetPreferencesParams = Knockapi::Models::ObjectGetPreferencesParams
+
+  class ObjectListMessagesParams = Knockapi::Models::ObjectListMessagesParams
+
+  class ObjectListParams = Knockapi::Models::ObjectListParams
+
+  class ObjectListPreferencesParams = Knockapi::Models::ObjectListPreferencesParams
+
+  class ObjectListSchedulesParams = Knockapi::Models::ObjectListSchedulesParams
+
+  class ObjectListSubscriptionsParams = Knockapi::Models::ObjectListSubscriptionsParams
+
+  module Objects = Knockapi::Models::Objects
+
+  class ObjectSetChannelDataParams = Knockapi::Models::ObjectSetChannelDataParams
+
+  class ObjectSetParams = Knockapi::Models::ObjectSetParams
+
+  class ObjectSetPreferencesParams = Knockapi::Models::ObjectSetPreferencesParams
+
+  class ObjectUnsetChannelDataParams = Knockapi::Models::ObjectUnsetChannelDataParams
+
+  class PageInfo = Knockapi::Models::PageInfo
+
+  module Providers = Knockapi::Models::Providers
+
+  module Recipient = Knockapi::Models::Recipient
+
+  module RecipientReference = Knockapi::Models::RecipientReference
+
+  module RecipientRequest = Knockapi::Models::RecipientRequest
+
+  module Recipients = Knockapi::Models::Recipients
+
+  class Schedule = Knockapi::Models::Schedule
+
+  class ScheduleCreateParams = Knockapi::Models::ScheduleCreateParams
+
+  class ScheduleDeleteParams = Knockapi::Models::ScheduleDeleteParams
+
+  class ScheduleListParams = Knockapi::Models::ScheduleListParams
+
+  class ScheduleRepeatRule = Knockapi::Models::ScheduleRepeatRule
+
+  module Schedules = Knockapi::Models::Schedules
+
+  class ScheduleUpdateParams = Knockapi::Models::ScheduleUpdateParams
+
+  class Tenant = Knockapi::Models::Tenant
+
+  class TenantDeleteParams = Knockapi::Models::TenantDeleteParams
+
+  class TenantGetParams = Knockapi::Models::TenantGetParams
+
+  class TenantListParams = Knockapi::Models::TenantListParams
+
+  class TenantRequest = Knockapi::Models::TenantRequest
+
+  module Tenants = Knockapi::Models::Tenants
+
+  class TenantSetParams = Knockapi::Models::TenantSetParams
+
+  class User = Knockapi::Models::User
+
+  class UserDeleteParams = Knockapi::Models::UserDeleteParams
+
+  class UserGetChannelDataParams = Knockapi::Models::UserGetChannelDataParams
+
+  class UserGetParams = Knockapi::Models::UserGetParams
+
+  class UserGetPreferencesParams = Knockapi::Models::UserGetPreferencesParams
+
+  class UserListMessagesParams = Knockapi::Models::UserListMessagesParams
+
+  class UserListParams = Knockapi::Models::UserListParams
+
+  class UserListPreferencesParams = Knockapi::Models::UserListPreferencesParams
+
+  class UserListSchedulesParams = Knockapi::Models::UserListSchedulesParams
+
+  class UserListSubscriptionsParams = Knockapi::Models::UserListSubscriptionsParams
+
+  class UserMergeParams = Knockapi::Models::UserMergeParams
+
+  module Users = Knockapi::Models::Users
+
+  class UserSetChannelDataParams = Knockapi::Models::UserSetChannelDataParams
+
+  class UserSetPreferencesParams = Knockapi::Models::UserSetPreferencesParams
+
+  class UserUnsetChannelDataParams = Knockapi::Models::UserUnsetChannelDataParams
+
+  class UserUpdateParams = Knockapi::Models::UserUpdateParams
+
+  class WorkflowCancelParams = Knockapi::Models::WorkflowCancelParams
+
+  class WorkflowTriggerParams = Knockapi::Models::WorkflowTriggerParams
+end

data/sig/knockapi/request_options.rbs

@@ -0,0 +1,34 @@
+module Knockapi
+  type request_opts =
+    Knockapi::RequestOptions | Knockapi::request_options | ::Hash[Symbol, top]
+
+  type request_options =
+    {
+      idempotency_key: String?,
+      extra_query: ::Hash[String, (::Array[String] | String)?]?,
+      extra_headers: ::Hash[String, String?]?,
+      extra_body: top?,
+      max_retries: Integer?,
+      timeout: Float?
+    }
+
+  class RequestOptions < Knockapi::Internal::Type::BaseModel
+    def self.validate!: (Knockapi::request_opts opts) -> void
+
+    attr_accessor idempotency_key: String?
+
+    attr_accessor extra_query: ::Hash[String, (::Array[String] | String)?]?
+
+    attr_accessor extra_headers: ::Hash[String, String?]?
+
+    attr_accessor extra_body: top?
+
+    attr_accessor max_retries: Integer?
+
+    attr_accessor timeout: Float?
+
+    def initialize: (
+      ?Knockapi::request_options | ::Hash[Symbol, top] values
+    ) -> void
+  end
+end

data/sig/knockapi/resources/audiences.rbs

@@ -0,0 +1,24 @@
+module Knockapi
+  module Resources
+    class Audiences
+      def add_members: (
+        String key,
+        members: ::Array[Knockapi::AudienceAddMembersParams::Member],
+        ?request_options: Knockapi::request_opts
+      ) -> String
+
+      def list_members: (
+        String key,
+        ?request_options: Knockapi::request_opts
+      ) -> Knockapi::Models::AudienceListMembersResponse
+
+      def remove_members: (
+        String key,
+        members: ::Array[Knockapi::AudienceRemoveMembersParams::Member],
+        ?request_options: Knockapi::request_opts
+      ) -> String
+
+      def initialize: (client: Knockapi::Client) -> void
+    end
+  end
+end

data/sig/knockapi/resources/bulk_operations.rbs

@@ -0,0 +1,12 @@
+module Knockapi
+  module Resources
+    class BulkOperations
+      def get: (
+        String id,
+        ?request_options: Knockapi::request_opts
+      ) -> Knockapi::BulkOperation
+
+      def initialize: (client: Knockapi::Client) -> void
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+module Knockapi
+  module Resources
+    class Channels
+      class Bulk
+        def update_message_status: (
+          String channel_id,
+          Knockapi::Models::Channels::BulkUpdateMessageStatusParams::action action,
+          ?archived: Knockapi::Models::Channels::BulkUpdateMessageStatusParams::archived,
+          ?delivery_status: Knockapi::Models::Channels::BulkUpdateMessageStatusParams::delivery_status,
+          ?engagement_status: Knockapi::Models::Channels::BulkUpdateMessageStatusParams::engagement_status,
+          ?has_tenant: bool,
+          ?newer_than: Time,
+          ?older_than: Time,
+          ?recipient_ids: ::Array[String],
+          ?tenants: ::Array[String],
+          ?trigger_data: String,
+          ?workflows: ::Array[String],
+          ?request_options: Knockapi::request_opts
+        ) -> Knockapi::BulkOperation
+
+        def initialize: (client: Knockapi::Client) -> void
+      end
+    end
+  end
+end

data/sig/knockapi/resources/channels.rbs

@@ -0,0 +1,9 @@
+module Knockapi
+  module Resources
+    class Channels
+      attr_reader bulk: Knockapi::Resources::Channels::Bulk
+
+      def initialize: (client: Knockapi::Client) -> void
+    end
+  end
+end

data/sig/knockapi/resources/integrations/census.rbs

@@ -0,0 +1,17 @@
+module Knockapi
+  module Resources
+    class Integrations
+      class Census
+        def custom_destination: (
+          id: String,
+          jsonrpc: String,
+          method_: String,
+          ?params: ::Hash[Symbol, top],
+          ?request_options: Knockapi::request_opts
+        ) -> Knockapi::Models::Integrations::CensusCustomDestinationResponse
+
+        def initialize: (client: Knockapi::Client) -> void
+      end
+    end
+  end
+end

data/sig/knockapi/resources/integrations/hightouch.rbs

@@ -0,0 +1,17 @@
+module Knockapi
+  module Resources
+    class Integrations
+      class Hightouch
+        def embedded_destination: (
+          id: String,
+          jsonrpc: String,
+          method_: String,
+          ?params: ::Hash[Symbol, top],
+          ?request_options: Knockapi::request_opts
+        ) -> Knockapi::Models::Integrations::HightouchEmbeddedDestinationResponse
+
+        def initialize: (client: Knockapi::Client) -> void
+      end
+    end
+  end
+end

data/sig/knockapi/resources/integrations.rbs

@@ -0,0 +1,11 @@
+module Knockapi
+  module Resources
+    class Integrations
+      attr_reader census: Knockapi::Resources::Integrations::Census
+
+      attr_reader hightouch: Knockapi::Resources::Integrations::Hightouch
+
+      def initialize: (client: Knockapi::Client) -> void
+    end
+  end
+end

data/sig/knockapi/resources/messages/batch.rbs

@@ -0,0 +1,50 @@
+module Knockapi
+  module Resources
+    class Messages
+      class Batch
+        def archive: (
+          message_ids: ::Array[String],
+          ?request_options: Knockapi::request_opts
+        ) -> Knockapi::Models::Messages::batch_archive_response
+
+        def get_content: (
+          message_ids: ::Array[String],
+          ?request_options: Knockapi::request_opts
+        ) -> Knockapi::Models::Messages::batch_get_content_response
+
+        def mark_as_interacted: (
+          message_ids: ::Array[String],
+          ?metadata: ::Hash[Symbol, top]?,
+          ?request_options: Knockapi::request_opts
+        ) -> Knockapi::Models::Messages::batch_mark_as_interacted_response
+
+        def mark_as_read: (
+          message_ids: ::Array[String],
+          ?request_options: Knockapi::request_opts
+        ) -> Knockapi::Models::Messages::batch_mark_as_read_response
+
+        def mark_as_seen: (
+          message_ids: ::Array[String],
+          ?request_options: Knockapi::request_opts
+        ) -> Knockapi::Models::Messages::batch_mark_as_seen_response
+
+        def mark_as_unread: (
+          message_ids: ::Array[String],
+          ?request_options: Knockapi::request_opts
+        ) -> Knockapi::Models::Messages::batch_mark_as_unread_response
+
+        def mark_as_unseen: (
+          message_ids: ::Array[String],
+          ?request_options: Knockapi::request_opts
+        ) -> Knockapi::Models::Messages::batch_mark_as_unseen_response
+
+        def unarchive: (
+          message_ids: ::Array[String],
+          ?request_options: Knockapi::request_opts
+        ) -> Knockapi::Models::Messages::batch_unarchive_response
+
+        def initialize: (client: Knockapi::Client) -> void
+      end
+    end
+  end
+end

data/sig/knockapi/resources/messages.rbs

@@ -0,0 +1,98 @@
+module Knockapi
+  module Resources
+    class Messages
+      attr_reader batch: Knockapi::Resources::Messages::Batch
+
+      def list: (
+        ?after: String,
+        ?before: String,
+        ?channel_id: String,
+        ?engagement_status: ::Array[Knockapi::MessageListParams::engagement_status],
+        ?inserted_at: Knockapi::MessageListParams::InsertedAt,
+        ?message_ids: ::Array[String],
+        ?page_size: Integer,
+        ?source: String,
+        ?status: ::Array[Knockapi::MessageListParams::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 archive: (
+        String message_id,
+        ?request_options: Knockapi::request_opts
+      ) -> Knockapi::Message
+
+      def get: (
+        String message_id,
+        ?request_options: Knockapi::request_opts
+      ) -> Knockapi::Message
+
+      def get_content: (
+        String message_id,
+        ?request_options: Knockapi::request_opts
+      ) -> Knockapi::Models::MessageGetContentResponse
+
+      def list_activities: (
+        String message_id,
+        ?after: String,
+        ?before: String,
+        ?page_size: Integer,
+        ?trigger_data: String,
+        ?request_options: Knockapi::request_opts
+      ) -> Knockapi::Internal::ItemsCursor[Knockapi::Activity]
+
+      def list_delivery_logs: (
+        String message_id,
+        ?after: String,
+        ?before: String,
+        ?page_size: Integer,
+        ?request_options: Knockapi::request_opts
+      ) -> Knockapi::Internal::EntriesCursor[Knockapi::MessageDeliveryLog]
+
+      def list_events: (
+        String message_id,
+        ?after: String,
+        ?before: String,
+        ?page_size: Integer,
+        ?request_options: Knockapi::request_opts
+      ) -> Knockapi::Internal::EntriesCursor[Knockapi::MessageEvent]
+
+      def mark_as_interacted: (
+        String message_id,
+        ?metadata: ::Hash[Symbol, top],
+        ?request_options: Knockapi::request_opts
+      ) -> Knockapi::Message
+
+      def mark_as_read: (
+        String message_id,
+        ?request_options: Knockapi::request_opts
+      ) -> Knockapi::Message
+
+      def mark_as_seen: (
+        String message_id,
+        ?request_options: Knockapi::request_opts
+      ) -> Knockapi::Message
+
+      def mark_as_unread: (
+        String message_id,
+        ?request_options: Knockapi::request_opts
+      ) -> Knockapi::Message
+
+      def mark_as_unseen: (
+        String message_id,
+        ?request_options: Knockapi::request_opts
+      ) -> Knockapi::Message
+
+      def unarchive: (
+        String message_id,
+        ?request_options: Knockapi::request_opts
+      ) -> Knockapi::Message
+
+      def initialize: (client: Knockapi::Client) -> void
+    end
+  end
+end

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

@@ -0,0 +1,27 @@
+module Knockapi
+  module Resources
+    class Objects
+      class Bulk
+        def delete: (
+          String collection,
+          object_ids: ::Array[String],
+          ?request_options: Knockapi::request_opts
+        ) -> Knockapi::BulkOperation
+
+        def add_subscriptions: (
+          String collection,
+          subscriptions: ::Array[Knockapi::Objects::BulkAddSubscriptionsParams::Subscription],
+          ?request_options: Knockapi::request_opts
+        ) -> Knockapi::BulkOperation
+
+        def set: (
+          String collection,
+          objects: ::Array[Knockapi::InlineObjectRequest],
+          ?request_options: Knockapi::request_opts
+        ) -> Knockapi::BulkOperation
+
+        def initialize: (client: Knockapi::Client) -> void
+      end
+    end
+  end
+end