lib/twilio-ruby/rest/api/v2010/account/conference.rb in twilio-ruby-5.8.1 vs lib/twilio-ruby/rest/api/v2010/account/conference.rb in twilio-ruby-5.9.0
- old
+ new
@@ -1,22 +1,25 @@
##
# This code was generated by
# \ / _ _ _| _ _
# | (_)\/(_)(_|\/| |(/_ v1.0.0
# / /
+#
+# frozen_string_literal: true
module Twilio
module REST
class Api < Domain
class V2010 < Version
class AccountContext < InstanceContext
class ConferenceList < ListResource
##
# Initialize the ConferenceList
# @param [Version] version Version that contains the resource
- # @param [String] account_sid The unique id of the Account] responsible for
- # creating this conference.
+ # @param [String] account_sid The unique id of the
+ # [Account](https://www.twilio.com/docs/api/rest/account) responsible for creating
+ # this conference.
# @return [ConferenceList] ConferenceList
def initialize(version, account_sid: nil)
super(version)
# Path Solution
@@ -239,11 +242,12 @@
)
end
##
# Update the ConferenceInstance
- # @param [conference.UpdateStatus] status The status
+ # @param [conference.UpdateStatus] status Specifying `completed` will end the
+ # conference and kick all participants
# @param [String] announce_url The announce_url
# @param [String] announce_method The announce_method
# @return [ConferenceInstance] Updated ConferenceInstance
def update(status: :unset, announce_url: :unset, announce_method: :unset)
data = Twilio::Values.of({
@@ -299,12 +303,13 @@
class ConferenceInstance < InstanceResource
##
# Initialize the ConferenceInstance
# @param [Version] version Version that contains the resource
# @param [Hash] payload payload that contains response from Twilio
- # @param [String] account_sid The unique id of the Account] responsible for
- # creating this conference.
+ # @param [String] account_sid The unique id of the
+ # [Account](https://www.twilio.com/docs/api/rest/account) responsible for creating
+ # this conference.
# @param [String] sid The conference Sid that uniquely identifies this resource
# @return [ConferenceInstance] ConferenceInstance
def initialize(version, payload, account_sid: nil, sid: nil)
super(version)
@@ -367,11 +372,11 @@
def friendly_name
@properties['friendly_name']
end
##
- # @return [String] The region
+ # @return [String] A string representing the Twilio Region where the conference was mixed.
def region
@properties['region']
end
##
@@ -405,10 +410,11 @@
context.fetch
end
##
# Update the ConferenceInstance
- # @param [conference.UpdateStatus] status The status
+ # @param [conference.UpdateStatus] status Specifying `completed` will end the
+ # conference and kick all participants
# @param [String] announce_url The announce_url
# @param [String] announce_method The announce_method
# @return [ConferenceInstance] Updated ConferenceInstance
def update(status: :unset, announce_url: :unset, announce_method: :unset)
context.update(status: status, announce_url: announce_url, announce_method: announce_method, )
\ No newline at end of file