knockapi 0.6.1 → 1.0.0

data/sig/knockapi/models/condition.rbs

@@ -0,0 +1,71 @@
+module Knockapi
+  module Models
+    type condition =
+      {
+        argument: String?,
+        operator: Knockapi::Models::Condition::operator,
+        variable: String
+      }
+
+    class Condition < Knockapi::Internal::Type::BaseModel
+      attr_accessor argument: String?
+
+      attr_accessor operator: Knockapi::Models::Condition::operator
+
+      attr_accessor variable: String
+
+      def initialize: (
+        argument: String?,
+        operator: Knockapi::Models::Condition::operator,
+        variable: String
+      ) -> void
+
+      def to_hash: -> Knockapi::Models::condition
+
+      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::Models::Condition::operator]
+      end
+    end
+  end
+end

data/sig/knockapi/models/identify_user_request.rbs

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

data/sig/knockapi/models/inline_identify_user_request.rbs

@@ -0,0 +1,30 @@
+module Knockapi
+  module Models
+    type inline_identify_user_request =
+      {
+        id: String,
+        channel_data: Knockapi::Models::Recipients::inline_channel_data_request?,
+        created_at: Time?,
+        preferences: Knockapi::Models::Recipients::inline_preference_set_request?
+      }
+
+    class InlineIdentifyUserRequest < Knockapi::Internal::Type::BaseModel
+      attr_accessor id: 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,
+        ?channel_data: Knockapi::Models::Recipients::inline_channel_data_request?,
+        ?created_at: Time?,
+        ?preferences: Knockapi::Models::Recipients::inline_preference_set_request?
+      ) -> void
+
+      def to_hash: -> Knockapi::Models::inline_identify_user_request
+    end
+  end
+end

data/sig/knockapi/models/inline_object_request.rbs

@@ -0,0 +1,34 @@
+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
+
+      def to_hash: -> Knockapi::Models::inline_object_request
+    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::Models::TenantRequest
+
+    module InlineTenantRequest
+      extend Knockapi::Internal::Type::Union
+
+      def self?.variants: -> [String, Knockapi::Models::TenantRequest]
+    end
+  end
+end

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

@@ -0,0 +1,39 @@
+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
+
+        def to_hash: -> Knockapi::Models::Integrations::census_custom_destination_params
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,39 @@
+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
+
+        def to_hash: -> Knockapi::Models::Integrations::hightouch_embedded_destination_params
+      end
+    end
+  end
+end

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

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

data/sig/knockapi/models/message.rbs

@@ -0,0 +1,193 @@
+module Knockapi
+  module Models
+    type message =
+      {
+        id: String,
+        _typename: String,
+        actors: ::Array[Knockapi::Models::recipient_reference],
+        archived_at: Time?,
+        channel_id: String,
+        clicked_at: Time?,
+        data: ::Hash[Symbol, top]?,
+        engagement_statuses: ::Array[Knockapi::Models::Message::engagement_status],
+        inserted_at: Time,
+        interacted_at: Time?,
+        link_clicked_at: Time?,
+        metadata: ::Hash[Symbol, top]?,
+        read_at: Time?,
+        recipient: Knockapi::Models::recipient_reference,
+        scheduled_at: Time?,
+        seen_at: Time?,
+        source: Knockapi::Models::Message::Source,
+        status: Knockapi::Models::Message::status,
+        tenant: String?,
+        updated_at: Time,
+        workflow: String?
+      }
+
+    class Message < Knockapi::Internal::Type::BaseModel
+      attr_reader id: String?
+
+      def id=: (String) -> String
+
+      attr_reader _typename: String?
+
+      def _typename=: (String) -> String
+
+      attr_reader actors: ::Array[Knockapi::Models::recipient_reference]?
+
+      def actors=: (
+        ::Array[Knockapi::Models::recipient_reference]
+      ) -> ::Array[Knockapi::Models::recipient_reference]
+
+      attr_accessor archived_at: Time?
+
+      attr_reader channel_id: String?
+
+      def channel_id=: (String) -> String
+
+      attr_accessor clicked_at: Time?
+
+      attr_accessor data: ::Hash[Symbol, top]?
+
+      attr_reader engagement_statuses: ::Array[Knockapi::Models::Message::engagement_status]?
+
+      def engagement_statuses=: (
+        ::Array[Knockapi::Models::Message::engagement_status]
+      ) -> ::Array[Knockapi::Models::Message::engagement_status]
+
+      attr_reader inserted_at: Time?
+
+      def inserted_at=: (Time) -> Time
+
+      attr_accessor interacted_at: Time?
+
+      attr_accessor link_clicked_at: Time?
+
+      attr_accessor metadata: ::Hash[Symbol, top]?
+
+      attr_accessor read_at: Time?
+
+      attr_reader recipient: Knockapi::Models::recipient_reference?
+
+      def recipient=: (
+        Knockapi::Models::recipient_reference
+      ) -> Knockapi::Models::recipient_reference
+
+      attr_accessor scheduled_at: Time?
+
+      attr_accessor seen_at: Time?
+
+      attr_reader source: Knockapi::Models::Message::Source?
+
+      def source=: (
+        Knockapi::Models::Message::Source
+      ) -> Knockapi::Models::Message::Source
+
+      attr_reader status: Knockapi::Models::Message::status?
+
+      def status=: (
+        Knockapi::Models::Message::status
+      ) -> Knockapi::Models::Message::status
+
+      attr_accessor tenant: String?
+
+      attr_reader updated_at: Time?
+
+      def updated_at=: (Time) -> Time
+
+      attr_accessor workflow: String?
+
+      def initialize: (
+        ?id: String,
+        ?_typename: String,
+        ?actors: ::Array[Knockapi::Models::recipient_reference],
+        ?archived_at: Time?,
+        ?channel_id: String,
+        ?clicked_at: Time?,
+        ?data: ::Hash[Symbol, top]?,
+        ?engagement_statuses: ::Array[Knockapi::Models::Message::engagement_status],
+        ?inserted_at: Time,
+        ?interacted_at: Time?,
+        ?link_clicked_at: Time?,
+        ?metadata: ::Hash[Symbol, top]?,
+        ?read_at: Time?,
+        ?recipient: Knockapi::Models::recipient_reference,
+        ?scheduled_at: Time?,
+        ?seen_at: Time?,
+        ?source: Knockapi::Models::Message::Source,
+        ?status: Knockapi::Models::Message::status,
+        ?tenant: String?,
+        ?updated_at: Time,
+        ?workflow: String?
+      ) -> void
+
+      def to_hash: -> Knockapi::Models::message
+
+      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::Message::engagement_status]
+      end
+
+      type source =
+        {
+          _typename: String,
+          categories: ::Array[String],
+          key: String,
+          version_id: String
+        }
+
+      class Source < Knockapi::Internal::Type::BaseModel
+        attr_accessor _typename: String
+
+        attr_accessor categories: ::Array[String]
+
+        attr_accessor key: String
+
+        attr_accessor version_id: String
+
+        def initialize: (
+          _typename: String,
+          categories: ::Array[String],
+          key: String,
+          version_id: String
+        ) -> void
+
+        def to_hash: -> Knockapi::Models::Message::source
+      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::Message::status]
+      end
+    end
+  end
+end

data/sig/knockapi/models/message_archive_params.rbs

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

data/sig/knockapi/models/message_delivery_log.rbs

@@ -0,0 +1,152 @@
+module Knockapi
+  module Models
+    type message_delivery_log =
+      {
+        id: String,
+        _typename: String,
+        environment_id: String,
+        inserted_at: String,
+        request: Knockapi::Models::MessageDeliveryLog::Request,
+        response: Knockapi::Models::MessageDeliveryLog::Response,
+        service_name: String
+      }
+
+    class MessageDeliveryLog < Knockapi::Internal::Type::BaseModel
+      attr_accessor id: String
+
+      attr_accessor _typename: String
+
+      attr_accessor environment_id: String
+
+      attr_accessor inserted_at: String
+
+      attr_accessor request: Knockapi::Models::MessageDeliveryLog::Request
+
+      attr_accessor response: Knockapi::Models::MessageDeliveryLog::Response
+
+      attr_accessor service_name: String
+
+      def initialize: (
+        id: String,
+        _typename: String,
+        environment_id: String,
+        inserted_at: String,
+        request: Knockapi::Models::MessageDeliveryLog::Request,
+        response: Knockapi::Models::MessageDeliveryLog::Response,
+        service_name: String
+      ) -> void
+
+      def to_hash: -> Knockapi::Models::message_delivery_log
+
+      type request =
+        {
+          body: Knockapi::Models::MessageDeliveryLog::Request::body,
+          headers: ::Hash[Symbol, top]?,
+          host: String,
+          method_: Knockapi::Models::MessageDeliveryLog::Request::method_,
+          path: String,
+          query: String?
+        }
+
+      class Request < Knockapi::Internal::Type::BaseModel
+        attr_reader body: Knockapi::Models::MessageDeliveryLog::Request::body?
+
+        def body=: (
+          Knockapi::Models::MessageDeliveryLog::Request::body
+        ) -> Knockapi::Models::MessageDeliveryLog::Request::body
+
+        attr_accessor headers: ::Hash[Symbol, top]?
+
+        attr_reader host: String?
+
+        def host=: (String) -> String
+
+        attr_reader method_: Knockapi::Models::MessageDeliveryLog::Request::method_?
+
+        def method_=: (
+          Knockapi::Models::MessageDeliveryLog::Request::method_
+        ) -> Knockapi::Models::MessageDeliveryLog::Request::method_
+
+        attr_reader path: String?
+
+        def path=: (String) -> String
+
+        attr_accessor query: String?
+
+        def initialize: (
+          ?body: Knockapi::Models::MessageDeliveryLog::Request::body,
+          ?headers: ::Hash[Symbol, top]?,
+          ?host: String,
+          ?method_: Knockapi::Models::MessageDeliveryLog::Request::method_,
+          ?path: String,
+          ?query: String?
+        ) -> void
+
+        def to_hash: -> Knockapi::Models::MessageDeliveryLog::request
+
+        type body = String | ::Hash[Symbol, top]
+
+        module Body
+          extend Knockapi::Internal::Type::Union
+
+          def self?.variants: -> [String, ::Hash[Symbol, top]]
+
+          UnionMember1Map: Knockapi::Internal::Type::Converter
+        end
+
+        type method_ = :GET | :POST | :PUT | :DELETE | :PATCH
+
+        module Method
+          extend Knockapi::Internal::Type::Enum
+
+          GET: :GET
+          POST: :POST
+          PUT: :PUT
+          DELETE: :DELETE
+          PATCH: :PATCH
+
+          def self?.values: -> ::Array[Knockapi::Models::MessageDeliveryLog::Request::method_]
+        end
+      end
+
+      type response =
+        {
+          body: Knockapi::Models::MessageDeliveryLog::Response::body,
+          headers: ::Hash[Symbol, top]?,
+          status: Integer
+        }
+
+      class Response < Knockapi::Internal::Type::BaseModel
+        attr_reader body: Knockapi::Models::MessageDeliveryLog::Response::body?
+
+        def body=: (
+          Knockapi::Models::MessageDeliveryLog::Response::body
+        ) -> Knockapi::Models::MessageDeliveryLog::Response::body
+
+        attr_accessor headers: ::Hash[Symbol, top]?
+
+        attr_reader status: Integer?
+
+        def status=: (Integer) -> Integer
+
+        def initialize: (
+          ?body: Knockapi::Models::MessageDeliveryLog::Response::body,
+          ?headers: ::Hash[Symbol, top]?,
+          ?status: Integer
+        ) -> void
+
+        def to_hash: -> Knockapi::Models::MessageDeliveryLog::response
+
+        type body = String | ::Hash[Symbol, top]
+
+        module Body
+          extend Knockapi::Internal::Type::Union
+
+          def self?.variants: -> [String, ::Hash[Symbol, top]]
+
+          UnionMember1Map: Knockapi::Internal::Type::Converter
+        end
+      end
+    end
+  end
+end