Class: Twilio::REST::Taskrouter::V1::WorkspaceContext::ActivityContext

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

Instance Method Summary collapse

Constructor Details

#initialize(version, workspace_sid, sid) ⇒ ActivityContext

Initialize the ActivityContext

Parameters:

  • version (Version) —

    Version that contains the resource

  • workspace_sid (String) —

    The SID of the Workspace with the Activity resources to update.

  • sid (String) —

    The SID of the Activity resource to update.



172
173
174
175
176
177
178
179
180
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/activity.rb', line 172

def initialize(version, workspace_sid, sid)
    super(version)

    # Path Solution
    @solution = { workspace_sid: workspace_sid, sid: sid,  }
    @uri = "/Workspaces/#{@solution[:workspace_sid]}/Activities/#{@solution[:sid]}"

    
end

Instance Method Details

#delete ⇒ Boolean

Delete the ActivityInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



184
185
186
187
188
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/activity.rb', line 184

def delete

    
    @version.delete('DELETE', @uri)
end

#fetch ⇒ ActivityInstance

Fetch the ActivityInstance

Returns:



193
194
195
196
197
198
199
200
201
202
203
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/activity.rb', line 193

def fetch

    
    payload = @version.fetch('GET', @uri)
    ActivityInstance.new(
        @version,
        payload,
        workspace_sid: @solution[:workspace_sid],
        sid: @solution[:sid],
    )
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



237
238
239
240
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/activity.rb', line 237

def inspect
    context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
    "#<Twilio.Taskrouter.V1.ActivityContext #{context}>"
end

#to_s ⇒ Object

Provide a user friendly representation



230
231
232
233
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/activity.rb', line 230

def to_s
    context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
    "#<Twilio.Taskrouter.V1.ActivityContext #{context}>"
end

#update(friendly_name: :unset) ⇒ ActivityInstance

Update the ActivityInstance

Parameters:

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

    A descriptive string that you create to describe the Activity resource. It can be up to 64 characters long. These names are used to calculate and expose statistics about Workers, and provide visibility into the state of each Worker. Examples of friendly names include: ‘on-call`, `break`, and `email`.

Returns:



209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/activity.rb', line 209

def update(
    friendly_name: :unset
)

    data = Twilio::Values.of({
        'FriendlyName' => friendly_name,
    })

    
    payload = @version.update('POST', @uri, data: data)
    ActivityInstance.new(
        @version,
        payload,
        workspace_sid: @solution[:workspace_sid],
        sid: @solution[:sid],
    )
end