Class: Twilio::REST::Intelligence::V2::CustomOperatorInstance

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

Instance Method Summary collapse

Constructor Details

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

Initialize the CustomOperatorInstance

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

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

    The SID of the Call resource to fetch.



284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
 
# File 'lib/twilio-ruby/rest/intelligence/v2/custom_operator.rb', line 284

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 Custom Operator belongs to.

Returns:

  • (String) —

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



321
322
323
 
# File 'lib/twilio-ruby/rest/intelligence/v2/custom_operator.rb', line 321

def 
    @properties['account_sid']
end

#author ⇒ String

Returns The creator of the Custom Operator. Custom Operators can only be created by a Twilio Account.

Returns:

  • (String) —

    The creator of the Custom Operator. Custom Operators can only be created by a Twilio Account.



345
346
347
 
# File 'lib/twilio-ruby/rest/intelligence/v2/custom_operator.rb', line 345

def author
    @properties['author']
end

#availability ⇒ Availability

Returns:

  • (Availability) 


363
364
365
 
# File 'lib/twilio-ruby/rest/intelligence/v2/custom_operator.rb', line 363

def availability
    @properties['availability']
end

#config ⇒ Hash

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

Returns:

  • (Hash) —

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



369
370
371
 
# File 'lib/twilio-ruby/rest/intelligence/v2/custom_operator.rb', line 369

def config
    @properties['config']
end

#context ⇒ CustomOperatorContext

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

Returns:



312
313
314
315
316
317
 
# File 'lib/twilio-ruby/rest/intelligence/v2/custom_operator.rb', line 312

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

#date_created ⇒ Time

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

Returns:

  • (Time) —

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



375
376
377
 
# File 'lib/twilio-ruby/rest/intelligence/v2/custom_operator.rb', line 375

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time

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

Returns:

  • (Time) —

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



381
382
383
 
# File 'lib/twilio-ruby/rest/intelligence/v2/custom_operator.rb', line 381

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the CustomOperatorInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



394
395
396
397
 
# File 'lib/twilio-ruby/rest/intelligence/v2/custom_operator.rb', line 394

def delete

    context.delete
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.



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

def description
    @properties['description']
end

#fetch ⇒ CustomOperatorInstance

Fetch the CustomOperatorInstance

Returns:



402
403
404
405
 
# File 'lib/twilio-ruby/rest/intelligence/v2/custom_operator.rb', line 402

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.



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

def friendly_name
    @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



435
436
437
438
 
# File 'lib/twilio-ruby/rest/intelligence/v2/custom_operator.rb', line 435

def inspect
    values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
    "<Twilio.Intelligence.V2.CustomOperatorInstance #{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.



351
352
353
 
# File 'lib/twilio-ruby/rest/intelligence/v2/custom_operator.rb', line 351

def operator_type
    @properties['operator_type']
end

#sid ⇒ String

Returns A 34 character string that uniquely identifies this Custom Operator.

Returns:

  • (String) —

    A 34 character string that uniquely identifies this Custom Operator.



327
328
329
 
# File 'lib/twilio-ruby/rest/intelligence/v2/custom_operator.rb', line 327

def sid
    @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



428
429
430
431
 
# File 'lib/twilio-ruby/rest/intelligence/v2/custom_operator.rb', line 428

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

#update(friendly_name: nil, config: nil, if_match: :unset) ⇒ CustomOperatorInstance

Update the CustomOperatorInstance

Parameters:

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

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

  • config (Object) (defaults to: nil) —

    Operator configuration, following the schema defined by the Operator Type.

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

    The If-Match HTTP request header

Returns:



413
414
415
416
417
418
419
420
421
422
423
424
 
# File 'lib/twilio-ruby/rest/intelligence/v2/custom_operator.rb', line 413

def update(
    friendly_name: nil, 
    config: nil, 
    if_match: :unset
)

    context.update(
        friendly_name: friendly_name, 
        config: config, 
        if_match: if_match, 
    )
end

#url ⇒ String

Returns The URL of this resource.

Returns:

  • (String) —

    The URL of this resource.



387
388
389
 
# File 'lib/twilio-ruby/rest/intelligence/v2/custom_operator.rb', line 387

def url
    @properties['url']
end

#version ⇒ String

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

Returns:

  • (String) —

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



357
358
359
 
# File 'lib/twilio-ruby/rest/intelligence/v2/custom_operator.rb', line 357

def version
    @properties['version']
end