@@ -77,6 +77,98 @@ def create(self, category_id, category_name, segment_id, user_name, user_email,
77
77
78
78
return AssessmentsInstance (self ._version , payload , )
79
79
80
+ def stream (self , segment_id = values .unset , token = values .unset , limit = None ,
81
+ page_size = None ):
82
+ """
83
+ Streams AssessmentsInstance records from the API as a generator stream.
84
+ This operation lazily loads records as efficiently as possible until the limit
85
+ is reached.
86
+ The results are returned as a generator, so this operation is memory efficient.
87
+
88
+ :param unicode segment_id: Segment Id.
89
+ :param unicode token: The Token HTTP request header
90
+ :param int limit: Upper limit for the number of records to return. stream()
91
+ guarantees to never return more than limit. Default is no limit
92
+ :param int page_size: Number of records to fetch per request, when not set will use
93
+ the default value of 50 records. If no page_size is defined
94
+ but a limit is defined, stream() will attempt to read the
95
+ limit with the most efficient page size, i.e. min(limit, 1000)
96
+
97
+ :returns: Generator that will yield up to limit results
98
+ :rtype: list[twilio.rest.flex_api.v1.assessments.AssessmentsInstance]
99
+ """
100
+ limits = self ._version .read_limits (limit , page_size )
101
+
102
+ page = self .page (segment_id = segment_id , token = token , page_size = limits ['page_size' ], )
103
+
104
+ return self ._version .stream (page , limits ['limit' ])
105
+
106
+ def list (self , segment_id = values .unset , token = values .unset , limit = None ,
107
+ page_size = None ):
108
+ """
109
+ Lists AssessmentsInstance records from the API as a list.
110
+ Unlike stream(), this operation is eager and will load `limit` records into
111
+ memory before returning.
112
+
113
+ :param unicode segment_id: Segment Id.
114
+ :param unicode token: The Token HTTP request header
115
+ :param int limit: Upper limit for the number of records to return. list() guarantees
116
+ never to return more than limit. Default is no limit
117
+ :param int page_size: Number of records to fetch per request, when not set will use
118
+ the default value of 50 records. If no page_size is defined
119
+ but a limit is defined, list() will attempt to read the limit
120
+ with the most efficient page size, i.e. min(limit, 1000)
121
+
122
+ :returns: Generator that will yield up to limit results
123
+ :rtype: list[twilio.rest.flex_api.v1.assessments.AssessmentsInstance]
124
+ """
125
+ return list (self .stream (segment_id = segment_id , token = token , limit = limit , page_size = page_size , ))
126
+
127
+ def page (self , segment_id = values .unset , token = values .unset ,
128
+ page_token = values .unset , page_number = values .unset ,
129
+ page_size = values .unset ):
130
+ """
131
+ Retrieve a single page of AssessmentsInstance records from the API.
132
+ Request is executed immediately
133
+
134
+ :param unicode segment_id: Segment Id.
135
+ :param unicode token: The Token HTTP request header
136
+ :param str page_token: PageToken provided by the API
137
+ :param int page_number: Page Number, this value is simply for client state
138
+ :param int page_size: Number of records to return, defaults to 50
139
+
140
+ :returns: Page of AssessmentsInstance
141
+ :rtype: twilio.rest.flex_api.v1.assessments.AssessmentsPage
142
+ """
143
+ data = values .of ({
144
+ 'SegmentId' : segment_id ,
145
+ 'PageToken' : page_token ,
146
+ 'Page' : page_number ,
147
+ 'PageSize' : page_size ,
148
+ })
149
+ headers = values .of ({'Token' : token , })
150
+
151
+ response = self ._version .page (method = 'GET' , uri = self ._uri , params = data , headers = headers , )
152
+
153
+ return AssessmentsPage (self ._version , response , self ._solution )
154
+
155
+ def get_page (self , target_url ):
156
+ """
157
+ Retrieve a specific page of AssessmentsInstance records from the API.
158
+ Request is executed immediately
159
+
160
+ :param str target_url: API-generated URL for the requested results page
161
+
162
+ :returns: Page of AssessmentsInstance
163
+ :rtype: twilio.rest.flex_api.v1.assessments.AssessmentsPage
164
+ """
165
+ response = self ._version .domain .twilio .request (
166
+ 'GET' ,
167
+ target_url ,
168
+ )
169
+
170
+ return AssessmentsPage (self ._version , response , self ._solution )
171
+
80
172
def get (self , assessment_id ):
81
173
"""
82
174
Constructs a AssessmentsContext
0 commit comments