knockapi 1.1.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c57d893d557fe8c19367b85213334576858a8024857ea969f05f0dd2368d9b8c
-  data.tar.gz: 3becb6c5c1d4cd3abd4a48a5abb818b035e1771651afd4172641bf228b336a83
+  metadata.gz: 05e2af454cc4e2dc3f721acdafcfe91ff2aafaac9a6cdcaeff7a6d0fb3554ded
+  data.tar.gz: 51f60b06a643f43661372498e05cf0eb236f9b05f290816ecf8c2d36450c84cd
 SHA512:
-  metadata.gz: 3241238cd0cc508b9c967d0f035b036483d1a1e774d84409adc91632b1629927079074c5692a8ef231dfe0bbdb68e227687da1e7f0d96124545a04f269388c4a
-  data.tar.gz: 89c50a639748a21f1733a174bc65017286875121414669dca2074d98d457796e7e96eddd5241a6b43c6efe2e8d31eecb73adfb0251ac836b8f90c0e0bdba038d
+  metadata.gz: 4664831a9ed4bb37eff4922c9bc1d75d08db467e03e1e70f97b7584ca20f5fd534a90a05c29dca71413c8cf9d782e954b4b6cddab94fba14f68f42820173dc25
+  data.tar.gz: d9353f602163c8883a97a072755294bde85439126a986dc1c8148daca0f7e92965836e146fe4df9591205284b86b1abf04c1166a97461ecc52887d030c7c7696

data/CHANGELOG.md

@@ -1,5 +1,47 @@
 # Changelog
 
+## 1.3.0 (2025-05-28)
+
+Full Changelog: [v1.2.0...v1.3.0](https://github.com/knocklabs/knock-ruby/compare/v1.2.0...v1.3.0)
+
+### Features
+
+* **api:** api update ([c47c0e6](https://github.com/knocklabs/knock-ruby/commit/c47c0e68992f447af50889cd4435d136e5fa2904))
+* **api:** api update ([346b571](https://github.com/knocklabs/knock-ruby/commit/346b571779ade48f5954f018ab3f7d8f8dbdbdd9))
+
+
+### Bug Fixes
+
+* prevent rubocop from mangling `===` to `is_a?` check ([9ddd5e9](https://github.com/knocklabs/knock-ruby/commit/9ddd5e93e0ffb56f07a5216f64ff7a4eaab43468))
+* sorbet types for enums, and make tapioca detection ignore `tapioca dsl` ([83ce737](https://github.com/knocklabs/knock-ruby/commit/83ce737225a0be39758aa1affcef2352a7e02502))
+
+
+### Chores
+
+* **docs:** grammar improvements ([3913113](https://github.com/knocklabs/knock-ruby/commit/3913113994e8e2e203fe2ab60a6e5fd817a130c5))
+* force utf-8 locale via `RUBYOPT` when formatting ([ec69c77](https://github.com/knocklabs/knock-ruby/commit/ec69c77c94ba059d577798a05098847bb304b36b))
+* use fully qualified names for yard annotations and rbs aliases ([ef4ddca](https://github.com/knocklabs/knock-ruby/commit/ef4ddca29f6bfa5d707415ee12e18a08738a3293))
+
+## 1.2.0 (2025-05-21)
+
+Full Changelog: [v1.1.0...v1.2.0](https://github.com/knocklabs/knock-ruby/compare/v1.1.0...v1.2.0)
+
+### Features
+
+* **api:** api update ([a2f7806](https://github.com/knocklabs/knock-ruby/commit/a2f7806c82832774d11f588232b5e8f86d126800))
+
+
+### Bug Fixes
+
+* correctly instantiate sorbet type aliases for enums and unions ([cb2a162](https://github.com/knocklabs/knock-ruby/commit/cb2a1627efa4a45d8cdee2844f963797fdfd9e59))
+
+
+### Chores
+
+* refine Yard and Sorbet types and ensure linting is turned on for examples ([4f2f24f](https://github.com/knocklabs/knock-ruby/commit/4f2f24fa37eaef8744a3bce3d02918d2e2929a69))
+* use sorbet union aliases where available ([80047be](https://github.com/knocklabs/knock-ruby/commit/80047be1c2fe8a496da2adf2ed99c2e0b146706d))
+* whitespaces ([6205cfa](https://github.com/knocklabs/knock-ruby/commit/6205cfa7ed48346b98f38131439e8f5e598853b1))
+
 ## 1.1.0 (2025-05-15)
 
 Full Changelog: [v1.0.0...v1.1.0](https://github.com/knocklabs/knock-ruby/compare/v1.0.0...v1.1.0)

data/README.md

@@ -17,7 +17,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "knockapi", "~> 1.1.0"
+gem "knockapi", "~> 1.3.0"
 ```
 
 <!-- x-release-please-end -->
@@ -173,7 +173,7 @@ puts(user[:my_undocumented_property])
 
 #### Undocumented request params
 
-If you want to explicitly send an extra param, you can do so with the `extra_query`, `extra_body`, and `extra_headers` under the `request_options:` parameter when making a request as seen in examples above.
+If you want to explicitly send an extra param, you can do so with the `extra_query`, `extra_body`, and `extra_headers` under the `request_options:` parameter when making a request, as seen in the examples above.
 
 #### Undocumented endpoints
 
@@ -191,7 +191,7 @@ response = client.request(
 
 ### Concurrency & connection pooling
 
-The `Knockapi::Client` instances are threadsafe, but only are fork-safe when there are no in-flight HTTP requests.
+The `Knockapi::Client` instances are threadsafe, but are only are fork-safe when there are no in-flight HTTP requests.
 
 Each instance of `Knockapi::Client` has its own HTTP connection pool with a default size of 99. As such, we recommend instantiating the client once per application in most settings.
 
@@ -241,7 +241,7 @@ knock.users.feeds.list_items(
   # …
 )
 
-# Literal values is also permissible:
+# Literal values are also permissible:
 knock.users.feeds.list_items(
   archived: :exclude,
   # …

data/SECURITY.md

@@ -16,11 +16,11 @@ before making any information public.
 ## Reporting Non-SDK Related Security Issues
 
 If you encounter security issues that are not directly related to SDKs but pertain to the services
-or products provided by Knock please follow the respective company's security reporting guidelines.
+or products provided by Knock, please follow the respective company's security reporting guidelines.
 
 ### Knock Terms and Policies
 
-Please contact security@knock.app for any questions or concerns regarding security of our services.
+Please contact security@knock.app for any questions or concerns regarding the security of our services.
 
 ---
 

data/lib/knockapi/internal/items_cursor.rb

@@ -10,8 +10,8 @@ module Knockapi
     #   end
     #
     # @example
-    #   items_cursor.auto_paging_each do |message|
-    #     puts(message)
+    #   items_cursor.auto_paging_each do |user|
+    #     puts(user)
     #   end
     class ItemsCursor
       include Knockapi::Internal::Type::BasePage

data/lib/knockapi/internal/type/array_of.rb

@@ -12,6 +12,7 @@ module Knockapi
       # Array of items of a given type.
       class ArrayOf
         include Knockapi::Internal::Type::Converter
+        include Knockapi::Internal::Util::SorbetRuntimeSupport
 
         private_class_method :new
 
@@ -110,6 +111,13 @@ module Knockapi
           end
         end
 
+        # @api private
+        #
+        # @return [Object]
+        def to_sorbet_type
+          T::Array[Knockapi::Internal::Util::SorbetRuntimeSupport.to_sorbet_type(item_type)]
+        end
+
         # @api private
         #
         # @return [generic<Elem>]

data/lib/knockapi/internal/type/base_model.rb

@@ -311,6 +311,13 @@ module Knockapi
 
             acc
           end
+
+          # @api private
+          #
+          # @return [Object]
+          def to_sorbet_type
+            self
+          end
         end
 
         class << self

data/lib/knockapi/internal/type/boolean.rb

@@ -10,6 +10,7 @@ module Knockapi
       # Ruby has no Boolean class; this is something for models to refer to.
       class Boolean
         extend Knockapi::Internal::Type::Converter
+        extend Knockapi::Internal::Util::SorbetRuntimeSupport
 
         private_class_method :new
 
@@ -56,6 +57,13 @@ module Knockapi
           #     @option state [Boolean] :can_retry
           #
           #   @return [Boolean, Object]
+
+          # @api private
+          #
+          # @return [Object]
+          def to_sorbet_type
+            T::Boolean
+          end
         end
       end
     end

data/lib/knockapi/internal/type/enum.rb

@@ -87,6 +87,18 @@ module Knockapi
         #
         #   @return [Symbol, Object]
 
+        # @api private
+        #
+        # @return [Object]
+        def to_sorbet_type
+          case values
+          in []
+            T.noreturn
+          in [value, *_]
+            T.all(Knockapi::Internal::Util::SorbetRuntimeSupport.to_sorbet_type(value), self)
+          end
+        end
+
         # @api private
         #
         # @param depth [Integer]

data/lib/knockapi/internal/type/file_input.rb

@@ -89,6 +89,13 @@ module Knockapi
 
             value
           end
+
+          # @api private
+          #
+          # @return [Object]
+          def to_sorbet_type
+            T.any(Pathname, StringIO, IO, String, Knockapi::FilePart)
+          end
         end
       end
     end

data/lib/knockapi/internal/type/hash_of.rb

@@ -12,6 +12,7 @@ module Knockapi
       # Hash of items of a given type.
       class HashOf
         include Knockapi::Internal::Type::Converter
+        include Knockapi::Internal::Util::SorbetRuntimeSupport
 
         private_class_method :new
 
@@ -130,6 +131,13 @@ module Knockapi
           end
         end
 
+        # @api private
+        #
+        # @return [Object]
+        def to_sorbet_type
+          T::Hash[Knockapi::Internal::Util::SorbetRuntimeSupport.to_sorbet_type(item_type)]
+        end
+
         # @api private
         #
         # @return [generic<Elem>]

data/lib/knockapi/internal/type/union.rb

@@ -202,6 +202,18 @@ module Knockapi
           super
         end
 
+        # @api private
+        #
+        # @return [Object]
+        def to_sorbet_type
+          case (v = variants)
+          in []
+            T.noreturn
+          else
+            T.any(*v.map { Knockapi::Internal::Util::SorbetRuntimeSupport.to_sorbet_type(_1) })
+          end
+        end
+
         # rubocop:enable Style/CaseEquality
         # rubocop:enable Style/HashEachMethods
 

data/lib/knockapi/internal/type/unknown.rb

@@ -10,6 +10,7 @@ module Knockapi
       # When we don't know what to expect for the value.
       class Unknown
         extend Knockapi::Internal::Type::Converter
+        extend Knockapi::Internal::Util::SorbetRuntimeSupport
 
         # rubocop:disable Lint/UnusedMethodArgument
 
@@ -58,6 +59,13 @@ module Knockapi
           #     @option state [Boolean] :can_retry
           #
           #   @return [Object]
+
+          # @api private
+          #
+          # @return [Object]
+          def to_sorbet_type
+            T.anything
+          end
         end
 
         # rubocop:enable Lint/UnusedMethodArgument

data/lib/knockapi/internal/util.rb

@@ -9,6 +9,23 @@ module Knockapi
       # @return [Float]
       def self.monotonic_secs = Process.clock_gettime(Process::CLOCK_MONOTONIC)
 
+      # @api private
+      #
+      # @param ns [Module, Class]
+      #
+      # @return [Enumerable<Module, Class>]
+      def self.walk_namespaces(ns)
+        ns.constants(false).lazy.flat_map do
+          case (c = ns.const_get(_1, false))
+          in Module | Class
+            walk_namespaces(c)
+          else
+            []
+          end
+        end
+          .chain([ns])
+      end
+
       class << self
         # @api private
         #
@@ -583,11 +600,13 @@ module Knockapi
         #
         # @return [Object]
         def encode_content(headers, body)
+          # rubocop:disable Style/CaseEquality
+          # rubocop:disable Layout/LineLength
           content_type = headers["content-type"]
           case [content_type, body]
           in [Knockapi::Internal::Util::JSON_CONTENT, Hash | Array | -> { primitive?(_1) }]
             [headers, JSON.generate(body)]
-          in [Knockapi::Internal::Util::JSONL_CONTENT, Enumerable] unless body.is_a?(Knockapi::Internal::Type::FileInput)
+          in [Knockapi::Internal::Util::JSONL_CONTENT, Enumerable] unless Knockapi::Internal::Type::FileInput === body
             [headers, body.lazy.map { JSON.generate(_1) }]
           in [%r{^multipart/form-data}, Hash | Knockapi::Internal::Type::FileInput]
             boundary, strio = encode_multipart_streaming(body)
@@ -602,6 +621,8 @@ module Knockapi
           else
             [headers, body]
           end
+          # rubocop:enable Layout/LineLength
+          # rubocop:enable Style/CaseEquality
         end
 
         # @api private
@@ -826,11 +847,43 @@ module Knockapi
           sorbet_runtime_constants.fetch(name).call
         end
 
+        # @api private
+        #
+        # @param name [Symbol]
+        #
+        # @return [Boolean]
+        def sorbet_constant_defined?(name) = sorbet_runtime_constants.key?(name)
+
         # @api private
         #
         # @param name [Symbol]
         # @param blk [Proc]
         def define_sorbet_constant!(name, &blk) = sorbet_runtime_constants.store(name, blk)
+
+        # @api private
+        #
+        # @return [Object]
+        def to_sorbet_type = raise NotImplementedError
+
+        class << self
+          # @api private
+          #
+          # @param type [Knockapi::Internal::Util::SorbetRuntimeSupport, Object]
+          #
+          # @return [Object]
+          def to_sorbet_type(type)
+            case type
+            in Knockapi::Internal::Util::SorbetRuntimeSupport
+              type.to_sorbet_type
+            in Class | Module
+              type
+            in true | false
+              T::Boolean
+            else
+              type.class
+            end
+          end
+        end
       end
 
       extend Knockapi::Internal::Util::SorbetRuntimeSupport

data/lib/knockapi/internal.rb

@@ -13,5 +13,8 @@ module Knockapi
     define_sorbet_constant!(:AnyHash) do
       T.type_alias { T::Hash[Symbol, T.anything] }
     end
+    define_sorbet_constant!(:FileInput) do
+      T.type_alias { T.any(Pathname, StringIO, IO, String, Knockapi::FilePart) }
+    end
   end
 end

data/lib/knockapi/models/activity.rb

@@ -19,7 +19,7 @@ module Knockapi
       # @!attribute actor
       #   A recipient of a notification, which is either a user or an object.
       #
-      #   @return [Knockapi::User, Knockapi::Object, nil]
+      #   @return [Knockapi::Models::User, Knockapi::Models::Object, nil]
       optional :actor, union: -> { Knockapi::Recipient }, nil?: true
 
       # @!attribute data
@@ -37,7 +37,7 @@ module Knockapi
       # @!attribute recipient
       #   A recipient of a notification, which is either a user or an object.
       #
-      #   @return [Knockapi::User, Knockapi::Object, nil]
+      #   @return [Knockapi::Models::User, Knockapi::Models::Object, nil]
       optional :recipient, union: -> { Knockapi::Recipient }
 
       # @!attribute updated_at
@@ -56,13 +56,13 @@ module Knockapi
       #
       #   @param _typename [String] The typename of the schema.
       #
-      #   @param actor [Knockapi::User, Knockapi::Object, nil] A recipient of a notification, which is either a user or an object.
+      #   @param actor [Knockapi::Models::User, Knockapi::Models::Object, nil] A recipient of a notification, which is either a user or an object.
       #
       #   @param data [Hash{Symbol=>Object}, nil] The workflow trigger `data` payload associated with the activity.
       #
       #   @param inserted_at [Time] Timestamp when the activity was created.
       #
-      #   @param recipient [Knockapi::User, Knockapi::Object] A recipient of a notification, which is either a user or an object.
+      #   @param recipient [Knockapi::Models::User, Knockapi::Models::Object] A recipient of a notification, which is either a user or an object.
       #
       #   @param updated_at [Time] Timestamp when the activity was last updated.
     end

data/lib/knockapi/models/audience_add_members_params.rb

@@ -10,11 +10,11 @@ module Knockapi
       # @!attribute members
       #   A list of audience members to add.
       #
-      #   @return [Array<Knockapi::AudienceAddMembersParams::Member>]
+      #   @return [Array<Knockapi::Models::AudienceAddMembersParams::Member>]
       required :members, -> { Knockapi::Internal::Type::ArrayOf[Knockapi::AudienceAddMembersParams::Member] }
 
       # @!method initialize(members:, request_options: {})
-      #   @param members [Array<Knockapi::AudienceAddMembersParams::Member>] A list of audience members to add.
+      #   @param members [Array<Knockapi::Models::AudienceAddMembersParams::Member>] A list of audience members to add.
       #
       #   @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
 
@@ -22,7 +22,7 @@ module Knockapi
         # @!attribute user
         #   An object containing the user's ID.
         #
-        #   @return [Knockapi::AudienceAddMembersParams::Member::User]
+        #   @return [Knockapi::Models::AudienceAddMembersParams::Member::User]
         required :user, -> { Knockapi::AudienceAddMembersParams::Member::User }
 
         # @!attribute tenant
@@ -34,11 +34,11 @@ module Knockapi
         # @!method initialize(user:, tenant: nil)
         #   An audience member.
         #
-        #   @param user [Knockapi::AudienceAddMembersParams::Member::User] An object containing the user's ID.
+        #   @param user [Knockapi::Models::AudienceAddMembersParams::Member::User] An object containing the user's ID.
         #
         #   @param tenant [String, nil] The unique identifier for the tenant.
 
-        # @see Knockapi::AudienceAddMembersParams::Member#user
+        # @see Knockapi::Models::AudienceAddMembersParams::Member#user
         class User < Knockapi::Internal::Type::BaseModel
           # @!attribute id
           #   The ID for the user that you set when identifying them in Knock.

data/lib/knockapi/models/audience_list_members_response.rb

@@ -7,21 +7,21 @@ module Knockapi
       # @!attribute entries
       #   A list of audience members.
       #
-      #   @return [Array<Knockapi::AudienceMember>]
+      #   @return [Array<Knockapi::Models::AudienceMember>]
       required :entries, -> { Knockapi::Internal::Type::ArrayOf[Knockapi::AudienceMember] }
 
       # @!attribute page_info
       #   Pagination information for a list of resources.
       #
-      #   @return [Knockapi::PageInfo]
+      #   @return [Knockapi::Models::PageInfo]
       required :page_info, -> { Knockapi::PageInfo }
 
       # @!method initialize(entries:, page_info:)
       #   A paginated list of audience members.
       #
-      #   @param entries [Array<Knockapi::AudienceMember>] A list of audience members.
+      #   @param entries [Array<Knockapi::Models::AudienceMember>] A list of audience members.
       #
-      #   @param page_info [Knockapi::PageInfo] Pagination information for a list of resources.
+      #   @param page_info [Knockapi::Models::PageInfo] Pagination information for a list of resources.
     end
   end
 end

data/lib/knockapi/models/audience_member.rb

@@ -20,7 +20,7 @@ module Knockapi
       #   receive notifications through Knock. Users are the most common recipients of
       #   notifications and are always referenced by your internal identifier.
       #
-      #   @return [Knockapi::User]
+      #   @return [Knockapi::Models::User]
       required :user, -> { Knockapi::User }
 
       # @!attribute user_id
@@ -36,8 +36,8 @@ module Knockapi
       optional :tenant, String, nil?: true
 
       # @!method initialize(_typename:, added_at:, user:, user_id:, tenant: nil)
-      #   Some parameter documentations has been truncated, see {Knockapi::AudienceMember}
-      #   for more details.
+      #   Some parameter documentations has been truncated, see
+      #   {Knockapi::Models::AudienceMember} for more details.
       #
       #   An audience member.
       #
@@ -45,7 +45,7 @@ module Knockapi
       #
       #   @param added_at [Time] Timestamp when the resource was created.
       #
-      #   @param user [Knockapi::User] A [User](/concepts/users) represents an individual in your system who can receiv
+      #   @param user [Knockapi::Models::User] A [User](/concepts/users) represents an individual in your system who can receiv
       #
       #   @param user_id [String] The ID for the user that you set when identifying them in Knock.
       #

data/lib/knockapi/models/audience_remove_members_params.rb

@@ -10,14 +10,14 @@ module Knockapi
       # @!attribute members
       #   A list of audience members to remove.
       #
-      #   @return [Array<Knockapi::AudienceRemoveMembersParams::Member>]
+      #   @return [Array<Knockapi::Models::AudienceRemoveMembersParams::Member>]
       required :members,
                -> {
                  Knockapi::Internal::Type::ArrayOf[Knockapi::AudienceRemoveMembersParams::Member]
                }
 
       # @!method initialize(members:, request_options: {})
-      #   @param members [Array<Knockapi::AudienceRemoveMembersParams::Member>] A list of audience members to remove.
+      #   @param members [Array<Knockapi::Models::AudienceRemoveMembersParams::Member>] A list of audience members to remove.
       #
       #   @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
 
@@ -25,7 +25,7 @@ module Knockapi
         # @!attribute user
         #   An object containing the user's ID.
         #
-        #   @return [Knockapi::AudienceRemoveMembersParams::Member::User]
+        #   @return [Knockapi::Models::AudienceRemoveMembersParams::Member::User]
         required :user, -> { Knockapi::AudienceRemoveMembersParams::Member::User }
 
         # @!attribute tenant
@@ -37,11 +37,11 @@ module Knockapi
         # @!method initialize(user:, tenant: nil)
         #   An audience member.
         #
-        #   @param user [Knockapi::AudienceRemoveMembersParams::Member::User] An object containing the user's ID.
+        #   @param user [Knockapi::Models::AudienceRemoveMembersParams::Member::User] An object containing the user's ID.
         #
         #   @param tenant [String, nil] The unique identifier for the tenant.
 
-        # @see Knockapi::AudienceRemoveMembersParams::Member#user
+        # @see Knockapi::Models::AudienceRemoveMembersParams::Member#user
         class User < Knockapi::Internal::Type::BaseModel
           # @!attribute id
           #   The ID for the user that you set when identifying them in Knock.

data/lib/knockapi/models/bulk_operation.rb

@@ -43,7 +43,7 @@ module Knockapi
       # @!attribute status
       #   The status of the bulk operation.
       #
-      #   @return [Symbol, Knockapi::BulkOperation::Status]
+      #   @return [Symbol, Knockapi::Models::BulkOperation::Status]
       required :status, enum: -> { Knockapi::BulkOperation::Status }
 
       # @!attribute success_count
@@ -73,7 +73,7 @@ module Knockapi
       # @!attribute error_items
       #   A list of items that failed to be processed.
       #
-      #   @return [Array<Knockapi::BulkOperation::ErrorItem>, nil]
+      #   @return [Array<Knockapi::Models::BulkOperation::ErrorItem>, nil]
       optional :error_items, -> { Knockapi::Internal::Type::ArrayOf[Knockapi::BulkOperation::ErrorItem] }
 
       # @!attribute failed_at
@@ -109,7 +109,7 @@ module Knockapi
       #
       #   @param processed_rows [Integer] The number of rows processed so far.
       #
-      #   @param status [Symbol, Knockapi::BulkOperation::Status] The status of the bulk operation.
+      #   @param status [Symbol, Knockapi::Models::BulkOperation::Status] The status of the bulk operation.
       #
       #   @param success_count [Integer] The number of successful operations.
       #
@@ -119,7 +119,7 @@ module Knockapi
       #
       #   @param error_count [Integer] The number of failed operations.
       #
-      #   @param error_items [Array<Knockapi::BulkOperation::ErrorItem>] A list of items that failed to be processed.
+      #   @param error_items [Array<Knockapi::Models::BulkOperation::ErrorItem>] A list of items that failed to be processed.
       #
       #   @param failed_at [Time, nil] Timestamp when the bulk operation failed.
       #
@@ -129,7 +129,7 @@ module Knockapi
 
       # The status of the bulk operation.
       #
-      # @see Knockapi::BulkOperation#status
+      # @see Knockapi::Models::BulkOperation#status
       module Status
         extend Knockapi::Internal::Type::Enum
 

data/lib/knockapi/models/channels/bulk_update_message_status_params.rb

@@ -11,13 +11,13 @@ module Knockapi
         # @!attribute archived
         #   Limits the results to messages with the given archived status.
         #
-        #   @return [Symbol, Knockapi::Channels::BulkUpdateMessageStatusParams::Archived, nil]
+        #   @return [Symbol, Knockapi::Models::Channels::BulkUpdateMessageStatusParams::Archived, nil]
         optional :archived, enum: -> { Knockapi::Channels::BulkUpdateMessageStatusParams::Archived }
 
         # @!attribute delivery_status
         #   Limits the results to messages with the given delivery status.
         #
-        #   @return [Symbol, Knockapi::Channels::BulkUpdateMessageStatusParams::DeliveryStatus, nil]
+        #   @return [Symbol, Knockapi::Models::Channels::BulkUpdateMessageStatusParams::DeliveryStatus, nil]
         optional :delivery_status,
                  enum: -> {
                    Knockapi::Channels::BulkUpdateMessageStatusParams::DeliveryStatus
@@ -26,7 +26,7 @@ module Knockapi
         # @!attribute engagement_status
         #   Limits the results to messages with the given engagement status.
         #
-        #   @return [Symbol, Knockapi::Channels::BulkUpdateMessageStatusParams::EngagementStatus, nil]
+        #   @return [Symbol, Knockapi::Models::Channels::BulkUpdateMessageStatusParams::EngagementStatus, nil]
         optional :engagement_status,
                  enum: -> { Knockapi::Channels::BulkUpdateMessageStatusParams::EngagementStatus }
 
@@ -78,11 +78,11 @@ module Knockapi
         #   Some parameter documentations has been truncated, see
         #   {Knockapi::Models::Channels::BulkUpdateMessageStatusParams} for more details.
         #
-        #   @param archived [Symbol, Knockapi::Channels::BulkUpdateMessageStatusParams::Archived] Limits the results to messages with the given archived status.
+        #   @param archived [Symbol, Knockapi::Models::Channels::BulkUpdateMessageStatusParams::Archived] Limits the results to messages with the given archived status.
         #
-        #   @param delivery_status [Symbol, Knockapi::Channels::BulkUpdateMessageStatusParams::DeliveryStatus] Limits the results to messages with the given delivery status.
+        #   @param delivery_status [Symbol, Knockapi::Models::Channels::BulkUpdateMessageStatusParams::DeliveryStatus] Limits the results to messages with the given delivery status.
         #
-        #   @param engagement_status [Symbol, Knockapi::Channels::BulkUpdateMessageStatusParams::EngagementStatus] Limits the results to messages with the given engagement status.
+        #   @param engagement_status [Symbol, Knockapi::Models::Channels::BulkUpdateMessageStatusParams::EngagementStatus] Limits the results to messages with the given engagement status.
         #
         #   @param has_tenant [Boolean] Limits the results to messages that have a tenant or not.
         #

data/lib/knockapi/models/condition.rb

@@ -12,7 +12,7 @@ module Knockapi
       # @!attribute operator
       #   The operator to use in the condition evaluation.
       #
-      #   @return [Symbol, Knockapi::Condition::Operator]
+      #   @return [Symbol, Knockapi::Models::Condition::Operator]
       required :operator, enum: -> { Knockapi::Condition::Operator }
 
       # @!attribute variable
@@ -26,13 +26,13 @@ module Knockapi
       #
       #   @param argument [String, nil] The argument value to compare against in the condition.
       #
-      #   @param operator [Symbol, Knockapi::Condition::Operator] The operator to use in the condition evaluation.
+      #   @param operator [Symbol, Knockapi::Models::Condition::Operator] The operator to use in the condition evaluation.
       #
       #   @param variable [String] The variable to be evaluated in the condition.
 
       # The operator to use in the condition evaluation.
       #
-      # @see Knockapi::Condition#operator
+      # @see Knockapi::Models::Condition#operator
       module Operator
         extend Knockapi::Internal::Type::Enum