twilio-ruby 5.67.3 → 5.74.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/.github/workflows/pr-lint.yml +8 -2
- data/.github/workflows/test-and-deploy.yml +3 -3
- data/CHANGES.md +288 -0
- data/LICENSE +1 -1
- data/Makefile +6 -2
- data/PULL_REQUEST_TEMPLATE.md +1 -1
- data/README.md +2 -2
- data/lib/twilio-ruby/rest/api/v2010/account/address.rb +19 -3
- data/lib/twilio-ruby/rest/api/v2010/account/application.rb +22 -3
- data/lib/twilio-ruby/rest/api/v2010/account/available_phone_number/local.rb +2 -2
- data/lib/twilio-ruby/rest/api/v2010/account/available_phone_number/machine_to_machine.rb +2 -2
- data/lib/twilio-ruby/rest/api/v2010/account/available_phone_number/mobile.rb +2 -2
- data/lib/twilio-ruby/rest/api/v2010/account/available_phone_number/national.rb +2 -2
- data/lib/twilio-ruby/rest/api/v2010/account/available_phone_number/shared_cost.rb +2 -2
- data/lib/twilio-ruby/rest/api/v2010/account/available_phone_number/toll_free.rb +2 -2
- data/lib/twilio-ruby/rest/api/v2010/account/available_phone_number/voip.rb +2 -2
- data/lib/twilio-ruby/rest/api/v2010/account/call/feedback.rb +1 -1
- data/lib/twilio-ruby/rest/api/v2010/account/call/feedback_summary.rb +5 -5
- data/lib/twilio-ruby/rest/api/v2010/account/call/recording.rb +2 -2
- data/lib/twilio-ruby/rest/api/v2010/account/call/user_defined_message.rb +160 -0
- data/lib/twilio-ruby/rest/api/v2010/account/call/user_defined_message_subscription.rb +251 -0
- data/lib/twilio-ruby/rest/api/v2010/account/call.rb +59 -0
- data/lib/twilio-ruby/rest/api/v2010/account/conference/participant.rb +56 -17
- data/lib/twilio-ruby/rest/api/v2010/account/conference/recording.rb +1 -1
- data/lib/twilio-ruby/rest/api/v2010/account/conference.rb +5 -5
- data/lib/twilio-ruby/rest/api/v2010/account/message.rb +17 -1
- data/lib/twilio-ruby/rest/api/v2010/account/queue/member.rb +2 -2
- data/lib/twilio-ruby/rest/api/v2010/account/queue.rb +3 -3
- data/lib/twilio-ruby/rest/api/v2010/account/recording/transcription.rb +1 -1
- data/lib/twilio-ruby/rest/api/v2010/account/recording.rb +1 -1
- data/lib/twilio-ruby/rest/api/v2010/account/sip/ip_access_control_list/ip_address.rb +5 -5
- data/lib/twilio-ruby/rest/api/v2010/account/sip/ip_access_control_list.rb +3 -3
- data/lib/twilio-ruby/rest/api/v2010/account/transcription.rb +1 -1
- data/lib/twilio-ruby/rest/api/v2010/account/usage/record/all_time.rb +1 -1
- data/lib/twilio-ruby/rest/api/v2010/account/usage/record/daily.rb +1 -1
- data/lib/twilio-ruby/rest/api/v2010/account/usage/record/last_month.rb +1 -1
- data/lib/twilio-ruby/rest/api/v2010/account/usage/record/monthly.rb +1 -1
- data/lib/twilio-ruby/rest/api/v2010/account/usage/record/this_month.rb +1 -1
- data/lib/twilio-ruby/rest/api/v2010/account/usage/record/today.rb +1 -1
- data/lib/twilio-ruby/rest/api/v2010/account/usage/record/yearly.rb +1 -1
- data/lib/twilio-ruby/rest/api/v2010/account/usage/record/yesterday.rb +1 -1
- data/lib/twilio-ruby/rest/api/v2010/account/usage/record.rb +1 -1
- data/lib/twilio-ruby/rest/autopilot/v1/assistant/task/task_statistics.rb +2 -2
- data/lib/twilio-ruby/rest/bulkexports/v1/export/day.rb +1 -1
- data/lib/twilio-ruby/rest/chat/v1/service/channel/message.rb +1 -1
- data/lib/twilio-ruby/rest/chat/v1/service/channel.rb +2 -2
- data/lib/twilio-ruby/rest/chat/v1/service/user.rb +1 -1
- data/lib/twilio-ruby/rest/chat/v1/service.rb +2 -2
- data/lib/twilio-ruby/rest/chat/v2/service/channel/message.rb +1 -1
- data/lib/twilio-ruby/rest/chat/v2/service/channel.rb +2 -2
- data/lib/twilio-ruby/rest/chat/v2/service/user.rb +1 -1
- data/lib/twilio-ruby/rest/chat/v2/service.rb +4 -4
- data/lib/twilio-ruby/rest/chat/v3/channel.rb +2 -2
- data/lib/twilio-ruby/rest/client.rb +28 -0
- data/lib/twilio-ruby/rest/content/v1/content/approval_fetch.rb +195 -0
- data/lib/twilio-ruby/rest/content/v1/content.rb +346 -0
- data/lib/twilio-ruby/rest/content/v1/legacy_content.rb +254 -0
- data/lib/twilio-ruby/rest/content/v1.rb +52 -0
- data/lib/twilio-ruby/rest/content.rb +53 -0
- data/lib/twilio-ruby/rest/conversations/v1/conversation/message/delivery_receipt.rb +1 -1
- data/lib/twilio-ruby/rest/conversations/v1/conversation/message.rb +17 -2
- data/lib/twilio-ruby/rest/conversations/v1/service/conversation/message/delivery_receipt.rb +1 -1
- data/lib/twilio-ruby/rest/conversations/v1/service/conversation/message.rb +17 -2
- data/lib/twilio-ruby/rest/events/v1/schema/version.rb +1 -1
- data/lib/twilio-ruby/rest/events/v1/schema.rb +1 -1
- data/lib/twilio-ruby/rest/events/v1/subscription/subscribed_event.rb +1 -1
- data/lib/twilio-ruby/rest/flex_api/v1/assessments.rb +397 -0
- data/lib/twilio-ruby/rest/flex_api/v1/configuration.rb +14 -0
- data/lib/twilio-ruby/rest/flex_api/v1/insights_assessments_comment.rb +314 -0
- data/lib/twilio-ruby/rest/flex_api/v1/insights_questionnaires.rb +394 -0
- data/lib/twilio-ruby/rest/flex_api/v1/insights_questionnaires_category.rb +313 -0
- data/lib/twilio-ruby/rest/flex_api/v1/insights_questionnaires_question.rb +390 -0
- data/lib/twilio-ruby/rest/flex_api/v1/insights_segments.rb +413 -0
- data/lib/twilio-ruby/rest/{preview/trusted_comms/brands_information.rb → flex_api/v1/insights_session.rb} +58 -55
- data/lib/twilio-ruby/rest/flex_api/v1/insights_settings_answersets.rb +144 -0
- data/lib/twilio-ruby/rest/flex_api/v1/insights_settings_comment.rb +130 -0
- data/lib/twilio-ruby/rest/{preview/trusted_comms/cps.rb → flex_api/v1/insights_user_roles.rb} +42 -54
- data/lib/twilio-ruby/rest/flex_api/v1/interaction/interaction_channel.rb +22 -1
- data/lib/twilio-ruby/rest/flex_api/v1.rb +115 -0
- data/lib/twilio-ruby/rest/flex_api/v2/web_channels.rb +133 -0
- data/lib/twilio-ruby/rest/flex_api/v2.rb +35 -0
- data/lib/twilio-ruby/rest/flex_api.rb +83 -0
- data/lib/twilio-ruby/rest/insights/v1/call/annotation.rb +322 -0
- data/lib/twilio-ruby/rest/insights/v1/call/summary.rb +14 -0
- data/lib/twilio-ruby/rest/insights/v1/call.rb +16 -8
- data/lib/twilio-ruby/rest/insights/v1/call_summaries.rb +7 -0
- data/lib/twilio-ruby/rest/insights/v1/room/participant.rb +1 -1
- data/lib/twilio-ruby/rest/insights/v1/room.rb +3 -3
- data/lib/twilio-ruby/rest/insights/v1.rb +0 -16
- data/lib/twilio-ruby/rest/insights.rb +0 -8
- data/lib/twilio-ruby/rest/ip_messaging/v1/service/channel/message.rb +1 -1
- data/lib/twilio-ruby/rest/ip_messaging/v1/service/channel.rb +2 -2
- data/lib/twilio-ruby/rest/ip_messaging/v1/service/user.rb +1 -1
- data/lib/twilio-ruby/rest/ip_messaging/v1/service.rb +2 -2
- data/lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb +1 -1
- data/lib/twilio-ruby/rest/ip_messaging/v2/service/channel.rb +2 -2
- data/lib/twilio-ruby/rest/ip_messaging/v2/service/user.rb +1 -1
- data/lib/twilio-ruby/rest/ip_messaging/v2/service.rb +4 -4
- data/lib/twilio-ruby/rest/lookups/v2/phone_number.rb +94 -12
- data/lib/twilio-ruby/rest/media/v1/media_processor.rb +1 -1
- data/lib/twilio-ruby/rest/media/v1/media_recording.rb +2 -9
- data/lib/twilio-ruby/rest/media/v1/player_streamer.rb +5 -5
- data/lib/twilio-ruby/rest/messaging/v1/domain_cert.rb +257 -0
- data/lib/twilio-ruby/rest/messaging/v1/domain_config.rb +267 -0
- data/lib/twilio-ruby/rest/messaging/v1/service/alpha_sender.rb +2 -2
- data/lib/twilio-ruby/rest/messaging/v1/service/us_app_to_person.rb +98 -3
- data/lib/twilio-ruby/rest/messaging/v1/service.rb +1 -1
- data/lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb +709 -0
- data/lib/twilio-ruby/rest/messaging/v1.rb +50 -0
- data/lib/twilio-ruby/rest/messaging.rb +26 -0
- data/lib/twilio-ruby/rest/microvisor/v1/account_config.rb +317 -0
- data/lib/twilio-ruby/rest/microvisor/v1/account_secret.rb +310 -0
- data/lib/twilio-ruby/rest/microvisor/v1/app/app_manifest.rb +192 -0
- data/lib/twilio-ruby/rest/microvisor/v1/app.rb +330 -0
- data/lib/twilio-ruby/rest/microvisor/v1/device/device_config.rb +342 -0
- data/lib/twilio-ruby/rest/{preview/bulk_exports/export/day.rb → microvisor/v1/device/device_secret.rb} +125 -84
- data/lib/twilio-ruby/rest/microvisor/v1/device.rb +393 -0
- data/lib/twilio-ruby/rest/microvisor/v1.rb +92 -0
- data/lib/twilio-ruby/rest/microvisor.rb +70 -0
- data/lib/twilio-ruby/rest/notify/v1/service/notification.rb +1 -1
- data/lib/twilio-ruby/rest/oauth/v1/device_code.rb +153 -0
- data/lib/twilio-ruby/rest/oauth/v1/oauth.rb +162 -0
- data/lib/twilio-ruby/rest/oauth/v1/openid_discovery.rb +242 -0
- data/lib/twilio-ruby/rest/oauth/v1/token.rb +157 -0
- data/lib/twilio-ruby/rest/oauth/v1/user_info.rb +193 -0
- data/lib/twilio-ruby/rest/oauth/v1.rb +63 -0
- data/lib/twilio-ruby/rest/oauth.rb +68 -0
- data/lib/twilio-ruby/rest/preview/hosted_numbers/authorization_document/dependent_hosted_number_order.rb +2 -2
- data/lib/twilio-ruby/rest/preview/hosted_numbers/hosted_number_order.rb +2 -2
- data/lib/twilio-ruby/rest/preview/sync/service/sync_list/sync_list_item.rb +1 -1
- data/lib/twilio-ruby/rest/preview/understand/assistant/task/task_statistics.rb +2 -2
- data/lib/twilio-ruby/rest/preview/wireless/rate_plan.rb +1 -1
- data/lib/twilio-ruby/rest/preview.rb +0 -58
- data/lib/twilio-ruby/rest/proxy/v1/service/phone_number.rb +1 -1
- data/lib/twilio-ruby/rest/proxy/v1/service/session/participant.rb +1 -14
- data/lib/twilio-ruby/rest/proxy/v1/service/session.rb +5 -46
- data/lib/twilio-ruby/rest/proxy/v1/service.rb +1 -1
- data/lib/twilio-ruby/rest/routes/v2/phone_number.rb +235 -0
- data/lib/twilio-ruby/rest/routes/v2/sip_domain.rb +231 -0
- data/lib/twilio-ruby/rest/routes/v2/trunk.rb +235 -0
- data/lib/twilio-ruby/rest/routes/v2.rb +76 -0
- data/lib/twilio-ruby/rest/routes.rb +62 -0
- data/lib/twilio-ruby/rest/studio/v1/flow.rb +1 -1
- data/lib/twilio-ruby/rest/studio/v2/flow/flow_revision.rb +1 -1
- data/lib/twilio-ruby/rest/studio/v2/flow.rb +1 -1
- data/lib/twilio-ruby/rest/supersim/v1/esim_profile.rb +21 -1
- data/lib/twilio-ruby/rest/supersim/v1/fleet.rb +17 -7
- data/lib/twilio-ruby/rest/supersim/v1/ip_command.rb +5 -2
- data/lib/twilio-ruby/rest/supersim/v1/settings_update.rb +247 -0
- data/lib/twilio-ruby/rest/supersim/v1/sim/sim_ip_address.rb +195 -0
- data/lib/twilio-ruby/rest/supersim/v1/sim.rb +20 -0
- data/lib/twilio-ruby/rest/supersim/v1/sms_command.rb +3 -3
- data/lib/twilio-ruby/rest/supersim/v1/usage_record.rb +4 -4
- data/lib/twilio-ruby/rest/supersim/v1.rb +7 -0
- data/lib/twilio-ruby/rest/supersim.rb +6 -0
- data/lib/twilio-ruby/rest/sync/v1/service/sync_list/sync_list_item.rb +1 -1
- data/lib/twilio-ruby/rest/sync/v1/service.rb +1 -1
- data/lib/twilio-ruby/rest/taskrouter/v1/workspace/event.rb +1 -1
- data/lib/twilio-ruby/rest/taskrouter/v1/workspace/task/reservation.rb +18 -5
- data/lib/twilio-ruby/rest/taskrouter/v1/workspace/task.rb +3 -3
- data/lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue/task_queue_cumulative_statistics.rb +12 -12
- data/lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue/task_queue_real_time_statistics.rb +5 -5
- data/lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb +10 -4
- data/lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/worker_channel.rb +3 -3
- data/lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/workers_cumulative_statistics.rb +6 -6
- data/lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/workers_real_time_statistics.rb +1 -1
- data/lib/twilio-ruby/rest/taskrouter/v1/workspace/worker.rb +9 -3
- data/lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_cumulative_statistics.rb +13 -13
- data/lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_real_time_statistics.rb +2 -2
- data/lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow.rb +1 -1
- data/lib/twilio-ruby/rest/taskrouter/v1/workspace/workspace_cumulative_statistics.rb +13 -13
- data/lib/twilio-ruby/rest/taskrouter/v1/workspace/workspace_real_time_statistics.rb +3 -3
- data/lib/twilio-ruby/rest/trunking/v1/trunk/origination_url.rb +2 -2
- data/lib/twilio-ruby/rest/verify/v2/safelist.rb +215 -0
- data/lib/twilio-ruby/rest/verify/v2/service/access_token.rb +1 -9
- data/lib/twilio-ruby/rest/verify/v2/service/entity/challenge/notification.rb +1 -7
- data/lib/twilio-ruby/rest/verify/v2/service/entity/challenge.rb +0 -8
- data/lib/twilio-ruby/rest/verify/v2/service/entity/factor.rb +0 -8
- data/lib/twilio-ruby/rest/verify/v2/service/entity/new_factor.rb +0 -6
- data/lib/twilio-ruby/rest/verify/v2/service/entity.rb +0 -8
- data/lib/twilio-ruby/rest/verify/v2/service/rate_limit/bucket.rb +2 -2
- data/lib/twilio-ruby/rest/verify/v2/service/verification.rb +14 -10
- data/lib/twilio-ruby/rest/verify/v2/service/verification_check.rb +8 -1
- data/lib/twilio-ruby/rest/verify/v2/service/webhook.rb +0 -8
- data/lib/twilio-ruby/rest/verify/v2/service.rb +1 -1
- data/lib/twilio-ruby/rest/verify/v2/template.rb +7 -0
- data/lib/twilio-ruby/rest/verify/v2/verification_attempts_summary.rb +4 -4
- data/lib/twilio-ruby/rest/verify/v2.rb +18 -0
- data/lib/twilio-ruby/rest/verify.rb +8 -0
- data/lib/twilio-ruby/rest/video/v1/composition.rb +3 -3
- data/lib/twilio-ruby/rest/video/v1/recording.rb +2 -2
- data/lib/twilio-ruby/rest/video/v1/room/recording.rb +2 -2
- data/lib/twilio-ruby/rest/video/v1/room/room_participant/room_participant_anonymize.rb +240 -0
- data/lib/twilio-ruby/rest/video/v1/room/room_participant.rb +16 -0
- data/lib/twilio-ruby/rest/video/v1/room.rb +4 -4
- data/lib/twilio-ruby/rest/voice/v1/connection_policy/connection_policy_target.rb +2 -2
- data/lib/twilio-ruby/rest/voice/v1/dialing_permissions/bulk_country_update.rb +1 -1
- data/lib/twilio-ruby/rest/voice/v1/ip_record.rb +1 -1
- data/lib/twilio-ruby/rest/wireless/v1/rate_plan.rb +3 -3
- data/lib/twilio-ruby/rest/wireless/v1/sim/data_session.rb +2 -2
- data/lib/twilio-ruby/security/request_validator.rb +1 -1
- data/lib/twilio-ruby/twiml/voice_response.rb +135 -35
- data/lib/twilio-ruby/version.rb +1 -1
- data/twilio-ruby.gemspec +1 -1
- metadata +52 -17
- data/lib/twilio-ruby/rest/insights/v1/annotation.rb +0 -271
- data/lib/twilio-ruby/rest/preview/bulk_exports/export/export_custom_job.rb +0 -275
- data/lib/twilio-ruby/rest/preview/bulk_exports/export/job.rb +0 -249
- data/lib/twilio-ruby/rest/preview/bulk_exports/export.rb +0 -251
- data/lib/twilio-ruby/rest/preview/bulk_exports/export_configuration.rb +0 -234
- data/lib/twilio-ruby/rest/preview/bulk_exports.rb +0 -62
- data/lib/twilio-ruby/rest/preview/trusted_comms/branded_channel/channel.rb +0 -165
- data/lib/twilio-ruby/rest/preview/trusted_comms/branded_channel.rb +0 -225
- data/lib/twilio-ruby/rest/preview/trusted_comms/current_call.rb +0 -277
- data/lib/twilio-ruby/rest/preview/trusted_comms.rb +0 -65
@@ -0,0 +1,394 @@
|
|
1
|
+
##
|
2
|
+
# This code was generated by
|
3
|
+
# \ / _ _ _| _ _
|
4
|
+
# | (_)\/(_)(_|\/| |(/_ v1.0.0
|
5
|
+
# / /
|
6
|
+
#
|
7
|
+
# frozen_string_literal: true
|
8
|
+
|
9
|
+
module Twilio
|
10
|
+
module REST
|
11
|
+
class FlexApi < Domain
|
12
|
+
class V1 < Version
|
13
|
+
##
|
14
|
+
# 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 help@twilio.com.
|
15
|
+
class InsightsQuestionnairesList < ListResource
|
16
|
+
##
|
17
|
+
# Initialize the InsightsQuestionnairesList
|
18
|
+
# @param [Version] version Version that contains the resource
|
19
|
+
# @return [InsightsQuestionnairesList] InsightsQuestionnairesList
|
20
|
+
def initialize(version)
|
21
|
+
super(version)
|
22
|
+
|
23
|
+
# Path Solution
|
24
|
+
@solution = {}
|
25
|
+
@uri = "/Insights/QM/Questionnaires"
|
26
|
+
end
|
27
|
+
|
28
|
+
##
|
29
|
+
# Create the InsightsQuestionnairesInstance
|
30
|
+
# @param [String] name The name of this questionnaire
|
31
|
+
# @param [String] description The description of this questionnaire
|
32
|
+
# @param [Boolean] active The flag to enable or disable questionnaire
|
33
|
+
# @param [Array[String]] question_ids The list of questions ids under a
|
34
|
+
# questionnaire
|
35
|
+
# @param [String] token The Token HTTP request header
|
36
|
+
# @return [InsightsQuestionnairesInstance] Created InsightsQuestionnairesInstance
|
37
|
+
def create(name: nil, description: :unset, active: :unset, question_ids: :unset, token: :unset)
|
38
|
+
data = Twilio::Values.of({
|
39
|
+
'Name' => name,
|
40
|
+
'Description' => description,
|
41
|
+
'Active' => active,
|
42
|
+
'QuestionIds' => Twilio.serialize_list(question_ids) { |e| e },
|
43
|
+
})
|
44
|
+
headers = Twilio::Values.of({'Token' => token, })
|
45
|
+
|
46
|
+
payload = @version.create('POST', @uri, data: data, headers: headers)
|
47
|
+
|
48
|
+
InsightsQuestionnairesInstance.new(@version, payload, )
|
49
|
+
end
|
50
|
+
|
51
|
+
##
|
52
|
+
# Lists InsightsQuestionnairesInstance records from the API as a list.
|
53
|
+
# Unlike stream(), this operation is eager and will load `limit` records into
|
54
|
+
# memory before returning.
|
55
|
+
# @param [Boolean] include_inactive Flag indicating whether to include inactive
|
56
|
+
# questionnaires or not
|
57
|
+
# @param [String] token The Token HTTP request header
|
58
|
+
# @param [Integer] limit Upper limit for the number of records to return. stream()
|
59
|
+
# guarantees to never return more than limit. Default is no limit
|
60
|
+
# @param [Integer] page_size Number of records to fetch per request, when
|
61
|
+
# not set will use the default value of 50 records. If no page_size is defined
|
62
|
+
# but a limit is defined, stream() will attempt to read the limit with the most
|
63
|
+
# efficient page size, i.e. min(limit, 1000)
|
64
|
+
# @return [Array] Array of up to limit results
|
65
|
+
def list(include_inactive: :unset, token: :unset, limit: nil, page_size: nil)
|
66
|
+
self.stream(
|
67
|
+
include_inactive: include_inactive,
|
68
|
+
token: token,
|
69
|
+
limit: limit,
|
70
|
+
page_size: page_size
|
71
|
+
).entries
|
72
|
+
end
|
73
|
+
|
74
|
+
##
|
75
|
+
# Streams InsightsQuestionnairesInstance records from the API as an Enumerable.
|
76
|
+
# This operation lazily loads records as efficiently as possible until the limit
|
77
|
+
# is reached.
|
78
|
+
# @param [Boolean] include_inactive Flag indicating whether to include inactive
|
79
|
+
# questionnaires or not
|
80
|
+
# @param [String] token The Token HTTP request header
|
81
|
+
# @param [Integer] limit Upper limit for the number of records to return. stream()
|
82
|
+
# guarantees to never return more than limit. Default is no limit.
|
83
|
+
# @param [Integer] page_size Number of records to fetch per request, when
|
84
|
+
# not set will use the default value of 50 records. If no page_size is defined
|
85
|
+
# but a limit is defined, stream() will attempt to read the limit with the most
|
86
|
+
# efficient page size, i.e. min(limit, 1000)
|
87
|
+
# @return [Enumerable] Enumerable that will yield up to limit results
|
88
|
+
def stream(include_inactive: :unset, token: :unset, limit: nil, page_size: nil)
|
89
|
+
limits = @version.read_limits(limit, page_size)
|
90
|
+
|
91
|
+
page = self.page(include_inactive: include_inactive, token: token, page_size: limits[:page_size], )
|
92
|
+
|
93
|
+
@version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
|
94
|
+
end
|
95
|
+
|
96
|
+
##
|
97
|
+
# When passed a block, yields InsightsQuestionnairesInstance records from the API.
|
98
|
+
# This operation lazily loads records as efficiently as possible until the limit
|
99
|
+
# is reached.
|
100
|
+
def each
|
101
|
+
limits = @version.read_limits
|
102
|
+
|
103
|
+
page = self.page(page_size: limits[:page_size], )
|
104
|
+
|
105
|
+
@version.stream(page,
|
106
|
+
limit: limits[:limit],
|
107
|
+
page_limit: limits[:page_limit]).each {|x| yield x}
|
108
|
+
end
|
109
|
+
|
110
|
+
##
|
111
|
+
# Retrieve a single page of InsightsQuestionnairesInstance records from the API.
|
112
|
+
# Request is executed immediately.
|
113
|
+
# @param [Boolean] include_inactive Flag indicating whether to include inactive
|
114
|
+
# questionnaires or not
|
115
|
+
# @param [String] token The Token HTTP request header
|
116
|
+
# @param [String] page_token PageToken provided by the API
|
117
|
+
# @param [Integer] page_number Page Number, this value is simply for client state
|
118
|
+
# @param [Integer] page_size Number of records to return, defaults to 50
|
119
|
+
# @return [Page] Page of InsightsQuestionnairesInstance
|
120
|
+
def page(include_inactive: :unset, token: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
|
121
|
+
params = Twilio::Values.of({
|
122
|
+
'IncludeInactive' => include_inactive,
|
123
|
+
'PageToken' => page_token,
|
124
|
+
'Page' => page_number,
|
125
|
+
'PageSize' => page_size,
|
126
|
+
})
|
127
|
+
headers = Twilio::Values.of({'Token' => token, })
|
128
|
+
|
129
|
+
response = @version.page('GET', @uri, params: params, headers: headers)
|
130
|
+
|
131
|
+
InsightsQuestionnairesPage.new(@version, response, @solution)
|
132
|
+
end
|
133
|
+
|
134
|
+
##
|
135
|
+
# Retrieve a single page of InsightsQuestionnairesInstance records from the API.
|
136
|
+
# Request is executed immediately.
|
137
|
+
# @param [String] target_url API-generated URL for the requested results page
|
138
|
+
# @return [Page] Page of InsightsQuestionnairesInstance
|
139
|
+
def get_page(target_url)
|
140
|
+
response = @version.domain.request(
|
141
|
+
'GET',
|
142
|
+
target_url
|
143
|
+
)
|
144
|
+
InsightsQuestionnairesPage.new(@version, response, @solution)
|
145
|
+
end
|
146
|
+
|
147
|
+
##
|
148
|
+
# Provide a user friendly representation
|
149
|
+
def to_s
|
150
|
+
'#<Twilio.FlexApi.V1.InsightsQuestionnairesList>'
|
151
|
+
end
|
152
|
+
end
|
153
|
+
|
154
|
+
##
|
155
|
+
# 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 help@twilio.com.
|
156
|
+
class InsightsQuestionnairesPage < Page
|
157
|
+
##
|
158
|
+
# Initialize the InsightsQuestionnairesPage
|
159
|
+
# @param [Version] version Version that contains the resource
|
160
|
+
# @param [Response] response Response from the API
|
161
|
+
# @param [Hash] solution Path solution for the resource
|
162
|
+
# @return [InsightsQuestionnairesPage] InsightsQuestionnairesPage
|
163
|
+
def initialize(version, response, solution)
|
164
|
+
super(version, response)
|
165
|
+
|
166
|
+
# Path Solution
|
167
|
+
@solution = solution
|
168
|
+
end
|
169
|
+
|
170
|
+
##
|
171
|
+
# Build an instance of InsightsQuestionnairesInstance
|
172
|
+
# @param [Hash] payload Payload response from the API
|
173
|
+
# @return [InsightsQuestionnairesInstance] InsightsQuestionnairesInstance
|
174
|
+
def get_instance(payload)
|
175
|
+
InsightsQuestionnairesInstance.new(@version, payload, )
|
176
|
+
end
|
177
|
+
|
178
|
+
##
|
179
|
+
# Provide a user friendly representation
|
180
|
+
def to_s
|
181
|
+
'<Twilio.FlexApi.V1.InsightsQuestionnairesPage>'
|
182
|
+
end
|
183
|
+
end
|
184
|
+
|
185
|
+
##
|
186
|
+
# 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 help@twilio.com.
|
187
|
+
class InsightsQuestionnairesContext < InstanceContext
|
188
|
+
##
|
189
|
+
# Initialize the InsightsQuestionnairesContext
|
190
|
+
# @param [Version] version Version that contains the resource
|
191
|
+
# @param [String] id The unique ID of the questionnaire
|
192
|
+
# @return [InsightsQuestionnairesContext] InsightsQuestionnairesContext
|
193
|
+
def initialize(version, id)
|
194
|
+
super(version)
|
195
|
+
|
196
|
+
# Path Solution
|
197
|
+
@solution = {id: id, }
|
198
|
+
@uri = "/Insights/QM/Questionnaires/#{@solution[:id]}"
|
199
|
+
end
|
200
|
+
|
201
|
+
##
|
202
|
+
# Update the InsightsQuestionnairesInstance
|
203
|
+
# @param [Boolean] active The flag to enable or disable questionnaire
|
204
|
+
# @param [String] name The name of this questionnaire
|
205
|
+
# @param [String] description The description of this questionnaire
|
206
|
+
# @param [Array[String]] question_ids The list of questions ids under a
|
207
|
+
# questionnaire
|
208
|
+
# @param [String] token The Token HTTP request header
|
209
|
+
# @return [InsightsQuestionnairesInstance] Updated InsightsQuestionnairesInstance
|
210
|
+
def update(active: nil, name: :unset, description: :unset, question_ids: :unset, token: :unset)
|
211
|
+
data = Twilio::Values.of({
|
212
|
+
'Active' => active,
|
213
|
+
'Name' => name,
|
214
|
+
'Description' => description,
|
215
|
+
'QuestionIds' => Twilio.serialize_list(question_ids) { |e| e },
|
216
|
+
})
|
217
|
+
headers = Twilio::Values.of({'Token' => token, })
|
218
|
+
|
219
|
+
payload = @version.update('POST', @uri, data: data, headers: headers)
|
220
|
+
|
221
|
+
InsightsQuestionnairesInstance.new(@version, payload, id: @solution[:id], )
|
222
|
+
end
|
223
|
+
|
224
|
+
##
|
225
|
+
# Delete the InsightsQuestionnairesInstance
|
226
|
+
# @param [String] token The Token HTTP request header
|
227
|
+
# @return [Boolean] true if delete succeeds, false otherwise
|
228
|
+
def delete(token: :unset)
|
229
|
+
headers = Twilio::Values.of({'Token' => token, })
|
230
|
+
|
231
|
+
@version.delete('DELETE', @uri, headers: headers)
|
232
|
+
end
|
233
|
+
|
234
|
+
##
|
235
|
+
# Fetch the InsightsQuestionnairesInstance
|
236
|
+
# @param [String] token The Token HTTP request header
|
237
|
+
# @return [InsightsQuestionnairesInstance] Fetched InsightsQuestionnairesInstance
|
238
|
+
def fetch(token: :unset)
|
239
|
+
headers = Twilio::Values.of({'Token' => token, })
|
240
|
+
|
241
|
+
payload = @version.fetch('GET', @uri, headers: headers)
|
242
|
+
|
243
|
+
InsightsQuestionnairesInstance.new(@version, payload, id: @solution[:id], )
|
244
|
+
end
|
245
|
+
|
246
|
+
##
|
247
|
+
# Provide a user friendly representation
|
248
|
+
def to_s
|
249
|
+
context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
|
250
|
+
"#<Twilio.FlexApi.V1.InsightsQuestionnairesContext #{context}>"
|
251
|
+
end
|
252
|
+
|
253
|
+
##
|
254
|
+
# Provide a detailed, user friendly representation
|
255
|
+
def inspect
|
256
|
+
context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
|
257
|
+
"#<Twilio.FlexApi.V1.InsightsQuestionnairesContext #{context}>"
|
258
|
+
end
|
259
|
+
end
|
260
|
+
|
261
|
+
##
|
262
|
+
# 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 help@twilio.com.
|
263
|
+
class InsightsQuestionnairesInstance < InstanceResource
|
264
|
+
##
|
265
|
+
# Initialize the InsightsQuestionnairesInstance
|
266
|
+
# @param [Version] version Version that contains the resource
|
267
|
+
# @param [Hash] payload payload that contains response from Twilio
|
268
|
+
# @param [String] id The unique ID of the questionnaire
|
269
|
+
# @return [InsightsQuestionnairesInstance] InsightsQuestionnairesInstance
|
270
|
+
def initialize(version, payload, id: nil)
|
271
|
+
super(version)
|
272
|
+
|
273
|
+
# Marshaled Properties
|
274
|
+
@properties = {
|
275
|
+
'account_sid' => payload['account_sid'],
|
276
|
+
'id' => payload['id'],
|
277
|
+
'name' => payload['name'],
|
278
|
+
'description' => payload['description'],
|
279
|
+
'active' => payload['active'],
|
280
|
+
'questions' => payload['questions'],
|
281
|
+
'url' => payload['url'],
|
282
|
+
}
|
283
|
+
|
284
|
+
# Context
|
285
|
+
@instance_context = nil
|
286
|
+
@params = {'id' => id || @properties['id'], }
|
287
|
+
end
|
288
|
+
|
289
|
+
##
|
290
|
+
# Generate an instance context for the instance, the context is capable of
|
291
|
+
# performing various actions. All instance actions are proxied to the context
|
292
|
+
# @return [InsightsQuestionnairesContext] InsightsQuestionnairesContext for this InsightsQuestionnairesInstance
|
293
|
+
def context
|
294
|
+
unless @instance_context
|
295
|
+
@instance_context = InsightsQuestionnairesContext.new(@version, @params['id'], )
|
296
|
+
end
|
297
|
+
@instance_context
|
298
|
+
end
|
299
|
+
|
300
|
+
##
|
301
|
+
# @return [String] The SID of the Account that created the resource and owns this Flex Insights
|
302
|
+
def account_sid
|
303
|
+
@properties['account_sid']
|
304
|
+
end
|
305
|
+
|
306
|
+
##
|
307
|
+
# @return [String] The questionnaire id
|
308
|
+
def id
|
309
|
+
@properties['id']
|
310
|
+
end
|
311
|
+
|
312
|
+
##
|
313
|
+
# @return [String] The category name.
|
314
|
+
def name
|
315
|
+
@properties['name']
|
316
|
+
end
|
317
|
+
|
318
|
+
##
|
319
|
+
# @return [String] The questionnaire description
|
320
|
+
def description
|
321
|
+
@properties['description']
|
322
|
+
end
|
323
|
+
|
324
|
+
##
|
325
|
+
# @return [Boolean] Is questionnaire enabled ?
|
326
|
+
def active
|
327
|
+
@properties['active']
|
328
|
+
end
|
329
|
+
|
330
|
+
##
|
331
|
+
# @return [Array[Hash]] The questions list
|
332
|
+
def questions
|
333
|
+
@properties['questions']
|
334
|
+
end
|
335
|
+
|
336
|
+
##
|
337
|
+
# @return [String] The url
|
338
|
+
def url
|
339
|
+
@properties['url']
|
340
|
+
end
|
341
|
+
|
342
|
+
##
|
343
|
+
# Update the InsightsQuestionnairesInstance
|
344
|
+
# @param [Boolean] active The flag to enable or disable questionnaire
|
345
|
+
# @param [String] name The name of this questionnaire
|
346
|
+
# @param [String] description The description of this questionnaire
|
347
|
+
# @param [Array[String]] question_ids The list of questions ids under a
|
348
|
+
# questionnaire
|
349
|
+
# @param [String] token The Token HTTP request header
|
350
|
+
# @return [InsightsQuestionnairesInstance] Updated InsightsQuestionnairesInstance
|
351
|
+
def update(active: nil, name: :unset, description: :unset, question_ids: :unset, token: :unset)
|
352
|
+
context.update(
|
353
|
+
active: active,
|
354
|
+
name: name,
|
355
|
+
description: description,
|
356
|
+
question_ids: question_ids,
|
357
|
+
token: token,
|
358
|
+
)
|
359
|
+
end
|
360
|
+
|
361
|
+
##
|
362
|
+
# Delete the InsightsQuestionnairesInstance
|
363
|
+
# @param [String] token The Token HTTP request header
|
364
|
+
# @return [Boolean] true if delete succeeds, false otherwise
|
365
|
+
def delete(token: :unset)
|
366
|
+
context.delete(token: token, )
|
367
|
+
end
|
368
|
+
|
369
|
+
##
|
370
|
+
# Fetch the InsightsQuestionnairesInstance
|
371
|
+
# @param [String] token The Token HTTP request header
|
372
|
+
# @return [InsightsQuestionnairesInstance] Fetched InsightsQuestionnairesInstance
|
373
|
+
def fetch(token: :unset)
|
374
|
+
context.fetch(token: token, )
|
375
|
+
end
|
376
|
+
|
377
|
+
##
|
378
|
+
# Provide a user friendly representation
|
379
|
+
def to_s
|
380
|
+
values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
|
381
|
+
"<Twilio.FlexApi.V1.InsightsQuestionnairesInstance #{values}>"
|
382
|
+
end
|
383
|
+
|
384
|
+
##
|
385
|
+
# Provide a detailed, user friendly representation
|
386
|
+
def inspect
|
387
|
+
values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
|
388
|
+
"<Twilio.FlexApi.V1.InsightsQuestionnairesInstance #{values}>"
|
389
|
+
end
|
390
|
+
end
|
391
|
+
end
|
392
|
+
end
|
393
|
+
end
|
394
|
+
end
|