knockapi 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a17bdfaf684872fdd008ffb6738905028e7015eac1e197a4b494d7683496409c
-  data.tar.gz: '0957f25b7abb88c19f79b68e5713ba725e66889d0f30a6c7affb9f37ebb57f83'
+  metadata.gz: 05e2af454cc4e2dc3f721acdafcfe91ff2aafaac9a6cdcaeff7a6d0fb3554ded
+  data.tar.gz: 51f60b06a643f43661372498e05cf0eb236f9b05f290816ecf8c2d36450c84cd
 SHA512:
-  metadata.gz: e071c34475a0192fd33f068ded94e4d25a6b57d78a8dca337bee16033a2907e9472d01610ab7549d59d3acc4c51da545708a5e074edc7a7b338e20da73567d91
-  data.tar.gz: 2fc22e17fc5c958bfdd9bcfdbc32d7b4c3714eb07b42b848bd65dfa760a833b77a96ee097ed99ed44e927bb083bd418f578740e63cfabb698938e5666b918d62
+  metadata.gz: 4664831a9ed4bb37eff4922c9bc1d75d08db467e03e1e70f97b7584ca20f5fd534a90a05c29dca71413c8cf9d782e954b4b6cddab94fba14f68f42820173dc25
+  data.tar.gz: d9353f602163c8883a97a072755294bde85439126a986dc1c8148daca0f7e92965836e146fe4df9591205284b86b1abf04c1166a97461ecc52887d030c7c7696

data/CHANGELOG.md

@@ -1,5 +1,27 @@
 # 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)

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.2.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/util.rb

@@ -600,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)
@@ -619,6 +621,8 @@ module Knockapi
           else
             [headers, body]
           end
+          # rubocop:enable Layout/LineLength
+          # rubocop:enable Style/CaseEquality
         end
 
         # @api private
@@ -871,8 +875,12 @@ module Knockapi
             case type
             in Knockapi::Internal::Util::SorbetRuntimeSupport
               type.to_sorbet_type
-            else
+            in Class | Module
               type
+            in true | false
+              T::Boolean
+            else
+              type.class
             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
 

data/lib/knockapi/models/identify_user_request.rb

@@ -12,7 +12,7 @@ module Knockapi
       # @!attribute channel_data
       #   A request to set channel data for a type of channel inline.
       #
-      #   @return [Hash{Symbol=>Knockapi::Recipients::PushChannelData, Knockapi::Recipients::OneSignalChannelData, Knockapi::Recipients::SlackChannelData, Knockapi::Recipients::MsTeamsChannelData, Knockapi::Recipients::DiscordChannelData}, nil]
+      #   @return [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil]
       optional :channel_data,
                -> {
                  Knockapi::Internal::Type::HashOf[union: Knockapi::Recipients::InlineChannelDataRequestItem]
@@ -53,7 +53,7 @@ module Knockapi
       # @!attribute preferences
       #   Inline set preferences for a recipient, where the key is the preference set id.
       #
-      #   @return [Hash{Symbol=>Knockapi::Recipients::PreferenceSetRequest}, nil]
+      #   @return [Hash{Symbol=>Knockapi::Models::Recipients::PreferenceSetRequest}, nil]
       optional :preferences,
                -> { Knockapi::Internal::Type::HashOf[Knockapi::Recipients::PreferenceSetRequest] },
                nil?: true
@@ -69,7 +69,7 @@ module Knockapi
 
       # @!method initialize(avatar: nil, channel_data: nil, created_at: nil, email: nil, locale: nil, name: nil, phone_number: nil, preferences: nil, timezone: nil)
       #   Some parameter documentations has been truncated, see
-      #   {Knockapi::IdentifyUserRequest} for more details.
+      #   {Knockapi::Models::IdentifyUserRequest} for more details.
       #
       #   A set of parameters to identify a user with. Does not include the user ID, as
       #   that's specified elsewhere in the request. You can supply any additional
@@ -77,7 +77,7 @@ module Knockapi
       #
       #   @param avatar [String, nil] URL to the user's avatar image.
       #
-      #   @param channel_data [Hash{Symbol=>Knockapi::Recipients::PushChannelData, Knockapi::Recipients::OneSignalChannelData, Knockapi::Recipients::SlackChannelData, Knockapi::Recipients::MsTeamsChannelData, Knockapi::Recipients::DiscordChannelData}, nil] A request to set channel data for a type of channel inline.
+      #   @param channel_data [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil] A request to set channel data for a type of channel inline.
       #
       #   @param created_at [Time, nil] The creation date of the user from your system.
       #
@@ -89,7 +89,7 @@ module Knockapi
       #
       #   @param phone_number [String, nil] The [E.164](https://www.twilio.com/docs/glossary/what-e164) phone number of the
       #
-      #   @param preferences [Hash{Symbol=>Knockapi::Recipients::PreferenceSetRequest}, nil] Inline set preferences for a recipient, where the key is the preference set id.
+      #   @param preferences [Hash{Symbol=>Knockapi::Models::Recipients::PreferenceSetRequest}, nil] Inline set preferences for a recipient, where the key is the preference set id.
       #
       #   @param timezone [String, nil] The timezone of the user. Must be a valid [tz database time zone string](https:/
     end

data/lib/knockapi/models/inline_identify_user_request.rb

@@ -18,7 +18,7 @@ module Knockapi
       # @!attribute channel_data
       #   A request to set channel data for a type of channel inline.
       #
-      #   @return [Hash{Symbol=>Knockapi::Recipients::PushChannelData, Knockapi::Recipients::OneSignalChannelData, Knockapi::Recipients::SlackChannelData, Knockapi::Recipients::MsTeamsChannelData, Knockapi::Recipients::DiscordChannelData}, nil]
+      #   @return [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil]
       optional :channel_data,
                -> {
                  Knockapi::Internal::Type::HashOf[union: Knockapi::Recipients::InlineChannelDataRequestItem]
@@ -59,7 +59,7 @@ module Knockapi
       # @!attribute preferences
       #   Inline set preferences for a recipient, where the key is the preference set id.
       #
-      #   @return [Hash{Symbol=>Knockapi::Recipients::PreferenceSetRequest}, nil]
+      #   @return [Hash{Symbol=>Knockapi::Models::Recipients::PreferenceSetRequest}, nil]
       optional :preferences,
                -> { Knockapi::Internal::Type::HashOf[Knockapi::Recipients::PreferenceSetRequest] },
                nil?: true
@@ -75,7 +75,7 @@ module Knockapi
 
       # @!method initialize(id:, avatar: nil, channel_data: nil, created_at: nil, email: nil, locale: nil, name: nil, phone_number: nil, preferences: nil, timezone: nil)
       #   Some parameter documentations has been truncated, see
-      #   {Knockapi::InlineIdentifyUserRequest} for more details.
+      #   {Knockapi::Models::InlineIdentifyUserRequest} for more details.
       #
       #   A set of parameters to inline-identify a user with. Inline identifying the user
       #   will ensure that the user is available before the request is executed in Knock.
@@ -86,7 +86,7 @@ module Knockapi
       #
       #   @param avatar [String, nil] URL to the user's avatar image.
       #
-      #   @param channel_data [Hash{Symbol=>Knockapi::Recipients::PushChannelData, Knockapi::Recipients::OneSignalChannelData, Knockapi::Recipients::SlackChannelData, Knockapi::Recipients::MsTeamsChannelData, Knockapi::Recipients::DiscordChannelData}, nil] A request to set channel data for a type of channel inline.
+      #   @param channel_data [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil] A request to set channel data for a type of channel inline.
       #
       #   @param created_at [Time, nil] The creation date of the user from your system.
       #
@@ -98,7 +98,7 @@ module Knockapi
       #
       #   @param phone_number [String, nil] The [E.164](https://www.twilio.com/docs/glossary/what-e164) phone number of the
       #
-      #   @param preferences [Hash{Symbol=>Knockapi::Recipients::PreferenceSetRequest}, nil] Inline set preferences for a recipient, where the key is the preference set id.
+      #   @param preferences [Hash{Symbol=>Knockapi::Models::Recipients::PreferenceSetRequest}, nil] Inline set preferences for a recipient, where the key is the preference set id.
       #
       #   @param timezone [String, nil] The timezone of the user. Must be a valid [tz database time zone string](https:/
     end

data/lib/knockapi/models/inline_object_request.rb

@@ -18,7 +18,7 @@ module Knockapi
       # @!attribute channel_data
       #   A request to set channel data for a type of channel inline.
       #
-      #   @return [Hash{Symbol=>Knockapi::Recipients::PushChannelData, Knockapi::Recipients::OneSignalChannelData, Knockapi::Recipients::SlackChannelData, Knockapi::Recipients::MsTeamsChannelData, Knockapi::Recipients::DiscordChannelData}, nil]
+      #   @return [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil]
       optional :channel_data,
                -> {
                  Knockapi::Internal::Type::HashOf[union: Knockapi::Recipients::InlineChannelDataRequestItem]
@@ -34,7 +34,7 @@ module Knockapi
       # @!attribute preferences
       #   Inline set preferences for a recipient, where the key is the preference set id.
       #
-      #   @return [Hash{Symbol=>Knockapi::Recipients::PreferenceSetRequest}, nil]
+      #   @return [Hash{Symbol=>Knockapi::Models::Recipients::PreferenceSetRequest}, nil]
       optional :preferences,
                -> { Knockapi::Internal::Type::HashOf[Knockapi::Recipients::PreferenceSetRequest] },
                nil?: true
@@ -46,11 +46,11 @@ module Knockapi
       #
       #   @param collection [String] The collection this object belongs to.
       #
-      #   @param channel_data [Hash{Symbol=>Knockapi::Recipients::PushChannelData, Knockapi::Recipients::OneSignalChannelData, Knockapi::Recipients::SlackChannelData, Knockapi::Recipients::MsTeamsChannelData, Knockapi::Recipients::DiscordChannelData}, nil] A request to set channel data for a type of channel inline.
+      #   @param channel_data [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil] A request to set channel data for a type of channel inline.
       #
       #   @param created_at [Time, nil] Timestamp when the resource was created.
       #
-      #   @param preferences [Hash{Symbol=>Knockapi::Recipients::PreferenceSetRequest}, nil] Inline set preferences for a recipient, where the key is the preference set id.
+      #   @param preferences [Hash{Symbol=>Knockapi::Models::Recipients::PreferenceSetRequest}, nil] Inline set preferences for a recipient, where the key is the preference set id.
     end
   end
 end

data/lib/knockapi/models/inline_tenant_request.rb

@@ -13,7 +13,7 @@ module Knockapi
       variant -> { Knockapi::TenantRequest }
 
       # @!method self.variants
-      #   @return [Array(String, Knockapi::TenantRequest)]
+      #   @return [Array(String, Knockapi::Models::TenantRequest)]
     end
   end
 end