Module: Knockapi::Internal::Type::RequestParameters::Converter 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::ObjectUnsetPreferencesParams, 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::UserUnsetPreferencesParams, 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::WorkflowRecipientRunGetParams, Models::WorkflowRecipientRunListParams, Models::WorkflowTriggerParams
Defined in:
lib/knockapi/internal/type/request_parameters.rb,
sig/knockapi/internal/type/request_parameters.rbs

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.

Instance Method Summary collapse

Instance Method Details

#dump_request(params) ⇒ Array(Object, Hash{Symbol=>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:

Returns:



27
28
29
30
31
32
33
34
35
36
37
 
# File 'lib/knockapi/internal/type/request_parameters.rb', line 27

def dump_request(params)
  state = {can_retry: true}
  case (dumped = dump(params, state: state))
  in Hash
    options = Knockapi::Internal::Util.coerce_hash!(dumped[:request_options]).to_h
    request_options = state.fetch(:can_retry) ? options : {**options, max_retries: 0}
    [dumped.except(:request_options), request_options]
  else
    [dumped, nil]
  end
end