Class: Twilio::REST::Verify::V2::ServiceContext::AccessTokenInstance

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/verify/v2/service/access_token.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, service_sid: nil, sid: nil) ⇒ AccessTokenInstance

Initialize the AccessTokenInstance

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

  • account_sid (String) —

    The SID of the Account that created this AccessToken resource.

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

    The SID of the Call resource to fetch.



162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
 
# File 'lib/twilio-ruby/rest/verify/v2/service/access_token.rb', line 162

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'],
        'entity_identity' => payload['entity_identity'],
        'factor_type' => payload['factor_type'],
        'factor_friendly_name' => payload['factor_friendly_name'],
        'token' => payload['token'],
        'url' => payload['url'],
        'ttl' => payload['ttl'] == nil ? payload['ttl'] : payload['ttl'].to_i,
        'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
    }

    # 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 unique SID identifier of the Account.

Returns:

  • (String) —

    The unique SID identifier of the Account.



203
204
205
 
# File 'lib/twilio-ruby/rest/verify/v2/service/access_token.rb', line 203

def 
    @properties['account_sid']
end

#context ⇒ AccessTokenContext

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

Returns:



188
189
190
191
192
193
 
# File 'lib/twilio-ruby/rest/verify/v2/service/access_token.rb', line 188

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

#date_created ⇒ Time

Returns The date that this access token was created, given in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.

Returns:



251
252
253
 
# File 'lib/twilio-ruby/rest/verify/v2/service/access_token.rb', line 251

def date_created
    @properties['date_created']
end

#entity_identity ⇒ String

Returns The unique external identifier for the Entity of the Service.

Returns:

  • (String) —

    The unique external identifier for the Entity of the Service.



215
216
217
 
# File 'lib/twilio-ruby/rest/verify/v2/service/access_token.rb', line 215

def entity_identity
    @properties['entity_identity']
end

#factor_friendly_name ⇒ String

Returns A human readable description of this factor, up to 64 characters. For a push factor, this can be the device’s name.

Returns:

  • (String) —

    A human readable description of this factor, up to 64 characters. For a push factor, this can be the device’s name.



227
228
229
 
# File 'lib/twilio-ruby/rest/verify/v2/service/access_token.rb', line 227

def factor_friendly_name
    @properties['factor_friendly_name']
end

#factor_type ⇒ FactorTypes

Returns:

  • (FactorTypes) 


221
222
223
 
# File 'lib/twilio-ruby/rest/verify/v2/service/access_token.rb', line 221

def factor_type
    @properties['factor_type']
end

#fetch ⇒ AccessTokenInstance

Fetch the AccessTokenInstance

Returns:



258
259
260
261
 
# File 'lib/twilio-ruby/rest/verify/v2/service/access_token.rb', line 258

def fetch

    context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



272
273
274
275
 
# File 'lib/twilio-ruby/rest/verify/v2/service/access_token.rb', line 272

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

#service_sid ⇒ String

Returns The unique SID identifier of the Verify Service.

Returns:

  • (String) —

    The unique SID identifier of the Verify Service.



209
210
211
 
# File 'lib/twilio-ruby/rest/verify/v2/service/access_token.rb', line 209

def service_sid
    @properties['service_sid']
end

#sid ⇒ String

Returns A 34 character string that uniquely identifies this Access Token.

Returns:

  • (String) —

    A 34 character string that uniquely identifies this Access Token.



197
198
199
 
# File 'lib/twilio-ruby/rest/verify/v2/service/access_token.rb', line 197

def sid
    @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



265
266
267
268
 
# File 'lib/twilio-ruby/rest/verify/v2/service/access_token.rb', line 265

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

#token ⇒ String

Returns The access token generated for enrollment, this is an encrypted json web token.

Returns:

  • (String) —

    The access token generated for enrollment, this is an encrypted json web token.



233
234
235
 
# File 'lib/twilio-ruby/rest/verify/v2/service/access_token.rb', line 233

def token
    @properties['token']
end

#ttl ⇒ String

Returns How long, in seconds, the access token is valid. Max: 5 minutes.

Returns:

  • (String) —

    How long, in seconds, the access token is valid. Max: 5 minutes



245
246
247
 
# File 'lib/twilio-ruby/rest/verify/v2/service/access_token.rb', line 245

def ttl
    @properties['ttl']
end

#url ⇒ String

Returns The URL of this resource.

Returns:

  • (String) —

    The URL of this resource.



239
240
241
 
# File 'lib/twilio-ruby/rest/verify/v2/service/access_token.rb', line 239

def url
    @properties['url']
end