twilio-ruby 5.67.2 → 5.69.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 35111efb3cd1c98d7e45570f3e4f0290d9b7c0dc
-  data.tar.gz: c4a245a46eb0f17fee275083b9762782049cad42
+  metadata.gz: 8dfd0266c044e0696ec36adbe6b650a715bb222c
+  data.tar.gz: 72cdf92cb46568d1b314f2ae67c1d96f9129d0ef
 SHA512:
-  metadata.gz: 3c72bd52e4a6529b2cce7ce38e13a20377ddf4f4f97f449cdaee564b256f7eb9da052f64d62fa3b711e566571ac26cfa1be7e063d76453964c47258950d279b4
-  data.tar.gz: d1774e844540e03939d8a2849c9f2971fc71607dd881d69046d90a12c80e91a328206dddd35099a922aec2282c328c127e92a0156a00306f085582faf1f15ac1
+  metadata.gz: e18aee13b94d15e4a19b152d0c730caf8c7ea176e3ab422584a938e7934f415a868e8b592334fab20ccd8d927e6db0dd476d759c95ea0aa035c64658fe33bf9e
+  data.tar.gz: e482fefb1d0b50b0f7c3b79f829b5c3f899efede7dd85b0b0c10b7ba375efa7a7b4545367d1635e54356c0de6219a6080458dee1cb1fea358b0da8a3b00a204b

data/.github/workflows/pr-lint.yml

@@ -10,6 +10,6 @@ jobs:
     steps:
       - uses: amannn/action-semantic-pull-request@v4
         with:
-          types: chore docs fix feat test
+          types: chore docs fix feat test misc
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

data/CHANGES.md

@@ -1,6 +1,59 @@
 twilio-ruby changelog
 =====================
 
+[2022-07-13] Version 5.69.0
+---------------------------
+**Library - Fix**
+- [PR #612](https://github.com/twilio/twilio-ruby/pull/612): useragent regrex unit test for RC branch. Thanks to [@claudiachua](https://github.com/claudiachua)!
+
+**Library - Test**
+- [PR #610](https://github.com/twilio/twilio-ruby/pull/610): Adding misc as PR type. Thanks to [@rakatyal](https://github.com/rakatyal)!
+
+**Conversations**
+- Allowed to use `identity` as part of Participant's resource **(breaking change)**
+
+**Lookups**
+- Remove `enhanced_line_type` from the lookup response **(breaking change)**
+
+**Supersim**
+- Add support for `sim_ip_addresses` resource to helper libraries
+
+**Verify**
+- Changed summary param `service_sid` to `verify_service_sid` to be consistent with list attempts API **(breaking change)**
+- Make `code` optional on Verification check to support `sna` attempts.
+
+
+[2022-06-29] Version 5.68.0
+---------------------------
+**Api**
+- Added `amazon-polly` to `usage_record` API.
+
+**Insights**
+- Added `annotation` field in call summary
+- Added new endpoint to fetch/create/update Call Annotations
+
+**Verify**
+- Remove `api.verify.totp` beta flag and set maturity to `beta` for Verify TOTP properties and parameters. **(breaking change)**
+- Changed summary param `verify_service_sid` to `service_sid` to be consistent with list attempts API **(breaking change)**
+
+**Twiml**
+- Add `maxQueueSize` to `Enqueue`
+
+
+[2022-06-15] Version 5.67.3
+---------------------------
+**Lookups**
+- Adding support for Lookup V2 API
+
+**Studio**
+- Corrected PII labels to be 30 days and added context to be PII
+
+**Twiml**
+- Add `statusCallbackMethod` attribute, nested `<Config` and `<Parameter>` elements to `<VirtualAgent>` noun.
+- Add support for new Amazon Polly voices (Q2 2022) for `Say` verb
+- Add support for `<Conversation>` noun
+
+
 [2022-06-01] Version 5.67.2
 ---------------------------
 **Library - Chore**

data/PULL_REQUEST_TEMPLATE.md

@@ -3,7 +3,7 @@ We appreciate the effort for this pull request but before that please make sure
 
 Please format the PR title appropriately based on the type of change:
   <type>[!]: <description>
-Where <type> is one of: docs, chore, feat, fix, test.
+Where <type> is one of: docs, chore, feat, fix, test, misc.
 Add a '!' after the type for breaking changes (e.g. feat!: new breaking feature).
 
 **All third-party contributors acknowledge that any contributions they provide will be made under the same open-source license that the open-source project is provided under.**

data/README.md

@@ -34,13 +34,13 @@ This library supports the following Ruby implementations:
 To install using [Bundler][bundler] grab the latest stable version:
 
 ```ruby
-gem 'twilio-ruby', '~> 5.67.2'
+gem 'twilio-ruby', '~> 5.69.0'
 ```
 
 To manually install `twilio-ruby` via [Rubygems][rubygems] simply gem install:
 
 ```bash
-gem install twilio-ruby -v 5.67.2
+gem install twilio-ruby -v 5.69.0
 ```
 
 To build and install the development branch yourself from the latest source:

data/lib/twilio-ruby/rest/api/v2010/account/call/payment.rb

@@ -52,7 +52,7 @@ module Twilio
               #   overwritten with `currency` field. Leave blank or set to 0 to tokenize.
               # @param [String] currency The currency of the `charge_amount`, formatted as {ISO
               #   4127}[http://www.iso.org/iso/home/standards/currency_codes.htm] format. The
-              #   default value is `USD` and all values allowed from the <Pay> Connector are
+              #   default value is `USD` and all values allowed from the Pay Connector are
               #   accepted.
               # @param [String] description The description can be used to provide more details
               #   regarding the transaction. This information is submitted along with the payment
@@ -68,9 +68,9 @@ module Twilio
               #   that has to be included here depends on the <Pay> Connector. {Read
               #   more}[https://www.twilio.com/console/voice/pay-connectors].
               # @param [String] payment_connector This is the unique name corresponding to the
-              #   Payment Gateway Connector installed in the Twilio Add-ons. Learn more about
-              #   {<Pay> Connectors}[https://www.twilio.com/console/voice/pay-connectors]. The
-              #   default value is `Default`.
+              #   Pay Connector installed in the Twilio Add-ons. Learn more about {<Pay>
+              #   Connectors}[https://www.twilio.com/console/voice/pay-connectors]. The default
+              #   value is `Default`.
               # @param [payment.PaymentMethod] payment_method Type of payment being captured.
               #   One of `credit-card` or `ach-debit`. The default value is `credit-card`.
               # @param [Boolean] postal_code Indicates whether the credit card postal code (zip
@@ -202,7 +202,7 @@ module Twilio
               # @param [payment.Status] status Indicates whether the current payment session
               #   should be cancelled or completed. When `cancel` the payment session is
               #   cancelled. When `complete`, Twilio sends the payment information to the selected
-              #   <Pay> connector for processing.
+              #   Pay Connector for processing.
               # @return [PaymentInstance] Updated PaymentInstance
               def update(idempotency_key: nil, status_callback: nil, capture: :unset, status: :unset)
                 data = Twilio::Values.of({
@@ -342,7 +342,7 @@ module Twilio
               # @param [payment.Status] status Indicates whether the current payment session
               #   should be cancelled or completed. When `cancel` the payment session is
               #   cancelled. When `complete`, Twilio sends the payment information to the selected
-              #   <Pay> connector for processing.
+              #   Pay Connector for processing.
               # @return [PaymentInstance] Updated PaymentInstance
               def update(idempotency_key: nil, status_callback: nil, capture: :unset, status: :unset)
                 context.update(

data/lib/twilio-ruby/rest/insights/v1/call/annotation.rb

@@ -0,0 +1,322 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Insights < Domain
+      class V1 < Version
+        class CallContext < InstanceContext
+          ##
+          # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+          class AnnotationList < ListResource
+            ##
+            # Initialize the AnnotationList
+            # @param [Version] version Version that contains the resource
+            # @param [String] call_sid The unique SID identifier of the Call.
+            # @return [AnnotationList] AnnotationList
+            def initialize(version, call_sid: nil)
+              super(version)
+
+              # Path Solution
+              @solution = {call_sid: call_sid}
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              '#<Twilio.Insights.V1.AnnotationList>'
+            end
+          end
+
+          ##
+          # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+          class AnnotationPage < Page
+            ##
+            # Initialize the AnnotationPage
+            # @param [Version] version Version that contains the resource
+            # @param [Response] response Response from the API
+            # @param [Hash] solution Path solution for the resource
+            # @return [AnnotationPage] AnnotationPage
+            def initialize(version, response, solution)
+              super(version, response)
+
+              # Path Solution
+              @solution = solution
+            end
+
+            ##
+            # Build an instance of AnnotationInstance
+            # @param [Hash] payload Payload response from the API
+            # @return [AnnotationInstance] AnnotationInstance
+            def get_instance(payload)
+              AnnotationInstance.new(@version, payload, call_sid: @solution[:call_sid], )
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              '<Twilio.Insights.V1.AnnotationPage>'
+            end
+          end
+
+          ##
+          # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+          class AnnotationContext < InstanceContext
+            ##
+            # Initialize the AnnotationContext
+            # @param [Version] version Version that contains the resource
+            # @param [String] call_sid The unique SID identifier of the Call.
+            # @return [AnnotationContext] AnnotationContext
+            def initialize(version, call_sid)
+              super(version)
+
+              # Path Solution
+              @solution = {call_sid: call_sid, }
+              @uri = "/Voice/#{@solution[:call_sid]}/Annotation"
+            end
+
+            ##
+            # Update the AnnotationInstance
+            # @param [annotation.AnsweredBy] answered_by Which entity answered the call as
+            #   determined by Answering Machine Detection. Use this to provide feedback on
+            #   Answering Machine Detection accuracy. Possible enumerated values, one of: human,
+            #   machine. human indicates the call was answered by a person. machine indicates
+            #   the call was answered by an answering machine.
+            # @param [annotation.ConnectivityIssue] connectivity_issue Specify if the call had
+            #   any connectivity issues. Possible enumerated values, one :
+            #   no_connectivity_issue, invalid_number, caller_id, dropped_call,
+            #   number_reachability.
+            # @param [String] quality_issues Specify if the call had any subjective quality
+            #   issues. Possible values, one or more of:  no_quality_issue, low_volume,
+            #   choppy_robotic, echo, dtmf, latency, owa, static_noise. Use comma separated
+            #   values to indicate multiple quality issues for the same call
+            # @param [Boolean] spam Specify if the call was a spam call. Use this to provide
+            #   feedback on whether calls placed from your account were marked as spam, or if
+            #   inbound calls received by your account were unwanted spam. Is of type Boolean:
+            #   true, false. Use true if the call was a spam call.
+            # @param [String] call_score Specify the call score. This is of type integer. Use
+            #   a range of 1-5 to indicate the call experience score, with the following mapping
+            #   as a reference for rating the call [5: Excellent, 4: Good, 3 : Fair, 2 : Poor,
+            #   1: Bad].
+            # @param [String] comment Specify any comments pertaining to the call. This of
+            #   type string with a max limit of 100 characters. Twilio does not treat this field
+            #   as PII, so don’t put any PII in here.
+            # @param [String] incident Associate this call with an incident or support ticket.
+            #   This is of type string with a max limit of 100 characters. Twilio does not treat
+            #   this field as PII, so don’t put any PII in here.
+            # @return [AnnotationInstance] Updated AnnotationInstance
+            def update(answered_by: :unset, connectivity_issue: :unset, quality_issues: :unset, spam: :unset, call_score: :unset, comment: :unset, incident: :unset)
+              data = Twilio::Values.of({
+                  'AnsweredBy' => answered_by,
+                  'ConnectivityIssue' => connectivity_issue,
+                  'QualityIssues' => quality_issues,
+                  'Spam' => spam,
+                  'CallScore' => call_score,
+                  'Comment' => comment,
+                  'Incident' => incident,
+              })
+
+              payload = @version.update('POST', @uri, data: data)
+
+              AnnotationInstance.new(@version, payload, call_sid: @solution[:call_sid], )
+            end
+
+            ##
+            # Fetch the AnnotationInstance
+            # @return [AnnotationInstance] Fetched AnnotationInstance
+            def fetch
+              payload = @version.fetch('GET', @uri)
+
+              AnnotationInstance.new(@version, payload, call_sid: @solution[:call_sid], )
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Insights.V1.AnnotationContext #{context}>"
+            end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Insights.V1.AnnotationContext #{context}>"
+            end
+          end
+
+          ##
+          # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+          class AnnotationInstance < InstanceResource
+            ##
+            # Initialize the AnnotationInstance
+            # @param [Version] version Version that contains the resource
+            # @param [Hash] payload payload that contains response from Twilio
+            # @param [String] call_sid The unique SID identifier of the Call.
+            # @return [AnnotationInstance] AnnotationInstance
+            def initialize(version, payload, call_sid: nil)
+              super(version)
+
+              # Marshaled Properties
+              @properties = {
+                  'call_sid' => payload['call_sid'],
+                  'account_sid' => payload['account_sid'],
+                  'answered_by' => payload['answered_by'],
+                  'connectivity_issue' => payload['connectivity_issue'],
+                  'quality_issues' => payload['quality_issues'],
+                  'spam' => payload['spam'],
+                  'call_score' => payload['call_score'] == nil ? payload['call_score'] : payload['call_score'].to_i,
+                  'comment' => payload['comment'],
+                  'incident' => payload['incident'],
+                  'url' => payload['url'],
+              }
+
+              # Context
+              @instance_context = nil
+              @params = {'call_sid' => call_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 [AnnotationContext] AnnotationContext for this AnnotationInstance
+            def context
+              unless @instance_context
+                @instance_context = AnnotationContext.new(@version, @params['call_sid'], )
+              end
+              @instance_context
+            end
+
+            ##
+            # @return [String] Call SID.
+            def call_sid
+              @properties['call_sid']
+            end
+
+            ##
+            # @return [String] Account SID.
+            def account_sid
+              @properties['account_sid']
+            end
+
+            ##
+            # @return [annotation.AnsweredBy] Indicates the answering entity as determined by Answering Machine Detection.
+            def answered_by
+              @properties['answered_by']
+            end
+
+            ##
+            # @return [annotation.ConnectivityIssue] Indicates if the call had any connectivity issue
+            def connectivity_issue
+              @properties['connectivity_issue']
+            end
+
+            ##
+            # @return [Array[String]] Indicates if the call had audio quality issues.
+            def quality_issues
+              @properties['quality_issues']
+            end
+
+            ##
+            # @return [Boolean] Call spam indicator
+            def spam
+              @properties['spam']
+            end
+
+            ##
+            # @return [String] Call Score
+            def call_score
+              @properties['call_score']
+            end
+
+            ##
+            # @return [String] User comments
+            def comment
+              @properties['comment']
+            end
+
+            ##
+            # @return [String] Call tag for incidents or support ticket
+            def incident
+              @properties['incident']
+            end
+
+            ##
+            # @return [String] The URL of this resource.
+            def url
+              @properties['url']
+            end
+
+            ##
+            # Update the AnnotationInstance
+            # @param [annotation.AnsweredBy] answered_by Which entity answered the call as
+            #   determined by Answering Machine Detection. Use this to provide feedback on
+            #   Answering Machine Detection accuracy. Possible enumerated values, one of: human,
+            #   machine. human indicates the call was answered by a person. machine indicates
+            #   the call was answered by an answering machine.
+            # @param [annotation.ConnectivityIssue] connectivity_issue Specify if the call had
+            #   any connectivity issues. Possible enumerated values, one :
+            #   no_connectivity_issue, invalid_number, caller_id, dropped_call,
+            #   number_reachability.
+            # @param [String] quality_issues Specify if the call had any subjective quality
+            #   issues. Possible values, one or more of:  no_quality_issue, low_volume,
+            #   choppy_robotic, echo, dtmf, latency, owa, static_noise. Use comma separated
+            #   values to indicate multiple quality issues for the same call
+            # @param [Boolean] spam Specify if the call was a spam call. Use this to provide
+            #   feedback on whether calls placed from your account were marked as spam, or if
+            #   inbound calls received by your account were unwanted spam. Is of type Boolean:
+            #   true, false. Use true if the call was a spam call.
+            # @param [String] call_score Specify the call score. This is of type integer. Use
+            #   a range of 1-5 to indicate the call experience score, with the following mapping
+            #   as a reference for rating the call [5: Excellent, 4: Good, 3 : Fair, 2 : Poor,
+            #   1: Bad].
+            # @param [String] comment Specify any comments pertaining to the call. This of
+            #   type string with a max limit of 100 characters. Twilio does not treat this field
+            #   as PII, so don’t put any PII in here.
+            # @param [String] incident Associate this call with an incident or support ticket.
+            #   This is of type string with a max limit of 100 characters. Twilio does not treat
+            #   this field as PII, so don’t put any PII in here.
+            # @return [AnnotationInstance] Updated AnnotationInstance
+            def update(answered_by: :unset, connectivity_issue: :unset, quality_issues: :unset, spam: :unset, call_score: :unset, comment: :unset, incident: :unset)
+              context.update(
+                  answered_by: answered_by,
+                  connectivity_issue: connectivity_issue,
+                  quality_issues: quality_issues,
+                  spam: spam,
+                  call_score: call_score,
+                  comment: comment,
+                  incident: incident,
+              )
+            end
+
+            ##
+            # Fetch the AnnotationInstance
+            # @return [AnnotationInstance] Fetched AnnotationInstance
+            def fetch
+              context.fetch
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+              "<Twilio.Insights.V1.AnnotationInstance #{values}>"
+            end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+              "<Twilio.Insights.V1.AnnotationInstance #{values}>"
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/twilio-ruby/rest/insights/v1/call/summary.rb

@@ -134,6 +134,7 @@ module Twilio
                   'attributes' => payload['attributes'],
                   'properties' => payload['properties'],
                   'trust' => payload['trust'],
+                  'annotation' => payload['annotation'],
               }
 
               # Context
@@ -278,6 +279,12 @@ module Twilio
               @properties['trust']
             end
 
+            ##
+            # @return [Hash] The annotation
+            def annotation
+              @properties['annotation']
+            end
+
             ##
             # Fetch the CallSummaryInstance
             # @param [call_summary.ProcessingState] processing_state The processing_state

data/lib/twilio-ruby/rest/insights/v1/call.rb

@@ -10,8 +10,6 @@ module Twilio
   module REST
     class Insights < Domain
       class V1 < Version
-        ##
-        # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
         class CallList < ListResource
           ##
           # Initialize the CallList
@@ -31,8 +29,6 @@ module Twilio
           end
         end
 
-        ##
-        # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
         class CallPage < Page
           ##
           # Initialize the CallPage
@@ -62,8 +58,6 @@ module Twilio
           end
         end
 
-        ##
-        # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
         class CallContext < InstanceContext
           ##
           # Initialize the CallContext
@@ -81,6 +75,7 @@ module Twilio
             @events = nil
             @metrics = nil
             @summary = nil
+            @annotation = nil
           end
 
           ##
@@ -124,6 +119,14 @@ module Twilio
             CallSummaryContext.new(@version, @solution[:sid], )
           end
 
+          ##
+          # Access the annotation
+          # @return [AnnotationList]
+          # @return [AnnotationContext]
+          def annotation
+            AnnotationContext.new(@version, @solution[:sid], )
+          end
+
           ##
           # Provide a user friendly representation
           def to_s
@@ -139,8 +142,6 @@ module Twilio
           end
         end
 
-        ##
-        # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
         class CallInstance < InstanceResource
           ##
           # Initialize the CallInstance
@@ -216,6 +217,13 @@ module Twilio
             context.summary
           end
 
+          ##
+          # Access the annotation
+          # @return [annotation] annotation
+          def annotation
+            context.annotation
+          end
+
           ##
           # Provide a user friendly representation
           def to_s

data/lib/twilio-ruby/rest/insights/v1.rb

@@ -16,7 +16,6 @@ module Twilio
           super
           @version = 'v1'
           @settings = nil
-          @annotation = nil
           @calls = nil
           @call_summaries = nil
           @conferences = nil
@@ -29,21 +28,6 @@ module Twilio
           @settings ||= SettingContext.new self
         end
 
-        ##
-        # @param [String] call_sid The call_sid
-        # @return [Twilio::REST::Insights::V1::AnnotationContext] if call_sid was passed.
-        # @return [Twilio::REST::Insights::V1::AnnotationList]
-        def annotation(call_sid=:unset)
-          if call_sid.nil?
-              raise ArgumentError, 'call_sid cannot be nil'
-          end
-          if call_sid == :unset
-              @annotation ||= AnnotationList.new self
-          else
-              AnnotationContext.new(self, call_sid)
-          end
-        end
-
         ##
         # @param [String] sid The sid
         # @return [Twilio::REST::Insights::V1::CallContext] if sid was passed.

data/lib/twilio-ruby/rest/insights.rb

@@ -34,14 +34,6 @@ module Twilio
         self.v1.settings()
       end
 
-      ##
-      # @param [String] call_sid The call_sid
-      # @return [Twilio::REST::Insights::V1::AnnotationInstance] if call_sid was passed.
-      # @return [Twilio::REST::Insights::V1::AnnotationList]
-      def annotation(call_sid=:unset)
-        self.v1.annotation(call_sid)
-      end
-
       ##
       # @param [String] sid The sid
       # @return [Twilio::REST::Insights::V1::CallInstance] if sid was passed.