Class: SurgeAPI::Models::AccountCreateParams

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

Overview

See Also:

  • SurgeAPI::Resources::Accounts#create

Defined Under Namespace

Classes: Organization

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 ⇒ Object 



30
 
# File 'sig/surge_api/models/account_create_params.rbs', line 30

def initialize: (

Instance Attribute Details

#brand_name ⇒ String?

The name by which the people this account communicates with know it. If not provided, this will match the name field.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


25
 
# File 'lib/surge_api/models/account_create_params.rb', line 25

optional :brand_name, String, nil?: true

#name ⇒ String

The name of the account that will be visible for your internal organizational purposes. This will also be the default public-facing brand name unless you also set a brand_name, but otherwise the account name will never be displayed anywhere outside of Surge HQ, and may include your ID for the account or anything else that may help you.

Parameters:

  • value (String)

Returns:

  • (String) 


18
 
# File 'lib/surge_api/models/account_create_params.rb', line 18

required :name, String

#organization ⇒ SurgeAPI::Models::AccountCreateParams::Organization?

Parameters describing the legal entity on whose behalf the account will be operated.

Returns:



32
 
# File 'lib/surge_api/models/account_create_params.rb', line 32

optional :organization, -> { SurgeAPI::AccountCreateParams::Organization }

#time_zone ⇒ String?

This is the time zone in which the account is headquartered. This time zone may be used for compliance with TCPA restrictions on when messages may be sent.

Parameters:

  • (String)

Returns:

  • (String, nil) 


39
 
# File 'lib/surge_api/models/account_create_params.rb', line 39

optional :time_zone, String

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


38
 
# File 'sig/surge_api/models/account_create_params.rbs', line 38

def to_hash: -> {