knockapi 1.0.0 → 1.2.0

data/rbi/knockapi/internal/util.rbi

@@ -4,58 +4,115 @@ module Knockapi
   module Internal
     # @api private
     module Util
+      extend Knockapi::Internal::Util::SorbetRuntimeSupport
+
       # @api private
       sig { returns(Float) }
-      def self.monotonic_secs; end
+      def self.monotonic_secs
+      end
+
+      # @api private
+      sig do
+        params(ns: T.any(Module, T::Class[T.anything])).returns(
+          T::Enumerable[T.any(Module, T::Class[T.anything])]
+        )
+      end
+      def self.walk_namespaces(ns)
+      end
 
       class << self
         # @api private
         sig { returns(String) }
-        def arch; end
+        def arch
+        end
 
         # @api private
         sig { returns(String) }
-        def os; end
+        def os
+        end
       end
 
       class << self
         # @api private
         sig { params(input: T.anything).returns(T::Boolean) }
-        def primitive?(input); end
+        def primitive?(input)
+        end
 
         # @api private
-        sig { params(input: T.any(String, T::Boolean)).returns(T.any(T::Boolean, T.anything)) }
-        def coerce_boolean(input); end
+        sig do
+          params(input: T.any(String, T::Boolean)).returns(
+            T.any(T::Boolean, T.anything)
+          )
+        end
+        def coerce_boolean(input)
+        end
 
         # @api private
-        sig { params(input: T.any(String, T::Boolean)).returns(T.nilable(T::Boolean)) }
-        def coerce_boolean!(input); end
+        sig do
+          params(input: T.any(String, T::Boolean)).returns(
+            T.nilable(T::Boolean)
+          )
+        end
+        def coerce_boolean!(input)
+        end
 
         # @api private
-        sig { params(input: T.any(String, Integer)).returns(T.any(Integer, T.anything)) }
-        def coerce_integer(input); end
+        sig do
+          params(input: T.any(String, Integer)).returns(
+            T.any(Integer, T.anything)
+          )
+        end
+        def coerce_integer(input)
+        end
 
         # @api private
-        sig { params(input: T.any(String, Integer, Float)).returns(T.any(Float, T.anything)) }
-        def coerce_float(input); end
+        sig do
+          params(input: T.any(String, Integer, Float)).returns(
+            T.any(Float, T.anything)
+          )
+        end
+        def coerce_float(input)
+        end
+
+        # @api private
+        sig do
+          params(input: T.anything).returns(
+            T.any(T::Hash[T.anything, T.anything], T.anything)
+          )
+        end
+        def coerce_hash(input)
+        end
 
         # @api private
-        sig { params(input: T.anything).returns(T.any(T::Hash[T.anything, T.anything], T.anything)) }
-        def coerce_hash(input); end
+        sig do
+          params(input: T.anything).returns(
+            T.nilable(T::Hash[T.anything, T.anything])
+          )
+        end
+        def coerce_hash!(input)
+        end
       end
 
       class << self
         # @api private
-        sig { params(lhs: T.anything, rhs: T.anything, concat: T::Boolean).returns(T.anything) }
-        private def deep_merge_lr(lhs, rhs, concat: false); end
+        sig do
+          params(lhs: T.anything, rhs: T.anything, concat: T::Boolean).returns(
+            T.anything
+          )
+        end
+        private def deep_merge_lr(lhs, rhs, concat: false)
+        end
 
         # @api private
         #
         # Recursively merge one hash with another. If the values at a given key are not
         # both hashes, just take the new value.
         sig do
-          params(values: T::Array[T.anything], sentinel: T.nilable(T.anything), concat: T::Boolean)
-            .returns(T.anything)
+          params(
+            values: T::Array[T.anything],
+            sentinel: T.nilable(T.anything),
+            concat: T::Boolean
+          ).returns(T.anything)
         end
         def deep_merge(
           *values,
@@ -63,50 +120,70 @@ module Knockapi
           sentinel: nil,
           # whether to merge sequences by concatenation.
           concat: false
-        ); end
+        )
+        end
+
         # @api private
         sig do
           params(
-            data: T.any(Knockapi::Internal::AnyHash, T::Array[T.anything], T.anything),
-            pick: T.nilable(
+            data:
               T.any(
-                Symbol,
-                Integer,
-                T::Array[T.any(Symbol, Integer)],
-                T.proc.params(arg0: T.anything).returns(T.anything)
-              )
-            ),
+                Knockapi::Internal::AnyHash,
+                T::Array[T.anything],
+                T.anything
+              ),
+            pick:
+              T.nilable(
+                T.any(
+                  Symbol,
+                  Integer,
+                  T::Array[T.any(Symbol, Integer)],
+                  T.proc.params(arg0: T.anything).returns(T.anything)
+                )
+              ),
             blk: T.nilable(T.proc.returns(T.anything))
-          )
-            .returns(T.nilable(T.anything))
+          ).returns(T.nilable(T.anything))
+        end
+        def dig(data, pick, &blk)
         end
-        def dig(data, pick, &blk); end
       end
 
       class << self
         # @api private
         sig { params(uri: URI::Generic).returns(String) }
-        def uri_origin(uri); end
+        def uri_origin(uri)
+        end
 
         # @api private
         sig { params(path: T.any(String, T::Array[String])).returns(String) }
-        def interpolate_path(path); end
+        def interpolate_path(path)
+        end
       end
 
       class << self
         # @api private
-        sig { params(query: T.nilable(String)).returns(T::Hash[String, T::Array[String]]) }
-        def decode_query(query); end
+        sig do
+          params(query: T.nilable(String)).returns(
+            T::Hash[String, T::Array[String]]
+          )
+        end
+        def decode_query(query)
+        end
 
         # @api private
         sig do
-          params(query: T.nilable(T::Hash[String, T.nilable(T.any(T::Array[String], String))]))
-            .returns(T.nilable(String))
+          params(
+            query:
+              T.nilable(
+                T::Hash[String, T.nilable(T.any(T::Array[String], String))]
+              )
+          ).returns(T.nilable(String))
+        end
+        def encode_query(query)
         end
-        def encode_query(query); end
       end
 
-      ParsedUriShape =
+      ParsedUri =
         T.type_alias do
           {
             scheme: T.nilable(String),
@@ -119,31 +196,53 @@ module Knockapi
 
       class << self
         # @api private
-        sig { params(url: T.any(URI::Generic, String)).returns(Knockapi::Internal::Util::ParsedUriShape) }
-        def parse_uri(url); end
+        sig do
+          params(url: T.any(URI::Generic, String)).returns(
+            Knockapi::Internal::Util::ParsedUri
+          )
+        end
+        def parse_uri(url)
+        end
 
         # @api private
-        sig { params(parsed: Knockapi::Internal::Util::ParsedUriShape).returns(URI::Generic) }
-        def unparse_uri(parsed); end
+        sig do
+          params(parsed: Knockapi::Internal::Util::ParsedUri).returns(
+            URI::Generic
+          )
+        end
+        def unparse_uri(parsed)
+        end
 
         # @api private
         sig do
-          params(lhs: Knockapi::Internal::Util::ParsedUriShape, rhs: Knockapi::Internal::Util::ParsedUriShape)
-            .returns(URI::Generic)
+          params(
+            lhs: Knockapi::Internal::Util::ParsedUri,
+            rhs: Knockapi::Internal::Util::ParsedUri
+          ).returns(URI::Generic)
+        end
+        def join_parsed_uri(lhs, rhs)
         end
-        def join_parsed_uri(lhs, rhs); end
       end
 
       class << self
         # @api private
         sig do
           params(
-            headers: T::Hash[String,
-                             T.nilable(T.any(String, Integer, T::Array[T.nilable(T.any(String, Integer))]))]
-          )
-            .returns(T::Hash[String, String])
+            headers:
+              T::Hash[
+                String,
+                T.nilable(
+                  T.any(
+                    String,
+                    Integer,
+                    T::Array[T.nilable(T.any(String, Integer))]
+                  )
+                )
+              ]
+          ).returns(T::Hash[String, String])
+        end
+        def normalized_headers(*headers)
         end
-        def normalized_headers(*headers); end
       end
 
       # @api private
@@ -152,38 +251,54 @@ module Knockapi
       class ReadIOAdapter
         # @api private
         sig { returns(T.nilable(T::Boolean)) }
-        def close?; end
+        def close?
+        end
 
         # @api private
         sig { void }
-        def close; end
+        def close
+        end
 
         # @api private
         sig { params(max_len: T.nilable(Integer)).returns(String) }
-        private def read_enum(max_len); end
+        private def read_enum(max_len)
+        end
 
         # @api private
-        sig { params(max_len: T.nilable(Integer), out_string: T.nilable(String)).returns(T.nilable(String)) }
-        def read(max_len = nil, out_string = nil); end
+        sig do
+          params(
+            max_len: T.nilable(Integer),
+            out_string: T.nilable(String)
+          ).returns(T.nilable(String))
+        end
+        def read(max_len = nil, out_string = nil)
+        end
 
         # @api private
         sig do
           params(
             src: T.any(String, Pathname, StringIO, T::Enumerable[String]),
             blk: T.proc.params(arg0: String).void
-          )
-            .returns(T.attached_class)
+          ).returns(T.attached_class)
+        end
+        def self.new(src, &blk)
         end
-        def self.new(src, &blk); end
       end
 
       class << self
-        sig { params(blk: T.proc.params(y: Enumerator::Yielder).void).returns(T::Enumerable[String]) }
-        def writable_enum(&blk); end
+        sig do
+          params(blk: T.proc.params(y: Enumerator::Yielder).void).returns(
+            T::Enumerable[String]
+          )
+        end
+        def writable_enum(&blk)
+        end
       end
 
-      JSON_CONTENT = T.let(%r{^application/(?:vnd(?:\.[^.]+)*\+)?json(?!l)}, Regexp)
-      JSONL_CONTENT = T.let(%r{^application/(?:x-)?jsonl}, Regexp)
+      JSON_CONTENT =
+        T.let(%r{^application/(?:vnd(?:\.[^.]+)*\+)?json(?!l)}, Regexp)
+      JSONL_CONTENT =
+        T.let(%r{^application/(:?x-(?:n|l)djson)|(:?(?:x-)?jsonl)}, Regexp)
 
       class << self
         # @api private
@@ -193,10 +308,15 @@ module Knockapi
             val: T.anything,
             closing: T::Array[T.proc.void],
             content_type: T.nilable(String)
-          )
-            .void
+          ).void
+        end
+        private def write_multipart_content(
+          y,
+          val:,
+          closing:,
+          content_type: nil
+        )
         end
-        private def write_multipart_content(y, val:, closing:, content_type: nil); end
 
         # @api private
         sig do
@@ -206,24 +326,33 @@ module Knockapi
             key: T.any(Symbol, String),
             val: T.anything,
             closing: T::Array[T.proc.void]
-          )
-            .void
+          ).void
+        end
+        private def write_multipart_chunk(y, boundary:, key:, val:, closing:)
         end
-        private def write_multipart_chunk(y, boundary:, key:, val:, closing:); end
 
         # @api private
-        sig { params(body: T.anything).returns([String, T::Enumerable[String]]) }
-        private def encode_multipart_streaming(body); end
+        sig do
+          params(body: T.anything).returns([String, T::Enumerable[String]])
+        end
+        private def encode_multipart_streaming(body)
+        end
 
         # @api private
-        sig { params(headers: T::Hash[String, String], body: T.anything).returns(T.anything) }
-        def encode_content(headers, body); end
+        sig do
+          params(headers: T::Hash[String, String], body: T.anything).returns(
+            T.anything
+          )
+        end
+        def encode_content(headers, body)
+        end
 
         # @api private
         #
         # https://www.iana.org/assignments/character-sets/character-sets.xhtml
         sig { params(content_type: String, text: String).void }
-        def force_charset!(content_type, text:); end
+        def force_charset!(content_type, text:)
+        end
 
         # @api private
         #
@@ -233,10 +362,10 @@ module Knockapi
             headers: T.any(T::Hash[String, String], Net::HTTPHeader),
             stream: T::Enumerable[String],
             suppress_error: T::Boolean
-          )
-            .returns(T.anything)
+          ).returns(T.anything)
+        end
+        def decode_content(headers, stream:, suppress_error: false)
         end
-        def decode_content(headers, stream:, suppress_error: false); end
       end
 
       class << self
@@ -244,24 +373,29 @@ module Knockapi
         #
         # https://doc.rust-lang.org/std/iter/trait.FusedIterator.html
         sig do
-          params(enum: T::Enumerable[T.anything], external: T::Boolean, close: T.proc.void)
-            .returns(T::Enumerable[T.anything])
+          params(
+            enum: T::Enumerable[T.anything],
+            external: T::Boolean,
+            close: T.proc.void
+          ).returns(T::Enumerable[T.anything])
+        end
+        def fused_enum(enum, external: false, &close)
         end
-        def fused_enum(enum, external: false, &close); end
 
         # @api private
         sig { params(enum: T.nilable(T::Enumerable[T.anything])).void }
-        def close_fused!(enum); end
+        def close_fused!(enum)
+        end
 
         # @api private
         sig do
           params(
             enum: T.nilable(T::Enumerable[T.anything]),
             blk: T.proc.params(arg0: Enumerator::Yielder).void
-          )
-            .returns(T::Enumerable[T.anything])
+          ).returns(T::Enumerable[T.anything])
+        end
+        def chain_fused(enum, &blk)
         end
-        def chain_fused(enum, &blk); end
       end
 
       ServerSentEvent =
@@ -281,8 +415,11 @@ module Knockapi
         #
         # This decoder is responsible for reassembling lines split across multiple
         # fragments.
-        sig { params(enum: T::Enumerable[String]).returns(T::Enumerable[String]) }
-        def decode_lines(enum); end
+        sig do
+          params(enum: T::Enumerable[String]).returns(T::Enumerable[String])
+        end
+        def decode_lines(enum)
+        end
 
         # @api private
         #
@@ -290,9 +427,58 @@ module Knockapi
         #
         # Assumes that `lines` has been decoded with `#decode_lines`.
         sig do
-          params(lines: T::Enumerable[String]).returns(T::Enumerable[Knockapi::Internal::Util::ServerSentEvent])
+          params(lines: T::Enumerable[String]).returns(
+            T::Enumerable[Knockapi::Internal::Util::ServerSentEvent]
+          )
+        end
+        def decode_sse(lines)
+        end
+      end
+
+      # @api private
+      module SorbetRuntimeSupport
+        class MissingSorbetRuntimeError < ::RuntimeError
+        end
+
+        # @api private
+        sig { returns(T::Hash[Symbol, T.anything]) }
+        private def sorbet_runtime_constants
+        end
+
+        # @api private
+        sig { params(name: Symbol).void }
+        def const_missing(name)
+        end
+
+        # @api private
+        sig { params(name: Symbol).returns(T::Boolean) }
+        def sorbet_constant_defined?(name)
+        end
+
+        # @api private
+        sig { params(name: Symbol, blk: T.proc.returns(T.anything)).void }
+        def define_sorbet_constant!(name, &blk)
+        end
+
+        # @api private
+        sig { returns(T.anything) }
+        def to_sorbet_type
+        end
+
+        class << self
+          # @api private
+          sig do
+            params(
+              type:
+                T.any(
+                  Knockapi::Internal::Util::SorbetRuntimeSupport,
+                  T.anything
+                )
+            ).returns(T.anything)
+          end
+          def to_sorbet_type(type)
+          end
         end
-        def decode_sse(lines); end
       end
     end
   end

data/rbi/knockapi/internal.rbi

@@ -2,10 +2,15 @@
 
 module Knockapi
   module Internal
+    extend Knockapi::Internal::Util::SorbetRuntimeSupport
+
     # Due to the current WIP status of Shapes support in Sorbet, types referencing
     # this alias might be refined in the future.
     AnyHash = T.type_alias { T::Hash[Symbol, T.anything] }
 
+    FileInput =
+      T.type_alias { T.any(Pathname, StringIO, IO, String, Knockapi::FilePart) }
+
     OMIT = T.let(Object.new.freeze, T.anything)
   end
 end

data/rbi/knockapi/models/activity.rbi

@@ -3,6 +3,9 @@
 module Knockapi
   module Models
     class Activity < Knockapi::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias { T.any(Knockapi::Activity, Knockapi::Internal::AnyHash) }
+
       # Unique identifier for the activity.
       sig { returns(T.nilable(String)) }
       attr_reader :id
@@ -18,7 +21,7 @@ module Knockapi
       attr_writer :_typename
 
       # A recipient of a notification, which is either a user or an object.
-      sig { returns(T.nilable(T.any(Knockapi::Models::User, Knockapi::Models::Object))) }
+      sig { returns(T.nilable(Knockapi::Recipient::Variants)) }
       attr_accessor :actor
 
       # The workflow trigger `data` payload associated with the activity.
@@ -33,12 +36,13 @@ module Knockapi
       attr_writer :inserted_at
 
       # A recipient of a notification, which is either a user or an object.
-      sig { returns(T.nilable(T.any(Knockapi::Models::User, Knockapi::Models::Object))) }
+      sig { returns(T.nilable(Knockapi::Recipient::Variants)) }
       attr_reader :recipient
 
       sig do
-        params(recipient: T.any(Knockapi::Models::User, Knockapi::Internal::AnyHash, Knockapi::Models::Object))
-          .void
+        params(
+          recipient: T.any(Knockapi::User::OrHash, Knockapi::Object::OrHash)
+        ).void
       end
       attr_writer :recipient
 
@@ -57,13 +61,13 @@ module Knockapi
         params(
           id: String,
           _typename: String,
-          actor: T.nilable(T.any(Knockapi::Models::User, Knockapi::Internal::AnyHash, Knockapi::Models::Object)),
+          actor:
+            T.nilable(T.any(Knockapi::User::OrHash, Knockapi::Object::OrHash)),
           data: T.nilable(T::Hash[Symbol, T.anything]),
           inserted_at: Time,
-          recipient: T.any(Knockapi::Models::User, Knockapi::Internal::AnyHash, Knockapi::Models::Object),
+          recipient: T.any(Knockapi::User::OrHash, Knockapi::Object::OrHash),
           updated_at: Time
-        )
-          .returns(T.attached_class)
+        ).returns(T.attached_class)
       end
       def self.new(
         # Unique identifier for the activity.
@@ -80,22 +84,24 @@ module Knockapi
         recipient: nil,
         # Timestamp when the activity was last updated.
         updated_at: nil
-      ); end
+      )
+      end
+
       sig do
-        override
-          .returns(
-            {
-              id: String,
-              _typename: String,
-              actor: T.nilable(T.any(Knockapi::Models::User, Knockapi::Models::Object)),
-              data: T.nilable(T::Hash[Symbol, T.anything]),
-              inserted_at: Time,
-              recipient: T.any(Knockapi::Models::User, Knockapi::Models::Object),
-              updated_at: Time
-            }
-          )
+        override.returns(
+          {
+            id: String,
+            _typename: String,
+            actor: T.nilable(Knockapi::Recipient::Variants),
+            data: T.nilable(T::Hash[Symbol, T.anything]),
+            inserted_at: Time,
+            recipient: Knockapi::Recipient::Variants,
+            updated_at: Time
+          }
+        )
+      end
+      def to_hash
       end
-      def to_hash; end
     end
   end
 end