Module: GrowsurfRuby::Internal::Type::RequestParameters Private

Included in:
Models::AccountCreateParams, Models::Campaign::CommissionApproveParams, Models::Campaign::CommissionDeleteParams, Models::Campaign::ParticipantAddParams, Models::Campaign::ParticipantBulkDeleteParams, Models::Campaign::ParticipantCancelDelayedReferralParams, Models::Campaign::ParticipantDeleteParams, Models::Campaign::ParticipantEmailParams, Models::Campaign::ParticipantGetPayoutDestinationParams, Models::Campaign::ParticipantListActivityLogsParams, Models::Campaign::ParticipantListCommissionsParams, Models::Campaign::ParticipantListPayoutsParams, Models::Campaign::ParticipantListReferralsParams, Models::Campaign::ParticipantListRewardsParams, Models::Campaign::ParticipantRecordTransactionParams, Models::Campaign::ParticipantRefundTransactionParams, Models::Campaign::ParticipantRequestPayoutDestinationConfirmationParams, Models::Campaign::ParticipantRetrieveAnalyticsParams, Models::Campaign::ParticipantRetrieveParams, Models::Campaign::ParticipantSendInvitesParams, Models::Campaign::ParticipantTriggerReferralParams, Models::Campaign::ParticipantUpdateParams, Models::Campaign::RewardApproveParams, Models::Campaign::RewardCreateParams, Models::Campaign::RewardDeleteParams, Models::Campaign::RewardFulfillParams, Models::Campaign::RewardUpdateParams, Models::Campaign::WebhookCreateParams, Models::Campaign::WebhookDeleteParams, Models::Campaign::WebhookTestParams, Models::Campaign::WebhookUpdateParams, Models::CampaignCreateAffiliateInviteParams, Models::CampaignCreateMobileParticipantTokenParams, Models::CampaignCreateParams, Models::CampaignListAffiliateApplicationsParams, Models::CampaignListAffiliateInvitesParams, Models::CampaignListCommissionsParams, Models::CampaignListLeaderboardParams, Models::CampaignListParams, Models::CampaignListParticipantsParams, Models::CampaignListPayoutsParams, Models::CampaignListReferralsParams, Models::CampaignResendAffiliateInviteParams, Models::CampaignRetrieveAffiliateApplicationParams, Models::CampaignRetrieveAnalyticsParams, Models::CampaignRetrieveParams, Models::CampaignReviewAffiliateApplicationParams, Models::CampaignRevokeAffiliateInviteParams, Models::CampaignUpdateParams, Models::TeamUpdateParams
Defined in:
lib/growsurf_ruby/internal/type/request_parameters.rb,
sig/growsurf_ruby/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

GrowsurfRuby =

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  ⇒ GrowsurfRuby::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 [GrowsurfRuby::RequestOptions, Hash{Symbol=>Object}]


  





  

Returns:


    
  
    
  • 
      
      
        (GrowsurfRuby::request_opts)
      
      
      
    
    • 
  





  

    
      




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

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

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