twilio-ruby 5.9.0 → 5.10.0

data/lib/twilio-ruby/rest/notify/v1/service.rb

@@ -28,18 +28,34 @@ module Twilio
           ##
           # Retrieve a single page of ServiceInstance records from the API.
           # Request is executed immediately.
-          # @param [String] friendly_name The friendly_name
-          # @param [String] apn_credential_sid The apn_credential_sid
-          # @param [String] gcm_credential_sid The gcm_credential_sid
-          # @param [String] messaging_service_sid The messaging_service_sid
-          # @param [String] facebook_messenger_page_id The facebook_messenger_page_id
-          # @param [String] default_apn_notification_protocol_version The
-          #   default_apn_notification_protocol_version
-          # @param [String] default_gcm_notification_protocol_version The
-          #   default_gcm_notification_protocol_version
-          # @param [String] fcm_credential_sid The fcm_credential_sid
-          # @param [String] default_fcm_notification_protocol_version The
-          #   default_fcm_notification_protocol_version
+          # @param [String] friendly_name Human-readable name for this service instance
+          # @param [String] apn_credential_sid The SID of the
+          #   [Credential](https://www.twilio.com/docs/notify/api/credentials) to be used for
+          #   APN Bindings.
+          # @param [String] gcm_credential_sid The SID of the
+          #   [Credential](https://www.twilio.com/docs/notify/api/credentials) to be used for
+          #   GCM Bindings.
+          # @param [String] messaging_service_sid The SID of the [Messaging
+          #   Service](https://www.twilio.com/docs/api/rest/sending-messages#messaging-services) to be used for SMS Bindings. In order to send SMS notifications this parameter has to be set.
+          # @param [String] facebook_messenger_page_id The Page ID to be used to send for
+          #   Facebook Messenger Bindings. It has to match the Page ID you configured when you
+          #   [enabled Facebook Messaging](https://www.twilio.com/console/sms/settings) on
+          #   your account.
+          # @param [String] default_apn_notification_protocol_version The version of the
+          #   protocol to be used for sending APNS notifications. Can be overriden on a
+          #   Binding by Binding basis when creating a
+          #   [Binding](https://www.twilio.com/docs/notify/api/bindings) resource.
+          # @param [String] default_gcm_notification_protocol_version The version of the
+          #   protocol to be used for sending GCM notifications. Can be overriden on a Binding
+          #   by Binding basis when creating a
+          #   [Binding](https://www.twilio.com/docs/notify/api/bindings) resource.
+          # @param [String] fcm_credential_sid The SID of the
+          #   [Credential](https://www.twilio.com/docs/notify/api/credentials) to be used for
+          #   FCM Bindings.
+          # @param [String] default_fcm_notification_protocol_version The version of the
+          #   protocol to be used for sending FCM notifications. Can be overriden on a Binding
+          #   by Binding basis when creating a
+          #   [Binding](https://www.twilio.com/docs/notify/api/bindings) resource.
           # @param [Boolean] log_enabled The log_enabled
           # @param [String] alexa_skill_id The alexa_skill_id
           # @param [String] default_alexa_notification_protocol_version The
@@ -74,7 +90,7 @@ module Twilio
           # Lists ServiceInstance records from the API as a list.
           # Unlike stream(), this operation is eager and will load `limit` records into
           # memory before returning.
-          # @param [String] friendly_name The friendly_name
+          # @param [String] friendly_name Filter services by FriendlyName
           # @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
@@ -90,7 +106,7 @@ module Twilio
           # Streams ServiceInstance records from the API as an Enumerable.
           # This operation lazily loads records as efficiently as possible until the limit
           # is reached.
-          # @param [String] friendly_name The friendly_name
+          # @param [String] friendly_name Filter services by FriendlyName
           # @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
@@ -123,7 +139,7 @@ module Twilio
           ##
           # Retrieve a single page of ServiceInstance records from the API.
           # Request is executed immediately.
-          # @param [String] friendly_name The friendly_name
+          # @param [String] friendly_name Filter services by FriendlyName
           # @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
@@ -240,18 +256,29 @@ module Twilio
 
           ##
           # Update the ServiceInstance
-          # @param [String] friendly_name The friendly_name
-          # @param [String] apn_credential_sid The apn_credential_sid
-          # @param [String] gcm_credential_sid The gcm_credential_sid
-          # @param [String] messaging_service_sid The messaging_service_sid
-          # @param [String] facebook_messenger_page_id The facebook_messenger_page_id
-          # @param [String] default_apn_notification_protocol_version The
-          #   default_apn_notification_protocol_version
-          # @param [String] default_gcm_notification_protocol_version The
-          #   default_gcm_notification_protocol_version
-          # @param [String] fcm_credential_sid The fcm_credential_sid
-          # @param [String] default_fcm_notification_protocol_version The
-          #   default_fcm_notification_protocol_version
+          # @param [String] friendly_name Human-readable name for this service instance
+          # @param [String] apn_credential_sid The SID of the default Credential to be used
+          #   for APN Bindings
+          # @param [String] gcm_credential_sid The SID of the default Credential to be used
+          #   for GCM Bindings
+          # @param [String] messaging_service_sid The SID of the [Messaging
+          #   Service](https://www.twilio.com/docs/api/rest/sending-messages#messaging-services) to be used for SMS Bindings. In order to send SMS notifications this parameter has to be set.
+          # @param [String] facebook_messenger_page_id The Page ID to be used to send for
+          #   Facebook Messenger Bindings. It has to match the Page ID you configured when you
+          #   [enabled Facebook Messaging](https://www.twilio.com/console/sms/settings) on
+          #   your account. Facebook Messenger integration is in beta. You need to be in the
+          #   beta program to be able to enable Facebook Messaging for your account.
+          # @param [String] default_apn_notification_protocol_version The version of the
+          #   protocol to be used for sending APNS notifications. Can be overriden on a
+          #   Binding by Binding basis when creating a Binding resource.
+          # @param [String] default_gcm_notification_protocol_version The version of the
+          #   protocol to be used for sending GCM notifications. Can be overriden on a Binding
+          #   by Binding basis when creating a Binding resource.
+          # @param [String] fcm_credential_sid The SID of the default Credential to be used
+          #   for FCM Bindings
+          # @param [String] default_fcm_notification_protocol_version The version of the
+          #   protocol to be used for sending FCM notifications. Can be overriden on a Binding
+          #   by Binding basis when creating a Binding resource.
           # @param [Boolean] log_enabled The log_enabled
           # @param [String] alexa_skill_id The alexa_skill_id
           # @param [String] default_alexa_notification_protocol_version The
@@ -413,7 +440,7 @@ module Twilio
           end
 
           ##
-          # @return [String] The friendly_name
+          # @return [String] Human-readable name for this service instance
           def friendly_name
             @properties['friendly_name']
           end
@@ -431,49 +458,49 @@ module Twilio
           end
 
           ##
-          # @return [String] The apn_credential_sid
+          # @return [String] The SID of the Credential to be used for APN Bindings.
           def apn_credential_sid
             @properties['apn_credential_sid']
           end
 
           ##
-          # @return [String] The gcm_credential_sid
+          # @return [String] The SID of the Credential to be used for GCM Bindings.
           def gcm_credential_sid
             @properties['gcm_credential_sid']
           end
 
           ##
-          # @return [String] The fcm_credential_sid
+          # @return [String] The SID of the Credential to be used for FCM Bindings.
           def fcm_credential_sid
             @properties['fcm_credential_sid']
           end
 
           ##
-          # @return [String] The messaging_service_sid
+          # @return [String] The SID of the Messaging Service to be used for SMS Bindings.
           def messaging_service_sid
             @properties['messaging_service_sid']
           end
 
           ##
-          # @return [String] The facebook_messenger_page_id
+          # @return [String] The Page ID to be used to send for Facebook Messenger Bindings.
           def facebook_messenger_page_id
             @properties['facebook_messenger_page_id']
           end
 
           ##
-          # @return [String] The default_apn_notification_protocol_version
+          # @return [String] The version of the protocol to be used for sending APNS notifications.
           def default_apn_notification_protocol_version
             @properties['default_apn_notification_protocol_version']
           end
 
           ##
-          # @return [String] The default_gcm_notification_protocol_version
+          # @return [String] The version of the protocol to be used for sending GCM notifications.
           def default_gcm_notification_protocol_version
             @properties['default_gcm_notification_protocol_version']
           end
 
           ##
-          # @return [String] The default_fcm_notification_protocol_version
+          # @return [String] The version of the protocol to be used for sending FCM notifications.
           def default_fcm_notification_protocol_version
             @properties['default_fcm_notification_protocol_version']
           end
@@ -524,18 +551,29 @@ module Twilio
 
           ##
           # Update the ServiceInstance
-          # @param [String] friendly_name The friendly_name
-          # @param [String] apn_credential_sid The apn_credential_sid
-          # @param [String] gcm_credential_sid The gcm_credential_sid
-          # @param [String] messaging_service_sid The messaging_service_sid
-          # @param [String] facebook_messenger_page_id The facebook_messenger_page_id
-          # @param [String] default_apn_notification_protocol_version The
-          #   default_apn_notification_protocol_version
-          # @param [String] default_gcm_notification_protocol_version The
-          #   default_gcm_notification_protocol_version
-          # @param [String] fcm_credential_sid The fcm_credential_sid
-          # @param [String] default_fcm_notification_protocol_version The
-          #   default_fcm_notification_protocol_version
+          # @param [String] friendly_name Human-readable name for this service instance
+          # @param [String] apn_credential_sid The SID of the default Credential to be used
+          #   for APN Bindings
+          # @param [String] gcm_credential_sid The SID of the default Credential to be used
+          #   for GCM Bindings
+          # @param [String] messaging_service_sid The SID of the [Messaging
+          #   Service](https://www.twilio.com/docs/api/rest/sending-messages#messaging-services) to be used for SMS Bindings. In order to send SMS notifications this parameter has to be set.
+          # @param [String] facebook_messenger_page_id The Page ID to be used to send for
+          #   Facebook Messenger Bindings. It has to match the Page ID you configured when you
+          #   [enabled Facebook Messaging](https://www.twilio.com/console/sms/settings) on
+          #   your account. Facebook Messenger integration is in beta. You need to be in the
+          #   beta program to be able to enable Facebook Messaging for your account.
+          # @param [String] default_apn_notification_protocol_version The version of the
+          #   protocol to be used for sending APNS notifications. Can be overriden on a
+          #   Binding by Binding basis when creating a Binding resource.
+          # @param [String] default_gcm_notification_protocol_version The version of the
+          #   protocol to be used for sending GCM notifications. Can be overriden on a Binding
+          #   by Binding basis when creating a Binding resource.
+          # @param [String] fcm_credential_sid The SID of the default Credential to be used
+          #   for FCM Bindings
+          # @param [String] default_fcm_notification_protocol_version The version of the
+          #   protocol to be used for sending FCM notifications. Can be overriden on a Binding
+          #   by Binding basis when creating a Binding resource.
           # @param [Boolean] log_enabled The log_enabled
           # @param [String] alexa_skill_id The alexa_skill_id
           # @param [String] default_alexa_notification_protocol_version The

data/lib/twilio-ruby/rest/preview/hosted_numbers/authorization_document.rb

@@ -137,8 +137,8 @@ module Twilio
           #   Address resource that is associated with this AuthorizationDocument.
           # @param [String] email Email that this AuthorizationDocument will be sent to for
           #   signing.
-          # @param [String] cc_emails A list of emails that this AuthorizationDocument will
-          #   be carbon copied to.
+          # @param [String] cc_emails Email recipients who will be informed when an
+          #   Authorization Document has been sent and signed.
           # @return [AuthorizationDocumentInstance] Newly created AuthorizationDocumentInstance
           def create(hosted_number_order_sids: nil, address_sid: nil, email: nil, cc_emails: :unset)
             data = Twilio::Values.of({

data/lib/twilio-ruby/rest/preview/marketplace.rb

@@ -15,37 +15,37 @@ module Twilio
         def initialize(domain)
           super
           @version = 'marketplace'
-          @available_add_ons = nil
           @installed_add_ons = nil
+          @available_add_ons = nil
         end
 
         ##
-        # @param [String] sid The Available Add-on Sid that uniquely identifies this
+        # @param [String] sid The Installed Add-on Sid that uniquely identifies this
         #   resource
-        # @return [Twilio::REST::Preview::Marketplace::AvailableAddOnContext] if sid was passed.
-        # @return [Twilio::REST::Preview::Marketplace::AvailableAddOnList]
-        def available_add_ons(sid=:unset)
+        # @return [Twilio::REST::Preview::Marketplace::InstalledAddOnContext] if sid was passed.
+        # @return [Twilio::REST::Preview::Marketplace::InstalledAddOnList]
+        def installed_add_ons(sid=:unset)
           if sid.nil?
             raise ArgumentError, 'sid cannot be nil'
           elsif sid == :unset
-            @available_add_ons ||= AvailableAddOnList.new self
+            @installed_add_ons ||= InstalledAddOnList.new self
           else
-            AvailableAddOnContext.new(self, sid)
+            InstalledAddOnContext.new(self, sid)
           end
         end
 
         ##
-        # @param [String] sid The Installed Add-on Sid that uniquely identifies this
+        # @param [String] sid The Available Add-on Sid that uniquely identifies this
         #   resource
-        # @return [Twilio::REST::Preview::Marketplace::InstalledAddOnContext] if sid was passed.
-        # @return [Twilio::REST::Preview::Marketplace::InstalledAddOnList]
-        def installed_add_ons(sid=:unset)
+        # @return [Twilio::REST::Preview::Marketplace::AvailableAddOnContext] if sid was passed.
+        # @return [Twilio::REST::Preview::Marketplace::AvailableAddOnList]
+        def available_add_ons(sid=:unset)
           if sid.nil?
             raise ArgumentError, 'sid cannot be nil'
           elsif sid == :unset
-            @installed_add_ons ||= InstalledAddOnList.new self
+            @available_add_ons ||= AvailableAddOnList.new self
           else
-            InstalledAddOnContext.new(self, sid)
+            AvailableAddOnContext.new(self, sid)
           end
         end
 

data/lib/twilio-ruby/rest/preview/understand/assistant/field_type/field_value.rb

@@ -18,8 +18,9 @@ module Twilio
               ##
               # Initialize the FieldValueList
               # @param [Version] version Version that contains the resource
-              # @param [String] assistant_sid The assistant_sid
-              # @param [String] field_type_sid The field_type_sid
+              # @param [String] assistant_sid The unique ID of the Assistant.
+              # @param [String] field_type_sid The unique ID of the Field Type associated with
+              #   this Field Value.
               # @return [FieldValueList] FieldValueList
               def initialize(version, assistant_sid: nil, field_type_sid: nil)
                 super(version)
@@ -33,7 +34,8 @@ module Twilio
               # Lists FieldValueInstance records from the API as a list.
               # Unlike stream(), this operation is eager and will load `limit` records into
               # memory before returning.
-              # @param [String] language The language
+              # @param [String] language An ISO language-country string of the value. For
+              #   example: *en-US*
               # @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
@@ -49,7 +51,8 @@ module Twilio
               # Streams FieldValueInstance records from the API as an Enumerable.
               # This operation lazily loads records as efficiently as possible until the limit
               # is reached.
-              # @param [String] language The language
+              # @param [String] language An ISO language-country string of the value. For
+              #   example: *en-US*
               # @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
@@ -82,7 +85,8 @@ module Twilio
               ##
               # Retrieve a single page of FieldValueInstance records from the API.
               # Request is executed immediately.
-              # @param [String] language The language
+              # @param [String] language An ISO language-country string of the value. For
+              #   example: *en-US*
               # @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
@@ -118,8 +122,9 @@ module Twilio
               ##
               # Retrieve a single page of FieldValueInstance records from the API.
               # Request is executed immediately.
-              # @param [String] language The language
-              # @param [String] value The value
+              # @param [String] language An ISO language-country string of the value.
+              # @param [String] value A user-provided string that uniquely identifies this
+              #   resource as an alternative to the sid. Unique up to 64 characters long.
               # @param [String] synonym_of The synonym_of
               # @return [FieldValueInstance] Newly created FieldValueInstance
               def create(language: nil, value: nil, synonym_of: :unset)
@@ -243,8 +248,9 @@ module Twilio
               # Initialize the FieldValueInstance
               # @param [Version] version Version that contains the resource
               # @param [Hash] payload payload that contains response from Twilio
-              # @param [String] assistant_sid The assistant_sid
-              # @param [String] field_type_sid The field_type_sid
+              # @param [String] assistant_sid The unique ID of the Assistant.
+              # @param [String] field_type_sid The unique ID of the Field Type associated with
+              #   this Field Value.
               # @param [String] sid The sid
               # @return [FieldValueInstance] FieldValueInstance
               def initialize(version, payload, assistant_sid: nil, field_type_sid: nil, sid: nil)
@@ -290,43 +296,43 @@ module Twilio
               end
 
               ##
-              # @return [String] The account_sid
+              # @return [String] The unique ID of the Account that created this Field Value.
               def account_sid
                 @properties['account_sid']
               end
 
               ##
-              # @return [Time] The date_created
+              # @return [Time] The date that this resource was created
               def date_created
                 @properties['date_created']
               end
 
               ##
-              # @return [Time] The date_updated
+              # @return [Time] The date that this resource was last updated
               def date_updated
                 @properties['date_updated']
               end
 
               ##
-              # @return [String] The field_type_sid
+              # @return [String] The unique ID of the Field Type associated with this Field Value.
               def field_type_sid
                 @properties['field_type_sid']
               end
 
               ##
-              # @return [String] The language
+              # @return [String] An ISO language-country string of the value.
               def language
                 @properties['language']
               end
 
               ##
-              # @return [String] The assistant_sid
+              # @return [String] The unique ID of the Assistant.
               def assistant_sid
                 @properties['assistant_sid']
               end
 
               ##
-              # @return [String] The sid
+              # @return [String] A 34 character string that uniquely identifies this resource.
               def sid
                 @properties['sid']
               end

data/lib/twilio-ruby/rest/preview/understand/assistant/field_type.rb

@@ -17,7 +17,7 @@ module Twilio
             ##
             # Initialize the FieldTypeList
             # @param [Version] version Version that contains the resource
-            # @param [String] assistant_sid The assistant_sid
+            # @param [String] assistant_sid The unique ID of the Assistant.
             # @return [FieldTypeList] FieldTypeList
             def initialize(version, assistant_sid: nil)
               super(version)
@@ -112,8 +112,10 @@ module Twilio
             ##
             # Retrieve a single page of FieldTypeInstance records from the API.
             # Request is executed immediately.
-            # @param [String] unique_name The unique_name
-            # @param [String] friendly_name The friendly_name
+            # @param [String] unique_name A user-provided string that uniquely identifies this
+            #   resource as an alternative to the sid. Unique up to 64 characters long.
+            # @param [String] friendly_name A user-provided string that identifies this
+            #   resource. It is non-unique and can up to 255 characters long.
             # @return [FieldTypeInstance] Newly created FieldTypeInstance
             def create(unique_name: nil, friendly_name: :unset)
               data = Twilio::Values.of({'UniqueName' => unique_name, 'FriendlyName' => friendly_name, })
@@ -207,8 +209,10 @@ module Twilio
 
             ##
             # Update the FieldTypeInstance
-            # @param [String] friendly_name The friendly_name
-            # @param [String] unique_name The unique_name
+            # @param [String] friendly_name A user-provided string that identifies this
+            #   resource. It is non-unique and can up to 255 characters long.
+            # @param [String] unique_name A user-provided string that uniquely identifies this
+            #   resource as an alternative to the sid. Unique up to 64 characters long.
             # @return [FieldTypeInstance] Updated FieldTypeInstance
             def update(friendly_name: :unset, unique_name: :unset)
               data = Twilio::Values.of({'FriendlyName' => friendly_name, 'UniqueName' => unique_name, })
@@ -271,7 +275,7 @@ module Twilio
             # Initialize the FieldTypeInstance
             # @param [Version] version Version that contains the resource
             # @param [Hash] payload payload that contains response from Twilio
-            # @param [String] assistant_sid The assistant_sid
+            # @param [String] assistant_sid The unique ID of the Assistant.
             # @param [String] sid The sid
             # @return [FieldTypeInstance] FieldTypeInstance
             def initialize(version, payload, assistant_sid: nil, sid: nil)
@@ -307,25 +311,25 @@ module Twilio
             end
 
             ##
-            # @return [String] The account_sid
+            # @return [String] The unique ID of the Account that created this Field Type.
             def account_sid
               @properties['account_sid']
             end
 
             ##
-            # @return [Time] The date_created
+            # @return [Time] The date that this resource was created
             def date_created
               @properties['date_created']
             end
 
             ##
-            # @return [Time] The date_updated
+            # @return [Time] The date that this resource was last updated
             def date_updated
               @properties['date_updated']
             end
 
             ##
-            # @return [String] The friendly_name
+            # @return [String] A user-provided string that identifies this resource. It is non-unique and can up to 255 characters long.
             def friendly_name
               @properties['friendly_name']
             end
@@ -337,19 +341,19 @@ module Twilio
             end
 
             ##
-            # @return [String] The assistant_sid
+            # @return [String] The unique ID of the Assistant.
             def assistant_sid
               @properties['assistant_sid']
             end
 
             ##
-            # @return [String] The sid
+            # @return [String] A 34 character string that uniquely identifies this resource.
             def sid
               @properties['sid']
             end
 
             ##
-            # @return [String] The unique_name
+            # @return [String] A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long.
             def unique_name
               @properties['unique_name']
             end
@@ -369,8 +373,10 @@ module Twilio
 
             ##
             # Update the FieldTypeInstance
-            # @param [String] friendly_name The friendly_name
-            # @param [String] unique_name The unique_name
+            # @param [String] friendly_name A user-provided string that identifies this
+            #   resource. It is non-unique and can up to 255 characters long.
+            # @param [String] unique_name A user-provided string that uniquely identifies this
+            #   resource as an alternative to the sid. Unique up to 64 characters long.
             # @return [FieldTypeInstance] Updated FieldTypeInstance
             def update(friendly_name: :unset, unique_name: :unset)
               context.update(friendly_name: friendly_name, unique_name: unique_name, )