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

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



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

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.



80
81
82
83
84
85
86
87
88
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/activity.rb', line 80

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.



122
123
124
125
126
127
128
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/activity.rb', line 122

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.



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

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.



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/activity.rb', line 101

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



68
69
70
71
72
73
74
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/activity.rb', line 68

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



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

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