twilio-ruby 7.7.2 → 7.8.1

data/lib/twilio-ruby/rest/intelligence/v2/transcript/encrypted_sentences.rb

@@ -0,0 +1,217 @@
+##
+#    This code was generated by
+#    ___ _ _ _ _ _    _ ____    ____ ____ _    ____ ____ _  _ ____ ____ ____ ___ __   __
+#     |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
+#     |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
+#
+#    Twilio - Intelligence
+#    This is the public Twilio REST API.
+#
+#    NOTE: This class is auto generated by OpenAPI Generator.
+#    https://openapi-generator.tech
+#    Do not edit the class manually.
+#
+
+
+module Twilio
+    module REST
+        class Intelligence < IntelligenceBase
+            class V2 < Version
+                class TranscriptContext < InstanceContext
+
+                     class EncryptedSentencesList < ListResource
+                
+                    ##
+                    # Initialize the EncryptedSentencesList
+                    # @param [Version] version Version that contains the resource
+                    # @return [EncryptedSentencesList] EncryptedSentencesList
+                    def initialize(version, transcript_sid: nil)
+                        super(version)
+                        # Path Solution
+                        @solution = { transcript_sid: transcript_sid }
+                        
+                        
+                    end
+                
+
+
+                    # Provide a user friendly representation
+                    def to_s
+                        '#<Twilio.Intelligence.V2.EncryptedSentencesList>'
+                    end
+                end
+
+
+                class EncryptedSentencesContext < InstanceContext
+                    ##
+                    # Initialize the EncryptedSentencesContext
+                    # @param [Version] version Version that contains the resource
+                    # @param [String] transcript_sid The unique SID identifier of the Transcript.
+                    # @return [EncryptedSentencesContext] EncryptedSentencesContext
+                    def initialize(version, transcript_sid)
+                        super(version)
+
+                        # Path Solution
+                        @solution = { transcript_sid: transcript_sid,  }
+                        @uri = "/Transcripts/#{@solution[:transcript_sid]}/Sentences/Encrypted"
+
+                        
+                    end
+                    ##
+                    # Fetch the EncryptedSentencesInstance
+                    # @param [Boolean] redacted Grant access to PII Redacted/Unredacted Sentences. If redaction is enabled, the default is `true` to access redacted sentences.
+                    # @return [EncryptedSentencesInstance] Fetched EncryptedSentencesInstance
+                    def fetch(
+                        redacted: :unset
+                    )
+
+                        params = Twilio::Values.of({
+                            'Redacted' => redacted,
+                        })
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        payload = @version.fetch('GET', @uri, params: params, headers: headers)
+                        EncryptedSentencesInstance.new(
+                            @version,
+                            payload,
+                            transcript_sid: @solution[:transcript_sid],
+                        )
+                    end
+
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
+                        "#<Twilio.Intelligence.V2.EncryptedSentencesContext #{context}>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
+                        "#<Twilio.Intelligence.V2.EncryptedSentencesContext #{context}>"
+                    end
+                end
+
+                class EncryptedSentencesPage < Page
+                    ##
+                    # Initialize the EncryptedSentencesPage
+                    # @param [Version] version Version that contains the resource
+                    # @param [Response] response Response from the API
+                    # @param [Hash] solution Path solution for the resource
+                    # @return [EncryptedSentencesPage] EncryptedSentencesPage
+                    def initialize(version, response, solution)
+                        super(version, response)
+
+                        # Path Solution
+                        @solution = solution
+                    end
+
+                    ##
+                    # Build an instance of EncryptedSentencesInstance
+                    # @param [Hash] payload Payload response from the API
+                    # @return [EncryptedSentencesInstance] EncryptedSentencesInstance
+                    def get_instance(payload)
+                        EncryptedSentencesInstance.new(@version, payload, transcript_sid: @solution[:transcript_sid])
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        '<Twilio.Intelligence.V2.EncryptedSentencesPage>'
+                    end
+                end
+                class EncryptedSentencesInstance < InstanceResource
+                    ##
+                    # Initialize the EncryptedSentencesInstance
+                    # @param [Version] version Version that contains the resource
+                    # @param [Hash] payload payload that contains response from Twilio
+                    # @param [String] account_sid The SID of the
+                    #   {Account}[https://www.twilio.com/docs/iam/api/account] that created this EncryptedSentences
+                    #   resource.
+                    # @param [String] sid The SID of the Call resource to fetch.
+                    # @return [EncryptedSentencesInstance] EncryptedSentencesInstance
+                    def initialize(version, payload , transcript_sid: nil)
+                        super(version)
+                        
+                        # Marshaled Properties
+                        @properties = { 
+                            'location' => payload['location'],
+                            'transcript_sid' => payload['transcript_sid'],
+                            'url' => payload['url'],
+                        }
+
+                        # Context
+                        @instance_context = nil
+                        @params = { 'transcript_sid' => transcript_sid  || @properties['transcript_sid']  , }
+                    end
+
+                    ##
+                    # Generate an instance context for the instance, the context is capable of
+                    # performing various actions.  All instance actions are proxied to the context
+                    # @return [EncryptedSentencesContext] CallContext for this CallInstance
+                    def context
+                        unless @instance_context
+                            @instance_context = EncryptedSentencesContext.new(@version , @params['transcript_sid'])
+                        end
+                        @instance_context
+                    end
+                    
+                    ##
+                    # @return [String] The location of the encrypted sentences.
+                    def location
+                        @properties['location']
+                    end
+                    
+                    ##
+                    # @return [String] 
+                    def transcript_sid
+                        @properties['transcript_sid']
+                    end
+                    
+                    ##
+                    # @return [String] 
+                    def url
+                        @properties['url']
+                    end
+                    
+                    ##
+                    # Fetch the EncryptedSentencesInstance
+                    # @param [Boolean] redacted Grant access to PII Redacted/Unredacted Sentences. If redaction is enabled, the default is `true` to access redacted sentences.
+                    # @return [EncryptedSentencesInstance] Fetched EncryptedSentencesInstance
+                    def fetch(
+                        redacted: :unset
+                    )
+
+                        context.fetch(
+                            redacted: redacted, 
+                        )
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+                        "<Twilio.Intelligence.V2.EncryptedSentencesInstance #{values}>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+                        "<Twilio.Intelligence.V2.EncryptedSentencesInstance #{values}>"
+                    end
+                end
+
+             end
+            end
+        end
+    end
+end
+
+

data/lib/twilio-ruby/rest/intelligence/v2/transcript.rb

@@ -224,7 +224,9 @@ module Twilio
 
                         # Dependents
                         @sentences = nil
+                        @encrypted_sentences = nil
                         @media = nil
+                        @encrypted_operator_results = nil
                         @operator_results = nil
                     end
                     ##
@@ -270,6 +272,16 @@ module Twilio
                       @sentences
                     end
                     ##
+                    # Access the encrypted_sentences
+                    # @return [EncryptedSentencesList]
+                    # @return [EncryptedSentencesContext]
+                    def encrypted_sentences
+                        EncryptedSentencesContext.new(
+                                @version,
+                                @solution[:sid]
+                                )
+                    end
+                    ##
                     # Access the media
                     # @return [MediaList]
                     # @return [MediaContext]
@@ -280,6 +292,16 @@ module Twilio
                                 )
                     end
                     ##
+                    # Access the encrypted_operator_results
+                    # @return [EncryptedOperatorResultsList]
+                    # @return [EncryptedOperatorResultsContext]
+                    def encrypted_operator_results
+                        EncryptedOperatorResultsContext.new(
+                                @version,
+                                @solution[:sid]
+                                )
+                    end
+                    ##
                     # Access the operator_results
                     # @return [OperatorResultList]
                     # @return [OperatorResultContext] if sid was passed.
@@ -371,6 +393,7 @@ module Twilio
                             'duration' => payload['duration'] == nil ? payload['duration'] : payload['duration'].to_i,
                             'url' => payload['url'],
                             'redaction' => payload['redaction'],
+                            'encryption_credential_sid' => payload['encryption_credential_sid'],
                             'links' => payload['links'],
                         }
 
@@ -474,6 +497,12 @@ module Twilio
                         @properties['redaction']
                     end
                     
+                    ##
+                    # @return [String] The unique SID identifier of the Public Key resource used to encrypt the sentences and operator results.
+                    def encryption_credential_sid
+                        @properties['encryption_credential_sid']
+                    end
+                    
                     ##
                     # @return [Hash] 
                     def links
@@ -503,6 +532,13 @@ module Twilio
                         context.sentences
                     end
 
+                    ##
+                    # Access the encrypted_sentences
+                    # @return [encrypted_sentences] encrypted_sentences
+                    def encrypted_sentences
+                        context.encrypted_sentences
+                    end
+
                     ##
                     # Access the media
                     # @return [media] media
@@ -510,6 +546,13 @@ module Twilio
                         context.media
                     end
 
+                    ##
+                    # Access the encrypted_operator_results
+                    # @return [encrypted_operator_results] encrypted_operator_results
+                    def encrypted_operator_results
+                        context.encrypted_operator_results
+                    end
+
                     ##
                     # Access the operator_results
                     # @return [operator_results] operator_results

data/lib/twilio-ruby/rest/messaging/v2/channels_sender.rb

@@ -20,19 +20,19 @@ module Twilio
                 class ChannelsSenderList < ListResource
                 
                     class MessagingV2ChannelsSenderProfile
-                            # @param [name]: [String] The name of the sender.
-                            # @param [about]: [String] The about text of the sender.
+                            # @param [name]: [String] The name of the sender. Required for WhatsApp senders and must follow [Meta's display name guidelines](https://www.facebook.com/business/help/757569725593362).
+                            # @param [about]: [String] The profile about text for the sender.
                             # @param [address]: [String] The address of the sender.
                             # @param [description]: [String] The description of the sender.
                             # @param [logo_url]: [String] The logo URL of the sender.
                             # @param [banner_url]: [String] The banner URL of the sender.
-                            # @param [privacy_url]: [String] The privacy URL of the sender. Publicly accessible URI associated with the Sender, must use the HTTP or HTTPS protocol 
+                            # @param [privacy_url]: [String] The privacy URL of the sender. Must be a publicly accessible HTTP or HTTPS URI associated with the sender. 
                             # @param [terms_of_service_url]: [String] The terms of service URL of the sender.
-                            # @param [accent_color]: [String] string - Color theme of the Sender (required, in hex format, need to be a minimum 4.5:1 contrast ratio relative to white) 
-                            # @param [vertical]: [String] The vertical of the sender. Allowed values are: - \"Automotive\" - \"Beauty, Spa and Salon\" - \"Clothing and Apparel\" - \"Education\" - \"Entertainment\" - \"Event Planning and Service\" - \"Finance and Banking\" - \"Food and Grocery\" - \"Public Service\" - \"Hotel and Lodging\" - \"Medical and Health\" - \"Non-profit\" - \"Professional Services\" - \"Shopping and Retail\" - \"Travel and Transportation\" - \"Restaurant\" - \"Other\" 
-                            # @param [websites]: [Hash] The websites of the sender
-                            # @param [emails]: [Hash] The emails of the sender
-                            # @param [phone_numbers]: [Hash] The phone numbers of the sender
+                            # @param [accent_color]: [String] The color theme of the sender. Must be in hex format and have at least a 4:5:1 contrast ratio against white.
+                            # @param [vertical]: [String] The vertical of the sender. Allowed values are: - `Automotive` - `Beauty, Spa and Salon` - `Clothing and Apparel` - `Education` - `Entertainment` - `Event Planning and Service` - `Finance and Banking` - `Food and Grocery` - `Public Service` - `Hotel and Lodging` - `Medical and Health` - `Non-profit` - `Professional Services` - `Shopping and Retail` - `Travel and Transportation` - `Restaurant` - `Other` 
+                            # @param [websites]: [Hash] The websites of the sender.
+                            # @param [emails]: [Hash] The emails of the sender.
+                            # @param [phone_numbers]: [Hash] The phone numbers of the sender.
                         attr_accessor :name, :about, :address, :description, :logo_url, :banner_url, :privacy_url, :terms_of_service_url, :accent_color, :vertical, :websites, :emails, :phone_numbers
                         def initialize(payload)
                                 @name = payload["name"]
@@ -117,7 +117,7 @@ module Twilio
                     end
 
                     class MessagingV2ChannelsSenderRequestsCreate
-                            # @param [sender_id]: [String] The ID of this Sender prefixed with the channel, e.g., `whatsapp:E.164`
+                            # @param [sender_id]: [String] The ID of the sender in `whatsapp:<E.164_PHONE_NUMBER>` format.
                             # @param [configuration]: [ChannelsSenderList.MessagingV2ChannelsSenderConfiguration] 
                             # @param [webhook]: [ChannelsSenderList.MessagingV2ChannelsSenderWebhook] 
                             # @param [profile]: [ChannelsSenderList.MessagingV2ChannelsSenderProfile] 
@@ -158,7 +158,7 @@ module Twilio
                     end
 
                     class MessagingV2RcsCarrier
-                            # @param [name]: [String] carrier in a country e.g. For US-Verizon, AT&T 
+                            # @param [name]: [String] The name of the carrier. For example, `Verizon` or `AT&T` for US.
                             # @param [status]: [MessagingV2RcsCarrierStatus] 
                         attr_accessor :name, :status
                         def initialize(payload)
@@ -174,8 +174,8 @@ module Twilio
                     end
 
                     class MessagingV2RcsComplianceCountryResponse
-                            # @param [country]: [String] ISO 3166-1 alpha-2 country code (e.g., 'US', 'UK').
-                            # @param [registration_sid]: [String] The default compliance registration SID (e.g., from CR-Google) that applies to all countries  unless overridden within the `countries` array. 
+                            # @param [country]: [String] The ISO 3166-1 alpha-2 country code.
+                            # @param [registration_sid]: [String] The default compliance registration SID (e.g., from CR-Google) that applies to all countries unless overridden in the `countries` array. 
                             # @param [status]: [MessagingV2RcsCountryStatus] 
                             # @param [carriers]: [Array<MessagingV2RcsCarrier>] 
                         attr_accessor :country, :registration_sid, :status, :carriers
@@ -197,19 +197,19 @@ module Twilio
 
 
                     class MessagingV2ChannelsSenderProfile
-                            # @param [name]: [String] The name of the sender.
-                            # @param [about]: [String] The about text of the sender.
+                            # @param [name]: [String] The name of the sender. Required for WhatsApp senders and must follow [Meta's display name guidelines](https://www.facebook.com/business/help/757569725593362).
+                            # @param [about]: [String] The profile about text for the sender.
                             # @param [address]: [String] The address of the sender.
                             # @param [description]: [String] The description of the sender.
                             # @param [logo_url]: [String] The logo URL of the sender.
                             # @param [banner_url]: [String] The banner URL of the sender.
-                            # @param [privacy_url]: [String] The privacy URL of the sender. Publicly accessible URI associated with the Sender, must use the HTTP or HTTPS protocol 
+                            # @param [privacy_url]: [String] The privacy URL of the sender. Must be a publicly accessible HTTP or HTTPS URI associated with the sender. 
                             # @param [terms_of_service_url]: [String] The terms of service URL of the sender.
-                            # @param [accent_color]: [String] string - Color theme of the Sender (required, in hex format, need to be a minimum 4.5:1 contrast ratio relative to white) 
-                            # @param [vertical]: [String] The vertical of the sender. Allowed values are: - \"Automotive\" - \"Beauty, Spa and Salon\" - \"Clothing and Apparel\" - \"Education\" - \"Entertainment\" - \"Event Planning and Service\" - \"Finance and Banking\" - \"Food and Grocery\" - \"Public Service\" - \"Hotel and Lodging\" - \"Medical and Health\" - \"Non-profit\" - \"Professional Services\" - \"Shopping and Retail\" - \"Travel and Transportation\" - \"Restaurant\" - \"Other\" 
-                            # @param [websites]: [Hash] The websites of the sender
-                            # @param [emails]: [Hash] The emails of the sender
-                            # @param [phone_numbers]: [Hash] The phone numbers of the sender
+                            # @param [accent_color]: [String] The color theme of the sender. Must be in hex format and have at least a 4:5:1 contrast ratio against white.
+                            # @param [vertical]: [String] The vertical of the sender. Allowed values are: - `Automotive` - `Beauty, Spa and Salon` - `Clothing and Apparel` - `Education` - `Entertainment` - `Event Planning and Service` - `Finance and Banking` - `Food and Grocery` - `Public Service` - `Hotel and Lodging` - `Medical and Health` - `Non-profit` - `Professional Services` - `Shopping and Retail` - `Travel and Transportation` - `Restaurant` - `Other` 
+                            # @param [websites]: [Hash] The websites of the sender.
+                            # @param [emails]: [Hash] The emails of the sender.
+                            # @param [phone_numbers]: [Hash] The phone numbers of the sender.
                         attr_accessor :name, :about, :address, :description, :logo_url, :banner_url, :privacy_url, :terms_of_service_url, :accent_color, :vertical, :websites, :emails, :phone_numbers
                         def initialize(payload)
                                 @name = payload["name"]
@@ -294,7 +294,7 @@ module Twilio
                     end
 
                     class MessagingV2ChannelsSenderRequestsCreate
-                            # @param [sender_id]: [String] The ID of this Sender prefixed with the channel, e.g., `whatsapp:E.164`
+                            # @param [sender_id]: [String] The ID of the sender in `whatsapp:<E.164_PHONE_NUMBER>` format.
                             # @param [configuration]: [ChannelsSenderList.MessagingV2ChannelsSenderConfiguration] 
                             # @param [webhook]: [ChannelsSenderList.MessagingV2ChannelsSenderWebhook] 
                             # @param [profile]: [ChannelsSenderList.MessagingV2ChannelsSenderProfile] 
@@ -335,7 +335,7 @@ module Twilio
                     end
 
                     class MessagingV2RcsCarrier
-                            # @param [name]: [String] carrier in a country e.g. For US-Verizon, AT&T 
+                            # @param [name]: [String] The name of the carrier. For example, `Verizon` or `AT&T` for US.
                             # @param [status]: [MessagingV2RcsCarrierStatus] 
                         attr_accessor :name, :status
                         def initialize(payload)
@@ -351,8 +351,8 @@ module Twilio
                     end
 
                     class MessagingV2RcsComplianceCountryResponse
-                            # @param [country]: [String] ISO 3166-1 alpha-2 country code (e.g., 'US', 'UK').
-                            # @param [registration_sid]: [String] The default compliance registration SID (e.g., from CR-Google) that applies to all countries  unless overridden within the `countries` array. 
+                            # @param [country]: [String] The ISO 3166-1 alpha-2 country code.
+                            # @param [registration_sid]: [String] The default compliance registration SID (e.g., from CR-Google) that applies to all countries unless overridden in the `countries` array. 
                             # @param [status]: [MessagingV2RcsCountryStatus] 
                             # @param [carriers]: [Array<MessagingV2RcsCarrier>] 
                         attr_accessor :country, :registration_sid, :status, :carriers
@@ -511,7 +511,7 @@ module Twilio
                     ##
                     # Initialize the ChannelsSenderContext
                     # @param [Version] version Version that contains the resource
-                    # @param [String] sid A 34 character string that uniquely identifies this Sender.
+                    # @param [String] sid The SID of the sender.
                     # @return [ChannelsSenderContext] ChannelsSenderContext
                     def initialize(version, sid)
                         super(version)
@@ -662,7 +662,7 @@ module Twilio
                     end
                     
                     ##
-                    # @return [String] A 34 character string that uniquely identifies this Sender.
+                    # @return [String] The SID of the sender.
                     def sid
                         @properties['sid']
                     end
@@ -674,7 +674,7 @@ module Twilio
                     end
                     
                     ##
-                    # @return [String] The ID of this Sender prefixed with the channel, e.g., `whatsapp:E.164`
+                    # @return [String] The ID of the sender in `whatsapp:<E.164_PHONE_NUMBER>` format.
                     def sender_id
                         @properties['sender_id']
                     end
@@ -704,7 +704,7 @@ module Twilio
                     end
                     
                     ##
-                    # @return [Array<MessagingV2ChannelsSenderOfflineReasonsItems>] Reasons why the sender is offline., e.g., [{\"code\": \"21211400\", \"message\": \"Whatsapp business account is banned by provider {provider_name} | Credit line is assigned to another BSP\", \"more_info\": \"https://www.twilio.com/docs/errors/21211400\"}]
+                    # @return [Array<MessagingV2ChannelsSenderOfflineReasonsItems>] The reasons why the sender is offline.
                     def offline_reasons
                         @properties['offline_reasons']
                     end
@@ -716,7 +716,7 @@ module Twilio
                     end
                     
                     ##
-                    # @return [String] The URL of this resource, relative to `https://messaging.twilio.com`.
+                    # @return [String] The URL of the resource.
                     def url
                         @properties['url']
                     end

data/lib/twilio-ruby/rest/messaging/v2.rb

@@ -25,7 +25,7 @@ module Twilio
                 end
 
                 ##
-                # @param [String] sid A 34 character string that uniquely identifies this Sender.
+                # @param [String] sid The SID of the sender.
                 # @return [Twilio::REST::Messaging::V2::ChannelsSenderContext] if sid was passed.
                 # @return [Twilio::REST::Messaging::V2::ChannelsSenderList]
                 def channels_senders(sid=:unset)

data/lib/twilio-ruby/rest/numbers/v1/porting_port_in.rb

@@ -223,19 +223,19 @@ module Twilio
                     end
                     
                     ##
-                    # @return [Date] Target date to port the number. We cannot guarantee that this date will be honored by the other carriers, please work with Ops to get a confirmation of the firm order commitment (FOC) date. Expected format is ISO Local Date, example: ‘2011-12-03`. This date must be at least 7 days in the future for US ports and 10 days in the future for Japanese ports. We can't guarantee the exact date and time, as this depends on the losing carrier
+                    # @return [Date] Target date to port the number. We cannot guarantee that this date will be honored by the other carriers, please work with Ops to get a confirmation of the firm order commitment (FOC) date. Expected format is ISO Local Date, example: ‘2011-12-03`. This date must be at least 7 days in the future for US ports and 10 days in the future for Japanese ports. If a start and end range is provided, the date will be converted to its UTC equivalent with the ranges as reference and stored in UTC. We can't guarantee the exact date and time, as this depends on the losing carrier.
                     def target_port_in_date
                         @properties['target_port_in_date']
                     end
                     
                     ##
-                    # @return [String] The earliest time that the port should occur on the target port in date. Expected format is ISO Offset Time, example: ‘10:15:00-08:00'. We can't guarantee the exact date and time, as this depends on the losing carrier
+                    # @return [String] The earliest time that the port should occur on the target port in date. Expected format is ISO Offset Time, example: ‘10:15:00-08:00'. We can't guarantee the exact date and time, as this depends on the losing carrier. The time will be stored and returned as UTC standard timezone.
                     def target_port_in_time_range_start
                         @properties['target_port_in_time_range_start']
                     end
                     
                     ##
-                    # @return [String] The latest time that the port should occur on the target port in date. Expected format is ISO Offset Time, example: ‘10:15:00-08:00'. We can't guarantee the exact date and time, as this depends on the losing carrier
+                    # @return [String] The latest time that the port should occur on the target port in date. Expected format is ISO Offset Time, example: ‘10:15:00-08:00'. We can't guarantee the exact date and time, as this depends on the losing carrier. The time will be stored and returned as UTC standard timezone.
                     def target_port_in_time_range_end
                         @properties['target_port_in_time_range_end']
                     end