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 that contains the resource



28
29
30
31
32
33
34
35
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow.rb', line 28

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

Create the WorkflowInstance

Parameters:

  • (defaults to: nil)

    A descriptive string that you create to describe the Workflow resource. For example, ‘Inbound Call Workflow` or `2014 Outbound Campaign`.

  • (defaults to: nil)

    A JSON string that contains the rules to apply to the Workflow. See [Configuring Workflows](www.twilio.com/docs/taskrouter/workflow-configuration) for more information.

  • (defaults to: :unset)

    The URL from your application that will process task assignment events. See [Handling Task Assignment Callback](www.twilio.com/docs/taskrouter/handle-assignment-callbacks) for more details.

  • (defaults to: :unset)

    The URL that we should call when a call to the assignment_callback_url fails.

  • (defaults to: :unset)

    How long TaskRouter will wait for a confirmation response from your application after it assigns a Task to a Worker. Can be up to ‘86,400` (24 hours) and the default is 120.

Returns:

  • Created WorkflowInstance



44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow.rb', line 44

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,
    })

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    payload = @version.create('POST', @uri, data: data, headers: headers)
    WorkflowInstance.new(
        @version,
        payload,
        workspace_sid: @solution[:workspace_sid],
    )
end

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

Create the WorkflowInstanceMetadata

Parameters:

  • (defaults to: nil)

    A descriptive string that you create to describe the Workflow resource. For example, ‘Inbound Call Workflow` or `2014 Outbound Campaign`.

  • (defaults to: nil)

    A JSON string that contains the rules to apply to the Workflow. See [Configuring Workflows](www.twilio.com/docs/taskrouter/workflow-configuration) for more information.

  • (defaults to: :unset)

    The URL from your application that will process task assignment events. See [Handling Task Assignment Callback](www.twilio.com/docs/taskrouter/handle-assignment-callbacks) for more details.

  • (defaults to: :unset)

    The URL that we should call when a call to the assignment_callback_url fails.

  • (defaults to: :unset)

    How long TaskRouter will wait for a confirmation response from your application after it assigns a Task to a Worker. Can be up to ‘86,400` (24 hours) and the default is 120.

Returns:

  • Created WorkflowInstance



82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow.rb', line 82

def create_with_metadata(
  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,
    })

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    response = @version.create_with_metadata('POST', @uri, data: data, headers: headers)
    workflow_instance = WorkflowInstance.new(
        @version,
        response.body,
        workspace_sid: @solution[:workspace_sid],
    )
    WorkflowInstanceMetadata.new(
        @version,
        workflow_instance,
        response.headers,
        response.status_code
    )
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.



189
190
191
192
193
194
195
196
197
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow.rb', line 189

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:

  • API-generated URL for the requested results page

Returns:

  • Page of WorkflowInstance



228
229
230
231
232
233
234
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow.rb', line 228

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:

  • (defaults to: :unset)

    The friendly_name of the Workflow resources to read.

  • (defaults to: nil)

    Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit

  • (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 of up to limit results



131
132
133
134
135
136
137
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow.rb', line 131

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

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

Returns Array of up to limit results.

Parameters:

  • (defaults to: nil)

    Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit

  • (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 of up to limit results



171
172
173
174
175
176
177
178
179
180
181
182
183
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow.rb', line 171

def list_with_metadata(friendly_name: :unset, limit: nil, page_size: nil)
    limits = @version.read_limits(limit, page_size)
    params = Twilio::Values.of({
        'FriendlyName' => friendly_name,
        
        'PageSize' => limits[:page_size],
    });
    headers = Twilio::Values.of({})

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

    WorkflowPageMetadata.new(@version, response, @solution, limits[:limit])
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:

  • (defaults to: :unset)

    The friendly_name of the Workflow resources to read.

  • (defaults to: :unset)

    PageToken provided by the API

  • (defaults to: :unset)

    Page Number, this value is simply for client state

  • (defaults to: :unset)

    Number of records to return, defaults to 50

Returns:

  • Page of WorkflowInstance



207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow.rb', line 207

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,
    })
    headers = Twilio::Values.of({})
    
    

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

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

Parameters:

  • (defaults to: :unset)

    The friendly_name of the Workflow resources to read.

  • (defaults to: nil)

    Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit

  • (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 that will yield up to limit results



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

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



239
240
241
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow.rb', line 239

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