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



21
22
23
24
25
26
27
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/activity.rb', line 21

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



146
147
148
149
150
151
152
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/activity.rb', line 146

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

  payload = @version.create('POST', @uri, data: data)

  ActivityInstance.new(@version, payload, workspace_sid: @solution[:workspace_sid], )
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.



84
85
86
87
88
89
90
91
92
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/activity.rb', line 84

def each
  limits = @version.read_limits

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

  @version.stream(page,
                  limit: limits[:limit],
                  page_limit: limits[:page_limit]).each {|x| yield x}
end

#get_page(target_url) ⇒ Page

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



126
127
128
129
130
131
132
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/activity.rb', line 126

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.



46
47
48
49
50
51
52
53
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/activity.rb', line 46

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

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



107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/activity.rb', line 107

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,
  })

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

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

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

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



72
73
74
75
76
77
78
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/activity.rb', line 72

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], )

  @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
end

#to_s ⇒ Object

Provide a user friendly representation



156
157
158
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/activity.rb', line 156

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