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.



304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
 
# File 'lib/twilio-ruby/rest/intelligence/v2/custom_operator.rb', line 304

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.



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

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.



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

def author
    @properties['author']
end

#availability ⇒ Availability

Returns:

  • (Availability) 


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

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.



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

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:



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

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.



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

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.



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

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the CustomOperatorInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



414
415
416
417
 
# File 'lib/twilio-ruby/rest/intelligence/v2/custom_operator.rb', line 414

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.



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

def description
    @properties['description']
end

#fetch ⇒ CustomOperatorInstance

Fetch the CustomOperatorInstance

Returns:



422
423
424
425
 
# File 'lib/twilio-ruby/rest/intelligence/v2/custom_operator.rb', line 422

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.



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

def friendly_name
    @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



455
456
457
458
 
# File 'lib/twilio-ruby/rest/intelligence/v2/custom_operator.rb', line 455

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.



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

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.



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

def sid
    @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



448
449
450
451
 
# File 'lib/twilio-ruby/rest/intelligence/v2/custom_operator.rb', line 448

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:



433
434
435
436
437
438
439
440
441
442
443
444
 
# File 'lib/twilio-ruby/rest/intelligence/v2/custom_operator.rb', line 433

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.



407
408
409
 
# File 'lib/twilio-ruby/rest/intelligence/v2/custom_operator.rb', line 407

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.



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

def version
    @properties['version']
end