Module: VitableConnect::Internal::Type::RequestParameters Private

Included in:
Models::AuthIssueAccessTokenParams, Models::EmployeeListEnrollmentsParams, Models::EmployeeRetrieveParams, Models::EmployeeUpdateParams, Models::EmployerCreateParams, Models::EmployerEnsurePayrollIntegrationEmailParams, Models::EmployerListBenefitPlanYearEnrollmentsParams, Models::EmployerListBenefitPlanYearsParams, Models::EmployerListEmployeesParams, Models::EmployerListHRISProvidersParams, Models::EmployerListInvoicesParams, Models::EmployerListParams, Models::EmployerListPayrollDeductionStatementsParams, Models::EmployerRetrieveBenefitPlanYearParams, Models::EmployerRetrieveHRISParams, Models::EmployerRetrieveInvoicePdfParams, Models::EmployerRetrieveParams, Models::EmployerRetrievePayrollAccessSetupParams, Models::EmployerSubmitCensusSyncParams, Models::EmployerSubmitPayrollAccessSetupParams, Models::EmployerUpdateParams, Models::EmployerUpdateSettingsParams, Models::EnrollmentReissueParams, Models::EnrollmentRetrieveParams, Models::EnrollmentTerminateParams, Models::GroupCreateParams, Models::GroupListParams, Models::GroupRetrieveParams, Models::GroupUpdateParams, Models::Groups::Members::SyncRetrieveParams, Models::Groups::Members::SyncSubmitParams, Models::MemberListDependentsParams, Models::MemberListEmploymentsParams, Models::MemberListEnrollmentsParams, Models::MemberListIDCardsParams, Models::MemberListParams, Models::MemberListQualifyingLifeEventsParams, Models::MemberRetrieveHouseholdParams, Models::MemberRetrieveParams, Models::OrganizationCreateParams, Models::OrganizationListParams, Models::PlanListParams, Models::WebhookEventListDeliveriesParams, Models::WebhookEventListParams, Models::WebhookEventRetrieveParams
Defined in:
lib/vitable_connect/internal/type/request_parameters.rb,
sig/vitable_connect/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.

Defined Under Namespace

Modules: Converter

Constant Summary collapse

VitableConnect =

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

Returns:

  • (:request_opts) 

      
    

  




  
Instance Attribute Summary collapse

  




  
    

      Class Method Summary
      collapse
    


    
    
  


  

    
Instance Attribute Details

    
      
      
      

  

  
    #request_options  ⇒ VitableConnect::request_opts 
  

  

  


  

    

  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.


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


  





  

Returns:


    
  
    
  • 
      
      
        (VitableConnect::request_opts)
      
      
      
    
    • 
  





  

    
      




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

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

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