Class: Twilio::REST::Routes::V2::SipDomainInstance

Inherits:
InstanceResource show all
Defined in:
lib/twilio-ruby/rest/routes/v2/sip_domain.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, sip_domain: nil) ⇒ SipDomainInstance

Initialize the SipDomainInstance

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

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

    The sip_domain



119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
 
# File 'lib/twilio-ruby/rest/routes/v2/sip_domain.rb', line 119

def initialize(version, payload, sip_domain: nil)
  super(version)

  # Marshaled Properties
  @properties = {
      'sip_domain' => payload['sip_domain'],
      'url' => payload['url'],
      'sid' => payload['sid'],
      'account_sid' => payload['account_sid'],
      'friendly_name' => payload['friendly_name'],
      'voice_region' => payload['voice_region'],
      'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
      'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
  }

  # Context
  @instance_context = nil
  @params = {'sip_domain' => sip_domain || @properties['sip_domain'], }
end

Instance Method Details

#account_sid ⇒ String

Returns The account_sid.

Returns:

  • (String) —

    The account_sid



170
171
172
 
# File 'lib/twilio-ruby/rest/routes/v2/sip_domain.rb', line 170

def 
  @properties['account_sid']
end

#context ⇒ SipDomainContext

Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context

Returns:



143
144
145
146
147
148
 
# File 'lib/twilio-ruby/rest/routes/v2/sip_domain.rb', line 143

def context
  unless @instance_context
    @instance_context = SipDomainContext.new(@version, @params['sip_domain'], )
  end
  @instance_context
end

#date_created ⇒ Time

Returns The date_created.

Returns:

  • (Time) —

    The date_created



188
189
190
 
# File 'lib/twilio-ruby/rest/routes/v2/sip_domain.rb', line 188

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns The date_updated.

Returns:

  • (Time) —

    The date_updated



194
195
196
 
# File 'lib/twilio-ruby/rest/routes/v2/sip_domain.rb', line 194

def date_updated
  @properties['date_updated']
end

#fetch ⇒ SipDomainInstance

Fetch the SipDomainInstance

Returns:



210
211
212
 
# File 'lib/twilio-ruby/rest/routes/v2/sip_domain.rb', line 210

def fetch
  context.fetch
end

#friendly_name ⇒ String

Returns The friendly_name.

Returns:

  • (String) —

    The friendly_name



176
177
178
 
# File 'lib/twilio-ruby/rest/routes/v2/sip_domain.rb', line 176

def friendly_name
  @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



223
224
225
226
 
# File 'lib/twilio-ruby/rest/routes/v2/sip_domain.rb', line 223

def inspect
  values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
  "<Twilio.Routes.V2.SipDomainInstance #{values}>"
end

#sid ⇒ String

Returns The sid.

Returns:

  • (String) —

    The sid



164
165
166
 
# File 'lib/twilio-ruby/rest/routes/v2/sip_domain.rb', line 164

def sid
  @properties['sid']
end

#sip_domain ⇒ String

Returns The sip_domain.

Returns:

  • (String) —

    The sip_domain



152
153
154
 
# File 'lib/twilio-ruby/rest/routes/v2/sip_domain.rb', line 152

def sip_domain
  @properties['sip_domain']
end

#to_s ⇒ Object

Provide a user friendly representation



216
217
218
219
 
# File 'lib/twilio-ruby/rest/routes/v2/sip_domain.rb', line 216

def to_s
  values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
  "<Twilio.Routes.V2.SipDomainInstance #{values}>"
end

#update(voice_region: :unset, friendly_name: :unset) ⇒ SipDomainInstance

Update the SipDomainInstance

Parameters:

  • voice_region (String) (defaults to: :unset) —

    The voice_region

  • friendly_name (String) (defaults to: :unset) —

    The friendly_name

Returns:



203
204
205
 
# File 'lib/twilio-ruby/rest/routes/v2/sip_domain.rb', line 203

def update(voice_region: :unset, friendly_name: :unset)
  context.update(voice_region: voice_region, friendly_name: friendly_name, )
end

#url ⇒ String

Returns The url.

Returns:

  • (String) —

    The url



158
159
160
 
# File 'lib/twilio-ruby/rest/routes/v2/sip_domain.rb', line 158

def url
  @properties['url']
end

#voice_region ⇒ String

Returns The voice_region.

Returns:

  • (String) —

    The voice_region



182
183
184
 
# File 'lib/twilio-ruby/rest/routes/v2/sip_domain.rb', line 182

def voice_region
  @properties['voice_region']
end