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

Parameters:

  • version (Version) —

    Version that contains the resource

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

    The workspace_sid



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

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.

Parameters:

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

    The friendly_name

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

    The configuration

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

    The assignment_callback_url

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

    The fallback_assignment_callback_url

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

    The task_reservation_timeout

Returns:



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

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.



75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow.rb', line 75

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.

Parameters:

  • target_url (String) —

    API-generated URL for the requested results page

Returns:

  • (Page) —

    Page of WorkflowInstance



115
116
117
118
119
120
121
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow.rb', line 115

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.

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



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

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.

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 WorkflowInstance



95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow.rb', line 95

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.

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



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

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



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

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