Class: Twilio::REST::Autopilot::V1::AssistantContext::TaskList

Inherits:
ListResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/autopilot/v1/assistant/task.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, assistant_sid: nil) ⇒ TaskList

Initialize the TaskList



27
28
29
30
31
32
33
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/task.rb', line 27

def initialize(version, assistant_sid: nil)
    super(version)
    # Path Solution
    @solution = { assistant_sid: assistant_sid }
    @uri = "/Assistants/#{@solution[:assistant_sid]}/Tasks"
    
end

Instance Method Details

#create(unique_name: nil, friendly_name: :unset, actions: :unset, actions_url: :unset) ⇒ TaskInstance

Create the TaskInstance



41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/task.rb', line 41

def create(
    unique_name: nil, 
    friendly_name: :unset, 
    actions: :unset, 
    actions_url: :unset
)

    data = Twilio::Values.of({
        'UniqueName' => unique_name,
        'FriendlyName' => friendly_name,
        'Actions' => Twilio.serialize_object(actions),
        'ActionsUrl' => actions_url,
    })

    payload = @version.create('POST', @uri, data: data)
    TaskInstance.new(
        @version,
        payload,
        assistant_sid: @solution[:assistant_sid],
    )
end

#each ⇒ Object

When passed a block, yields TaskInstance records from the API. This operation lazily loads records as efficiently as possible until the limit is reached.



106
107
108
109
110
111
112
113
114
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/task.rb', line 106

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



140
141
142
143
144
145
146
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/task.rb', line 140

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

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

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



75
76
77
78
79
80
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/task.rb', line 75

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

#page(page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page

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



123
124
125
126
127
128
129
130
131
132
133
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/task.rb', line 123

def page(page_token: :unset, page_number: :unset, page_size: :unset)
    params = Twilio::Values.of({
        'PageToken' => page_token,
        'Page' => page_number,
        'PageSize' => page_size,
    })

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

    TaskPage.new(@version, response, @solution)
end

#stream(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.



93
94
95
96
97
98
99
100
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/task.rb', line 93

def stream(limit: nil, page_size: nil)
    limits = @version.read_limits(limit, page_size)

    page = self.page(
        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



151
152
153
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/task.rb', line 151

def to_s
    '#<Twilio.Autopilot.V1.TaskList>'
end