knockapi 0.6.1 → 1.1.0

data/sig/knockapi/client.rbs

@@ -0,0 +1,50 @@
+module Knockapi
+  class Client < Knockapi::Internal::Transport::BaseClient
+    DEFAULT_MAX_RETRIES: 2
+
+    DEFAULT_TIMEOUT_IN_SECONDS: Float
+
+    DEFAULT_INITIAL_RETRY_DELAY: Float
+
+    DEFAULT_MAX_RETRY_DELAY: Float
+
+    attr_reader api_key: String
+
+    attr_reader shared: Knockapi::Resources::Shared
+
+    attr_reader recipients: Knockapi::Resources::Recipients
+
+    attr_reader users: Knockapi::Resources::Users
+
+    attr_reader objects: Knockapi::Resources::Objects
+
+    attr_reader tenants: Knockapi::Resources::Tenants
+
+    attr_reader bulk_operations: Knockapi::Resources::BulkOperations
+
+    attr_reader messages: Knockapi::Resources::Messages
+
+    attr_reader providers: Knockapi::Resources::Providers
+
+    attr_reader integrations: Knockapi::Resources::Integrations
+
+    attr_reader workflows: Knockapi::Resources::Workflows
+
+    attr_reader schedules: Knockapi::Resources::Schedules
+
+    attr_reader channels: Knockapi::Resources::Channels
+
+    attr_reader audiences: Knockapi::Resources::Audiences
+
+    private def auth_headers: -> ::Hash[String, String]
+
+    def initialize: (
+      ?api_key: String?,
+      ?base_url: String?,
+      ?max_retries: Integer,
+      ?timeout: Float,
+      ?initial_retry_delay: Float,
+      ?max_retry_delay: Float
+    ) -> void
+  end
+end

data/sig/knockapi/errors.rbs

@@ -0,0 +1,101 @@
+module Knockapi
+  module Errors
+    class Error < StandardError
+      attr_accessor cause: StandardError?
+    end
+
+    class ConversionError < Knockapi::Errors::Error
+    end
+
+    class APIError < Knockapi::Errors::Error
+      attr_accessor url: URI::Generic
+
+      attr_accessor status: Integer?
+
+      attr_accessor body: top?
+
+      def initialize: (
+        url: URI::Generic,
+        ?status: Integer?,
+        ?body: Object?,
+        ?request: nil,
+        ?response: nil,
+        ?message: String?
+      ) -> void
+    end
+
+    class APIConnectionError < Knockapi::Errors::APIError
+      def initialize: (
+        url: URI::Generic,
+        ?status: nil,
+        ?body: nil,
+        ?request: nil,
+        ?response: nil,
+        ?message: String?
+      ) -> void
+    end
+
+    class APITimeoutError < Knockapi::Errors::APIConnectionError
+      def initialize: (
+        url: URI::Generic,
+        ?status: nil,
+        ?body: nil,
+        ?request: nil,
+        ?response: nil,
+        ?message: String?
+      ) -> void
+    end
+
+    class APIStatusError < Knockapi::Errors::APIError
+      def self.for: (
+        url: URI::Generic,
+        status: Integer,
+        body: Object?,
+        request: nil,
+        response: nil,
+        ?message: String?
+      ) -> instance
+
+      def initialize: (
+        url: URI::Generic,
+        status: Integer,
+        body: Object?,
+        request: nil,
+        response: nil,
+        ?message: String?
+      ) -> void
+    end
+
+    class BadRequestError < Knockapi::Errors::APIStatusError
+      HTTP_STATUS: 400
+    end
+
+    class AuthenticationError < Knockapi::Errors::APIStatusError
+      HTTP_STATUS: 401
+    end
+
+    class PermissionDeniedError < Knockapi::Errors::APIStatusError
+      HTTP_STATUS: 403
+    end
+
+    class NotFoundError < Knockapi::Errors::APIStatusError
+      HTTP_STATUS: 404
+    end
+
+    class ConflictError < Knockapi::Errors::APIStatusError
+      HTTP_STATUS: 409
+    end
+
+    class UnprocessableEntityError < Knockapi::Errors::APIStatusError
+      HTTP_STATUS: 422
+    end
+
+    class RateLimitError < Knockapi::Errors::APIStatusError
+      HTTP_STATUS: 429
+    end
+
+    class InternalServerError < Knockapi::Errors::APIStatusError
+      HTTP_STATUS: Range[Integer]
+    end
+  end
+end

data/sig/knockapi/file_part.rbs

@@ -0,0 +1,21 @@
+module Knockapi
+  class FilePart
+    attr_reader content: Pathname | StringIO | IO | String
+
+    attr_reader content_type: String?
+
+    attr_reader filename: String?
+
+    private def read: -> String
+
+    def to_json: (*top a) -> String
+
+    def to_yaml: (*top a) -> String
+
+    def initialize: (
+      Pathname | StringIO | IO | String content,
+      ?filename: String?,
+      ?content_type: String?
+    ) -> void
+  end
+end

data/sig/knockapi/internal/entries_cursor.rbs

@@ -0,0 +1,22 @@
+module Knockapi
+  module Internal
+    class EntriesCursor[Elem]
+      include Knockapi::Internal::Type::BasePage[Elem]
+
+      attr_accessor entries: ::Array[Elem]?
+
+      attr_accessor page_info: PageInfo
+
+      def inspect: -> String
+
+      type page_info = { after: String }
+      class PageInfo < Knockapi::Internal::Type::BaseModel
+        attr_reader after: String?
+
+        def after=: (String) -> String
+
+        def initialize: (?after: String) -> void
+      end
+    end
+  end
+end

data/sig/knockapi/internal/items_cursor.rbs

@@ -0,0 +1,22 @@
+module Knockapi
+  module Internal
+    class ItemsCursor[Elem]
+      include Knockapi::Internal::Type::BasePage[Elem]
+
+      attr_accessor items: ::Array[Elem]?
+
+      attr_accessor page_info: PageInfo
+
+      def inspect: -> String
+
+      type page_info = { after: String }
+      class PageInfo < Knockapi::Internal::Type::BaseModel
+        attr_reader after: String?
+
+        def after=: (String) -> String
+
+        def initialize: (?after: String) -> void
+      end
+    end
+  end
+end

data/sig/knockapi/internal/ms_teams_pagination.rbs

@@ -0,0 +1,13 @@
+module Knockapi
+  module Internal
+    class MsTeamsPagination[Elem]
+      include Knockapi::Internal::Type::BasePage[Elem]
+
+      attr_accessor skip_token: String
+
+      attr_accessor ms_teams_teams: ::Array[Elem]?
+
+      def inspect: -> String
+    end
+  end
+end

data/sig/knockapi/internal/slack_channels_cursor.rbs

@@ -0,0 +1,13 @@
+module Knockapi
+  module Internal
+    class SlackChannelsCursor[Elem]
+      include Knockapi::Internal::Type::BasePage[Elem]
+
+      attr_accessor next_cursor: String
+
+      attr_accessor slack_channels: ::Array[Elem]?
+
+      def inspect: -> String
+    end
+  end
+end

data/sig/knockapi/internal/transport/base_client.rbs

@@ -0,0 +1,131 @@
+module Knockapi
+  module Internal
+    module Transport
+      class BaseClient
+        extend Knockapi::Internal::Util::SorbetRuntimeSupport
+
+        type request_components =
+          {
+            method: Symbol,
+            path: String | ::Array[String],
+            query: ::Hash[String, (::Array[String] | String)?]?,
+            headers: ::Hash[String, (String
+            | Integer
+            | ::Array[(String | Integer)?])?]?,
+            body: top?,
+            unwrap: (Symbol
+            | Integer
+            | ::Array[(Symbol | Integer)]
+            | (^(top arg0) -> top))?,
+            page: Class?,
+            stream: Class?,
+            model: Knockapi::Internal::Type::Converter::input?,
+            options: Knockapi::request_opts?
+          }
+        type request_input =
+          {
+            method: Symbol,
+            url: URI::Generic,
+            headers: ::Hash[String, String],
+            body: top,
+            max_retries: Integer,
+            timeout: Float
+          }
+
+        MAX_REDIRECTS: 20
+
+        PLATFORM_HEADERS: ::Hash[String, String]
+
+        def self.validate!: (
+          Knockapi::Internal::Transport::BaseClient::request_components req
+        ) -> void
+
+        def self.should_retry?: (
+          Integer status,
+          headers: ::Hash[String, String]
+        ) -> bool
+
+        def self.follow_redirect: (
+          Knockapi::Internal::Transport::BaseClient::request_input request,
+          status: Integer,
+          response_headers: ::Hash[String, String]
+        ) -> Knockapi::Internal::Transport::BaseClient::request_input
+
+        def self.reap_connection!: (
+          Integer | Knockapi::Errors::APIConnectionError status,
+          stream: Enumerable[String]?
+        ) -> void
+
+        attr_reader base_url: URI::Generic
+
+        attr_reader timeout: Float
+
+        attr_reader max_retries: Integer
+
+        attr_reader initial_retry_delay: Float
+
+        attr_reader max_retry_delay: Float
+
+        attr_reader headers: ::Hash[String, String]
+
+        attr_reader idempotency_header: String?
+
+        # @api private
+        attr_reader requester: Knockapi::Internal::Transport::PooledNetRequester
+
+        def initialize: (
+          base_url: String,
+          ?timeout: Float,
+          ?max_retries: Integer,
+          ?initial_retry_delay: Float,
+          ?max_retry_delay: Float,
+          ?headers: ::Hash[String, (String
+          | Integer
+          | ::Array[(String | Integer)?])?],
+          ?idempotency_header: String?
+        ) -> void
+
+        private def auth_headers: -> ::Hash[String, String]
+
+        private def generate_idempotency_key: -> String
+
+        private def build_request: (
+          Knockapi::Internal::Transport::BaseClient::request_components req,
+          Knockapi::request_options opts
+        ) -> Knockapi::Internal::Transport::BaseClient::request_input
+
+        private def retry_delay: (
+          ::Hash[String, String] headers,
+          retry_count: Integer
+        ) -> Float
+
+        private def send_request: (
+          Knockapi::Internal::Transport::BaseClient::request_input request,
+          redirect_count: Integer,
+          retry_count: Integer,
+          send_retry_header: bool
+        ) -> [Integer, top, Enumerable[String]]
+
+        def request: (
+          Symbol method,
+          String | ::Array[String] path,
+          ?query: ::Hash[String, (::Array[String] | String)?]?,
+          ?headers: ::Hash[String, (String
+          | Integer
+          | ::Array[(String | Integer)?])?]?,
+          ?body: top?,
+          ?unwrap: (Symbol
+          | Integer
+          | ::Array[(Symbol | Integer)]
+          | (^(top arg0) -> top))?,
+          ?page: Class?,
+          ?stream: Class?,
+          ?model: Knockapi::Internal::Type::Converter::input?,
+          ?options: Knockapi::request_opts?
+        ) -> top
+
+        def inspect: -> String
+      end
+    end
+  end
+end

data/sig/knockapi/internal/transport/pooled_net_requester.rbs

@@ -0,0 +1,45 @@
+module Knockapi
+  module Internal
+    module Transport
+      class PooledNetRequester
+        extend Knockapi::Internal::Util::SorbetRuntimeSupport
+
+        type request =
+          {
+            method: Symbol,
+            url: URI::Generic,
+            headers: ::Hash[String, String],
+            body: top,
+            deadline: Float
+          }
+
+        KEEP_ALIVE_TIMEOUT: 30
+
+        DEFAULT_MAX_CONNECTIONS: Integer
+
+        def self.connect: (URI::Generic url) -> top
+
+        def self.calibrate_socket_timeout: (top conn, Float deadline) -> void
+
+        def self.build_request: (
+          Knockapi::Internal::Transport::PooledNetRequester::request request
+        ) {
+          (String arg0) -> void
+        } -> [top, (^-> void)]
+
+        private def with_pool: (
+          URI::Generic url,
+          deadline: Float
+        ) {
+          (top arg0) -> void
+        } -> void
+
+        def execute: (
+          Knockapi::Internal::Transport::PooledNetRequester::request request
+        ) -> [Integer, top, Enumerable[String]]
+
+        def initialize: (?size: Integer) -> void
+      end
+    end
+  end
+end

data/sig/knockapi/internal/type/array_of.rbs

@@ -0,0 +1,45 @@
+module Knockapi
+  module Internal
+    module Type
+      class ArrayOf[Elem]
+        include Knockapi::Internal::Type::Converter
+
+        def self.[]: (
+          ::Hash[Symbol, top]
+          | ^-> Knockapi::Internal::Type::Converter::input
+          | Knockapi::Internal::Type::Converter::input type_info,
+          ?::Hash[Symbol, top] spec
+        ) -> instance
+
+        def ===: (top other) -> bool
+
+        def ==: (top other) -> bool
+
+        def hash: -> Integer
+
+        def coerce: (
+          ::Array[top] | top value,
+          state: Knockapi::Internal::Type::Converter::coerce_state
+        ) -> (::Array[top] | top)
+
+        def dump: (
+          ::Array[top] | top value,
+          state: Knockapi::Internal::Type::Converter::dump_state
+        ) -> (::Array[top] | top)
+
+        def item_type: -> Elem
+
+        def nilable?: -> bool
+
+        def initialize: (
+          ::Hash[Symbol, top]
+          | ^-> Knockapi::Internal::Type::Converter::input
+          | Knockapi::Internal::Type::Converter::input type_info,
+          ?::Hash[Symbol, top] spec
+        ) -> void
+
+        def inspect: (?depth: Integer) -> String
+      end
+    end
+  end
+end

data/sig/knockapi/internal/type/base_model.rbs

@@ -0,0 +1,100 @@
+module Knockapi
+  module Internal
+    module Type
+      class BaseModel
+        extend Knockapi::Internal::Type::Converter
+        extend Knockapi::Internal::Util::SorbetRuntimeSupport
+
+        type known_field =
+          { mode: (:coerce | :dump)?, required: bool, nilable: bool }
+
+        def self.inherited: (self child) -> void
+
+        def self.known_fields: -> ::Hash[Symbol, (Knockapi::Internal::Type::BaseModel::known_field
+        & { type_fn: (^-> Knockapi::Internal::Type::Converter::input) })]
+
+        def self.fields: -> ::Hash[Symbol, (Knockapi::Internal::Type::BaseModel::known_field
+        & { type: Knockapi::Internal::Type::Converter::input })]
+
+        private def self.add_field: (
+          Symbol name_sym,
+          required: bool,
+          type_info: {
+            const: (nil | bool | Integer | Float | Symbol)?,
+            enum: ^-> Knockapi::Internal::Type::Converter::input?,
+            union: ^-> Knockapi::Internal::Type::Converter::input?,
+            api_name: Symbol
+          }
+          | ^-> Knockapi::Internal::Type::Converter::input
+          | Knockapi::Internal::Type::Converter::input,
+          spec: ::Hash[Symbol, top]
+        ) -> void
+
+        def self.required: (
+          Symbol name_sym,
+          ::Hash[Symbol, top]
+          | ^-> Knockapi::Internal::Type::Converter::input
+          | Knockapi::Internal::Type::Converter::input type_info,
+          ?::Hash[Symbol, top] spec
+        ) -> void
+
+        def self.optional: (
+          Symbol name_sym,
+          ::Hash[Symbol, top]
+          | ^-> Knockapi::Internal::Type::Converter::input
+          | Knockapi::Internal::Type::Converter::input type_info,
+          ?::Hash[Symbol, top] spec
+        ) -> void
+
+        private def self.request_only: { -> void } -> void
+
+        private def self.response_only: { -> void } -> void
+
+        def self.==: (top other) -> bool
+
+        def self.hash: -> Integer
+
+        def ==: (top other) -> bool
+
+        def hash: -> Integer
+
+        def self.coerce: (
+          Knockapi::Internal::Type::BaseModel | ::Hash[top, top] | top value,
+          state: Knockapi::Internal::Type::Converter::coerce_state
+        ) -> (instance | top)
+
+        def self.dump: (
+          instance | top value,
+          state: Knockapi::Internal::Type::Converter::dump_state
+        ) -> (::Hash[top, top] | top)
+
+        def self.recursively_to_h: (
+          Knockapi::Internal::Type::BaseModel model,
+          convert: bool
+        ) -> ::Hash[Symbol, top]
+
+        def []: (Symbol key) -> top?
+
+        def to_h: -> ::Hash[Symbol, top]
+
+        alias to_hash to_h
+
+        def deep_to_h: -> ::Hash[Symbol, top]
+
+        def deconstruct_keys: (::Array[Symbol]? keys) -> ::Hash[Symbol, top]
+
+        def to_json: (*top a) -> String
+
+        def to_yaml: (*top a) -> String
+
+        def initialize: (?::Hash[Symbol, top] | instance data) -> void
+
+        def self.inspect: (?depth: Integer) -> String
+
+        def to_s: -> String
+
+        def inspect: -> String
+      end
+    end
+  end
+end

data/sig/knockapi/internal/type/base_page.rbs

@@ -0,0 +1,24 @@
+module Knockapi
+  module Internal
+    module Type
+      module BasePage[Elem]
+        def next_page?: -> bool
+
+        def next_page: -> instance
+
+        def auto_paging_each: { (Elem arg0) -> void } -> void
+
+        def to_enum: -> Enumerable[Elem]
+
+        alias enum_for to_enum
+
+        def initialize: (
+          client: Knockapi::Internal::Transport::BaseClient,
+          req: Knockapi::Internal::Transport::BaseClient::request_components,
+          headers: ::Hash[String, String],
+          page_data: top
+        ) -> void
+      end
+    end
+  end
+end

data/sig/knockapi/internal/type/boolean.rbs

@@ -0,0 +1,23 @@
+module Knockapi
+  module Internal
+    module Type
+      class Boolean
+        extend Knockapi::Internal::Type::Converter
+
+        def self.===: (top other) -> bool
+
+        def self.==: (top other) -> bool
+
+        def self.coerce: (
+          bool | top value,
+          state: Knockapi::Internal::Type::Converter::coerce_state
+        ) -> (bool | top)
+
+        def self.dump: (
+          bool | top value,
+          state: Knockapi::Internal::Type::Converter::dump_state
+        ) -> (bool | top)
+      end
+    end
+  end
+end

data/sig/knockapi/internal/type/converter.rbs

@@ -0,0 +1,56 @@
+module Knockapi
+  module Internal
+    module Type
+      module Converter
+        extend Knockapi::Internal::Util::SorbetRuntimeSupport
+
+        type input = Knockapi::Internal::Type::Converter | Class
+
+        type coerce_state =
+          {
+            strictness: bool | :strong,
+            exactness: { yes: Integer, no: Integer, maybe: Integer },
+            branched: Integer
+          }
+
+        type dump_state = { can_retry: bool }
+
+        def coerce: (
+          top value,
+          state: Knockapi::Internal::Type::Converter::coerce_state
+        ) -> top
+
+        def dump: (
+          top value,
+          state: Knockapi::Internal::Type::Converter::dump_state
+        ) -> top
+
+        def inspect: (?depth: Integer) -> String
+
+        def self.type_info: (
+          {
+            const: (nil | bool | Integer | Float | Symbol)?,
+            enum: ^-> Knockapi::Internal::Type::Converter::input?,
+            union: ^-> Knockapi::Internal::Type::Converter::input?
+          }
+          | ^-> Knockapi::Internal::Type::Converter::input
+          | Knockapi::Internal::Type::Converter::input spec
+        ) -> (^-> top)
+
+        def self.coerce: (
+          Knockapi::Internal::Type::Converter::input target,
+          top value,
+          ?state: Knockapi::Internal::Type::Converter::coerce_state
+        ) -> top
+
+        def self.dump: (
+          Knockapi::Internal::Type::Converter::input target,
+          top value,
+          ?state: Knockapi::Internal::Type::Converter::dump_state
+        ) -> top
+
+        def self.inspect: (top target, depth: Integer) -> String
+      end
+    end
+  end
+end