knockapi 0.6.1 → 1.0.0

data/sig/knockapi/models/tenant_set_params.rbs

@@ -0,0 +1,85 @@
+module Knockapi
+  module Models
+    type tenant_set_params =
+      {
+        channel_data: Knockapi::Models::Recipients::inline_channel_data_request?,
+        preferences: Knockapi::Models::Recipients::inline_preference_set_request?,
+        settings: Knockapi::Models::TenantSetParams::Settings
+      }
+      & Knockapi::Internal::Type::request_parameters
+
+    class TenantSetParams < Knockapi::Internal::Type::BaseModel
+      extend Knockapi::Internal::Type::RequestParameters::Converter
+      include Knockapi::Internal::Type::RequestParameters
+
+      attr_accessor channel_data: Knockapi::Models::Recipients::inline_channel_data_request?
+
+      attr_accessor preferences: Knockapi::Models::Recipients::inline_preference_set_request?
+
+      attr_reader settings: Knockapi::Models::TenantSetParams::Settings?
+
+      def settings=: (
+        Knockapi::Models::TenantSetParams::Settings
+      ) -> Knockapi::Models::TenantSetParams::Settings
+
+      def initialize: (
+        ?channel_data: Knockapi::Models::Recipients::inline_channel_data_request?,
+        ?preferences: Knockapi::Models::Recipients::inline_preference_set_request?,
+        ?settings: Knockapi::Models::TenantSetParams::Settings,
+        ?request_options: Knockapi::request_opts
+      ) -> void
+
+      def to_hash: -> Knockapi::Models::tenant_set_params
+
+      type settings =
+        {
+          branding: Knockapi::Models::TenantSetParams::Settings::Branding,
+          preference_set: Knockapi::Models::Recipients::PreferenceSetRequest?
+        }
+
+      class Settings < Knockapi::Internal::Type::BaseModel
+        attr_reader branding: Knockapi::Models::TenantSetParams::Settings::Branding?
+
+        def branding=: (
+          Knockapi::Models::TenantSetParams::Settings::Branding
+        ) -> Knockapi::Models::TenantSetParams::Settings::Branding
+
+        attr_accessor preference_set: Knockapi::Models::Recipients::PreferenceSetRequest?
+
+        def initialize: (
+          ?branding: Knockapi::Models::TenantSetParams::Settings::Branding,
+          ?preference_set: Knockapi::Models::Recipients::PreferenceSetRequest?
+        ) -> void
+
+        def to_hash: -> Knockapi::Models::TenantSetParams::settings
+
+        type branding =
+          {
+            icon_url: String?,
+            logo_url: String?,
+            primary_color: String?,
+            primary_color_contrast: String?
+          }
+
+        class Branding < Knockapi::Internal::Type::BaseModel
+          attr_accessor icon_url: String?
+
+          attr_accessor logo_url: String?
+
+          attr_accessor primary_color: String?
+
+          attr_accessor primary_color_contrast: String?
+
+          def initialize: (
+            ?icon_url: String?,
+            ?logo_url: String?,
+            ?primary_color: String?,
+            ?primary_color_contrast: String?
+          ) -> void
+
+          def to_hash: -> Knockapi::Models::TenantSetParams::Settings::branding
+        end
+      end
+    end
+  end
+end

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

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

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

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

data/sig/knockapi/models/user.rbs

@@ -0,0 +1,50 @@
+module Knockapi
+  module Models
+    type user =
+      {
+        id: String,
+        _typename: String,
+        updated_at: Time,
+        avatar: String?,
+        created_at: Time?,
+        email: String?,
+        name: String?,
+        phone_number: String?,
+        timezone: String?
+      }
+
+    class User < Knockapi::Internal::Type::BaseModel
+      attr_accessor id: String
+
+      attr_accessor _typename: String
+
+      attr_accessor updated_at: Time
+
+      attr_accessor avatar: String?
+
+      attr_accessor created_at: Time?
+
+      attr_accessor email: String?
+
+      attr_accessor name: String?
+
+      attr_accessor phone_number: String?
+
+      attr_accessor timezone: String?
+
+      def initialize: (
+        id: String,
+        _typename: String,
+        updated_at: Time,
+        ?avatar: String?,
+        ?created_at: Time?,
+        ?email: String?,
+        ?name: String?,
+        ?phone_number: String?,
+        ?timezone: String?
+      ) -> void
+
+      def to_hash: -> Knockapi::Models::user
+    end
+  end
+end

data/sig/knockapi/models/user_delete_params.rbs

@@ -0,0 +1,15 @@
+module Knockapi
+  module Models
+    type user_delete_params =
+      {  } & Knockapi::Internal::Type::request_parameters
+
+    class UserDeleteParams < 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::user_delete_params
+    end
+  end
+end

data/sig/knockapi/models/user_get_channel_data_params.rbs

@@ -0,0 +1,15 @@
+module Knockapi
+  module Models
+    type user_get_channel_data_params =
+      {  } & Knockapi::Internal::Type::request_parameters
+
+    class UserGetChannelDataParams < 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::user_get_channel_data_params
+    end
+  end
+end

data/sig/knockapi/models/user_get_params.rbs

@@ -0,0 +1,14 @@
+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
+
+      def to_hash: -> Knockapi::Models::user_get_params
+    end
+  end
+end

data/sig/knockapi/models/user_get_preferences_params.rbs

@@ -0,0 +1,22 @@
+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
+
+      def to_hash: -> Knockapi::Models::user_get_preferences_params
+    end
+  end
+end

data/sig/knockapi/models/user_list_messages_params.rbs

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

data/sig/knockapi/models/user_list_params.rbs

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

data/sig/knockapi/models/user_list_preferences_params.rbs

@@ -0,0 +1,15 @@
+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
+
+      def to_hash: -> Knockapi::Models::user_list_preferences_params
+    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::Models::Recipients::PreferenceSet]
+
+    UserListPreferencesResponse: Knockapi::Internal::Type::Converter
+  end
+end

data/sig/knockapi/models/user_list_schedules_params.rbs

@@ -0,0 +1,49 @@
+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
+
+      def to_hash: -> Knockapi::Models::user_list_schedules_params
+    end
+  end
+end

data/sig/knockapi/models/user_list_subscriptions_params.rbs

@@ -0,0 +1,61 @@
+module Knockapi
+  module Models
+    type user_list_subscriptions_params =
+      {
+        after: String,
+        before: String,
+        include: ::Array[Knockapi::Models::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::Models::UserListSubscriptionsParams::include_]?
+
+      def include=: (
+        ::Array[Knockapi::Models::UserListSubscriptionsParams::include_]
+      ) -> ::Array[Knockapi::Models::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::Models::UserListSubscriptionsParams::include_],
+        ?objects: ::Array[String],
+        ?page_size: Integer,
+        ?request_options: Knockapi::request_opts
+      ) -> void
+
+      def to_hash: -> Knockapi::Models::user_list_subscriptions_params
+
+      type include_ = :preferences
+
+      module Include
+        extend Knockapi::Internal::Type::Enum
+
+        PREFERENCES: :preferences
+
+        def self?.values: -> ::Array[Knockapi::Models::UserListSubscriptionsParams::include_]
+      end
+    end
+  end
+end

data/sig/knockapi/models/user_merge_params.rbs

@@ -0,0 +1,20 @@
+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
+
+      def to_hash: -> Knockapi::Models::user_merge_params
+    end
+  end
+end

data/sig/knockapi/models/user_set_channel_data_params.rbs

@@ -0,0 +1,15 @@
+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
+
+      def to_hash: -> Knockapi::Models::user_set_channel_data_params
+    end
+  end
+end

data/sig/knockapi/models/user_set_preferences_params.rbs

@@ -0,0 +1,15 @@
+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
+
+      def to_hash: -> Knockapi::Models::user_set_preferences_params
+    end
+  end
+end

data/sig/knockapi/models/user_unset_channel_data_params.rbs

@@ -0,0 +1,15 @@
+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
+
+      def to_hash: -> Knockapi::Models::user_unset_channel_data_params
+    end
+  end
+end