Class: Twilio::REST::FlexApi::V1::InsightsQuestionnairesList

Inherits:
ListResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/flex_api/v1/insights_questionnaires.rb

Instance Method Summary collapse

Constructor Details

#initialize(version) ⇒ InsightsQuestionnairesList

Initialize the InsightsQuestionnairesList

Parameters:

  • version (Version) —

    Version that contains the resource



26
27
28
29
30
31
32
33
 
# File 'lib/twilio-ruby/rest/flex_api/v1/insights_questionnaires.rb', line 26

def initialize(version)
    super(version)
    
    # Path Solution
    @solution = {  }
    @uri = "/Insights/QualityManagement/Questionnaires"
    
end

Instance Method Details

#create(name: nil, description: :unset, active: :unset, question_sids: :unset, authorization: :unset) ⇒ InsightsQuestionnairesInstance

Create the InsightsQuestionnairesInstance

Parameters:

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

    The name of this questionnaire

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

    The description of this questionnaire

  • active (Boolean) (defaults to: :unset) —

    The flag to enable or disable questionnaire

  • question_sids (Array[String]) (defaults to: :unset) —

    The list of questions sids under a questionnaire

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

    The Authorization HTTP request header

Returns:



42
43
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
 
# File 'lib/twilio-ruby/rest/flex_api/v1/insights_questionnaires.rb', line 42

def create(
    name: nil, 
    description: :unset, 
    active: :unset, 
    question_sids: :unset, 
    authorization: :unset
)

    data = Twilio::Values.of({
        'Name' => name,
        'Description' => description,
        'Active' => active,
        'QuestionSids' => Twilio.serialize_list(question_sids) { |e| e },
    })

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

#create_with_metadata(name: nil, description: :unset, active: :unset, question_sids: :unset, authorization: :unset) ⇒ InsightsQuestionnairesInstance

Create the InsightsQuestionnairesInstanceMetadata

Parameters:

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

    The name of this questionnaire

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

    The description of this questionnaire

  • active (Boolean) (defaults to: :unset) —

    The flag to enable or disable questionnaire

  • question_sids (Array[String]) (defaults to: :unset) —

    The list of questions sids under a questionnaire

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

    The Authorization HTTP request header

Returns:



78
79
80
81
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
 
# File 'lib/twilio-ruby/rest/flex_api/v1/insights_questionnaires.rb', line 78

def create_with_metadata(
  name: nil, 
  description: :unset, 
  active: :unset, 
  question_sids: :unset, 
  authorization: :unset
)

    data = Twilio::Values.of({
        'Name' => name,
        'Description' => description,
        'Active' => active,
        'QuestionSids' => Twilio.serialize_list(question_sids) { |e| e },
    })

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', 'Authorization' => authorization, })
    
    
    
    
    
    response = @version.create_with_metadata('POST', @uri, data: data, headers: headers)
    insights_questionnaires_instance = InsightsQuestionnairesInstance.new(
        @version,
        response.body,
    )
    InsightsQuestionnairesInstanceMetadata.new(
        @version,
        insights_questionnaires_instance,
        response.headers,
        response.status_code
    )
end

#each ⇒ Object

When passed a block, yields InsightsQuestionnairesInstance 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/flex_api/v1/insights_questionnaires.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 InsightsQuestionnairesInstance records from the API. Request is executed immediately.

Parameters:

  • target_url (String) —

    API-generated URL for the requested results page

Returns:

  • (Page) —

    Page of InsightsQuestionnairesInstance



230
231
232
233
234
235
236
 
# File 'lib/twilio-ruby/rest/flex_api/v1/insights_questionnaires.rb', line 230

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

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

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

Parameters:

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

    The Authorization HTTP request header

  • include_inactive (Boolean) (defaults to: :unset) —

    Flag indicating whether to include inactive questionnaires or not

  • 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



126
127
128
129
130
131
132
133
 
# File 'lib/twilio-ruby/rest/flex_api/v1/insights_questionnaires.rb', line 126

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

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

Returns Array of up to limit results.

Parameters:

  • 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



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

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

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

    InsightsQuestionnairesPageMetadata.new(@version, response, @solution, limits[:limit])
end

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

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

Parameters:

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

    The Authorization HTTP request header

  • include_inactive (Boolean) (defaults to: :unset) —

    Flag indicating whether to include inactive questionnaires or not

  • 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 InsightsQuestionnairesInstance



208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
 
# File 'lib/twilio-ruby/rest/flex_api/v1/insights_questionnaires.rb', line 208

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

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

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

#stream(authorization: :unset, include_inactive: :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:

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

    The Authorization HTTP request header

  • include_inactive (Boolean) (defaults to: :unset) —

    Flag indicating whether to include inactive questionnaires or not

  • 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



148
149
150
151
152
153
154
155
156
157
 
# File 'lib/twilio-ruby/rest/flex_api/v1/insights_questionnaires.rb', line 148

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

    page = self.page(
        authorization: authorization,
        include_inactive: include_inactive,
        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



241
242
243
 
# File 'lib/twilio-ruby/rest/flex_api/v1/insights_questionnaires.rb', line 241

def to_s
    '#<Twilio.FlexApi.V1.InsightsQuestionnairesList>'
end