Class: SurgeAPI::Models::PhoneNumberUpdateParams

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

Overview

See Also:

  • SurgeAPI::Resources::PhoneNumbers#update

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:, campaign_id: nil, name: nil, request_options: {}) ⇒ Object

Parameters:

  • id (String) —

    The ID of the phone number to update.

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

    Campaign ID to attach this number to (cpn_...).

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

    A human-readable name for the phone number.

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



# File 'lib/surge_api/models/phone_number_update_params.rb', line 28

Instance Attribute Details

#campaign_id ⇒ String?

Campaign ID to attach this number to (cpn_...).

Parameters:

  • (String)

Returns:

  • (String, nil) 


20
 
# File 'lib/surge_api/models/phone_number_update_params.rb', line 20

optional :campaign_id, String

#id ⇒ String

The ID of the phone number to update.

Parameters:

  • value (String)

Returns:

  • (String) 


14
 
# File 'lib/surge_api/models/phone_number_update_params.rb', line 14

required :id, String

#name ⇒ String?

A human-readable name for the phone number.

Parameters:

  • (String)

Returns:

  • (String, nil) 


26
 
# File 'lib/surge_api/models/phone_number_update_params.rb', line 26

optional :name, String

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


28
 
# File 'sig/surge_api/models/phone_number_update_params.rbs', line 28

def to_hash: -> {