Class: Twilio::REST::Authy::V1::ServiceInstance

Inherits:
InstanceResource show all
Defined in:
lib/twilio-ruby/rest/authy/v1/service.rb

Overview

PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact [email protected].

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, sid: nil) ⇒ ServiceInstance

Initialize the ServiceInstance

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

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

    A 34 character string that uniquely identifies this Service.



266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
 
# File 'lib/twilio-ruby/rest/authy/v1/service.rb', line 266

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

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

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

Instance Method Details

#account_sid ⇒ String

Returns Account Sid.

Returns:

  • (String) —

    Account Sid.



310
311
312
 
# File 'lib/twilio-ruby/rest/authy/v1/service.rb', line 310

def 
  @properties['account_sid']
end

#context ⇒ ServiceContext

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

Returns:



289
290
291
292
293
294
 
# File 'lib/twilio-ruby/rest/authy/v1/service.rb', line 289

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

#date_created ⇒ Time

Returns The date this Service was created.

Returns:

  • (Time) —

    The date this Service was created



316
317
318
 
# File 'lib/twilio-ruby/rest/authy/v1/service.rb', line 316

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns The date this Service was updated.

Returns:

  • (Time) —

    The date this Service was updated



322
323
324
 
# File 'lib/twilio-ruby/rest/authy/v1/service.rb', line 322

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Deletes the ServiceInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



341
342
343
 
# File 'lib/twilio-ruby/rest/authy/v1/service.rb', line 341

def delete
  context.delete
end

#entities ⇒ entities

Access the entities

Returns:



364
365
366
 
# File 'lib/twilio-ruby/rest/authy/v1/service.rb', line 364

def entities
  context.entities
end

#fetch ⇒ ServiceInstance

Fetch a ServiceInstance

Returns:



348
349
350
 
# File 'lib/twilio-ruby/rest/authy/v1/service.rb', line 348

def fetch
  context.fetch
end

#friendly_name ⇒ String

Returns A human readable description of this resource.

Returns:

  • (String) —

    A human readable description of this resource.



304
305
306
 
# File 'lib/twilio-ruby/rest/authy/v1/service.rb', line 304

def friendly_name
  @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



377
378
379
380
 
# File 'lib/twilio-ruby/rest/authy/v1/service.rb', line 377

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

#links ⇒ String

Returns Nested resource URLs.

Returns:

  • (String) —

    Nested resource URLs.



334
335
336
 
# File 'lib/twilio-ruby/rest/authy/v1/service.rb', line 334

def links
  @properties['links']
end

#sid ⇒ String

Returns A string that uniquely identifies this Service.

Returns:

  • (String) —

    A string that uniquely identifies this Service.



298
299
300
 
# File 'lib/twilio-ruby/rest/authy/v1/service.rb', line 298

def sid
  @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



370
371
372
373
 
# File 'lib/twilio-ruby/rest/authy/v1/service.rb', line 370

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

#update(friendly_name: :unset) ⇒ ServiceInstance

Update the ServiceInstance

Parameters:

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

    A human readable description of this resource, up to 64 characters.

Returns:



357
358
359
 
# File 'lib/twilio-ruby/rest/authy/v1/service.rb', line 357

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

#url ⇒ String

Returns The URL of this resource.

Returns:

  • (String) —

    The URL of this resource.



328
329
330
 
# File 'lib/twilio-ruby/rest/authy/v1/service.rb', line 328

def url
  @properties['url']
end