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



26
27
28
29
30
31
32
 
# 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



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

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

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



116
117
118
119
120
121
122
123
124
 
# File 'lib/twilio-ruby/rest/flex_api/v1/insights_questionnaires.rb', line 116

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.



154
155
156
157
158
159
160
 
# File 'lib/twilio-ruby/rest/flex_api/v1/insights_questionnaires.rb', line 154

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.



79
80
81
82
83
84
85
86
 
# File 'lib/twilio-ruby/rest/flex_api/v1/insights_questionnaires.rb', line 79

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

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



135
136
137
138
139
140
141
142
143
144
145
146
147
 
# File 'lib/twilio-ruby/rest/flex_api/v1/insights_questionnaires.rb', line 135

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

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

    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.



101
102
103
104
105
106
107
108
109
110
 
# File 'lib/twilio-ruby/rest/flex_api/v1/insights_questionnaires.rb', line 101

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



165
166
167
 
# File 'lib/twilio-ruby/rest/flex_api/v1/insights_questionnaires.rb', line 165

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