Class: GrowsurfRuby::Models::CampaignUpdateParams

Inherits:

Internal::Type::BaseModel

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

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

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

Overview

See Also:

• GrowsurfRuby::Resources::Campaign#update

Defined Under Namespace

Modules: Status

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^?
• #design ⇒ Hash{Symbol=>Object}^?
• #emails ⇒ Hash{Symbol=>Object}^?
• #goal ⇒ String^?
• #id ⇒ String
• #installation ⇒ Hash{Symbol=>Object}^?
• #name ⇒ String^?
• #notifications ⇒ Hash{Symbol=>Object}^?
• #options ⇒ Hash{Symbol=>Object}^?
• #status ⇒ Symbol, ...

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(id:, company_logo_image_url: nil, company_name: nil, currency_iso: nil, design: nil, emails: nil, goal: nil, installation: nil, name: nil, notifications: nil, options: nil, status: 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(id:, company_logo_image_url: nil, company_name: nil, currency_iso: nil, design: nil, emails: nil, goal: nil, installation: nil, name: nil, notifications: nil, options: nil, status: nil, request_options: {}) ⇒ Object

Parameters:

• id (String)
• company_logo_image_url (String) (defaults to: nil)
• company_name (String) (defaults to: nil)
• currency_iso (String) (defaults to: nil)
• design (Hash{Symbol=>Object}) (defaults to: nil)
• emails (Hash{Symbol=>Object}) (defaults to: nil)
• goal (String) (defaults to: nil)
• installation (Hash{Symbol=>Object}) (defaults to: nil)
• name (String) (defaults to: nil)
• notifications (Hash{Symbol=>Object}) (defaults to: nil)
• options (Hash{Symbol=>Object}) (defaults to: nil)
• status (Symbol, GrowsurfRuby::Models::CampaignUpdateParams::Status) (defaults to: nil)
• request_options (GrowsurfRuby::RequestOptions, Hash{Symbol=>Object}) (defaults to: {})

# File 'lib/growsurf_ruby/models/campaign_update_params.rb', line 70

Instance Attribute Details

#company_logo_image_url ⇒ String^?

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/growsurf_ruby/models/campaign_update_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_update_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_update_params.rb', line 28

optional :currency_iso, String, api_name: :currencyISO

#design ⇒ Hash{Symbol=>Object}^?

Parameters:

• (::Hash[Symbol, top])

Returns:

• (Hash{Symbol=>Object}, nil)

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

optional :design, GrowsurfRuby::Internal::Type::HashOf[GrowsurfRuby::Internal::Type::Unknown]

#emails ⇒ Hash{Symbol=>Object}^?

Parameters:

• (::Hash[Symbol, top])

Returns:

• (Hash{Symbol=>Object}, nil)

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

optional :emails, GrowsurfRuby::Internal::Type::HashOf[GrowsurfRuby::Internal::Type::Unknown]

#goal ⇒ String^?

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/growsurf_ruby/models/campaign_update_params.rb', line 43

optional :goal, String

#id ⇒ String

Parameters:

• value (String)

Returns:

• (String)

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

required :id, String

#installation ⇒ Hash{Symbol=>Object}^?

Parameters:

• (::Hash[Symbol, top])

Returns:

• (Hash{Symbol=>Object}, nil)

# File 'lib/growsurf_ruby/models/campaign_update_params.rb', line 48

optional :installation, GrowsurfRuby::Internal::Type::HashOf[GrowsurfRuby::Internal::Type::Unknown]

#name ⇒ String^?

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/growsurf_ruby/models/campaign_update_params.rb', line 53

optional :name, String

#notifications ⇒ Hash{Symbol=>Object}^?

Parameters:

• (::Hash[Symbol, top])

Returns:

• (Hash{Symbol=>Object}, nil)

# File 'lib/growsurf_ruby/models/campaign_update_params.rb', line 58

optional :notifications, GrowsurfRuby::Internal::Type::HashOf[GrowsurfRuby::Internal::Type::Unknown]

#options ⇒ Hash{Symbol=>Object}^?

Parameters:

• (::Hash[Symbol, top])

Returns:

• (Hash{Symbol=>Object}, nil)

# File 'lib/growsurf_ruby/models/campaign_update_params.rb', line 63

optional :options, GrowsurfRuby::Internal::Type::HashOf[GrowsurfRuby::Internal::Type::Unknown]

#status ⇒ Symbol, ...

Returns:

• (Symbol, GrowsurfRuby::Models::CampaignUpdateParams::Status, nil)

# File 'lib/growsurf_ruby/models/campaign_update_params.rb', line 68

optional :status, enum: -> { GrowsurfRuby::CampaignUpdateParams::Status }

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/growsurf_ruby/models/campaign_update_params.rbs', line 88

def to_hash: -> {