knockapi 0.6.1 → 1.0.0

data/lib/knockapi/models/object_list_subscriptions_params.rb

@@ -0,0 +1,122 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Models
+    # @see Knockapi::Resources::Objects#list_subscriptions
+    class ObjectListSubscriptionsParams < Knockapi::Internal::Type::BaseModel
+      extend Knockapi::Internal::Type::RequestParameters::Converter
+      include Knockapi::Internal::Type::RequestParameters
+
+      # @!attribute after
+      #   The cursor to fetch entries after.
+      #
+      #   @return [String, nil]
+      optional :after, String
+
+      # @!attribute before
+      #   The cursor to fetch entries before.
+      #
+      #   @return [String, nil]
+      optional :before, String
+
+      # @!attribute include
+      #   Additional fields to include in the response.
+      #
+      #   @return [Array<Symbol, Knockapi::Models::ObjectListSubscriptionsParams::Include>, nil]
+      optional :include,
+               -> { Knockapi::Internal::Type::ArrayOf[enum: Knockapi::Models::ObjectListSubscriptionsParams::Include] }
+
+      # @!attribute mode
+      #   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.
+      #
+      #   @return [Symbol, Knockapi::Models::ObjectListSubscriptionsParams::Mode, nil]
+      optional :mode, enum: -> { Knockapi::Models::ObjectListSubscriptionsParams::Mode }
+
+      # @!attribute objects
+      #   Objects to filter by (only used if mode is `recipient`).
+      #
+      #   @return [Array<Knockapi::Models::ObjectListSubscriptionsParams::Object>, nil]
+      optional :objects,
+               -> { Knockapi::Internal::Type::ArrayOf[Knockapi::Models::ObjectListSubscriptionsParams::Object] }
+
+      # @!attribute page_size
+      #   The number of items per page.
+      #
+      #   @return [Integer, nil]
+      optional :page_size, Integer
+
+      # @!attribute recipients
+      #   Recipients to filter by (only used if mode is `object`).
+      #
+      #   @return [Array<String, Knockapi::Models::RecipientReference::ObjectReference>, nil]
+      optional :recipients,
+               -> { Knockapi::Internal::Type::ArrayOf[union: Knockapi::Models::RecipientReference] }
+
+      # @!method initialize(after: nil, before: nil, include: nil, mode: nil, objects: nil, page_size: nil, recipients: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Knockapi::Models::ObjectListSubscriptionsParams} for more details.
+      #
+      #   @param after [String] The cursor to fetch entries after.
+      #
+      #   @param before [String] The cursor to fetch entries before.
+      #
+      #   @param include [Array<Symbol, Knockapi::Models::ObjectListSubscriptionsParams::Include>] Additional fields to include in the response.
+      #
+      #   @param mode [Symbol, Knockapi::Models::ObjectListSubscriptionsParams::Mode] Mode of the request. `recipient` to list the objects that the provided object is
+      #   ...
+      #
+      #   @param objects [Array<Knockapi::Models::ObjectListSubscriptionsParams::Object>] Objects to filter by (only used if mode is `recipient`).
+      #
+      #   @param page_size [Integer] The number of items per page.
+      #
+      #   @param recipients [Array<String, Knockapi::Models::RecipientReference::ObjectReference>] Recipients to filter by (only used if mode is `object`).
+      #
+      #   @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
+
+      module Include
+        extend Knockapi::Internal::Type::Enum
+
+        PREFERENCES = :preferences
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # 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.
+      module Mode
+        extend Knockapi::Internal::Type::Enum
+
+        RECIPIENT = :recipient
+        OBJECT = :object
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      class Object < Knockapi::Internal::Type::BaseModel
+        # @!attribute id
+        #   An identifier for the recipient object.
+        #
+        #   @return [String, nil]
+        optional :id, String
+
+        # @!attribute collection
+        #   The collection the recipient object belongs to.
+        #
+        #   @return [String, nil]
+        optional :collection, String
+
+        # @!method initialize(id: nil, collection: nil)
+        #   A reference to a recipient object.
+        #
+        #   @param id [String] An identifier for the recipient object.
+        #
+        #   @param collection [String] The collection the recipient object belongs to.
+      end
+    end
+  end
+end

data/lib/knockapi/models/object_set_channel_data_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Models
+    # @see Knockapi::Resources::Objects#set_channel_data
+    class ObjectSetChannelDataParams < Knockapi::Models::Recipients::ChannelDataRequest
+      extend Knockapi::Internal::Type::RequestParameters::Converter
+      include Knockapi::Internal::Type::RequestParameters
+
+      # @!method initialize(request_options: {})
+      #   @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/knockapi/models/object_set_params.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Models
+    # @see Knockapi::Resources::Objects#set
+    class ObjectSetParams < Knockapi::Internal::Type::BaseModel
+      extend Knockapi::Internal::Type::RequestParameters::Converter
+      include Knockapi::Internal::Type::RequestParameters
+
+      # @!attribute channel_data
+      #   A request to set channel data for a type of channel inline.
+      #
+      #   @return [Hash{Symbol=>Knockapi::Models::Recipients::ChannelDataRequest}, nil]
+      optional :channel_data,
+               -> { Knockapi::Internal::Type::HashOf[Knockapi::Models::Recipients::ChannelDataRequest] }
+
+      # @!attribute locale
+      #   The locale of the object. Used for
+      #   [message localization](/concepts/translations).
+      #
+      #   @return [String, nil]
+      optional :locale, String, nil?: true
+
+      # @!attribute preferences
+      #   Inline set preferences for a recipient, where the key is the preference set id.
+      #
+      #   @return [Hash{Symbol=>Knockapi::Models::Recipients::PreferenceSetRequest}, nil]
+      optional :preferences,
+               -> { Knockapi::Internal::Type::HashOf[Knockapi::Models::Recipients::PreferenceSetRequest] }
+
+      # @!attribute timezone
+      #   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).
+      #
+      #   @return [String, nil]
+      optional :timezone, String, nil?: true
+
+      # @!method initialize(channel_data: nil, locale: nil, preferences: nil, timezone: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Knockapi::Models::ObjectSetParams} for more details.
+      #
+      #   @param channel_data [Hash{Symbol=>Knockapi::Models::Recipients::ChannelDataRequest}] A request to set channel data for a type of channel inline.
+      #
+      #   @param locale [String, nil] The locale of the object. Used for [message localization](/concepts/translations
+      #   ...
+      #
+      #   @param preferences [Hash{Symbol=>Knockapi::Models::Recipients::PreferenceSetRequest}] Inline set preferences for a recipient, where the key is the preference set id.
+      #
+      #   @param timezone [String, nil] The timezone of the object. Must be a valid [tz database time zone string](https
+      #   ...
+      #
+      #   @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/knockapi/models/object_set_preferences_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Models
+    # @see Knockapi::Resources::Objects#set_preferences
+    class ObjectSetPreferencesParams < Knockapi::Models::Recipients::PreferenceSetRequest
+      extend Knockapi::Internal::Type::RequestParameters::Converter
+      include Knockapi::Internal::Type::RequestParameters
+
+      # @!method initialize(request_options: {})
+      #   @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/knockapi/models/object_unset_channel_data_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Models
+    # @see Knockapi::Resources::Objects#unset_channel_data
+    class ObjectUnsetChannelDataParams < Knockapi::Internal::Type::BaseModel
+      extend Knockapi::Internal::Type::RequestParameters::Converter
+      include Knockapi::Internal::Type::RequestParameters
+
+      # @!method initialize(request_options: {})
+      #   @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/knockapi/models/objects/bulk_add_subscriptions_params.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Models
+    module Objects
+      # @see Knockapi::Resources::Objects::Bulk#add_subscriptions
+      class BulkAddSubscriptionsParams < Knockapi::Internal::Type::BaseModel
+        extend Knockapi::Internal::Type::RequestParameters::Converter
+        include Knockapi::Internal::Type::RequestParameters
+
+        # @!attribute subscriptions
+        #   A list of subscriptions.
+        #
+        #   @return [Array<Knockapi::Models::Objects::BulkAddSubscriptionsParams::Subscription>]
+        required :subscriptions,
+                 -> { Knockapi::Internal::Type::ArrayOf[Knockapi::Models::Objects::BulkAddSubscriptionsParams::Subscription] }
+
+        # @!method initialize(subscriptions:, request_options: {})
+        #   @param subscriptions [Array<Knockapi::Models::Objects::BulkAddSubscriptionsParams::Subscription>] A list of subscriptions.
+        #
+        #   @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
+
+        class Subscription < Knockapi::Internal::Type::BaseModel
+          # @!attribute recipients
+          #   The recipients of the subscription. You can subscribe up to 100 recipients to an
+          #   object at a time.
+          #
+          #   @return [Array<String, Knockapi::Models::InlineIdentifyUserRequest, Knockapi::Models::InlineObjectRequest>]
+          required :recipients, -> { Knockapi::Internal::Type::ArrayOf[union: Knockapi::Models::RecipientRequest] }
+
+          # @!attribute properties
+          #   The custom properties associated with the subscription relationship.
+          #
+          #   @return [Hash{Symbol=>Object}, nil]
+          optional :properties,
+                   Knockapi::Internal::Type::HashOf[Knockapi::Internal::Type::Unknown],
+                   nil?: true
+
+          # @!method initialize(recipients:, properties: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {Knockapi::Models::Objects::BulkAddSubscriptionsParams::Subscription} for more
+          #   details.
+          #
+          #   @param recipients [Array<String, Knockapi::Models::InlineIdentifyUserRequest, Knockapi::Models::InlineObjectRequest>] The recipients of the subscription. You can subscribe up to 100 recipients to an
+          #   ...
+          #
+          #   @param properties [Hash{Symbol=>Object}, nil] The custom properties associated with the subscription relationship.
+        end
+      end
+    end
+  end
+end

data/lib/knockapi/models/objects/bulk_delete_params.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Models
+    module Objects
+      # @see Knockapi::Resources::Objects::Bulk#delete
+      class BulkDeleteParams < Knockapi::Internal::Type::BaseModel
+        extend Knockapi::Internal::Type::RequestParameters::Converter
+        include Knockapi::Internal::Type::RequestParameters
+
+        # @!attribute object_ids
+        #   List of object IDs to delete.
+        #
+        #   @return [Array<String>]
+        required :object_ids, Knockapi::Internal::Type::ArrayOf[String]
+
+        # @!method initialize(object_ids:, request_options: {})
+        #   @param object_ids [Array<String>] List of object IDs to delete.
+        #
+        #   @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/knockapi/models/objects/bulk_set_params.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Models
+    module Objects
+      # @see Knockapi::Resources::Objects::Bulk#set
+      class BulkSetParams < Knockapi::Internal::Type::BaseModel
+        extend Knockapi::Internal::Type::RequestParameters::Converter
+        include Knockapi::Internal::Type::RequestParameters
+
+        # @!attribute objects
+        #   A list of objects.
+        #
+        #   @return [Array<Knockapi::Models::InlineObjectRequest>]
+        required :objects, -> { Knockapi::Internal::Type::ArrayOf[Knockapi::Models::InlineObjectRequest] }
+
+        # @!method initialize(objects:, request_options: {})
+        #   @param objects [Array<Knockapi::Models::InlineObjectRequest>] A list of objects.
+        #
+        #   @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/knockapi/models/page_info.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Models
+    class PageInfo < Knockapi::Internal::Type::BaseModel
+      # @!attribute _typename
+      #   The typename of the schema.
+      #
+      #   @return [String]
+      required :_typename, String, api_name: :__typename
+
+      # @!attribute page_size
+      #   The number of items per page.
+      #
+      #   @return [Integer]
+      required :page_size, Integer
+
+      # @!attribute after
+      #   The cursor to fetch entries after.
+      #
+      #   @return [String, nil]
+      optional :after, String, nil?: true
+
+      # @!attribute before
+      #   The cursor to fetch entries before.
+      #
+      #   @return [String, nil]
+      optional :before, String, nil?: true
+
+      # @!method initialize(_typename:, page_size:, after: nil, before: nil)
+      #   Pagination information for a list of resources.
+      #
+      #   @param _typename [String] The typename of the schema.
+      #
+      #   @param page_size [Integer] The number of items per page.
+      #
+      #   @param after [String, nil] The cursor to fetch entries after.
+      #
+      #   @param before [String, nil] The cursor to fetch entries before.
+    end
+  end
+end

data/lib/knockapi/models/providers/ms_team_check_auth_params.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Models
+    module Providers
+      # @see Knockapi::Resources::Providers::MsTeams#check_auth
+      class MsTeamCheckAuthParams < Knockapi::Internal::Type::BaseModel
+        extend Knockapi::Internal::Type::RequestParameters::Converter
+        include Knockapi::Internal::Type::RequestParameters
+
+        # @!attribute ms_teams_tenant_object
+        #   A JSON encoded string containing the Microsoft Teams tenant object reference.
+        #
+        #   @return [String]
+        required :ms_teams_tenant_object, String
+
+        # @!method initialize(ms_teams_tenant_object:, request_options: {})
+        #   @param ms_teams_tenant_object [String] A JSON encoded string containing the Microsoft Teams tenant object reference.
+        #
+        #   @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/knockapi/models/providers/ms_team_check_auth_response.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Models
+    module Providers
+      # @see Knockapi::Resources::Providers::MsTeams#check_auth
+      class MsTeamCheckAuthResponse < Knockapi::Internal::Type::BaseModel
+        # @!attribute connection
+        #   A Microsoft Teams connection object.
+        #
+        #   @return [Knockapi::Models::Providers::MsTeamCheckAuthResponse::Connection]
+        required :connection, -> { Knockapi::Models::Providers::MsTeamCheckAuthResponse::Connection }
+
+        # @!method initialize(connection:)
+        #   The response from a Microsoft Teams auth check request.
+        #
+        #   @param connection [Knockapi::Models::Providers::MsTeamCheckAuthResponse::Connection] A Microsoft Teams connection object.
+
+        # @see Knockapi::Models::Providers::MsTeamCheckAuthResponse#connection
+        class Connection < Knockapi::Internal::Type::BaseModel
+          # @!attribute ok
+          #   Whether the Microsoft Teams connection is valid.
+          #
+          #   @return [Boolean]
+          required :ok, Knockapi::Internal::Type::Boolean
+
+          # @!attribute reason
+          #   The reason for the Microsoft Teams connection if it is not valid.
+          #
+          #   @return [String, nil]
+          optional :reason, String, nil?: true
+
+          # @!method initialize(ok:, reason: nil)
+          #   A Microsoft Teams connection object.
+          #
+          #   @param ok [Boolean] Whether the Microsoft Teams connection is valid.
+          #
+          #   @param reason [String, nil] The reason for the Microsoft Teams connection if it is not valid.
+        end
+      end
+    end
+  end
+end

data/lib/knockapi/models/providers/ms_team_list_channels_params.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Models
+    module Providers
+      # @see Knockapi::Resources::Providers::MsTeams#list_channels
+      class MsTeamListChannelsParams < Knockapi::Internal::Type::BaseModel
+        extend Knockapi::Internal::Type::RequestParameters::Converter
+        include Knockapi::Internal::Type::RequestParameters
+
+        # @!attribute ms_teams_tenant_object
+        #   A JSON encoded string containing the Microsoft Teams tenant object reference.
+        #
+        #   @return [String]
+        required :ms_teams_tenant_object, String
+
+        # @!attribute team_id
+        #   Microsoft Teams team ID.
+        #
+        #   @return [String]
+        required :team_id, String
+
+        # @!attribute query_options
+        #
+        #   @return [Knockapi::Models::Providers::MsTeamListChannelsParams::QueryOptions, nil]
+        optional :query_options, -> { Knockapi::Models::Providers::MsTeamListChannelsParams::QueryOptions }
+
+        # @!method initialize(ms_teams_tenant_object:, team_id:, query_options: nil, request_options: {})
+        #   @param ms_teams_tenant_object [String] A JSON encoded string containing the Microsoft Teams tenant object reference.
+        #
+        #   @param team_id [String] Microsoft Teams team ID.
+        #
+        #   @param query_options [Knockapi::Models::Providers::MsTeamListChannelsParams::QueryOptions]
+        #
+        #   @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
+
+        class QueryOptions < Knockapi::Internal::Type::BaseModel
+          # @!attribute filter
+          #   [OData param](https://learn.microsoft.com/en-us/graph/query-parameters) passed
+          #   to the Microsoft Graph API to filter channels.
+          #
+          #   @return [String, nil]
+          optional :filter, String, api_name: :$filter
+
+          # @!attribute select_
+          #   [OData param](https://learn.microsoft.com/en-us/graph/query-parameters) passed
+          #   to the Microsoft Graph API to select specific properties.
+          #
+          #   @return [String, nil]
+          optional :select_, String, api_name: :$select
+
+          # @!method initialize(filter: nil, select_: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {Knockapi::Models::Providers::MsTeamListChannelsParams::QueryOptions} for more
+          #   details.
+          #
+          #   @param filter [String] [OData param](https://learn.microsoft.com/en-us/graph/query-parameters) passed t
+          #   ...
+          #
+          #   @param select_ [String] [OData param](https://learn.microsoft.com/en-us/graph/query-parameters) passed t
+          #   ...
+        end
+      end
+    end
+  end
+end

data/lib/knockapi/models/providers/ms_team_list_channels_response.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Models
+    module Providers
+      # @see Knockapi::Resources::Providers::MsTeams#list_channels
+      class MsTeamListChannelsResponse < Knockapi::Internal::Type::BaseModel
+        # @!attribute ms_teams_channels
+        #   List of Microsoft Teams channels.
+        #
+        #   @return [Array<Knockapi::Models::Providers::MsTeamListChannelsResponse::MsTeamsChannel>]
+        required :ms_teams_channels,
+                 -> { Knockapi::Internal::Type::ArrayOf[Knockapi::Models::Providers::MsTeamListChannelsResponse::MsTeamsChannel] }
+
+        # @!method initialize(ms_teams_channels:)
+        #   The response from a Microsoft Teams provider request, containing a list of
+        #   channels.
+        #
+        #   @param ms_teams_channels [Array<Knockapi::Models::Providers::MsTeamListChannelsResponse::MsTeamsChannel>] List of Microsoft Teams channels.
+
+        class MsTeamsChannel < Knockapi::Internal::Type::BaseModel
+          # @!attribute id
+          #   Microsoft Teams channel ID.
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!attribute display_name
+          #   Microsoft Teams channel name.
+          #
+          #   @return [String]
+          required :display_name, String, api_name: :displayName
+
+          # @!attribute created_date_time
+          #   Microsoft Teams channel created date and time.
+          #
+          #   @return [String, nil]
+          optional :created_date_time, String, api_name: :createdDateTime
+
+          # @!attribute description
+          #   Microsoft Teams channel description.
+          #
+          #   @return [String, nil]
+          optional :description, String, nil?: true
+
+          # @!attribute is_archived
+          #   Whether the Microsoft Teams channel is archived.
+          #
+          #   @return [Boolean, nil]
+          optional :is_archived, Knockapi::Internal::Type::Boolean, api_name: :isArchived
+
+          # @!attribute membership_type
+          #   Microsoft Teams channel membership type.
+          #
+          #   @return [String, nil]
+          optional :membership_type, String, api_name: :membershipType
+
+          # @!method initialize(id:, display_name:, created_date_time: nil, description: nil, is_archived: nil, membership_type: nil)
+          #   @param id [String] Microsoft Teams channel ID.
+          #
+          #   @param display_name [String] Microsoft Teams channel name.
+          #
+          #   @param created_date_time [String] Microsoft Teams channel created date and time.
+          #
+          #   @param description [String, nil] Microsoft Teams channel description.
+          #
+          #   @param is_archived [Boolean] Whether the Microsoft Teams channel is archived.
+          #
+          #   @param membership_type [String] Microsoft Teams channel membership type.
+        end
+      end
+    end
+  end
+end

data/lib/knockapi/models/providers/ms_team_list_teams_params.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Models
+    module Providers
+      # @see Knockapi::Resources::Providers::MsTeams#list_teams
+      class MsTeamListTeamsParams < Knockapi::Internal::Type::BaseModel
+        extend Knockapi::Internal::Type::RequestParameters::Converter
+        include Knockapi::Internal::Type::RequestParameters
+
+        # @!attribute ms_teams_tenant_object
+        #   A JSON encoded string containing the Microsoft Teams tenant object reference.
+        #
+        #   @return [String]
+        required :ms_teams_tenant_object, String
+
+        # @!attribute query_options
+        #
+        #   @return [Knockapi::Models::Providers::MsTeamListTeamsParams::QueryOptions, nil]
+        optional :query_options, -> { Knockapi::Models::Providers::MsTeamListTeamsParams::QueryOptions }
+
+        # @!method initialize(ms_teams_tenant_object:, query_options: nil, request_options: {})
+        #   @param ms_teams_tenant_object [String] A JSON encoded string containing the Microsoft Teams tenant object reference.
+        #
+        #   @param query_options [Knockapi::Models::Providers::MsTeamListTeamsParams::QueryOptions]
+        #
+        #   @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
+
+        class QueryOptions < Knockapi::Internal::Type::BaseModel
+          # @!attribute filter
+          #   [OData param](https://learn.microsoft.com/en-us/graph/query-parameters) passed
+          #   to the Microsoft Graph API to filter teams.
+          #
+          #   @return [String, nil]
+          optional :filter, String, api_name: :$filter
+
+          # @!attribute select_
+          #   [OData param](https://learn.microsoft.com/en-us/graph/query-parameters) passed
+          #   to the Microsoft Graph API to select fields on a team.
+          #
+          #   @return [String, nil]
+          optional :select_, String, api_name: :$select
+
+          # @!attribute skiptoken
+          #   [OData param](https://learn.microsoft.com/en-us/graph/query-parameters) passed
+          #   to the Microsoft Graph API to retrieve the next page of results.
+          #
+          #   @return [String, nil]
+          optional :skiptoken, String, api_name: :$skiptoken
+
+          # @!attribute top
+          #   [OData param](https://learn.microsoft.com/en-us/graph/query-parameters) passed
+          #   to the Microsoft Graph API to limit the number of teams returned.
+          #
+          #   @return [Integer, nil]
+          optional :top, Integer, api_name: :$top
+
+          # @!method initialize(filter: nil, select_: nil, skiptoken: nil, top: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {Knockapi::Models::Providers::MsTeamListTeamsParams::QueryOptions} for more
+          #   details.
+          #
+          #   @param filter [String] [OData param](https://learn.microsoft.com/en-us/graph/query-parameters) passed t
+          #   ...
+          #
+          #   @param select_ [String] [OData param](https://learn.microsoft.com/en-us/graph/query-parameters) passed t
+          #   ...
+          #
+          #   @param skiptoken [String] [OData param](https://learn.microsoft.com/en-us/graph/query-parameters) passed t
+          #   ...
+          #
+          #   @param top [Integer] [OData param](https://learn.microsoft.com/en-us/graph/query-parameters) passed t
+          #   ...
+        end
+      end
+    end
+  end
+end