Class: Twilio::REST::Taskrouter::V1::WorkspaceContext::WorkflowList

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

Instance Method Summary collapse

Constructor Details

#initialize(version, workspace_sid: nil) ⇒ WorkflowList

Initialize the WorkflowList



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

def initialize(version, workspace_sid: nil)
  super(version)

  # Path Solution
  @solution = {workspace_sid: workspace_sid}
  @uri = "/Workspaces/#{@solution[:workspace_sid]}/Workflows"
end

Instance Method Details

#create(friendly_name: nil, configuration: nil, assignment_callback_url: :unset, fallback_assignment_callback_url: :unset, task_reservation_timeout: :unset) ⇒ WorkflowInstance

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



138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow.rb', line 138

def create(friendly_name: nil, configuration: nil, assignment_callback_url: :unset, fallback_assignment_callback_url: :unset, task_reservation_timeout: :unset)
  data = Twilio::Values.of({
      'FriendlyName' => friendly_name,
      'Configuration' => configuration,
      'AssignmentCallbackUrl' => assignment_callback_url,
      'FallbackAssignmentCallbackUrl' => fallback_assignment_callback_url,
      'TaskReservationTimeout' => task_reservation_timeout,
  })

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

  WorkflowInstance.new(@version, payload, workspace_sid: @solution[:workspace_sid], )
end

#each ⇒ Object

When passed a block, yields WorkflowInstance 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
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow.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 WorkflowInstance records from the API. Request is executed immediately.



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

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

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

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



42
43
44
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow.rb', line 42

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



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

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
  )
  WorkflowPage.new(@version, response, @solution)
end

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

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



59
60
61
62
63
64
65
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow.rb', line 59

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



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

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