binding.rb in twilio-ruby-5.21.2

- old
+ new

@@ -13,13 +13,13 @@
         class ServiceContext < InstanceContext
           class BindingList < ListResource
             ##
             # Initialize the BindingList
             # @param [Version] version Version that contains the resource
-            # @param [String] service_sid The unique id of the
-            #   [Service](https://www.twilio.com/docs/api/chat/rest/services) this binding
-            #   belongs to.
+            # @param [String] service_sid The SID of the
+            #   [Service](https://www.twilio.com/docs/chat/rest/services) the resource is
+            #   associated with.
             # @return [BindingList] BindingList
             def initialize(version, service_sid: nil)
               super(version)
 
               # Path Solution
@@ -29,16 +29,19 @@
 
             ##
             # Lists BindingInstance records from the API as a list.
             # Unlike stream(), this operation is eager and will load `limit` records into
             # memory before returning.
-            # @param [binding.BindingType] binding_type The push technology used for the
-            #   returned Bindings.  Supported values are apn, gcm and fcm.  See [push
+            # @param [binding.BindingType] binding_type The push technology used by the
+            #   Binding resources to read.  Can be: `apn`, `gcm`, or `fcm`.  See [push
             #   notification
             #   configuration](https://www.twilio.com/docs/chat/push-notification-configuration)
             #   for more information.
-            # @param [String] identity The identity
+            # @param [String] identity The
+            #   [User](https://www.twilio.com/docs/chat/rest/users)'s `identity` value of the
+            #   resources to read. See [access
+            #   tokens](https://www.twilio.com/docs/chat/create-tokens) for more details.
             # @param [Integer] limit Upper limit for the number of records to return. stream()
             #    guarantees to never return more than limit.  Default is no limit
             # @param [Integer] page_size Number of records to fetch per request, when
             #    not set will use the default value of 50 records.  If no page_size is defined
             #    but a limit is defined, stream() will attempt to read the limit with the most
@@ -55,16 +58,19 @@
 
             ##
             # Streams BindingInstance records from the API as an Enumerable.
             # This operation lazily loads records as efficiently as possible until the limit
             # is reached.
-            # @param [binding.BindingType] binding_type The push technology used for the
-            #   returned Bindings.  Supported values are apn, gcm and fcm.  See [push
+            # @param [binding.BindingType] binding_type The push technology used by the
+            #   Binding resources to read.  Can be: `apn`, `gcm`, or `fcm`.  See [push
             #   notification
             #   configuration](https://www.twilio.com/docs/chat/push-notification-configuration)
             #   for more information.
-            # @param [String] identity The identity
+            # @param [String] identity The
+            #   [User](https://www.twilio.com/docs/chat/rest/users)'s `identity` value of the
+            #   resources to read. See [access
+            #   tokens](https://www.twilio.com/docs/chat/create-tokens) for more details.
             # @param [Integer] limit Upper limit for the number of records to return. stream()
             #    guarantees to never return more than limit. Default is no limit.
             # @param [Integer] page_size Number of records to fetch per request, when
             #    not set will use the default value of 50 records. If no page_size is defined
             #    but a limit is defined, stream() will attempt to read the limit with the most
@@ -93,16 +99,19 @@
             end
 
             ##
             # Retrieve a single page of BindingInstance records from the API.
             # Request is executed immediately.
-            # @param [binding.BindingType] binding_type The push technology used for the
-            #   returned Bindings.  Supported values are apn, gcm and fcm.  See [push
+            # @param [binding.BindingType] binding_type The push technology used by the
+            #   Binding resources to read.  Can be: `apn`, `gcm`, or `fcm`.  See [push
             #   notification
             #   configuration](https://www.twilio.com/docs/chat/push-notification-configuration)
             #   for more information.
-            # @param [String] identity The identity
+            # @param [String] identity The
+            #   [User](https://www.twilio.com/docs/chat/rest/users)'s `identity` value of the
+            #   resources to read. See [access
+            #   tokens](https://www.twilio.com/docs/chat/create-tokens) for more details.
             # @param [String] page_token PageToken provided by the API
             # @param [Integer] page_number Page Number, this value is simply for client state
             # @param [Integer] page_size Number of records to return, defaults to 50
             # @return [Page] Page of BindingInstance
             def page(binding_type: :unset, identity: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
@@ -172,12 +181,15 @@
 
           class BindingContext < InstanceContext
             ##
             # Initialize the BindingContext
             # @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/chat/rest/services) to fetch the resource
+            #   from.
+            # @param [String] sid The Twilio-provided string that uniquely identifies the
+            #   Binding resource to fetch.
             # @return [BindingContext] BindingContext
             def initialize(version, service_sid, sid)
               super(version)
 
               # Path Solution
@@ -225,14 +237,15 @@
           class BindingInstance < InstanceResource
             ##
             # Initialize the BindingInstance
             # @param [Version] version Version that contains the resource
             # @param [Hash] payload payload that contains response from Twilio
-            # @param [String] service_sid The unique id of the
-            #   [Service](https://www.twilio.com/docs/api/chat/rest/services) this binding
-            #   belongs to.
-            # @param [String] sid The sid
+            # @param [String] service_sid The SID of the
+            #   [Service](https://www.twilio.com/docs/chat/rest/services) the resource is
+            #   associated with.
+            # @param [String] sid The Twilio-provided string that uniquely identifies the
+            #   Binding resource to fetch.
             # @return [BindingInstance] BindingInstance
             def initialize(version, payload, service_sid: nil, sid: nil)
               super(version)
 
               # Marshaled Properties
@@ -266,76 +279,76 @@
               end
               @instance_context
             end
 
             ##
-            # @return [String] A 34 character string that uniquely identifies this resource.
+            # @return [String] The unique string that identifies the resource
             def sid
               @properties['sid']
             end
 
             ##
-            # @return [String] The unique id of the Account responsible for this binding.
+            # @return [String] The SID of the Account that created the resource
             def account_sid
               @properties['account_sid']
             end
 
             ##
-            # @return [String] The unique id of the Service this binding belongs to.
+            # @return [String] The SID of the Service that the resource is associated with
             def service_sid
               @properties['service_sid']
             end
 
             ##
-            # @return [Time] The date that 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 that 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 endpoint identifier for this Binding.
+            # @return [String] The unique endpoint identifier for the Binding
             def endpoint
               @properties['endpoint']
             end
 
             ##
-            # @return [String] A unique string identifier for the Binding for this User in this Service.
+            # @return [String] The string that identifies the resource's User
             def identity
               @properties['identity']
             end
 
             ##
-            # @return [String] The unique id of the Credential for this binding.
+            # @return [String] The SID of the Credential for the binding
             def credential_sid
               @properties['credential_sid']
             end
 
             ##
-            # @return [binding.BindingType] The push technology to use for this binding.
+            # @return [binding.BindingType] The push technology to use for the binding
             def binding_type
               @properties['binding_type']
             end
 
             ##
-            # @return [String] List of message types for this binding.
+            # @return [String] The Programmable Chat message types the binding is subscribed to
             def message_types
               @properties['message_types']
             end
 
             ##
-            # @return [String] An absolute URL for this binding.
+            # @return [String] The absolute URL of the Binding resource
             def url
               @properties['url']
             end
 
             ##
-            # @return [String] Absolute URLs to access the Users for this Binding.
+            # @return [String] The absolute URLs of the Users for the Binding
             def links
               @properties['links']
             end
 
             ##
\ No newline at end of file