knockapi 0.6.1 → 1.1.0

data/sig/knockapi/models/user_get_params.rbs

@@ -0,0 +1,12 @@
+module Knockapi
+  module Models
+    type user_get_params = {  } & Knockapi::Internal::Type::request_parameters
+
+    class UserGetParams < Knockapi::Internal::Type::BaseModel
+      extend Knockapi::Internal::Type::RequestParameters::Converter
+      include Knockapi::Internal::Type::RequestParameters
+
+      def initialize: (?request_options: Knockapi::request_opts) -> void
+    end
+  end
+end

data/sig/knockapi/models/user_get_preferences_params.rbs

@@ -0,0 +1,20 @@
+module Knockapi
+  module Models
+    type user_get_preferences_params =
+      { tenant: String } & Knockapi::Internal::Type::request_parameters
+
+    class UserGetPreferencesParams < Knockapi::Internal::Type::BaseModel
+      extend Knockapi::Internal::Type::RequestParameters::Converter
+      include Knockapi::Internal::Type::RequestParameters
+
+      attr_reader tenant: String?
+
+      def tenant=: (String) -> String
+
+      def initialize: (
+        ?tenant: String,
+        ?request_options: Knockapi::request_opts
+      ) -> void
+    end
+  end
+end

data/sig/knockapi/models/user_list_messages_params.rbs

@@ -0,0 +1,172 @@
+module Knockapi
+  module Models
+    type user_list_messages_params =
+      {
+        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
+      }
+      & Knockapi::Internal::Type::request_parameters
+
+    class UserListMessagesParams < Knockapi::Internal::Type::BaseModel
+      extend Knockapi::Internal::Type::RequestParameters::Converter
+      include Knockapi::Internal::Type::RequestParameters
+
+      attr_reader after: String?
+
+      def after=: (String) -> String
+
+      attr_reader before: String?
+
+      def before=: (String) -> String
+
+      attr_reader channel_id: String?
+
+      def channel_id=: (String) -> String
+
+      attr_reader engagement_status: ::Array[Knockapi::UserListMessagesParams::engagement_status]?
+
+      def engagement_status=: (
+        ::Array[Knockapi::UserListMessagesParams::engagement_status]
+      ) -> ::Array[Knockapi::UserListMessagesParams::engagement_status]
+
+      attr_reader inserted_at: Knockapi::UserListMessagesParams::InsertedAt?
+
+      def inserted_at=: (
+        Knockapi::UserListMessagesParams::InsertedAt
+      ) -> Knockapi::UserListMessagesParams::InsertedAt
+
+      attr_reader message_ids: ::Array[String]?
+
+      def message_ids=: (::Array[String]) -> ::Array[String]
+
+      attr_reader page_size: Integer?
+
+      def page_size=: (Integer) -> Integer
+
+      attr_reader source: String?
+
+      def source=: (String) -> String
+
+      attr_reader status: ::Array[Knockapi::UserListMessagesParams::status]?
+
+      def status=: (
+        ::Array[Knockapi::UserListMessagesParams::status]
+      ) -> ::Array[Knockapi::UserListMessagesParams::status]
+
+      attr_reader tenant: String?
+
+      def tenant=: (String) -> String
+
+      attr_reader trigger_data: String?
+
+      def trigger_data=: (String) -> String
+
+      attr_reader workflow_categories: ::Array[String]?
+
+      def workflow_categories=: (::Array[String]) -> ::Array[String]
+
+      attr_reader workflow_recipient_run_id: String?
+
+      def workflow_recipient_run_id=: (String) -> String
+
+      attr_reader workflow_run_id: String?
+
+      def workflow_run_id=: (String) -> String
+
+      def initialize: (
+        ?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
+      ) -> void
+
+      type engagement_status =
+        :seen | :read | :interacted | :link_clicked | :archived
+
+      module EngagementStatus
+        extend Knockapi::Internal::Type::Enum
+
+        SEEN: :seen
+        READ: :read
+        INTERACTED: :interacted
+        LINK_CLICKED: :link_clicked
+        ARCHIVED: :archived
+
+        def self?.values: -> ::Array[Knockapi::UserListMessagesParams::engagement_status]
+      end
+
+      type inserted_at = { gt: String, gte: String, lt: String, lte: String }
+
+      class InsertedAt < Knockapi::Internal::Type::BaseModel
+        attr_reader gt: String?
+
+        def gt=: (String) -> String
+
+        attr_reader gte: String?
+
+        def gte=: (String) -> String
+
+        attr_reader lt: String?
+
+        def lt=: (String) -> String
+
+        attr_reader lte: String?
+
+        def lte=: (String) -> String
+
+        def initialize: (
+          ?gt: String,
+          ?gte: String,
+          ?lt: String,
+          ?lte: String
+        ) -> void
+      end
+
+      type status =
+        :queued
+        | :sent
+        | :delivered
+        | :delivery_attempted
+        | :undelivered
+        | :not_sent
+        | :bounced
+
+      module Status
+        extend Knockapi::Internal::Type::Enum
+
+        QUEUED: :queued
+        SENT: :sent
+        DELIVERED: :delivered
+        DELIVERY_ATTEMPTED: :delivery_attempted
+        UNDELIVERED: :undelivered
+        NOT_SENT: :not_sent
+        BOUNCED: :bounced
+
+        def self?.values: -> ::Array[Knockapi::UserListMessagesParams::status]
+      end
+    end
+  end
+end

data/sig/knockapi/models/user_list_params.rbs

@@ -0,0 +1,53 @@
+module Knockapi
+  module Models
+    type user_list_params =
+      {
+        after: String,
+        before: String,
+        include: ::Array[Knockapi::UserListParams::include_],
+        page_size: Integer
+      }
+      & Knockapi::Internal::Type::request_parameters
+
+    class UserListParams < Knockapi::Internal::Type::BaseModel
+      extend Knockapi::Internal::Type::RequestParameters::Converter
+      include Knockapi::Internal::Type::RequestParameters
+
+      attr_reader after: String?
+
+      def after=: (String) -> String
+
+      attr_reader before: String?
+
+      def before=: (String) -> String
+
+      attr_reader include: ::Array[Knockapi::UserListParams::include_]?
+
+      def include=: (
+        ::Array[Knockapi::UserListParams::include_]
+      ) -> ::Array[Knockapi::UserListParams::include_]
+
+      attr_reader page_size: Integer?
+
+      def page_size=: (Integer) -> Integer
+
+      def initialize: (
+        ?after: String,
+        ?before: String,
+        ?include: ::Array[Knockapi::UserListParams::include_],
+        ?page_size: Integer,
+        ?request_options: Knockapi::request_opts
+      ) -> void
+
+      type include_ = :preferences
+
+      module Include
+        extend Knockapi::Internal::Type::Enum
+
+        PREFERENCES: :preferences
+
+        def self?.values: -> ::Array[Knockapi::UserListParams::include_]
+      end
+    end
+  end
+end

data/sig/knockapi/models/user_list_preferences_params.rbs

@@ -0,0 +1,13 @@
+module Knockapi
+  module Models
+    type user_list_preferences_params =
+      {  } & Knockapi::Internal::Type::request_parameters
+
+    class UserListPreferencesParams < Knockapi::Internal::Type::BaseModel
+      extend Knockapi::Internal::Type::RequestParameters::Converter
+      include Knockapi::Internal::Type::RequestParameters
+
+      def initialize: (?request_options: Knockapi::request_opts) -> void
+    end
+  end
+end

data/sig/knockapi/models/user_list_preferences_response.rbs

@@ -0,0 +1,8 @@
+module Knockapi
+  module Models
+    type user_list_preferences_response =
+      ::Array[Knockapi::Recipients::PreferenceSet]
+
+    UserListPreferencesResponse: Knockapi::Internal::Type::Converter
+  end
+end

data/sig/knockapi/models/user_list_schedules_params.rbs

@@ -0,0 +1,47 @@
+module Knockapi
+  module Models
+    type user_list_schedules_params =
+      {
+        after: String,
+        before: String,
+        page_size: Integer,
+        tenant: String,
+        workflow: String
+      }
+      & Knockapi::Internal::Type::request_parameters
+
+    class UserListSchedulesParams < Knockapi::Internal::Type::BaseModel
+      extend Knockapi::Internal::Type::RequestParameters::Converter
+      include Knockapi::Internal::Type::RequestParameters
+
+      attr_reader after: String?
+
+      def after=: (String) -> String
+
+      attr_reader before: String?
+
+      def before=: (String) -> String
+
+      attr_reader page_size: Integer?
+
+      def page_size=: (Integer) -> Integer
+
+      attr_reader tenant: String?
+
+      def tenant=: (String) -> String
+
+      attr_reader workflow: String?
+
+      def workflow=: (String) -> String
+
+      def initialize: (
+        ?after: String,
+        ?before: String,
+        ?page_size: Integer,
+        ?tenant: String,
+        ?workflow: String,
+        ?request_options: Knockapi::request_opts
+      ) -> void
+    end
+  end
+end

data/sig/knockapi/models/user_list_subscriptions_params.rbs

@@ -0,0 +1,59 @@
+module Knockapi
+  module Models
+    type user_list_subscriptions_params =
+      {
+        after: String,
+        before: String,
+        include: ::Array[Knockapi::UserListSubscriptionsParams::include_],
+        objects: ::Array[String],
+        page_size: Integer
+      }
+      & Knockapi::Internal::Type::request_parameters
+
+    class UserListSubscriptionsParams < Knockapi::Internal::Type::BaseModel
+      extend Knockapi::Internal::Type::RequestParameters::Converter
+      include Knockapi::Internal::Type::RequestParameters
+
+      attr_reader after: String?
+
+      def after=: (String) -> String
+
+      attr_reader before: String?
+
+      def before=: (String) -> String
+
+      attr_reader include: ::Array[Knockapi::UserListSubscriptionsParams::include_]?
+
+      def include=: (
+        ::Array[Knockapi::UserListSubscriptionsParams::include_]
+      ) -> ::Array[Knockapi::UserListSubscriptionsParams::include_]
+
+      attr_reader objects: ::Array[String]?
+
+      def objects=: (::Array[String]) -> ::Array[String]
+
+      attr_reader page_size: Integer?
+
+      def page_size=: (Integer) -> Integer
+
+      def initialize: (
+        ?after: String,
+        ?before: String,
+        ?include: ::Array[Knockapi::UserListSubscriptionsParams::include_],
+        ?objects: ::Array[String],
+        ?page_size: Integer,
+        ?request_options: Knockapi::request_opts
+      ) -> void
+
+      type include_ = :preferences
+
+      module Include
+        extend Knockapi::Internal::Type::Enum
+
+        PREFERENCES: :preferences
+
+        def self?.values: -> ::Array[Knockapi::UserListSubscriptionsParams::include_]
+      end
+    end
+  end
+end

data/sig/knockapi/models/user_merge_params.rbs

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

data/sig/knockapi/models/user_set_channel_data_params.rbs

@@ -0,0 +1,13 @@
+module Knockapi
+  module Models
+    type user_set_channel_data_params =
+      {  } & Knockapi::Internal::Type::request_parameters
+
+    class UserSetChannelDataParams < Knockapi::Models::Recipients::ChannelDataRequest
+      extend Knockapi::Internal::Type::RequestParameters::Converter
+      include Knockapi::Internal::Type::RequestParameters
+
+      def initialize: (?request_options: Knockapi::request_opts) -> void
+    end
+  end
+end

data/sig/knockapi/models/user_set_preferences_params.rbs

@@ -0,0 +1,13 @@
+module Knockapi
+  module Models
+    type user_set_preferences_params =
+      {  } & Knockapi::Internal::Type::request_parameters
+
+    class UserSetPreferencesParams < Knockapi::Models::Recipients::PreferenceSetRequest
+      extend Knockapi::Internal::Type::RequestParameters::Converter
+      include Knockapi::Internal::Type::RequestParameters
+
+      def initialize: (?request_options: Knockapi::request_opts) -> void
+    end
+  end
+end

data/sig/knockapi/models/user_unset_channel_data_params.rbs

@@ -0,0 +1,13 @@
+module Knockapi
+  module Models
+    type user_unset_channel_data_params =
+      {  } & Knockapi::Internal::Type::request_parameters
+
+    class UserUnsetChannelDataParams < Knockapi::Internal::Type::BaseModel
+      extend Knockapi::Internal::Type::RequestParameters::Converter
+      include Knockapi::Internal::Type::RequestParameters
+
+      def initialize: (?request_options: Knockapi::request_opts) -> void
+    end
+  end
+end

data/sig/knockapi/models/user_unset_channel_data_response.rbs

@@ -0,0 +1,5 @@
+module Knockapi
+  module Models
+    class UserUnsetChannelDataResponse = String
+  end
+end

data/sig/knockapi/models/user_update_params.rbs

@@ -0,0 +1,13 @@
+module Knockapi
+  module Models
+    type user_update_params =
+      {  } & Knockapi::Internal::Type::request_parameters
+
+    class UserUpdateParams < Knockapi::Models::IdentifyUserRequest
+      extend Knockapi::Internal::Type::RequestParameters::Converter
+      include Knockapi::Internal::Type::RequestParameters
+
+      def initialize: (?request_options: Knockapi::request_opts) -> void
+    end
+  end
+end

data/sig/knockapi/models/users/bulk_delete_params.rbs

@@ -0,0 +1,21 @@
+module Knockapi
+  module Models
+    module Users
+      type bulk_delete_params =
+        { user_ids: ::Array[String] }
+        & Knockapi::Internal::Type::request_parameters
+
+      class BulkDeleteParams < Knockapi::Internal::Type::BaseModel
+        extend Knockapi::Internal::Type::RequestParameters::Converter
+        include Knockapi::Internal::Type::RequestParameters
+
+        attr_accessor user_ids: ::Array[String]
+
+        def initialize: (
+          user_ids: ::Array[String],
+          ?request_options: Knockapi::request_opts
+        ) -> void
+      end
+    end
+  end
+end

data/sig/knockapi/models/users/bulk_identify_params.rbs

@@ -0,0 +1,21 @@
+module Knockapi
+  module Models
+    module Users
+      type bulk_identify_params =
+        { users: ::Array[Knockapi::InlineIdentifyUserRequest] }
+        & Knockapi::Internal::Type::request_parameters
+
+      class BulkIdentifyParams < Knockapi::Internal::Type::BaseModel
+        extend Knockapi::Internal::Type::RequestParameters::Converter
+        include Knockapi::Internal::Type::RequestParameters
+
+        attr_accessor users: ::Array[Knockapi::InlineIdentifyUserRequest]
+
+        def initialize: (
+          users: ::Array[Knockapi::InlineIdentifyUserRequest],
+          ?request_options: Knockapi::request_opts
+        ) -> void
+      end
+    end
+  end
+end

data/sig/knockapi/models/users/bulk_set_preferences_params.rbs

@@ -0,0 +1,27 @@
+module Knockapi
+  module Models
+    module Users
+      type bulk_set_preferences_params =
+        {
+          preferences: Knockapi::Recipients::PreferenceSetRequest,
+          user_ids: ::Array[String]
+        }
+        & Knockapi::Internal::Type::request_parameters
+
+      class BulkSetPreferencesParams < Knockapi::Internal::Type::BaseModel
+        extend Knockapi::Internal::Type::RequestParameters::Converter
+        include Knockapi::Internal::Type::RequestParameters
+
+        attr_accessor preferences: Knockapi::Recipients::PreferenceSetRequest
+
+        attr_accessor user_ids: ::Array[String]
+
+        def initialize: (
+          preferences: Knockapi::Recipients::PreferenceSetRequest,
+          user_ids: ::Array[String],
+          ?request_options: Knockapi::request_opts
+        ) -> void
+      end
+    end
+  end
+end

data/sig/knockapi/models/users/feed_get_settings_params.rbs

@@ -0,0 +1,15 @@
+module Knockapi
+  module Models
+    module Users
+      type feed_get_settings_params =
+        {  } & Knockapi::Internal::Type::request_parameters
+
+      class FeedGetSettingsParams < Knockapi::Internal::Type::BaseModel
+        extend Knockapi::Internal::Type::RequestParameters::Converter
+        include Knockapi::Internal::Type::RequestParameters
+
+        def initialize: (?request_options: Knockapi::request_opts) -> void
+      end
+    end
+  end
+end

data/sig/knockapi/models/users/feed_get_settings_response.rbs

@@ -0,0 +1,24 @@
+module Knockapi
+  module Models
+    module Users
+      type feed_get_settings_response =
+        { features: Knockapi::Models::Users::FeedGetSettingsResponse::Features }
+
+      class FeedGetSettingsResponse < Knockapi::Internal::Type::BaseModel
+        attr_accessor features: Knockapi::Models::Users::FeedGetSettingsResponse::Features
+
+        def initialize: (
+          features: Knockapi::Models::Users::FeedGetSettingsResponse::Features
+        ) -> void
+
+        type features = { branding_required: bool }
+
+        class Features < Knockapi::Internal::Type::BaseModel
+          attr_accessor branding_required: bool
+
+          def initialize: (branding_required: bool) -> void
+        end
+      end
+    end
+  end
+end