Class: Twilio::REST::Taskrouter::V1::WorkspaceContext::TaskChannelInstance

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/taskrouter/v1/workspace/task_channel.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, workspace_sid: nil, sid: nil) ⇒ TaskChannelInstance

Initialize the TaskChannelInstance

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

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

    The unique ID of the Workspace that this TaskChannel belongs to.

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

    The sid



253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_channel.rb', line 253

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

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

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

Instance Method Details

#account_sid ⇒ String

Returns The unique ID of the Account that owns this TaskChannel.

Returns:

  • (String) —

    The unique ID of the Account that owns this TaskChannel.



287
288
289
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_channel.rb', line 287

def 
  @properties['account_sid']
end

#context ⇒ TaskChannelContext

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

Returns:



278
279
280
281
282
283
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_channel.rb', line 278

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

#date_created ⇒ Time

Returns The date this TaskChannel was created.

Returns:

  • (Time) —

    The date this TaskChannel was created.



293
294
295
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_channel.rb', line 293

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns The date this TaskChannel was updated.

Returns:

  • (Time) —

    The date this TaskChannel was updated.



299
300
301
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_channel.rb', line 299

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Deletes the TaskChannelInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



357
358
359
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_channel.rb', line 357

def delete
  context.delete
end

#fetch ⇒ TaskChannelInstance

Fetch a TaskChannelInstance

Returns:



342
343
344
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_channel.rb', line 342

def fetch
  context.fetch
end

#friendly_name ⇒ String

Returns The friendly name of this TaskChannel.

Returns:

  • (String) —

    The friendly name of this TaskChannel



305
306
307
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_channel.rb', line 305

def friendly_name
  @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



370
371
372
373
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_channel.rb', line 370

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

#links ⇒ String

Returns The links.

Returns:

  • (String) —

    The links



335
336
337
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_channel.rb', line 335

def links
  @properties['links']
end

#sid ⇒ String

Returns The unique ID for this TaskChannel.

Returns:

  • (String) —

    The unique ID for this TaskChannel.



311
312
313
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_channel.rb', line 311

def sid
  @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



363
364
365
366
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_channel.rb', line 363

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

#unique_name ⇒ String

Returns The unique name of TaskChannel, such as 'voice', 'sms', etc.

Returns:

  • (String) —

    The unique name of TaskChannel, such as 'voice', 'sms', etc.



317
318
319
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_channel.rb', line 317

def unique_name
  @properties['unique_name']
end

#update(friendly_name: :unset) ⇒ TaskChannelInstance

Update the TaskChannelInstance

Parameters:

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

    Toggle the FriendlyName for the TaskChannel

Returns:



350
351
352
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_channel.rb', line 350

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

#url ⇒ String

Returns The url.

Returns:

  • (String) —

    The url



329
330
331
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_channel.rb', line 329

def url
  @properties['url']
end

#workspace_sid ⇒ String

Returns The unique ID of the Workspace that this TaskChannel belongs to.

Returns:

  • (String) —

    The unique ID of the Workspace that this TaskChannel belongs to.



323
324
325
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_channel.rb', line 323

def workspace_sid
  @properties['workspace_sid']
end