Class: GrowsurfRuby::Models::CampaignCreateParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• GrowsurfRuby::Models::CampaignCreateParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/growsurf_ruby/models/campaign_create_params.rb,
sig/growsurf_ruby/models/campaign_create_params.rbs

Overview

See Also:

• GrowsurfRuby::Resources::Campaign#create

Defined Under Namespace

Modules: Type

Constant Summary

Constants included from Internal::Type::RequestParameters

Internal::Type::RequestParameters::GrowsurfRuby

Instance Attribute Summary

• #company_logo_image_url ⇒ String^?
• #company_name ⇒ String^?
• #currency_iso ⇒ String^?
• #name ⇒ String^?
• #rewards ⇒ Array<GrowsurfRuby::Models::Campaign::RewardCreateParams>^?
• #type ⇒ Symbol, GrowsurfRuby::Models::CampaignCreateParams::Type

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(type:, company_logo_image_url: nil, company_name: nil, currency_iso: nil, name: nil, rewards: nil, request_options: {}) ⇒ Object constructor
• #to_hash ⇒ {

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(type:, company_logo_image_url: nil, company_name: nil, currency_iso: nil, name: nil, rewards: nil, request_options: {}) ⇒ Object

Parameters:

• type (Symbol, GrowsurfRuby::Models::CampaignCreateParams::Type)
• company_logo_image_url (String) (defaults to: nil)
• company_name (String) (defaults to: nil)
• currency_iso (String) (defaults to: nil)
• name (String) (defaults to: nil)
• rewards (Array<GrowsurfRuby::Models::Campaign::RewardCreateParams>) (defaults to: nil)
• request_options (GrowsurfRuby::RequestOptions, Hash{Symbol=>Object}) (defaults to: {})

# File 'lib/growsurf_ruby/models/campaign_create_params.rb', line 41

Instance Attribute Details

#company_logo_image_url ⇒ String^?

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/growsurf_ruby/models/campaign_create_params.rb', line 18

optional :company_logo_image_url, String, api_name: :companyLogoImageUrl

#company_name ⇒ String^?

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/growsurf_ruby/models/campaign_create_params.rb', line 23

optional :company_name, String, api_name: :companyName

#currency_iso ⇒ String^?

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/growsurf_ruby/models/campaign_create_params.rb', line 28

optional :currency_iso, String, api_name: :currencyISO

#name ⇒ String^?

Parameters:

• (String)

Returns:

• (String, nil)

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

optional :name, String

#rewards ⇒ Array<GrowsurfRuby::Models::Campaign::RewardCreateParams>^?

Returns:

• (Array<GrowsurfRuby::Models::Campaign::RewardCreateParams>, nil)

# File 'lib/growsurf_ruby/models/campaign_create_params.rb', line 38

optional :rewards,
-> { GrowsurfRuby::Internal::Type::ArrayOf[GrowsurfRuby::Campaign::RewardCreateParams] }

#type ⇒ Symbol, GrowsurfRuby::Models::CampaignCreateParams::Type

Parameters:

• value (GrowsurfRuby::Models::CampaignCreateParams::type_)

Returns:

• (Symbol, GrowsurfRuby::Models::CampaignCreateParams::Type)

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

required :type, enum: -> { GrowsurfRuby::CampaignCreateParams::Type }

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/growsurf_ruby/models/campaign_create_params.rbs', line 52

def to_hash: -> {