twilio-ruby 5.61.2 → 6.9.1
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 +21 -0
- data/.github/workflows/test-and-deploy.yml +139 -0
- data/.gitignore +3 -0
- data/.rubocop.yml +1 -1
- data/.rubocop_todo.yml +84 -21
- data/CHANGES.md +893 -1
- data/CONTRIBUTING.md +11 -9
- data/LICENSE +1 -1
- data/Makefile +13 -8
- data/PULL_REQUEST_TEMPLATE.md +1 -1
- data/README.md +136 -44
- data/UPGRADE.md +10 -0
- data/advanced-examples/custom-http-client.md +170 -0
- data/cluster_spec.rb +77 -0
- data/lib/rack/twilio_webhook_authentication.rb +25 -1
- data/lib/twilio-ruby/base/client_base.rb +121 -0
- data/lib/twilio-ruby/framework/rest/error.rb +0 -12
- data/lib/twilio-ruby/http/http_client.rb +11 -6
- data/lib/twilio-ruby/jwt/access_token.rb +0 -59
- data/lib/twilio-ruby/rest/accounts/v1/auth_token_promotion.rb +198 -178
- data/lib/twilio-ruby/rest/accounts/v1/credential/aws.rb +371 -332
- data/lib/twilio-ruby/rest/accounts/v1/credential/public_key.rb +371 -332
- data/lib/twilio-ruby/rest/accounts/v1/credential.rb +121 -114
- data/lib/twilio-ruby/rest/accounts/v1/safelist.rb +169 -0
- data/lib/twilio-ruby/rest/accounts/v1/secondary_auth_token.rb +214 -192
- data/lib/twilio-ruby/rest/accounts/v1.rb +51 -42
- data/lib/twilio-ruby/rest/accounts.rb +4 -34
- data/lib/twilio-ruby/rest/accounts_base.rb +38 -0
- data/lib/twilio-ruby/rest/api/v2010/account/address/dependent_phone_number.rb +370 -365
- data/lib/twilio-ruby/rest/api/v2010/account/address.rb +551 -514
- data/lib/twilio-ruby/rest/api/v2010/account/application.rb +615 -586
- data/lib/twilio-ruby/rest/api/v2010/account/authorized_connect_app.rb +313 -320
- data/lib/twilio-ruby/rest/api/v2010/account/available_phone_number_country/local.rb +394 -0
- data/lib/twilio-ruby/rest/api/v2010/account/available_phone_number_country/machine_to_machine.rb +394 -0
- data/lib/twilio-ruby/rest/api/v2010/account/available_phone_number_country/mobile.rb +394 -0
- data/lib/twilio-ruby/rest/api/v2010/account/available_phone_number_country/national.rb +394 -0
- data/lib/twilio-ruby/rest/api/v2010/account/available_phone_number_country/shared_cost.rb +394 -0
- data/lib/twilio-ruby/rest/api/v2010/account/available_phone_number_country/toll_free.rb +394 -0
- data/lib/twilio-ruby/rest/api/v2010/account/available_phone_number_country/voip.rb +394 -0
- data/lib/twilio-ruby/rest/api/v2010/account/available_phone_number_country.rb +432 -0
- data/lib/twilio-ruby/rest/api/v2010/account/balance.rb +136 -118
- data/lib/twilio-ruby/rest/api/v2010/account/call/event.rb +202 -194
- data/lib/twilio-ruby/rest/api/v2010/account/call/feedback.rb +252 -289
- data/lib/twilio-ruby/rest/api/v2010/account/call/feedback_summary.rb +317 -303
- data/lib/twilio-ruby/rest/api/v2010/account/call/notification.rb +400 -417
- data/lib/twilio-ruby/rest/api/v2010/account/call/payment.rb +291 -342
- data/lib/twilio-ruby/rest/api/v2010/account/call/recording.rb +494 -511
- data/lib/twilio-ruby/rest/api/v2010/account/call/siprec.rb +839 -634
- data/lib/twilio-ruby/rest/api/v2010/account/call/stream.rb +872 -0
- data/lib/twilio-ruby/rest/api/v2010/account/call/user_defined_message.rb +163 -0
- data/lib/twilio-ruby/rest/api/v2010/account/call/user_defined_message_subscription.rb +239 -0
- data/lib/twilio-ruby/rest/api/v2010/account/call.rb +952 -972
- data/lib/twilio-ruby/rest/api/v2010/account/conference/participant.rb +652 -717
- data/lib/twilio-ruby/rest/api/v2010/account/conference/recording.rb +451 -458
- data/lib/twilio-ruby/rest/api/v2010/account/conference.rb +489 -493
- data/lib/twilio-ruby/rest/api/v2010/account/connect_app.rb +426 -407
- data/lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/assigned_add_on/assigned_add_on_extension.rb +321 -351
- data/lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/assigned_add_on.rb +398 -418
- data/lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/local.rb +536 -554
- data/lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/mobile.rb +536 -553
- data/lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/toll_free.rb +536 -553
- data/lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb +841 -903
- data/lib/twilio-ruby/rest/api/v2010/account/key.rb +335 -302
- data/lib/twilio-ruby/rest/api/v2010/account/message/feedback.rb +167 -166
- data/lib/twilio-ruby/rest/api/v2010/account/message/media.rb +340 -350
- data/lib/twilio-ruby/rest/api/v2010/account/message.rb +615 -612
- data/lib/twilio-ruby/rest/api/v2010/account/new_key.rb +157 -138
- data/lib/twilio-ruby/rest/api/v2010/account/new_signing_key.rb +157 -138
- data/lib/twilio-ruby/rest/api/v2010/account/notification.rb +400 -399
- data/lib/twilio-ruby/rest/api/v2010/account/outgoing_caller_id.rb +368 -358
- data/lib/twilio-ruby/rest/api/v2010/account/queue/member.rb +340 -338
- data/lib/twilio-ruby/rest/api/v2010/account/queue.rb +426 -390
- data/lib/twilio-ruby/rest/api/v2010/account/recording/add_on_result/payload.rb +358 -380
- data/lib/twilio-ruby/rest/api/v2010/account/recording/add_on_result.rb +368 -385
- data/lib/twilio-ruby/rest/api/v2010/account/recording/transcription.rb +364 -372
- data/lib/twilio-ruby/rest/api/v2010/account/recording.rb +507 -486
- data/lib/twilio-ruby/rest/api/v2010/account/short_code.rb +417 -408
- data/lib/twilio-ruby/rest/api/v2010/account/signing_key.rb +335 -306
- data/lib/twilio-ruby/rest/api/v2010/account/sip/credential_list/credential.rb +375 -368
- data/lib/twilio-ruby/rest/api/v2010/account/sip/credential_list.rb +399 -373
- data/lib/twilio-ruby/rest/api/v2010/account/sip/domain/auth_types/auth_type_calls/auth_calls_credential_list_mapping.rb +346 -0
- data/lib/twilio-ruby/rest/api/v2010/account/sip/domain/auth_types/{auth_calls_mapping → auth_type_calls}/auth_calls_ip_access_control_list_mapping.rb +193 -195
- data/lib/twilio-ruby/rest/api/v2010/account/sip/domain/auth_types/auth_type_calls.rb +140 -0
- data/lib/twilio-ruby/rest/api/v2010/account/sip/domain/auth_types/{auth_registrations_mapping → auth_type_registrations}/auth_registrations_credential_list_mapping.rb +193 -195
- data/lib/twilio-ruby/rest/api/v2010/account/sip/domain/auth_types/auth_type_registrations.rb +126 -0
- data/lib/twilio-ruby/rest/api/v2010/account/sip/domain/auth_types.rb +94 -103
- data/lib/twilio-ruby/rest/api/v2010/account/sip/domain/credential_list_mapping.rb +339 -339
- data/lib/twilio-ruby/rest/api/v2010/account/sip/domain/ip_access_control_list_mapping.rb +339 -338
- data/lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb +649 -645
- data/lib/twilio-ruby/rest/api/v2010/account/sip/ip_access_control_list/ip_address.rb +412 -421
- data/lib/twilio-ruby/rest/api/v2010/account/sip/ip_access_control_list.rb +399 -374
- data/lib/twilio-ruby/rest/api/v2010/account/sip.rb +141 -150
- data/lib/twilio-ruby/rest/api/v2010/account/token.rb +171 -154
- data/lib/twilio-ruby/rest/api/v2010/account/transcription.rb +364 -350
- data/lib/twilio-ruby/rest/api/v2010/account/usage/record/all_time.rb +314 -339
- data/lib/twilio-ruby/rest/api/v2010/account/usage/record/daily.rb +314 -339
- data/lib/twilio-ruby/rest/api/v2010/account/usage/record/last_month.rb +314 -339
- data/lib/twilio-ruby/rest/api/v2010/account/usage/record/monthly.rb +314 -339
- data/lib/twilio-ruby/rest/api/v2010/account/usage/record/this_month.rb +314 -339
- data/lib/twilio-ruby/rest/api/v2010/account/usage/record/today.rb +314 -339
- data/lib/twilio-ruby/rest/api/v2010/account/usage/record/yearly.rb +314 -339
- data/lib/twilio-ruby/rest/api/v2010/account/usage/record/yesterday.rb +314 -339
- data/lib/twilio-ruby/rest/api/v2010/account/usage/record.rb +381 -416
- data/lib/twilio-ruby/rest/api/v2010/account/usage/trigger.rb +485 -484
- data/lib/twilio-ruby/rest/api/v2010/account/usage.rb +112 -104
- data/lib/twilio-ruby/rest/api/v2010/account/validation_request.rb +172 -161
- data/lib/twilio-ruby/rest/api/v2010/account.rb +979 -943
- data/lib/twilio-ruby/rest/api/v2010.rb +126 -148
- data/lib/twilio-ruby/rest/api.rb +25 -34
- data/lib/twilio-ruby/rest/api_base.rb +38 -0
- data/lib/twilio-ruby/rest/bulkexports/v1/export/day.rb +299 -279
- data/lib/twilio-ruby/rest/bulkexports/v1/export/export_custom_job.rb +298 -279
- data/lib/twilio-ruby/rest/bulkexports/v1/export/job.rb +271 -248
- data/lib/twilio-ruby/rest/bulkexports/v1/export.rb +246 -235
- data/lib/twilio-ruby/rest/bulkexports/v1/export_configuration.rb +245 -218
- data/lib/twilio-ruby/rest/bulkexports/v1.rb +57 -55
- data/lib/twilio-ruby/rest/bulkexports.rb +3 -34
- data/lib/twilio-ruby/rest/bulkexports_base.rb +38 -0
- data/lib/twilio-ruby/rest/chat/v1/credential.rb +419 -403
- data/lib/twilio-ruby/rest/chat/v1/service/channel/invite.rb +374 -391
- data/lib/twilio-ruby/rest/chat/v1/service/channel/member.rb +422 -440
- data/lib/twilio-ruby/rest/chat/v1/service/channel/message.rb +438 -437
- data/lib/twilio-ruby/rest/chat/v1/service/channel.rb +534 -515
- data/lib/twilio-ruby/rest/chat/v1/service/role.rb +396 -367
- data/lib/twilio-ruby/rest/chat/v1/service/user/user_channel.rb +244 -239
- data/lib/twilio-ruby/rest/chat/v1/service/user.rb +465 -440
- data/lib/twilio-ruby/rest/chat/v1/service.rb +861 -894
- data/lib/twilio-ruby/rest/chat/v1.rb +57 -55
- data/lib/twilio-ruby/rest/chat/v2/credential.rb +419 -401
- data/lib/twilio-ruby/rest/chat/v2/service/binding.rb +371 -370
- data/lib/twilio-ruby/rest/chat/v2/service/channel/invite.rb +374 -386
- data/lib/twilio-ruby/rest/chat/v2/service/channel/member.rb +486 -527
- data/lib/twilio-ruby/rest/chat/v2/service/channel/message.rb +513 -533
- data/lib/twilio-ruby/rest/chat/v2/service/channel/webhook.rb +440 -467
- data/lib/twilio-ruby/rest/chat/v2/service/channel.rb +606 -605
- data/lib/twilio-ruby/rest/chat/v2/service/role.rb +396 -369
- data/lib/twilio-ruby/rest/chat/v2/service/user/user_binding.rb +364 -381
- data/lib/twilio-ruby/rest/chat/v2/service/user/user_channel.rb +406 -413
- data/lib/twilio-ruby/rest/chat/v2/service/user.rb +509 -491
- data/lib/twilio-ruby/rest/chat/v2/service.rb +764 -778
- data/lib/twilio-ruby/rest/chat/v2.rb +57 -53
- data/lib/twilio-ruby/rest/chat/v3/channel.rb +297 -0
- data/lib/twilio-ruby/rest/chat/v3.rb +71 -0
- data/lib/twilio-ruby/rest/chat.rb +10 -38
- data/lib/twilio-ruby/rest/chat_base.rb +48 -0
- data/lib/twilio-ruby/rest/client.rb +318 -561
- data/lib/twilio-ruby/rest/content/v1/content/approval_fetch.rb +208 -0
- data/lib/twilio-ruby/rest/content/v1/content.rb +363 -0
- data/lib/twilio-ruby/rest/content/v1/content_and_approvals.rb +251 -0
- data/lib/twilio-ruby/rest/content/v1/legacy_content.rb +265 -0
- data/lib/twilio-ruby/rest/content/v1.rb +61 -0
- data/lib/twilio-ruby/rest/content.rb +15 -0
- data/lib/twilio-ruby/rest/content_base.rb +38 -0
- data/lib/twilio-ruby/rest/conversations/v1/address_configuration.rb +482 -0
- data/lib/twilio-ruby/rest/conversations/v1/configuration/webhook.rb +254 -227
- data/lib/twilio-ruby/rest/conversations/v1/configuration.rb +279 -252
- data/lib/twilio-ruby/rest/conversations/v1/conversation/message/delivery_receipt.rb +334 -344
- data/lib/twilio-ruby/rest/conversations/v1/conversation/message.rb +537 -495
- data/lib/twilio-ruby/rest/conversations/v1/conversation/participant.rb +498 -495
- data/lib/twilio-ruby/rest/conversations/v1/conversation/webhook.rb +425 -403
- data/lib/twilio-ruby/rest/conversations/v1/conversation.rb +620 -552
- data/lib/twilio-ruby/rest/conversations/v1/credential.rb +425 -409
- data/lib/twilio-ruby/rest/conversations/v1/participant_conversation.rb +304 -304
- data/lib/twilio-ruby/rest/conversations/v1/role.rb +384 -356
- data/lib/twilio-ruby/rest/conversations/v1/service/binding.rb +364 -373
- data/lib/twilio-ruby/rest/conversations/v1/service/configuration/notification.rb +300 -289
- data/lib/twilio-ruby/rest/conversations/v1/service/configuration/webhook.rb +246 -235
- data/lib/twilio-ruby/rest/conversations/v1/service/configuration.rb +307 -279
- data/lib/twilio-ruby/rest/conversations/v1/service/conversation/message/delivery_receipt.rb +341 -371
- data/lib/twilio-ruby/rest/conversations/v1/service/conversation/message.rb +544 -535
- data/lib/twilio-ruby/rest/conversations/v1/service/conversation/participant.rb +507 -530
- data/lib/twilio-ruby/rest/conversations/v1/service/conversation/webhook.rb +434 -438
- data/lib/twilio-ruby/rest/conversations/v1/service/conversation.rb +632 -588
- data/lib/twilio-ruby/rest/conversations/v1/service/participant_conversation.rb +310 -317
- data/lib/twilio-ruby/rest/conversations/v1/service/role.rb +396 -380
- data/lib/twilio-ruby/rest/conversations/v1/service/user/user_conversation.rb +446 -455
- data/lib/twilio-ruby/rest/conversations/v1/service/user.rb +484 -474
- data/lib/twilio-ruby/rest/conversations/v1/service.rb +476 -447
- data/lib/twilio-ruby/rest/conversations/v1/user/user_conversation.rb +445 -435
- data/lib/twilio-ruby/rest/conversations/v1/user.rb +472 -441
- data/lib/twilio-ruby/rest/conversations/v1.rb +129 -119
- data/lib/twilio-ruby/rest/conversations.rb +18 -34
- data/lib/twilio-ruby/rest/conversations_base.rb +38 -0
- data/lib/twilio-ruby/rest/events/v1/event_type.rb +302 -288
- data/lib/twilio-ruby/rest/events/v1/schema/schema_version.rb +299 -0
- data/lib/twilio-ruby/rest/events/v1/schema.rb +227 -218
- data/lib/twilio-ruby/rest/events/v1/sink/sink_test.rb +114 -100
- data/lib/twilio-ruby/rest/events/v1/sink/sink_validate.rb +120 -103
- data/lib/twilio-ruby/rest/events/v1/sink.rb +434 -408
- data/lib/twilio-ruby/rest/events/v1/subscription/subscribed_event.rb +365 -339
- data/lib/twilio-ruby/rest/events/v1/subscription.rb +416 -387
- data/lib/twilio-ruby/rest/events/v1.rb +87 -87
- data/lib/twilio-ruby/rest/events.rb +5 -34
- data/lib/twilio-ruby/rest/events_base.rb +38 -0
- data/lib/twilio-ruby/rest/flex_api/v1/assessments.rb +448 -0
- data/lib/twilio-ruby/rest/flex_api/v1/channel.rb +365 -330
- data/lib/twilio-ruby/rest/flex_api/v1/configuration.rb +510 -475
- data/lib/twilio-ruby/rest/flex_api/v1/flex_flow.rb +563 -555
- data/lib/twilio-ruby/rest/flex_api/v1/insights_assessments_comment.rb +327 -0
- data/lib/twilio-ruby/rest/flex_api/v1/insights_conversations.rb +228 -0
- data/lib/twilio-ruby/rest/flex_api/v1/insights_questionnaires.rb +442 -0
- data/lib/twilio-ruby/rest/flex_api/v1/insights_questionnaires_category.rb +358 -0
- data/lib/twilio-ruby/rest/flex_api/v1/insights_questionnaires_question.rb +443 -0
- data/lib/twilio-ruby/rest/flex_api/v1/insights_segments.rb +361 -0
- data/lib/twilio-ruby/rest/flex_api/v1/insights_session.rb +217 -0
- data/lib/twilio-ruby/rest/flex_api/v1/insights_settings_answer_sets.rb +155 -0
- data/lib/twilio-ruby/rest/flex_api/v1/insights_settings_comment.rb +141 -0
- data/lib/twilio-ruby/rest/flex_api/v1/insights_user_roles.rb +196 -0
- data/lib/twilio-ruby/rest/flex_api/v1/interaction/interaction_channel/interaction_channel_invite.rb +251 -0
- data/lib/twilio-ruby/rest/flex_api/v1/interaction/interaction_channel/interaction_channel_participant.rb +339 -0
- data/lib/twilio-ruby/rest/flex_api/v1/interaction/interaction_channel.rb +406 -0
- data/lib/twilio-ruby/rest/flex_api/v1/interaction.rb +267 -0
- data/lib/twilio-ruby/rest/flex_api/v1/provisioning_status.rb +187 -0
- data/lib/twilio-ruby/rest/flex_api/v1/web_channel.rb +378 -331
- data/lib/twilio-ruby/rest/flex_api/v1.rb +201 -76
- data/lib/twilio-ruby/rest/flex_api/v2/web_channels.rb +146 -0
- data/lib/twilio-ruby/rest/flex_api/v2.rb +40 -0
- data/lib/twilio-ruby/rest/flex_api.rb +33 -31
- data/lib/twilio-ruby/rest/flex_api_base.rb +43 -0
- data/lib/twilio-ruby/rest/frontline_api/v1/user.rb +244 -227
- data/lib/twilio-ruby/rest/frontline_api/v1.rb +42 -38
- data/lib/twilio-ruby/rest/frontline_api.rb +2 -34
- data/lib/twilio-ruby/rest/frontline_api_base.rb +38 -0
- data/lib/twilio-ruby/rest/insights/v1/call/annotation.rb +319 -0
- data/lib/twilio-ruby/rest/insights/v1/call/call_summary.rb +350 -0
- data/lib/twilio-ruby/rest/insights/v1/call/event.rb +269 -255
- data/lib/twilio-ruby/rest/insights/v1/call/metric.rb +241 -225
- data/lib/twilio-ruby/rest/insights/v1/call.rb +260 -228
- data/lib/twilio-ruby/rest/insights/v1/call_summaries.rb +485 -426
- data/lib/twilio-ruby/rest/insights/v1/conference/conference_participant.rb +488 -0
- data/lib/twilio-ruby/rest/insights/v1/conference.rb +505 -0
- data/lib/twilio-ruby/rest/insights/v1/room/participant.rb +378 -371
- data/lib/twilio-ruby/rest/insights/v1/room.rb +490 -489
- data/lib/twilio-ruby/rest/insights/v1/setting.rb +254 -0
- data/lib/twilio-ruby/rest/insights/v1.rb +84 -60
- data/lib/twilio-ruby/rest/insights.rb +17 -31
- data/lib/twilio-ruby/rest/insights_base.rb +38 -0
- data/lib/twilio-ruby/rest/intelligence/v2/service.rb +510 -0
- data/lib/twilio-ruby/rest/intelligence/v2/transcript/media.rb +226 -0
- data/lib/twilio-ruby/rest/intelligence/v2/transcript/operator_result.rb +388 -0
- data/lib/twilio-ruby/rest/intelligence/v2/transcript/sentence.rb +248 -0
- data/lib/twilio-ruby/rest/intelligence/v2/transcript.rb +520 -0
- data/lib/twilio-ruby/rest/intelligence/v2.rb +64 -0
- data/lib/twilio-ruby/rest/intelligence.rb +6 -0
- data/lib/twilio-ruby/rest/intelligence_base.rb +38 -0
- data/lib/twilio-ruby/rest/ip_messaging/v1/credential.rb +419 -364
- data/lib/twilio-ruby/rest/ip_messaging/v1/service/channel/invite.rb +374 -359
- data/lib/twilio-ruby/rest/ip_messaging/v1/service/channel/member.rb +422 -397
- data/lib/twilio-ruby/rest/ip_messaging/v1/service/channel/message.rb +438 -409
- data/lib/twilio-ruby/rest/ip_messaging/v1/service/channel.rb +534 -488
- data/lib/twilio-ruby/rest/ip_messaging/v1/service/role.rb +396 -347
- data/lib/twilio-ruby/rest/ip_messaging/v1/service/user/user_channel.rb +244 -233
- data/lib/twilio-ruby/rest/ip_messaging/v1/service/user.rb +465 -418
- data/lib/twilio-ruby/rest/ip_messaging/v1/service.rb +861 -779
- data/lib/twilio-ruby/rest/ip_messaging/v1.rb +57 -53
- data/lib/twilio-ruby/rest/ip_messaging/v2/credential.rb +419 -364
- data/lib/twilio-ruby/rest/ip_messaging/v2/service/binding.rb +371 -343
- data/lib/twilio-ruby/rest/ip_messaging/v2/service/channel/invite.rb +374 -359
- data/lib/twilio-ruby/rest/ip_messaging/v2/service/channel/member.rb +486 -451
- data/lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb +513 -479
- data/lib/twilio-ruby/rest/ip_messaging/v2/service/channel/webhook.rb +440 -411
- data/lib/twilio-ruby/rest/ip_messaging/v2/service/channel.rb +606 -555
- data/lib/twilio-ruby/rest/ip_messaging/v2/service/role.rb +396 -347
- data/lib/twilio-ruby/rest/ip_messaging/v2/service/user/user_binding.rb +364 -351
- data/lib/twilio-ruby/rest/ip_messaging/v2/service/user/user_channel.rb +397 -384
- data/lib/twilio-ruby/rest/ip_messaging/v2/service/user.rb +509 -467
- data/lib/twilio-ruby/rest/ip_messaging/v2/service.rb +764 -689
- data/lib/twilio-ruby/rest/ip_messaging/v2.rb +57 -53
- data/lib/twilio-ruby/rest/ip_messaging.rb +3 -41
- data/lib/twilio-ruby/rest/ip_messaging_base.rb +43 -0
- data/lib/twilio-ruby/rest/lookups/v1/phone_number.rb +243 -239
- data/lib/twilio-ruby/rest/lookups/v1.rb +42 -39
- data/lib/twilio-ruby/rest/lookups/v2/phone_number.rb +370 -0
- data/lib/twilio-ruby/rest/lookups/v2.rb +49 -0
- data/lib/twilio-ruby/rest/lookups.rb +2 -34
- data/lib/twilio-ruby/rest/lookups_base.rb +43 -0
- data/lib/twilio-ruby/rest/media/v1/media_processor.rb +410 -374
- data/lib/twilio-ruby/rest/media/v1/media_recording.rb +404 -0
- data/lib/twilio-ruby/rest/media/v1/player_streamer/playback_grant.rb +245 -214
- data/lib/twilio-ruby/rest/media/v1/player_streamer.rb +422 -380
- data/lib/twilio-ruby/rest/media/v1.rb +72 -53
- data/lib/twilio-ruby/rest/media.rb +13 -34
- data/lib/twilio-ruby/rest/media_base.rb +38 -0
- data/lib/twilio-ruby/rest/messaging/v1/brand_registration/brand_registration_otp.rb +136 -0
- data/lib/twilio-ruby/rest/messaging/v1/brand_registration/brand_vetting.rb +358 -346
- data/lib/twilio-ruby/rest/messaging/v1/brand_registration.rb +487 -420
- data/lib/twilio-ruby/rest/messaging/v1/deactivations.rb +189 -0
- data/lib/twilio-ruby/rest/messaging/v1/domain_certs.rb +280 -0
- data/lib/twilio-ruby/rest/messaging/v1/domain_config.rb +289 -0
- data/lib/twilio-ruby/rest/messaging/v1/domain_config_messaging_service.rb +238 -0
- data/lib/twilio-ruby/rest/messaging/v1/external_campaign.rb +155 -144
- data/lib/twilio-ruby/rest/messaging/v1/linkshortening_messaging_service.rb +214 -0
- data/lib/twilio-ruby/rest/messaging/v1/linkshortening_messaging_service_domain_association.rb +196 -0
- data/lib/twilio-ruby/rest/messaging/v1/service/alpha_sender.rb +351 -335
- data/lib/twilio-ruby/rest/messaging/v1/service/channel_sender.rb +329 -0
- data/lib/twilio-ruby/rest/messaging/v1/service/phone_number.rb +358 -341
- data/lib/twilio-ruby/rest/messaging/v1/service/short_code.rb +358 -336
- data/lib/twilio-ruby/rest/messaging/v1/service/us_app_to_person.rb +506 -426
- data/lib/twilio-ruby/rest/messaging/v1/service/us_app_to_person_usecase.rb +121 -115
- data/lib/twilio-ruby/rest/messaging/v1/service.rb +767 -763
- data/lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb +777 -0
- data/lib/twilio-ruby/rest/messaging/v1/usecase.rb +106 -94
- data/lib/twilio-ruby/rest/messaging/v1.rb +187 -74
- data/lib/twilio-ruby/rest/messaging.rb +36 -35
- data/lib/twilio-ruby/rest/messaging_base.rb +38 -0
- data/lib/twilio-ruby/rest/microvisor/v1/account_config.rb +358 -0
- data/lib/twilio-ruby/rest/microvisor/v1/account_secret.rb +351 -0
- data/lib/twilio-ruby/rest/microvisor/v1/app/app_manifest.rb +208 -0
- data/lib/twilio-ruby/rest/microvisor/v1/app.rb +349 -0
- data/lib/twilio-ruby/rest/microvisor/v1/device/device_config.rb +374 -0
- data/lib/twilio-ruby/rest/microvisor/v1/device/device_secret.rb +367 -0
- data/lib/twilio-ruby/rest/microvisor/v1/device.rb +427 -0
- data/lib/twilio-ruby/rest/microvisor/v1.rb +94 -0
- data/lib/twilio-ruby/rest/microvisor.rb +24 -0
- data/lib/twilio-ruby/rest/microvisor_base.rb +38 -0
- data/lib/twilio-ruby/rest/monitor/v1/alert.rb +398 -395
- data/lib/twilio-ruby/rest/monitor/v1/event.rb +381 -390
- data/lib/twilio-ruby/rest/monitor/v1.rb +57 -53
- data/lib/twilio-ruby/rest/monitor.rb +3 -34
- data/lib/twilio-ruby/rest/monitor_base.rb +38 -0
- data/lib/twilio-ruby/rest/notify/v1/credential.rb +421 -408
- data/lib/twilio-ruby/rest/notify/v1/service/binding.rb +437 -452
- data/lib/twilio-ruby/rest/notify/v1/service/notification.rb +313 -362
- data/lib/twilio-ruby/rest/notify/v1/service.rb +626 -622
- data/lib/twilio-ruby/rest/notify/v1.rb +57 -55
- data/lib/twilio-ruby/rest/notify.rb +3 -34
- data/lib/twilio-ruby/rest/notify_base.rb +38 -0
- data/lib/twilio-ruby/rest/numbers/v1/bulk_eligibility.rb +224 -0
- data/lib/twilio-ruby/rest/numbers/v1/porting_bulk_portability.rb +229 -0
- data/lib/twilio-ruby/rest/numbers/v1/porting_port_in_fetch.rb +245 -0
- data/lib/twilio-ruby/rest/numbers/v1/porting_portability.rb +263 -0
- data/lib/twilio-ruby/rest/numbers/v1.rb +94 -0
- data/lib/twilio-ruby/rest/numbers/v2/authorization_document/dependent_hosted_number_order.rb +343 -0
- data/lib/twilio-ruby/rest/numbers/v2/authorization_document.rb +403 -0
- data/lib/twilio-ruby/rest/numbers/v2/bulk_hosted_number_order.rb +249 -0
- data/lib/twilio-ruby/rest/numbers/v2/hosted_number_order.rb +502 -0
- data/lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/bundle/bundle_copy.rb +276 -179
- data/lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/bundle/evaluation.rb +324 -298
- data/lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/bundle/item_assignment.rb +333 -309
- data/lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/bundle/replace_items.rb +194 -181
- data/lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/bundle.rb +601 -550
- data/lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/end_user.rb +391 -351
- data/lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/end_user_type.rb +290 -266
- data/lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/regulation.rb +322 -307
- data/lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/supporting_document.rb +412 -364
- data/lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/supporting_document_type.rb +290 -266
- data/lib/twilio-ruby/rest/numbers/v2/regulatory_compliance.rb +177 -181
- data/lib/twilio-ruby/rest/numbers/v2.rb +78 -28
- data/lib/twilio-ruby/rest/numbers.rb +2 -34
- data/lib/twilio-ruby/rest/numbers_base.rb +43 -0
- data/lib/twilio-ruby/rest/preview/deployed_devices/fleet/certificate.rb +410 -375
- data/lib/twilio-ruby/rest/preview/deployed_devices/fleet/deployment.rb +394 -358
- data/lib/twilio-ruby/rest/preview/deployed_devices/fleet/device.rb +449 -418
- data/lib/twilio-ruby/rest/preview/deployed_devices/fleet/key.rb +407 -369
- data/lib/twilio-ruby/rest/preview/deployed_devices/fleet.rb +494 -459
- data/lib/twilio-ruby/rest/preview/deployed_devices.rb +42 -38
- data/lib/twilio-ruby/rest/preview/hosted_numbers/authorization_document/dependent_hosted_number_order.rb +370 -396
- data/lib/twilio-ruby/rest/preview/hosted_numbers/authorization_document.rb +446 -446
- data/lib/twilio-ruby/rest/preview/hosted_numbers/hosted_number_order.rb +610 -625
- data/lib/twilio-ruby/rest/preview/hosted_numbers.rb +57 -55
- data/lib/twilio-ruby/rest/preview/marketplace/available_add_on/available_add_on_extension.rb +301 -298
- data/lib/twilio-ruby/rest/preview/marketplace/available_add_on.rb +325 -309
- data/lib/twilio-ruby/rest/preview/marketplace/installed_add_on/installed_add_on_extension.rb +342 -330
- data/lib/twilio-ruby/rest/preview/marketplace/installed_add_on.rb +429 -398
- data/lib/twilio-ruby/rest/preview/marketplace.rb +57 -53
- data/lib/twilio-ruby/rest/preview/sync/service/document/document_permission.rb +378 -374
- data/lib/twilio-ruby/rest/preview/sync/service/document.rb +442 -399
- data/lib/twilio-ruby/rest/preview/sync/service/sync_list/sync_list_item.rb +434 -407
- data/lib/twilio-ruby/rest/preview/sync/service/sync_list/sync_list_permission.rb +378 -374
- data/lib/twilio-ruby/rest/preview/sync/service/sync_list.rb +419 -398
- data/lib/twilio-ruby/rest/preview/sync/service/sync_map/sync_map_item.rb +437 -404
- data/lib/twilio-ruby/rest/preview/sync/service/sync_map/sync_map_permission.rb +378 -374
- data/lib/twilio-ruby/rest/preview/sync/service/sync_map.rb +419 -398
- data/lib/twilio-ruby/rest/preview/sync/service.rb +495 -452
- data/lib/twilio-ruby/rest/preview/sync.rb +42 -37
- data/lib/twilio-ruby/rest/preview/wireless/command.rb +387 -364
- data/lib/twilio-ruby/rest/preview/wireless/rate_plan.rb +448 -398
- data/lib/twilio-ruby/rest/preview/wireless/sim/usage.rb +232 -205
- data/lib/twilio-ruby/rest/preview/wireless/sim.rb +574 -523
- data/lib/twilio-ruby/rest/preview/wireless.rb +72 -69
- data/lib/twilio-ruby/rest/preview.rb +11 -137
- data/lib/twilio-ruby/rest/preview_base.rb +58 -0
- data/lib/twilio-ruby/rest/pricing/v1/messaging/country.rb +297 -275
- data/lib/twilio-ruby/rest/pricing/v1/messaging.rb +107 -119
- data/lib/twilio-ruby/rest/pricing/v1/phone_number/country.rb +290 -268
- data/lib/twilio-ruby/rest/pricing/v1/phone_number.rb +107 -119
- data/lib/twilio-ruby/rest/pricing/v1/voice/country.rb +297 -275
- data/lib/twilio-ruby/rest/pricing/v1/voice/number.rb +220 -197
- data/lib/twilio-ruby/rest/pricing/v1/voice.rb +121 -135
- data/lib/twilio-ruby/rest/pricing/v1.rb +45 -42
- data/lib/twilio-ruby/rest/pricing/v2/country.rb +289 -270
- data/lib/twilio-ruby/rest/pricing/v2/number.rb +232 -217
- data/lib/twilio-ruby/rest/pricing/v2/voice/country.rb +297 -275
- data/lib/twilio-ruby/rest/pricing/v2/voice/number.rb +238 -220
- data/lib/twilio-ruby/rest/pricing/v2/voice.rb +121 -138
- data/lib/twilio-ruby/rest/pricing/v2.rb +63 -65
- data/lib/twilio-ruby/rest/pricing.rb +6 -41
- data/lib/twilio-ruby/rest/pricing_base.rb +43 -0
- data/lib/twilio-ruby/rest/proxy/v1/service/phone_number.rb +419 -403
- data/lib/twilio-ruby/rest/proxy/v1/service/session/interaction.rb +408 -418
- data/lib/twilio-ruby/rest/proxy/v1/service/session/participant/message_interaction.rb +430 -449
- data/lib/twilio-ruby/rest/proxy/v1/service/session/participant.rb +421 -455
- data/lib/twilio-ruby/rest/proxy/v1/service/session.rb +522 -547
- data/lib/twilio-ruby/rest/proxy/v1/service/short_code.rb +399 -370
- data/lib/twilio-ruby/rest/proxy/v1/service.rb +559 -596
- data/lib/twilio-ruby/rest/proxy/v1.rb +42 -38
- data/lib/twilio-ruby/rest/proxy.rb +2 -34
- data/lib/twilio-ruby/rest/proxy_base.rb +38 -0
- data/lib/twilio-ruby/rest/routes/v2/phone_number.rb +268 -0
- data/lib/twilio-ruby/rest/routes/v2/sip_domain.rb +268 -0
- data/lib/twilio-ruby/rest/routes/v2/trunk.rb +268 -0
- data/lib/twilio-ruby/rest/routes/v2.rb +79 -0
- data/lib/twilio-ruby/rest/routes.rb +32 -0
- data/lib/twilio-ruby/rest/routes_base.rb +38 -0
- data/lib/twilio-ruby/rest/serverless/v1/service/asset/asset_version.rb +315 -323
- data/lib/twilio-ruby/rest/serverless/v1/service/asset.rb +412 -380
- data/lib/twilio-ruby/rest/serverless/v1/service/build/build_status.rb +208 -208
- data/lib/twilio-ruby/rest/serverless/v1/service/build.rb +407 -384
- data/lib/twilio-ruby/rest/serverless/v1/service/environment/deployment.rb +336 -338
- data/lib/twilio-ruby/rest/serverless/v1/service/environment/log.rb +361 -383
- data/lib/twilio-ruby/rest/serverless/v1/service/environment/variable.rb +403 -396
- data/lib/twilio-ruby/rest/serverless/v1/service/environment.rb +456 -447
- data/lib/twilio-ruby/rest/serverless/v1/service/function/function_version/function_version_content.rb +223 -234
- data/lib/twilio-ruby/rest/serverless/v1/service/function/function_version.rb +342 -353
- data/lib/twilio-ruby/rest/serverless/v1/service/function.rb +412 -380
- data/lib/twilio-ruby/rest/serverless/v1/service.rb +523 -493
- data/lib/twilio-ruby/rest/serverless/v1.rb +42 -37
- data/lib/twilio-ruby/rest/serverless.rb +2 -34
- data/lib/twilio-ruby/rest/serverless_base.rb +38 -0
- data/lib/twilio-ruby/rest/studio/v1/flow/engagement/engagement_context.rb +206 -199
- data/lib/twilio-ruby/rest/studio/v1/flow/engagement/step/step_context.rb +221 -218
- data/lib/twilio-ruby/rest/studio/v1/flow/engagement/step.rb +361 -355
- data/lib/twilio-ruby/rest/studio/v1/flow/engagement.rb +422 -394
- data/lib/twilio-ruby/rest/studio/v1/flow/execution/execution_context.rb +206 -200
- data/lib/twilio-ruby/rest/studio/v1/flow/execution/execution_step/execution_step_context.rb +221 -221
- data/lib/twilio-ruby/rest/studio/v1/flow/execution/execution_step.rb +361 -361
- data/lib/twilio-ruby/rest/studio/v1/flow/execution.rb +468 -449
- data/lib/twilio-ruby/rest/studio/v1/flow.rb +380 -355
- data/lib/twilio-ruby/rest/studio/v1.rb +42 -37
- data/lib/twilio-ruby/rest/studio/v2/flow/execution/execution_context.rb +206 -200
- data/lib/twilio-ruby/rest/studio/v2/flow/execution/execution_step/execution_step_context.rb +221 -221
- data/lib/twilio-ruby/rest/studio/v2/flow/execution/execution_step.rb +361 -361
- data/lib/twilio-ruby/rest/studio/v2/flow/execution.rb +461 -442
- data/lib/twilio-ruby/rest/studio/v2/flow/flow_revision.rb +341 -320
- data/lib/twilio-ruby/rest/studio/v2/flow/flow_test_user.rb +232 -0
- data/lib/twilio-ruby/rest/studio/v2/flow.rb +519 -472
- data/lib/twilio-ruby/rest/studio/v2/flow_validate.rb +121 -99
- data/lib/twilio-ruby/rest/studio/v2.rb +48 -44
- data/lib/twilio-ruby/rest/studio.rb +3 -41
- data/lib/twilio-ruby/rest/studio_base.rb +43 -0
- data/lib/twilio-ruby/rest/supersim/v1/esim_profile.rb +403 -0
- data/lib/twilio-ruby/rest/supersim/v1/fleet.rb +472 -484
- data/lib/twilio-ruby/rest/supersim/v1/ip_command.rb +398 -406
- data/lib/twilio-ruby/rest/supersim/v1/network.rb +302 -297
- data/lib/twilio-ruby/rest/supersim/v1/network_access_profile/network_access_profile_network.rb +337 -332
- data/lib/twilio-ruby/rest/supersim/v1/network_access_profile.rb +380 -351
- data/lib/twilio-ruby/rest/supersim/v1/settings_update.rb +256 -0
- data/lib/twilio-ruby/rest/supersim/v1/sim/billing_period.rb +242 -224
- data/lib/twilio-ruby/rest/supersim/v1/sim/sim_ip_address.rb +207 -0
- data/lib/twilio-ruby/rest/supersim/v1/sim.rb +460 -433
- data/lib/twilio-ruby/rest/supersim/v1/sms_command.rb +358 -361
- data/lib/twilio-ruby/rest/supersim/v1/usage_record.rb +286 -311
- data/lib/twilio-ruby/rest/supersim/v1.rb +144 -140
- data/lib/twilio-ruby/rest/supersim.rb +22 -40
- data/lib/twilio-ruby/rest/supersim_base.rb +38 -0
- data/lib/twilio-ruby/rest/sync/v1/service/document/document_permission.rb +376 -371
- data/lib/twilio-ruby/rest/sync/v1/service/document.rb +456 -423
- data/lib/twilio-ruby/rest/sync/v1/service/sync_list/sync_list_item.rb +466 -490
- data/lib/twilio-ruby/rest/sync/v1/service/sync_list/sync_list_permission.rb +376 -370
- data/lib/twilio-ruby/rest/sync/v1/service/sync_list.rb +470 -445
- data/lib/twilio-ruby/rest/sync/v1/service/sync_map/sync_map_item.rb +469 -495
- data/lib/twilio-ruby/rest/sync/v1/service/sync_map/sync_map_permission.rb +376 -368
- data/lib/twilio-ruby/rest/sync/v1/service/sync_map.rb +470 -444
- data/lib/twilio-ruby/rest/sync/v1/service/sync_stream/stream_message.rb +139 -132
- data/lib/twilio-ruby/rest/sync/v1/service/sync_stream.rb +419 -400
- data/lib/twilio-ruby/rest/sync/v1/service.rb +575 -567
- data/lib/twilio-ruby/rest/sync/v1.rb +42 -37
- data/lib/twilio-ruby/rest/sync.rb +2 -34
- data/lib/twilio-ruby/rest/sync_base.rb +38 -0
- data/lib/twilio-ruby/rest/taskrouter/v1/workspace/activity.rb +405 -395
- data/lib/twilio-ruby/rest/taskrouter/v1/workspace/event.rb +442 -464
- data/lib/twilio-ruby/rest/taskrouter/v1/workspace/task/reservation.rb +705 -736
- data/lib/twilio-ruby/rest/taskrouter/v1/workspace/task.rb +623 -661
- data/lib/twilio-ruby/rest/taskrouter/v1/workspace/task_channel.rb +409 -382
- data/lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue/task_queue_cumulative_statistics.rb +359 -365
- data/lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue/task_queue_real_time_statistics.rb +279 -275
- data/lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue/task_queue_statistics.rb +230 -236
- data/lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue/task_queues_statistics.rb +239 -258
- data/lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb +574 -566
- data/lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/reservation.rb +687 -732
- data/lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/worker_channel.rb +389 -388
- data/lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/worker_statistics.rb +235 -239
- data/lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/workers_cumulative_statistics.rb +281 -265
- data/lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/workers_real_time_statistics.rb +215 -193
- data/lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/workers_statistics.rb +251 -234
- data/lib/twilio-ruby/rest/taskrouter/v1/workspace/worker.rb +623 -631
- data/lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_cumulative_statistics.rb +359 -373
- data/lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_real_time_statistics.rb +245 -241
- data/lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_statistics.rb +230 -244
- data/lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow.rb +523 -510
- data/lib/twilio-ruby/rest/taskrouter/v1/workspace/workspace_cumulative_statistics.rb +353 -354
- data/lib/twilio-ruby/rest/taskrouter/v1/workspace/workspace_real_time_statistics.rb +231 -206
- data/lib/twilio-ruby/rest/taskrouter/v1/workspace/workspace_statistics.rb +241 -234
- data/lib/twilio-ruby/rest/taskrouter/v1/workspace.rb +720 -730
- data/lib/twilio-ruby/rest/taskrouter/v1.rb +42 -37
- data/lib/twilio-ruby/rest/taskrouter.rb +2 -34
- data/lib/twilio-ruby/rest/taskrouter_base.rb +38 -0
- data/lib/twilio-ruby/rest/trunking/v1/trunk/credential_list.rb +342 -320
- data/lib/twilio-ruby/rest/trunking/v1/trunk/ip_access_control_list.rb +342 -317
- data/lib/twilio-ruby/rest/trunking/v1/trunk/origination_url.rb +440 -419
- data/lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.rb +475 -451
- data/lib/twilio-ruby/rest/trunking/v1/trunk/recording.rb +224 -191
- data/lib/twilio-ruby/rest/trunking/v1/trunk.rb +623 -630
- data/lib/twilio-ruby/rest/trunking/v1.rb +42 -38
- data/lib/twilio-ruby/rest/trunking.rb +2 -34
- data/lib/twilio-ruby/rest/trunking_base.rb +38 -0
- data/lib/twilio-ruby/rest/trusthub/v1/compliance_inquiries.rb +232 -0
- data/lib/twilio-ruby/rest/trusthub/v1/compliance_tollfree_inquiries.rb +211 -0
- data/lib/twilio-ruby/rest/trusthub/v1/customer_profiles/customer_profiles_channel_endpoint_assignment.rb +357 -352
- data/lib/twilio-ruby/rest/trusthub/v1/customer_profiles/customer_profiles_entity_assignments.rb +335 -323
- data/lib/twilio-ruby/rest/trusthub/v1/customer_profiles/customer_profiles_evaluations.rb +333 -321
- data/lib/twilio-ruby/rest/trusthub/v1/customer_profiles.rb +525 -513
- data/lib/twilio-ruby/rest/trusthub/v1/end_user.rb +383 -346
- data/lib/twilio-ruby/rest/trusthub/v1/end_user_type.rb +282 -261
- data/lib/twilio-ruby/rest/trusthub/v1/policies.rb +275 -252
- data/lib/twilio-ruby/rest/trusthub/v1/supporting_document.rb +397 -359
- data/lib/twilio-ruby/rest/trusthub/v1/supporting_document_type.rb +282 -261
- data/lib/twilio-ruby/rest/trusthub/v1/trust_products/trust_products_channel_endpoint_assignment.rb +357 -352
- data/lib/twilio-ruby/rest/trusthub/v1/trust_products/trust_products_entity_assignments.rb +335 -323
- data/lib/twilio-ruby/rest/trusthub/v1/trust_products/trust_products_evaluations.rb +333 -321
- data/lib/twilio-ruby/rest/trusthub/v1/trust_products.rb +525 -513
- data/lib/twilio-ruby/rest/trusthub/v1.rb +153 -139
- data/lib/twilio-ruby/rest/trusthub.rb +8 -34
- data/lib/twilio-ruby/rest/trusthub_base.rb +38 -0
- data/lib/twilio-ruby/rest/verify/v2/form.rb +195 -183
- data/lib/twilio-ruby/rest/verify/v2/safelist.rb +231 -0
- data/lib/twilio-ruby/rest/verify/v2/service/access_token.rb +265 -116
- data/lib/twilio-ruby/rest/verify/v2/service/entity/challenge/notification.rb +191 -198
- data/lib/twilio-ruby/rest/verify/v2/service/entity/challenge.rb +496 -521
- data/lib/twilio-ruby/rest/verify/v2/service/entity/factor.rb +447 -454
- data/lib/twilio-ruby/rest/verify/v2/service/entity/new_factor.rb +249 -279
- data/lib/twilio-ruby/rest/verify/v2/service/entity.rb +422 -422
- data/lib/twilio-ruby/rest/verify/v2/service/messaging_configuration.rb +379 -363
- data/lib/twilio-ruby/rest/verify/v2/service/rate_limit/bucket.rb +401 -388
- data/lib/twilio-ruby/rest/verify/v2/service/rate_limit.rb +420 -384
- data/lib/twilio-ruby/rest/verify/v2/service/verification.rb +380 -359
- data/lib/twilio-ruby/rest/verify/v2/service/verification_check.rb +218 -198
- data/lib/twilio-ruby/rest/verify/v2/service/webhook.rb +447 -420
- data/lib/twilio-ruby/rest/verify/v2/service.rb +782 -770
- data/lib/twilio-ruby/rest/verify/v2/template.rb +221 -198
- data/lib/twilio-ruby/rest/verify/v2/verification_attempt.rb +372 -319
- data/lib/twilio-ruby/rest/verify/v2/verification_attempts_summary.rb +247 -0
- data/lib/twilio-ruby/rest/verify/v2.rb +99 -78
- data/lib/twilio-ruby/rest/verify.rb +23 -36
- data/lib/twilio-ruby/rest/verify_base.rb +38 -0
- data/lib/twilio-ruby/rest/video/v1/composition.rb +477 -486
- data/lib/twilio-ruby/rest/video/v1/composition_hook.rb +525 -647
- data/lib/twilio-ruby/rest/video/v1/composition_settings.rb +281 -261
- data/lib/twilio-ruby/rest/video/v1/recording.rb +426 -405
- data/lib/twilio-ruby/rest/video/v1/recording_settings.rb +281 -261
- data/lib/twilio-ruby/rest/video/v1/room/participant/anonymize.rb +259 -0
- data/lib/twilio-ruby/rest/video/v1/room/participant/published_track.rb +331 -0
- data/lib/twilio-ruby/rest/video/v1/room/participant/subscribe_rules.rb +181 -0
- data/lib/twilio-ruby/rest/video/v1/room/participant/subscribed_track.rb +338 -0
- data/lib/twilio-ruby/rest/video/v1/room/participant.rb +498 -0
- data/lib/twilio-ruby/rest/video/v1/room/recording_rules.rb +170 -0
- data/lib/twilio-ruby/rest/video/v1/room/room_recording.rb +423 -0
- data/lib/twilio-ruby/rest/video/v1/room.rb +606 -567
- data/lib/twilio-ruby/rest/video/v1.rb +99 -99
- data/lib/twilio-ruby/rest/video.rb +7 -34
- data/lib/twilio-ruby/rest/video_base.rb +38 -0
- data/lib/twilio-ruby/rest/voice/v1/archived_call.rb +168 -0
- data/lib/twilio-ruby/rest/voice/v1/byoc_trunk.rb +501 -486
- data/lib/twilio-ruby/rest/voice/v1/connection_policy/connection_policy_target.rb +440 -434
- data/lib/twilio-ruby/rest/voice/v1/connection_policy.rb +391 -352
- data/lib/twilio-ruby/rest/voice/v1/dialing_permissions/bulk_country_update.rb +135 -121
- data/lib/twilio-ruby/rest/voice/v1/dialing_permissions/country/highrisk_special_prefix.rb +195 -183
- data/lib/twilio-ruby/rest/voice/v1/dialing_permissions/country.rb +375 -397
- data/lib/twilio-ruby/rest/voice/v1/dialing_permissions/settings.rb +217 -190
- data/lib/twilio-ruby/rest/voice/v1/dialing_permissions.rb +122 -121
- data/lib/twilio-ruby/rest/voice/v1/ip_record.rb +377 -339
- data/lib/twilio-ruby/rest/voice/v1/source_ip_mapping.rb +360 -319
- data/lib/twilio-ruby/rest/voice/v1.rb +130 -96
- data/lib/twilio-ruby/rest/voice.rb +12 -31
- data/lib/twilio-ruby/rest/voice_base.rb +38 -0
- data/lib/twilio-ruby/rest/wireless/v1/command.rb +408 -406
- data/lib/twilio-ruby/rest/wireless/v1/rate_plan.rb +463 -436
- data/lib/twilio-ruby/rest/wireless/v1/sim/data_session.rb +298 -284
- data/lib/twilio-ruby/rest/wireless/v1/sim/usage_record.rb +239 -243
- data/lib/twilio-ruby/rest/wireless/v1/sim.rb +634 -647
- data/lib/twilio-ruby/rest/wireless/v1/usage_record.rb +226 -221
- data/lib/twilio-ruby/rest/wireless/v1.rb +78 -76
- data/lib/twilio-ruby/rest/wireless.rb +5 -34
- data/lib/twilio-ruby/rest/wireless_base.rb +38 -0
- data/lib/twilio-ruby/rest.rb +1 -0
- data/lib/twilio-ruby/security/request_validator.rb +1 -1
- data/lib/twilio-ruby/twiml/voice_response.rb +209 -42
- data/lib/twilio-ruby/version.rb +1 -1
- data/lib/twilio-ruby.rb +1 -1
- data/sonar-project.properties +2 -2
- data/twilio-ruby.gemspec +2 -3
- metadata +155 -98
- data/.github/workflows/deploy.yml +0 -65
- data/.github/workflows/test.yml +0 -52
- data/conf/cacert.pem +0 -3376
- data/lib/twilio-ruby/framework/twilio_response.rb +0 -19
- data/lib/twilio-ruby/rest/api/v2010/account/available_phone_number/local.rb +0 -500
- data/lib/twilio-ruby/rest/api/v2010/account/available_phone_number/machine_to_machine.rb +0 -500
- data/lib/twilio-ruby/rest/api/v2010/account/available_phone_number/mobile.rb +0 -500
- data/lib/twilio-ruby/rest/api/v2010/account/available_phone_number/national.rb +0 -500
- data/lib/twilio-ruby/rest/api/v2010/account/available_phone_number/shared_cost.rb +0 -500
- data/lib/twilio-ruby/rest/api/v2010/account/available_phone_number/toll_free.rb +0 -500
- data/lib/twilio-ruby/rest/api/v2010/account/available_phone_number/voip.rb +0 -500
- data/lib/twilio-ruby/rest/api/v2010/account/available_phone_number.rb +0 -464
- data/lib/twilio-ruby/rest/api/v2010/account/sip/domain/auth_types/auth_calls_mapping/auth_calls_credential_list_mapping.rb +0 -348
- data/lib/twilio-ruby/rest/api/v2010/account/sip/domain/auth_types/auth_calls_mapping.rb +0 -163
- data/lib/twilio-ruby/rest/api/v2010/account/sip/domain/auth_types/auth_registrations_mapping.rb +0 -137
- data/lib/twilio-ruby/rest/autopilot/v1/assistant/defaults.rb +0 -220
- data/lib/twilio-ruby/rest/autopilot/v1/assistant/dialogue.rb +0 -214
- data/lib/twilio-ruby/rest/autopilot/v1/assistant/field_type/field_value.rb +0 -399
- data/lib/twilio-ruby/rest/autopilot/v1/assistant/field_type.rb +0 -418
- data/lib/twilio-ruby/rest/autopilot/v1/assistant/model_build.rb +0 -392
- data/lib/twilio-ruby/rest/autopilot/v1/assistant/query.rb +0 -469
- data/lib/twilio-ruby/rest/autopilot/v1/assistant/style_sheet.rb +0 -218
- data/lib/twilio-ruby/rest/autopilot/v1/assistant/task/field.rb +0 -386
- data/lib/twilio-ruby/rest/autopilot/v1/assistant/task/sample.rb +0 -456
- data/lib/twilio-ruby/rest/autopilot/v1/assistant/task/task_actions.rb +0 -255
- data/lib/twilio-ruby/rest/autopilot/v1/assistant/task/task_statistics.rb +0 -237
- data/lib/twilio-ruby/rest/autopilot/v1/assistant/task.rb +0 -507
- data/lib/twilio-ruby/rest/autopilot/v1/assistant/webhook.rb +0 -420
- data/lib/twilio-ruby/rest/autopilot/v1/assistant.rb +0 -650
- data/lib/twilio-ruby/rest/autopilot/v1/restore_assistant.rb +0 -194
- data/lib/twilio-ruby/rest/autopilot/v1.rb +0 -52
- data/lib/twilio-ruby/rest/autopilot.rb +0 -53
- data/lib/twilio-ruby/rest/events/v1/schema/version.rb +0 -290
- data/lib/twilio-ruby/rest/fax/v1/fax/fax_media.rb +0 -314
- data/lib/twilio-ruby/rest/fax/v1/fax.rb +0 -536
- data/lib/twilio-ruby/rest/fax/v1.rb +0 -45
- data/lib/twilio-ruby/rest/fax.rb +0 -47
- data/lib/twilio-ruby/rest/insights/v1/call/summary.rb +0 -307
- data/lib/twilio-ruby/rest/messaging/v1/deactivation.rb +0 -164
- data/lib/twilio-ruby/rest/preview/bulk_exports/export/day.rb +0 -294
- 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/brands_information.rb +0 -195
- data/lib/twilio-ruby/rest/preview/trusted_comms/cps.rb +0 -186
- data/lib/twilio-ruby/rest/preview/trusted_comms/current_call.rb +0 -277
- data/lib/twilio-ruby/rest/preview/trusted_comms.rb +0 -65
- data/lib/twilio-ruby/rest/preview/understand/assistant/assistant_fallback_actions.rb +0 -212
- data/lib/twilio-ruby/rest/preview/understand/assistant/assistant_initiation_actions.rb +0 -212
- data/lib/twilio-ruby/rest/preview/understand/assistant/dialogue.rb +0 -206
- data/lib/twilio-ruby/rest/preview/understand/assistant/field_type/field_value.rb +0 -386
- data/lib/twilio-ruby/rest/preview/understand/assistant/field_type.rb +0 -407
- data/lib/twilio-ruby/rest/preview/understand/assistant/model_build.rb +0 -380
- data/lib/twilio-ruby/rest/preview/understand/assistant/query.rb +0 -437
- data/lib/twilio-ruby/rest/preview/understand/assistant/style_sheet.rb +0 -212
- data/lib/twilio-ruby/rest/preview/understand/assistant/task/field.rb +0 -373
- data/lib/twilio-ruby/rest/preview/understand/assistant/task/sample.rb +0 -428
- data/lib/twilio-ruby/rest/preview/understand/assistant/task/task_actions.rb +0 -241
- data/lib/twilio-ruby/rest/preview/understand/assistant/task/task_statistics.rb +0 -225
- data/lib/twilio-ruby/rest/preview/understand/assistant/task.rb +0 -495
- data/lib/twilio-ruby/rest/preview/understand/assistant.rb +0 -629
- data/lib/twilio-ruby/rest/preview/understand.rb +0 -45
- data/lib/twilio-ruby/rest/studio/v2/flow/test_user.rb +0 -199
- data/lib/twilio-ruby/rest/supersim/v1/command.rb +0 -368
- data/lib/twilio-ruby/rest/video/v1/room/recording.rb +0 -406
- data/lib/twilio-ruby/rest/video/v1/room/room_participant/room_participant_published_track.rb +0 -335
- data/lib/twilio-ruby/rest/video/v1/room/room_participant/room_participant_subscribe_rule.rb +0 -175
- data/lib/twilio-ruby/rest/video/v1/room/room_participant/room_participant_subscribed_track.rb +0 -340
- data/lib/twilio-ruby/rest/video/v1/room/room_participant.rb +0 -483
- data/lib/twilio-ruby/rest/video/v1/room/room_recording_rule.rb +0 -144
@@ -1,728 +1,663 @@
|
|
1
1
|
##
|
2
|
-
#
|
3
|
-
#
|
4
|
-
# |
|
5
|
-
#
|
2
|
+
# This code was generated by
|
3
|
+
# ___ _ _ _ _ _ _ ____ ____ ____ _ ____ ____ _ _ ____ ____ ____ ___ __ __
|
4
|
+
# | | | | | | | | | __ | | |__| | __ | __ |___ |\ | |___ |__/ |__| | | | |__/
|
5
|
+
# | |_|_| | |___ | |__| |__| | | | |__] |___ | \| |___ | \ | | | |__| | \
|
6
6
|
#
|
7
|
-
#
|
7
|
+
# Twilio - Api
|
8
|
+
# This is the public Twilio REST API.
|
9
|
+
#
|
10
|
+
# NOTE: This class is auto generated by OpenAPI Generator.
|
11
|
+
# https://openapi-generator.tech
|
12
|
+
# Do not edit the class manually.
|
13
|
+
#
|
14
|
+
|
8
15
|
|
9
16
|
module Twilio
|
10
|
-
|
11
|
-
|
12
|
-
|
13
|
-
|
14
|
-
|
15
|
-
|
16
|
-
|
17
|
-
|
18
|
-
|
19
|
-
|
20
|
-
|
21
|
-
|
22
|
-
|
23
|
-
|
24
|
-
|
25
|
-
|
26
|
-
|
27
|
-
|
28
|
-
|
29
|
-
|
30
|
-
|
31
|
-
|
32
|
-
|
33
|
-
|
34
|
-
|
35
|
-
|
36
|
-
|
37
|
-
|
38
|
-
|
39
|
-
|
40
|
-
|
41
|
-
|
42
|
-
|
43
|
-
|
44
|
-
|
45
|
-
|
46
|
-
|
47
|
-
|
48
|
-
|
49
|
-
|
50
|
-
|
51
|
-
|
52
|
-
|
53
|
-
|
54
|
-
|
55
|
-
|
56
|
-
|
57
|
-
|
58
|
-
|
59
|
-
|
60
|
-
|
61
|
-
|
62
|
-
|
63
|
-
|
64
|
-
|
65
|
-
|
66
|
-
|
67
|
-
|
68
|
-
|
69
|
-
|
70
|
-
|
71
|
-
|
72
|
-
|
73
|
-
|
74
|
-
|
75
|
-
|
76
|
-
|
77
|
-
|
78
|
-
|
79
|
-
|
80
|
-
|
81
|
-
|
82
|
-
|
83
|
-
|
84
|
-
|
85
|
-
|
86
|
-
|
87
|
-
|
88
|
-
|
89
|
-
|
90
|
-
|
91
|
-
|
92
|
-
|
93
|
-
|
94
|
-
|
95
|
-
|
96
|
-
|
97
|
-
|
98
|
-
|
99
|
-
|
100
|
-
|
101
|
-
|
102
|
-
|
103
|
-
|
104
|
-
|
105
|
-
|
106
|
-
|
107
|
-
|
108
|
-
|
109
|
-
|
110
|
-
|
111
|
-
|
112
|
-
|
113
|
-
|
114
|
-
|
115
|
-
|
116
|
-
|
117
|
-
|
118
|
-
|
119
|
-
|
120
|
-
|
121
|
-
|
122
|
-
|
123
|
-
|
124
|
-
|
125
|
-
|
126
|
-
|
127
|
-
|
128
|
-
|
129
|
-
|
130
|
-
|
131
|
-
|
132
|
-
|
133
|
-
|
134
|
-
|
135
|
-
|
136
|
-
|
137
|
-
|
138
|
-
|
139
|
-
|
140
|
-
|
141
|
-
|
142
|
-
|
143
|
-
|
144
|
-
|
145
|
-
|
146
|
-
|
147
|
-
|
148
|
-
|
149
|
-
|
150
|
-
|
151
|
-
|
152
|
-
|
153
|
-
|
154
|
-
|
155
|
-
|
156
|
-
|
157
|
-
|
158
|
-
|
159
|
-
|
160
|
-
|
161
|
-
|
162
|
-
|
163
|
-
|
164
|
-
|
165
|
-
|
166
|
-
|
167
|
-
|
168
|
-
|
169
|
-
|
170
|
-
|
171
|
-
|
172
|
-
|
173
|
-
|
174
|
-
|
175
|
-
|
176
|
-
|
177
|
-
|
178
|
-
|
179
|
-
|
180
|
-
|
181
|
-
|
182
|
-
|
183
|
-
|
184
|
-
|
185
|
-
|
186
|
-
|
187
|
-
|
188
|
-
|
189
|
-
|
190
|
-
|
191
|
-
|
192
|
-
|
193
|
-
|
194
|
-
|
195
|
-
|
196
|
-
|
197
|
-
|
198
|
-
|
199
|
-
|
200
|
-
|
201
|
-
|
202
|
-
|
203
|
-
|
204
|
-
|
205
|
-
|
206
|
-
|
207
|
-
|
208
|
-
|
209
|
-
|
210
|
-
|
211
|
-
|
212
|
-
|
213
|
-
|
214
|
-
|
215
|
-
|
216
|
-
|
217
|
-
|
218
|
-
|
219
|
-
@
|
220
|
-
|
221
|
-
|
222
|
-
|
223
|
-
|
224
|
-
|
225
|
-
|
226
|
-
|
227
|
-
|
228
|
-
|
229
|
-
|
230
|
-
|
231
|
-
|
232
|
-
|
233
|
-
|
234
|
-
|
235
|
-
|
236
|
-
|
237
|
-
|
238
|
-
|
239
|
-
|
240
|
-
|
241
|
-
|
242
|
-
|
243
|
-
|
244
|
-
|
245
|
-
|
246
|
-
|
247
|
-
|
248
|
-
|
249
|
-
|
250
|
-
|
251
|
-
|
252
|
-
|
253
|
-
|
254
|
-
|
255
|
-
|
256
|
-
|
257
|
-
|
258
|
-
|
259
|
-
|
260
|
-
|
261
|
-
|
262
|
-
|
263
|
-
|
264
|
-
|
265
|
-
|
266
|
-
|
267
|
-
|
268
|
-
|
269
|
-
|
270
|
-
|
271
|
-
|
272
|
-
|
273
|
-
|
274
|
-
|
275
|
-
|
276
|
-
|
277
|
-
|
278
|
-
|
279
|
-
|
280
|
-
|
281
|
-
|
282
|
-
|
283
|
-
|
284
|
-
|
285
|
-
|
286
|
-
|
287
|
-
|
288
|
-
|
289
|
-
|
290
|
-
|
291
|
-
|
292
|
-
|
293
|
-
|
294
|
-
|
295
|
-
|
296
|
-
|
297
|
-
|
298
|
-
|
299
|
-
|
300
|
-
# another call. Can be: `true` or `false`.
|
301
|
-
# @param [String] page_token PageToken provided by the API
|
302
|
-
# @param [Integer] page_number Page Number, this value is simply for client state
|
303
|
-
# @param [Integer] page_size Number of records to return, defaults to 50
|
304
|
-
# @return [Page] Page of ParticipantInstance
|
305
|
-
def page(muted: :unset, hold: :unset, coaching: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
|
306
|
-
params = Twilio::Values.of({
|
307
|
-
'Muted' => muted,
|
308
|
-
'Hold' => hold,
|
309
|
-
'Coaching' => coaching,
|
310
|
-
'PageToken' => page_token,
|
311
|
-
'Page' => page_number,
|
312
|
-
'PageSize' => page_size,
|
313
|
-
})
|
314
|
-
|
315
|
-
response = @version.page('GET', @uri, params: params)
|
316
|
-
|
317
|
-
ParticipantPage.new(@version, response, @solution)
|
318
|
-
end
|
319
|
-
|
320
|
-
##
|
321
|
-
# Retrieve a single page of ParticipantInstance records from the API.
|
322
|
-
# Request is executed immediately.
|
323
|
-
# @param [String] target_url API-generated URL for the requested results page
|
324
|
-
# @return [Page] Page of ParticipantInstance
|
325
|
-
def get_page(target_url)
|
326
|
-
response = @version.domain.request(
|
327
|
-
'GET',
|
328
|
-
target_url
|
329
|
-
)
|
330
|
-
ParticipantPage.new(@version, response, @solution)
|
331
|
-
end
|
332
|
-
|
333
|
-
##
|
334
|
-
# Provide a user friendly representation
|
335
|
-
def to_s
|
336
|
-
'#<Twilio.Api.V2010.ParticipantList>'
|
337
|
-
end
|
338
|
-
end
|
17
|
+
module REST
|
18
|
+
class Api < ApiBase
|
19
|
+
class V2010 < Version
|
20
|
+
class AccountContext < InstanceContext
|
21
|
+
class ConferenceContext < InstanceContext
|
22
|
+
|
23
|
+
class ParticipantList < ListResource
|
24
|
+
##
|
25
|
+
# Initialize the ParticipantList
|
26
|
+
# @param [Version] version Version that contains the resource
|
27
|
+
# @return [ParticipantList] ParticipantList
|
28
|
+
def initialize(version, account_sid: nil, conference_sid: nil)
|
29
|
+
super(version)
|
30
|
+
# Path Solution
|
31
|
+
@solution = { account_sid: account_sid, conference_sid: conference_sid }
|
32
|
+
@uri = "/Accounts/#{@solution[:account_sid]}/Conferences/#{@solution[:conference_sid]}/Participants.json"
|
33
|
+
|
34
|
+
end
|
35
|
+
##
|
36
|
+
# Create the ParticipantInstance
|
37
|
+
# @param [String] from The phone number, Client identifier, or username portion of SIP address that made this call. Phone numbers are in [E.164](https://www.twilio.com/docs/glossary/what-e164) format (e.g., +16175551212). Client identifiers are formatted `client:name`. If using a phone number, it must be a Twilio number or a Verified [outgoing caller id](https://www.twilio.com/docs/voice/api/outgoing-caller-ids) for your account. If the `to` parameter is a phone number, `from` must also be a phone number. If `to` is sip address, this value of `from` should be a username portion to be used to populate the P-Asserted-Identity header that is passed to the SIP endpoint.
|
38
|
+
# @param [String] to The phone number, SIP address, or Client identifier that received this call. Phone numbers are in [E.164](https://www.twilio.com/docs/glossary/what-e164) format (e.g., +16175551212). SIP addresses are formatted as `sip:name@company.com`. Client identifiers are formatted `client:name`. [Custom parameters](https://www.twilio.com/docs/voice/api/conference-participant-resource#custom-parameters) may also be specified.
|
39
|
+
# @param [String] status_callback The URL we should call using the `status_callback_method` to send status information to your application.
|
40
|
+
# @param [String] status_callback_method The HTTP method we should use to call `status_callback`. Can be: `GET` and `POST` and defaults to `POST`.
|
41
|
+
# @param [Array[String]] status_callback_event The conference state changes that should generate a call to `status_callback`. Can be: `initiated`, `ringing`, `answered`, and `completed`. Separate multiple values with a space. The default value is `completed`.
|
42
|
+
# @param [String] label A label for this participant. If one is supplied, it may subsequently be used to fetch, update or delete the participant.
|
43
|
+
# @param [String] timeout The number of seconds that we should allow the phone to ring before assuming there is no answer. Can be an integer between `5` and `600`, inclusive. The default value is `60`. We always add a 5-second timeout buffer to outgoing calls, so value of 10 would result in an actual timeout that was closer to 15 seconds.
|
44
|
+
# @param [Boolean] record Whether to record the participant and their conferences, including the time between conferences. Can be `true` or `false` and the default is `false`.
|
45
|
+
# @param [Boolean] muted Whether the agent is muted in the conference. Can be `true` or `false` and the default is `false`.
|
46
|
+
# @param [String] beep Whether to play a notification beep to the conference when the participant joins. Can be: `true`, `false`, `onEnter`, or `onExit`. The default value is `true`.
|
47
|
+
# @param [Boolean] start_conference_on_enter Whether to start the conference when the participant joins, if it has not already started. Can be: `true` or `false` and the default is `true`. If `false` and the conference has not started, the participant is muted and hears background music until another participant starts the conference.
|
48
|
+
# @param [Boolean] end_conference_on_exit Whether to end the conference when the participant leaves. Can be: `true` or `false` and defaults to `false`.
|
49
|
+
# @param [String] wait_url The URL we should call using the `wait_method` for the music to play while participants are waiting for the conference to start. The default value is the URL of our standard hold music. [Learn more about hold music](https://www.twilio.com/labs/twimlets/holdmusic).
|
50
|
+
# @param [String] wait_method The HTTP method we should use to call `wait_url`. Can be `GET` or `POST` and the default is `POST`. When using a static audio file, this should be `GET` so that we can cache the file.
|
51
|
+
# @param [Boolean] early_media Whether to allow an agent to hear the state of the outbound call, including ringing or disconnect messages. Can be: `true` or `false` and defaults to `true`.
|
52
|
+
# @param [String] max_participants The maximum number of participants in the conference. Can be a positive integer from `2` to `250`. The default value is `250`.
|
53
|
+
# @param [String] conference_record Whether to record the conference the participant is joining. Can be: `true`, `false`, `record-from-start`, and `do-not-record`. The default value is `false`.
|
54
|
+
# @param [String] conference_trim Whether to trim leading and trailing silence from the conference recording. Can be: `trim-silence` or `do-not-trim` and defaults to `trim-silence`.
|
55
|
+
# @param [String] conference_status_callback The URL we should call using the `conference_status_callback_method` when the conference events in `conference_status_callback_event` occur. Only the value set by the first participant to join the conference is used. Subsequent `conference_status_callback` values are ignored.
|
56
|
+
# @param [String] conference_status_callback_method The HTTP method we should use to call `conference_status_callback`. Can be: `GET` or `POST` and defaults to `POST`.
|
57
|
+
# @param [Array[String]] conference_status_callback_event The conference state changes that should generate a call to `conference_status_callback`. Can be: `start`, `end`, `join`, `leave`, `mute`, `hold`, `modify`, `speaker`, and `announcement`. Separate multiple values with a space. Defaults to `start end`.
|
58
|
+
# @param [String] recording_channels The recording channels for the final recording. Can be: `mono` or `dual` and the default is `mono`.
|
59
|
+
# @param [String] recording_status_callback The URL that we should call using the `recording_status_callback_method` when the recording status changes.
|
60
|
+
# @param [String] recording_status_callback_method The HTTP method we should use when we call `recording_status_callback`. Can be: `GET` or `POST` and defaults to `POST`.
|
61
|
+
# @param [String] sip_auth_username The SIP username used for authentication.
|
62
|
+
# @param [String] sip_auth_password The SIP password for authentication.
|
63
|
+
# @param [String] region The [region](https://support.twilio.com/hc/en-us/articles/223132167-How-global-low-latency-routing-and-region-selection-work-for-conferences-and-Client-calls) where we should mix the recorded audio. Can be:`us1`, `ie1`, `de1`, `sg1`, `br1`, `au1`, or `jp1`.
|
64
|
+
# @param [String] conference_recording_status_callback The URL we should call using the `conference_recording_status_callback_method` when the conference recording is available.
|
65
|
+
# @param [String] conference_recording_status_callback_method The HTTP method we should use to call `conference_recording_status_callback`. Can be: `GET` or `POST` and defaults to `POST`.
|
66
|
+
# @param [Array[String]] recording_status_callback_event The recording state changes that should generate a call to `recording_status_callback`. Can be: `started`, `in-progress`, `paused`, `resumed`, `stopped`, `completed`, `failed`, and `absent`. Separate multiple values with a space, ex: `'in-progress completed failed'`.
|
67
|
+
# @param [Array[String]] conference_recording_status_callback_event The conference recording state changes that generate a call to `conference_recording_status_callback`. Can be: `in-progress`, `completed`, `failed`, and `absent`. Separate multiple values with a space, ex: `'in-progress completed failed'`
|
68
|
+
# @param [Boolean] coaching Whether the participant is coaching another call. Can be: `true` or `false`. If not present, defaults to `false` unless `call_sid_to_coach` is defined. If `true`, `call_sid_to_coach` must be defined.
|
69
|
+
# @param [String] call_sid_to_coach The SID of the participant who is being `coached`. The participant being coached is the only participant who can hear the participant who is `coaching`.
|
70
|
+
# @param [String] jitter_buffer_size Jitter buffer size for the connecting participant. Twilio will use this setting to apply Jitter Buffer before participant's audio is mixed into the conference. Can be: `off`, `small`, `medium`, and `large`. Default to `large`.
|
71
|
+
# @param [String] byoc The SID of a BYOC (Bring Your Own Carrier) trunk to route this call with. Note that `byoc` is only meaningful when `to` is a phone number; it will otherwise be ignored. (Beta)
|
72
|
+
# @param [String] caller_id The phone number, Client identifier, or username portion of SIP address that made this call. Phone numbers are in [E.164](https://www.twilio.com/docs/glossary/what-e164) format (e.g., +16175551212). Client identifiers are formatted `client:name`. If using a phone number, it must be a Twilio number or a Verified [outgoing caller id](https://www.twilio.com/docs/voice/api/outgoing-caller-ids) for your account. If the `to` parameter is a phone number, `callerId` must also be a phone number. If `to` is sip address, this value of `callerId` should be a username portion to be used to populate the From header that is passed to the SIP endpoint.
|
73
|
+
# @param [String] call_reason The Reason for the outgoing call. Use it to specify the purpose of the call that is presented on the called party's phone. (Branded Calls Beta)
|
74
|
+
# @param [String] recording_track The audio track to record for the call. Can be: `inbound`, `outbound` or `both`. The default is `both`. `inbound` records the audio that is received by Twilio. `outbound` records the audio that is sent from Twilio. `both` records the audio that is received and sent by Twilio.
|
75
|
+
# @param [String] time_limit The maximum duration of the call in seconds. Constraints depend on account and configuration.
|
76
|
+
# @param [String] machine_detection Whether to detect if a human, answering machine, or fax has picked up the call. Can be: `Enable` or `DetectMessageEnd`. Use `Enable` if you would like us to return `AnsweredBy` as soon as the called party is identified. Use `DetectMessageEnd`, if you would like to leave a message on an answering machine. For more information, see [Answering Machine Detection](https://www.twilio.com/docs/voice/answering-machine-detection).
|
77
|
+
# @param [String] machine_detection_timeout The number of seconds that we should attempt to detect an answering machine before timing out and sending a voice request with `AnsweredBy` of `unknown`. The default timeout is 30 seconds.
|
78
|
+
# @param [String] machine_detection_speech_threshold The number of milliseconds that is used as the measuring stick for the length of the speech activity, where durations lower than this value will be interpreted as a human and longer than this value as a machine. Possible Values: 1000-6000. Default: 2400.
|
79
|
+
# @param [String] machine_detection_speech_end_threshold The number of milliseconds of silence after speech activity at which point the speech activity is considered complete. Possible Values: 500-5000. Default: 1200.
|
80
|
+
# @param [String] machine_detection_silence_timeout The number of milliseconds of initial silence after which an `unknown` AnsweredBy result will be returned. Possible Values: 2000-10000. Default: 5000.
|
81
|
+
# @param [String] amd_status_callback The URL that we should call using the `amd_status_callback_method` to notify customer application whether the call was answered by human, machine or fax.
|
82
|
+
# @param [String] amd_status_callback_method The HTTP method we should use when calling the `amd_status_callback` URL. Can be: `GET` or `POST` and the default is `POST`.
|
83
|
+
# @param [String] trim Whether to trim any leading and trailing silence from the participant recording. Can be: `trim-silence` or `do-not-trim` and the default is `trim-silence`.
|
84
|
+
# @param [String] call_token A token string needed to invoke a forwarded call. A call_token is generated when an incoming call is received on a Twilio number. Pass an incoming call's call_token value to a forwarded call via the call_token parameter when creating a new call. A forwarded call should bear the same CallerID of the original incoming call.
|
85
|
+
# @return [ParticipantInstance] Created ParticipantInstance
|
86
|
+
def create(
|
87
|
+
from: nil,
|
88
|
+
to: nil,
|
89
|
+
status_callback: :unset,
|
90
|
+
status_callback_method: :unset,
|
91
|
+
status_callback_event: :unset,
|
92
|
+
label: :unset,
|
93
|
+
timeout: :unset,
|
94
|
+
record: :unset,
|
95
|
+
muted: :unset,
|
96
|
+
beep: :unset,
|
97
|
+
start_conference_on_enter: :unset,
|
98
|
+
end_conference_on_exit: :unset,
|
99
|
+
wait_url: :unset,
|
100
|
+
wait_method: :unset,
|
101
|
+
early_media: :unset,
|
102
|
+
max_participants: :unset,
|
103
|
+
conference_record: :unset,
|
104
|
+
conference_trim: :unset,
|
105
|
+
conference_status_callback: :unset,
|
106
|
+
conference_status_callback_method: :unset,
|
107
|
+
conference_status_callback_event: :unset,
|
108
|
+
recording_channels: :unset,
|
109
|
+
recording_status_callback: :unset,
|
110
|
+
recording_status_callback_method: :unset,
|
111
|
+
sip_auth_username: :unset,
|
112
|
+
sip_auth_password: :unset,
|
113
|
+
region: :unset,
|
114
|
+
conference_recording_status_callback: :unset,
|
115
|
+
conference_recording_status_callback_method: :unset,
|
116
|
+
recording_status_callback_event: :unset,
|
117
|
+
conference_recording_status_callback_event: :unset,
|
118
|
+
coaching: :unset,
|
119
|
+
call_sid_to_coach: :unset,
|
120
|
+
jitter_buffer_size: :unset,
|
121
|
+
byoc: :unset,
|
122
|
+
caller_id: :unset,
|
123
|
+
call_reason: :unset,
|
124
|
+
recording_track: :unset,
|
125
|
+
time_limit: :unset,
|
126
|
+
machine_detection: :unset,
|
127
|
+
machine_detection_timeout: :unset,
|
128
|
+
machine_detection_speech_threshold: :unset,
|
129
|
+
machine_detection_speech_end_threshold: :unset,
|
130
|
+
machine_detection_silence_timeout: :unset,
|
131
|
+
amd_status_callback: :unset,
|
132
|
+
amd_status_callback_method: :unset,
|
133
|
+
trim: :unset,
|
134
|
+
call_token: :unset
|
135
|
+
)
|
136
|
+
|
137
|
+
data = Twilio::Values.of({
|
138
|
+
'From' => from,
|
139
|
+
'To' => to,
|
140
|
+
'StatusCallback' => status_callback,
|
141
|
+
'StatusCallbackMethod' => status_callback_method,
|
142
|
+
'StatusCallbackEvent' => Twilio.serialize_list(status_callback_event) { |e| e },
|
143
|
+
'Label' => label,
|
144
|
+
'Timeout' => timeout,
|
145
|
+
'Record' => record,
|
146
|
+
'Muted' => muted,
|
147
|
+
'Beep' => beep,
|
148
|
+
'StartConferenceOnEnter' => start_conference_on_enter,
|
149
|
+
'EndConferenceOnExit' => end_conference_on_exit,
|
150
|
+
'WaitUrl' => wait_url,
|
151
|
+
'WaitMethod' => wait_method,
|
152
|
+
'EarlyMedia' => early_media,
|
153
|
+
'MaxParticipants' => max_participants,
|
154
|
+
'ConferenceRecord' => conference_record,
|
155
|
+
'ConferenceTrim' => conference_trim,
|
156
|
+
'ConferenceStatusCallback' => conference_status_callback,
|
157
|
+
'ConferenceStatusCallbackMethod' => conference_status_callback_method,
|
158
|
+
'ConferenceStatusCallbackEvent' => Twilio.serialize_list(conference_status_callback_event) { |e| e },
|
159
|
+
'RecordingChannels' => recording_channels,
|
160
|
+
'RecordingStatusCallback' => recording_status_callback,
|
161
|
+
'RecordingStatusCallbackMethod' => recording_status_callback_method,
|
162
|
+
'SipAuthUsername' => sip_auth_username,
|
163
|
+
'SipAuthPassword' => sip_auth_password,
|
164
|
+
'Region' => region,
|
165
|
+
'ConferenceRecordingStatusCallback' => conference_recording_status_callback,
|
166
|
+
'ConferenceRecordingStatusCallbackMethod' => conference_recording_status_callback_method,
|
167
|
+
'RecordingStatusCallbackEvent' => Twilio.serialize_list(recording_status_callback_event) { |e| e },
|
168
|
+
'ConferenceRecordingStatusCallbackEvent' => Twilio.serialize_list(conference_recording_status_callback_event) { |e| e },
|
169
|
+
'Coaching' => coaching,
|
170
|
+
'CallSidToCoach' => call_sid_to_coach,
|
171
|
+
'JitterBufferSize' => jitter_buffer_size,
|
172
|
+
'Byoc' => byoc,
|
173
|
+
'CallerId' => caller_id,
|
174
|
+
'CallReason' => call_reason,
|
175
|
+
'RecordingTrack' => recording_track,
|
176
|
+
'TimeLimit' => time_limit,
|
177
|
+
'MachineDetection' => machine_detection,
|
178
|
+
'MachineDetectionTimeout' => machine_detection_timeout,
|
179
|
+
'MachineDetectionSpeechThreshold' => machine_detection_speech_threshold,
|
180
|
+
'MachineDetectionSpeechEndThreshold' => machine_detection_speech_end_threshold,
|
181
|
+
'MachineDetectionSilenceTimeout' => machine_detection_silence_timeout,
|
182
|
+
'AmdStatusCallback' => amd_status_callback,
|
183
|
+
'AmdStatusCallbackMethod' => amd_status_callback_method,
|
184
|
+
'Trim' => trim,
|
185
|
+
'CallToken' => call_token,
|
186
|
+
})
|
187
|
+
|
188
|
+
payload = @version.create('POST', @uri, data: data)
|
189
|
+
ParticipantInstance.new(
|
190
|
+
@version,
|
191
|
+
payload,
|
192
|
+
account_sid: @solution[:account_sid],
|
193
|
+
conference_sid: @solution[:conference_sid],
|
194
|
+
)
|
195
|
+
end
|
196
|
+
|
197
|
+
|
198
|
+
##
|
199
|
+
# Lists ParticipantInstance records from the API as a list.
|
200
|
+
# Unlike stream(), this operation is eager and will load `limit` records into
|
201
|
+
# memory before returning.
|
202
|
+
# @param [Boolean] muted Whether to return only participants that are muted. Can be: `true` or `false`.
|
203
|
+
# @param [Boolean] hold Whether to return only participants that are on hold. Can be: `true` or `false`.
|
204
|
+
# @param [Boolean] coaching Whether to return only participants who are coaching another call. Can be: `true` or `false`.
|
205
|
+
# @param [Integer] limit Upper limit for the number of records to return. stream()
|
206
|
+
# guarantees to never return more than limit. Default is no limit
|
207
|
+
# @param [Integer] page_size Number of records to fetch per request, when
|
208
|
+
# not set will use the default value of 50 records. If no page_size is defined
|
209
|
+
# but a limit is defined, stream() will attempt to read the limit with the most
|
210
|
+
# efficient page size, i.e. min(limit, 1000)
|
211
|
+
# @return [Array] Array of up to limit results
|
212
|
+
def list(muted: :unset, hold: :unset, coaching: :unset, limit: nil, page_size: nil)
|
213
|
+
self.stream(
|
214
|
+
muted: muted,
|
215
|
+
hold: hold,
|
216
|
+
coaching: coaching,
|
217
|
+
limit: limit,
|
218
|
+
page_size: page_size
|
219
|
+
).entries
|
220
|
+
end
|
221
|
+
|
222
|
+
##
|
223
|
+
# Streams Instance records from the API as an Enumerable.
|
224
|
+
# This operation lazily loads records as efficiently as possible until the limit
|
225
|
+
# is reached.
|
226
|
+
# @param [Boolean] muted Whether to return only participants that are muted. Can be: `true` or `false`.
|
227
|
+
# @param [Boolean] hold Whether to return only participants that are on hold. Can be: `true` or `false`.
|
228
|
+
# @param [Boolean] coaching Whether to return only participants who are coaching another call. Can be: `true` or `false`.
|
229
|
+
# @param [Integer] limit Upper limit for the number of records to return. stream()
|
230
|
+
# guarantees to never return more than limit. Default is no limit
|
231
|
+
# @param [Integer] page_size Number of records to fetch per request, when
|
232
|
+
# not set will use the default value of 50 records. If no page_size is defined
|
233
|
+
# but a limit is defined, stream() will attempt to read the limit with the most
|
234
|
+
# efficient page size, i.e. min(limit, 1000)
|
235
|
+
# @return [Enumerable] Enumerable that will yield up to limit results
|
236
|
+
def stream(muted: :unset, hold: :unset, coaching: :unset, limit: nil, page_size: nil)
|
237
|
+
limits = @version.read_limits(limit, page_size)
|
238
|
+
|
239
|
+
page = self.page(
|
240
|
+
muted: muted,
|
241
|
+
hold: hold,
|
242
|
+
coaching: coaching,
|
243
|
+
page_size: limits[:page_size], )
|
244
|
+
|
245
|
+
@version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
|
246
|
+
end
|
247
|
+
|
248
|
+
##
|
249
|
+
# When passed a block, yields ParticipantInstance records from the API.
|
250
|
+
# This operation lazily loads records as efficiently as possible until the limit
|
251
|
+
# is reached.
|
252
|
+
def each
|
253
|
+
limits = @version.read_limits
|
254
|
+
|
255
|
+
page = self.page(page_size: limits[:page_size], )
|
256
|
+
|
257
|
+
@version.stream(page,
|
258
|
+
limit: limits[:limit],
|
259
|
+
page_limit: limits[:page_limit]).each {|x| yield x}
|
260
|
+
end
|
261
|
+
|
262
|
+
##
|
263
|
+
# Retrieve a single page of ParticipantInstance records from the API.
|
264
|
+
# Request is executed immediately.
|
265
|
+
# @param [Boolean] muted Whether to return only participants that are muted. Can be: `true` or `false`.
|
266
|
+
# @param [Boolean] hold Whether to return only participants that are on hold. Can be: `true` or `false`.
|
267
|
+
# @param [Boolean] coaching Whether to return only participants who are coaching another call. Can be: `true` or `false`.
|
268
|
+
# @param [String] page_token PageToken provided by the API
|
269
|
+
# @param [Integer] page_number Page Number, this value is simply for client state
|
270
|
+
# @param [Integer] page_size Number of records to return, defaults to 50
|
271
|
+
# @return [Page] Page of ParticipantInstance
|
272
|
+
def page(muted: :unset, hold: :unset, coaching: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
|
273
|
+
params = Twilio::Values.of({
|
274
|
+
'Muted' => muted,
|
275
|
+
'Hold' => hold,
|
276
|
+
'Coaching' => coaching,
|
277
|
+
'PageToken' => page_token,
|
278
|
+
'Page' => page_number,
|
279
|
+
'PageSize' => page_size,
|
280
|
+
})
|
281
|
+
|
282
|
+
response = @version.page('GET', @uri, params: params)
|
283
|
+
|
284
|
+
ParticipantPage.new(@version, response, @solution)
|
285
|
+
end
|
286
|
+
|
287
|
+
##
|
288
|
+
# Retrieve a single page of ParticipantInstance records from the API.
|
289
|
+
# Request is executed immediately.
|
290
|
+
# @param [String] target_url API-generated URL for the requested results page
|
291
|
+
# @return [Page] Page of ParticipantInstance
|
292
|
+
def get_page(target_url)
|
293
|
+
response = @version.domain.request(
|
294
|
+
'GET',
|
295
|
+
target_url
|
296
|
+
)
|
297
|
+
ParticipantPage.new(@version, response, @solution)
|
298
|
+
end
|
299
|
+
|
300
|
+
|
301
|
+
|
302
|
+
# Provide a user friendly representation
|
303
|
+
def to_s
|
304
|
+
'#<Twilio.Api.V2010.ParticipantList>'
|
305
|
+
end
|
306
|
+
end
|
339
307
|
|
340
|
-
class ParticipantPage < Page
|
341
|
-
##
|
342
|
-
# Initialize the ParticipantPage
|
343
|
-
# @param [Version] version Version that contains the resource
|
344
|
-
# @param [Response] response Response from the API
|
345
|
-
# @param [Hash] solution Path solution for the resource
|
346
|
-
# @return [ParticipantPage] ParticipantPage
|
347
|
-
def initialize(version, response, solution)
|
348
|
-
super(version, response)
|
349
|
-
|
350
|
-
# Path Solution
|
351
|
-
@solution = solution
|
352
|
-
end
|
353
|
-
|
354
|
-
##
|
355
|
-
# Build an instance of ParticipantInstance
|
356
|
-
# @param [Hash] payload Payload response from the API
|
357
|
-
# @return [ParticipantInstance] ParticipantInstance
|
358
|
-
def get_instance(payload)
|
359
|
-
ParticipantInstance.new(
|
360
|
-
@version,
|
361
|
-
payload,
|
362
|
-
account_sid: @solution[:account_sid],
|
363
|
-
conference_sid: @solution[:conference_sid],
|
364
|
-
)
|
365
|
-
end
|
366
|
-
|
367
|
-
##
|
368
|
-
# Provide a user friendly representation
|
369
|
-
def to_s
|
370
|
-
'<Twilio.Api.V2010.ParticipantPage>'
|
371
|
-
end
|
372
|
-
end
|
373
308
|
|
374
|
-
|
375
|
-
|
376
|
-
|
377
|
-
|
378
|
-
|
379
|
-
|
380
|
-
|
381
|
-
|
382
|
-
|
383
|
-
|
384
|
-
|
385
|
-
|
386
|
-
|
387
|
-
|
388
|
-
|
389
|
-
|
390
|
-
|
391
|
-
|
392
|
-
|
393
|
-
|
394
|
-
|
395
|
-
|
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
|
-
|
430
|
-
|
431
|
-
|
432
|
-
|
433
|
-
|
434
|
-
|
435
|
-
|
436
|
-
|
437
|
-
|
438
|
-
|
439
|
-
|
440
|
-
|
441
|
-
|
442
|
-
|
443
|
-
|
444
|
-
|
445
|
-
|
446
|
-
|
447
|
-
|
448
|
-
|
449
|
-
|
450
|
-
|
451
|
-
|
452
|
-
|
453
|
-
|
454
|
-
|
455
|
-
|
456
|
-
|
457
|
-
|
458
|
-
|
459
|
-
|
460
|
-
|
461
|
-
|
462
|
-
|
463
|
-
|
464
|
-
|
465
|
-
|
466
|
-
|
467
|
-
|
468
|
-
|
469
|
-
|
470
|
-
|
471
|
-
|
472
|
-
|
473
|
-
|
474
|
-
|
475
|
-
|
476
|
-
|
477
|
-
|
478
|
-
|
479
|
-
|
480
|
-
|
481
|
-
|
482
|
-
|
483
|
-
|
484
|
-
def to_s
|
485
|
-
context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
|
486
|
-
"#<Twilio.Api.V2010.ParticipantContext #{context}>"
|
487
|
-
end
|
488
|
-
|
489
|
-
##
|
490
|
-
# Provide a detailed, user friendly representation
|
491
|
-
def inspect
|
492
|
-
context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
|
493
|
-
"#<Twilio.Api.V2010.ParticipantContext #{context}>"
|
494
|
-
end
|
495
|
-
end
|
309
|
+
class ParticipantContext < InstanceContext
|
310
|
+
##
|
311
|
+
# Initialize the ParticipantContext
|
312
|
+
# @param [Version] version Version that contains the resource
|
313
|
+
# @param [String] account_sid The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Participant resources to update.
|
314
|
+
# @param [String] conference_sid The SID of the conference with the participant to update.
|
315
|
+
# @param [String] call_sid The [Call](https://www.twilio.com/docs/voice/api/call-resource) SID or label of the participant to update. Non URL safe characters in a label must be percent encoded, for example, a space character is represented as %20.
|
316
|
+
# @return [ParticipantContext] ParticipantContext
|
317
|
+
def initialize(version, account_sid, conference_sid, call_sid)
|
318
|
+
super(version)
|
319
|
+
|
320
|
+
# Path Solution
|
321
|
+
@solution = { account_sid: account_sid, conference_sid: conference_sid, call_sid: call_sid, }
|
322
|
+
@uri = "/Accounts/#{@solution[:account_sid]}/Conferences/#{@solution[:conference_sid]}/Participants/#{@solution[:call_sid]}.json"
|
323
|
+
|
324
|
+
|
325
|
+
end
|
326
|
+
##
|
327
|
+
# Delete the ParticipantInstance
|
328
|
+
# @return [Boolean] True if delete succeeds, false otherwise
|
329
|
+
def delete
|
330
|
+
|
331
|
+
@version.delete('DELETE', @uri)
|
332
|
+
end
|
333
|
+
|
334
|
+
##
|
335
|
+
# Fetch the ParticipantInstance
|
336
|
+
# @return [ParticipantInstance] Fetched ParticipantInstance
|
337
|
+
def fetch
|
338
|
+
|
339
|
+
payload = @version.fetch('GET', @uri)
|
340
|
+
ParticipantInstance.new(
|
341
|
+
@version,
|
342
|
+
payload,
|
343
|
+
account_sid: @solution[:account_sid],
|
344
|
+
conference_sid: @solution[:conference_sid],
|
345
|
+
call_sid: @solution[:call_sid],
|
346
|
+
)
|
347
|
+
end
|
348
|
+
|
349
|
+
##
|
350
|
+
# Update the ParticipantInstance
|
351
|
+
# @param [Boolean] muted Whether the participant should be muted. Can be `true` or `false`. `true` will mute the participant, and `false` will un-mute them. Anything value other than `true` or `false` is interpreted as `false`.
|
352
|
+
# @param [Boolean] hold Whether the participant should be on hold. Can be: `true` or `false`. `true` puts the participant on hold, and `false` lets them rejoin the conference.
|
353
|
+
# @param [String] hold_url The URL we call using the `hold_method` for music that plays when the participant is on hold. The URL may return an MP3 file, a WAV file, or a TwiML document that contains `<Play>`, `<Say>`, `<Pause>`, or `<Redirect>` verbs.
|
354
|
+
# @param [String] hold_method The HTTP method we should use to call `hold_url`. Can be: `GET` or `POST` and the default is `GET`.
|
355
|
+
# @param [String] announce_url The URL we call using the `announce_method` for an announcement to the participant. The URL may return an MP3 file, a WAV file, or a TwiML document that contains `<Play>`, `<Say>`, `<Pause>`, or `<Redirect>` verbs.
|
356
|
+
# @param [String] announce_method The HTTP method we should use to call `announce_url`. Can be: `GET` or `POST` and defaults to `POST`.
|
357
|
+
# @param [String] wait_url The URL we call using the `wait_method` for the music to play while participants are waiting for the conference to start. The URL may return an MP3 file, a WAV file, or a TwiML document that contains `<Play>`, `<Say>`, `<Pause>`, or `<Redirect>` verbs. The default value is the URL of our standard hold music. [Learn more about hold music](https://www.twilio.com/labs/twimlets/holdmusic).
|
358
|
+
# @param [String] wait_method The HTTP method we should use to call `wait_url`. Can be `GET` or `POST` and the default is `POST`. When using a static audio file, this should be `GET` so that we can cache the file.
|
359
|
+
# @param [Boolean] beep_on_exit Whether to play a notification beep to the conference when the participant exits. Can be: `true` or `false`.
|
360
|
+
# @param [Boolean] end_conference_on_exit Whether to end the conference when the participant leaves. Can be: `true` or `false` and defaults to `false`.
|
361
|
+
# @param [Boolean] coaching Whether the participant is coaching another call. Can be: `true` or `false`. If not present, defaults to `false` unless `call_sid_to_coach` is defined. If `true`, `call_sid_to_coach` must be defined.
|
362
|
+
# @param [String] call_sid_to_coach The SID of the participant who is being `coached`. The participant being coached is the only participant who can hear the participant who is `coaching`.
|
363
|
+
# @return [ParticipantInstance] Updated ParticipantInstance
|
364
|
+
def update(
|
365
|
+
muted: :unset,
|
366
|
+
hold: :unset,
|
367
|
+
hold_url: :unset,
|
368
|
+
hold_method: :unset,
|
369
|
+
announce_url: :unset,
|
370
|
+
announce_method: :unset,
|
371
|
+
wait_url: :unset,
|
372
|
+
wait_method: :unset,
|
373
|
+
beep_on_exit: :unset,
|
374
|
+
end_conference_on_exit: :unset,
|
375
|
+
coaching: :unset,
|
376
|
+
call_sid_to_coach: :unset
|
377
|
+
)
|
378
|
+
|
379
|
+
data = Twilio::Values.of({
|
380
|
+
'Muted' => muted,
|
381
|
+
'Hold' => hold,
|
382
|
+
'HoldUrl' => hold_url,
|
383
|
+
'HoldMethod' => hold_method,
|
384
|
+
'AnnounceUrl' => announce_url,
|
385
|
+
'AnnounceMethod' => announce_method,
|
386
|
+
'WaitUrl' => wait_url,
|
387
|
+
'WaitMethod' => wait_method,
|
388
|
+
'BeepOnExit' => beep_on_exit,
|
389
|
+
'EndConferenceOnExit' => end_conference_on_exit,
|
390
|
+
'Coaching' => coaching,
|
391
|
+
'CallSidToCoach' => call_sid_to_coach,
|
392
|
+
})
|
393
|
+
|
394
|
+
payload = @version.update('POST', @uri, data: data)
|
395
|
+
ParticipantInstance.new(
|
396
|
+
@version,
|
397
|
+
payload,
|
398
|
+
account_sid: @solution[:account_sid],
|
399
|
+
conference_sid: @solution[:conference_sid],
|
400
|
+
call_sid: @solution[:call_sid],
|
401
|
+
)
|
402
|
+
end
|
403
|
+
|
404
|
+
|
405
|
+
##
|
406
|
+
# Provide a user friendly representation
|
407
|
+
def to_s
|
408
|
+
context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
|
409
|
+
"#<Twilio.Api.V2010.ParticipantContext #{context}>"
|
410
|
+
end
|
411
|
+
|
412
|
+
##
|
413
|
+
# Provide a detailed, user friendly representation
|
414
|
+
def inspect
|
415
|
+
context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
|
416
|
+
"#<Twilio.Api.V2010.ParticipantContext #{context}>"
|
417
|
+
end
|
418
|
+
end
|
496
419
|
|
497
|
-
|
498
|
-
|
499
|
-
|
500
|
-
|
501
|
-
|
502
|
-
|
503
|
-
|
504
|
-
|
505
|
-
|
506
|
-
|
507
|
-
|
508
|
-
|
509
|
-
|
510
|
-
|
511
|
-
|
512
|
-
|
513
|
-
|
514
|
-
|
515
|
-
|
516
|
-
|
517
|
-
|
518
|
-
|
519
|
-
|
520
|
-
|
521
|
-
|
522
|
-
|
523
|
-
|
524
|
-
|
525
|
-
|
526
|
-
|
527
|
-
|
528
|
-
|
529
|
-
|
530
|
-
|
531
|
-
|
532
|
-
|
533
|
-
|
534
|
-
|
535
|
-
|
536
|
-
|
537
|
-
|
538
|
-
|
539
|
-
|
540
|
-
|
541
|
-
|
542
|
-
|
543
|
-
|
544
|
-
|
545
|
-
|
546
|
-
|
547
|
-
|
548
|
-
|
549
|
-
|
550
|
-
|
551
|
-
|
552
|
-
|
420
|
+
class ParticipantPage < Page
|
421
|
+
##
|
422
|
+
# Initialize the ParticipantPage
|
423
|
+
# @param [Version] version Version that contains the resource
|
424
|
+
# @param [Response] response Response from the API
|
425
|
+
# @param [Hash] solution Path solution for the resource
|
426
|
+
# @return [ParticipantPage] ParticipantPage
|
427
|
+
def initialize(version, response, solution)
|
428
|
+
super(version, response)
|
429
|
+
|
430
|
+
# Path Solution
|
431
|
+
@solution = solution
|
432
|
+
end
|
433
|
+
|
434
|
+
##
|
435
|
+
# Build an instance of ParticipantInstance
|
436
|
+
# @param [Hash] payload Payload response from the API
|
437
|
+
# @return [ParticipantInstance] ParticipantInstance
|
438
|
+
def get_instance(payload)
|
439
|
+
ParticipantInstance.new(@version, payload, account_sid: @solution[:account_sid], conference_sid: @solution[:conference_sid])
|
440
|
+
end
|
441
|
+
|
442
|
+
##
|
443
|
+
# Provide a user friendly representation
|
444
|
+
def to_s
|
445
|
+
'<Twilio.Api.V2010.ParticipantPage>'
|
446
|
+
end
|
447
|
+
end
|
448
|
+
class ParticipantInstance < InstanceResource
|
449
|
+
##
|
450
|
+
# Initialize the ParticipantInstance
|
451
|
+
# @param [Version] version Version that contains the resource
|
452
|
+
# @param [Hash] payload payload that contains response from Twilio
|
453
|
+
# @param [String] account_sid The SID of the
|
454
|
+
# {Account}[https://www.twilio.com/docs/iam/api/account] that created this Participant
|
455
|
+
# resource.
|
456
|
+
# @param [String] sid The SID of the Call resource to fetch.
|
457
|
+
# @return [ParticipantInstance] ParticipantInstance
|
458
|
+
def initialize(version, payload , account_sid: nil, conference_sid: nil, call_sid: nil)
|
459
|
+
super(version)
|
460
|
+
|
461
|
+
# Marshaled Properties
|
462
|
+
@properties = {
|
463
|
+
'account_sid' => payload['account_sid'],
|
464
|
+
'call_sid' => payload['call_sid'],
|
465
|
+
'label' => payload['label'],
|
466
|
+
'call_sid_to_coach' => payload['call_sid_to_coach'],
|
467
|
+
'coaching' => payload['coaching'],
|
468
|
+
'conference_sid' => payload['conference_sid'],
|
469
|
+
'date_created' => Twilio.deserialize_rfc2822(payload['date_created']),
|
470
|
+
'date_updated' => Twilio.deserialize_rfc2822(payload['date_updated']),
|
471
|
+
'end_conference_on_exit' => payload['end_conference_on_exit'],
|
472
|
+
'muted' => payload['muted'],
|
473
|
+
'hold' => payload['hold'],
|
474
|
+
'start_conference_on_enter' => payload['start_conference_on_enter'],
|
475
|
+
'status' => payload['status'],
|
476
|
+
'uri' => payload['uri'],
|
477
|
+
}
|
478
|
+
|
479
|
+
# Context
|
480
|
+
@instance_context = nil
|
481
|
+
@params = { 'account_sid' => account_sid ,'conference_sid' => conference_sid || @properties['conference_sid'] ,'call_sid' => call_sid || @properties['call_sid'] , }
|
482
|
+
end
|
483
|
+
|
484
|
+
##
|
485
|
+
# Generate an instance context for the instance, the context is capable of
|
486
|
+
# performing various actions. All instance actions are proxied to the context
|
487
|
+
# @return [ParticipantContext] CallContext for this CallInstance
|
488
|
+
def context
|
489
|
+
unless @instance_context
|
490
|
+
@instance_context = ParticipantContext.new(@version , @params['account_sid'], @params['conference_sid'], @params['call_sid'])
|
491
|
+
end
|
492
|
+
@instance_context
|
493
|
+
end
|
494
|
+
|
495
|
+
##
|
496
|
+
# @return [String] The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Participant resource.
|
497
|
+
def account_sid
|
498
|
+
@properties['account_sid']
|
499
|
+
end
|
500
|
+
|
501
|
+
##
|
502
|
+
# @return [String] The SID of the [Call](https://www.twilio.com/docs/voice/api/call-resource) the Participant resource is associated with.
|
503
|
+
def call_sid
|
504
|
+
@properties['call_sid']
|
505
|
+
end
|
506
|
+
|
507
|
+
##
|
508
|
+
# @return [String] The user-specified label of this participant, if one was given when the participant was created. This may be used to fetch, update or delete the participant.
|
509
|
+
def label
|
510
|
+
@properties['label']
|
511
|
+
end
|
512
|
+
|
513
|
+
##
|
514
|
+
# @return [String] The SID of the participant who is being `coached`. The participant being coached is the only participant who can hear the participant who is `coaching`.
|
515
|
+
def call_sid_to_coach
|
516
|
+
@properties['call_sid_to_coach']
|
517
|
+
end
|
518
|
+
|
519
|
+
##
|
520
|
+
# @return [Boolean] Whether the participant is coaching another call. Can be: `true` or `false`. If not present, defaults to `false` unless `call_sid_to_coach` is defined. If `true`, `call_sid_to_coach` must be defined.
|
521
|
+
def coaching
|
522
|
+
@properties['coaching']
|
523
|
+
end
|
524
|
+
|
525
|
+
##
|
526
|
+
# @return [String] The SID of the conference the participant is in.
|
527
|
+
def conference_sid
|
528
|
+
@properties['conference_sid']
|
529
|
+
end
|
530
|
+
|
531
|
+
##
|
532
|
+
# @return [Time] The date and time in GMT that the resource was created specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format.
|
533
|
+
def date_created
|
534
|
+
@properties['date_created']
|
535
|
+
end
|
536
|
+
|
537
|
+
##
|
538
|
+
# @return [Time] The date and time in GMT that the resource was last updated specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format.
|
539
|
+
def date_updated
|
540
|
+
@properties['date_updated']
|
541
|
+
end
|
542
|
+
|
543
|
+
##
|
544
|
+
# @return [Boolean] Whether the conference ends when the participant leaves. Can be: `true` or `false` and the default is `false`. If `true`, the conference ends and all other participants drop out when the participant leaves.
|
545
|
+
def end_conference_on_exit
|
546
|
+
@properties['end_conference_on_exit']
|
547
|
+
end
|
548
|
+
|
549
|
+
##
|
550
|
+
# @return [Boolean] Whether the participant is muted. Can be `true` or `false`.
|
551
|
+
def muted
|
552
|
+
@properties['muted']
|
553
|
+
end
|
554
|
+
|
555
|
+
##
|
556
|
+
# @return [Boolean] Whether the participant is on hold. Can be `true` or `false`.
|
557
|
+
def hold
|
558
|
+
@properties['hold']
|
559
|
+
end
|
560
|
+
|
561
|
+
##
|
562
|
+
# @return [Boolean] Whether the conference starts when the participant joins the conference, if it has not already started. Can be: `true` or `false` and the default is `true`. If `false` and the conference has not started, the participant is muted and hears background music until another participant starts the conference.
|
563
|
+
def start_conference_on_enter
|
564
|
+
@properties['start_conference_on_enter']
|
565
|
+
end
|
566
|
+
|
567
|
+
##
|
568
|
+
# @return [Status]
|
569
|
+
def status
|
570
|
+
@properties['status']
|
571
|
+
end
|
572
|
+
|
573
|
+
##
|
574
|
+
# @return [String] The URI of the resource, relative to `https://api.twilio.com`.
|
575
|
+
def uri
|
576
|
+
@properties['uri']
|
577
|
+
end
|
578
|
+
|
579
|
+
##
|
580
|
+
# Delete the ParticipantInstance
|
581
|
+
# @return [Boolean] True if delete succeeds, false otherwise
|
582
|
+
def delete
|
583
|
+
|
584
|
+
context.delete
|
585
|
+
end
|
586
|
+
|
587
|
+
##
|
588
|
+
# Fetch the ParticipantInstance
|
589
|
+
# @return [ParticipantInstance] Fetched ParticipantInstance
|
590
|
+
def fetch
|
591
|
+
|
592
|
+
context.fetch
|
593
|
+
end
|
594
|
+
|
595
|
+
##
|
596
|
+
# Update the ParticipantInstance
|
597
|
+
# @param [Boolean] muted Whether the participant should be muted. Can be `true` or `false`. `true` will mute the participant, and `false` will un-mute them. Anything value other than `true` or `false` is interpreted as `false`.
|
598
|
+
# @param [Boolean] hold Whether the participant should be on hold. Can be: `true` or `false`. `true` puts the participant on hold, and `false` lets them rejoin the conference.
|
599
|
+
# @param [String] hold_url The URL we call using the `hold_method` for music that plays when the participant is on hold. The URL may return an MP3 file, a WAV file, or a TwiML document that contains `<Play>`, `<Say>`, `<Pause>`, or `<Redirect>` verbs.
|
600
|
+
# @param [String] hold_method The HTTP method we should use to call `hold_url`. Can be: `GET` or `POST` and the default is `GET`.
|
601
|
+
# @param [String] announce_url The URL we call using the `announce_method` for an announcement to the participant. The URL may return an MP3 file, a WAV file, or a TwiML document that contains `<Play>`, `<Say>`, `<Pause>`, or `<Redirect>` verbs.
|
602
|
+
# @param [String] announce_method The HTTP method we should use to call `announce_url`. Can be: `GET` or `POST` and defaults to `POST`.
|
603
|
+
# @param [String] wait_url The URL we call using the `wait_method` for the music to play while participants are waiting for the conference to start. The URL may return an MP3 file, a WAV file, or a TwiML document that contains `<Play>`, `<Say>`, `<Pause>`, or `<Redirect>` verbs. The default value is the URL of our standard hold music. [Learn more about hold music](https://www.twilio.com/labs/twimlets/holdmusic).
|
604
|
+
# @param [String] wait_method The HTTP method we should use to call `wait_url`. Can be `GET` or `POST` and the default is `POST`. When using a static audio file, this should be `GET` so that we can cache the file.
|
605
|
+
# @param [Boolean] beep_on_exit Whether to play a notification beep to the conference when the participant exits. Can be: `true` or `false`.
|
606
|
+
# @param [Boolean] end_conference_on_exit Whether to end the conference when the participant leaves. Can be: `true` or `false` and defaults to `false`.
|
607
|
+
# @param [Boolean] coaching Whether the participant is coaching another call. Can be: `true` or `false`. If not present, defaults to `false` unless `call_sid_to_coach` is defined. If `true`, `call_sid_to_coach` must be defined.
|
608
|
+
# @param [String] call_sid_to_coach The SID of the participant who is being `coached`. The participant being coached is the only participant who can hear the participant who is `coaching`.
|
609
|
+
# @return [ParticipantInstance] Updated ParticipantInstance
|
610
|
+
def update(
|
611
|
+
muted: :unset,
|
612
|
+
hold: :unset,
|
613
|
+
hold_url: :unset,
|
614
|
+
hold_method: :unset,
|
615
|
+
announce_url: :unset,
|
616
|
+
announce_method: :unset,
|
617
|
+
wait_url: :unset,
|
618
|
+
wait_method: :unset,
|
619
|
+
beep_on_exit: :unset,
|
620
|
+
end_conference_on_exit: :unset,
|
621
|
+
coaching: :unset,
|
622
|
+
call_sid_to_coach: :unset
|
623
|
+
)
|
624
|
+
|
625
|
+
context.update(
|
626
|
+
muted: muted,
|
627
|
+
hold: hold,
|
628
|
+
hold_url: hold_url,
|
629
|
+
hold_method: hold_method,
|
630
|
+
announce_url: announce_url,
|
631
|
+
announce_method: announce_method,
|
632
|
+
wait_url: wait_url,
|
633
|
+
wait_method: wait_method,
|
634
|
+
beep_on_exit: beep_on_exit,
|
635
|
+
end_conference_on_exit: end_conference_on_exit,
|
636
|
+
coaching: coaching,
|
637
|
+
call_sid_to_coach: call_sid_to_coach,
|
638
|
+
)
|
639
|
+
end
|
640
|
+
|
641
|
+
##
|
642
|
+
# Provide a user friendly representation
|
643
|
+
def to_s
|
644
|
+
values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
|
645
|
+
"<Twilio.Api.V2010.ParticipantInstance #{values}>"
|
646
|
+
end
|
647
|
+
|
648
|
+
##
|
649
|
+
# Provide a detailed, user friendly representation
|
650
|
+
def inspect
|
651
|
+
values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
|
652
|
+
"<Twilio.Api.V2010.ParticipantInstance #{values}>"
|
653
|
+
end
|
553
654
|
end
|
554
|
-
|
555
|
-
|
556
|
-
|
557
|
-
##
|
558
|
-
# @return [String] The SID of the Account that created the resource
|
559
|
-
def account_sid
|
560
|
-
@properties['account_sid']
|
561
|
-
end
|
562
|
-
|
563
|
-
##
|
564
|
-
# @return [String] The SID of the Call the resource is associated with
|
565
|
-
def call_sid
|
566
|
-
@properties['call_sid']
|
567
|
-
end
|
568
|
-
|
569
|
-
##
|
570
|
-
# @return [String] The label of this participant
|
571
|
-
def label
|
572
|
-
@properties['label']
|
573
|
-
end
|
574
|
-
|
575
|
-
##
|
576
|
-
# @return [String] The SID of the participant who is being `coached`
|
577
|
-
def call_sid_to_coach
|
578
|
-
@properties['call_sid_to_coach']
|
579
|
-
end
|
580
|
-
|
581
|
-
##
|
582
|
-
# @return [Boolean] Indicates if the participant changed to coach
|
583
|
-
def coaching
|
584
|
-
@properties['coaching']
|
585
|
-
end
|
586
|
-
|
587
|
-
##
|
588
|
-
# @return [String] The SID of the conference the participant is in
|
589
|
-
def conference_sid
|
590
|
-
@properties['conference_sid']
|
591
|
-
end
|
592
|
-
|
593
|
-
##
|
594
|
-
# @return [Time] The RFC 2822 date and time in GMT that the resource was created
|
595
|
-
def date_created
|
596
|
-
@properties['date_created']
|
597
|
-
end
|
598
|
-
|
599
|
-
##
|
600
|
-
# @return [Time] The RFC 2822 date and time in GMT that the resource was last updated
|
601
|
-
def date_updated
|
602
|
-
@properties['date_updated']
|
603
|
-
end
|
604
|
-
|
605
|
-
##
|
606
|
-
# @return [Boolean] Whether the conference ends when the participant leaves
|
607
|
-
def end_conference_on_exit
|
608
|
-
@properties['end_conference_on_exit']
|
609
|
-
end
|
610
|
-
|
611
|
-
##
|
612
|
-
# @return [Boolean] Whether the participant is muted
|
613
|
-
def muted
|
614
|
-
@properties['muted']
|
615
|
-
end
|
616
|
-
|
617
|
-
##
|
618
|
-
# @return [Boolean] Whether the participant is on hold
|
619
|
-
def hold
|
620
|
-
@properties['hold']
|
621
|
-
end
|
622
|
-
|
623
|
-
##
|
624
|
-
# @return [Boolean] Whether the conference starts when the participant joins the conference
|
625
|
-
def start_conference_on_enter
|
626
|
-
@properties['start_conference_on_enter']
|
627
|
-
end
|
628
|
-
|
629
|
-
##
|
630
|
-
# @return [participant.Status] The status of the participant's call in a session
|
631
|
-
def status
|
632
|
-
@properties['status']
|
633
|
-
end
|
634
|
-
|
635
|
-
##
|
636
|
-
# @return [String] The URI of the resource, relative to `https://api.twilio.com`
|
637
|
-
def uri
|
638
|
-
@properties['uri']
|
639
|
-
end
|
640
|
-
|
641
|
-
##
|
642
|
-
# Fetch the ParticipantInstance
|
643
|
-
# @return [ParticipantInstance] Fetched ParticipantInstance
|
644
|
-
def fetch
|
645
|
-
context.fetch
|
646
|
-
end
|
647
|
-
|
648
|
-
##
|
649
|
-
# Update the ParticipantInstance
|
650
|
-
# @param [Boolean] muted Whether the participant should be muted. Can be `true` or
|
651
|
-
# `false`. `true` will mute the participant, and `false` will un-mute them.
|
652
|
-
# Anything value other than `true` or `false` is interpreted as `false`.
|
653
|
-
# @param [Boolean] hold Whether the participant should be on hold. Can be: `true`
|
654
|
-
# or `false`. `true` puts the participant on hold, and `false` lets them rejoin
|
655
|
-
# the conference.
|
656
|
-
# @param [String] hold_url The URL we call using the `hold_method` for music that
|
657
|
-
# plays when the participant is on hold. The URL may return an MP3 file, a WAV
|
658
|
-
# file, or a TwiML document that contains the `<Play>`, `<Say>` or `<Redirect>`
|
659
|
-
# commands.
|
660
|
-
# @param [String] hold_method The HTTP method we should use to call `hold_url`.
|
661
|
-
# Can be: `GET` or `POST` and the default is `GET`.
|
662
|
-
# @param [String] announce_url The URL we call using the `announce_method` for an
|
663
|
-
# announcement to the participant. The URL must return an MP3 file, a WAV file, or
|
664
|
-
# a TwiML document that contains `<Play>` or `<Say>` commands.
|
665
|
-
# @param [String] announce_method The HTTP method we should use to call
|
666
|
-
# `announce_url`. Can be: `GET` or `POST` and defaults to `POST`.
|
667
|
-
# @param [String] wait_url The URL we should call using the `wait_method` for the
|
668
|
-
# music to play while participants are waiting for the conference to start. The
|
669
|
-
# default value is the URL of our standard hold music. {Learn more about hold
|
670
|
-
# music}[https://www.twilio.com/labs/twimlets/holdmusic].
|
671
|
-
# @param [String] wait_method The HTTP method we should use to call `wait_url`.
|
672
|
-
# Can be `GET` or `POST` and the default is `POST`. When using a static audio
|
673
|
-
# file, this should be `GET` so that we can cache the file.
|
674
|
-
# @param [Boolean] beep_on_exit Whether to play a notification beep to the
|
675
|
-
# conference when the participant exits. Can be: `true` or `false`.
|
676
|
-
# @param [Boolean] end_conference_on_exit Whether to end the conference when the
|
677
|
-
# participant leaves. Can be: `true` or `false` and defaults to `false`.
|
678
|
-
# @param [Boolean] coaching Whether the participant is coaching another call. Can
|
679
|
-
# be: `true` or `false`. If not present, defaults to `false` unless
|
680
|
-
# `call_sid_to_coach` is defined. If `true`, `call_sid_to_coach` must be defined.
|
681
|
-
# @param [String] call_sid_to_coach The SID of the participant who is being
|
682
|
-
# `coached`. The participant being coached is the only participant who can hear
|
683
|
-
# the participant who is `coaching`.
|
684
|
-
# @return [ParticipantInstance] Updated ParticipantInstance
|
685
|
-
def update(muted: :unset, hold: :unset, hold_url: :unset, hold_method: :unset, announce_url: :unset, announce_method: :unset, wait_url: :unset, wait_method: :unset, beep_on_exit: :unset, end_conference_on_exit: :unset, coaching: :unset, call_sid_to_coach: :unset)
|
686
|
-
context.update(
|
687
|
-
muted: muted,
|
688
|
-
hold: hold,
|
689
|
-
hold_url: hold_url,
|
690
|
-
hold_method: hold_method,
|
691
|
-
announce_url: announce_url,
|
692
|
-
announce_method: announce_method,
|
693
|
-
wait_url: wait_url,
|
694
|
-
wait_method: wait_method,
|
695
|
-
beep_on_exit: beep_on_exit,
|
696
|
-
end_conference_on_exit: end_conference_on_exit,
|
697
|
-
coaching: coaching,
|
698
|
-
call_sid_to_coach: call_sid_to_coach,
|
699
|
-
)
|
700
|
-
end
|
701
|
-
|
702
|
-
##
|
703
|
-
# Delete the ParticipantInstance
|
704
|
-
# @return [Boolean] true if delete succeeds, false otherwise
|
705
|
-
def delete
|
706
|
-
context.delete
|
707
|
-
end
|
708
|
-
|
709
|
-
##
|
710
|
-
# Provide a user friendly representation
|
711
|
-
def to_s
|
712
|
-
values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
|
713
|
-
"<Twilio.Api.V2010.ParticipantInstance #{values}>"
|
714
|
-
end
|
715
|
-
|
716
|
-
##
|
717
|
-
# Provide a detailed, user friendly representation
|
718
|
-
def inspect
|
719
|
-
values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
|
720
|
-
"<Twilio.Api.V2010.ParticipantInstance #{values}>"
|
721
|
-
end
|
655
|
+
|
656
|
+
end
|
657
|
+
end
|
722
658
|
end
|
723
|
-
end
|
724
659
|
end
|
725
|
-
end
|
726
660
|
end
|
727
|
-
|
728
|
-
|
661
|
+
end
|
662
|
+
|
663
|
+
|