knockapi 0.6.1 → 1.1.0

data/sig/knockapi/models/bulk_operation.rbs

@@ -0,0 +1,103 @@
+module Knockapi
+  module Models
+    type bulk_operation =
+      {
+        id: String,
+        _typename: String,
+        estimated_total_rows: Integer,
+        inserted_at: Time,
+        name: String,
+        processed_rows: Integer,
+        status: Knockapi::BulkOperation::status,
+        success_count: Integer,
+        updated_at: Time,
+        completed_at: Time?,
+        error_count: Integer,
+        error_items: ::Array[Knockapi::BulkOperation::ErrorItem],
+        failed_at: Time?,
+        progress_path: String,
+        started_at: Time?
+      }
+
+    class BulkOperation < Knockapi::Internal::Type::BaseModel
+      attr_accessor id: String
+
+      attr_accessor _typename: String
+
+      attr_accessor estimated_total_rows: Integer
+
+      attr_accessor inserted_at: Time
+
+      attr_accessor name: String
+
+      attr_accessor processed_rows: Integer
+
+      attr_accessor status: Knockapi::BulkOperation::status
+
+      attr_accessor success_count: Integer
+
+      attr_accessor updated_at: Time
+
+      attr_accessor completed_at: Time?
+
+      attr_reader error_count: Integer?
+
+      def error_count=: (Integer) -> Integer
+
+      attr_reader error_items: ::Array[Knockapi::BulkOperation::ErrorItem]?
+
+      def error_items=: (
+        ::Array[Knockapi::BulkOperation::ErrorItem]
+      ) -> ::Array[Knockapi::BulkOperation::ErrorItem]
+
+      attr_accessor failed_at: Time?
+
+      attr_reader progress_path: String?
+
+      def progress_path=: (String) -> String
+
+      attr_accessor started_at: Time?
+
+      def initialize: (
+        id: String,
+        _typename: String,
+        estimated_total_rows: Integer,
+        inserted_at: Time,
+        name: String,
+        processed_rows: Integer,
+        status: Knockapi::BulkOperation::status,
+        success_count: Integer,
+        updated_at: Time,
+        ?completed_at: Time?,
+        ?error_count: Integer,
+        ?error_items: ::Array[Knockapi::BulkOperation::ErrorItem],
+        ?failed_at: Time?,
+        ?progress_path: String,
+        ?started_at: Time?
+      ) -> void
+
+      type status = :queued | :processing | :completed | :failed
+
+      module Status
+        extend Knockapi::Internal::Type::Enum
+
+        QUEUED: :queued
+        PROCESSING: :processing
+        COMPLETED: :completed
+        FAILED: :failed
+
+        def self?.values: -> ::Array[Knockapi::BulkOperation::status]
+      end
+
+      type error_item = { id: String, collection: String? }
+
+      class ErrorItem < Knockapi::Internal::Type::BaseModel
+        attr_accessor id: String
+
+        attr_accessor collection: String?
+
+        def initialize: (id: String, ?collection: String?) -> void
+      end
+    end
+  end
+end

data/sig/knockapi/models/bulk_operation_get_params.rbs

@@ -0,0 +1,13 @@
+module Knockapi
+  module Models
+    type bulk_operation_get_params =
+      {  } & Knockapi::Internal::Type::request_parameters
+
+    class BulkOperationGetParams < 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/channels/bulk_update_message_status_params.rbs

@@ -0,0 +1,174 @@
+module Knockapi
+  module Models
+    module Channels
+      type bulk_update_message_status_params =
+        {
+          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]
+        }
+        & Knockapi::Internal::Type::request_parameters
+
+      class BulkUpdateMessageStatusParams < Knockapi::Internal::Type::BaseModel
+        extend Knockapi::Internal::Type::RequestParameters::Converter
+        include Knockapi::Internal::Type::RequestParameters
+
+        attr_reader archived: Knockapi::Models::Channels::BulkUpdateMessageStatusParams::archived?
+
+        def archived=: (
+          Knockapi::Models::Channels::BulkUpdateMessageStatusParams::archived
+        ) -> Knockapi::Models::Channels::BulkUpdateMessageStatusParams::archived
+
+        attr_reader delivery_status: Knockapi::Models::Channels::BulkUpdateMessageStatusParams::delivery_status?
+
+        def delivery_status=: (
+          Knockapi::Models::Channels::BulkUpdateMessageStatusParams::delivery_status
+        ) -> Knockapi::Models::Channels::BulkUpdateMessageStatusParams::delivery_status
+
+        attr_reader engagement_status: Knockapi::Models::Channels::BulkUpdateMessageStatusParams::engagement_status?
+
+        def engagement_status=: (
+          Knockapi::Models::Channels::BulkUpdateMessageStatusParams::engagement_status
+        ) -> Knockapi::Models::Channels::BulkUpdateMessageStatusParams::engagement_status
+
+        attr_reader has_tenant: bool?
+
+        def has_tenant=: (bool) -> bool
+
+        attr_reader newer_than: Time?
+
+        def newer_than=: (Time) -> Time
+
+        attr_reader older_than: Time?
+
+        def older_than=: (Time) -> Time
+
+        attr_reader recipient_ids: ::Array[String]?
+
+        def recipient_ids=: (::Array[String]) -> ::Array[String]
+
+        attr_reader tenants: ::Array[String]?
+
+        def tenants=: (::Array[String]) -> ::Array[String]
+
+        attr_reader trigger_data: String?
+
+        def trigger_data=: (String) -> String
+
+        attr_reader workflows: ::Array[String]?
+
+        def workflows=: (::Array[String]) -> ::Array[String]
+
+        def initialize: (
+          ?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
+        ) -> void
+
+        type action =
+          :seen
+          | :unseen
+          | :read
+          | :unread
+          | :archived
+          | :unarchived
+          | :interacted
+          | :archive
+          | :unarchive
+          | :delete
+
+        module Action
+          extend Knockapi::Internal::Type::Enum
+
+          SEEN: :seen
+          UNSEEN: :unseen
+          READ: :read
+          UNREAD: :unread
+          ARCHIVED: :archived
+          UNARCHIVED: :unarchived
+          INTERACTED: :interacted
+          ARCHIVE: :archive
+          UNARCHIVE: :unarchive
+          DELETE: :delete
+
+          def self?.values: -> ::Array[Knockapi::Models::Channels::BulkUpdateMessageStatusParams::action]
+        end
+
+        type archived = :exclude | :include | :only
+
+        module Archived
+          extend Knockapi::Internal::Type::Enum
+
+          EXCLUDE: :exclude
+          INCLUDE: :include
+          ONLY: :only
+
+          def self?.values: -> ::Array[Knockapi::Models::Channels::BulkUpdateMessageStatusParams::archived]
+        end
+
+        type delivery_status =
+          :queued
+          | :sent
+          | :delivered
+          | :delivery_attempted
+          | :undelivered
+          | :not_sent
+          | :bounced
+
+        module DeliveryStatus
+          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::Channels::BulkUpdateMessageStatusParams::delivery_status]
+        end
+
+        type engagement_status =
+          :seen
+          | :unseen
+          | :read
+          | :unread
+          | :archived
+          | :unarchived
+          | :link_clicked
+          | :interacted
+
+        module EngagementStatus
+          extend Knockapi::Internal::Type::Enum
+
+          SEEN: :seen
+          UNSEEN: :unseen
+          READ: :read
+          UNREAD: :unread
+          ARCHIVED: :archived
+          UNARCHIVED: :unarchived
+          LINK_CLICKED: :link_clicked
+          INTERACTED: :interacted
+
+          def self?.values: -> ::Array[Knockapi::Models::Channels::BulkUpdateMessageStatusParams::engagement_status]
+        end
+      end
+    end
+  end
+end

data/sig/knockapi/models/condition.rbs

@@ -0,0 +1,69 @@
+module Knockapi
+  module Models
+    type condition =
+      {
+        argument: String?,
+        operator: Knockapi::Condition::operator,
+        variable: String
+      }
+
+    class Condition < Knockapi::Internal::Type::BaseModel
+      attr_accessor argument: String?
+
+      attr_accessor operator: Knockapi::Condition::operator
+
+      attr_accessor variable: String
+
+      def initialize: (
+        argument: String?,
+        operator: Knockapi::Condition::operator,
+        variable: String
+      ) -> void
+
+      type operator =
+        :equal_to
+        | :not_equal_to
+        | :greater_than
+        | :less_than
+        | :greater_than_or_equal_to
+        | :less_than_or_equal_to
+        | :contains
+        | :not_contains
+        | :empty
+        | :not_empty
+        | :contains_all
+        | :is_timestamp
+        | :is_not_timestamp
+        | :is_timestamp_after
+        | :is_timestamp_before
+        | :is_timestamp_between
+        | :is_audience_member
+        | :is_not_audience_member
+
+      module Operator
+        extend Knockapi::Internal::Type::Enum
+
+        EQUAL_TO: :equal_to
+        NOT_EQUAL_TO: :not_equal_to
+        GREATER_THAN: :greater_than
+        LESS_THAN: :less_than
+        GREATER_THAN_OR_EQUAL_TO: :greater_than_or_equal_to
+        LESS_THAN_OR_EQUAL_TO: :less_than_or_equal_to
+        CONTAINS: :contains
+        NOT_CONTAINS: :not_contains
+        EMPTY: :empty
+        NOT_EMPTY: :not_empty
+        CONTAINS_ALL: :contains_all
+        IS_TIMESTAMP: :is_timestamp
+        IS_NOT_TIMESTAMP: :is_not_timestamp
+        IS_TIMESTAMP_AFTER: :is_timestamp_after
+        IS_TIMESTAMP_BEFORE: :is_timestamp_before
+        IS_TIMESTAMP_BETWEEN: :is_timestamp_between
+        IS_AUDIENCE_MEMBER: :is_audience_member
+        IS_NOT_AUDIENCE_MEMBER: :is_not_audience_member
+
+        def self?.values: -> ::Array[Knockapi::Condition::operator]
+      end
+    end
+  end
+end

data/sig/knockapi/models/identify_user_request.rbs

@@ -0,0 +1,48 @@
+module Knockapi
+  module Models
+    type identify_user_request =
+      {
+        avatar: String?,
+        channel_data: Knockapi::Models::Recipients::inline_channel_data_request?,
+        created_at: Time?,
+        email: String?,
+        locale: String?,
+        name: String?,
+        phone_number: String?,
+        preferences: Knockapi::Models::Recipients::inline_preference_set_request?,
+        timezone: String?
+      }
+
+    class IdentifyUserRequest < Knockapi::Internal::Type::BaseModel
+      attr_accessor avatar: String?
+
+      attr_accessor channel_data: Knockapi::Models::Recipients::inline_channel_data_request?
+
+      attr_accessor created_at: Time?
+
+      attr_accessor email: String?
+
+      attr_accessor locale: String?
+
+      attr_accessor name: String?
+
+      attr_accessor phone_number: String?
+
+      attr_accessor preferences: Knockapi::Models::Recipients::inline_preference_set_request?
+
+      attr_accessor timezone: String?
+
+      def initialize: (
+        ?avatar: String?,
+        ?channel_data: Knockapi::Models::Recipients::inline_channel_data_request?,
+        ?created_at: Time?,
+        ?email: String?,
+        ?locale: String?,
+        ?name: String?,
+        ?phone_number: String?,
+        ?preferences: Knockapi::Models::Recipients::inline_preference_set_request?,
+        ?timezone: String?
+      ) -> void
+    end
+  end
+end

data/sig/knockapi/models/inline_identify_user_request.rbs

@@ -0,0 +1,52 @@
+module Knockapi
+  module Models
+    type inline_identify_user_request =
+      {
+        id: String,
+        avatar: String?,
+        channel_data: Knockapi::Models::Recipients::inline_channel_data_request?,
+        created_at: Time?,
+        email: String?,
+        locale: String?,
+        name: String?,
+        phone_number: String?,
+        preferences: Knockapi::Models::Recipients::inline_preference_set_request?,
+        timezone: String?
+      }
+
+    class InlineIdentifyUserRequest < Knockapi::Internal::Type::BaseModel
+      attr_accessor id: String
+
+      attr_accessor avatar: String?
+
+      attr_accessor channel_data: Knockapi::Models::Recipients::inline_channel_data_request?
+
+      attr_accessor created_at: Time?
+
+      attr_accessor email: String?
+
+      attr_accessor locale: String?
+
+      attr_accessor name: String?
+
+      attr_accessor phone_number: String?
+
+      attr_accessor preferences: Knockapi::Models::Recipients::inline_preference_set_request?
+
+      attr_accessor timezone: String?
+
+      def initialize: (
+        id: String,
+        ?avatar: String?,
+        ?channel_data: Knockapi::Models::Recipients::inline_channel_data_request?,
+        ?created_at: Time?,
+        ?email: String?,
+        ?locale: String?,
+        ?name: String?,
+        ?phone_number: String?,
+        ?preferences: Knockapi::Models::Recipients::inline_preference_set_request?,
+        ?timezone: String?
+      ) -> void
+    end
+  end
+end

data/sig/knockapi/models/inline_object_request.rbs

@@ -0,0 +1,32 @@
+module Knockapi
+  module Models
+    type inline_object_request =
+      {
+        id: String,
+        collection: String,
+        channel_data: Knockapi::Models::Recipients::inline_channel_data_request?,
+        created_at: Time?,
+        preferences: Knockapi::Models::Recipients::inline_preference_set_request?
+      }
+
+    class InlineObjectRequest < Knockapi::Internal::Type::BaseModel
+      attr_accessor id: String
+
+      attr_accessor collection: String
+
+      attr_accessor channel_data: Knockapi::Models::Recipients::inline_channel_data_request?
+
+      attr_accessor created_at: Time?
+
+      attr_accessor preferences: Knockapi::Models::Recipients::inline_preference_set_request?
+
+      def initialize: (
+        id: String,
+        collection: String,
+        ?channel_data: Knockapi::Models::Recipients::inline_channel_data_request?,
+        ?created_at: Time?,
+        ?preferences: Knockapi::Models::Recipients::inline_preference_set_request?
+      ) -> void
+    end
+  end
+end

data/sig/knockapi/models/inline_tenant_request.rbs

@@ -0,0 +1,11 @@
+module Knockapi
+  module Models
+    type inline_tenant_request = String | Knockapi::TenantRequest
+
+    module InlineTenantRequest
+      extend Knockapi::Internal::Type::Union
+
+      def self?.variants: -> ::Array[Knockapi::Models::inline_tenant_request]
+    end
+  end
+end

data/sig/knockapi/models/integrations/census_custom_destination_params.rbs

@@ -0,0 +1,37 @@
+module Knockapi
+  module Models
+    module Integrations
+      type census_custom_destination_params =
+        {
+          id: String,
+          jsonrpc: String,
+          method_: String,
+          params: ::Hash[Symbol, top]
+        }
+        & Knockapi::Internal::Type::request_parameters
+
+      class CensusCustomDestinationParams < Knockapi::Internal::Type::BaseModel
+        extend Knockapi::Internal::Type::RequestParameters::Converter
+        include Knockapi::Internal::Type::RequestParameters
+
+        attr_accessor id: String
+
+        attr_accessor jsonrpc: String
+
+        attr_accessor method_: String
+
+        attr_reader params: ::Hash[Symbol, top]?
+
+        def params=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top]
+
+        def initialize: (
+          id: String,
+          jsonrpc: String,
+          method_: String,
+          ?params: ::Hash[Symbol, top],
+          ?request_options: Knockapi::request_opts
+        ) -> void
+      end
+    end
+  end
+end

data/sig/knockapi/models/integrations/census_custom_destination_response.rbs

@@ -0,0 +1,20 @@
+module Knockapi
+  module Models
+    module Integrations
+      type census_custom_destination_response =
+        { id: String, result: ::Hash[Symbol, top] }
+
+      class CensusCustomDestinationResponse < Knockapi::Internal::Type::BaseModel
+        attr_reader id: String?
+
+        def id=: (String) -> String
+
+        attr_reader result: ::Hash[Symbol, top]?
+
+        def result=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top]
+
+        def initialize: (?id: String, ?result: ::Hash[Symbol, top]) -> void
+      end
+    end
+  end
+end

data/sig/knockapi/models/integrations/hightouch_embedded_destination_params.rbs

@@ -0,0 +1,37 @@
+module Knockapi
+  module Models
+    module Integrations
+      type hightouch_embedded_destination_params =
+        {
+          id: String,
+          jsonrpc: String,
+          method_: String,
+          params: ::Hash[Symbol, top]
+        }
+        & Knockapi::Internal::Type::request_parameters
+
+      class HightouchEmbeddedDestinationParams < Knockapi::Internal::Type::BaseModel
+        extend Knockapi::Internal::Type::RequestParameters::Converter
+        include Knockapi::Internal::Type::RequestParameters
+
+        attr_accessor id: String
+
+        attr_accessor jsonrpc: String
+
+        attr_accessor method_: String
+
+        attr_reader params: ::Hash[Symbol, top]?
+
+        def params=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top]
+
+        def initialize: (
+          id: String,
+          jsonrpc: String,
+          method_: String,
+          ?params: ::Hash[Symbol, top],
+          ?request_options: Knockapi::request_opts
+        ) -> void
+      end
+    end
+  end
+end

data/sig/knockapi/models/integrations/hightouch_embedded_destination_response.rbs

@@ -0,0 +1,20 @@
+module Knockapi
+  module Models
+    module Integrations
+      type hightouch_embedded_destination_response =
+        { id: String, result: ::Hash[Symbol, top] }
+
+      class HightouchEmbeddedDestinationResponse < Knockapi::Internal::Type::BaseModel
+        attr_reader id: String?
+
+        def id=: (String) -> String
+
+        attr_reader result: ::Hash[Symbol, top]?
+
+        def result=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top]
+
+        def initialize: (?id: String, ?result: ::Hash[Symbol, top]) -> void
+      end
+    end
+  end
+end