Class: Twilio::REST::Taskrouter::V1::WorkspaceList

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

Instance Method Summary collapse

Constructor Details

#initialize(version) ⇒ WorkspaceList

Initialize the WorkspaceList



18
19
20
21
22
23
24
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 18

def initialize(version)
  super(version)

  # Path Solution
  @solution = {}
  @uri = "/Workspaces"
end

Instance Method Details

#create(friendly_name: nil, event_callback_url: :unset, events_filter: :unset, multi_task_enabled: :unset, template: :unset, prioritize_queue_order: :unset) ⇒ WorkspaceInstance

Create the WorkspaceInstance



148
149
150
151
152
153
154
155
156
157
158
159
160
161
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 148

def create(friendly_name: nil, event_callback_url: :unset, events_filter: :unset, multi_task_enabled: :unset, template: :unset, prioritize_queue_order: :unset)
  data = Twilio::Values.of({
      'FriendlyName' => friendly_name,
      'EventCallbackUrl' => event_callback_url,
      'EventsFilter' => events_filter,
      'MultiTaskEnabled' => multi_task_enabled,
      'Template' => template,
      'PrioritizeQueueOrder' => prioritize_queue_order,
  })

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

  WorkspaceInstance.new(@version, payload, )
end

#each ⇒ Object

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



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

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 WorkspaceInstance records from the API. Request is executed immediately.



105
106
107
108
109
110
111
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 105

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

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

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



39
40
41
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 39

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

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

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



87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 87

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

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

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

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

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



56
57
58
59
60
61
62
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 56

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

  page = self.page(friendly_name: friendly_name, 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



165
166
167
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 165

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