Class: Twilio::REST::Intelligence::V2::OperatorInstance

Inherits:
Twilio::REST::InstanceResource show all
Defined in:
lib/twilio-ruby/rest/intelligence/v2/operator.rb

Instance Method Summary collapse

Constructor Details

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

Initialize the OperatorInstance

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 Operator resource.

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

    The SID of the Call resource to fetch.



222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
 
# File 'lib/twilio-ruby/rest/intelligence/v2/operator.rb', line 222

def initialize(version, payload , sid: nil)
    super(version)
    
    # Marshaled Properties
    @properties = { 
        'account_sid' => payload['account_sid'],
        'sid' => payload['sid'],
        'friendly_name' => payload['friendly_name'],
        'description' => payload['description'],
        'author' => payload['author'],
        'operator_type' => payload['operator_type'],
        'version' => payload['version'] == nil ? payload['version'] : payload['version'].to_i,
        'availability' => payload['availability'],
        'config' => payload['config'],
        'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
        'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
        'url' => payload['url'],
    }

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

Instance Method Details

#account_sid ⇒ String

Returns The unique SID identifier of the Account the Operator belongs to.

Returns:

  • (String) —

    The unique SID identifier of the Account the Operator belongs to.



259
260
261
 
# File 'lib/twilio-ruby/rest/intelligence/v2/operator.rb', line 259

def 
    @properties['account_sid']
end

#author ⇒ String

Returns The creator of the Operator. Either Twilio or the creating Account.

Returns:

  • (String) —

    The creator of the Operator. Either Twilio or the creating Account.



283
284
285
 
# File 'lib/twilio-ruby/rest/intelligence/v2/operator.rb', line 283

def author
    @properties['author']
end

#availability ⇒ Availability

Returns:

  • (Availability) 


301
302
303
 
# File 'lib/twilio-ruby/rest/intelligence/v2/operator.rb', line 301

def availability
    @properties['availability']
end

#config ⇒ Hash

Returns Operator configuration, following the schema defined by the Operator Type. Only available on Custom Operators created by the Account.

Returns:

  • (Hash) —

    Operator configuration, following the schema defined by the Operator Type. Only available on Custom Operators created by the Account.



307
308
309
 
# File 'lib/twilio-ruby/rest/intelligence/v2/operator.rb', line 307

def config
    @properties['config']
end

#context ⇒ OperatorContext

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

Returns:



250
251
252
253
254
255
 
# File 'lib/twilio-ruby/rest/intelligence/v2/operator.rb', line 250

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

#date_created ⇒ Time

Returns The date that this Operator was created, given in ISO 8601 format.

Returns:

  • (Time) —

    The date that this Operator was created, given in ISO 8601 format.



313
314
315
 
# File 'lib/twilio-ruby/rest/intelligence/v2/operator.rb', line 313

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time

Returns The date that this Operator was updated, given in ISO 8601 format.

Returns:

  • (Time) —

    The date that this Operator was updated, given in ISO 8601 format.



319
320
321
 
# File 'lib/twilio-ruby/rest/intelligence/v2/operator.rb', line 319

def date_updated
    @properties['date_updated']
end

#description ⇒ String

Returns A human-readable description of this resource, longer than the friendly name.

Returns:

  • (String) —

    A human-readable description of this resource, longer than the friendly name.



277
278
279
 
# File 'lib/twilio-ruby/rest/intelligence/v2/operator.rb', line 277

def description
    @properties['description']
end

#fetch ⇒ OperatorInstance

Fetch the OperatorInstance

Returns:



332
333
334
335
 
# File 'lib/twilio-ruby/rest/intelligence/v2/operator.rb', line 332

def fetch

    context.fetch
end

#friendly_name ⇒ String

Returns A human-readable name of this resource, up to 64 characters.

Returns:

  • (String) —

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



271
272
273
 
# File 'lib/twilio-ruby/rest/intelligence/v2/operator.rb', line 271

def friendly_name
    @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



346
347
348
349
 
# File 'lib/twilio-ruby/rest/intelligence/v2/operator.rb', line 346

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

#operator_type ⇒ String

Returns Operator Type for this Operator. References an existing Operator Type resource.

Returns:

  • (String) —

    Operator Type for this Operator. References an existing Operator Type resource.



289
290
291
 
# File 'lib/twilio-ruby/rest/intelligence/v2/operator.rb', line 289

def operator_type
    @properties['operator_type']
end

#sid ⇒ String

Returns A 34 character string that uniquely identifies this Operator.

Returns:

  • (String) —

    A 34 character string that uniquely identifies this Operator.



265
266
267
 
# File 'lib/twilio-ruby/rest/intelligence/v2/operator.rb', line 265

def sid
    @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



339
340
341
342
 
# File 'lib/twilio-ruby/rest/intelligence/v2/operator.rb', line 339

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

#url ⇒ String

Returns The URL of this resource.

Returns:

  • (String) —

    The URL of this resource.



325
326
327
 
# File 'lib/twilio-ruby/rest/intelligence/v2/operator.rb', line 325

def url
    @properties['url']
end

#version ⇒ String

Returns Numeric Operator version. Incremented with each update on the resource, used to ensure integrity when updating the Operator.

Returns:

  • (String) —

    Numeric Operator version. Incremented with each update on the resource, used to ensure integrity when updating the Operator.



295
296
297
 
# File 'lib/twilio-ruby/rest/intelligence/v2/operator.rb', line 295

def version
    @properties['version']
end