composition_settings.rb in twilio-ruby-5.27.1

- old
+ new

@@ -93,23 +93,23 @@
           end
 
           ##
           # Retrieve a single page of CompositionSettingsInstance records from the API.
           # Request is executed immediately.
-          # @param [String] friendly_name Friendly name of the configuration to be shown in
-          #   the console
-          # @param [String] aws_credentials_sid SID of the Stored Credential resource `CRxx`
-          # @param [String] encryption_key_sid SID of the Public Key resource `CRxx`
-          # @param [String] aws_s3_url Identity of the external location where the
-          #   compositions should be stored. We only support DNS-compliant URLs like
-          #   `http://<my-bucket>.s3-<aws-region>.amazonaws.com/compositions`,  where
-          #   `compositions` is the path where you want compositions to be stored.
-          # @param [Boolean] aws_storage_enabled `true|false` When set to `true`, all
-          #   Compositions will be written to the `AwsS3Url` specified above. When set to
-          #   `false`, all Compositions will be stored in Twilio's cloud.
-          # @param [Boolean] encryption_enabled `true|false` When set to `true`, all
-          #   Compositions will be stored encrypted. Dafault value is `false`
+          # @param [String] friendly_name A descriptive string that you create to describe
+          #   the resource and show to the user in the console
+          # @param [String] aws_credentials_sid The SID of the stored Credential resource.
+          # @param [String] encryption_key_sid The SID of the Public Key resource to use for
+          #   encryption.
+          # @param [String] aws_s3_url The URL of the AWS S3 bucket where the compositions
+          #   should be stored. We only support DNS-compliant URLs like
+          #   `http://<my-bucket>.s3-<aws-region>.amazonaws.com/compositions`, where
+          #   `compositions` is the path in which you want the compositions to be stored.
+          # @param [Boolean] aws_storage_enabled Whether all compositions should be written
+          #   to the `aws_s3_url`. When `false`, all compositions are stored in our cloud.
+          # @param [Boolean] encryption_enabled Whether all compositions should be stored in
+          #   an encrypted form. The default is `false`.
           # @return [CompositionSettingsInstance] Newly created CompositionSettingsInstance
           def create(friendly_name: nil, aws_credentials_sid: :unset, encryption_key_sid: :unset, aws_s3_url: :unset, aws_storage_enabled: :unset, encryption_enabled: :unset)
             data = Twilio::Values.of({
                 'FriendlyName' => friendly_name,
                 'AwsCredentialsSid' => aws_credentials_sid,
@@ -181,53 +181,53 @@
             end
             @instance_context
           end
 
           ##
-          # @return [String] The Twilio Account SID associated with this item
+          # @return [String] The SID of the Account that created the resource
           def account_sid
             @properties['account_sid']
           end
 
           ##
-          # @return [String] Friendly name of the configuration to be shown in the console
+          # @return [String] The string that you assigned to describe the resource
           def friendly_name
             @properties['friendly_name']
           end
 
           ##
-          # @return [String] SID of the Stored Credential resource CRxx
+          # @return [String] The SID of the stored Credential resource
           def aws_credentials_sid
             @properties['aws_credentials_sid']
           end
 
           ##
-          # @return [String] URL of the S3 bucket where the compositions should be stored. We only support DNS-compliant URLs like http://<my-bucket>.s3-<aws-region>.amazonaws.com/compositions, where compositions is the path where you want compositions to be stored.
+          # @return [String] The URL of the AWS S3 bucket where the compositions are stored
           def aws_s3_url
             @properties['aws_s3_url']
           end
 
           ##
-          # @return [Boolean] true|false When set to true, all Compositions will be written to the AwsS3Url specified above. When set to false, all Compositions will be stored in Twilio's cloud.
+          # @return [Boolean] Whether all compositions are written to the aws_s3_url
           def aws_storage_enabled
             @properties['aws_storage_enabled']
           end
 
           ##
-          # @return [String] SID of the Public Key resource CRxx
+          # @return [String] The SID of the Public Key resource used for encryption
           def encryption_key_sid
             @properties['encryption_key_sid']
           end
 
           ##
-          # @return [Boolean] true|false When set to true, all Compositions will be stored encrypted.
+          # @return [Boolean] Whether all compositions are stored in an encrypted form
           def encryption_enabled
             @properties['encryption_enabled']
           end
 
           ##
-          # @return [String] The url
+          # @return [String] The absolute URL of the resource
           def url
             @properties['url']
           end
 
           ##
@@ -238,22 +238,22 @@
           end
 
           ##
           # Retrieve a single page of CompositionSettingsInstance records from the API.
           # Request is executed immediately.
-          # @param [String] friendly_name Friendly name of the configuration to be shown in
-          #   the console
-          # @param [String] aws_credentials_sid SID of the Stored Credential resource `CRxx`
-          # @param [String] encryption_key_sid SID of the Public Key resource `CRxx`
-          # @param [String] aws_s3_url Identity of the external location where the
-          #   compositions should be stored. We only support DNS-compliant URLs like
-          #   `http://<my-bucket>.s3-<aws-region>.amazonaws.com/compositions`,  where
-          #   `compositions` is the path where you want compositions to be stored.
-          # @param [Boolean] aws_storage_enabled `true|false` When set to `true`, all
-          #   Compositions will be written to the `AwsS3Url` specified above. When set to
-          #   `false`, all Compositions will be stored in Twilio's cloud.
-          # @param [Boolean] encryption_enabled `true|false` When set to `true`, all
-          #   Compositions will be stored encrypted. Dafault value is `false`
+          # @param [String] friendly_name A descriptive string that you create to describe
+          #   the resource and show to the user in the console
+          # @param [String] aws_credentials_sid The SID of the stored Credential resource.
+          # @param [String] encryption_key_sid The SID of the Public Key resource to use for
+          #   encryption.
+          # @param [String] aws_s3_url The URL of the AWS S3 bucket where the compositions
+          #   should be stored. We only support DNS-compliant URLs like
+          #   `http://<my-bucket>.s3-<aws-region>.amazonaws.com/compositions`, where
+          #   `compositions` is the path in which you want the compositions to be stored.
+          # @param [Boolean] aws_storage_enabled Whether all compositions should be written
+          #   to the `aws_s3_url`. When `false`, all compositions are stored in our cloud.
+          # @param [Boolean] encryption_enabled Whether all compositions should be stored in
+          #   an encrypted form. The default is `false`.
           # @return [CompositionSettingsInstance] Newly created CompositionSettingsInstance
           def create(friendly_name: nil, aws_credentials_sid: :unset, encryption_key_sid: :unset, aws_s3_url: :unset, aws_storage_enabled: :unset, encryption_enabled: :unset)
             context.create(
                 friendly_name: friendly_name,
                 aws_credentials_sid: aws_credentials_sid,
\ No newline at end of file