knockapi 1.0.0 → 1.2.0

data/rbi/knockapi/models/identify_user_request.rbi

@@ -3,12 +3,32 @@
 module Knockapi
   module Models
     class IdentifyUserRequest < Knockapi::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Knockapi::IdentifyUserRequest, Knockapi::Internal::AnyHash)
+        end
+
       # URL to the user's avatar image.
       sig { returns(T.nilable(String)) }
       attr_accessor :avatar
 
       # A request to set channel data for a type of channel inline.
-      sig { returns(T.nilable(T::Hash[Symbol, Knockapi::Models::Recipients::ChannelDataRequest])) }
+      sig do
+        returns(
+          T.nilable(
+            T::Hash[
+              Symbol,
+              T.any(
+                Knockapi::Recipients::PushChannelData,
+                Knockapi::Recipients::OneSignalChannelData,
+                Knockapi::Recipients::SlackChannelData,
+                Knockapi::Recipients::MsTeamsChannelData,
+                Knockapi::Recipients::DiscordChannelData
+              )
+            ]
+          )
+        )
+      end
       attr_accessor :channel_data
 
       # The creation date of the user from your system.
@@ -27,19 +47,23 @@ module Knockapi
       sig { returns(T.nilable(String)) }
       attr_accessor :name
 
-      # 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).
       sig { returns(T.nilable(String)) }
       attr_accessor :phone_number
 
       # Inline set preferences for a recipient, where the key is the preference set id.
-      sig { returns(T.nilable(T::Hash[Symbol, Knockapi::Models::Recipients::PreferenceSetRequest])) }
+      sig do
+        returns(
+          T.nilable(T::Hash[Symbol, Knockapi::Recipients::PreferenceSetRequest])
+        )
+      end
       attr_accessor :preferences
 
-      # 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).
       sig { returns(T.nilable(String)) }
       attr_accessor :timezone
 
@@ -49,20 +73,33 @@ module Knockapi
       sig do
         params(
           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)
-        )
-          .returns(T.attached_class)
+        ).returns(T.attached_class)
       end
       def self.new(
         # URL to the user's avatar image.
@@ -77,34 +114,51 @@ 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
-      ); end
+      )
+      end
+
       sig do
-        override
-          .returns(
-            {
-              avatar: T.nilable(String),
-              channel_data: T.nilable(T::Hash[Symbol, Knockapi::Models::Recipients::ChannelDataRequest]),
-              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, Knockapi::Models::Recipients::PreferenceSetRequest]),
-              timezone: T.nilable(String)
-            }
-          )
+        override.returns(
+          {
+            avatar: T.nilable(String),
+            channel_data:
+              T.nilable(
+                T::Hash[
+                  Symbol,
+                  T.any(
+                    Knockapi::Recipients::PushChannelData,
+                    Knockapi::Recipients::OneSignalChannelData,
+                    Knockapi::Recipients::SlackChannelData,
+                    Knockapi::Recipients::MsTeamsChannelData,
+                    Knockapi::Recipients::DiscordChannelData
+                  )
+                ]
+              ),
+            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, Knockapi::Recipients::PreferenceSetRequest]
+              ),
+            timezone: T.nilable(String)
+          }
+        )
+      end
+      def to_hash
       end
-      def to_hash; end
     end
   end
 end

data/rbi/knockapi/models/inline_identify_user_request.rbi

@@ -3,22 +3,77 @@
 module Knockapi
   module Models
     class InlineIdentifyUserRequest < Knockapi::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Knockapi::InlineIdentifyUserRequest,
+            Knockapi::Internal::AnyHash
+          )
+        end
+
       # The ID for the user that you set when identifying them in Knock.
       sig { returns(String) }
       attr_accessor :id
 
+      # URL to the user's avatar image.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :avatar
+
       # A request to set channel data for a type of channel inline.
-      sig { returns(T.nilable(T::Hash[Symbol, Knockapi::Models::Recipients::ChannelDataRequest])) }
+      sig do
+        returns(
+          T.nilable(
+            T::Hash[
+              Symbol,
+              T.any(
+                Knockapi::Recipients::PushChannelData,
+                Knockapi::Recipients::OneSignalChannelData,
+                Knockapi::Recipients::SlackChannelData,
+                Knockapi::Recipients::MsTeamsChannelData,
+                Knockapi::Recipients::DiscordChannelData
+              )
+            ]
+          )
+        )
+      end
       attr_accessor :channel_data
 
       # The creation date of the user from your system.
       sig { returns(T.nilable(Time)) }
       attr_accessor :created_at
 
+      # The primary email address for the user.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :email
+
+      # The locale of the user. Used for [message localization](/concepts/translations).
+      sig { returns(T.nilable(String)) }
+      attr_accessor :locale
+
+      # Display name of the user.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :name
+
+      # The [E.164](https://www.twilio.com/docs/glossary/what-e164) phone number of the
+      # user (required for SMS channels).
+      sig { returns(T.nilable(String)) }
+      attr_accessor :phone_number
+
       # Inline set preferences for a recipient, where the key is the preference set id.
-      sig { returns(T.nilable(T::Hash[Symbol, Knockapi::Models::Recipients::PreferenceSetRequest])) }
+      sig do
+        returns(
+          T.nilable(T::Hash[Symbol, Knockapi::Recipients::PreferenceSetRequest])
+        )
+      end
       attr_accessor :preferences
 
+      # 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).
+      sig { returns(T.nilable(String)) }
+      attr_accessor :timezone
+
       # 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.
       # It will perform an upsert for the user you're supplying, replacing any
@@ -26,38 +81,96 @@ module Knockapi
       sig do
         params(
           id: String,
-          channel_data: T.nilable(
-            T::Hash[Symbol, T.any(Knockapi::Models::Recipients::ChannelDataRequest, Knockapi::Internal::AnyHash)]
-          ),
+          avatar: T.nilable(String),
+          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),
-          preferences: T.nilable(
-            T::Hash[Symbol, T.any(Knockapi::Models::Recipients::PreferenceSetRequest, Knockapi::Internal::AnyHash)]
-          )
-        )
-          .returns(T.attached_class)
+          email: T.nilable(String),
+          locale: T.nilable(String),
+          name: T.nilable(String),
+          phone_number: T.nilable(String),
+          preferences:
+            T.nilable(
+              T::Hash[
+                Symbol,
+                Knockapi::Recipients::PreferenceSetRequest::OrHash
+              ]
+            ),
+          timezone: T.nilable(String)
+        ).returns(T.attached_class)
       end
       def self.new(
         # The ID for the user that you set when identifying them in Knock.
         id:,
+        # URL to the user's avatar image.
+        avatar: nil,
         # A request to set channel data for a type of channel inline.
         channel_data: nil,
         # The creation date of the user from your system.
         created_at: nil,
+        # The primary email address for the user.
+        email: nil,
+        # The locale of the user. Used for [message localization](/concepts/translations).
+        locale: nil,
+        # Display name of the user.
+        name: nil,
+        # 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
-      ); end
+        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).
+        timezone: nil
+      )
+      end
+
       sig do
-        override
-          .returns(
-            {
-              id: String,
-              channel_data: T.nilable(T::Hash[Symbol, Knockapi::Models::Recipients::ChannelDataRequest]),
-              created_at: T.nilable(Time),
-              preferences: T.nilable(T::Hash[Symbol, Knockapi::Models::Recipients::PreferenceSetRequest])
-            }
-          )
+        override.returns(
+          {
+            id: String,
+            avatar: T.nilable(String),
+            channel_data:
+              T.nilable(
+                T::Hash[
+                  Symbol,
+                  T.any(
+                    Knockapi::Recipients::PushChannelData,
+                    Knockapi::Recipients::OneSignalChannelData,
+                    Knockapi::Recipients::SlackChannelData,
+                    Knockapi::Recipients::MsTeamsChannelData,
+                    Knockapi::Recipients::DiscordChannelData
+                  )
+                ]
+              ),
+            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, Knockapi::Recipients::PreferenceSetRequest]
+              ),
+            timezone: T.nilable(String)
+          }
+        )
+      end
+      def to_hash
       end
-      def to_hash; end
     end
   end
 end

data/rbi/knockapi/models/inline_object_request.rbi

@@ -3,6 +3,11 @@
 module Knockapi
   module Models
     class InlineObjectRequest < Knockapi::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Knockapi::InlineObjectRequest, Knockapi::Internal::AnyHash)
+        end
+
       # Unique identifier for the object.
       sig { returns(String) }
       attr_accessor :id
@@ -12,7 +17,22 @@ module Knockapi
       attr_accessor :collection
 
       # A request to set channel data for a type of channel inline.
-      sig { returns(T.nilable(T::Hash[Symbol, Knockapi::Models::Recipients::ChannelDataRequest])) }
+      sig do
+        returns(
+          T.nilable(
+            T::Hash[
+              Symbol,
+              T.any(
+                Knockapi::Recipients::PushChannelData,
+                Knockapi::Recipients::OneSignalChannelData,
+                Knockapi::Recipients::SlackChannelData,
+                Knockapi::Recipients::MsTeamsChannelData,
+                Knockapi::Recipients::DiscordChannelData
+              )
+            ]
+          )
+        )
+      end
       attr_accessor :channel_data
 
       # Timestamp when the resource was created.
@@ -20,7 +40,11 @@ module Knockapi
       attr_accessor :created_at
 
       # Inline set preferences for a recipient, where the key is the preference set id.
-      sig { returns(T.nilable(T::Hash[Symbol, Knockapi::Models::Recipients::PreferenceSetRequest])) }
+      sig do
+        returns(
+          T.nilable(T::Hash[Symbol, Knockapi::Recipients::PreferenceSetRequest])
+        )
+      end
       attr_accessor :preferences
 
       # A custom [Object](/concepts/objects) entity which belongs to a collection.
@@ -28,15 +52,28 @@ module Knockapi
         params(
           id: String,
           collection: 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),
-          preferences: T.nilable(
-            T::Hash[Symbol, T.any(Knockapi::Models::Recipients::PreferenceSetRequest, Knockapi::Internal::AnyHash)]
-          )
-        )
-          .returns(T.attached_class)
+          preferences:
+            T.nilable(
+              T::Hash[
+                Symbol,
+                Knockapi::Recipients::PreferenceSetRequest::OrHash
+              ]
+            )
+        ).returns(T.attached_class)
       end
       def self.new(
         # Unique identifier for the object.
@@ -49,20 +86,37 @@ module Knockapi
         created_at: nil,
         # Inline set preferences for a recipient, where the key is the preference set id.
         preferences: nil
-      ); end
+      )
+      end
+
       sig do
-        override
-          .returns(
-            {
-              id: String,
-              collection: String,
-              channel_data: T.nilable(T::Hash[Symbol, Knockapi::Models::Recipients::ChannelDataRequest]),
-              created_at: T.nilable(Time),
-              preferences: T.nilable(T::Hash[Symbol, Knockapi::Models::Recipients::PreferenceSetRequest])
-            }
-          )
+        override.returns(
+          {
+            id: String,
+            collection: String,
+            channel_data:
+              T.nilable(
+                T::Hash[
+                  Symbol,
+                  T.any(
+                    Knockapi::Recipients::PushChannelData,
+                    Knockapi::Recipients::OneSignalChannelData,
+                    Knockapi::Recipients::SlackChannelData,
+                    Knockapi::Recipients::MsTeamsChannelData,
+                    Knockapi::Recipients::DiscordChannelData
+                  )
+                ]
+              ),
+            created_at: T.nilable(Time),
+            preferences:
+              T.nilable(
+                T::Hash[Symbol, Knockapi::Recipients::PreferenceSetRequest]
+              )
+          }
+        )
+      end
+      def to_hash
       end
-      def to_hash; end
     end
   end
 end

data/rbi/knockapi/models/inline_tenant_request.rbi

@@ -6,8 +6,13 @@ module Knockapi
     module InlineTenantRequest
       extend Knockapi::Internal::Type::Union
 
-      sig { override.returns([String, Knockapi::Models::TenantRequest]) }
-      def self.variants; end
+      Variants = T.type_alias { T.any(String, Knockapi::TenantRequest) }
+
+      sig do
+        override.returns(T::Array[Knockapi::InlineTenantRequest::Variants])
+      end
+      def self.variants
+      end
     end
   end
 end

data/rbi/knockapi/models/integrations/census_custom_destination_params.rbi

@@ -7,6 +7,14 @@ module Knockapi
         extend Knockapi::Internal::Type::RequestParameters::Converter
         include Knockapi::Internal::Type::RequestParameters
 
+        OrHash =
+          T.type_alias do
+            T.any(
+              Knockapi::Integrations::CensusCustomDestinationParams,
+              Knockapi::Internal::AnyHash
+            )
+          end
+
         # The unique identifier for the RPC request.
         sig { returns(String) }
         attr_accessor :id
@@ -32,9 +40,8 @@ module Knockapi
             jsonrpc: String,
             method_: String,
             params: T::Hash[Symbol, T.anything],
-            request_options: T.any(Knockapi::RequestOptions, Knockapi::Internal::AnyHash)
-          )
-            .returns(T.attached_class)
+            request_options: Knockapi::RequestOptions::OrHash
+          ).returns(T.attached_class)
         end
         def self.new(
           # The unique identifier for the RPC request.
@@ -46,20 +53,22 @@ module Knockapi
           # The parameters for the method.
           params: nil,
           request_options: {}
-        ); end
+        )
+        end
+
         sig do
-          override
-            .returns(
-              {
-                id: String,
-                jsonrpc: String,
-                method_: String,
-                params: T::Hash[Symbol, T.anything],
-                request_options: Knockapi::RequestOptions
-              }
-            )
+          override.returns(
+            {
+              id: String,
+              jsonrpc: String,
+              method_: String,
+              params: T::Hash[Symbol, T.anything],
+              request_options: Knockapi::RequestOptions
+            }
+          )
+        end
+        def to_hash
         end
-        def to_hash; end
       end
     end
   end

data/rbi/knockapi/models/integrations/census_custom_destination_response.rbi

@@ -4,6 +4,14 @@ module Knockapi
   module Models
     module Integrations
       class CensusCustomDestinationResponse < Knockapi::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Knockapi::Models::Integrations::CensusCustomDestinationResponse,
+              Knockapi::Internal::AnyHash
+            )
+          end
+
         # The request ID.
         sig { returns(T.nilable(String)) }
         attr_reader :id
@@ -18,15 +26,24 @@ module Knockapi
         sig { params(result: T::Hash[Symbol, T.anything]).void }
         attr_writer :result
 
-        sig { params(id: String, result: T::Hash[Symbol, T.anything]).returns(T.attached_class) }
+        sig do
+          params(id: String, result: T::Hash[Symbol, T.anything]).returns(
+            T.attached_class
+          )
+        end
         def self.new(
           # The request ID.
           id: nil,
           # The result of the RPC call.
           result: nil
-        ); end
-        sig { override.returns({id: String, result: T::Hash[Symbol, T.anything]}) }
-        def to_hash; end
+        )
+        end
+
+        sig do
+          override.returns({ id: String, result: T::Hash[Symbol, T.anything] })
+        end
+        def to_hash
+        end
       end
     end
   end