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

Parameters:

  • version (Version) —

    Version that contains the resource



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

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

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

Parameters:

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

    The friendly_name

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

    The event_callback_url

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

    The events_filter

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

    The multi_task_enabled

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

    The template

  • prioritize_queue_order (workspace.QueueOrder) (defaults to: :unset) —

    The prioritize_queue_order

Returns:



129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 129

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.



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

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.

Parameters:

  • target_url (String) —

    API-generated URL for the requested results page

Returns:

  • (Page) —

    Page of WorkspaceInstance



111
112
113
114
115
116
117
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 111

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.

Parameters:

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

    The friendly_name

  • 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



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

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.

Parameters:

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

    The friendly_name

  • 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 WorkspaceInstance



91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 91

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

Parameters:

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

    The friendly_name

  • 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



56
57
58
59
60
61
62
63
64
65
 
# 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



153
154
155
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 153

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