twilio-ruby 5.67.3 → 5.74.5
Sign up to get free protection for your applications and to get access to all the features.
- 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,709 @@
|
|
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 Messaging < Domain
|
12
|
+
class V1 < Version
|
13
|
+
##
|
14
|
+
# PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
|
15
|
+
class TollfreeVerificationList < ListResource
|
16
|
+
##
|
17
|
+
# Initialize the TollfreeVerificationList
|
18
|
+
# @param [Version] version Version that contains the resource
|
19
|
+
# @return [TollfreeVerificationList] TollfreeVerificationList
|
20
|
+
def initialize(version)
|
21
|
+
super(version)
|
22
|
+
|
23
|
+
# Path Solution
|
24
|
+
@solution = {}
|
25
|
+
@uri = "/Tollfree/Verifications"
|
26
|
+
end
|
27
|
+
|
28
|
+
##
|
29
|
+
# Lists TollfreeVerificationInstance records from the API as a list.
|
30
|
+
# Unlike stream(), this operation is eager and will load `limit` records into
|
31
|
+
# memory before returning.
|
32
|
+
# @param [String] tollfree_phone_number_sid The SID of the Phone Number associated
|
33
|
+
# with the Tollfree Verification.
|
34
|
+
# @param [tollfree_verification.Status] status The compliance status of the
|
35
|
+
# Tollfree Verification record.
|
36
|
+
# @param [Integer] limit Upper limit for the number of records to return. stream()
|
37
|
+
# guarantees to never return more than limit. Default is no limit
|
38
|
+
# @param [Integer] page_size Number of records to fetch per request, when
|
39
|
+
# not set will use the default value of 50 records. If no page_size is defined
|
40
|
+
# but a limit is defined, stream() will attempt to read the limit with the most
|
41
|
+
# efficient page size, i.e. min(limit, 1000)
|
42
|
+
# @return [Array] Array of up to limit results
|
43
|
+
def list(tollfree_phone_number_sid: :unset, status: :unset, limit: nil, page_size: nil)
|
44
|
+
self.stream(
|
45
|
+
tollfree_phone_number_sid: tollfree_phone_number_sid,
|
46
|
+
status: status,
|
47
|
+
limit: limit,
|
48
|
+
page_size: page_size
|
49
|
+
).entries
|
50
|
+
end
|
51
|
+
|
52
|
+
##
|
53
|
+
# Streams TollfreeVerificationInstance records from the API as an Enumerable.
|
54
|
+
# This operation lazily loads records as efficiently as possible until the limit
|
55
|
+
# is reached.
|
56
|
+
# @param [String] tollfree_phone_number_sid The SID of the Phone Number associated
|
57
|
+
# with the Tollfree Verification.
|
58
|
+
# @param [tollfree_verification.Status] status The compliance status of the
|
59
|
+
# Tollfree Verification record.
|
60
|
+
# @param [Integer] limit Upper limit for the number of records to return. stream()
|
61
|
+
# guarantees to never return more than limit. Default is no limit.
|
62
|
+
# @param [Integer] page_size Number of records to fetch per request, when
|
63
|
+
# not set will use the default value of 50 records. If no page_size is defined
|
64
|
+
# but a limit is defined, stream() will attempt to read the limit with the most
|
65
|
+
# efficient page size, i.e. min(limit, 1000)
|
66
|
+
# @return [Enumerable] Enumerable that will yield up to limit results
|
67
|
+
def stream(tollfree_phone_number_sid: :unset, status: :unset, limit: nil, page_size: nil)
|
68
|
+
limits = @version.read_limits(limit, page_size)
|
69
|
+
|
70
|
+
page = self.page(
|
71
|
+
tollfree_phone_number_sid: tollfree_phone_number_sid,
|
72
|
+
status: status,
|
73
|
+
page_size: limits[:page_size],
|
74
|
+
)
|
75
|
+
|
76
|
+
@version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
|
77
|
+
end
|
78
|
+
|
79
|
+
##
|
80
|
+
# When passed a block, yields TollfreeVerificationInstance records from the API.
|
81
|
+
# This operation lazily loads records as efficiently as possible until the limit
|
82
|
+
# is reached.
|
83
|
+
def each
|
84
|
+
limits = @version.read_limits
|
85
|
+
|
86
|
+
page = self.page(page_size: limits[:page_size], )
|
87
|
+
|
88
|
+
@version.stream(page,
|
89
|
+
limit: limits[:limit],
|
90
|
+
page_limit: limits[:page_limit]).each {|x| yield x}
|
91
|
+
end
|
92
|
+
|
93
|
+
##
|
94
|
+
# Retrieve a single page of TollfreeVerificationInstance records from the API.
|
95
|
+
# Request is executed immediately.
|
96
|
+
# @param [String] tollfree_phone_number_sid The SID of the Phone Number associated
|
97
|
+
# with the Tollfree Verification.
|
98
|
+
# @param [tollfree_verification.Status] status The compliance status of the
|
99
|
+
# Tollfree Verification record.
|
100
|
+
# @param [String] page_token PageToken provided by the API
|
101
|
+
# @param [Integer] page_number Page Number, this value is simply for client state
|
102
|
+
# @param [Integer] page_size Number of records to return, defaults to 50
|
103
|
+
# @return [Page] Page of TollfreeVerificationInstance
|
104
|
+
def page(tollfree_phone_number_sid: :unset, status: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
|
105
|
+
params = Twilio::Values.of({
|
106
|
+
'TollfreePhoneNumberSid' => tollfree_phone_number_sid,
|
107
|
+
'Status' => status,
|
108
|
+
'PageToken' => page_token,
|
109
|
+
'Page' => page_number,
|
110
|
+
'PageSize' => page_size,
|
111
|
+
})
|
112
|
+
|
113
|
+
response = @version.page('GET', @uri, params: params)
|
114
|
+
|
115
|
+
TollfreeVerificationPage.new(@version, response, @solution)
|
116
|
+
end
|
117
|
+
|
118
|
+
##
|
119
|
+
# Retrieve a single page of TollfreeVerificationInstance records from the API.
|
120
|
+
# Request is executed immediately.
|
121
|
+
# @param [String] target_url API-generated URL for the requested results page
|
122
|
+
# @return [Page] Page of TollfreeVerificationInstance
|
123
|
+
def get_page(target_url)
|
124
|
+
response = @version.domain.request(
|
125
|
+
'GET',
|
126
|
+
target_url
|
127
|
+
)
|
128
|
+
TollfreeVerificationPage.new(@version, response, @solution)
|
129
|
+
end
|
130
|
+
|
131
|
+
##
|
132
|
+
# Create the TollfreeVerificationInstance
|
133
|
+
# @param [String] business_name The name of the business or organization using the
|
134
|
+
# Tollfree number.
|
135
|
+
# @param [String] business_website The website of the business or organization
|
136
|
+
# using the Tollfree number.
|
137
|
+
# @param [String] notification_email The email address to receive the notification
|
138
|
+
# about the verification result. .
|
139
|
+
# @param [Array[String]] use_case_categories The category of the use case for the
|
140
|
+
# Tollfree Number. List as many are applicable..
|
141
|
+
# @param [String] use_case_summary Use this to further explain how messaging is
|
142
|
+
# used by the business or organization.
|
143
|
+
# @param [String] production_message_sample An example of message content, i.e. a
|
144
|
+
# sample message.
|
145
|
+
# @param [Array[String]] opt_in_image_urls Link to an image that shows the opt-in
|
146
|
+
# workflow. Multiple images allowed and must be a publicly hosted URL.
|
147
|
+
# @param [tollfree_verification.OptInType] opt_in_type Describe how a user opts-in
|
148
|
+
# to text messages.
|
149
|
+
# @param [String] message_volume Estimate monthly volume of messages from the
|
150
|
+
# Tollfree Number.
|
151
|
+
# @param [String] tollfree_phone_number_sid The SID of the Phone Number associated
|
152
|
+
# with the Tollfree Verification.
|
153
|
+
# @param [String] customer_profile_sid Customer's Profile Bundle BundleSid.
|
154
|
+
# @param [String] business_street_address The address of the business or
|
155
|
+
# organization using the Tollfree number.
|
156
|
+
# @param [String] business_street_address2 The address of the business or
|
157
|
+
# organization using the Tollfree number.
|
158
|
+
# @param [String] business_city The city of the business or organization using the
|
159
|
+
# Tollfree number.
|
160
|
+
# @param [String] business_state_province_region The state/province/region of the
|
161
|
+
# business or organization using the Tollfree number.
|
162
|
+
# @param [String] business_postal_code The postal code of the business or
|
163
|
+
# organization using the Tollfree number.
|
164
|
+
# @param [String] business_country The country of the business or organization
|
165
|
+
# using the Tollfree number.
|
166
|
+
# @param [String] additional_information Additional information to be provided for
|
167
|
+
# verification.
|
168
|
+
# @param [String] business_contact_first_name The first name of the contact for
|
169
|
+
# the business or organization using the Tollfree number.
|
170
|
+
# @param [String] business_contact_last_name The last name of the contact for the
|
171
|
+
# business or organization using the Tollfree number.
|
172
|
+
# @param [String] business_contact_email The email address of the contact for the
|
173
|
+
# business or organization using the Tollfree number.
|
174
|
+
# @param [String] business_contact_phone The phone number of the contact for the
|
175
|
+
# business or organization using the Tollfree number.
|
176
|
+
# @param [String] external_reference_id An optional external reference ID supplied
|
177
|
+
# by customer and echoed back on status retrieval.
|
178
|
+
# @return [TollfreeVerificationInstance] Created TollfreeVerificationInstance
|
179
|
+
def create(business_name: nil, business_website: nil, notification_email: nil, use_case_categories: nil, use_case_summary: nil, production_message_sample: nil, opt_in_image_urls: nil, opt_in_type: nil, message_volume: nil, tollfree_phone_number_sid: nil, customer_profile_sid: :unset, business_street_address: :unset, business_street_address2: :unset, business_city: :unset, business_state_province_region: :unset, business_postal_code: :unset, business_country: :unset, additional_information: :unset, business_contact_first_name: :unset, business_contact_last_name: :unset, business_contact_email: :unset, business_contact_phone: :unset, external_reference_id: :unset)
|
180
|
+
data = Twilio::Values.of({
|
181
|
+
'BusinessName' => business_name,
|
182
|
+
'BusinessWebsite' => business_website,
|
183
|
+
'NotificationEmail' => notification_email,
|
184
|
+
'UseCaseCategories' => Twilio.serialize_list(use_case_categories) { |e| e },
|
185
|
+
'UseCaseSummary' => use_case_summary,
|
186
|
+
'ProductionMessageSample' => production_message_sample,
|
187
|
+
'OptInImageUrls' => Twilio.serialize_list(opt_in_image_urls) { |e| e },
|
188
|
+
'OptInType' => opt_in_type,
|
189
|
+
'MessageVolume' => message_volume,
|
190
|
+
'TollfreePhoneNumberSid' => tollfree_phone_number_sid,
|
191
|
+
'CustomerProfileSid' => customer_profile_sid,
|
192
|
+
'BusinessStreetAddress' => business_street_address,
|
193
|
+
'BusinessStreetAddress2' => business_street_address2,
|
194
|
+
'BusinessCity' => business_city,
|
195
|
+
'BusinessStateProvinceRegion' => business_state_province_region,
|
196
|
+
'BusinessPostalCode' => business_postal_code,
|
197
|
+
'BusinessCountry' => business_country,
|
198
|
+
'AdditionalInformation' => additional_information,
|
199
|
+
'BusinessContactFirstName' => business_contact_first_name,
|
200
|
+
'BusinessContactLastName' => business_contact_last_name,
|
201
|
+
'BusinessContactEmail' => business_contact_email,
|
202
|
+
'BusinessContactPhone' => business_contact_phone,
|
203
|
+
'ExternalReferenceId' => external_reference_id,
|
204
|
+
})
|
205
|
+
|
206
|
+
payload = @version.create('POST', @uri, data: data)
|
207
|
+
|
208
|
+
TollfreeVerificationInstance.new(@version, payload, )
|
209
|
+
end
|
210
|
+
|
211
|
+
##
|
212
|
+
# Provide a user friendly representation
|
213
|
+
def to_s
|
214
|
+
'#<Twilio.Messaging.V1.TollfreeVerificationList>'
|
215
|
+
end
|
216
|
+
end
|
217
|
+
|
218
|
+
##
|
219
|
+
# PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
|
220
|
+
class TollfreeVerificationPage < Page
|
221
|
+
##
|
222
|
+
# Initialize the TollfreeVerificationPage
|
223
|
+
# @param [Version] version Version that contains the resource
|
224
|
+
# @param [Response] response Response from the API
|
225
|
+
# @param [Hash] solution Path solution for the resource
|
226
|
+
# @return [TollfreeVerificationPage] TollfreeVerificationPage
|
227
|
+
def initialize(version, response, solution)
|
228
|
+
super(version, response)
|
229
|
+
|
230
|
+
# Path Solution
|
231
|
+
@solution = solution
|
232
|
+
end
|
233
|
+
|
234
|
+
##
|
235
|
+
# Build an instance of TollfreeVerificationInstance
|
236
|
+
# @param [Hash] payload Payload response from the API
|
237
|
+
# @return [TollfreeVerificationInstance] TollfreeVerificationInstance
|
238
|
+
def get_instance(payload)
|
239
|
+
TollfreeVerificationInstance.new(@version, payload, )
|
240
|
+
end
|
241
|
+
|
242
|
+
##
|
243
|
+
# Provide a user friendly representation
|
244
|
+
def to_s
|
245
|
+
'<Twilio.Messaging.V1.TollfreeVerificationPage>'
|
246
|
+
end
|
247
|
+
end
|
248
|
+
|
249
|
+
##
|
250
|
+
# PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
|
251
|
+
class TollfreeVerificationContext < InstanceContext
|
252
|
+
##
|
253
|
+
# Initialize the TollfreeVerificationContext
|
254
|
+
# @param [Version] version Version that contains the resource
|
255
|
+
# @param [String] sid The unique string to identify Tollfree Verification.
|
256
|
+
# @return [TollfreeVerificationContext] TollfreeVerificationContext
|
257
|
+
def initialize(version, sid)
|
258
|
+
super(version)
|
259
|
+
|
260
|
+
# Path Solution
|
261
|
+
@solution = {sid: sid, }
|
262
|
+
@uri = "/Tollfree/Verifications/#{@solution[:sid]}"
|
263
|
+
end
|
264
|
+
|
265
|
+
##
|
266
|
+
# Fetch the TollfreeVerificationInstance
|
267
|
+
# @return [TollfreeVerificationInstance] Fetched TollfreeVerificationInstance
|
268
|
+
def fetch
|
269
|
+
payload = @version.fetch('GET', @uri)
|
270
|
+
|
271
|
+
TollfreeVerificationInstance.new(@version, payload, sid: @solution[:sid], )
|
272
|
+
end
|
273
|
+
|
274
|
+
##
|
275
|
+
# Update the TollfreeVerificationInstance
|
276
|
+
# @param [String] business_name The name of the business or organization using the
|
277
|
+
# Tollfree number.
|
278
|
+
# @param [String] business_website The website of the business or organization
|
279
|
+
# using the Tollfree number.
|
280
|
+
# @param [String] notification_email The email address to receive the notification
|
281
|
+
# about the verification result. .
|
282
|
+
# @param [Array[String]] use_case_categories The category of the use case for the
|
283
|
+
# Tollfree Number. List as many are applicable..
|
284
|
+
# @param [String] use_case_summary Use this to further explain how messaging is
|
285
|
+
# used by the business or organization.
|
286
|
+
# @param [String] production_message_sample An example of message content, i.e. a
|
287
|
+
# sample message.
|
288
|
+
# @param [Array[String]] opt_in_image_urls Link to an image that shows the opt-in
|
289
|
+
# workflow. Multiple images allowed and must be a publicly hosted URL.
|
290
|
+
# @param [tollfree_verification.OptInType] opt_in_type Describe how a user opts-in
|
291
|
+
# to text messages.
|
292
|
+
# @param [String] message_volume Estimate monthly volume of messages from the
|
293
|
+
# Tollfree Number.
|
294
|
+
# @param [String] business_street_address The address of the business or
|
295
|
+
# organization using the Tollfree number.
|
296
|
+
# @param [String] business_street_address2 The address of the business or
|
297
|
+
# organization using the Tollfree number.
|
298
|
+
# @param [String] business_city The city of the business or organization using the
|
299
|
+
# Tollfree number.
|
300
|
+
# @param [String] business_state_province_region The state/province/region of the
|
301
|
+
# business or organization using the Tollfree number.
|
302
|
+
# @param [String] business_postal_code The postal code of the business or
|
303
|
+
# organization using the Tollfree number.
|
304
|
+
# @param [String] business_country The country of the business or organization
|
305
|
+
# using the Tollfree number.
|
306
|
+
# @param [String] additional_information Additional information to be provided for
|
307
|
+
# verification.
|
308
|
+
# @param [String] business_contact_first_name The first name of the contact for
|
309
|
+
# the business or organization using the Tollfree number.
|
310
|
+
# @param [String] business_contact_last_name The last name of the contact for the
|
311
|
+
# business or organization using the Tollfree number.
|
312
|
+
# @param [String] business_contact_email The email address of the contact for the
|
313
|
+
# business or organization using the Tollfree number.
|
314
|
+
# @param [String] business_contact_phone The phone number of the contact for the
|
315
|
+
# business or organization using the Tollfree number.
|
316
|
+
# @return [TollfreeVerificationInstance] Updated TollfreeVerificationInstance
|
317
|
+
def update(business_name: :unset, business_website: :unset, notification_email: :unset, use_case_categories: :unset, use_case_summary: :unset, production_message_sample: :unset, opt_in_image_urls: :unset, opt_in_type: :unset, message_volume: :unset, business_street_address: :unset, business_street_address2: :unset, business_city: :unset, business_state_province_region: :unset, business_postal_code: :unset, business_country: :unset, additional_information: :unset, business_contact_first_name: :unset, business_contact_last_name: :unset, business_contact_email: :unset, business_contact_phone: :unset)
|
318
|
+
data = Twilio::Values.of({
|
319
|
+
'BusinessName' => business_name,
|
320
|
+
'BusinessWebsite' => business_website,
|
321
|
+
'NotificationEmail' => notification_email,
|
322
|
+
'UseCaseCategories' => Twilio.serialize_list(use_case_categories) { |e| e },
|
323
|
+
'UseCaseSummary' => use_case_summary,
|
324
|
+
'ProductionMessageSample' => production_message_sample,
|
325
|
+
'OptInImageUrls' => Twilio.serialize_list(opt_in_image_urls) { |e| e },
|
326
|
+
'OptInType' => opt_in_type,
|
327
|
+
'MessageVolume' => message_volume,
|
328
|
+
'BusinessStreetAddress' => business_street_address,
|
329
|
+
'BusinessStreetAddress2' => business_street_address2,
|
330
|
+
'BusinessCity' => business_city,
|
331
|
+
'BusinessStateProvinceRegion' => business_state_province_region,
|
332
|
+
'BusinessPostalCode' => business_postal_code,
|
333
|
+
'BusinessCountry' => business_country,
|
334
|
+
'AdditionalInformation' => additional_information,
|
335
|
+
'BusinessContactFirstName' => business_contact_first_name,
|
336
|
+
'BusinessContactLastName' => business_contact_last_name,
|
337
|
+
'BusinessContactEmail' => business_contact_email,
|
338
|
+
'BusinessContactPhone' => business_contact_phone,
|
339
|
+
})
|
340
|
+
|
341
|
+
payload = @version.update('POST', @uri, data: data)
|
342
|
+
|
343
|
+
TollfreeVerificationInstance.new(@version, payload, sid: @solution[:sid], )
|
344
|
+
end
|
345
|
+
|
346
|
+
##
|
347
|
+
# Provide a user friendly representation
|
348
|
+
def to_s
|
349
|
+
context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
|
350
|
+
"#<Twilio.Messaging.V1.TollfreeVerificationContext #{context}>"
|
351
|
+
end
|
352
|
+
|
353
|
+
##
|
354
|
+
# Provide a detailed, user friendly representation
|
355
|
+
def inspect
|
356
|
+
context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
|
357
|
+
"#<Twilio.Messaging.V1.TollfreeVerificationContext #{context}>"
|
358
|
+
end
|
359
|
+
end
|
360
|
+
|
361
|
+
##
|
362
|
+
# PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
|
363
|
+
class TollfreeVerificationInstance < InstanceResource
|
364
|
+
##
|
365
|
+
# Initialize the TollfreeVerificationInstance
|
366
|
+
# @param [Version] version Version that contains the resource
|
367
|
+
# @param [Hash] payload payload that contains response from Twilio
|
368
|
+
# @param [String] sid The unique string to identify Tollfree Verification.
|
369
|
+
# @return [TollfreeVerificationInstance] TollfreeVerificationInstance
|
370
|
+
def initialize(version, payload, sid: nil)
|
371
|
+
super(version)
|
372
|
+
|
373
|
+
# Marshaled Properties
|
374
|
+
@properties = {
|
375
|
+
'sid' => payload['sid'],
|
376
|
+
'account_sid' => payload['account_sid'],
|
377
|
+
'customer_profile_sid' => payload['customer_profile_sid'],
|
378
|
+
'trust_product_sid' => payload['trust_product_sid'],
|
379
|
+
'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
|
380
|
+
'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
|
381
|
+
'regulated_item_sid' => payload['regulated_item_sid'],
|
382
|
+
'business_name' => payload['business_name'],
|
383
|
+
'business_street_address' => payload['business_street_address'],
|
384
|
+
'business_street_address2' => payload['business_street_address2'],
|
385
|
+
'business_city' => payload['business_city'],
|
386
|
+
'business_state_province_region' => payload['business_state_province_region'],
|
387
|
+
'business_postal_code' => payload['business_postal_code'],
|
388
|
+
'business_country' => payload['business_country'],
|
389
|
+
'business_website' => payload['business_website'],
|
390
|
+
'business_contact_first_name' => payload['business_contact_first_name'],
|
391
|
+
'business_contact_last_name' => payload['business_contact_last_name'],
|
392
|
+
'business_contact_email' => payload['business_contact_email'],
|
393
|
+
'business_contact_phone' => payload['business_contact_phone'],
|
394
|
+
'notification_email' => payload['notification_email'],
|
395
|
+
'use_case_categories' => payload['use_case_categories'],
|
396
|
+
'use_case_summary' => payload['use_case_summary'],
|
397
|
+
'production_message_sample' => payload['production_message_sample'],
|
398
|
+
'opt_in_image_urls' => payload['opt_in_image_urls'],
|
399
|
+
'opt_in_type' => payload['opt_in_type'],
|
400
|
+
'message_volume' => payload['message_volume'],
|
401
|
+
'additional_information' => payload['additional_information'],
|
402
|
+
'tollfree_phone_number_sid' => payload['tollfree_phone_number_sid'],
|
403
|
+
'status' => payload['status'],
|
404
|
+
'url' => payload['url'],
|
405
|
+
'resource_links' => payload['resource_links'],
|
406
|
+
'external_reference_id' => payload['external_reference_id'],
|
407
|
+
}
|
408
|
+
|
409
|
+
# Context
|
410
|
+
@instance_context = nil
|
411
|
+
@params = {'sid' => sid || @properties['sid'], }
|
412
|
+
end
|
413
|
+
|
414
|
+
##
|
415
|
+
# Generate an instance context for the instance, the context is capable of
|
416
|
+
# performing various actions. All instance actions are proxied to the context
|
417
|
+
# @return [TollfreeVerificationContext] TollfreeVerificationContext for this TollfreeVerificationInstance
|
418
|
+
def context
|
419
|
+
unless @instance_context
|
420
|
+
@instance_context = TollfreeVerificationContext.new(@version, @params['sid'], )
|
421
|
+
end
|
422
|
+
@instance_context
|
423
|
+
end
|
424
|
+
|
425
|
+
##
|
426
|
+
# @return [String] Tollfree Verification Sid
|
427
|
+
def sid
|
428
|
+
@properties['sid']
|
429
|
+
end
|
430
|
+
|
431
|
+
##
|
432
|
+
# @return [String] The SID of the Account that created the resource
|
433
|
+
def account_sid
|
434
|
+
@properties['account_sid']
|
435
|
+
end
|
436
|
+
|
437
|
+
##
|
438
|
+
# @return [String] Customer's Profile Bundle BundleSid
|
439
|
+
def customer_profile_sid
|
440
|
+
@properties['customer_profile_sid']
|
441
|
+
end
|
442
|
+
|
443
|
+
##
|
444
|
+
# @return [String] Tollfree TrustProduct Bundle BundleSid
|
445
|
+
def trust_product_sid
|
446
|
+
@properties['trust_product_sid']
|
447
|
+
end
|
448
|
+
|
449
|
+
##
|
450
|
+
# @return [Time] The ISO 8601 date and time in GMT when the resource was created
|
451
|
+
def date_created
|
452
|
+
@properties['date_created']
|
453
|
+
end
|
454
|
+
|
455
|
+
##
|
456
|
+
# @return [Time] The ISO 8601 date and time in GMT when the resource was last updated
|
457
|
+
def date_updated
|
458
|
+
@properties['date_updated']
|
459
|
+
end
|
460
|
+
|
461
|
+
##
|
462
|
+
# @return [String] The SID of the Regulated Item
|
463
|
+
def regulated_item_sid
|
464
|
+
@properties['regulated_item_sid']
|
465
|
+
end
|
466
|
+
|
467
|
+
##
|
468
|
+
# @return [String] The name of the business or organization using the Tollfree number
|
469
|
+
def business_name
|
470
|
+
@properties['business_name']
|
471
|
+
end
|
472
|
+
|
473
|
+
##
|
474
|
+
# @return [String] The address of the business or organization using the Tollfree number
|
475
|
+
def business_street_address
|
476
|
+
@properties['business_street_address']
|
477
|
+
end
|
478
|
+
|
479
|
+
##
|
480
|
+
# @return [String] The address of the business or organization using the Tollfree number
|
481
|
+
def business_street_address2
|
482
|
+
@properties['business_street_address2']
|
483
|
+
end
|
484
|
+
|
485
|
+
##
|
486
|
+
# @return [String] The city of the business or organization using the Tollfree number
|
487
|
+
def business_city
|
488
|
+
@properties['business_city']
|
489
|
+
end
|
490
|
+
|
491
|
+
##
|
492
|
+
# @return [String] The state/province/region of the business or organization using the Tollfree number
|
493
|
+
def business_state_province_region
|
494
|
+
@properties['business_state_province_region']
|
495
|
+
end
|
496
|
+
|
497
|
+
##
|
498
|
+
# @return [String] The postal code of the business or organization using the Tollfree number
|
499
|
+
def business_postal_code
|
500
|
+
@properties['business_postal_code']
|
501
|
+
end
|
502
|
+
|
503
|
+
##
|
504
|
+
# @return [String] The country of the business or organization using the Tollfree number
|
505
|
+
def business_country
|
506
|
+
@properties['business_country']
|
507
|
+
end
|
508
|
+
|
509
|
+
##
|
510
|
+
# @return [String] The website of the business or organization using the Tollfree number
|
511
|
+
def business_website
|
512
|
+
@properties['business_website']
|
513
|
+
end
|
514
|
+
|
515
|
+
##
|
516
|
+
# @return [String] The first name of the contact for the business or organization using the Tollfree number
|
517
|
+
def business_contact_first_name
|
518
|
+
@properties['business_contact_first_name']
|
519
|
+
end
|
520
|
+
|
521
|
+
##
|
522
|
+
# @return [String] The last name of the contact for the business or organization using the Tollfree number
|
523
|
+
def business_contact_last_name
|
524
|
+
@properties['business_contact_last_name']
|
525
|
+
end
|
526
|
+
|
527
|
+
##
|
528
|
+
# @return [String] The email address of the contact for the business or organization using the Tollfree number
|
529
|
+
def business_contact_email
|
530
|
+
@properties['business_contact_email']
|
531
|
+
end
|
532
|
+
|
533
|
+
##
|
534
|
+
# @return [String] The phone number of the contact for the business or organization using the Tollfree number
|
535
|
+
def business_contact_phone
|
536
|
+
@properties['business_contact_phone']
|
537
|
+
end
|
538
|
+
|
539
|
+
##
|
540
|
+
# @return [String] The email address to receive the notification about the verification result.
|
541
|
+
def notification_email
|
542
|
+
@properties['notification_email']
|
543
|
+
end
|
544
|
+
|
545
|
+
##
|
546
|
+
# @return [Array[String]] The category of the use case for the Tollfree Number. List as many are applicable.
|
547
|
+
def use_case_categories
|
548
|
+
@properties['use_case_categories']
|
549
|
+
end
|
550
|
+
|
551
|
+
##
|
552
|
+
# @return [String] Further explaination on how messaging is used by the business or organization
|
553
|
+
def use_case_summary
|
554
|
+
@properties['use_case_summary']
|
555
|
+
end
|
556
|
+
|
557
|
+
##
|
558
|
+
# @return [String] An example of message content, i.e. a sample message
|
559
|
+
def production_message_sample
|
560
|
+
@properties['production_message_sample']
|
561
|
+
end
|
562
|
+
|
563
|
+
##
|
564
|
+
# @return [Array[String]] Link to an image that shows the opt-in workflow. Multiple images allowed and must be a publicly hosted URL
|
565
|
+
def opt_in_image_urls
|
566
|
+
@properties['opt_in_image_urls']
|
567
|
+
end
|
568
|
+
|
569
|
+
##
|
570
|
+
# @return [tollfree_verification.OptInType] Describe how a user opts-in to text messages
|
571
|
+
def opt_in_type
|
572
|
+
@properties['opt_in_type']
|
573
|
+
end
|
574
|
+
|
575
|
+
##
|
576
|
+
# @return [String] Estimate monthly volume of messages from the Tollfree Number
|
577
|
+
def message_volume
|
578
|
+
@properties['message_volume']
|
579
|
+
end
|
580
|
+
|
581
|
+
##
|
582
|
+
# @return [String] Additional information to be provided for verification
|
583
|
+
def additional_information
|
584
|
+
@properties['additional_information']
|
585
|
+
end
|
586
|
+
|
587
|
+
##
|
588
|
+
# @return [String] The SID of the Phone Number associated with the Tollfree Verification
|
589
|
+
def tollfree_phone_number_sid
|
590
|
+
@properties['tollfree_phone_number_sid']
|
591
|
+
end
|
592
|
+
|
593
|
+
##
|
594
|
+
# @return [tollfree_verification.Status] The compliance status of the Tollfree Verification record.
|
595
|
+
def status
|
596
|
+
@properties['status']
|
597
|
+
end
|
598
|
+
|
599
|
+
##
|
600
|
+
# @return [String] The absolute URL of the Tollfree Verification
|
601
|
+
def url
|
602
|
+
@properties['url']
|
603
|
+
end
|
604
|
+
|
605
|
+
##
|
606
|
+
# @return [Hash] The URLs of the documents associated with the Tollfree Verification resource
|
607
|
+
def resource_links
|
608
|
+
@properties['resource_links']
|
609
|
+
end
|
610
|
+
|
611
|
+
##
|
612
|
+
# @return [String] An optional external reference ID supplied by customer and echoed back on status retrieval
|
613
|
+
def external_reference_id
|
614
|
+
@properties['external_reference_id']
|
615
|
+
end
|
616
|
+
|
617
|
+
##
|
618
|
+
# Fetch the TollfreeVerificationInstance
|
619
|
+
# @return [TollfreeVerificationInstance] Fetched TollfreeVerificationInstance
|
620
|
+
def fetch
|
621
|
+
context.fetch
|
622
|
+
end
|
623
|
+
|
624
|
+
##
|
625
|
+
# Update the TollfreeVerificationInstance
|
626
|
+
# @param [String] business_name The name of the business or organization using the
|
627
|
+
# Tollfree number.
|
628
|
+
# @param [String] business_website The website of the business or organization
|
629
|
+
# using the Tollfree number.
|
630
|
+
# @param [String] notification_email The email address to receive the notification
|
631
|
+
# about the verification result. .
|
632
|
+
# @param [Array[String]] use_case_categories The category of the use case for the
|
633
|
+
# Tollfree Number. List as many are applicable..
|
634
|
+
# @param [String] use_case_summary Use this to further explain how messaging is
|
635
|
+
# used by the business or organization.
|
636
|
+
# @param [String] production_message_sample An example of message content, i.e. a
|
637
|
+
# sample message.
|
638
|
+
# @param [Array[String]] opt_in_image_urls Link to an image that shows the opt-in
|
639
|
+
# workflow. Multiple images allowed and must be a publicly hosted URL.
|
640
|
+
# @param [tollfree_verification.OptInType] opt_in_type Describe how a user opts-in
|
641
|
+
# to text messages.
|
642
|
+
# @param [String] message_volume Estimate monthly volume of messages from the
|
643
|
+
# Tollfree Number.
|
644
|
+
# @param [String] business_street_address The address of the business or
|
645
|
+
# organization using the Tollfree number.
|
646
|
+
# @param [String] business_street_address2 The address of the business or
|
647
|
+
# organization using the Tollfree number.
|
648
|
+
# @param [String] business_city The city of the business or organization using the
|
649
|
+
# Tollfree number.
|
650
|
+
# @param [String] business_state_province_region The state/province/region of the
|
651
|
+
# business or organization using the Tollfree number.
|
652
|
+
# @param [String] business_postal_code The postal code of the business or
|
653
|
+
# organization using the Tollfree number.
|
654
|
+
# @param [String] business_country The country of the business or organization
|
655
|
+
# using the Tollfree number.
|
656
|
+
# @param [String] additional_information Additional information to be provided for
|
657
|
+
# verification.
|
658
|
+
# @param [String] business_contact_first_name The first name of the contact for
|
659
|
+
# the business or organization using the Tollfree number.
|
660
|
+
# @param [String] business_contact_last_name The last name of the contact for the
|
661
|
+
# business or organization using the Tollfree number.
|
662
|
+
# @param [String] business_contact_email The email address of the contact for the
|
663
|
+
# business or organization using the Tollfree number.
|
664
|
+
# @param [String] business_contact_phone The phone number of the contact for the
|
665
|
+
# business or organization using the Tollfree number.
|
666
|
+
# @return [TollfreeVerificationInstance] Updated TollfreeVerificationInstance
|
667
|
+
def update(business_name: :unset, business_website: :unset, notification_email: :unset, use_case_categories: :unset, use_case_summary: :unset, production_message_sample: :unset, opt_in_image_urls: :unset, opt_in_type: :unset, message_volume: :unset, business_street_address: :unset, business_street_address2: :unset, business_city: :unset, business_state_province_region: :unset, business_postal_code: :unset, business_country: :unset, additional_information: :unset, business_contact_first_name: :unset, business_contact_last_name: :unset, business_contact_email: :unset, business_contact_phone: :unset)
|
668
|
+
context.update(
|
669
|
+
business_name: business_name,
|
670
|
+
business_website: business_website,
|
671
|
+
notification_email: notification_email,
|
672
|
+
use_case_categories: use_case_categories,
|
673
|
+
use_case_summary: use_case_summary,
|
674
|
+
production_message_sample: production_message_sample,
|
675
|
+
opt_in_image_urls: opt_in_image_urls,
|
676
|
+
opt_in_type: opt_in_type,
|
677
|
+
message_volume: message_volume,
|
678
|
+
business_street_address: business_street_address,
|
679
|
+
business_street_address2: business_street_address2,
|
680
|
+
business_city: business_city,
|
681
|
+
business_state_province_region: business_state_province_region,
|
682
|
+
business_postal_code: business_postal_code,
|
683
|
+
business_country: business_country,
|
684
|
+
additional_information: additional_information,
|
685
|
+
business_contact_first_name: business_contact_first_name,
|
686
|
+
business_contact_last_name: business_contact_last_name,
|
687
|
+
business_contact_email: business_contact_email,
|
688
|
+
business_contact_phone: business_contact_phone,
|
689
|
+
)
|
690
|
+
end
|
691
|
+
|
692
|
+
##
|
693
|
+
# Provide a user friendly representation
|
694
|
+
def to_s
|
695
|
+
values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
|
696
|
+
"<Twilio.Messaging.V1.TollfreeVerificationInstance #{values}>"
|
697
|
+
end
|
698
|
+
|
699
|
+
##
|
700
|
+
# Provide a detailed, user friendly representation
|
701
|
+
def inspect
|
702
|
+
values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
|
703
|
+
"<Twilio.Messaging.V1.TollfreeVerificationInstance #{values}>"
|
704
|
+
end
|
705
|
+
end
|
706
|
+
end
|
707
|
+
end
|
708
|
+
end
|
709
|
+
end
|