Class: Twilio::REST::Messaging::V1::ServiceContext::ShortCodeInstance
- Inherits:
-
InstanceResource
- Object
- InstanceResource
- Twilio::REST::Messaging::V1::ServiceContext::ShortCodeInstance
- Defined in:
- lib/twilio-ruby/rest/messaging/v1/service/short_code.rb
Instance Method Summary collapse
-
#account_sid ⇒ String
The SID of the [Account](www.twilio.com/docs/iam/api/account) that created the ShortCode resource.
-
#capabilities ⇒ Array<String>
An array of values that describe whether the number can receive calls or messages.
-
#context ⇒ ShortCodeContext
Generate an instance context for the instance, the context is capable of performing various actions.
-
#country_code ⇒ String
The 2-character [ISO Country Code](www.iso.org/iso-3166-country-codes.html) of the number.
-
#date_created ⇒ Time
The date and time in GMT when the resource was created specified in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.
-
#date_updated ⇒ Time
The date and time in GMT when the resource was last updated specified in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.
-
#delete ⇒ Boolean
Delete the ShortCodeInstance.
-
#fetch ⇒ ShortCodeInstance
Fetch the ShortCodeInstance.
-
#initialize(version, payload, service_sid: nil, sid: nil) ⇒ ShortCodeInstance
constructor
Initialize the ShortCodeInstance.
-
#inspect ⇒ Object
Provide a detailed, user friendly representation.
-
#service_sid ⇒ String
The SID of the [Service](www.twilio.com/docs/chat/rest/service-resource) the resource is associated with.
-
#short_code ⇒ String
The [E.164](www.twilio.com/docs/glossary/what-e164) format of the short code.
-
#sid ⇒ String
The unique string that we created to identify the ShortCode resource.
-
#to_s ⇒ Object
Provide a user friendly representation.
-
#url ⇒ String
The absolute URL of the ShortCode resource.
Constructor Details
#initialize(version, payload, service_sid: nil, sid: nil) ⇒ ShortCodeInstance
Initialize the ShortCodeInstance
243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 |
# File 'lib/twilio-ruby/rest/messaging/v1/service/short_code.rb', line 243 def initialize(version, payload , service_sid: nil, sid: nil) super(version) # Marshaled Properties @properties = { 'sid' => payload['sid'], 'account_sid' => payload['account_sid'], 'service_sid' => payload['service_sid'], 'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']), 'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']), 'short_code' => payload['short_code'], 'country_code' => payload['country_code'], 'capabilities' => payload['capabilities'], 'url' => payload['url'], } # Context @instance_context = nil @params = { 'service_sid' => service_sid || @properties['service_sid'] ,'sid' => sid || @properties['sid'] , } end |
Instance Method Details
#account_sid ⇒ String
Returns The SID of the [Account](www.twilio.com/docs/iam/api/account) that created the ShortCode resource.
283 284 285 |
# File 'lib/twilio-ruby/rest/messaging/v1/service/short_code.rb', line 283 def account_sid @properties['account_sid'] end |
#capabilities ⇒ Array<String>
Returns An array of values that describe whether the number can receive calls or messages. Can be: ‘SMS` and `MMS`.
319 320 321 |
# File 'lib/twilio-ruby/rest/messaging/v1/service/short_code.rb', line 319 def capabilities @properties['capabilities'] end |
#context ⇒ ShortCodeContext
Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context
268 269 270 271 272 273 |
# File 'lib/twilio-ruby/rest/messaging/v1/service/short_code.rb', line 268 def context unless @instance_context @instance_context = ShortCodeContext.new(@version , @params['service_sid'], @params['sid']) end @instance_context end |
#country_code ⇒ String
Returns The 2-character [ISO Country Code](www.iso.org/iso-3166-country-codes.html) of the number.
313 314 315 |
# File 'lib/twilio-ruby/rest/messaging/v1/service/short_code.rb', line 313 def country_code @properties['country_code'] end |
#date_created ⇒ Time
Returns The date and time in GMT when the resource was created specified in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.
295 296 297 |
# File 'lib/twilio-ruby/rest/messaging/v1/service/short_code.rb', line 295 def date_created @properties['date_created'] end |
#date_updated ⇒ Time
Returns The date and time in GMT when the resource was last updated specified in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.
301 302 303 |
# File 'lib/twilio-ruby/rest/messaging/v1/service/short_code.rb', line 301 def date_updated @properties['date_updated'] end |
#delete ⇒ Boolean
Delete the ShortCodeInstance
332 333 334 335 |
# File 'lib/twilio-ruby/rest/messaging/v1/service/short_code.rb', line 332 def delete context.delete end |
#fetch ⇒ ShortCodeInstance
Fetch the ShortCodeInstance
340 341 342 343 |
# File 'lib/twilio-ruby/rest/messaging/v1/service/short_code.rb', line 340 def fetch context.fetch end |
#inspect ⇒ Object
Provide a detailed, user friendly representation
354 355 356 357 |
# File 'lib/twilio-ruby/rest/messaging/v1/service/short_code.rb', line 354 def inspect values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ") "<Twilio.Messaging.V1.ShortCodeInstance #{values}>" end |
#service_sid ⇒ String
Returns The SID of the [Service](www.twilio.com/docs/chat/rest/service-resource) the resource is associated with.
289 290 291 |
# File 'lib/twilio-ruby/rest/messaging/v1/service/short_code.rb', line 289 def service_sid @properties['service_sid'] end |
#short_code ⇒ String
Returns The [E.164](www.twilio.com/docs/glossary/what-e164) format of the short code.
307 308 309 |
# File 'lib/twilio-ruby/rest/messaging/v1/service/short_code.rb', line 307 def short_code @properties['short_code'] end |
#sid ⇒ String
Returns The unique string that we created to identify the ShortCode resource.
277 278 279 |
# File 'lib/twilio-ruby/rest/messaging/v1/service/short_code.rb', line 277 def sid @properties['sid'] end |
#to_s ⇒ Object
Provide a user friendly representation
347 348 349 350 |
# File 'lib/twilio-ruby/rest/messaging/v1/service/short_code.rb', line 347 def to_s values = @params.map{|k, v| "#{k}: #{v}"}.join(" ") "<Twilio.Messaging.V1.ShortCodeInstance #{values}>" end |
#url ⇒ String
Returns The absolute URL of the ShortCode resource.
325 326 327 |
# File 'lib/twilio-ruby/rest/messaging/v1/service/short_code.rb', line 325 def url @properties['url'] end |