knockapi 1.0.0 → 1.1.0

data/lib/knockapi.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 # Standard libraries.
+# rubocop:disable Lint/RedundantRequireStatement
 require "English"
 require "cgi"
 require "date"
@@ -15,6 +16,7 @@ require "set"
 require "stringio"
 require "time"
 require "uri"
+# rubocop:enable Lint/RedundantRequireStatement
 
 # We already ship the preferred sorbet manifests in the package itself.
 # `tapioca` currently does not offer us a way to opt out of unnecessary compilation.
@@ -55,10 +57,12 @@ require_relative "knockapi/models/recipients/preference_set_request"
 require_relative "knockapi/models/identify_user_request"
 require_relative "knockapi/models/activity"
 require_relative "knockapi/models/audience_add_members_params"
+require_relative "knockapi/models/audience_add_members_response"
 require_relative "knockapi/models/audience_list_members_params"
 require_relative "knockapi/models/audience_list_members_response"
 require_relative "knockapi/models/audience_member"
 require_relative "knockapi/models/audience_remove_members_params"
+require_relative "knockapi/models/audience_remove_members_response"
 require_relative "knockapi/models/bulk_operation"
 require_relative "knockapi/models/bulk_operation_get_params"
 require_relative "knockapi/models/channels/bulk_update_message_status_params"
@@ -86,7 +90,6 @@ require_relative "knockapi/models/message_mark_as_read_params"
 require_relative "knockapi/models/message_mark_as_seen_params"
 require_relative "knockapi/models/message_mark_as_unread_params"
 require_relative "knockapi/models/message_mark_as_unseen_params"
-require_relative "knockapi/models/messages/activity_list_params"
 require_relative "knockapi/models/messages/batch_archive_params"
 require_relative "knockapi/models/messages/batch_archive_response"
 require_relative "knockapi/models/messages/batch_get_content_params"
@@ -108,6 +111,7 @@ require_relative "knockapi/models/object"
 require_relative "knockapi/models/object_add_subscriptions_params"
 require_relative "knockapi/models/object_add_subscriptions_response"
 require_relative "knockapi/models/object_delete_params"
+require_relative "knockapi/models/object_delete_response"
 require_relative "knockapi/models/object_delete_subscriptions_params"
 require_relative "knockapi/models/object_delete_subscriptions_response"
 require_relative "knockapi/models/object_get_channel_data_params"
@@ -126,6 +130,7 @@ require_relative "knockapi/models/object_set_channel_data_params"
 require_relative "knockapi/models/object_set_params"
 require_relative "knockapi/models/object_set_preferences_params"
 require_relative "knockapi/models/object_unset_channel_data_params"
+require_relative "knockapi/models/object_unset_channel_data_response"
 require_relative "knockapi/models/page_info"
 require_relative "knockapi/models/providers/ms_team_check_auth_params"
 require_relative "knockapi/models/providers/ms_team_check_auth_response"
@@ -168,6 +173,7 @@ require_relative "knockapi/models/schedule_update_params"
 require_relative "knockapi/models/schedule_update_response"
 require_relative "knockapi/models/tenant"
 require_relative "knockapi/models/tenant_delete_params"
+require_relative "knockapi/models/tenant_delete_response"
 require_relative "knockapi/models/tenant_get_params"
 require_relative "knockapi/models/tenant_list_params"
 require_relative "knockapi/models/tenant_request"
@@ -176,6 +182,7 @@ require_relative "knockapi/models/tenants/bulk_set_params"
 require_relative "knockapi/models/tenant_set_params"
 require_relative "knockapi/models/user"
 require_relative "knockapi/models/user_delete_params"
+require_relative "knockapi/models/user_delete_response"
 require_relative "knockapi/models/user_get_channel_data_params"
 require_relative "knockapi/models/user_get_params"
 require_relative "knockapi/models/user_get_preferences_params"
@@ -204,10 +211,13 @@ require_relative "knockapi/models/users/guide_mark_message_as_seen_response"
 require_relative "knockapi/models/user_set_channel_data_params"
 require_relative "knockapi/models/user_set_preferences_params"
 require_relative "knockapi/models/user_unset_channel_data_params"
+require_relative "knockapi/models/user_unset_channel_data_response"
 require_relative "knockapi/models/user_update_params"
 require_relative "knockapi/models/workflow_cancel_params"
+require_relative "knockapi/models/workflow_cancel_response"
 require_relative "knockapi/models/workflow_trigger_params"
 require_relative "knockapi/models/workflow_trigger_response"
+require_relative "knockapi/models"
 require_relative "knockapi/resources/audiences"
 require_relative "knockapi/resources/bulk_operations"
 require_relative "knockapi/resources/channels"
@@ -216,7 +226,6 @@ require_relative "knockapi/resources/integrations"
 require_relative "knockapi/resources/integrations/census"
 require_relative "knockapi/resources/integrations/hightouch"
 require_relative "knockapi/resources/messages"
-require_relative "knockapi/resources/messages/activities"
 require_relative "knockapi/resources/messages/batch"
 require_relative "knockapi/resources/objects"
 require_relative "knockapi/resources/objects/bulk"

data/rbi/knockapi/client.rbi

@@ -54,7 +54,8 @@ module Knockapi
 
     # @api private
     sig { override.returns(T::Hash[String, String]) }
-    private def auth_headers; end
+    private def auth_headers
+    end
 
     # Creates and returns a new client for interacting with the API.
     sig do
@@ -65,8 +66,7 @@ module Knockapi
         timeout: Float,
         initial_retry_delay: Float,
         max_retry_delay: Float
-      )
-        .returns(T.attached_class)
+      ).returns(T.attached_class)
     end
     def self.new(
       # Defaults to `ENV["KNOCK_API_KEY"]`
@@ -79,6 +79,7 @@ module Knockapi
       timeout: Knockapi::Client::DEFAULT_TIMEOUT_IN_SECONDS,
       initial_retry_delay: Knockapi::Client::DEFAULT_INITIAL_RETRY_DELAY,
       max_retry_delay: Knockapi::Client::DEFAULT_MAX_RETRY_DELAY
-    ); end
+    )
+    end
   end
 end

data/rbi/knockapi/errors.rbi

@@ -29,10 +29,17 @@ module Knockapi
           request: NilClass,
           response: NilClass,
           message: T.nilable(String)
-        )
-          .returns(T.attached_class)
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        url:,
+        status: nil,
+        body: nil,
+        request: nil,
+        response: nil,
+        message: nil
+      )
       end
-      def self.new(url:, status: nil, body: nil, request: nil, response: nil, message: nil); end
     end
 
     class APIConnectionError < Knockapi::Errors::APIError
@@ -51,10 +58,16 @@ module Knockapi
           request: NilClass,
           response: NilClass,
           message: T.nilable(String)
-        )
-          .returns(T.attached_class)
+        ).returns(T.attached_class)
       end
-      def self.new(url:, status: nil, body: nil, request: nil, response: nil, message: "Connection error.")
+      def self.new(
+        url:,
+        status: nil,
+        body: nil,
+        request: nil,
+        response: nil,
+        message: "Connection error."
+      )
       end
     end
 
@@ -68,10 +81,16 @@ module Knockapi
           request: NilClass,
           response: NilClass,
           message: T.nilable(String)
-        )
-          .returns(T.attached_class)
+        ).returns(T.attached_class)
       end
-      def self.new(url:, status: nil, body: nil, request: nil, response: nil, message: "Request timed out.")
+      def self.new(
+        url:,
+        status: nil,
+        body: nil,
+        request: nil,
+        response: nil,
+        message: "Request timed out."
+      )
       end
     end
 
@@ -85,10 +104,10 @@ module Knockapi
           request: NilClass,
           response: NilClass,
           message: T.nilable(String)
-        )
-          .returns(T.attached_class)
+        ).returns(T.attached_class)
+      end
+      def self.for(url:, status:, body:, request:, response:, message: nil)
       end
-      def self.for(url:, status:, body:, request:, response:, message: nil); end
 
       sig { returns(Integer) }
       attr_accessor :status
@@ -102,10 +121,10 @@ module Knockapi
           request: NilClass,
           response: NilClass,
           message: T.nilable(String)
-        )
-          .returns(T.attached_class)
+        ).returns(T.attached_class)
+      end
+      def self.new(url:, status:, body:, request:, response:, message: nil)
       end
-      def self.new(url:, status:, body:, request:, response:, message: nil); end
     end
 
     class BadRequestError < Knockapi::Errors::APIStatusError
@@ -137,7 +156,7 @@ module Knockapi
     end
 
     class InternalServerError < Knockapi::Errors::APIStatusError
-      HTTP_STATUS = T.let(500.., T::Range[Integer])
+      HTTP_STATUS = T.let((500..), T::Range[Integer])
     end
   end
 end

data/rbi/knockapi/file_part.rbi

@@ -13,22 +13,25 @@ module Knockapi
 
     # @api private
     sig { returns(String) }
-    private def read; end
+    private def read
+    end
 
     sig { params(a: T.anything).returns(String) }
-    def to_json(*a); end
+    def to_json(*a)
+    end
 
     sig { params(a: T.anything).returns(String) }
-    def to_yaml(*a); end
+    def to_yaml(*a)
+    end
 
     sig do
       params(
         content: T.any(Pathname, StringIO, IO, String),
         filename: T.nilable(String),
         content_type: T.nilable(String)
-      )
-        .returns(T.attached_class)
+      ).returns(T.attached_class)
+    end
+    def self.new(content, filename: nil, content_type: nil)
     end
-    def self.new(content, filename: nil, content_type: nil); end
   end
 end

data/rbi/knockapi/internal/entries_cursor.rbi

@@ -15,9 +15,12 @@ module Knockapi
 
       # @api private
       sig { returns(String) }
-      def inspect; end
+      def inspect
+      end
 
       class PageInfo < Knockapi::Internal::Type::BaseModel
+        OrHash = T.type_alias { T.any(PageInfo, Knockapi::Internal::AnyHash) }
+
         sig { returns(T.nilable(String)) }
         attr_reader :after
 
@@ -25,10 +28,12 @@ module Knockapi
         attr_writer :after
 
         sig { params(after: String).returns(T.attached_class) }
-        def self.new(after: nil); end
+        def self.new(after: nil)
+        end
 
-        sig { override.returns({after: String}) }
-        def to_hash; end
+        sig { override.returns({ after: String }) }
+        def to_hash
+        end
       end
     end
   end

data/rbi/knockapi/internal/items_cursor.rbi

@@ -15,9 +15,12 @@ module Knockapi
 
       # @api private
       sig { returns(String) }
-      def inspect; end
+      def inspect
+      end
 
       class PageInfo < Knockapi::Internal::Type::BaseModel
+        OrHash = T.type_alias { T.any(PageInfo, Knockapi::Internal::AnyHash) }
+
         sig { returns(T.nilable(String)) }
         attr_reader :after
 
@@ -25,10 +28,12 @@ module Knockapi
         attr_writer :after
 
         sig { params(after: String).returns(T.attached_class) }
-        def self.new(after: nil); end
+        def self.new(after: nil)
+        end
 
-        sig { override.returns({after: String}) }
-        def to_hash; end
+        sig { override.returns({ after: String }) }
+        def to_hash
+        end
       end
     end
   end

data/rbi/knockapi/internal/ms_teams_pagination.rbi

@@ -15,7 +15,8 @@ module Knockapi
 
       # @api private
       sig { returns(String) }
-      def inspect; end
+      def inspect
+      end
     end
   end
 end

data/rbi/knockapi/internal/slack_channels_cursor.rbi

@@ -15,7 +15,8 @@ module Knockapi
 
       # @api private
       sig { returns(String) }
-      def inspect; end
+      def inspect
+      end
     end
   end
 end

data/rbi/knockapi/internal/transport/base_client.rbi

@@ -5,41 +5,57 @@ module Knockapi
     module Transport
       # @api private
       class BaseClient
+        extend Knockapi::Internal::Util::SorbetRuntimeSupport
+
         abstract!
 
-        RequestComponentsShape =
+        RequestComponents =
           T.type_alias do
             {
               method: Symbol,
               path: T.any(String, T::Array[String]),
-              query: T.nilable(T::Hash[String, T.nilable(T.any(T::Array[String], String))]),
-              headers: T.nilable(
-                T::Hash[String,
-                        T.nilable(
-                          T.any(
-                            String,
-                            Integer,
-                            T::Array[T.nilable(T.any(String, Integer))]
-                          )
-                        )]
-              ),
+              query:
+                T.nilable(
+                  T::Hash[String, T.nilable(T.any(T::Array[String], String))]
+                ),
+              headers:
+                T.nilable(
+                  T::Hash[
+                    String,
+                    T.nilable(
+                      T.any(
+                        String,
+                        Integer,
+                        T::Array[T.nilable(T.any(String, Integer))]
+                      )
+                    )
+                  ]
+                ),
               body: T.nilable(T.anything),
-              unwrap: T.nilable(
-                T.any(
-                  Symbol,
-                  Integer,
-                  T::Array[T.any(Symbol, Integer)],
-                  T.proc.params(arg0: T.anything).returns(T.anything)
-                )
-              ),
-              page: T.nilable(T::Class[Knockapi::Internal::Type::BasePage[Knockapi::Internal::Type::BaseModel]]),
+              unwrap:
+                T.nilable(
+                  T.any(
+                    Symbol,
+                    Integer,
+                    T::Array[T.any(Symbol, Integer)],
+                    T.proc.params(arg0: T.anything).returns(T.anything)
+                  )
+                ),
+              page:
+                T.nilable(
+                  T::Class[
+                    Knockapi::Internal::Type::BasePage[
+                      Knockapi::Internal::Type::BaseModel
+                    ]
+                  ]
+                ),
               stream: T.nilable(T::Class[T.anything]),
               model: T.nilable(Knockapi::Internal::Type::Converter::Input),
-              options: T.nilable(Knockapi::RequestOpts)
+              options: T.nilable(Knockapi::RequestOptions::OrHash)
             }
           end
 
-        RequestInputShape =
+        RequestInput =
           T.type_alias do
             {
               method: Symbol,
@@ -58,43 +74,67 @@ module Knockapi
 
         class << self
           # @api private
-          sig { params(req: Knockapi::Internal::Transport::BaseClient::RequestComponentsShape).void }
-          def validate!(req); end
+          sig do
+            params(
+              req: Knockapi::Internal::Transport::BaseClient::RequestComponents
+            ).void
+          end
+          def validate!(req)
+          end
 
           # @api private
           sig do
             params(
               status: Integer,
-              headers: T.any(
-                T::Hash[String, String],
-                Net::HTTPHeader
-              )
+              headers: T.any(T::Hash[String, String], Net::HTTPHeader)
             ).returns(T::Boolean)
           end
-          def should_retry?(status, headers:); end
+          def should_retry?(status, headers:)
+          end
 
           # @api private
           sig do
             params(
-              request: Knockapi::Internal::Transport::BaseClient::RequestInputShape,
+              request: Knockapi::Internal::Transport::BaseClient::RequestInput,
               status: Integer,
               response_headers: T.any(T::Hash[String, String], Net::HTTPHeader)
-            )
-              .returns(Knockapi::Internal::Transport::BaseClient::RequestInputShape)
+            ).returns(Knockapi::Internal::Transport::BaseClient::RequestInput)
+          end
+          def follow_redirect(request, status:, response_headers:)
           end
-          def follow_redirect(request, status:, response_headers:); end
 
           # @api private
           sig do
             params(
               status: T.any(Integer, Knockapi::Errors::APIConnectionError),
               stream: T.nilable(T::Enumerable[String])
-            )
-              .void
+            ).void
+          end
+          def reap_connection!(status, stream:)
           end
-          def reap_connection!(status, stream:); end
         end
 
+        sig { returns(URI::Generic) }
+        attr_reader :base_url
+
+        sig { returns(Float) }
+        attr_reader :timeout
+
+        sig { returns(Integer) }
+        attr_reader :max_retries
+
+        sig { returns(Float) }
+        attr_reader :initial_retry_delay
+
+        sig { returns(Float) }
+        attr_reader :max_retry_delay
+
+        sig { returns(T::Hash[String, String]) }
+        attr_reader :headers
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :idempotency_header
+
         # @api private
         sig { returns(Knockapi::Internal::Transport::PooledNetRequester) }
         attr_reader :requester
@@ -107,11 +147,19 @@ module Knockapi
             max_retries: Integer,
             initial_retry_delay: Float,
             max_retry_delay: Float,
-            headers: T::Hash[String,
-                             T.nilable(T.any(String, Integer, T::Array[T.nilable(T.any(String, Integer))]))],
+            headers:
+              T::Hash[
+                String,
+                T.nilable(
+                  T.any(
+                    String,
+                    Integer,
+                    T::Array[T.nilable(T.any(String, Integer))]
+                  )
+                )
+              ],
             idempotency_header: T.nilable(String)
-          )
-            .returns(T.attached_class)
+          ).returns(T.attached_class)
         end
         def self.new(
           base_url:,
@@ -121,41 +169,57 @@ module Knockapi
           max_retry_delay: 0.0,
           headers: {},
           idempotency_header: nil
-        ); end
+        )
+        end
+
         # @api private
         sig { overridable.returns(T::Hash[String, String]) }
-        private def auth_headers; end
+        private def auth_headers
+        end
 
         # @api private
         sig { returns(String) }
-        private def generate_idempotency_key; end
+        private def generate_idempotency_key
+        end
 
         # @api private
         sig do
           overridable
             .params(
-              req: Knockapi::Internal::Transport::BaseClient::RequestComponentsShape,
+              req: Knockapi::Internal::Transport::BaseClient::RequestComponents,
               opts: Knockapi::Internal::AnyHash
             )
-            .returns(Knockapi::Internal::Transport::BaseClient::RequestInputShape)
+            .returns(Knockapi::Internal::Transport::BaseClient::RequestInput)
+        end
+        private def build_request(req, opts)
         end
-        private def build_request(req, opts); end
 
         # @api private
-        sig { params(headers: T::Hash[String, String], retry_count: Integer).returns(Float) }
-        private def retry_delay(headers, retry_count:); end
+        sig do
+          params(
+            headers: T::Hash[String, String],
+            retry_count: Integer
+          ).returns(Float)
+        end
+        private def retry_delay(headers, retry_count:)
+        end
 
         # @api private
         sig do
           params(
-            request: Knockapi::Internal::Transport::BaseClient::RequestInputShape,
+            request: Knockapi::Internal::Transport::BaseClient::RequestInput,
             redirect_count: Integer,
             retry_count: Integer,
             send_retry_header: T::Boolean
-          )
-            .returns([Integer, Net::HTTPResponse, T::Enumerable[String]])
+          ).returns([Integer, Net::HTTPResponse, T::Enumerable[String]])
+        end
+        private def send_request(
+          request,
+          redirect_count:,
+          retry_count:,
+          send_retry_header:
+        )
         end
-        private def send_request(request, redirect_count:, retry_count:, send_retry_header:); end
 
         # Execute the request specified by `req`. This is the method that all resource
         # methods call into.
@@ -165,32 +229,45 @@ module Knockapi
           params(
             method: Symbol,
             path: T.any(String, T::Array[String]),
-            query: T.nilable(T::Hash[String, T.nilable(T.any(T::Array[String], String))]),
-            headers: T.nilable(
-              T::Hash[String,
-                      T.nilable(
-                        T.any(
-                          String,
-                          Integer,
-                          T::Array[T.nilable(T.any(String, Integer))]
-                        )
-                      )]
-            ),
+            query:
+              T.nilable(
+                T::Hash[String, T.nilable(T.any(T::Array[String], String))]
+              ),
+            headers:
+              T.nilable(
+                T::Hash[
+                  String,
+                  T.nilable(
+                    T.any(
+                      String,
+                      Integer,
+                      T::Array[T.nilable(T.any(String, Integer))]
+                    )
+                  )
+                ]
+              ),
             body: T.nilable(T.anything),
-            unwrap: T.nilable(
-              T.any(
-                Symbol,
-                Integer,
-                T::Array[T.any(Symbol, Integer)],
-                T.proc.params(arg0: T.anything).returns(T.anything)
-              )
-            ),
-            page: T.nilable(T::Class[Knockapi::Internal::Type::BasePage[Knockapi::Internal::Type::BaseModel]]),
+            unwrap:
+              T.nilable(
+                T.any(
+                  Symbol,
+                  Integer,
+                  T::Array[T.any(Symbol, Integer)],
+                  T.proc.params(arg0: T.anything).returns(T.anything)
+                )
+              ),
+            page:
+              T.nilable(
+                T::Class[
+                  Knockapi::Internal::Type::BasePage[
+                    Knockapi::Internal::Type::BaseModel
+                  ]
+                ]
+              ),
             stream: T.nilable(T::Class[T.anything]),
             model: T.nilable(Knockapi::Internal::Type::Converter::Input),
-            options: T.nilable(Knockapi::RequestOpts)
-          )
-            .returns(T.anything)
+            options: T.nilable(Knockapi::RequestOptions::OrHash)
+          ).returns(T.anything)
         end
         def request(
           method,
@@ -203,10 +280,13 @@ module Knockapi
           stream: nil,
           model: Knockapi::Internal::Type::Unknown,
           options: {}
-        ); end
+        )
+        end
+
         # @api private
         sig { returns(String) }
-        def inspect; end
+        def inspect
+        end
       end
     end
   end