knockapi 0.6.1 → 1.0.0

data/rbi/knockapi/models/object_set_params.rbi

@@ -0,0 +1,85 @@
+# typed: strong
+
+module Knockapi
+  module Models
+    class ObjectSetParams < Knockapi::Internal::Type::BaseModel
+      extend Knockapi::Internal::Type::RequestParameters::Converter
+      include Knockapi::Internal::Type::RequestParameters
+
+      # A request to set channel data for a type of channel inline.
+      sig { returns(T.nilable(T::Hash[Symbol, Knockapi::Models::Recipients::ChannelDataRequest])) }
+      attr_reader :channel_data
+
+      sig do
+        params(
+          channel_data: T::Hash[Symbol, T.any(Knockapi::Models::Recipients::ChannelDataRequest, Knockapi::Internal::AnyHash)]
+        )
+          .void
+      end
+      attr_writer :channel_data
+
+      # The locale of the object. Used for
+      # [message localization](/concepts/translations).
+      sig { returns(T.nilable(String)) }
+      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])) }
+      attr_reader :preferences
+
+      sig do
+        params(
+          preferences: T::Hash[Symbol, T.any(Knockapi::Models::Recipients::PreferenceSetRequest, Knockapi::Internal::AnyHash)]
+        )
+          .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).
+      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)],
+          locale: T.nilable(String),
+          preferences: T::Hash[Symbol, T.any(Knockapi::Models::Recipients::PreferenceSetRequest, Knockapi::Internal::AnyHash)],
+          timezone: T.nilable(String),
+          request_options: T.any(Knockapi::RequestOptions, Knockapi::Internal::AnyHash)
+        )
+          .returns(T.attached_class)
+      end
+      def self.new(
+        # A request to set channel data for a type of channel inline.
+        channel_data: nil,
+        # The locale of the object. Used for
+        # [message localization](/concepts/translations).
+        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).
+        timezone: nil,
+        request_options: {}
+      ); 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
+            }
+          )
+      end
+      def to_hash; end
+    end
+  end
+end

data/rbi/knockapi/models/object_set_preferences_params.rbi

@@ -0,0 +1,19 @@
+# typed: strong
+
+module Knockapi
+  module Models
+    class ObjectSetPreferencesParams < Knockapi::Models::Recipients::PreferenceSetRequest
+      extend Knockapi::Internal::Type::RequestParameters::Converter
+      include Knockapi::Internal::Type::RequestParameters
+
+      sig do
+        params(request_options: T.any(Knockapi::RequestOptions, Knockapi::Internal::AnyHash))
+          .returns(T.attached_class)
+      end
+      def self.new(request_options: {}); 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

@@ -0,0 +1,19 @@
+# typed: strong
+
+module Knockapi
+  module Models
+    class ObjectUnsetChannelDataParams < Knockapi::Internal::Type::BaseModel
+      extend Knockapi::Internal::Type::RequestParameters::Converter
+      include Knockapi::Internal::Type::RequestParameters
+
+      sig do
+        params(request_options: T.any(Knockapi::RequestOptions, Knockapi::Internal::AnyHash))
+          .returns(T.attached_class)
+      end
+      def self.new(request_options: {}); end
+
+      sig { override.returns({request_options: Knockapi::RequestOptions}) }
+      def to_hash; end
+    end
+  end
+end

data/rbi/knockapi/models/objects/bulk_add_subscriptions_params.rbi

@@ -0,0 +1,86 @@
+# typed: strong
+
+module Knockapi
+  module Models
+    module Objects
+      class BulkAddSubscriptionsParams < Knockapi::Internal::Type::BaseModel
+        extend Knockapi::Internal::Type::RequestParameters::Converter
+        include Knockapi::Internal::Type::RequestParameters
+
+        # A list of subscriptions.
+        sig { returns(T::Array[Knockapi::Models::Objects::BulkAddSubscriptionsParams::Subscription]) }
+        attr_accessor :subscriptions
+
+        sig do
+          params(
+            subscriptions: T::Array[T.any(Knockapi::Models::Objects::BulkAddSubscriptionsParams::Subscription, Knockapi::Internal::AnyHash)],
+            request_options: T.any(Knockapi::RequestOptions, Knockapi::Internal::AnyHash)
+          )
+            .returns(T.attached_class)
+        end
+        def self.new(
+          # A list of subscriptions.
+          subscriptions:,
+          request_options: {}
+        ); end
+        sig do
+          override
+            .returns(
+              {
+                subscriptions: T::Array[Knockapi::Models::Objects::BulkAddSubscriptionsParams::Subscription],
+                request_options: Knockapi::RequestOptions
+              }
+            )
+        end
+        def to_hash; end
+
+        class Subscription < Knockapi::Internal::Type::BaseModel
+          # The recipients of the subscription. You can subscribe up to 100 recipients to an
+          # object at a time.
+          sig do
+            returns(
+              T::Array[T.any(String, Knockapi::Models::InlineIdentifyUserRequest, Knockapi::Models::InlineObjectRequest)]
+            )
+          end
+          attr_accessor :recipients
+
+          # The custom properties associated with the subscription relationship.
+          sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
+          attr_accessor :properties
+
+          sig do
+            params(
+              recipients: T::Array[
+                T.any(
+                  String,
+                  Knockapi::Models::InlineIdentifyUserRequest,
+                  Knockapi::Internal::AnyHash,
+                  Knockapi::Models::InlineObjectRequest
+                )
+              ],
+              properties: T.nilable(T::Hash[Symbol, T.anything])
+            )
+              .returns(T.attached_class)
+          end
+          def self.new(
+            # The recipients of the subscription. You can subscribe up to 100 recipients to an
+            # object at a time.
+            recipients:,
+            # The custom properties associated with the subscription relationship.
+            properties: nil
+          ); end
+          sig do
+            override
+              .returns(
+                {
+                  recipients: T::Array[T.any(String, Knockapi::Models::InlineIdentifyUserRequest, Knockapi::Models::InlineObjectRequest)],
+                  properties: T.nilable(T::Hash[Symbol, T.anything])
+                }
+              )
+          end
+          def to_hash; end
+        end
+      end
+    end
+  end
+end

data/rbi/knockapi/models/objects/bulk_delete_params.rbi

@@ -0,0 +1,31 @@
+# typed: strong
+
+module Knockapi
+  module Models
+    module Objects
+      class BulkDeleteParams < Knockapi::Internal::Type::BaseModel
+        extend Knockapi::Internal::Type::RequestParameters::Converter
+        include Knockapi::Internal::Type::RequestParameters
+
+        # List of object IDs to delete.
+        sig { returns(T::Array[String]) }
+        attr_accessor :object_ids
+
+        sig do
+          params(
+            object_ids: T::Array[String],
+            request_options: T.any(Knockapi::RequestOptions, Knockapi::Internal::AnyHash)
+          )
+            .returns(T.attached_class)
+        end
+        def self.new(
+          # List of object IDs to delete.
+          object_ids:,
+          request_options: {}
+        ); end
+        sig { override.returns({object_ids: T::Array[String], request_options: Knockapi::RequestOptions}) }
+        def to_hash; end
+      end
+    end
+  end
+end

data/rbi/knockapi/models/objects/bulk_set_params.rbi

@@ -0,0 +1,36 @@
+# typed: strong
+
+module Knockapi
+  module Models
+    module Objects
+      class BulkSetParams < Knockapi::Internal::Type::BaseModel
+        extend Knockapi::Internal::Type::RequestParameters::Converter
+        include Knockapi::Internal::Type::RequestParameters
+
+        # A list of objects.
+        sig { returns(T::Array[Knockapi::Models::InlineObjectRequest]) }
+        attr_accessor :objects
+
+        sig do
+          params(
+            objects: T::Array[T.any(Knockapi::Models::InlineObjectRequest, Knockapi::Internal::AnyHash)],
+            request_options: T.any(Knockapi::RequestOptions, Knockapi::Internal::AnyHash)
+          )
+            .returns(T.attached_class)
+        end
+        def self.new(
+          # A list of objects.
+          objects:,
+          request_options: {}
+        ); end
+        sig do
+          override
+            .returns(
+              {objects: T::Array[Knockapi::Models::InlineObjectRequest], request_options: Knockapi::RequestOptions}
+            )
+        end
+        def to_hash; end
+      end
+    end
+  end
+end

data/rbi/knockapi/models/page_info.rbi

@@ -0,0 +1,49 @@
+# typed: strong
+
+module Knockapi
+  module Models
+    class PageInfo < Knockapi::Internal::Type::BaseModel
+      # The typename of the schema.
+      sig { returns(String) }
+      attr_accessor :_typename
+
+      # The number of items per page.
+      sig { returns(Integer) }
+      attr_accessor :page_size
+
+      # The cursor to fetch entries after.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :after
+
+      # The cursor to fetch entries before.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :before
+
+      # Pagination information for a list of resources.
+      sig do
+        params(_typename: String, page_size: Integer, after: T.nilable(String), before: T.nilable(String))
+          .returns(T.attached_class)
+      end
+      def self.new(
+        # The typename of the schema.
+        _typename:,
+        # The number of items per page.
+        page_size:,
+        # The cursor to fetch entries after.
+        after: nil,
+        # The cursor to fetch entries before.
+        before: nil
+      ); end
+      sig do
+        override
+          .returns({
+                     _typename: String,
+                     page_size: Integer,
+                     after: T.nilable(String),
+                     before: T.nilable(String)
+                   })
+      end
+      def to_hash; end
+    end
+  end
+end

data/rbi/knockapi/models/providers/ms_team_check_auth_params.rbi

@@ -0,0 +1,31 @@
+# typed: strong
+
+module Knockapi
+  module Models
+    module Providers
+      class MsTeamCheckAuthParams < Knockapi::Internal::Type::BaseModel
+        extend Knockapi::Internal::Type::RequestParameters::Converter
+        include Knockapi::Internal::Type::RequestParameters
+
+        # A JSON encoded string containing the Microsoft Teams tenant object reference.
+        sig { returns(String) }
+        attr_accessor :ms_teams_tenant_object
+
+        sig do
+          params(
+            ms_teams_tenant_object: String,
+            request_options: T.any(Knockapi::RequestOptions, Knockapi::Internal::AnyHash)
+          )
+            .returns(T.attached_class)
+        end
+        def self.new(
+          # A JSON encoded string containing the Microsoft Teams tenant object reference.
+          ms_teams_tenant_object:,
+          request_options: {}
+        ); end
+        sig { override.returns({ms_teams_tenant_object: String, request_options: Knockapi::RequestOptions}) }
+        def to_hash; end
+      end
+    end
+  end
+end

data/rbi/knockapi/models/providers/ms_team_check_auth_response.rbi

@@ -0,0 +1,56 @@
+# typed: strong
+
+module Knockapi
+  module Models
+    module Providers
+      class MsTeamCheckAuthResponse < Knockapi::Internal::Type::BaseModel
+        # A Microsoft Teams connection object.
+        sig { returns(Knockapi::Models::Providers::MsTeamCheckAuthResponse::Connection) }
+        attr_reader :connection
+
+        sig do
+          params(
+            connection: T.any(Knockapi::Models::Providers::MsTeamCheckAuthResponse::Connection, Knockapi::Internal::AnyHash)
+          )
+            .void
+        end
+        attr_writer :connection
+
+        # The response from a Microsoft Teams auth check request.
+        sig do
+          params(
+            connection: T.any(Knockapi::Models::Providers::MsTeamCheckAuthResponse::Connection, Knockapi::Internal::AnyHash)
+          )
+            .returns(T.attached_class)
+        end
+        def self.new(
+          # A Microsoft Teams connection object.
+          connection:
+        ); end
+        sig { override.returns({connection: Knockapi::Models::Providers::MsTeamCheckAuthResponse::Connection}) }
+        def to_hash; end
+
+        class Connection < Knockapi::Internal::Type::BaseModel
+          # Whether the Microsoft Teams connection is valid.
+          sig { returns(T::Boolean) }
+          attr_accessor :ok
+
+          # The reason for the Microsoft Teams connection if it is not valid.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :reason
+
+          # A Microsoft Teams connection object.
+          sig { params(ok: T::Boolean, reason: T.nilable(String)).returns(T.attached_class) }
+          def self.new(
+            # Whether the Microsoft Teams connection is valid.
+            ok:,
+            # The reason for the Microsoft Teams connection if it is not valid.
+            reason: nil
+          ); end
+          sig { override.returns({ok: T::Boolean, reason: T.nilable(String)}) }
+          def to_hash; end
+        end
+      end
+    end
+  end
+end

data/rbi/knockapi/models/providers/ms_team_list_channels_params.rbi

@@ -0,0 +1,91 @@
+# typed: strong
+
+module Knockapi
+  module Models
+    module Providers
+      class MsTeamListChannelsParams < Knockapi::Internal::Type::BaseModel
+        extend Knockapi::Internal::Type::RequestParameters::Converter
+        include Knockapi::Internal::Type::RequestParameters
+
+        # A JSON encoded string containing the Microsoft Teams tenant object reference.
+        sig { returns(String) }
+        attr_accessor :ms_teams_tenant_object
+
+        # Microsoft Teams team ID.
+        sig { returns(String) }
+        attr_accessor :team_id
+
+        sig { returns(T.nilable(Knockapi::Models::Providers::MsTeamListChannelsParams::QueryOptions)) }
+        attr_reader :query_options
+
+        sig do
+          params(
+            query_options: T.any(Knockapi::Models::Providers::MsTeamListChannelsParams::QueryOptions, Knockapi::Internal::AnyHash)
+          )
+            .void
+        end
+        attr_writer :query_options
+
+        sig do
+          params(
+            ms_teams_tenant_object: String,
+            team_id: String,
+            query_options: T.any(Knockapi::Models::Providers::MsTeamListChannelsParams::QueryOptions, Knockapi::Internal::AnyHash),
+            request_options: T.any(Knockapi::RequestOptions, Knockapi::Internal::AnyHash)
+          )
+            .returns(T.attached_class)
+        end
+        def self.new(
+          # A JSON encoded string containing the Microsoft Teams tenant object reference.
+          ms_teams_tenant_object:,
+          # Microsoft Teams team ID.
+          team_id:,
+          query_options: nil,
+          request_options: {}
+        ); end
+        sig do
+          override
+            .returns(
+              {
+                ms_teams_tenant_object: String,
+                team_id: String,
+                query_options: Knockapi::Models::Providers::MsTeamListChannelsParams::QueryOptions,
+                request_options: Knockapi::RequestOptions
+              }
+            )
+        end
+        def to_hash; end
+
+        class QueryOptions < Knockapi::Internal::Type::BaseModel
+          # [OData param](https://learn.microsoft.com/en-us/graph/query-parameters) passed
+          # to the Microsoft Graph API to filter channels.
+          sig { returns(T.nilable(String)) }
+          attr_reader :filter
+
+          sig { params(filter: String).void }
+          attr_writer :filter
+
+          # [OData param](https://learn.microsoft.com/en-us/graph/query-parameters) passed
+          # to the Microsoft Graph API to select specific properties.
+          sig { returns(T.nilable(String)) }
+          attr_reader :select_
+
+          sig { params(select_: String).void }
+          attr_writer :select_
+
+          sig { params(filter: String, select_: String).returns(T.attached_class) }
+          def self.new(
+            # [OData param](https://learn.microsoft.com/en-us/graph/query-parameters) passed
+            # to the Microsoft Graph API to filter channels.
+            filter: nil,
+            # [OData param](https://learn.microsoft.com/en-us/graph/query-parameters) passed
+            # to the Microsoft Graph API to select specific properties.
+            select_: nil
+          ); end
+          sig { override.returns({filter: String, select_: String}) }
+          def to_hash; end
+        end
+      end
+    end
+  end
+end

data/rbi/knockapi/models/providers/ms_team_list_channels_response.rbi

@@ -0,0 +1,113 @@
+# typed: strong
+
+module Knockapi
+  module Models
+    module Providers
+      class MsTeamListChannelsResponse < Knockapi::Internal::Type::BaseModel
+        # List of Microsoft Teams channels.
+        sig { returns(T::Array[Knockapi::Models::Providers::MsTeamListChannelsResponse::MsTeamsChannel]) }
+        attr_accessor :ms_teams_channels
+
+        # The response from a Microsoft Teams provider request, containing a list of
+        # channels.
+        sig do
+          params(
+            ms_teams_channels: T::Array[
+              T.any(
+                Knockapi::Models::Providers::MsTeamListChannelsResponse::MsTeamsChannel,
+                Knockapi::Internal::AnyHash
+              )
+            ]
+          )
+            .returns(T.attached_class)
+        end
+        def self.new(
+          # List of Microsoft Teams channels.
+          ms_teams_channels:
+        ); end
+        sig do
+          override
+            .returns(
+              {ms_teams_channels: T::Array[Knockapi::Models::Providers::MsTeamListChannelsResponse::MsTeamsChannel]}
+            )
+        end
+        def to_hash; end
+
+        class MsTeamsChannel < Knockapi::Internal::Type::BaseModel
+          # Microsoft Teams channel ID.
+          sig { returns(String) }
+          attr_accessor :id
+
+          # Microsoft Teams channel name.
+          sig { returns(String) }
+          attr_accessor :display_name
+
+          # Microsoft Teams channel created date and time.
+          sig { returns(T.nilable(String)) }
+          attr_reader :created_date_time
+
+          sig { params(created_date_time: String).void }
+          attr_writer :created_date_time
+
+          # Microsoft Teams channel description.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :description
+
+          # Whether the Microsoft Teams channel is archived.
+          sig { returns(T.nilable(T::Boolean)) }
+          attr_reader :is_archived
+
+          sig { params(is_archived: T::Boolean).void }
+          attr_writer :is_archived
+
+          # Microsoft Teams channel membership type.
+          sig { returns(T.nilable(String)) }
+          attr_reader :membership_type
+
+          sig { params(membership_type: String).void }
+          attr_writer :membership_type
+
+          sig do
+            params(
+              id: String,
+              display_name: String,
+              created_date_time: String,
+              description: T.nilable(String),
+              is_archived: T::Boolean,
+              membership_type: String
+            )
+              .returns(T.attached_class)
+          end
+          def self.new(
+            # Microsoft Teams channel ID.
+            id:,
+            # Microsoft Teams channel name.
+            display_name:,
+            # Microsoft Teams channel created date and time.
+            created_date_time: nil,
+            # Microsoft Teams channel description.
+            description: nil,
+            # Whether the Microsoft Teams channel is archived.
+            is_archived: nil,
+            # Microsoft Teams channel membership type.
+            membership_type: nil
+          ); end
+          sig do
+            override
+              .returns(
+                {
+                  id: String,
+                  display_name: String,
+                  created_date_time: String,
+                  description: T.nilable(String),
+                  is_archived: T::Boolean,
+                  membership_type: String
+                }
+              )
+          end
+          def to_hash; end
+        end
+      end
+    end
+  end
+end