Class: Twilio::REST::Taskrouter::V1::WorkspaceContext::ActivityList

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

Instance Method Summary collapse

Constructor Details

#initialize(version, workspace_sid: nil) ⇒ ActivityList

Initialize the ActivityList

Parameters:

  • version (Version) —

    Version that contains the resource



28
29
30
31
32
33
34
35
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/activity.rb', line 28

def initialize(version, workspace_sid: nil)
    super(version)
    
    # Path Solution
    @solution = { workspace_sid: workspace_sid }
    @uri = "/Workspaces/#{@solution[:workspace_sid]}/Activities"
    
end

Instance Method Details

#create(friendly_name: nil, available: :unset) ⇒ ActivityInstance

Create the ActivityInstance

Parameters:

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

    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`.

  • available (Boolean) (defaults to: :unset) —

    Whether the Worker should be eligible to receive a Task when it occupies the Activity. A value of ‘true`, `1`, or `yes` specifies the Activity is available. All other values specify that it is not. The value cannot be changed after the Activity is created.

Returns:



41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/activity.rb', line 41

def create(
  friendly_name: nil, 
  available: :unset
)

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

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    payload = @version.create('POST', @uri, data: data, headers: headers)
    ActivityInstance.new(
        @version,
        payload,
        workspace_sid: @solution[:workspace_sid],
    )
end

#create_with_metadata(friendly_name: nil, available: :unset) ⇒ ActivityInstance

Create the ActivityInstanceMetadata

Parameters:

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

    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`.

  • available (Boolean) (defaults to: :unset) —

    Whether the Worker should be eligible to receive a Task when it occupies the Activity. A value of ‘true`, `1`, or `yes` specifies the Activity is available. All other values specify that it is not. The value cannot be changed after the Activity is created.

Returns:



70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/activity.rb', line 70

def create_with_metadata(
  friendly_name: nil, 
  available: :unset
)

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

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    response = @version.create_with_metadata('POST', @uri, data: data, headers: headers)
    activity_instance = ActivityInstance.new(
        @version,
        response.body,
        workspace_sid: @solution[:workspace_sid],
    )
    ActivityInstanceMetadata.new(
        @version,
        activity_instance,
        response.headers,
        response.status_code
    )
end

#each ⇒ Object

When passed a block, yields ActivityInstance records from the API. This operation lazily loads records as efficiently as possible until the limit is reached.



181
182
183
184
185
186
187
188
189
190
191
192
193
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/activity.rb', line 181

def each
    limits = @version.read_limits

    page = self.page(page_size: limits[:page_size], )

    return [].each if page.nil?

    result = @version.stream(page,
        limit: limits[:limit],
        page_limit: limits[:page_limit])
    return [].each if result.nil?
    result.each {|x| yield x}
end

#get_page(target_url) ⇒ Page

Retrieve a single page of ActivityInstance records from the API. Request is executed immediately.

Parameters:

  • target_url (String) —

    API-generated URL for the requested results page

Returns:

  • (Page) —

    Page of ActivityInstance



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

def get_page(target_url)
    response = @version.domain.request(
        'GET',
        target_url
    )
ActivityPage.new(@version, response, @solution)
end

#list(friendly_name: :unset, available: :unset, limit: nil, page_size: nil) ⇒ Array

Lists ActivityInstance records from the API as a list. Unlike stream(), this operation is eager and will load ‘limit` records into memory before returning.

Parameters:

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

    The ‘friendly_name` of the Activity resources to read.

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

    Whether return only Activity resources that are available or unavailable. A value of ‘true` returns only available activities. Values of ’1’ or ‘yes` also indicate `true`. All other values represent `false` and return activities that are unavailable.

  • limit (Integer) (defaults to: nil) —

    Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit

  • page_size (Integer) (defaults to: nil) —

    Number of records to fetch per request, when not set will use the default value of 50 records. If no page_size is defined but a limit is defined, stream() will attempt to read the limit with the most efficient page size, i.e. min(limit, 1000)

Returns:

  • (Array) —

    Array of up to limit results



114
115
116
117
118
119
120
121
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/activity.rb', line 114

def list(friendly_name: :unset, available: :unset, limit: nil, page_size: nil)
    self.stream(
        friendly_name: friendly_name,
        available: available,
        limit: limit,
        page_size: page_size
    ).entries
end

#list_with_metadata(friendly_name: :unset, available: :unset, limit: nil, page_size: nil) ⇒ Array

Returns Array of up to limit results.

Parameters:

  • limit (Integer) (defaults to: nil) —

    Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit

  • page_size (Integer) (defaults to: nil) —

    Number of records to fetch per request, when not set will use the default value of 50 records. If no page_size is defined but a limit is defined, stream() will attempt to read the limit with the most efficient page size, i.e. min(limit, 1000)

Returns:

  • (Array) —

    Array of up to limit results



162
163
164
165
166
167
168
169
170
171
172
173
174
175
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/activity.rb', line 162

def list_with_metadata(friendly_name: :unset, available: :unset, limit: nil, page_size: nil)
    limits = @version.read_limits(limit, page_size)
    params = Twilio::Values.of({
        'FriendlyName' => friendly_name,
        'Available' => available,
        
        'PageSize' => limits[:page_size],
    });
    headers = Twilio::Values.of({})

    response = @version.page('GET', @uri, params: params, headers: headers)

    ActivityPageMetadata.new(@version, response, @solution, limits[:limit])
end

#page(friendly_name: :unset, available: :unset, page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page

Retrieve a single page of ActivityInstance records from the API. Request is executed immediately.

Parameters:

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

    The ‘friendly_name` of the Activity resources to read.

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

    Whether return only Activity resources that are available or unavailable. A value of ‘true` returns only available activities. Values of ’1’ or ‘yes` also indicate `true`. All other values represent `false` and return activities that are unavailable.

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

    PageToken provided by the API

  • page_number (Integer) (defaults to: :unset) —

    Page Number, this value is simply for client state

  • page_size (Integer) (defaults to: :unset) —

    Number of records to return, defaults to 50

Returns:

  • (Page) —

    Page of ActivityInstance



204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/activity.rb', line 204

def page(friendly_name: :unset, available: :unset, page_token: :unset, page_number: :unset,page_size: :unset)
    params = Twilio::Values.of({
        'FriendlyName' => friendly_name,
        'Available' => available,
        'PageToken' => page_token,
        'Page' => page_number,
        'PageSize' => page_size,
    })
    headers = Twilio::Values.of({})
    
    

    response = @version.page('GET', @uri, params: params, headers: headers)

    ActivityPage.new(@version, response, @solution)
end

#stream(friendly_name: :unset, available: :unset, limit: nil, page_size: nil) ⇒ Enumerable

Streams Instance records from the API as an Enumerable. This operation lazily loads records as efficiently as possible until the limit is reached.

Parameters:

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

    The ‘friendly_name` of the Activity resources to read.

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

    Whether return only Activity resources that are available or unavailable. A value of ‘true` returns only available activities. Values of ’1’ or ‘yes` also indicate `true`. All other values represent `false` and return activities that are unavailable.

  • limit (Integer) (defaults to: nil) —

    Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit

  • page_size (Integer) (defaults to: nil) —

    Number of records to fetch per request, when not set will use the default value of 50 records. If no page_size is defined but a limit is defined, stream() will attempt to read the limit with the most efficient page size, i.e. min(limit, 1000)

Returns:

  • (Enumerable) —

    Enumerable that will yield up to limit results



136
137
138
139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/activity.rb', line 136

def stream(friendly_name: :unset, available: :unset, limit: nil, page_size: nil)
    limits = @version.read_limits(limit, page_size)

    page = self.page(
        friendly_name: friendly_name,
        available: available,
        page_size: limits[:page_size], )

    return [].each if page.nil?

    result = @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
    return [].each if result.nil?
    result
end

#to_s ⇒ Object

Provide a user friendly representation



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

def to_s
    '#<Twilio.Taskrouter.V1.ActivityList>'
end