knockapi 0.6.1 → 1.0.0

data/sig/knockapi/internal/util.rbs

@@ -0,0 +1,158 @@
+module Knockapi
+  module Internal
+    module Util
+      def self?.monotonic_secs: -> Float
+
+      def self?.arch: -> String
+
+      def self?.os: -> String
+
+      def self?.primitive?: (top input) -> bool
+
+      def self?.coerce_boolean: (String | bool input) -> (bool | top)
+
+      def self?.coerce_boolean!: (String | bool input) -> bool?
+
+      def self?.coerce_integer: (String | Integer input) -> (Integer | top)
+
+      def self?.coerce_float: (String | Integer | Float input) -> (Float | top)
+
+      def self?.coerce_hash: (top input) -> (::Hash[top, top] | top)
+
+      def self?.deep_merge_lr: (top lhs, top rhs, ?concat: bool) -> top
+
+      def self?.deep_merge: (
+        *::Array[top] values,
+        ?sentinel: top?,
+        ?concat: bool
+      ) -> top
+
+      def self?.dig: (
+        ::Hash[Symbol, top] | ::Array[top] | top data,
+        (Symbol
+        | Integer
+        | ::Array[(Symbol | Integer)]
+        | (^(top arg0) -> top))? pick
+      ) {
+        -> top?
+      } -> top?
+
+      def self?.uri_origin: (URI::Generic uri) -> String
+
+      def self?.interpolate_path: (String | ::Array[String] path) -> String
+
+      def self?.decode_query: (String? query) -> ::Hash[String, ::Array[String]]
+
+      def self?.encode_query: (
+        ::Hash[String, (::Array[String] | String)?]? query
+      ) -> String?
+
+      type parsed_uri =
+        {
+          scheme: String?,
+          host: String?,
+          port: Integer?,
+          path: String?,
+          query: ::Hash[String, ::Array[String]]
+        }
+
+      def self?.parse_uri: (
+        URI::Generic | String url
+      ) -> Knockapi::Internal::Util::parsed_uri
+
+      def self?.unparse_uri: (
+        Knockapi::Internal::Util::parsed_uri parsed
+      ) -> URI::Generic
+
+      def self?.join_parsed_uri: (
+        Knockapi::Internal::Util::parsed_uri lhs,
+        Knockapi::Internal::Util::parsed_uri rhs
+      ) -> URI::Generic
+
+      def self?.normalized_headers: (
+        *::Hash[String, (String
+        | Integer
+        | ::Array[(String | Integer)?])?] headers
+      ) -> ::Hash[String, String]
+
+      class ReadIOAdapter
+        def close?: -> bool?
+
+        def close: -> void
+
+        private def read_enum: (Integer? max_len) -> String
+
+        def read: (?Integer? max_len, ?String? out_string) -> String?
+
+        def initialize: (
+          String | Pathname | StringIO | Enumerable[String] src
+        ) {
+          (String arg0) -> void
+        } -> void
+      end
+
+      def self?.writable_enum: {
+        (Enumerator::Yielder y) -> void
+      } -> Enumerable[String]
+
+      JSON_CONTENT: Regexp
+      JSONL_CONTENT: Regexp
+
+      def self?.write_multipart_content: (
+        Enumerator::Yielder y,
+        val: top,
+        closing: ::Array[^-> void],
+        ?content_type: String?
+      ) -> void
+
+      def self?.write_multipart_chunk: (
+        Enumerator::Yielder y,
+        boundary: String,
+        key: Symbol | String,
+        val: top,
+        closing: ::Array[^-> void]
+      ) -> void
+
+      def self?.encode_multipart_streaming: (
+        top body
+      ) -> [String, Enumerable[String]]
+
+      def self?.encode_content: (
+        ::Hash[String, String] headers,
+        top body
+      ) -> top
+
+      def self?.force_charset!: (String content_type, text: String) -> void
+
+      def self?.decode_content: (
+        ::Hash[String, String] headers,
+        stream: Enumerable[String],
+        ?suppress_error: bool
+      ) -> top
+
+      def self?.fused_enum: (
+        Enumerable[top] enum,
+        ?external: bool
+      ) {
+        -> void
+      } -> Enumerable[top]
+
+      def self?.close_fused!: (Enumerable[top]? enum) -> void
+
+      def self?.chain_fused: (
+        Enumerable[top]? enum
+      ) {
+        (Enumerator::Yielder arg0) -> void
+      } -> Enumerable[top]
+
+      type server_sent_event =
+        { event: String?, data: String?, id: String?, retry: Integer? }
+
+      def self?.decode_lines: (Enumerable[String] enum) -> Enumerable[String]
+
+      def self?.decode_sse: (
+        Enumerable[String] lines
+      ) -> Enumerable[Knockapi::Internal::Util::server_sent_event]
+    end
+  end
+end

data/sig/knockapi/internal.rbs

@@ -0,0 +1,5 @@
+module Knockapi
+  module Internal
+    OMIT: Object
+  end
+end

data/sig/knockapi/models/activity.rbs

@@ -0,0 +1,54 @@
+module Knockapi
+  module Models
+    type activity =
+      {
+        id: String,
+        _typename: String,
+        actor: Knockapi::Models::recipient?,
+        data: ::Hash[Symbol, top]?,
+        inserted_at: Time,
+        recipient: Knockapi::Models::recipient,
+        updated_at: Time
+      }
+
+    class Activity < Knockapi::Internal::Type::BaseModel
+      attr_reader id: String?
+
+      def id=: (String) -> String
+
+      attr_reader _typename: String?
+
+      def _typename=: (String) -> String
+
+      attr_accessor actor: Knockapi::Models::recipient?
+
+      attr_accessor data: ::Hash[Symbol, top]?
+
+      attr_reader inserted_at: Time?
+
+      def inserted_at=: (Time) -> Time
+
+      attr_reader recipient: Knockapi::Models::recipient?
+
+      def recipient=: (
+        Knockapi::Models::recipient
+      ) -> Knockapi::Models::recipient
+
+      attr_reader updated_at: Time?
+
+      def updated_at=: (Time) -> Time
+
+      def initialize: (
+        ?id: String,
+        ?_typename: String,
+        ?actor: Knockapi::Models::recipient?,
+        ?data: ::Hash[Symbol, top]?,
+        ?inserted_at: Time,
+        ?recipient: Knockapi::Models::recipient,
+        ?updated_at: Time
+      ) -> void
+
+      def to_hash: -> Knockapi::Models::activity
+    end
+  end
+end

data/sig/knockapi/models/audience_add_members_params.rbs

@@ -0,0 +1,52 @@
+module Knockapi
+  module Models
+    type audience_add_members_params =
+      { members: ::Array[Knockapi::Models::AudienceAddMembersParams::Member] }
+      & Knockapi::Internal::Type::request_parameters
+
+    class AudienceAddMembersParams < Knockapi::Internal::Type::BaseModel
+      extend Knockapi::Internal::Type::RequestParameters::Converter
+      include Knockapi::Internal::Type::RequestParameters
+
+      attr_accessor members: ::Array[Knockapi::Models::AudienceAddMembersParams::Member]
+
+      def initialize: (
+        members: ::Array[Knockapi::Models::AudienceAddMembersParams::Member],
+        ?request_options: Knockapi::request_opts
+      ) -> void
+
+      def to_hash: -> Knockapi::Models::audience_add_members_params
+
+      type member =
+        {
+          user: Knockapi::Models::AudienceAddMembersParams::Member::User,
+          tenant: String?
+        }
+
+      class Member < Knockapi::Internal::Type::BaseModel
+        attr_accessor user: Knockapi::Models::AudienceAddMembersParams::Member::User
+
+        attr_accessor tenant: String?
+
+        def initialize: (
+          user: Knockapi::Models::AudienceAddMembersParams::Member::User,
+          ?tenant: String?
+        ) -> void
+
+        def to_hash: -> Knockapi::Models::AudienceAddMembersParams::member
+
+        type user = { id: String }
+
+        class User < Knockapi::Internal::Type::BaseModel
+          attr_reader id: String?
+
+          def id=: (String) -> String
+
+          def initialize: (?id: String) -> void
+
+          def to_hash: -> Knockapi::Models::AudienceAddMembersParams::Member::user
+        end
+      end
+    end
+  end
+end

data/sig/knockapi/models/audience_list_members_params.rbs

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

data/sig/knockapi/models/audience_list_members_response.rbs

@@ -0,0 +1,22 @@
+module Knockapi
+  module Models
+    type audience_list_members_response =
+      {
+        entries: ::Array[Knockapi::Models::AudienceMember],
+        page_info: Knockapi::Models::PageInfo
+      }
+
+    class AudienceListMembersResponse < Knockapi::Internal::Type::BaseModel
+      attr_accessor entries: ::Array[Knockapi::Models::AudienceMember]
+
+      attr_accessor page_info: Knockapi::Models::PageInfo
+
+      def initialize: (
+        entries: ::Array[Knockapi::Models::AudienceMember],
+        page_info: Knockapi::Models::PageInfo
+      ) -> void
+
+      def to_hash: -> Knockapi::Models::audience_list_members_response
+    end
+  end
+end

data/sig/knockapi/models/audience_member.rbs

@@ -0,0 +1,34 @@
+module Knockapi
+  module Models
+    type audience_member =
+      {
+        _typename: String,
+        added_at: Time,
+        user: Knockapi::Models::User,
+        user_id: String,
+        tenant: String?
+      }
+
+    class AudienceMember < Knockapi::Internal::Type::BaseModel
+      attr_accessor _typename: String
+
+      attr_accessor added_at: Time
+
+      attr_accessor user: Knockapi::Models::User
+
+      attr_accessor user_id: String
+
+      attr_accessor tenant: String?
+
+      def initialize: (
+        _typename: String,
+        added_at: Time,
+        user: Knockapi::Models::User,
+        user_id: String,
+        ?tenant: String?
+      ) -> void
+
+      def to_hash: -> Knockapi::Models::audience_member
+    end
+  end
+end

data/sig/knockapi/models/audience_remove_members_params.rbs

@@ -0,0 +1,54 @@
+module Knockapi
+  module Models
+    type audience_remove_members_params =
+      {
+        members: ::Array[Knockapi::Models::AudienceRemoveMembersParams::Member]
+      }
+      & Knockapi::Internal::Type::request_parameters
+
+    class AudienceRemoveMembersParams < Knockapi::Internal::Type::BaseModel
+      extend Knockapi::Internal::Type::RequestParameters::Converter
+      include Knockapi::Internal::Type::RequestParameters
+
+      attr_accessor members: ::Array[Knockapi::Models::AudienceRemoveMembersParams::Member]
+
+      def initialize: (
+        members: ::Array[Knockapi::Models::AudienceRemoveMembersParams::Member],
+        ?request_options: Knockapi::request_opts
+      ) -> void
+
+      def to_hash: -> Knockapi::Models::audience_remove_members_params
+
+      type member =
+        {
+          user: Knockapi::Models::AudienceRemoveMembersParams::Member::User,
+          tenant: String?
+        }
+
+      class Member < Knockapi::Internal::Type::BaseModel
+        attr_accessor user: Knockapi::Models::AudienceRemoveMembersParams::Member::User
+
+        attr_accessor tenant: String?
+
+        def initialize: (
+          user: Knockapi::Models::AudienceRemoveMembersParams::Member::User,
+          ?tenant: String?
+        ) -> void
+
+        def to_hash: -> Knockapi::Models::AudienceRemoveMembersParams::member
+
+        type user = { id: String }
+
+        class User < Knockapi::Internal::Type::BaseModel
+          attr_reader id: String?
+
+          def id=: (String) -> String
+
+          def initialize: (?id: String) -> void
+
+          def to_hash: -> Knockapi::Models::AudienceRemoveMembersParams::Member::user
+        end
+      end
+    end
+  end
+end

data/sig/knockapi/models/bulk_operation.rbs

@@ -0,0 +1,107 @@
+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::Models::BulkOperation::status,
+        success_count: Integer,
+        updated_at: Time,
+        completed_at: Time?,
+        error_count: Integer,
+        error_items: ::Array[Knockapi::Models::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::Models::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::Models::BulkOperation::ErrorItem]?
+
+      def error_items=: (
+        ::Array[Knockapi::Models::BulkOperation::ErrorItem]
+      ) -> ::Array[Knockapi::Models::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::Models::BulkOperation::status,
+        success_count: Integer,
+        updated_at: Time,
+        ?completed_at: Time?,
+        ?error_count: Integer,
+        ?error_items: ::Array[Knockapi::Models::BulkOperation::ErrorItem],
+        ?failed_at: Time?,
+        ?progress_path: String,
+        ?started_at: Time?
+      ) -> void
+
+      def to_hash: -> Knockapi::Models::bulk_operation
+
+      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::Models::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
+
+        def to_hash: -> Knockapi::Models::BulkOperation::error_item
+      end
+    end
+  end
+end

data/sig/knockapi/models/bulk_operation_get_params.rbs

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

data/sig/knockapi/models/channels/bulk_update_message_status_params.rbs

@@ -0,0 +1,176 @@
+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
+
+        def to_hash: -> Knockapi::Models::Channels::bulk_update_message_status_params
+
+        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