Class: GrowsurfRuby::Models::CampaignCreateAffiliateInviteParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/growsurf_ruby/models/campaign_create_affiliate_invite_params.rb,
sig/growsurf_ruby/models/campaign_create_affiliate_invite_params.rbs

Overview

See Also:

  • GrowsurfRuby::Resources::Campaign#create_affiliate_invite

Constant Summary

Constants included from Internal::Type::RequestParameters

Internal::Type::RequestParameters::GrowsurfRuby

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary collapse

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(id:, email:, first_name: nil, last_name: nil, request_options: {}) ⇒ Object

Parameters:

  • id (String)
  • email (String) —

    Valid email address to invite. Maximum 255 characters.

  • first_name (String) (defaults to: nil) —

    Invitee first name, used in the invite email. Maximum 255 characters.

  • last_name (String) (defaults to: nil) —

    Invitee last name. Maximum 255 characters.

  • request_options (GrowsurfRuby::RequestOptions, Hash{Symbol=>Object}) (defaults to: {}) 



# File 'lib/growsurf_ruby/models/campaign_create_affiliate_invite_params.rb', line 33

Instance Attribute Details

#email ⇒ String

Valid email address to invite. Maximum 255 characters.

Parameters:

  • value (String)

Returns:

  • (String) 


19
 
# File 'lib/growsurf_ruby/models/campaign_create_affiliate_invite_params.rb', line 19

required :email, String

#first_name ⇒ String?

Invitee first name, used in the invite email. Maximum 255 characters.

Parameters:

  • (String)

Returns:

  • (String, nil) 


25
 
# File 'lib/growsurf_ruby/models/campaign_create_affiliate_invite_params.rb', line 25

optional :first_name, String, api_name: :firstName

#id ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


13
 
# File 'lib/growsurf_ruby/models/campaign_create_affiliate_invite_params.rb', line 13

required :id, String

#last_name ⇒ String?

Invitee last name. Maximum 255 characters.

Parameters:

  • (String)

Returns:

  • (String, nil) 


31
 
# File 'lib/growsurf_ruby/models/campaign_create_affiliate_invite_params.rb', line 31

optional :last_name, String, api_name: :lastName

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


31
 
# File 'sig/growsurf_ruby/models/campaign_create_affiliate_invite_params.rbs', line 31

def to_hash: -> {