Module: SurgeAPI::Internal::Type::RequestParameters Private

Included in:
Models::AccountArchiveParams, Models::AccountCreateParams, Models::AccountRetrieveStatusParams, Models::AccountUpdateParams, Models::BlastCreateParams, Models::CampaignCreateParams, Models::ContactCreateParams, Models::ContactListParams, Models::ContactRetrieveParams, Models::ContactUpdateParams, Models::MessageCreateParams, Models::MessageListParams, Models::MessageRetrieveParams, Models::PhoneNumberListParams, Models::PhoneNumberPurchaseParams, Models::UserCreateParams, Models::UserCreateTokenParams, Models::UserDeleteParams, Models::UserRetrieveParams, Models::UserUpdateParams, Models::VerificationCheckParams, Models::VerificationCreateParams, Models::WebhookUnwrapParams
Defined in:
lib/surge_api/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 [SurgeAPI::RequestOptions, Hash{Symbol=>Object}]




# File 'lib/surge_api/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/surge_api/internal/type/request_parameters.rb', line 14

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

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