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

Inherits:
ListResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/flex_api/v1/insights_questionnaires.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) ⇒ InsightsQuestionnairesList

Initialize the InsightsQuestionnairesList

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.rb', line 20

def initialize(version)
  super(version)

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

Instance Method Details

#create(name: nil, description: :unset, active: :unset, question_ids: :unset, token: :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_ids (Array[String]) (defaults to: :unset) —

    The list of questions ids under a questionnaire

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

    The Token HTTP request header

Returns:



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

def create(name: nil, description: :unset, active: :unset, question_ids: :unset, token: :unset)
  data = Twilio::Values.of({
      'Name' => name,
      'Description' => description,
      'Active' => active,
      'QuestionIds' => Twilio.serialize_list(question_ids) { |e| e },
  })
  headers = Twilio::Values.of({'Token' => token, })

  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.



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

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



139
140
141
142
143
144
145
 
# File 'lib/twilio-ruby/rest/flex_api/v1/insights_questionnaires.rb', line 139

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

#list(include_inactive: :unset, token: :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:

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

    Flag indicating whether to include inactive questionnaires or not

  • 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
68
69
70
71
72
 
# File 'lib/twilio-ruby/rest/flex_api/v1/insights_questionnaires.rb', line 65

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

#page(include_inactive: :unset, token: :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:

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

    Flag indicating whether to include inactive questionnaires or not

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



120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'lib/twilio-ruby/rest/flex_api/v1/insights_questionnaires.rb', line 120

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

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

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

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

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

Parameters:

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

    Flag indicating whether to include inactive questionnaires or not

  • 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



88
89
90
91
92
93
94
 
# File 'lib/twilio-ruby/rest/flex_api/v1/insights_questionnaires.rb', line 88

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

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



149
150
151
 
# File 'lib/twilio-ruby/rest/flex_api/v1/insights_questionnaires.rb', line 149

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