Class: Twilio::REST::FlexApi::V1::InsightsQuestionnairesQuestionInstance

Inherits:
InstanceResource
  • 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, payload, question_id: nil) ⇒ InsightsQuestionnairesQuestionInstance

Initialize the InsightsQuestionnairesQuestionInstance

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

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

    The unique ID of the question



252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
 
# File 'lib/twilio-ruby/rest/flex_api/v1/insights_questionnaires_question.rb', line 252

def initialize(version, payload, question_id: nil)
  super(version)

  # Marshaled Properties
  @properties = {
      'account_sid' => payload['account_sid'],
      'question_id' => payload['question_id'],
      'question' => payload['question'],
      'description' => payload['description'],
      'category' => payload['category'],
      'answer_set_id' => payload['answer_set_id'],
      'allow_na' => payload['allow_na'],
      'usage' => payload['usage'] == nil ? payload['usage'] : payload['usage'].to_i,
      'answer_set' => payload['answer_set'],
      'url' => payload['url'],
  }

  # Context
  @instance_context = nil
  @params = {'question_id' => question_id || @properties['question_id'], }
end

Instance Method Details

#account_sid ⇒ String

Returns The SID of the Account that created the resource and owns this Flex Insights.

Returns:

  • (String) —

    The SID of the Account that created the resource and owns this Flex Insights



287
288
289
 
# File 'lib/twilio-ruby/rest/flex_api/v1/insights_questionnaires_question.rb', line 287

def 
  @properties['account_sid']
end

#allow_na ⇒ Boolean

Returns Flag to enable NA for answer.

Returns:

  • (Boolean) —

    Flag to enable NA for answer.



323
324
325
 
# File 'lib/twilio-ruby/rest/flex_api/v1/insights_questionnaires_question.rb', line 323

def allow_na
  @properties['allow_na']
end

#answer_set ⇒ Hash

Returns Question’s Answer set.

Returns:

  • (Hash) —

    Question’s Answer set



335
336
337
 
# File 'lib/twilio-ruby/rest/flex_api/v1/insights_questionnaires_question.rb', line 335

def answer_set
  @properties['answer_set']
end

#answer_set_id ⇒ String

Returns The answer_set for question.

Returns:

  • (String) —

    The answer_set for question.



317
318
319
 
# File 'lib/twilio-ruby/rest/flex_api/v1/insights_questionnaires_question.rb', line 317

def answer_set_id
  @properties['answer_set_id']
end

#category ⇒ Hash

Returns The question category.

Returns:

  • (Hash) —

    The question category.



311
312
313
 
# File 'lib/twilio-ruby/rest/flex_api/v1/insights_questionnaires_question.rb', line 311

def category
  @properties['category']
end

#context ⇒ InsightsQuestionnairesQuestionContext

Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context

Returns:



278
279
280
281
282
283
 
# File 'lib/twilio-ruby/rest/flex_api/v1/insights_questionnaires_question.rb', line 278

def context
  unless @instance_context
    @instance_context = InsightsQuestionnairesQuestionContext.new(@version, @params['question_id'], )
  end
  @instance_context
end

#delete(token: :unset) ⇒ Boolean

Delete the InsightsQuestionnairesQuestionInstance

Parameters:

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

    The Token HTTP request header

Returns:

  • (Boolean) —

    true if delete succeeds, false otherwise



369
370
371
 
# File 'lib/twilio-ruby/rest/flex_api/v1/insights_questionnaires_question.rb', line 369

def delete(token: :unset)
  context.delete(token: token, )
end

#description ⇒ String

Returns The question description.

Returns:

  • (String) —

    The question description.



305
306
307
 
# File 'lib/twilio-ruby/rest/flex_api/v1/insights_questionnaires_question.rb', line 305

def description
  @properties['description']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



382
383
384
385
 
# File 'lib/twilio-ruby/rest/flex_api/v1/insights_questionnaires_question.rb', line 382

def inspect
  values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
  "<Twilio.FlexApi.V1.InsightsQuestionnairesQuestionInstance #{values}>"
end

#question ⇒ String

Returns The question.

Returns:

  • (String) —

    The question.



299
300
301
 
# File 'lib/twilio-ruby/rest/flex_api/v1/insights_questionnaires_question.rb', line 299

def question
  @properties['question']
end

#question_id ⇒ String

Returns Unique Question ID.

Returns:

  • (String) —

    Unique Question ID



293
294
295
 
# File 'lib/twilio-ruby/rest/flex_api/v1/insights_questionnaires_question.rb', line 293

def question_id
  @properties['question_id']
end

#to_s ⇒ Object

Provide a user friendly representation



375
376
377
378
 
# File 'lib/twilio-ruby/rest/flex_api/v1/insights_questionnaires_question.rb', line 375

def to_s
  values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
  "<Twilio.FlexApi.V1.InsightsQuestionnairesQuestionInstance #{values}>"
end

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

Update the InsightsQuestionnairesQuestionInstance

Parameters:

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

    The flag to enable for disable NA for answer.

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

    The ID of the category

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

    The question.

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

    The description for the question.

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

    The answer_set for the question.

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

    The Token HTTP request header

Returns:



354
355
356
357
358
359
360
361
362
363
 
# File 'lib/twilio-ruby/rest/flex_api/v1/insights_questionnaires_question.rb', line 354

def update(allow_na: nil, category_id: :unset, question: :unset, description: :unset, answer_set_id: :unset, token: :unset)
  context.update(
      allow_na: allow_na,
      category_id: category_id,
      question: question,
      description: description,
      answer_set_id: answer_set_id,
      token: token,
  )
end

#url ⇒ String

Returns The url.

Returns:

  • (String) —

    The url



341
342
343
 
# File 'lib/twilio-ruby/rest/flex_api/v1/insights_questionnaires_question.rb', line 341

def url
  @properties['url']
end

#usage ⇒ String

Returns Questions usage.

Returns:

  • (String) —

    Questions usage



329
330
331
 
# File 'lib/twilio-ruby/rest/flex_api/v1/insights_questionnaires_question.rb', line 329

def usage
  @properties['usage']
end