knockapi 0.6.1 → 1.0.0

data/rbi/knockapi/internal/util.rbi

@@ -0,0 +1,299 @@
+# typed: strong
+
+module Knockapi
+  module Internal
+    # @api private
+    module Util
+      # @api private
+      sig { returns(Float) }
+      def self.monotonic_secs; end
+
+      class << self
+        # @api private
+        sig { returns(String) }
+        def arch; end
+
+        # @api private
+        sig { returns(String) }
+        def os; end
+      end
+
+      class << self
+        # @api private
+        sig { params(input: T.anything).returns(T::Boolean) }
+        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
+
+        # @api private
+        sig { params(input: T.any(String, T::Boolean)).returns(T.nilable(T::Boolean)) }
+        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
+
+        # @api private
+        sig { params(input: T.any(String, Integer, Float)).returns(T.any(Float, T.anything)) }
+        def coerce_float(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
+      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
+
+        # @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)
+        end
+        def deep_merge(
+          *values,
+          # the value to return if no values are provided.
+          sentinel: nil,
+          # whether to merge sequences by concatenation.
+          concat: false
+        ); end
+        # @api private
+        sig do
+          params(
+            data: T.any(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))
+        end
+        def dig(data, pick, &blk); end
+      end
+
+      class << self
+        # @api private
+        sig { params(uri: URI::Generic).returns(String) }
+        def uri_origin(uri); end
+
+        # @api private
+        sig { params(path: T.any(String, T::Array[String])).returns(String) }
+        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
+
+        # @api private
+        sig do
+          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
+      end
+
+      ParsedUriShape =
+        T.type_alias do
+          {
+            scheme: T.nilable(String),
+            host: T.nilable(String),
+            port: T.nilable(Integer),
+            path: T.nilable(String),
+            query: T::Hash[String, T::Array[String]]
+          }
+        end
+
+      class << self
+        # @api private
+        sig { params(url: T.any(URI::Generic, String)).returns(Knockapi::Internal::Util::ParsedUriShape) }
+        def parse_uri(url); end
+
+        # @api private
+        sig { params(parsed: Knockapi::Internal::Util::ParsedUriShape).returns(URI::Generic) }
+        def unparse_uri(parsed); end
+
+        # @api private
+        sig do
+          params(lhs: Knockapi::Internal::Util::ParsedUriShape, rhs: Knockapi::Internal::Util::ParsedUriShape)
+            .returns(URI::Generic)
+        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])
+        end
+        def normalized_headers(*headers); end
+      end
+
+      # @api private
+      #
+      # An adapter that satisfies the IO interface required by `::IO.copy_stream`
+      class ReadIOAdapter
+        # @api private
+        sig { returns(T.nilable(T::Boolean)) }
+        def close?; end
+
+        # @api private
+        sig { void }
+        def close; end
+
+        # @api private
+        sig { params(max_len: T.nilable(Integer)).returns(String) }
+        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
+
+        # @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)
+        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
+      end
+
+      JSON_CONTENT = T.let(%r{^application/(?:vnd(?:\.[^.]+)*\+)?json(?!l)}, Regexp)
+      JSONL_CONTENT = T.let(%r{^application/(?:x-)?jsonl}, Regexp)
+
+      class << self
+        # @api private
+        sig do
+          params(
+            y: Enumerator::Yielder,
+            val: T.anything,
+            closing: T::Array[T.proc.void],
+            content_type: T.nilable(String)
+          )
+            .void
+        end
+        private def write_multipart_content(y, val:, closing:, content_type: nil); end
+
+        # @api private
+        sig do
+          params(
+            y: Enumerator::Yielder,
+            boundary: String,
+            key: T.any(Symbol, String),
+            val: T.anything,
+            closing: T::Array[T.proc.void]
+          )
+            .void
+        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
+
+        # @api private
+        sig { params(headers: T::Hash[String, String], body: T.anything).returns(T.anything) }
+        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
+
+        # @api private
+        #
+        # Assumes each chunk in stream has `Encoding::BINARY`.
+        sig do
+          params(
+            headers: T.any(T::Hash[String, String], Net::HTTPHeader),
+            stream: T::Enumerable[String],
+            suppress_error: T::Boolean
+          )
+            .returns(T.anything)
+        end
+        def decode_content(headers, stream:, suppress_error: false); end
+      end
+
+      class << self
+        # @api private
+        #
+        # 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])
+        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
+
+        # @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])
+        end
+        def chain_fused(enum, &blk); end
+      end
+
+      ServerSentEvent =
+        T.type_alias do
+          {
+            event: T.nilable(String),
+            data: T.nilable(String),
+            id: T.nilable(String),
+            retry: T.nilable(Integer)
+          }
+        end
+
+      class << self
+        # @api private
+        #
+        # Assumes Strings have been forced into having `Encoding::BINARY`.
+        #
+        # 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
+
+        # @api private
+        #
+        # https://html.spec.whatwg.org/multipage/server-sent-events.html#parsing-an-event-stream
+        #
+        # Assumes that `lines` has been decoded with `#decode_lines`.
+        sig do
+          params(lines: T::Enumerable[String]).returns(T::Enumerable[Knockapi::Internal::Util::ServerSentEvent])
+        end
+        def decode_sse(lines); end
+      end
+    end
+  end
+end

data/rbi/knockapi/internal.rbi

@@ -0,0 +1,11 @@
+# typed: strong
+
+module Knockapi
+  module Internal
+    # 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] }
+
+    OMIT = T.let(Object.new.freeze, T.anything)
+  end
+end

data/rbi/knockapi/models/activity.rbi

@@ -0,0 +1,101 @@
+# typed: strong
+
+module Knockapi
+  module Models
+    class Activity < Knockapi::Internal::Type::BaseModel
+      # Unique identifier for the activity.
+      sig { returns(T.nilable(String)) }
+      attr_reader :id
+
+      sig { params(id: String).void }
+      attr_writer :id
+
+      # The typename of the schema.
+      sig { returns(T.nilable(String)) }
+      attr_reader :_typename
+
+      sig { params(_typename: String).void }
+      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))) }
+      attr_accessor :actor
+
+      # The workflow trigger `data` payload associated with the activity.
+      sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
+      attr_accessor :data
+
+      # Timestamp when the activity was created.
+      sig { returns(T.nilable(Time)) }
+      attr_reader :inserted_at
+
+      sig { params(inserted_at: Time).void }
+      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))) }
+      attr_reader :recipient
+
+      sig do
+        params(recipient: T.any(Knockapi::Models::User, Knockapi::Internal::AnyHash, Knockapi::Models::Object))
+          .void
+      end
+      attr_writer :recipient
+
+      # Timestamp when the activity was last updated.
+      sig { returns(T.nilable(Time)) }
+      attr_reader :updated_at
+
+      sig { params(updated_at: Time).void }
+      attr_writer :updated_at
+
+      # An activity associated with a workflow trigger request. Messages produced after
+      # a [batch step](/designing-workflows/batch-function) can be associated with one
+      # or more activities. Non-batched messages will always be associated with a single
+      # activity.
+      sig do
+        params(
+          id: String,
+          _typename: String,
+          actor: T.nilable(T.any(Knockapi::Models::User, Knockapi::Internal::AnyHash, Knockapi::Models::Object)),
+          data: T.nilable(T::Hash[Symbol, T.anything]),
+          inserted_at: Time,
+          recipient: T.any(Knockapi::Models::User, Knockapi::Internal::AnyHash, Knockapi::Models::Object),
+          updated_at: Time
+        )
+          .returns(T.attached_class)
+      end
+      def self.new(
+        # Unique identifier for the activity.
+        id: nil,
+        # The typename of the schema.
+        _typename: nil,
+        # A recipient of a notification, which is either a user or an object.
+        actor: nil,
+        # The workflow trigger `data` payload associated with the activity.
+        data: nil,
+        # Timestamp when the activity was created.
+        inserted_at: nil,
+        # A recipient of a notification, which is either a user or an object.
+        recipient: nil,
+        # Timestamp when the activity was last updated.
+        updated_at: nil
+      ); 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
+            }
+          )
+      end
+      def to_hash; end
+    end
+  end
+end

data/rbi/knockapi/models/audience_add_members_params.rbi

@@ -0,0 +1,88 @@
+# typed: strong
+
+module Knockapi
+  module Models
+    class AudienceAddMembersParams < Knockapi::Internal::Type::BaseModel
+      extend Knockapi::Internal::Type::RequestParameters::Converter
+      include Knockapi::Internal::Type::RequestParameters
+
+      # A list of audience members to add.
+      sig { returns(T::Array[Knockapi::Models::AudienceAddMembersParams::Member]) }
+      attr_accessor :members
+
+      sig do
+        params(
+          members: T::Array[T.any(Knockapi::Models::AudienceAddMembersParams::Member, Knockapi::Internal::AnyHash)],
+          request_options: T.any(Knockapi::RequestOptions, Knockapi::Internal::AnyHash)
+        )
+          .returns(T.attached_class)
+      end
+      def self.new(
+        # A list of audience members to add.
+        members:,
+        request_options: {}
+      ); end
+      sig do
+        override
+          .returns(
+            {
+              members: T::Array[Knockapi::Models::AudienceAddMembersParams::Member],
+              request_options: Knockapi::RequestOptions
+            }
+          )
+      end
+      def to_hash; end
+
+      class Member < Knockapi::Internal::Type::BaseModel
+        sig { returns(Knockapi::Models::AudienceAddMembersParams::Member::User) }
+        attr_reader :user
+
+        sig do
+          params(user: T.any(Knockapi::Models::AudienceAddMembersParams::Member::User, Knockapi::Internal::AnyHash))
+            .void
+        end
+        attr_writer :user
+
+        # The unique identifier for the tenant.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :tenant
+
+        # An audience member.
+        sig do
+          params(
+            user: T.any(Knockapi::Models::AudienceAddMembersParams::Member::User, Knockapi::Internal::AnyHash),
+            tenant: T.nilable(String)
+          )
+            .returns(T.attached_class)
+        end
+        def self.new(
+          user:,
+          # The unique identifier for the tenant.
+          tenant: nil
+        ); end
+        sig do
+          override
+            .returns({user: Knockapi::Models::AudienceAddMembersParams::Member::User, tenant: T.nilable(String)})
+        end
+        def to_hash; end
+
+        class User < Knockapi::Internal::Type::BaseModel
+          # The ID for the user that you set when identifying them in Knock.
+          sig { returns(T.nilable(String)) }
+          attr_reader :id
+
+          sig { params(id: String).void }
+          attr_writer :id
+
+          sig { params(id: String).returns(T.attached_class) }
+          def self.new(
+            # The ID for the user that you set when identifying them in Knock.
+            id: nil
+          ); end
+          sig { override.returns({id: String}) }
+          def to_hash; end
+        end
+      end
+    end
+  end
+end

data/rbi/knockapi/models/audience_list_members_params.rbi

@@ -0,0 +1,19 @@
+# typed: strong
+
+module Knockapi
+  module Models
+    class AudienceListMembersParams < Knockapi::Internal::Type::BaseModel
+      extend Knockapi::Internal::Type::RequestParameters::Converter
+      include Knockapi::Internal::Type::RequestParameters
+
+      sig do
+        params(request_options: T.any(Knockapi::RequestOptions, Knockapi::Internal::AnyHash))
+          .returns(T.attached_class)
+      end
+      def self.new(request_options: {}); end
+
+      sig { override.returns({request_options: Knockapi::RequestOptions}) }
+      def to_hash; end
+    end
+  end
+end

data/rbi/knockapi/models/audience_list_members_response.rbi

@@ -0,0 +1,38 @@
+# typed: strong
+
+module Knockapi
+  module Models
+    class AudienceListMembersResponse < Knockapi::Internal::Type::BaseModel
+      # A list of audience members.
+      sig { returns(T::Array[Knockapi::Models::AudienceMember]) }
+      attr_accessor :entries
+
+      # Pagination information for a list of resources.
+      sig { returns(Knockapi::Models::PageInfo) }
+      attr_reader :page_info
+
+      sig { params(page_info: T.any(Knockapi::Models::PageInfo, Knockapi::Internal::AnyHash)).void }
+      attr_writer :page_info
+
+      # A paginated list of audience members.
+      sig do
+        params(
+          entries: T::Array[T.any(Knockapi::Models::AudienceMember, Knockapi::Internal::AnyHash)],
+          page_info: T.any(Knockapi::Models::PageInfo, Knockapi::Internal::AnyHash)
+        )
+          .returns(T.attached_class)
+      end
+      def self.new(
+        # A list of audience members.
+        entries:,
+        # Pagination information for a list of resources.
+        page_info:
+      ); end
+      sig do
+        override
+          .returns({entries: T::Array[Knockapi::Models::AudienceMember], page_info: Knockapi::Models::PageInfo})
+      end
+      def to_hash; end
+    end
+  end
+end

data/rbi/knockapi/models/audience_member.rbi

@@ -0,0 +1,65 @@
+# typed: strong
+
+module Knockapi
+  module Models
+    class AudienceMember < Knockapi::Internal::Type::BaseModel
+      # The typename of the schema.
+      sig { returns(String) }
+      attr_accessor :_typename
+
+      # Timestamp when the resource was created.
+      sig { returns(Time) }
+      attr_accessor :added_at
+
+      # A [User](/concepts/users) represents an individual in your system who can
+      # receive notifications through Knock. Users are the most common recipients of
+      # notifications and are always referenced by your internal identifier.
+      sig { returns(Knockapi::Models::User) }
+      attr_reader :user
+
+      sig { params(user: T.any(Knockapi::Models::User, Knockapi::Internal::AnyHash)).void }
+      attr_writer :user
+
+      # The ID for the user that you set when identifying them in Knock.
+      sig { returns(String) }
+      attr_accessor :user_id
+
+      # The unique identifier for the tenant.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :tenant
+
+      # An audience member.
+      sig do
+        params(
+          _typename: String,
+          added_at: Time,
+          user: T.any(Knockapi::Models::User, Knockapi::Internal::AnyHash),
+          user_id: String,
+          tenant: T.nilable(String)
+        )
+          .returns(T.attached_class)
+      end
+      def self.new(
+        # The typename of the schema.
+        _typename:,
+        # Timestamp when the resource was created.
+        added_at:,
+        # A [User](/concepts/users) represents an individual in your system who can
+        # receive notifications through Knock. Users are the most common recipients of
+        # notifications and are always referenced by your internal identifier.
+        user:,
+        # The ID for the user that you set when identifying them in Knock.
+        user_id:,
+        # The unique identifier for the tenant.
+        tenant: nil
+      ); end
+      sig do
+        override
+          .returns(
+            {_typename: String, added_at: Time, user: Knockapi::Models::User, user_id: String, tenant: T.nilable(String)}
+          )
+      end
+      def to_hash; end
+    end
+  end
+end