short_code.rb in twilio-ruby-5.19.0

- old
+ new

@@ -15,11 +15,13 @@
           # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
           class ShortCodeList < ListResource
             ##
             # Initialize the ShortCodeList
             # @param [Version] version Version that contains the resource
-            # @param [String] service_sid The 34 character unique sid of the Service.
+            # @param [String] service_sid The SID of the
+            #   [Service](https://www.twilio.com/docs/api/chat/rest/services) this resource is
+            #   associated with.
             # @return [ShortCodeList] ShortCodeList
             def initialize(version, service_sid: nil)
               super(version)
 
               # Path Solution
@@ -28,12 +30,12 @@
             end
 
             ##
             # Retrieve a single page of ShortCodeInstance records from the API.
             # Request is executed immediately.
-            # @param [String] short_code_sid ShortCodeSid for the Shortcode being added to the
-            #   Service..
+            # @param [String] short_code_sid SID of the ShortCode resource being added to the
+            #   Service.
             # @return [ShortCodeInstance] Newly created ShortCodeInstance
             def create(short_code_sid: nil)
               data = Twilio::Values.of({'ShortCodeSid' => short_code_sid, })
 
               payload = @version.create(
@@ -169,12 +171,15 @@
           # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
           class ShortCodeContext < InstanceContext
             ##
             # Initialize the ShortCodeContext
             # @param [Version] version Version that contains the resource
-            # @param [String] service_sid The service_sid
-            # @param [String] sid The sid
+            # @param [String] service_sid The SID of the
+            #   [Service](https://www.twilio.com/docs/api/chat/rest/services) to fetch the
+            #   resource from.
+            # @param [String] sid The Twilio-provided string that uniquely identifies the
+            #   ShortCode resource to fetch
             # @return [ShortCodeContext] ShortCodeContext
             def initialize(version, service_sid, sid)
               super(version)
 
               # Path Solution
@@ -217,12 +222,15 @@
           class ShortCodeInstance < InstanceResource
             ##
             # Initialize the ShortCodeInstance
             # @param [Version] version Version that contains the resource
             # @param [Hash] payload payload that contains response from Twilio
-            # @param [String] service_sid The 34 character unique sid of the Service.
-            # @param [String] sid The sid
+            # @param [String] service_sid The SID of the
+            #   [Service](https://www.twilio.com/docs/api/chat/rest/services) this resource is
+            #   associated with.
+            # @param [String] sid The Twilio-provided string that uniquely identifies the
+            #   ShortCode resource to fetch
             # @return [ShortCodeInstance] ShortCodeInstance
             def initialize(version, payload, service_sid: nil, sid: nil)
               super(version)
 
               # Marshaled Properties
@@ -253,35 +261,35 @@
               end
               @instance_context
             end
 
             ##
-            # @return [String] The 34 character unique sid of the Short Code
+            # @return [String] The unique string that identifies this resource
             def sid
               @properties['sid']
             end
 
             ##
-            # @return [String] The 34 character unique sid of the Account.
+            # @return [String] The SID of the Account that created this resource
             def account_sid
               @properties['account_sid']
             end
 
             ##
-            # @return [String] The 34 character unique sid of the Service.
+            # @return [String] The SID of the Service that this resource is associated with
             def service_sid
               @properties['service_sid']
             end
 
             ##
-            # @return [Time] he date that this resource was created.
+            # @return [Time] The RFC 2822 date and time in GMT that this resource was created
             def date_created
               @properties['date_created']
             end
 
             ##
-            # @return [Time] The date that this resource was last updated.
+            # @return [Time] The RFC 2822 date and time in GMT that this resource was last updated
             def date_updated
               @properties['date_updated']
             end
 
             ##
@@ -289,11 +297,11 @@
             def short_code
               @properties['short_code']
             end
 
             ##
-            # @return [String] The 2 character ISO Country Code of the number.
+            # @return [String] The 2-character ISO Country Code of the number.
             def country_code
               @properties['country_code']
             end
 
             ##
@@ -301,10 +309,10 @@
             def capabilities
               @properties['capabilities']
             end
 
             ##
-            # @return [String] The url
+            # @return [String] The absolute URL of this ShortCode resource
             def url
               @properties['url']
             end
 
             ##
\ No newline at end of file