Class: Twilio::REST::Taskrouter::V1::WorkspaceList
- Inherits:
-
ListResource
- Object
- ListResource
- Twilio::REST::Taskrouter::V1::WorkspaceList
- Defined in:
- lib/twilio-ruby/rest/taskrouter/v1/workspace.rb
Instance Method Summary collapse
-
#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.
-
#each ⇒ Object
When passed a block, yields WorkspaceInstance records from the API.
-
#get_page(target_url) ⇒ Page
Retrieve a single page of WorkspaceInstance records from the API.
-
#initialize(version) ⇒ WorkspaceList
constructor
Initialize the WorkspaceList.
-
#list(friendly_name: :unset, limit: nil, page_size: nil) ⇒ Array
Lists WorkspaceInstance records from the API as a list.
-
#page(friendly_name: :unset, page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page
Retrieve a single page of WorkspaceInstance records from the API.
-
#stream(friendly_name: :unset, limit: nil, page_size: nil) ⇒ Enumerable
Streams Instance records from the API as an Enumerable.
-
#to_s ⇒ Object
Provide a user friendly representation.
Constructor Details
#initialize(version) ⇒ WorkspaceList
Initialize the WorkspaceList
25 26 27 28 29 30 31 |
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 25 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
41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 |
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 41 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.
113 114 115 116 117 118 119 120 121 |
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 113 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.
149 150 151 152 153 154 155 |
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 149 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.
79 80 81 82 83 84 85 |
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 79 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.
131 132 133 134 135 136 137 138 139 140 141 142 |
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 131 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 Instance records from the API as an Enumerable. This operation lazily loads records as efficiently as possible until the limit is reached.
99 100 101 102 103 104 105 106 107 |
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 99 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
160 161 162 |
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 160 def to_s '#<Twilio.Taskrouter.V1.WorkspaceList>' end |