knockapi 1.0.0 → 1.1.0

data/rbi/knockapi/resources/users.rbi

@@ -19,21 +19,34 @@ module Knockapi
         params(
           user_id: String,
           avatar: T.nilable(String),
-          channel_data: T.nilable(
-            T::Hash[Symbol, T.any(Knockapi::Models::Recipients::ChannelDataRequest, Knockapi::Internal::AnyHash)]
-          ),
+          channel_data:
+            T.nilable(
+              T::Hash[
+                Symbol,
+                T.any(
+                  Knockapi::Recipients::PushChannelData::OrHash,
+                  Knockapi::Recipients::OneSignalChannelData::OrHash,
+                  Knockapi::Recipients::SlackChannelData::OrHash,
+                  Knockapi::Recipients::MsTeamsChannelData::OrHash,
+                  Knockapi::Recipients::DiscordChannelData::OrHash
+                )
+              ]
+            ),
           created_at: T.nilable(Time),
           email: T.nilable(String),
           locale: T.nilable(String),
           name: T.nilable(String),
           phone_number: T.nilable(String),
-          preferences: T.nilable(
-            T::Hash[Symbol, T.any(Knockapi::Models::Recipients::PreferenceSetRequest, Knockapi::Internal::AnyHash)]
-          ),
+          preferences:
+            T.nilable(
+              T::Hash[
+                Symbol,
+                Knockapi::Recipients::PreferenceSetRequest::OrHash
+              ]
+            ),
           timezone: T.nilable(String),
-          request_options: Knockapi::RequestOpts
-        )
-          .returns(Knockapi::Models::User)
+          request_options: Knockapi::RequestOptions::OrHash
+        ).returns(Knockapi::User)
       end
       def update(
         # The ID for the user that you set when identifying them in Knock.
@@ -50,29 +63,30 @@ module Knockapi
         locale: nil,
         # Display name of the user.
         name: nil,
-        # The [E.164](https://www.twilio.com/docs/glossary/what-e164) phone number of the
+        # The [E.164](https://www.twilio.com/docs/glossary/what-e164) phone number of the
         # user (required for SMS channels).
         phone_number: nil,
         # Inline set preferences for a recipient, where the key is the preference set id.
         preferences: nil,
-        # The timezone of the user. Must be a valid
-        # [tz database time zone string](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).
-        # Used for
-        # [recurring schedules](/concepts/schedules#scheduling-workflows-with-recurring-schedules-for-recipients).
+        # The timezone of the user. Must be a
+        # valid [tz database time zone string](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).
+        # Used
+        # for [recurring schedules](/concepts/schedules#scheduling-workflows-with-recurring-schedules-for-recipients).
         timezone: nil,
         request_options: {}
-      ); end
+      )
+      end
+
       # Retrieve a paginated list of users in the environment. Defaults to 50 users per
       # page.
       sig do
         params(
           after: String,
           before: String,
-          include: T::Array[Knockapi::Models::UserListParams::Include::OrSymbol],
+          include: T::Array[Knockapi::UserListParams::Include::OrSymbol],
           page_size: Integer,
-          request_options: Knockapi::RequestOpts
-        )
-          .returns(Knockapi::Internal::EntriesCursor[Knockapi::Models::User])
+          request_options: Knockapi::RequestOptions::OrHash
+        ).returns(Knockapi::Internal::EntriesCursor[Knockapi::User])
       end
       def list(
         # The cursor to fetch entries after.
@@ -84,25 +98,44 @@ module Knockapi
         # The number of items per page.
         page_size: nil,
         request_options: {}
-      ); end
+      )
+      end
+
       # Permanently delete a user and all associated data.
-      sig { params(user_id: String, request_options: Knockapi::RequestOpts).returns(String) }
+      sig do
+        params(
+          user_id: String,
+          request_options: Knockapi::RequestOptions::OrHash
+        ).returns(String)
+      end
       def delete(
         # The ID of the user to delete.
         user_id,
         request_options: {}
-      ); end
+      )
+      end
+
       # Retrieve a specific user by their ID.
-      sig { params(user_id: String, request_options: Knockapi::RequestOpts).returns(Knockapi::Models::User) }
+      sig do
+        params(
+          user_id: String,
+          request_options: Knockapi::RequestOptions::OrHash
+        ).returns(Knockapi::User)
+      end
       def get(
         # The ID of the user to retrieve.
         user_id,
         request_options: {}
-      ); end
+      )
+      end
+
       # Retrieves the channel data for a specific user and channel ID.
       sig do
-        params(user_id: String, channel_id: String, request_options: Knockapi::RequestOpts)
-          .returns(Knockapi::Models::Recipients::RecipientsChannelData)
+        params(
+          user_id: String,
+          channel_id: String,
+          request_options: Knockapi::RequestOptions::OrHash
+        ).returns(Knockapi::Recipients::RecipientsChannelData)
       end
       def get_channel_data(
         # The ID for the user that you set when identifying them in Knock.
@@ -110,12 +143,18 @@ module Knockapi
         # The unique identifier for the channel.
         channel_id,
         request_options: {}
-      ); end
+      )
+      end
+
       # Retrieves a specific preference set for a user identified by the preference set
       # ID.
       sig do
-        params(user_id: String, id: String, tenant: String, request_options: Knockapi::RequestOpts)
-          .returns(Knockapi::Models::Recipients::PreferenceSet)
+        params(
+          user_id: String,
+          id: String,
+          tenant: String,
+          request_options: Knockapi::RequestOptions::OrHash
+        ).returns(Knockapi::Recipients::PreferenceSet)
       end
       def get_preferences(
         # The ID for the user that you set when identifying them in Knock.
@@ -125,7 +164,9 @@ module Knockapi
         # The unique identifier for the tenant.
         tenant: nil,
         request_options: {}
-      ); end
+      )
+      end
+
       # Returns a paginated list of messages for a specific user. Allows filtering by
       # message status and provides various sorting options. Messages outside the
       # account's retention window will not be included in the results.
@@ -135,20 +176,22 @@ module Knockapi
           after: String,
           before: String,
           channel_id: String,
-          engagement_status: T::Array[Knockapi::Models::UserListMessagesParams::EngagementStatus::OrSymbol],
-          inserted_at: T.any(Knockapi::Models::UserListMessagesParams::InsertedAt, Knockapi::Internal::AnyHash),
+          engagement_status:
+            T::Array[
+              Knockapi::UserListMessagesParams::EngagementStatus::OrSymbol
+            ],
+          inserted_at: Knockapi::UserListMessagesParams::InsertedAt::OrHash,
           message_ids: T::Array[String],
           page_size: Integer,
           source: String,
-          status: T::Array[Knockapi::Models::UserListMessagesParams::Status::OrSymbol],
+          status: T::Array[Knockapi::UserListMessagesParams::Status::OrSymbol],
           tenant: String,
           trigger_data: String,
           workflow_categories: T::Array[String],
           workflow_recipient_run_id: String,
           workflow_run_id: String,
-          request_options: Knockapi::RequestOpts
-        )
-          .returns(Knockapi::Internal::EntriesCursor[Knockapi::Models::Message])
+          request_options: Knockapi::RequestOptions::OrHash
+        ).returns(Knockapi::Internal::EntriesCursor[Knockapi::Message])
       end
       def list_messages(
         # The user ID to list messages for.
@@ -185,17 +228,23 @@ module Knockapi
         # returned by the workflow trigger request.
         workflow_run_id: nil,
         request_options: {}
-      ); end
+      )
+      end
+
       # Retrieves a list of all preference sets for a specific user.
       sig do
-        params(user_id: String, request_options: Knockapi::RequestOpts)
-          .returns(T::Array[Knockapi::Models::Recipients::PreferenceSet])
+        params(
+          user_id: String,
+          request_options: Knockapi::RequestOptions::OrHash
+        ).returns(T::Array[Knockapi::Recipients::PreferenceSet])
       end
       def list_preferences(
         # The ID for the user that you set when identifying them in Knock.
         user_id,
         request_options: {}
-      ); end
+      )
+      end
+
       # Returns a paginated list of schedules for a specific user, in descending order.
       sig do
         params(
@@ -205,9 +254,8 @@ module Knockapi
           page_size: Integer,
           tenant: String,
           workflow: String,
-          request_options: Knockapi::RequestOpts
-        )
-          .returns(Knockapi::Internal::EntriesCursor[Knockapi::Models::Schedule])
+          request_options: Knockapi::RequestOptions::OrHash
+        ).returns(Knockapi::Internal::EntriesCursor[Knockapi::Schedule])
       end
       def list_schedules(
         # The user ID to list schedules for.
@@ -223,7 +271,9 @@ module Knockapi
         # The workflow key to filter schedules for.
         workflow: nil,
         request_options: {}
-      ); end
+      )
+      end
+
       # Retrieves a paginated list of subscriptions for a specific user, in descending
       # order.
       sig do
@@ -231,12 +281,14 @@ module Knockapi
           user_id: String,
           after: String,
           before: String,
-          include: T::Array[Knockapi::Models::UserListSubscriptionsParams::Include::OrSymbol],
+          include:
+            T::Array[Knockapi::UserListSubscriptionsParams::Include::OrSymbol],
           objects: T::Array[String],
           page_size: Integer,
-          request_options: Knockapi::RequestOpts
+          request_options: Knockapi::RequestOptions::OrHash
+        ).returns(
+          Knockapi::Internal::EntriesCursor[Knockapi::Recipients::Subscription]
         )
-          .returns(Knockapi::Internal::EntriesCursor[Knockapi::Models::Recipients::Subscription])
       end
       def list_subscriptions(
         # The user ID to list subscriptions for.
@@ -252,12 +304,17 @@ module Knockapi
         # The number of items per page.
         page_size: nil,
         request_options: {}
-      ); end
+      )
+      end
+
       # Merge two users together, where the user specified with the `from_user_id` param
       # will be merged into the user specified by `user_id`.
       sig do
-        params(user_id: String, from_user_id: String, request_options: Knockapi::RequestOpts)
-          .returns(Knockapi::Models::User)
+        params(
+          user_id: String,
+          from_user_id: String,
+          request_options: Knockapi::RequestOptions::OrHash
+        ).returns(Knockapi::User)
       end
       def merge(
         # The id of the user to merge into.
@@ -265,23 +322,24 @@ module Knockapi
         # The user ID to merge from.
         from_user_id:,
         request_options: {}
-      ); end
+      )
+      end
+
       # Updates or creates channel data for a specific user and channel ID.
       sig do
         params(
           user_id: String,
           channel_id: String,
-          data: T.any(
-            Knockapi::Models::Recipients::PushChannelData,
-            Knockapi::Internal::AnyHash,
-            Knockapi::Models::Recipients::OneSignalChannelData,
-            Knockapi::Models::Recipients::SlackChannelData,
-            Knockapi::Models::Recipients::MsTeamsChannelData,
-            Knockapi::Models::Recipients::DiscordChannelData
-          ),
-          request_options: Knockapi::RequestOpts
-        )
-          .returns(Knockapi::Models::Recipients::RecipientsChannelData)
+          data:
+            T.any(
+              Knockapi::Recipients::PushChannelData::OrHash,
+              Knockapi::Recipients::OneSignalChannelData::OrHash,
+              Knockapi::Recipients::SlackChannelData::OrHash,
+              Knockapi::Recipients::MsTeamsChannelData::OrHash,
+              Knockapi::Recipients::DiscordChannelData::OrHash
+            ),
+          request_options: Knockapi::RequestOptions::OrHash
+        ).returns(Knockapi::Recipients::RecipientsChannelData)
       end
       def set_channel_data(
         # The ID for the user that you set when identifying them in Knock.
@@ -291,37 +349,39 @@ module Knockapi
         # Channel data for a given channel type.
         data:,
         request_options: {}
-      ); end
+      )
+      end
+
       # Updates a complete preference set for a user. This is a destructive operation
       # that will replace the existing preference set for the user.
       sig do
         params(
           user_id: String,
           id: String,
-          categories: T.nilable(
-            T::Hash[
-              Symbol,
-              T.any(
-                T::Boolean,
-                Knockapi::Models::Recipients::PreferenceSetRequest::Category::PreferenceSetWorkflowCategorySettingObject,
-                Knockapi::Internal::AnyHash
-              )
-            ]
-          ),
-          channel_types: T.nilable(T.any(Knockapi::Models::Recipients::PreferenceSetChannelTypes, Knockapi::Internal::AnyHash)),
-          workflows: T.nilable(
-            T::Hash[
-              Symbol,
-              T.any(
-                T::Boolean,
-                Knockapi::Models::Recipients::PreferenceSetRequest::Workflow::PreferenceSetWorkflowCategorySettingObject,
-                Knockapi::Internal::AnyHash
-              )
-            ]
-          ),
-          request_options: Knockapi::RequestOpts
-        )
-          .returns(Knockapi::Models::Recipients::PreferenceSet)
+          categories:
+            T.nilable(
+              T::Hash[
+                Symbol,
+                T.any(
+                  T::Boolean,
+                  Knockapi::Recipients::PreferenceSetRequest::Category::PreferenceSetWorkflowCategorySettingObject::OrHash
+                )
+              ]
+            ),
+          channel_types:
+            T.nilable(Knockapi::Recipients::PreferenceSetChannelTypes::OrHash),
+          workflows:
+            T.nilable(
+              T::Hash[
+                Symbol,
+                T.any(
+                  T::Boolean,
+                  Knockapi::Recipients::PreferenceSetRequest::Workflow::PreferenceSetWorkflowCategorySettingObject::OrHash
+                )
+              ]
+            ),
+          request_options: Knockapi::RequestOptions::OrHash
+        ).returns(Knockapi::Recipients::PreferenceSet)
       end
       def set_preferences(
         # The ID for the user that you set when identifying them in Knock.
@@ -337,10 +397,16 @@ module Knockapi
         # settings for that workflow.
         workflows: nil,
         request_options: {}
-      ); end
+      )
+      end
+
       # Deletes channel data for a specific user and channel ID.
       sig do
-        params(user_id: String, channel_id: String, request_options: Knockapi::RequestOpts).returns(String)
+        params(
+          user_id: String,
+          channel_id: String,
+          request_options: Knockapi::RequestOptions::OrHash
+        ).returns(String)
       end
       def unset_channel_data(
         # The ID for the user that you set when identifying them in Knock.
@@ -348,10 +414,13 @@ module Knockapi
         # The unique identifier for the channel.
         channel_id,
         request_options: {}
-      ); end
+      )
+      end
+
       # @api private
       sig { params(client: Knockapi::Client).returns(T.attached_class) }
-      def self.new(client:); end
+      def self.new(client:)
+      end
     end
   end
 end

data/rbi/knockapi/resources/workflows.rbi

@@ -10,12 +10,17 @@ module Knockapi
         params(
           key: String,
           cancellation_key: String,
-          recipients: T.nilable(
-            T::Array[T.any(String, Knockapi::Models::RecipientReference::ObjectReference, Knockapi::Internal::AnyHash)]
-          ),
-          request_options: Knockapi::RequestOpts
-        )
-          .returns(String)
+          recipients:
+            T.nilable(
+              T::Array[
+                T.any(
+                  String,
+                  Knockapi::RecipientReference::ObjectReference::OrHash
+                )
+              ]
+            ),
+          request_options: Knockapi::RequestOptions::OrHash
+        ).returns(String)
       end
       def cancel(
         # The key of the workflow to cancel.
@@ -30,7 +35,9 @@ module Knockapi
         # recipients associated with the cancellation key.
         recipients: nil,
         request_options: {}
-      ); end
+      )
+      end
+
       # Trigger a workflow (specified by the key) to run for the given recipients, using
       # the parameters provided. Returns an identifier for the workflow run request. All
       # workflow runs are executed asynchronously. This endpoint also handles
@@ -39,28 +46,27 @@ module Knockapi
       sig do
         params(
           key: String,
-          recipients: T::Array[
-            T.any(
-              String,
-              Knockapi::Models::InlineIdentifyUserRequest,
-              Knockapi::Internal::AnyHash,
-              Knockapi::Models::InlineObjectRequest
-            )
-          ],
-          actor: T.nilable(
-            T.any(
-              String,
-              Knockapi::Models::InlineIdentifyUserRequest,
-              Knockapi::Internal::AnyHash,
-              Knockapi::Models::InlineObjectRequest
-            )
-          ),
+          recipients:
+            T::Array[
+              T.any(
+                String,
+                Knockapi::InlineIdentifyUserRequest::OrHash,
+                Knockapi::InlineObjectRequest::OrHash
+              )
+            ],
+          actor:
+            T.nilable(
+              T.any(
+                String,
+                Knockapi::InlineIdentifyUserRequest::OrHash,
+                Knockapi::InlineObjectRequest::OrHash
+              )
+            ),
           cancellation_key: T.nilable(String),
           data: T.nilable(T::Hash[Symbol, T.anything]),
-          tenant: T.nilable(T.any(String, Knockapi::Models::TenantRequest, Knockapi::Internal::AnyHash)),
-          request_options: Knockapi::RequestOpts
-        )
-          .returns(Knockapi::Models::WorkflowTriggerResponse)
+          tenant: T.nilable(T.any(String, Knockapi::TenantRequest::OrHash)),
+          request_options: Knockapi::RequestOptions::OrHash
+        ).returns(Knockapi::Models::WorkflowTriggerResponse)
       end
       def trigger(
         # Key of the workflow to trigger.
@@ -83,10 +89,13 @@ module Knockapi
         # An request to set a tenant inline.
         tenant: nil,
         request_options: {}
-      ); end
+      )
+      end
+
       # @api private
       sig { params(client: Knockapi::Client).returns(T.attached_class) }
-      def self.new(client:); end
+      def self.new(client:)
+      end
     end
   end
 end

data/sig/knockapi/internal/entries_cursor.rbs

@@ -16,8 +16,6 @@ module Knockapi
         def after=: (String) -> String
 
         def initialize: (?after: String) -> void
-
-        def to_hash: -> page_info
       end
     end
   end

data/sig/knockapi/internal/items_cursor.rbs

@@ -16,8 +16,6 @@ module Knockapi
         def after=: (String) -> String
 
         def initialize: (?after: String) -> void
-
-        def to_hash: -> page_info
       end
     end
   end

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

@@ -2,6 +2,8 @@ module Knockapi
   module Internal
     module Transport
       class BaseClient
+        extend Knockapi::Internal::Util::SorbetRuntimeSupport
+
         type request_components =
           {
             method: Symbol,
@@ -20,7 +22,6 @@ module Knockapi
             model: Knockapi::Internal::Type::Converter::input?,
             options: Knockapi::request_opts?
           }
-
         type request_input =
           {
             method: Symbol,
@@ -55,6 +56,20 @@ module Knockapi
           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
 

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

@@ -2,6 +2,8 @@ module Knockapi
   module Internal
     module Transport
       class PooledNetRequester
+        extend Knockapi::Internal::Util::SorbetRuntimeSupport
+
         type request =
           {
             method: Symbol,
@@ -13,6 +15,8 @@ module Knockapi
 
         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

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

@@ -3,10 +3,13 @@ module Knockapi
     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) })]
 
@@ -65,23 +68,26 @@ module Knockapi
           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 deconstruct_keys: (::Array[Symbol]? keys) -> ::Hash[Symbol, top]
+        def deep_to_h: -> ::Hash[Symbol, top]
 
-        def self.walk: (
-          Knockapi::Internal::Type::BaseModel model
-        ) -> ::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] | self data) -> void
+        def initialize: (?::Hash[Symbol, top] | instance data) -> void
 
         def self.inspect: (?depth: Integer) -> String
 

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

@@ -4,7 +4,7 @@ module Knockapi
       module BasePage[Elem]
         def next_page?: -> bool
 
-        def next_page: -> self
+        def next_page: -> instance
 
         def auto_paging_each: { (Elem arg0) -> void } -> void
 

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

@@ -2,6 +2,8 @@ module Knockapi
   module Internal
     module Type
       module Converter
+        extend Knockapi::Internal::Util::SorbetRuntimeSupport
+
         type input = Knockapi::Internal::Type::Converter | Class
 
         type coerce_state =

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

@@ -3,6 +3,7 @@ module Knockapi
     module Type
       module Enum
         include Knockapi::Internal::Type::Converter
+        include Knockapi::Internal::Util::SorbetRuntimeSupport
 
         def self.values: -> ::Array[(nil | bool | Integer | Float | Symbol)]
 

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

@@ -4,7 +4,9 @@ module Knockapi
       type request_parameters = { request_options: Knockapi::request_opts }
 
       module RequestParameters
-        attr_accessor request_options: Knockapi::request_opts
+        attr_reader request_options: Knockapi::request_opts
+
+        def request_options=: (Knockapi::request_opts) -> Knockapi::request_opts
 
         module Converter
           def dump_request: (top params) -> [top, ::Hash[Symbol, top]]