channel.rb in twilio-ruby-5.15.0

- old
+ new

@@ -31,12 +31,14 @@
             # Retrieve a single page of ChannelInstance records from the API.
             # Request is executed immediately.
             # @param [String] friendly_name A human-readable name for the Channel. Optional.
             # @param [String] unique_name A unique, addressable name for the Channel. 
             #   Optional.
-            # @param [String] attributes An optional metadata field you can use to store any
-            #   data you wish. No processing or validation is done on this field.
+            # @param [String] attributes An optional string metadata field you can use to
+            #   store any data you wish. The string value must contain structurally valid JSON
+            #   if specified.  **Note** that if the attributes are not set "{}" will be
+            #   returned.
             # @param [channel.ChannelType] type The visibility of the channel - `public` or
             #   `private`. Defaults to `public`.
             # @param [Time] date_created The optional ISO8601 time specifying the datetime the
             #   Channel should be set as being created.  Will be set to the current time by the
             #   Chat service if not specified.  Note that this should only be used in cases
@@ -243,12 +245,14 @@
             ##
             # Update the ChannelInstance
             # @param [String] friendly_name A human-readable name for the Channel. Optional.
             # @param [String] unique_name A unique, addressable name for the Channel. 
             #   Optional.
-            # @param [String] attributes An optional metadata field you can use to store any
-            #   data you wish. No processing or validation is done on this field.
+            # @param [String] attributes An optional string metadata field you can use to
+            #   store any data you wish. The string value must contain structurally valid JSON
+            #   if specified.  **Note** that if the attributes are not set "{}" will be
+            #   returned.
             # @param [Time] date_created The optional ISO8601 time specifying the datetime the
             #   Channel should be set as being created.
             # @param [Time] date_updated The optional ISO8601 time specifying the datetime the
             #   Channel should be set as having been last updated.
             # @param [String] created_by Optional field to specify the Identity of the User
@@ -518,11 +522,13 @@
             ##
             # Update the ChannelInstance
             # @param [String] friendly_name A human-readable name for the Channel. Optional.
             # @param [String] unique_name A unique, addressable name for the Channel. 
             #   Optional.
-            # @param [String] attributes An optional metadata field you can use to store any
-            #   data you wish. No processing or validation is done on this field.
+            # @param [String] attributes An optional string metadata field you can use to
+            #   store any data you wish. The string value must contain structurally valid JSON
+            #   if specified.  **Note** that if the attributes are not set "{}" will be
+            #   returned.
             # @param [Time] date_created The optional ISO8601 time specifying the datetime the
             #   Channel should be set as being created.
             # @param [Time] date_updated The optional ISO8601 time specifying the datetime the
             #   Channel should be set as having been last updated.
             # @param [String] created_by Optional field to specify the Identity of the User
\ No newline at end of file