Class: Twilio::REST::FlexApi::V1::InsightsQuestionnairesContext

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

Instance Method Summary collapse

Constructor Details

#initialize(version, questionnaire_sid) ⇒ InsightsQuestionnairesContext

Initialize the InsightsQuestionnairesContext

Parameters:

  • version (Version) —

    Version that contains the resource

  • questionnaire_sid (String) —

    The SID of the questionnaire



253
254
255
256
257
258
259
260
261
262
 
# File 'lib/twilio-ruby/rest/flex_api/v1/insights_questionnaires.rb', line 253

def initialize(version, questionnaire_sid)
    super(version)
    

    # Path Solution
    @solution = { questionnaire_sid: questionnaire_sid,  }
    @uri = "/Insights/QualityManagement/Questionnaires/#{@solution[:questionnaire_sid]}"

    
end

Instance Method Details

#delete(authorization: :unset) ⇒ Boolean

Delete the InsightsQuestionnairesInstance

Parameters:

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

    The Authorization HTTP request header

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



267
268
269
270
271
272
273
274
275
276
277
 
# File 'lib/twilio-ruby/rest/flex_api/v1/insights_questionnaires.rb', line 267

def delete(
    authorization: :unset
)

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', 'Authorization' => authorization, })
    
    
    

    @version.delete('DELETE', @uri, headers: headers)
end

#delete_with_metadata(authorization: :unset) ⇒ Boolean

Delete the InsightsQuestionnairesInstanceMetadata

Parameters:

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

    The Authorization HTTP request header

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
 
# File 'lib/twilio-ruby/rest/flex_api/v1/insights_questionnaires.rb', line 283

def delete_with_metadata(
  authorization: :unset
)

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', 'Authorization' => authorization, })
    
    
    
      response = @version.delete_with_metadata('DELETE', @uri, headers: headers)
      insightsQuestionnaires_instance = InsightsQuestionnairesInstance.new(
          @version,
          response.body,
          account_sid: @solution[:account_sid],
          sid: @solution[:sid],
      )
      InsightsQuestionnairesInstanceMetadata.new(@version, insightsQuestionnaires_instance, response.headers, response.status_code)
end

#fetch(authorization: :unset) ⇒ InsightsQuestionnairesInstance

Fetch the InsightsQuestionnairesInstance

Parameters:

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

    The Authorization HTTP request header

Returns:



305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
 
# File 'lib/twilio-ruby/rest/flex_api/v1/insights_questionnaires.rb', line 305

def fetch(
    authorization: :unset
)

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', 'Authorization' => authorization, })
    
    
    
    
    
    payload = @version.fetch('GET', @uri, headers: headers)
    InsightsQuestionnairesInstance.new(
        @version,
        payload,
        questionnaire_sid: @solution[:questionnaire_sid],
    )
end

#fetch_with_metadata(authorization: :unset) ⇒ InsightsQuestionnairesInstance

Fetch the InsightsQuestionnairesInstanceMetadata

Parameters:

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

    The Authorization HTTP request header

Returns:



327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
 
# File 'lib/twilio-ruby/rest/flex_api/v1/insights_questionnaires.rb', line 327

def fetch_with_metadata(
  authorization: :unset
)

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

#inspect ⇒ Object

Provide a detailed, user friendly representation



441
442
443
444
 
# File 'lib/twilio-ruby/rest/flex_api/v1/insights_questionnaires.rb', line 441

def inspect
    context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
    "#<Twilio.FlexApi.V1.InsightsQuestionnairesContext #{context}>"
end

#to_s ⇒ Object

Provide a user friendly representation



434
435
436
437
 
# File 'lib/twilio-ruby/rest/flex_api/v1/insights_questionnaires.rb', line 434

def to_s
    context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
    "#<Twilio.FlexApi.V1.InsightsQuestionnairesContext #{context}>"
end

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

Update the InsightsQuestionnairesInstance

Parameters:

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

    The flag to enable or disable questionnaire

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

    The name of this questionnaire

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

    The description of this 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:



359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
 
# File 'lib/twilio-ruby/rest/flex_api/v1/insights_questionnaires.rb', line 359

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

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

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

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

Update the InsightsQuestionnairesInstanceMetadata

Parameters:

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

    The flag to enable or disable questionnaire

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

    The name of this questionnaire

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

    The description of this 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:



396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
 
# File 'lib/twilio-ruby/rest/flex_api/v1/insights_questionnaires.rb', line 396

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

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

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