knockapi 0.6.1 → 1.0.0

data/sig/knockapi/models/schedule.rbs

@@ -0,0 +1,64 @@
+module Knockapi
+  module Models
+    type schedule =
+      {
+        id: String,
+        inserted_at: Time,
+        recipient: Knockapi::Models::recipient,
+        repeats: ::Array[Knockapi::Models::ScheduleRepeatRule],
+        updated_at: Time,
+        workflow: String,
+        _typename: String,
+        actor: Knockapi::Models::recipient?,
+        data: ::Hash[Symbol, top]?,
+        last_occurrence_at: Time?,
+        next_occurrence_at: Time?,
+        tenant: String?
+      }
+
+    class Schedule < Knockapi::Internal::Type::BaseModel
+      attr_accessor id: String
+
+      attr_accessor inserted_at: Time
+
+      attr_accessor recipient: Knockapi::Models::recipient
+
+      attr_accessor repeats: ::Array[Knockapi::Models::ScheduleRepeatRule]
+
+      attr_accessor updated_at: Time
+
+      attr_accessor workflow: String
+
+      attr_reader _typename: String?
+
+      def _typename=: (String) -> String
+
+      attr_accessor actor: Knockapi::Models::recipient?
+
+      attr_accessor data: ::Hash[Symbol, top]?
+
+      attr_accessor last_occurrence_at: Time?
+
+      attr_accessor next_occurrence_at: Time?
+
+      attr_accessor tenant: String?
+
+      def initialize: (
+        id: String,
+        inserted_at: Time,
+        recipient: Knockapi::Models::recipient,
+        repeats: ::Array[Knockapi::Models::ScheduleRepeatRule],
+        updated_at: Time,
+        workflow: String,
+        ?_typename: String,
+        ?actor: Knockapi::Models::recipient?,
+        ?data: ::Hash[Symbol, top]?,
+        ?last_occurrence_at: Time?,
+        ?next_occurrence_at: Time?,
+        ?tenant: String?
+      ) -> void
+
+      def to_hash: -> Knockapi::Models::schedule
+    end
+  end
+end

data/sig/knockapi/models/schedule_create_params.rbs

@@ -0,0 +1,47 @@
+module Knockapi
+  module Models
+    type schedule_create_params =
+      {
+        recipients: ::Array[Knockapi::Models::recipient_request],
+        repeats: ::Array[Knockapi::Models::ScheduleRepeatRule],
+        workflow: String,
+        data: ::Hash[Symbol, top]?,
+        ending_at: Time?,
+        scheduled_at: Time?,
+        tenant: Knockapi::Models::inline_tenant_request?
+      }
+      & Knockapi::Internal::Type::request_parameters
+
+    class ScheduleCreateParams < 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 repeats: ::Array[Knockapi::Models::ScheduleRepeatRule]
+
+      attr_accessor workflow: String
+
+      attr_accessor data: ::Hash[Symbol, top]?
+
+      attr_accessor ending_at: Time?
+
+      attr_accessor scheduled_at: Time?
+
+      attr_accessor tenant: Knockapi::Models::inline_tenant_request?
+
+      def initialize: (
+        recipients: ::Array[Knockapi::Models::recipient_request],
+        repeats: ::Array[Knockapi::Models::ScheduleRepeatRule],
+        workflow: String,
+        ?data: ::Hash[Symbol, top]?,
+        ?ending_at: Time?,
+        ?scheduled_at: Time?,
+        ?tenant: Knockapi::Models::inline_tenant_request?,
+        ?request_options: Knockapi::request_opts
+      ) -> void
+
+      def to_hash: -> Knockapi::Models::schedule_create_params
+    end
+  end
+end

data/sig/knockapi/models/schedule_create_response.rbs

@@ -0,0 +1,7 @@
+module Knockapi
+  module Models
+    type schedule_create_response = ::Array[Knockapi::Models::Schedule]
+
+    ScheduleCreateResponse: Knockapi::Internal::Type::Converter
+  end
+end

data/sig/knockapi/models/schedule_delete_params.rbs

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

data/sig/knockapi/models/schedule_delete_response.rbs

@@ -0,0 +1,7 @@
+module Knockapi
+  module Models
+    type schedule_delete_response = ::Array[Knockapi::Models::Schedule]
+
+    ScheduleDeleteResponse: Knockapi::Internal::Type::Converter
+  end
+end

data/sig/knockapi/models/schedule_list_params.rbs

@@ -0,0 +1,53 @@
+module Knockapi
+  module Models
+    type schedule_list_params =
+      {
+        workflow: String,
+        after: String,
+        before: String,
+        page_size: Integer,
+        recipients: ::Array[String],
+        tenant: String
+      }
+      & Knockapi::Internal::Type::request_parameters
+
+    class ScheduleListParams < Knockapi::Internal::Type::BaseModel
+      extend Knockapi::Internal::Type::RequestParameters::Converter
+      include Knockapi::Internal::Type::RequestParameters
+
+      attr_accessor workflow: String
+
+      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 recipients: ::Array[String]?
+
+      def recipients=: (::Array[String]) -> ::Array[String]
+
+      attr_reader tenant: String?
+
+      def tenant=: (String) -> String
+
+      def initialize: (
+        workflow: String,
+        ?after: String,
+        ?before: String,
+        ?page_size: Integer,
+        ?recipients: ::Array[String],
+        ?tenant: String,
+        ?request_options: Knockapi::request_opts
+      ) -> void
+
+      def to_hash: -> Knockapi::Models::schedule_list_params
+    end
+  end
+end

data/sig/knockapi/models/schedule_repeat_rule.rbs

@@ -0,0 +1,73 @@
+module Knockapi
+  module Models
+    type schedule_repeat_rule =
+      {
+        _typename: String,
+        frequency: Knockapi::Models::ScheduleRepeatRule::frequency,
+        day_of_month: Integer?,
+        days: ::Array[Knockapi::Models::ScheduleRepeatRule::day]?,
+        hours: Integer?,
+        interval: Integer,
+        minutes: Integer?
+      }
+
+    class ScheduleRepeatRule < Knockapi::Internal::Type::BaseModel
+      attr_accessor _typename: String
+
+      attr_accessor frequency: Knockapi::Models::ScheduleRepeatRule::frequency
+
+      attr_accessor day_of_month: Integer?
+
+      attr_accessor days: ::Array[Knockapi::Models::ScheduleRepeatRule::day]?
+
+      attr_accessor hours: Integer?
+
+      attr_reader interval: Integer?
+
+      def interval=: (Integer) -> Integer
+
+      attr_accessor minutes: Integer?
+
+      def initialize: (
+        _typename: String,
+        frequency: Knockapi::Models::ScheduleRepeatRule::frequency,
+        ?day_of_month: Integer?,
+        ?days: ::Array[Knockapi::Models::ScheduleRepeatRule::day]?,
+        ?hours: Integer?,
+        ?interval: Integer,
+        ?minutes: Integer?
+      ) -> void
+
+      def to_hash: -> Knockapi::Models::schedule_repeat_rule
+
+      type frequency = :daily | :weekly | :monthly | :hourly
+
+      module Frequency
+        extend Knockapi::Internal::Type::Enum
+
+        DAILY: :daily
+        WEEKLY: :weekly
+        MONTHLY: :monthly
+        HOURLY: :hourly
+
+        def self?.values: -> ::Array[Knockapi::Models::ScheduleRepeatRule::frequency]
+      end
+
+      type day = :mon | :tue | :wed | :thu | :fri | :sat | :sun
+
+      module Day
+        extend Knockapi::Internal::Type::Enum
+
+        MON: :mon
+        TUE: :tue
+        WED: :wed
+        THU: :thu
+        FRI: :fri
+        SAT: :sat
+        SUN: :sun
+
+        def self?.values: -> ::Array[Knockapi::Models::ScheduleRepeatRule::day]
+      end
+    end
+  end
+end

data/sig/knockapi/models/schedule_update_params.rbs

@@ -0,0 +1,51 @@
+module Knockapi
+  module Models
+    type schedule_update_params =
+      {
+        schedule_ids: ::Array[String],
+        actor: Knockapi::Models::recipient_reference?,
+        data: ::Hash[Symbol, top]?,
+        ending_at: Time?,
+        repeats: ::Array[Knockapi::Models::ScheduleRepeatRule],
+        scheduled_at: Time?,
+        tenant: Knockapi::Models::inline_tenant_request?
+      }
+      & Knockapi::Internal::Type::request_parameters
+
+    class ScheduleUpdateParams < Knockapi::Internal::Type::BaseModel
+      extend Knockapi::Internal::Type::RequestParameters::Converter
+      include Knockapi::Internal::Type::RequestParameters
+
+      attr_accessor schedule_ids: ::Array[String]
+
+      attr_accessor actor: Knockapi::Models::recipient_reference?
+
+      attr_accessor data: ::Hash[Symbol, top]?
+
+      attr_accessor ending_at: Time?
+
+      attr_reader repeats: ::Array[Knockapi::Models::ScheduleRepeatRule]?
+
+      def repeats=: (
+        ::Array[Knockapi::Models::ScheduleRepeatRule]
+      ) -> ::Array[Knockapi::Models::ScheduleRepeatRule]
+
+      attr_accessor scheduled_at: Time?
+
+      attr_accessor tenant: Knockapi::Models::inline_tenant_request?
+
+      def initialize: (
+        schedule_ids: ::Array[String],
+        ?actor: Knockapi::Models::recipient_reference?,
+        ?data: ::Hash[Symbol, top]?,
+        ?ending_at: Time?,
+        ?repeats: ::Array[Knockapi::Models::ScheduleRepeatRule],
+        ?scheduled_at: Time?,
+        ?tenant: Knockapi::Models::inline_tenant_request?,
+        ?request_options: Knockapi::request_opts
+      ) -> void
+
+      def to_hash: -> Knockapi::Models::schedule_update_params
+    end
+  end
+end

data/sig/knockapi/models/schedule_update_response.rbs

@@ -0,0 +1,7 @@
+module Knockapi
+  module Models
+    type schedule_update_response = ::Array[Knockapi::Models::Schedule]
+
+    ScheduleUpdateResponse: Knockapi::Internal::Type::Converter
+  end
+end

data/sig/knockapi/models/schedules/bulk_create_params.rbs

@@ -0,0 +1,76 @@
+module Knockapi
+  module Models
+    module Schedules
+      type bulk_create_params =
+        {
+          schedules: ::Array[Knockapi::Models::Schedules::BulkCreateParams::Schedule]
+        }
+        & Knockapi::Internal::Type::request_parameters
+
+      class BulkCreateParams < Knockapi::Internal::Type::BaseModel
+        extend Knockapi::Internal::Type::RequestParameters::Converter
+        include Knockapi::Internal::Type::RequestParameters
+
+        attr_accessor schedules: ::Array[Knockapi::Models::Schedules::BulkCreateParams::Schedule]
+
+        def initialize: (
+          schedules: ::Array[Knockapi::Models::Schedules::BulkCreateParams::Schedule],
+          ?request_options: Knockapi::request_opts
+        ) -> void
+
+        def to_hash: -> Knockapi::Models::Schedules::bulk_create_params
+
+        type schedule =
+          {
+            workflow: String,
+            actor: Knockapi::Models::recipient_request?,
+            data: ::Hash[Symbol, top]?,
+            ending_at: Time?,
+            recipient: Knockapi::Models::recipient_request,
+            repeats: ::Array[Knockapi::Models::ScheduleRepeatRule],
+            scheduled_at: Time?,
+            tenant: Knockapi::Models::inline_tenant_request?
+          }
+
+        class Schedule < Knockapi::Internal::Type::BaseModel
+          attr_accessor workflow: String
+
+          attr_accessor actor: Knockapi::Models::recipient_request?
+
+          attr_accessor data: ::Hash[Symbol, top]?
+
+          attr_accessor ending_at: Time?
+
+          attr_reader recipient: Knockapi::Models::recipient_request?
+
+          def recipient=: (
+            Knockapi::Models::recipient_request
+          ) -> Knockapi::Models::recipient_request
+
+          attr_reader repeats: ::Array[Knockapi::Models::ScheduleRepeatRule]?
+
+          def repeats=: (
+            ::Array[Knockapi::Models::ScheduleRepeatRule]
+          ) -> ::Array[Knockapi::Models::ScheduleRepeatRule]
+
+          attr_accessor scheduled_at: Time?
+
+          attr_accessor tenant: Knockapi::Models::inline_tenant_request?
+
+          def initialize: (
+            workflow: String,
+            ?actor: Knockapi::Models::recipient_request?,
+            ?data: ::Hash[Symbol, top]?,
+            ?ending_at: Time?,
+            ?recipient: Knockapi::Models::recipient_request,
+            ?repeats: ::Array[Knockapi::Models::ScheduleRepeatRule],
+            ?scheduled_at: Time?,
+            ?tenant: Knockapi::Models::inline_tenant_request?
+          ) -> void
+
+          def to_hash: -> Knockapi::Models::Schedules::BulkCreateParams::schedule
+        end
+      end
+    end
+  end
+end

data/sig/knockapi/models/tenant.rbs

@@ -0,0 +1,76 @@
+module Knockapi
+  module Models
+    type tenant =
+      {
+        id: String,
+        _typename: String,
+        name: String?,
+        settings: Knockapi::Models::Tenant::Settings?
+      }
+
+    class Tenant < Knockapi::Internal::Type::BaseModel
+      attr_accessor id: String
+
+      attr_accessor _typename: String
+
+      attr_accessor name: String?
+
+      attr_accessor settings: Knockapi::Models::Tenant::Settings?
+
+      def initialize: (
+        id: String,
+        _typename: String,
+        ?name: String?,
+        ?settings: Knockapi::Models::Tenant::Settings?
+      ) -> void
+
+      def to_hash: -> Knockapi::Models::tenant
+
+      type settings =
+        {
+          branding: Knockapi::Models::Tenant::Settings::Branding?,
+          preference_set: Knockapi::Models::Recipients::PreferenceSet?
+        }
+
+      class Settings < Knockapi::Internal::Type::BaseModel
+        attr_accessor branding: Knockapi::Models::Tenant::Settings::Branding?
+
+        attr_accessor preference_set: Knockapi::Models::Recipients::PreferenceSet?
+
+        def initialize: (
+          ?branding: Knockapi::Models::Tenant::Settings::Branding?,
+          ?preference_set: Knockapi::Models::Recipients::PreferenceSet?
+        ) -> void
+
+        def to_hash: -> Knockapi::Models::Tenant::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::Tenant::Settings::branding
+        end
+      end
+    end
+  end
+end

data/sig/knockapi/models/tenant_delete_params.rbs

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

data/sig/knockapi/models/tenant_get_params.rbs

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

data/sig/knockapi/models/tenant_list_params.rbs

@@ -0,0 +1,49 @@
+module Knockapi
+  module Models
+    type tenant_list_params =
+      {
+        after: String,
+        before: String,
+        name: String,
+        page_size: Integer,
+        tenant_id: String
+      }
+      & Knockapi::Internal::Type::request_parameters
+
+    class TenantListParams < 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 name: String?
+
+      def name=: (String) -> String
+
+      attr_reader page_size: Integer?
+
+      def page_size=: (Integer) -> Integer
+
+      attr_reader tenant_id: String?
+
+      def tenant_id=: (String) -> String
+
+      def initialize: (
+        ?after: String,
+        ?before: String,
+        ?name: String,
+        ?page_size: Integer,
+        ?tenant_id: String,
+        ?request_options: Knockapi::request_opts
+      ) -> void
+
+      def to_hash: -> Knockapi::Models::tenant_list_params
+    end
+  end
+end

data/sig/knockapi/models/tenant_request.rbs

@@ -0,0 +1,84 @@
+module Knockapi
+  module Models
+    type tenant_request =
+      {
+        id: String,
+        channel_data: Knockapi::Models::Recipients::inline_channel_data_request?,
+        preferences: Knockapi::Models::Recipients::inline_preference_set_request?,
+        settings: Knockapi::Models::TenantRequest::Settings
+      }
+
+    class TenantRequest < Knockapi::Internal::Type::BaseModel
+      attr_accessor id: String
+
+      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::TenantRequest::Settings?
+
+      def settings=: (
+        Knockapi::Models::TenantRequest::Settings
+      ) -> Knockapi::Models::TenantRequest::Settings
+
+      def initialize: (
+        id: String,
+        ?channel_data: Knockapi::Models::Recipients::inline_channel_data_request?,
+        ?preferences: Knockapi::Models::Recipients::inline_preference_set_request?,
+        ?settings: Knockapi::Models::TenantRequest::Settings
+      ) -> void
+
+      def to_hash: -> Knockapi::Models::tenant_request
+
+      type settings =
+        {
+          branding: Knockapi::Models::TenantRequest::Settings::Branding,
+          preference_set: Knockapi::Models::Recipients::PreferenceSetRequest?
+        }
+
+      class Settings < Knockapi::Internal::Type::BaseModel
+        attr_reader branding: Knockapi::Models::TenantRequest::Settings::Branding?
+
+        def branding=: (
+          Knockapi::Models::TenantRequest::Settings::Branding
+        ) -> Knockapi::Models::TenantRequest::Settings::Branding
+
+        attr_accessor preference_set: Knockapi::Models::Recipients::PreferenceSetRequest?
+
+        def initialize: (
+          ?branding: Knockapi::Models::TenantRequest::Settings::Branding,
+          ?preference_set: Knockapi::Models::Recipients::PreferenceSetRequest?
+        ) -> void
+
+        def to_hash: -> Knockapi::Models::TenantRequest::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::TenantRequest::Settings::branding
+        end
+      end
+    end
+  end
+end