knockapi 1.0.0 → 1.2.0

data/rbi/knockapi/models/object_list_subscriptions_params.rbi

@@ -6,6 +6,14 @@ module Knockapi
       extend Knockapi::Internal::Type::RequestParameters::Converter
       include Knockapi::Internal::Type::RequestParameters
 
+      OrHash =
+        T.type_alias do
+          T.any(
+            Knockapi::ObjectListSubscriptionsParams,
+            Knockapi::Internal::AnyHash
+          )
+        end
+
       # The cursor to fetch entries after.
       sig { returns(T.nilable(String)) }
       attr_reader :after
@@ -21,30 +29,53 @@ module Knockapi
       attr_writer :before
 
       # Additional fields to include in the response.
-      sig { returns(T.nilable(T::Array[Knockapi::Models::ObjectListSubscriptionsParams::Include::OrSymbol])) }
+      sig do
+        returns(
+          T.nilable(
+            T::Array[Knockapi::ObjectListSubscriptionsParams::Include::OrSymbol]
+          )
+        )
+      end
       attr_reader :include
 
-      sig { params(include: T::Array[Knockapi::Models::ObjectListSubscriptionsParams::Include::OrSymbol]).void }
+      sig do
+        params(
+          include:
+            T::Array[Knockapi::ObjectListSubscriptionsParams::Include::OrSymbol]
+        ).void
+      end
       attr_writer :include
 
       # Mode of the request. `recipient` to list the objects that the provided object is
       # subscribed to, `object` to list the recipients that subscribe to the provided
       # object.
-      sig { returns(T.nilable(Knockapi::Models::ObjectListSubscriptionsParams::Mode::OrSymbol)) }
+      sig do
+        returns(
+          T.nilable(Knockapi::ObjectListSubscriptionsParams::Mode::OrSymbol)
+        )
+      end
       attr_reader :mode
 
-      sig { params(mode: Knockapi::Models::ObjectListSubscriptionsParams::Mode::OrSymbol).void }
+      sig do
+        params(
+          mode: Knockapi::ObjectListSubscriptionsParams::Mode::OrSymbol
+        ).void
+      end
       attr_writer :mode
 
       # Objects to filter by (only used if mode is `recipient`).
-      sig { returns(T.nilable(T::Array[Knockapi::Models::ObjectListSubscriptionsParams::Object])) }
+      sig do
+        returns(
+          T.nilable(T::Array[Knockapi::ObjectListSubscriptionsParams::Object])
+        )
+      end
       attr_reader :objects
 
       sig do
         params(
-          objects: T::Array[T.any(Knockapi::Models::ObjectListSubscriptionsParams::Object, Knockapi::Internal::AnyHash)]
-        )
-          .void
+          objects:
+            T::Array[Knockapi::ObjectListSubscriptionsParams::Object::OrHash]
+        ).void
       end
       attr_writer :objects
 
@@ -56,14 +87,27 @@ module Knockapi
       attr_writer :page_size
 
       # Recipients to filter by (only used if mode is `object`).
-      sig { returns(T.nilable(T::Array[T.any(String, Knockapi::Models::RecipientReference::ObjectReference)])) }
+      sig do
+        returns(
+          T.nilable(
+            T::Array[
+              T.any(String, Knockapi::RecipientReference::ObjectReference)
+            ]
+          )
+        )
+      end
       attr_reader :recipients
 
       sig do
         params(
-          recipients: T::Array[T.any(String, Knockapi::Models::RecipientReference::ObjectReference, Knockapi::Internal::AnyHash)]
-        )
-          .void
+          recipients:
+            T::Array[
+              T.any(
+                String,
+                Knockapi::RecipientReference::ObjectReference::OrHash
+              )
+            ]
+        ).void
       end
       attr_writer :recipients
 
@@ -71,14 +115,23 @@ module Knockapi
         params(
           after: String,
           before: String,
-          include: T::Array[Knockapi::Models::ObjectListSubscriptionsParams::Include::OrSymbol],
-          mode: Knockapi::Models::ObjectListSubscriptionsParams::Mode::OrSymbol,
-          objects: T::Array[T.any(Knockapi::Models::ObjectListSubscriptionsParams::Object, Knockapi::Internal::AnyHash)],
+          include:
+            T::Array[
+              Knockapi::ObjectListSubscriptionsParams::Include::OrSymbol
+            ],
+          mode: Knockapi::ObjectListSubscriptionsParams::Mode::OrSymbol,
+          objects:
+            T::Array[Knockapi::ObjectListSubscriptionsParams::Object::OrHash],
           page_size: Integer,
-          recipients: T::Array[T.any(String, Knockapi::Models::RecipientReference::ObjectReference, Knockapi::Internal::AnyHash)],
-          request_options: T.any(Knockapi::RequestOptions, Knockapi::Internal::AnyHash)
-        )
-          .returns(T.attached_class)
+          recipients:
+            T::Array[
+              T.any(
+                String,
+                Knockapi::RecipientReference::ObjectReference::OrHash
+              )
+            ],
+          request_options: Knockapi::RequestOptions::OrHash
+        ).returns(T.attached_class)
       end
       def self.new(
         # The cursor to fetch entries after.
@@ -98,34 +151,56 @@ module Knockapi
         # Recipients to filter by (only used if mode is `object`).
         recipients: nil,
         request_options: {}
-      ); end
+      )
+      end
+
       sig do
-        override
-          .returns(
-            {
-              after: String,
-              before: String,
-              include: T::Array[Knockapi::Models::ObjectListSubscriptionsParams::Include::OrSymbol],
-              mode: Knockapi::Models::ObjectListSubscriptionsParams::Mode::OrSymbol,
-              objects: T::Array[Knockapi::Models::ObjectListSubscriptionsParams::Object],
-              page_size: Integer,
-              recipients: T::Array[T.any(String, Knockapi::Models::RecipientReference::ObjectReference)],
-              request_options: Knockapi::RequestOptions
-            }
-          )
+        override.returns(
+          {
+            after: String,
+            before: String,
+            include:
+              T::Array[
+                Knockapi::ObjectListSubscriptionsParams::Include::OrSymbol
+              ],
+            mode: Knockapi::ObjectListSubscriptionsParams::Mode::OrSymbol,
+            objects: T::Array[Knockapi::ObjectListSubscriptionsParams::Object],
+            page_size: Integer,
+            recipients:
+              T::Array[
+                T.any(String, Knockapi::RecipientReference::ObjectReference)
+              ],
+            request_options: Knockapi::RequestOptions
+          }
+        )
+      end
+      def to_hash
       end
-      def to_hash; end
 
       module Include
         extend Knockapi::Internal::Type::Enum
 
-        TaggedSymbol = T.type_alias { T.all(Symbol, Knockapi::Models::ObjectListSubscriptionsParams::Include) }
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Knockapi::ObjectListSubscriptionsParams::Include)
+          end
         OrSymbol = T.type_alias { T.any(Symbol, String) }
 
-        PREFERENCES = T.let(:preferences, Knockapi::Models::ObjectListSubscriptionsParams::Include::TaggedSymbol)
+        PREFERENCES =
+          T.let(
+            :preferences,
+            Knockapi::ObjectListSubscriptionsParams::Include::TaggedSymbol
+          )
 
-        sig { override.returns(T::Array[Knockapi::Models::ObjectListSubscriptionsParams::Include::TaggedSymbol]) }
-        def self.values; end
+        sig do
+          override.returns(
+            T::Array[
+              Knockapi::ObjectListSubscriptionsParams::Include::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
       end
 
       # Mode of the request. `recipient` to list the objects that the provided object is
@@ -134,17 +209,43 @@ module Knockapi
       module Mode
         extend Knockapi::Internal::Type::Enum
 
-        TaggedSymbol = T.type_alias { T.all(Symbol, Knockapi::Models::ObjectListSubscriptionsParams::Mode) }
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Knockapi::ObjectListSubscriptionsParams::Mode)
+          end
         OrSymbol = T.type_alias { T.any(Symbol, String) }
 
-        RECIPIENT = T.let(:recipient, Knockapi::Models::ObjectListSubscriptionsParams::Mode::TaggedSymbol)
-        OBJECT = T.let(:object, Knockapi::Models::ObjectListSubscriptionsParams::Mode::TaggedSymbol)
+        RECIPIENT =
+          T.let(
+            :recipient,
+            Knockapi::ObjectListSubscriptionsParams::Mode::TaggedSymbol
+          )
+        OBJECT =
+          T.let(
+            :object,
+            Knockapi::ObjectListSubscriptionsParams::Mode::TaggedSymbol
+          )
 
-        sig { override.returns(T::Array[Knockapi::Models::ObjectListSubscriptionsParams::Mode::TaggedSymbol]) }
-        def self.values; end
+        sig do
+          override.returns(
+            T::Array[
+              Knockapi::ObjectListSubscriptionsParams::Mode::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
       end
 
       class Object < Knockapi::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Knockapi::ObjectListSubscriptionsParams::Object,
+              Knockapi::Internal::AnyHash
+            )
+          end
+
         # An identifier for the recipient object.
         sig { returns(T.nilable(String)) }
         attr_reader :id
@@ -166,9 +267,12 @@ module Knockapi
           id: nil,
           # The collection the recipient object belongs to.
           collection: nil
-        ); end
-        sig { override.returns({id: String, collection: String}) }
-        def to_hash; end
+        )
+        end
+
+        sig { override.returns({ id: String, collection: String }) }
+        def to_hash
+        end
       end
     end
   end

data/rbi/knockapi/models/object_set_channel_data_params.rbi

@@ -6,14 +6,25 @@ module Knockapi
       extend Knockapi::Internal::Type::RequestParameters::Converter
       include Knockapi::Internal::Type::RequestParameters
 
+      OrHash =
+        T.type_alias do
+          T.any(
+            Knockapi::ObjectSetChannelDataParams,
+            Knockapi::Internal::AnyHash
+          )
+        end
+
       sig do
-        params(request_options: T.any(Knockapi::RequestOptions, Knockapi::Internal::AnyHash))
-          .returns(T.attached_class)
+        params(request_options: Knockapi::RequestOptions::OrHash).returns(
+          T.attached_class
+        )
+      end
+      def self.new(request_options: {})
       end
-      def self.new(request_options: {}); end
 
-      sig { override.returns({request_options: Knockapi::RequestOptions}) }
-      def to_hash; end
+      sig { override.returns({ request_options: Knockapi::RequestOptions }) }
+      def to_hash
+      end
     end
   end
 end

data/rbi/knockapi/models/object_set_params.rbi

@@ -6,15 +6,44 @@ module Knockapi
       extend Knockapi::Internal::Type::RequestParameters::Converter
       include Knockapi::Internal::Type::RequestParameters
 
+      OrHash =
+        T.type_alias do
+          T.any(Knockapi::ObjectSetParams, Knockapi::Internal::AnyHash)
+        end
+
       # 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_reader :channel_data
 
       sig do
         params(
-          channel_data: T::Hash[Symbol, T.any(Knockapi::Models::Recipients::ChannelDataRequest, Knockapi::Internal::AnyHash)]
-        )
-          .void
+          channel_data:
+            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
+              )
+            ]
+        ).void
       end
       attr_writer :channel_data
 
@@ -24,33 +53,47 @@ module Knockapi
       attr_accessor :locale
 
       # 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_reader :preferences
 
       sig do
         params(
-          preferences: T::Hash[Symbol, T.any(Knockapi::Models::Recipients::PreferenceSetRequest, Knockapi::Internal::AnyHash)]
-        )
-          .void
+          preferences:
+            T::Hash[Symbol, Knockapi::Recipients::PreferenceSetRequest::OrHash]
+        ).void
       end
       attr_writer :preferences
 
-      # The timezone of the object. 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 object. 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
 
       sig do
         params(
-          channel_data: T::Hash[Symbol, T.any(Knockapi::Models::Recipients::ChannelDataRequest, Knockapi::Internal::AnyHash)],
+          channel_data:
+            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
+              )
+            ],
           locale: T.nilable(String),
-          preferences: T::Hash[Symbol, T.any(Knockapi::Models::Recipients::PreferenceSetRequest, Knockapi::Internal::AnyHash)],
+          preferences:
+            T::Hash[Symbol, Knockapi::Recipients::PreferenceSetRequest::OrHash],
           timezone: T.nilable(String),
-          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(
         # A request to set channel data for a type of channel inline.
@@ -60,26 +103,39 @@ module Knockapi
         locale: nil,
         # Inline set preferences for a recipient, where the key is the preference set id.
         preferences: nil,
-        # The timezone of the object. 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 object. 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
+
       sig do
-        override
-          .returns(
-            {
-              channel_data: T::Hash[Symbol, Knockapi::Models::Recipients::ChannelDataRequest],
-              locale: T.nilable(String),
-              preferences: T::Hash[Symbol, Knockapi::Models::Recipients::PreferenceSetRequest],
-              timezone: T.nilable(String),
-              request_options: Knockapi::RequestOptions
-            }
-          )
+        override.returns(
+          {
+            channel_data:
+              T::Hash[
+                Symbol,
+                T.any(
+                  Knockapi::Recipients::PushChannelData,
+                  Knockapi::Recipients::OneSignalChannelData,
+                  Knockapi::Recipients::SlackChannelData,
+                  Knockapi::Recipients::MsTeamsChannelData,
+                  Knockapi::Recipients::DiscordChannelData
+                )
+              ],
+            locale: T.nilable(String),
+            preferences:
+              T::Hash[Symbol, Knockapi::Recipients::PreferenceSetRequest],
+            timezone: T.nilable(String),
+            request_options: Knockapi::RequestOptions
+          }
+        )
+      end
+      def to_hash
       end
-      def to_hash; end
     end
   end
 end

data/rbi/knockapi/models/object_set_preferences_params.rbi

@@ -6,14 +6,25 @@ module Knockapi
       extend Knockapi::Internal::Type::RequestParameters::Converter
       include Knockapi::Internal::Type::RequestParameters
 
+      OrHash =
+        T.type_alias do
+          T.any(
+            Knockapi::ObjectSetPreferencesParams,
+            Knockapi::Internal::AnyHash
+          )
+        end
+
       sig do
-        params(request_options: T.any(Knockapi::RequestOptions, Knockapi::Internal::AnyHash))
-          .returns(T.attached_class)
+        params(request_options: Knockapi::RequestOptions::OrHash).returns(
+          T.attached_class
+        )
+      end
+      def self.new(request_options: {})
       end
-      def self.new(request_options: {}); end
 
-      sig { override.returns({request_options: Knockapi::RequestOptions}) }
-      def to_hash; end
+      sig { override.returns({ request_options: Knockapi::RequestOptions }) }
+      def to_hash
+      end
     end
   end
 end

data/rbi/knockapi/models/object_unset_channel_data_params.rbi

@@ -6,14 +6,25 @@ module Knockapi
       extend Knockapi::Internal::Type::RequestParameters::Converter
       include Knockapi::Internal::Type::RequestParameters
 
+      OrHash =
+        T.type_alias do
+          T.any(
+            Knockapi::ObjectUnsetChannelDataParams,
+            Knockapi::Internal::AnyHash
+          )
+        end
+
       sig do
-        params(request_options: T.any(Knockapi::RequestOptions, Knockapi::Internal::AnyHash))
-          .returns(T.attached_class)
+        params(request_options: Knockapi::RequestOptions::OrHash).returns(
+          T.attached_class
+        )
+      end
+      def self.new(request_options: {})
       end
-      def self.new(request_options: {}); end
 
-      sig { override.returns({request_options: Knockapi::RequestOptions}) }
-      def to_hash; end
+      sig { override.returns({ request_options: Knockapi::RequestOptions }) }
+      def to_hash
+      end
     end
   end
 end

data/rbi/knockapi/models/object_unset_channel_data_response.rbi

@@ -0,0 +1,7 @@
+# typed: strong
+
+module Knockapi
+  module Models
+    ObjectUnsetChannelDataResponse = String
+  end
+end