knockapi 0.6.1 → 1.0.0

data/sig/knockapi/models/object_get_channel_data_params.rbs

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

data/sig/knockapi/models/object_get_params.rbs

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

data/sig/knockapi/models/object_get_preferences_params.rbs

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

data/sig/knockapi/models/object_list_messages_params.rbs

@@ -0,0 +1,176 @@
+module Knockapi
+  module Models
+    type object_list_messages_params =
+      {
+        after: String,
+        before: String,
+        channel_id: String,
+        engagement_status: ::Array[Knockapi::Models::ObjectListMessagesParams::engagement_status],
+        inserted_at: Knockapi::Models::ObjectListMessagesParams::InsertedAt,
+        message_ids: ::Array[String],
+        page_size: Integer,
+        source: String,
+        status: ::Array[Knockapi::Models::ObjectListMessagesParams::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 ObjectListMessagesParams < 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::Models::ObjectListMessagesParams::engagement_status]?
+
+      def engagement_status=: (
+        ::Array[Knockapi::Models::ObjectListMessagesParams::engagement_status]
+      ) -> ::Array[Knockapi::Models::ObjectListMessagesParams::engagement_status]
+
+      attr_reader inserted_at: Knockapi::Models::ObjectListMessagesParams::InsertedAt?
+
+      def inserted_at=: (
+        Knockapi::Models::ObjectListMessagesParams::InsertedAt
+      ) -> Knockapi::Models::ObjectListMessagesParams::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::Models::ObjectListMessagesParams::status]?
+
+      def status=: (
+        ::Array[Knockapi::Models::ObjectListMessagesParams::status]
+      ) -> ::Array[Knockapi::Models::ObjectListMessagesParams::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::Models::ObjectListMessagesParams::engagement_status],
+        ?inserted_at: Knockapi::Models::ObjectListMessagesParams::InsertedAt,
+        ?message_ids: ::Array[String],
+        ?page_size: Integer,
+        ?source: String,
+        ?status: ::Array[Knockapi::Models::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
+      ) -> void
+
+      def to_hash: -> Knockapi::Models::object_list_messages_params
+
+      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::Models::ObjectListMessagesParams::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
+
+        def to_hash: -> Knockapi::Models::ObjectListMessagesParams::inserted_at
+      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::Models::ObjectListMessagesParams::status]
+      end
+    end
+  end
+end

data/sig/knockapi/models/object_list_params.rbs

@@ -0,0 +1,55 @@
+module Knockapi
+  module Models
+    type object_list_params =
+      {
+        after: String,
+        before: String,
+        include: ::Array[Knockapi::Models::ObjectListParams::include_],
+        page_size: Integer
+      }
+      & Knockapi::Internal::Type::request_parameters
+
+    class ObjectListParams < 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::Models::ObjectListParams::include_]?
+
+      def include=: (
+        ::Array[Knockapi::Models::ObjectListParams::include_]
+      ) -> ::Array[Knockapi::Models::ObjectListParams::include_]
+
+      attr_reader page_size: Integer?
+
+      def page_size=: (Integer) -> Integer
+
+      def initialize: (
+        ?after: String,
+        ?before: String,
+        ?include: ::Array[Knockapi::Models::ObjectListParams::include_],
+        ?page_size: Integer,
+        ?request_options: Knockapi::request_opts
+      ) -> void
+
+      def to_hash: -> Knockapi::Models::object_list_params
+
+      type include_ = :preferences
+
+      module Include
+        extend Knockapi::Internal::Type::Enum
+
+        PREFERENCES: :preferences
+
+        def self?.values: -> ::Array[Knockapi::Models::ObjectListParams::include_]
+      end
+    end
+  end
+end

data/sig/knockapi/models/object_list_preferences_params.rbs

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

data/sig/knockapi/models/object_list_preferences_response.rbs

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

data/sig/knockapi/models/object_list_schedules_params.rbs

@@ -0,0 +1,49 @@
+module Knockapi
+  module Models
+    type object_list_schedules_params =
+      {
+        after: String,
+        before: String,
+        page_size: Integer,
+        tenant: String,
+        workflow: String
+      }
+      & Knockapi::Internal::Type::request_parameters
+
+    class ObjectListSchedulesParams < 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
+
+      def to_hash: -> Knockapi::Models::object_list_schedules_params
+    end
+  end
+end

data/sig/knockapi/models/object_list_subscriptions_params.rbs

@@ -0,0 +1,106 @@
+module Knockapi
+  module Models
+    type object_list_subscriptions_params =
+      {
+        after: String,
+        before: String,
+        include: ::Array[Knockapi::Models::ObjectListSubscriptionsParams::include_],
+        mode: Knockapi::Models::ObjectListSubscriptionsParams::mode,
+        objects: ::Array[Knockapi::Models::ObjectListSubscriptionsParams::Object],
+        page_size: Integer,
+        recipients: ::Array[Knockapi::Models::recipient_reference]
+      }
+      & Knockapi::Internal::Type::request_parameters
+
+    class ObjectListSubscriptionsParams < 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::Models::ObjectListSubscriptionsParams::include_]?
+
+      def include=: (
+        ::Array[Knockapi::Models::ObjectListSubscriptionsParams::include_]
+      ) -> ::Array[Knockapi::Models::ObjectListSubscriptionsParams::include_]
+
+      attr_reader mode: Knockapi::Models::ObjectListSubscriptionsParams::mode?
+
+      def mode=: (
+        Knockapi::Models::ObjectListSubscriptionsParams::mode
+      ) -> Knockapi::Models::ObjectListSubscriptionsParams::mode
+
+      attr_reader objects: ::Array[Knockapi::Models::ObjectListSubscriptionsParams::Object]?
+
+      def objects=: (
+        ::Array[Knockapi::Models::ObjectListSubscriptionsParams::Object]
+      ) -> ::Array[Knockapi::Models::ObjectListSubscriptionsParams::Object]
+
+      attr_reader page_size: Integer?
+
+      def page_size=: (Integer) -> Integer
+
+      attr_reader recipients: ::Array[Knockapi::Models::recipient_reference]?
+
+      def recipients=: (
+        ::Array[Knockapi::Models::recipient_reference]
+      ) -> ::Array[Knockapi::Models::recipient_reference]
+
+      def initialize: (
+        ?after: String,
+        ?before: String,
+        ?include: ::Array[Knockapi::Models::ObjectListSubscriptionsParams::include_],
+        ?mode: Knockapi::Models::ObjectListSubscriptionsParams::mode,
+        ?objects: ::Array[Knockapi::Models::ObjectListSubscriptionsParams::Object],
+        ?page_size: Integer,
+        ?recipients: ::Array[Knockapi::Models::recipient_reference],
+        ?request_options: Knockapi::request_opts
+      ) -> void
+
+      def to_hash: -> Knockapi::Models::object_list_subscriptions_params
+
+      type include_ = :preferences
+
+      module Include
+        extend Knockapi::Internal::Type::Enum
+
+        PREFERENCES: :preferences
+
+        def self?.values: -> ::Array[Knockapi::Models::ObjectListSubscriptionsParams::include_]
+      end
+
+      type mode = :recipient | :object
+
+      module Mode
+        extend Knockapi::Internal::Type::Enum
+
+        RECIPIENT: :recipient
+        OBJECT: :object
+
+        def self?.values: -> ::Array[Knockapi::Models::ObjectListSubscriptionsParams::mode]
+      end
+
+      type object = { id: String, collection: String }
+
+      class Object < 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
+
+        def to_hash: -> Knockapi::Models::ObjectListSubscriptionsParams::object
+      end
+    end
+  end
+end

data/sig/knockapi/models/object_set_channel_data_params.rbs

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

data/sig/knockapi/models/object_set_params.rbs

@@ -0,0 +1,43 @@
+module Knockapi
+  module Models
+    type object_set_params =
+      {
+        channel_data: Knockapi::Models::Recipients::inline_channel_data_request,
+        locale: String?,
+        preferences: Knockapi::Models::Recipients::inline_preference_set_request,
+        timezone: String?
+      }
+      & Knockapi::Internal::Type::request_parameters
+
+    class ObjectSetParams < Knockapi::Internal::Type::BaseModel
+      extend Knockapi::Internal::Type::RequestParameters::Converter
+      include Knockapi::Internal::Type::RequestParameters
+
+      attr_reader channel_data: Knockapi::Models::Recipients::inline_channel_data_request?
+
+      def channel_data=: (
+        Knockapi::Models::Recipients::inline_channel_data_request
+      ) -> Knockapi::Models::Recipients::inline_channel_data_request
+
+      attr_accessor locale: String?
+
+      attr_reader preferences: Knockapi::Models::Recipients::inline_preference_set_request?
+
+      def preferences=: (
+        Knockapi::Models::Recipients::inline_preference_set_request
+      ) -> Knockapi::Models::Recipients::inline_preference_set_request
+
+      attr_accessor timezone: String?
+
+      def initialize: (
+        ?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
+      ) -> void
+
+      def to_hash: -> Knockapi::Models::object_set_params
+    end
+  end
+end

data/sig/knockapi/models/object_set_preferences_params.rbs

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

data/sig/knockapi/models/object_unset_channel_data_params.rbs

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

data/sig/knockapi/models/objects/bulk_add_subscriptions_params.rbs

@@ -0,0 +1,44 @@
+module Knockapi
+  module Models
+    module Objects
+      type bulk_add_subscriptions_params =
+        {
+          subscriptions: ::Array[Knockapi::Models::Objects::BulkAddSubscriptionsParams::Subscription]
+        }
+        & Knockapi::Internal::Type::request_parameters
+
+      class BulkAddSubscriptionsParams < Knockapi::Internal::Type::BaseModel
+        extend Knockapi::Internal::Type::RequestParameters::Converter
+        include Knockapi::Internal::Type::RequestParameters
+
+        attr_accessor subscriptions: ::Array[Knockapi::Models::Objects::BulkAddSubscriptionsParams::Subscription]
+
+        def initialize: (
+          subscriptions: ::Array[Knockapi::Models::Objects::BulkAddSubscriptionsParams::Subscription],
+          ?request_options: Knockapi::request_opts
+        ) -> void
+
+        def to_hash: -> Knockapi::Models::Objects::bulk_add_subscriptions_params
+
+        type subscription =
+          {
+            recipients: ::Array[Knockapi::Models::recipient_request],
+            properties: ::Hash[Symbol, top]?
+          }
+
+        class Subscription < Knockapi::Internal::Type::BaseModel
+          attr_accessor recipients: ::Array[Knockapi::Models::recipient_request]
+
+          attr_accessor properties: ::Hash[Symbol, top]?
+
+          def initialize: (
+            recipients: ::Array[Knockapi::Models::recipient_request],
+            ?properties: ::Hash[Symbol, top]?
+          ) -> void
+
+          def to_hash: -> Knockapi::Models::Objects::BulkAddSubscriptionsParams::subscription
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+module Knockapi
+  module Models
+    module Objects
+      type bulk_delete_params =
+        { object_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 object_ids: ::Array[String]
+
+        def initialize: (
+          object_ids: ::Array[String],
+          ?request_options: Knockapi::request_opts
+        ) -> void
+
+        def to_hash: -> Knockapi::Models::Objects::bulk_delete_params
+      end
+    end
+  end
+end

data/sig/knockapi/models/objects/bulk_set_params.rbs

@@ -0,0 +1,23 @@
+module Knockapi
+  module Models
+    module Objects
+      type bulk_set_params =
+        { objects: ::Array[Knockapi::Models::InlineObjectRequest] }
+        & Knockapi::Internal::Type::request_parameters
+
+      class BulkSetParams < Knockapi::Internal::Type::BaseModel
+        extend Knockapi::Internal::Type::RequestParameters::Converter
+        include Knockapi::Internal::Type::RequestParameters
+
+        attr_accessor objects: ::Array[Knockapi::Models::InlineObjectRequest]
+
+        def initialize: (
+          objects: ::Array[Knockapi::Models::InlineObjectRequest],
+          ?request_options: Knockapi::request_opts
+        ) -> void
+
+        def to_hash: -> Knockapi::Models::Objects::bulk_set_params
+      end
+    end
+  end
+end

data/sig/knockapi/models/page_info.rbs

@@ -0,0 +1,25 @@
+module Knockapi
+  module Models
+    type page_info =
+      { _typename: String, page_size: Integer, after: String?, before: String? }
+
+    class PageInfo < Knockapi::Internal::Type::BaseModel
+      attr_accessor _typename: String
+
+      attr_accessor page_size: Integer
+
+      attr_accessor after: String?
+
+      attr_accessor before: String?
+
+      def initialize: (
+        _typename: String,
+        page_size: Integer,
+        ?after: String?,
+        ?before: String?
+      ) -> void
+
+      def to_hash: -> Knockapi::Models::page_info
+    end
+  end
+end