Class: Twilio::REST::FlexApi::V1::InsightsQuestionnairesQuestionList

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

Overview

PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact [email protected].

Instance Method Summary collapse

Constructor Details

#initialize(version) ⇒ InsightsQuestionnairesQuestionList

Initialize the InsightsQuestionnairesQuestionList

Parameters:

  • version (Version) —

    Version that contains the resource



20
21
22
23
24
25
26
 
# File 'lib/twilio-ruby/rest/flex_api/v1/insights_questionnaires_question.rb', line 20

def initialize(version)
  super(version)

  # Path Solution
  @solution = {}
  @uri = "/Insights/QM/Questions"
end

Instance Method Details

#create(category_id: nil, question: nil, description: nil, answer_set_id: nil, allow_na: nil, token: :unset) ⇒ InsightsQuestionnairesQuestionInstance

Create the InsightsQuestionnairesQuestionInstance

Parameters:

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

    The ID of the category

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

    The question.

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

    The description for the question.

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

    The answer_set for the question.

  • allow_na (Boolean) (defaults to: nil) —

    The flag to enable for disable NA for answer.

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

    The Token HTTP request header

Returns:



37
38
39
40
41
42
43
44
45
46
47
48
49
50
 
# File 'lib/twilio-ruby/rest/flex_api/v1/insights_questionnaires_question.rb', line 37

def create(category_id: nil, question: nil, description: nil, answer_set_id: nil, allow_na: nil, token: :unset)
  data = Twilio::Values.of({
      'CategoryId' => category_id,
      'Question' => question,
      'Description' => description,
      'AnswerSetId' => answer_set_id,
      'AllowNa' => allow_na,
  })
  headers = Twilio::Values.of({'Token' => token, })

  payload = @version.create('POST', @uri, data: data, headers: headers)

  InsightsQuestionnairesQuestionInstance.new(@version, payload, )
end

#each ⇒ Object

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



94
95
96
97
98
99
100
101
102
 
# File 'lib/twilio-ruby/rest/flex_api/v1/insights_questionnaires_question.rb', line 94

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

Parameters:

  • target_url (String) —

    API-generated URL for the requested results page

Returns:

  • (Page) —

    Page of InsightsQuestionnairesQuestionInstance



132
133
134
135
136
137
138
 
# File 'lib/twilio-ruby/rest/flex_api/v1/insights_questionnaires_question.rb', line 132

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

#list(category_id: :unset, token: :unset, limit: nil, page_size: nil) ⇒ Array

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

Parameters:

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

    The list of category IDs

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

    The Token HTTP request header

  • 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



65
66
67
 
# File 'lib/twilio-ruby/rest/flex_api/v1/insights_questionnaires_question.rb', line 65

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

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

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

Parameters:

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

    The list of category IDs

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

    The Token HTTP request header

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



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

def page(category_id: :unset, token: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
  params = Twilio::Values.of({
      'CategoryId' => Twilio.serialize_list(category_id) { |e| e },
      'PageToken' => page_token,
      'Page' => page_number,
      'PageSize' => page_size,
  })
  headers = Twilio::Values.of({'Token' => token, })

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

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

#stream(category_id: :unset, token: :unset, limit: nil, page_size: nil) ⇒ Enumerable

Streams InsightsQuestionnairesQuestionInstance records from the API as an Enumerable. This operation lazily loads records as efficiently as possible until the limit is reached.

Parameters:

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

    The list of category IDs

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

    The Token HTTP request header

  • 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



82
83
84
85
86
87
88
 
# File 'lib/twilio-ruby/rest/flex_api/v1/insights_questionnaires_question.rb', line 82

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

  page = self.page(category_id: category_id, token: token, 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



142
143
144
 
# File 'lib/twilio-ruby/rest/flex_api/v1/insights_questionnaires_question.rb', line 142

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