Module: FinchAPI::Type::RequestParameters Private

Included in:
Models::AccessTokenCreateParams, Models::AccountDisconnectParams, Models::AccountIntrospectParams, Models::Connect::SessionNewParams, Models::Connect::SessionReauthenticateParams, Models::HRIS::BenefitCreateParams, Models::HRIS::BenefitListParams, Models::HRIS::BenefitListSupportedBenefitsParams, Models::HRIS::BenefitRetrieveParams, Models::HRIS::BenefitUpdateParams, Models::HRIS::Benefits::IndividualEnrollManyParams, Models::HRIS::Benefits::IndividualEnrolledIDsParams, Models::HRIS::Benefits::IndividualRetrieveManyBenefitsParams, Models::HRIS::Benefits::IndividualUnenrollManyParams, Models::HRIS::CompanyRetrieveParams, Models::HRIS::DirectoryListIndividualsParams, Models::HRIS::DirectoryListParams, Models::HRIS::DocumentListParams, Models::HRIS::DocumentRetreiveParams, Models::HRIS::EmploymentRetrieveManyParams, Models::HRIS::IndividualRetrieveManyParams, Models::HRIS::PayStatementRetrieveManyParams, Models::HRIS::PaymentListParams, Models::Jobs::AutomatedCreateParams, Models::Jobs::AutomatedListParams, Models::Jobs::AutomatedRetrieveParams, Models::Jobs::ManualRetrieveParams, Models::Payroll::PayGroupListParams, Models::Payroll::PayGroupRetrieveParams, Models::ProviderListParams, Models::RequestForwardingForwardParams, Models::Sandbox::CompanyUpdateParams, Models::Sandbox::ConnectionCreateParams, Models::Sandbox::Connections::AccountCreateParams, Models::Sandbox::Connections::AccountUpdateParams, Models::Sandbox::DirectoryCreateParams, Models::Sandbox::EmploymentUpdateParams, Models::Sandbox::IndividualUpdateParams, Models::Sandbox::JobCreateParams, Models::Sandbox::Jobs::ConfigurationRetrieveParams, Models::Sandbox::Jobs::ConfigurationUpdateParams, Models::Sandbox::PaymentCreateParams
Defined in:
lib/finch-api/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 ⇒ FinchAPI::RequestOptions, 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.

Options to specify HTTP behaviour for this request.

Returns:



3
4
5
 
# File 'lib/finch-api/type/request_parameters.rb', line 3

def request_options
  @request_options
end

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) 


13
14
15
16
17
18
 
# File 'lib/finch-api/type/request_parameters.rb', line 13

def self.included(mod)
  return unless mod <= FinchAPI::BaseModel

  mod.extend(FinchAPI::Type::RequestParameters::Converter)
  mod.optional(:request_options, FinchAPI::RequestOptions)
end