Class: GrowsurfRuby::Models::AccountCreateParams

Inherits:

Internal::Type::BaseModel

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

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

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

Overview

See Also:

• GrowsurfRuby::Resources::Account#create

Constant Summary

Constants included from Internal::Type::RequestParameters

Internal::Type::RequestParameters::GrowsurfRuby

Instance Attribute Summary

• #company ⇒ String^?
• #email ⇒ String

  The email address for the new account.

• #first_name ⇒ String^?
• #last_name ⇒ String^?

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(email:, company: nil, first_name: nil, last_name: nil, request_options: {}) ⇒ Object constructor

  Some parameter documentations has been truncated, see AccountCreateParams for more details.

• #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(email:, company: nil, first_name: nil, last_name: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see GrowsurfRuby::Models::AccountCreateParams for more details.

Parameters:

• email (String) —

  The email address for the new account. Personal emails and disposable email addresses are not accepted.

• company (String) (defaults to: nil)
• first_name (String) (defaults to: nil)
• last_name (String) (defaults to: nil)
• request_options (GrowsurfRuby::RequestOptions, Hash{Symbol=>Object}) (defaults to: {})

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

Instance Attribute Details

#company ⇒ String^?

Parameters:

• (String)

Returns:

• (String, nil)

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

optional :company, String

#email ⇒ String

The email address for the new account. Personal emails and disposable email addresses are not accepted.

Parameters:

• value (String)

Returns:

• (String)

# File 'lib/growsurf_ruby/models/account_create_params.rb', line 14

required :email, String

#first_name ⇒ String^?

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/growsurf_ruby/models/account_create_params.rb', line 24

optional :first_name, String, api_name: :firstName

#last_name ⇒ String^?

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/growsurf_ruby/models/account_create_params.rb', line 29

optional :last_name, String, api_name: :lastName

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/growsurf_ruby/models/account_create_params.rbs', line 33

def to_hash: -> {