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 SID of the Workspace that contains the Task Channel.

  • sid (String) (defaults to: nil)

    The SID of the Task Channel resource to fetch.


252
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 252

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'],
      'channel_optimized_routing' => payload['channel_optimized_routing'],
      'url' => payload['url'],
      'links' => payload['links'],
  }

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

Instance Method Details

#account_sidString

Returns The SID of the Account that created the resource.

Returns:

  • (String)

    The SID of the Account that created the resource


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

def 
  @properties['account_sid']
end

#channel_optimized_routingBoolean

Returns Whether the Task Channel will prioritize Workers that have been idle.

Returns:

  • (Boolean)

    Whether the Task Channel will prioritize Workers that have been idle


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

def channel_optimized_routing
  @properties['channel_optimized_routing']
end

#contextTaskChannelContext

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_createdTime

Returns The ISO 8601 date and time in GMT when the resource was created.

Returns:

  • (Time)

    The ISO 8601 date and time in GMT when the resource 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_updatedTime

Returns The ISO 8601 date and time in GMT when the resource was last updated.

Returns:

  • (Time)

    The ISO 8601 date and time in GMT when the resource was last updated


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

def date_updated
  @properties['date_updated']
end

#deleteBoolean

Delete the TaskChannelInstance

Returns:

  • (Boolean)

    true if delete succeeds, false otherwise


367
368
369
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_channel.rb', line 367

def delete
  context.delete
end

#fetchTaskChannelInstance

Fetch the TaskChannelInstance

Returns:


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

def fetch
  context.fetch
end

#friendly_nameString

Returns The string that you assigned to describe the resource.

Returns:

  • (String)

    The string that you assigned to describe the resource


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

def friendly_name
  @properties['friendly_name']
end

#inspectObject

Provide a detailed, user friendly representation


380
381
382
383
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_channel.rb', line 380

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

Returns The URLs of related resources.

Returns:

  • (String)

    The URLs of related resources


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

def links
  @properties['links']
end

#sidString

Returns The unique string that identifies the resource.

Returns:

  • (String)

    The unique string that identifies the resource


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

def sid
  @properties['sid']
end

#to_sObject

Provide a user friendly representation


373
374
375
376
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_channel.rb', line 373

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

#unique_nameString

Returns An application-defined string that uniquely identifies the Task Channel.

Returns:

  • (String)

    An application-defined string that uniquely identifies the Task Channel


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, channel_optimized_routing: :unset) ⇒ TaskChannelInstance

Update the TaskChannelInstance

Parameters:

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

    A descriptive string that you create to describe the Task Channel. It can be up to 64 characters long.

  • channel_optimized_routing (Boolean) (defaults to: :unset)

    Whether the TaskChannel should prioritize Workers that have been idle. If `true`, Workers that have been idle the longest are prioritized.

Returns:


360
361
362
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_channel.rb', line 360

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

#urlString

Returns The absolute URL of the Task Channel resource.

Returns:

  • (String)

    The absolute URL of the Task Channel resource


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

def url
  @properties['url']
end

#workspace_sidString

Returns The SID of the Workspace that contains the Task Channel.

Returns:

  • (String)

    The SID of the Workspace that contains the Task Channel


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

def workspace_sid
  @properties['workspace_sid']
end