Module: Knockapi::Internal::Type::RequestParameters Private

Included in:
Models::AudienceAddMembersParams, Models::AudienceListMembersParams, Models::AudienceRemoveMembersParams, Models::BulkOperationGetParams, Models::Channels::BulkUpdateMessageStatusParams, Models::Integrations::CensusCustomDestinationParams, Models::Integrations::HightouchEmbeddedDestinationParams, Models::MessageArchiveParams, Models::MessageGetContentParams, Models::MessageGetParams, Models::MessageListActivitiesParams, Models::MessageListDeliveryLogsParams, Models::MessageListEventsParams, Models::MessageListParams, Models::MessageMarkAsInteractedParams, Models::MessageMarkAsReadParams, Models::MessageMarkAsSeenParams, Models::MessageMarkAsUnreadParams, Models::MessageMarkAsUnseenParams, Models::MessageUnarchiveParams, Models::Messages::BatchArchiveParams, Models::Messages::BatchGetContentParams, Models::Messages::BatchMarkAsInteractedParams, Models::Messages::BatchMarkAsReadParams, Models::Messages::BatchMarkAsSeenParams, Models::Messages::BatchMarkAsUnreadParams, Models::Messages::BatchMarkAsUnseenParams, Models::Messages::BatchUnarchiveParams, Models::ObjectAddSubscriptionsParams, Models::ObjectDeleteParams, Models::ObjectDeleteSubscriptionsParams, Models::ObjectGetChannelDataParams, Models::ObjectGetParams, Models::ObjectGetPreferencesParams, Models::ObjectListMessagesParams, Models::ObjectListParams, Models::ObjectListPreferencesParams, Models::ObjectListSchedulesParams, Models::ObjectListSubscriptionsParams, Models::ObjectSetChannelDataParams, Models::ObjectSetParams, Models::ObjectSetPreferencesParams, Models::ObjectUnsetChannelDataParams, Models::Objects::BulkAddSubscriptionsParams, Models::Objects::BulkDeleteParams, Models::Objects::BulkDeleteSubscriptionsParams, Models::Objects::BulkSetParams, Models::Providers::MsTeamCheckAuthParams, Models::Providers::MsTeamListChannelsParams, Models::Providers::MsTeamListTeamsParams, Models::Providers::MsTeamRevokeAccessParams, Models::Providers::SlackCheckAuthParams, Models::Providers::SlackListChannelsParams, Models::Providers::SlackRevokeAccessParams, Models::ScheduleCreateParams, Models::ScheduleDeleteParams, Models::ScheduleListParams, Models::ScheduleUpdateParams, Models::Schedules::BulkCreateParams, Models::TenantDeleteParams, Models::TenantGetParams, Models::TenantListParams, Models::TenantSetParams, Models::Tenants::BulkDeleteParams, Models::Tenants::BulkSetParams, Models::UserDeleteParams, Models::UserGetChannelDataParams, Models::UserGetParams, Models::UserGetPreferencesParams, Models::UserListMessagesParams, Models::UserListParams, Models::UserListPreferencesParams, Models::UserListSchedulesParams, Models::UserListSubscriptionsParams, Models::UserMergeParams, Models::UserSetChannelDataParams, Models::UserSetPreferencesParams, Models::UserUnsetChannelDataParams, Models::UserUpdateParams, Models::Users::BulkDeleteParams, Models::Users::BulkIdentifyParams, Models::Users::BulkSetPreferencesParams, Models::Users::FeedGetSettingsParams, Models::Users::FeedListItemsParams, Models::Users::GuideGetChannelParams, Models::Users::GuideMarkMessageAsArchivedParams, Models::Users::GuideMarkMessageAsInteractedParams, Models::Users::GuideMarkMessageAsSeenParams, Models::WorkflowCancelParams, Models::WorkflowTriggerParams
Defined in:
lib/knockapi/internal/type/request_parameters.rb

This module is part of a private API. You should avoid using this module if possible, as it may be removed or be changed in the future.

Defined Under Namespace

Modules: Converter

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Attribute Details

#request_options ⇒ Object

Options to specify HTTP behaviour for this request.

@return [Knockapi::RequestOptions, Hash{Symbol=>Object}]




# File 'lib/knockapi/internal/type/request_parameters.rb', line 8

Class Method Details

.included(mod) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Parameters:

  • mod (Module)

Raises:

  • (ArgumentError) 


14
15
16
17
18
 
# File 'lib/knockapi/internal/type/request_parameters.rb', line 14

def self.included(mod)
  raise ArgumentError.new(mod) unless mod <= Knockapi::Internal::Type::BaseModel

  mod.optional(:request_options, Knockapi::RequestOptions)
end