twilio-ruby 5.22.1 → 5.22.2

data/lib/twilio-ruby/rest/trunking/v1/trunk/origination_url.rb

@@ -15,8 +15,7 @@ module Twilio
             ##
             # Initialize the OriginationUrlList
             # @param [Version] version Version that contains the resource
-            # @param [String] trunk_sid The unique ID of the Trunk that owns this Origination
-            #   URL.
+            # @param [String] trunk_sid The SID of the Trunk that owns the Origination URL.
             # @return [OriginationUrlList] OriginationUrlList
             def initialize(version, trunk_sid: nil)
               super(version)
@@ -29,16 +28,16 @@ module Twilio
             ##
             # Retrieve a single page of OriginationUrlInstance records from the API.
             # Request is executed immediately.
-            # @param [String] weight Weight is used to determine the share of load when more
-            #   than one URI has the same priority. Its values range from 1 to 65535. The higher
-            #   the value, the more load a URI is given. Defaults to 10.
-            # @param [String] priority Priority ranks the importance of the URI. Values range
-            #   from 0 to 65535, where the lowest number represents the highest importance.
-            #   Defaults to 10.
-            # @param [Boolean] enabled A boolean value indicating whether the URL is enabled
-            #   or disabled. Defaults to true.
-            # @param [String] friendly_name A human readable descriptive text, up to 64
-            #   characters long.
+            # @param [String] weight The value that determines the relative share of the load
+            #   the URI should receive compared to other URIs with the same priority. Can be an
+            #   integer from 1 to 65535, inclusive, and the default is 10. URLs with higher
+            #   values receive more load than those with lower ones with the same priority.
+            # @param [String] priority The relative importance of the URI. Can be an integer
+            #   from 0 to 65535, inclusive, and the default is 10. The lowest number represents
+            #   the most important URI.
+            # @param [Boolean] enabled Whether the URL is enabled. The default is `true`.
+            # @param [String] friendly_name A descriptive string that you create to describe
+            #   the resource. It can be up to 64 characters long.
             # @param [String] sip_url The SIP address you want Twilio to route your
             #   Origination calls to. This must be a `sip:` schema.
             # @return [OriginationUrlInstance] Newly created OriginationUrlInstance
@@ -182,8 +181,10 @@ module Twilio
             ##
             # Initialize the OriginationUrlContext
             # @param [Version] version Version that contains the resource
-            # @param [String] trunk_sid The trunk_sid
-            # @param [String] sid The sid
+            # @param [String] trunk_sid The SID of the Trunk from which to fetch the
+            #   OriginationUrl.
+            # @param [String] sid The unique string that we created to identify the
+            #   OriginationUrl resource to fetch.
             # @return [OriginationUrlContext] OriginationUrlContext
             def initialize(version, trunk_sid, sid)
               super(version)
@@ -222,18 +223,18 @@ module Twilio
 
             ##
             # Update the OriginationUrlInstance
-            # @param [String] weight Weight is used to determine the share of load when more
-            #   than one URI has the same priority. Its values range from 1 to 65535. The higher
-            #   the value, the more load a URI is given. Defaults to 10.
-            # @param [String] priority Priority ranks the importance of the URI. Values range
-            #   from 0 to 65535, where the lowest number represents the highest importance.
-            #   Defaults to 10.
-            # @param [Boolean] enabled A boolean value indicating whether the URL is enabled
-            #   or disabled. Defaults to true.
-            # @param [String] friendly_name A human readable descriptive text, up to 64
-            #   characters long.
+            # @param [String] weight The value that determines the relative share of the load
+            #   the URI should receive compared to other URIs with the same priority. Can be an
+            #   integer from 1 to 65535, inclusive, and the default is 10. URLs with higher
+            #   values receive more load than those with lower ones with the same priority.
+            # @param [String] priority The relative importance of the URI. Can be an integer
+            #   from 0 to 65535, inclusive, and the default is 10. The lowest number represents
+            #   the most important URI.
+            # @param [Boolean] enabled Whether the URL is enabled. The default is `true`.
+            # @param [String] friendly_name A descriptive string that you create to describe
+            #   the resource. It can be up to 64 characters long.
             # @param [String] sip_url The SIP address you want Twilio to route your
-            #   Origination calls to. This must be a `sip:` schema. `sips` is NOT supported
+            #   Origination calls to. This must be a `sip:` schema. `sips` is NOT supported.
             # @return [OriginationUrlInstance] Updated OriginationUrlInstance
             def update(weight: :unset, priority: :unset, enabled: :unset, friendly_name: :unset, sip_url: :unset)
               data = Twilio::Values.of({
@@ -278,9 +279,9 @@ module Twilio
             # Initialize the OriginationUrlInstance
             # @param [Version] version Version that contains the resource
             # @param [Hash] payload payload that contains response from Twilio
-            # @param [String] trunk_sid The unique ID of the Trunk that owns this Origination
-            #   URL.
-            # @param [String] sid The sid
+            # @param [String] trunk_sid The SID of the Trunk that owns the Origination URL.
+            # @param [String] sid The unique string that we created to identify the
+            #   OriginationUrl resource to fetch.
             # @return [OriginationUrlInstance] OriginationUrlInstance
             def initialize(version, payload, trunk_sid: nil, sid: nil)
               super(version)
@@ -317,67 +318,67 @@ module Twilio
             end
 
             ##
-            # @return [String] The unique ID of the Account that owns this Origination URL.
+            # @return [String] The SID of the Account that created the resource
             def account_sid
               @properties['account_sid']
             end
 
             ##
-            # @return [String] A 34 character string that uniquely identifies the Origination URL in this Twilio Trunk.
+            # @return [String] The unique string that identifies the resource
             def sid
               @properties['sid']
             end
 
             ##
-            # @return [String] The unique ID of the Trunk that owns this Origination URL.
+            # @return [String] The SID of the Trunk that owns the Origination URL
             def trunk_sid
               @properties['trunk_sid']
             end
 
             ##
-            # @return [String] Weight is used to determine the share of load when more than one URI has the same priority.
+            # @return [String] The value that determines the relative load the URI should receive compared to others with the same priority
             def weight
               @properties['weight']
             end
 
             ##
-            # @return [Boolean] A boolean value indicating whether the URL is enabled or disabled.
+            # @return [Boolean] Whether the URL is enabled
             def enabled
               @properties['enabled']
             end
 
             ##
-            # @return [String] The SIP address you want Twilio to route your Origination calls to.
+            # @return [String] The SIP address you want Twilio to route your Origination calls to
             def sip_url
               @properties['sip_url']
             end
 
             ##
-            # @return [String] A human readable descriptive text, up to 64 characters long.
+            # @return [String] The string that you assigned to describe the resource
             def friendly_name
               @properties['friendly_name']
             end
 
             ##
-            # @return [String] Priority ranks the importance of the URI.
+            # @return [String] The relative importance of the URI
             def priority
               @properties['priority']
             end
 
             ##
-            # @return [Time] The date this Activity was created.
+            # @return [Time] The RFC 2822 date and time in GMT when the resource was created
             def date_created
               @properties['date_created']
             end
 
             ##
-            # @return [Time] The date this Activity was updated.
+            # @return [Time] The RFC 2822 date and time in GMT when the resource was last updated
             def date_updated
               @properties['date_updated']
             end
 
             ##
-            # @return [String] The URL for this resource, relative to https://trunking.
+            # @return [String] The absolute URL of the resource
             def url
               @properties['url']
             end
@@ -398,18 +399,18 @@ module Twilio
 
             ##
             # Update the OriginationUrlInstance
-            # @param [String] weight Weight is used to determine the share of load when more
-            #   than one URI has the same priority. Its values range from 1 to 65535. The higher
-            #   the value, the more load a URI is given. Defaults to 10.
-            # @param [String] priority Priority ranks the importance of the URI. Values range
-            #   from 0 to 65535, where the lowest number represents the highest importance.
-            #   Defaults to 10.
-            # @param [Boolean] enabled A boolean value indicating whether the URL is enabled
-            #   or disabled. Defaults to true.
-            # @param [String] friendly_name A human readable descriptive text, up to 64
-            #   characters long.
+            # @param [String] weight The value that determines the relative share of the load
+            #   the URI should receive compared to other URIs with the same priority. Can be an
+            #   integer from 1 to 65535, inclusive, and the default is 10. URLs with higher
+            #   values receive more load than those with lower ones with the same priority.
+            # @param [String] priority The relative importance of the URI. Can be an integer
+            #   from 0 to 65535, inclusive, and the default is 10. The lowest number represents
+            #   the most important URI.
+            # @param [Boolean] enabled Whether the URL is enabled. The default is `true`.
+            # @param [String] friendly_name A descriptive string that you create to describe
+            #   the resource. It can be up to 64 characters long.
             # @param [String] sip_url The SIP address you want Twilio to route your
-            #   Origination calls to. This must be a `sip:` schema. `sips` is NOT supported
+            #   Origination calls to. This must be a `sip:` schema. `sips` is NOT supported.
             # @return [OriginationUrlInstance] Updated OriginationUrlInstance
             def update(weight: :unset, priority: :unset, enabled: :unset, friendly_name: :unset, sip_url: :unset)
               context.update(

data/lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.rb

@@ -15,7 +15,10 @@ module Twilio
             ##
             # Initialize the PhoneNumberList
             # @param [Version] version Version that contains the resource
-            # @param [String] trunk_sid The trunk_sid
+            # @param [String] trunk_sid The SID of the Trunk that handles calls to the phone
+            #   number. If a `trunk_sid` is present, we ignore all of the voice URLs and voice
+            #   applications and use those set on the Trunk. Setting a `trunk_sid` will
+            #   automatically delete your `voice_application_sid` and vice versa.
             # @return [PhoneNumberList] PhoneNumberList
             def initialize(version, trunk_sid: nil)
               super(version)
@@ -30,7 +33,7 @@ module Twilio
             # Request is executed immediately.
             # @param [String] phone_number_sid The SID of the [Incoming Phone
             #   Number](https://www.twilio.com/docs/api/rest/incoming-phone-numbers) that you
-            #   want to associate with this trunk.
+            #   want to associate with the trunk.
             # @return [PhoneNumberInstance] Newly created PhoneNumberInstance
             def create(phone_number_sid: nil)
               data = Twilio::Values.of({'PhoneNumberSid' => phone_number_sid, })
@@ -166,8 +169,10 @@ module Twilio
             ##
             # Initialize the PhoneNumberContext
             # @param [Version] version Version that contains the resource
-            # @param [String] trunk_sid The trunk_sid
-            # @param [String] sid The sid
+            # @param [String] trunk_sid The SID of the Trunk from which to fetch the
+            #   PhoneNumber resource.
+            # @param [String] sid The unique string that we created to identify the
+            #   PhoneNumber resource to fetch.
             # @return [PhoneNumberContext] PhoneNumberContext
             def initialize(version, trunk_sid, sid)
               super(version)
@@ -219,8 +224,12 @@ module Twilio
             # Initialize the PhoneNumberInstance
             # @param [Version] version Version that contains the resource
             # @param [Hash] payload payload that contains response from Twilio
-            # @param [String] trunk_sid The trunk_sid
-            # @param [String] sid The sid
+            # @param [String] trunk_sid The SID of the Trunk that handles calls to the phone
+            #   number. If a `trunk_sid` is present, we ignore all of the voice URLs and voice
+            #   applications and use those set on the Trunk. Setting a `trunk_sid` will
+            #   automatically delete your `voice_application_sid` and vice versa.
+            # @param [String] sid The unique string that we created to identify the
+            #   PhoneNumber resource to fetch.
             # @return [PhoneNumberInstance] PhoneNumberInstance
             def initialize(version, payload, trunk_sid: nil, sid: nil)
               super(version)
@@ -272,157 +281,157 @@ module Twilio
             end
 
             ##
-            # @return [String] The account_sid
+            # @return [String] The SID of the Account that created the resource
             def account_sid
               @properties['account_sid']
             end
 
             ##
-            # @return [phone_number.AddressRequirement] The address_requirements
+            # @return [phone_number.AddressRequirement] Whether the phone number requires an Address registered with Twilio
             def address_requirements
               @properties['address_requirements']
             end
 
             ##
-            # @return [String] The api_version
+            # @return [String] The API version used to start a new TwiML session
             def api_version
               @properties['api_version']
             end
 
             ##
-            # @return [Boolean] The beta
+            # @return [Boolean] Whether the phone number is new to the Twilio platform
             def beta
               @properties['beta']
             end
 
             ##
-            # @return [String] The capabilities
+            # @return [String] Indicate if a phone can receive calls or messages
             def capabilities
               @properties['capabilities']
             end
 
             ##
-            # @return [Time] The date_created
+            # @return [Time] The RFC 2822 date and time in GMT when the resource was created
             def date_created
               @properties['date_created']
             end
 
             ##
-            # @return [Time] The date_updated
+            # @return [Time] The RFC 2822 date and time in GMT when the resource was last updated
             def date_updated
               @properties['date_updated']
             end
 
             ##
-            # @return [String] The friendly_name
+            # @return [String] The string that you assigned to describe the resource
             def friendly_name
               @properties['friendly_name']
             end
 
             ##
-            # @return [String] The links
+            # @return [String] The URLs of related resources
             def links
               @properties['links']
             end
 
             ##
-            # @return [String] The phone_number
+            # @return [String] The phone number in E.164 format
             def phone_number
               @properties['phone_number']
             end
 
             ##
-            # @return [String] The sid
+            # @return [String] The unique string that identifies the resource
             def sid
               @properties['sid']
             end
 
             ##
-            # @return [String] The sms_application_sid
+            # @return [String] The SID of the application that handles SMS messages sent to the phone number
             def sms_application_sid
               @properties['sms_application_sid']
             end
 
             ##
-            # @return [String] The sms_fallback_method
+            # @return [String] The HTTP method used with sms_fallback_url
             def sms_fallback_method
               @properties['sms_fallback_method']
             end
 
             ##
-            # @return [String] The sms_fallback_url
+            # @return [String] The URL that we call when an error occurs while retrieving or executing the TwiML
             def sms_fallback_url
               @properties['sms_fallback_url']
             end
 
             ##
-            # @return [String] The sms_method
+            # @return [String] The HTTP method to use with sms_url
             def sms_method
               @properties['sms_method']
             end
 
             ##
-            # @return [String] The sms_url
+            # @return [String] The URL we call when the phone number receives an incoming SMS message
             def sms_url
               @properties['sms_url']
             end
 
             ##
-            # @return [String] The status_callback
+            # @return [String] The URL to send status information to your application
             def status_callback
               @properties['status_callback']
             end
 
             ##
-            # @return [String] The status_callback_method
+            # @return [String] The HTTP method we use to call status_callback
             def status_callback_method
               @properties['status_callback_method']
             end
 
             ##
-            # @return [String] The trunk_sid
+            # @return [String] The SID of the Trunk that handles calls to the phone number
             def trunk_sid
               @properties['trunk_sid']
             end
 
             ##
-            # @return [String] The url
+            # @return [String] The absolute URL of the resource
             def url
               @properties['url']
             end
 
             ##
-            # @return [String] The voice_application_sid
+            # @return [String] The SID of the application that handles calls to the phone number
             def voice_application_sid
               @properties['voice_application_sid']
             end
 
             ##
-            # @return [Boolean] The voice_caller_id_lookup
+            # @return [Boolean] Whether to lookup the caller's name
             def voice_caller_id_lookup
               @properties['voice_caller_id_lookup']
             end
 
             ##
-            # @return [String] The voice_fallback_method
+            # @return [String] The HTTP method that we use to call voice_fallback_url
             def voice_fallback_method
               @properties['voice_fallback_method']
             end
 
             ##
-            # @return [String] The voice_fallback_url
+            # @return [String] The URL we call when an error occurs in TwiML
             def voice_fallback_url
               @properties['voice_fallback_url']
             end
 
             ##
-            # @return [String] The voice_method
+            # @return [String] The HTTP method used with the voice_url
             def voice_method
               @properties['voice_method']
             end
 
             ##
-            # @return [String] The voice_url
+            # @return [String] The URL we call when the phone number receives a call
             def voice_url
               @properties['voice_url']
             end

data/lib/twilio-ruby/rest/trunking/v1/trunk/terminating_sip_domain.rb

@@ -15,10 +15,9 @@ module Twilio
             ##
             # Initialize the TerminatingSipDomainList
             # @param [Version] version Version that contains the resource
-            # @param [String] trunk_sid The 34 character sid of the Trunk Twilio should route
-            #   calls arriving at this domain. If a `TrunkSid` is present, Twilio will ignore
-            #   all of the voice urls present and calls will be terminated through the specified
-            #   trunk.
+            # @param [String] trunk_sid The SID of the Trunk to which we should route calls
+            #   that arrive at the domain. If a `trunk_sid` is present, we ignore all of the
+            #   voice URLs present and terminate calls through the specified trunk.
             # @return [TerminatingSipDomainList] TerminatingSipDomainList
             def initialize(version, trunk_sid: nil)
               super(version)
@@ -33,7 +32,7 @@ module Twilio
             # Request is executed immediately.
             # @param [String] sip_domain_sid The SID of the [SIP
             #   Domain](https://www.twilio.com/docs/voice/sip/api/sip-domain-resource) that you
-            #   want to associate with this trunk.
+            #   want to associate with the trunk.
             # @return [TerminatingSipDomainInstance] Newly created TerminatingSipDomainInstance
             def create(sip_domain_sid: nil)
               data = Twilio::Values.of({'SipDomainSid' => sip_domain_sid, })
@@ -169,9 +168,10 @@ module Twilio
             ##
             # Initialize the TerminatingSipDomainContext
             # @param [Version] version Version that contains the resource
-            # @param [String] trunk_sid A unique string that identifies the trunk.
-            # @param [String] sid A unique string that identifies the associated domain to
-            #   fetch.
+            # @param [String] trunk_sid The SID of the Trunk with the TerminatingSipDomain
+            #   resource to fetch.
+            # @param [String] sid The unique string that we created to identify the
+            #   TerminatingSipDomain resource to fetch.
             # @return [TerminatingSipDomainContext] TerminatingSipDomainContext
             def initialize(version, trunk_sid, sid)
               super(version)
@@ -228,12 +228,11 @@ module Twilio
             # Initialize the TerminatingSipDomainInstance
             # @param [Version] version Version that contains the resource
             # @param [Hash] payload payload that contains response from Twilio
-            # @param [String] trunk_sid The 34 character sid of the Trunk Twilio should route
-            #   calls arriving at this domain. If a `TrunkSid` is present, Twilio will ignore
-            #   all of the voice urls present and calls will be terminated through the specified
-            #   trunk.
-            # @param [String] sid A unique string that identifies the associated domain to
-            #   fetch.
+            # @param [String] trunk_sid The SID of the Trunk to which we should route calls
+            #   that arrive at the domain. If a `trunk_sid` is present, we ignore all of the
+            #   voice URLs present and terminate calls through the specified trunk.
+            # @param [String] sid The unique string that we created to identify the
+            #   TerminatingSipDomain resource to fetch.
             # @return [TerminatingSipDomainInstance] TerminatingSipDomainInstance
             def initialize(version, payload, trunk_sid: nil, sid: nil)
               super(version)
@@ -277,13 +276,13 @@ module Twilio
             end
 
             ##
-            # @return [String] The unique id of the account responsible for this domain
+            # @return [String] The SID of the Account that created the resource
             def account_sid
               @properties['account_sid']
             end
 
             ##
-            # @return [String] The Twilio API version used to process the call
+            # @return [String] The API version used to process the call
             def api_version
               @properties['api_version']
             end
@@ -295,91 +294,91 @@ module Twilio
             end
 
             ##
-            # @return [Time] The date this resource was created
+            # @return [Time] The RFC 2822 date and time in GMT when the resource was created
             def date_created
               @properties['date_created']
             end
 
             ##
-            # @return [Time] The date this resource was last updated
+            # @return [Time] The RFC 2822 date and time in GMT when the resource was last updated
             def date_updated
               @properties['date_updated']
             end
 
             ##
-            # @return [String] The unique address on Twilio to route SIP traffic
+            # @return [String] The unique address you reserve on Twilio to which you route your SIP traffic
             def domain_name
               @properties['domain_name']
             end
 
             ##
-            # @return [String] A user-specified, human-readable name for the domain.
+            # @return [String] The string that you assigned to describe the resource
             def friendly_name
               @properties['friendly_name']
             end
 
             ##
-            # @return [String] A string that uniquely identifies the SIP Domain
+            # @return [String] The unique string that identifies the resource
             def sid
               @properties['sid']
             end
 
             ##
-            # @return [String] The url
+            # @return [String] The absolute URL of the resource
             def url
               @properties['url']
             end
 
             ##
-            # @return [String] HTTP method used with voice_fallback_url
+            # @return [String] The HTTP method used with voice_fallback_url
             def voice_fallback_method
               @properties['voice_fallback_method']
             end
 
             ##
-            # @return [String] URL Twilio will request if an error occurs in executing TwiML
+            # @return [String] The URL that we call when an error occurs in executing TwiML
             def voice_fallback_url
               @properties['voice_fallback_url']
             end
 
             ##
-            # @return [String] HTTP method to use with voice_url
+            # @return [String] The HTTP method used with voice_url
             def voice_method
               @properties['voice_method']
             end
 
             ##
-            # @return [String] The HTTP method Twilio will use to make requests to the StatusCallback URL.
+            # @return [String] The HTTP method that we use to call the voice_status_callback_url
             def voice_status_callback_method
               @properties['voice_status_callback_method']
             end
 
             ##
-            # @return [String] URL that Twilio will request with status updates
+            # @return [String] The URL that we call to pass status parameters to your application
             def voice_status_callback_url
               @properties['voice_status_callback_url']
             end
 
             ##
-            # @return [String] URL Twilio will request when receiving a call
+            # @return [String] The URL we call when the domain receives a call
             def voice_url
               @properties['voice_url']
             end
 
             ##
-            # @return [Boolean] If SIP registration is allowed
+            # @return [Boolean] Whether SIP Endpoints can register with the domain to receive calls
             def sip_registration
               @properties['sip_registration']
             end
 
             ##
-            # @return [String] Unique string to identify an associated trunk
+            # @return [String] The SID of the Trunk to which we should route calls
             def trunk_sid
               @properties['trunk_sid']
             end
 
             ##
-            # @return [String] The links
+            # @return [String] The URLs of related resources
             def links
               @properties['links']
             end