twilio-ruby 5.66.0 → 5.66.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 05d747e6afb3147d260dc189582592a19e650957
-  data.tar.gz: 07114f3240dfeebbdd9d3128a6631d6b40255a41
+  metadata.gz: 27cd5b2536a7ece409f2f6222f9743446e7ed44f
+  data.tar.gz: 2d2d5e161f40f11b388f9118eebd120e9c5ba765
 SHA512:
-  metadata.gz: cceca2b0801fc90db7e7671ef014bfd0d962e44a732be30b6d8e32fa00006cfb9cbcf9742e3ca4848b35f6cf2ea7ca8c6cf3e9a5b078a3a9dd3f900ed19f9f9a
-  data.tar.gz: 8d735e1c20ec6c1d5b151ffb100bcad25413bd67e935104bf0b3d6fc4070fc1598c8c8e66427295e54507dcf7fd456a71e45de4b3ef4fc58af8eddadad280bfb
+  metadata.gz: 32503dca86f69127f882feec36ad61d9c91f01379ae60f10bed3f9d410e30399d3436bbd097ff063a9359f100c83173b82b9203fd1871500694ef81cec6cb911
+  data.tar.gz: d426b5f3df1f6a991f0c829623dd5c67d17de0f7068ac79b586911e4dc8afb3052ac781fa5e152b7c5c63adf9f7696732ed072527457d523e3b13d4fc49574a0

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

@@ -0,0 +1,15 @@
+name: Lint PR
+on:
+  pull_request_target:
+    types: [ opened, edited, reopened ]
+
+jobs:
+  validate:
+    name: Validate title
+    runs-on: ubuntu-latest
+    steps:
+      - uses: amannn/action-semantic-pull-request@v4
+        with:
+          types: chore docs fix feat test
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

data/CHANGES.md

@@ -1,6 +1,19 @@
 twilio-ruby changelog
 =====================
 
+[2022-04-06] Version 5.66.1
+---------------------------
+**Api**
+- Updated `provider_sid` visibility to private
+
+**Verify**
+- Verify List Attempts API summary endpoint added.
+- Update PII documentation for `AccessTokens` `factor_friendly_name` property.
+
+**Voice**
+- make annotation parameter from /Calls API private
+
+
 [2022-03-23] Version 5.66.0
 ---------------------------
 **Api**

data/README.md

@@ -4,8 +4,6 @@
 [![Gem Version](https://img.shields.io/gem/v/twilio-ruby.svg)](https://rubygems.org/gems/twilio-ruby)
 [![Learn with TwilioQuest](https://img.shields.io/static/v1?label=TwilioQuest&message=Learn%20to%20contribute%21&color=F22F46&labelColor=1f243c&style=flat-square&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAIAAAACACAMAAAD04JH5AAAASFBMVEUAAAAZGRkcHBwjIyMoKCgAAABgYGBoaGiAgICMjIyzs7PJycnMzMzNzc3UoBfd3d3m5ubqrhfrMEDu7u739/f4vSb/3AD///9tbdyEAAAABXRSTlMAAAAAAMJrBrEAAAKoSURBVHgB7ZrRcuI6EESdyxXGYoNFvMD//+l2bSszRgyUYpFAsXOeiJGmj4NkuWx1Qeh+Ekl9DgEXOBwOx+Px5xyQhDykfgq4wG63MxxaR4ddIkg6Ul3g84vCIcjPBA5gmUMeXESrlukuoK33+33uID8TWeLAdOWsKpJYzwVMB7bOzYSGOciyUlXSn0/ABXTosJ1M1SbypZ4O4MbZuIDMU02PMbauhhHMHXbmebmALIiEbbbbbUrpF1gwE9kFfRNAJaP+FQEXCCTGyJ4ngDrjOFo3jEL5JdqjF/pueR4cCeCGgAtwmuRS6gDwaRiGvu+DMFwSBLTE3+jF8JyuV1okPZ+AC4hDFhCHyHQjdjPHUKFDlHSJkHQXMB3KpSwXNGJPcwwTdZiXlRN0gSp0zpWxNtM0beYE0nRH6QIbO7rawwXaBYz0j78gxjokDuv12gVeUuBD0MDi0OQCLvDaAho4juP1Q/jkAncXqIcCfd+7gAu4QLMACCLxpRsSuQh0igu0C9Svhi7weAGZg50L3IE3cai4IfkNZAC8dfdhsUD3CgKBVC9JE5ABAFzg4QL/taYPAAWrHdYcgfLaIgAXWJ7OV38n1LEF8tt2TH29E+QAoDoO5Ve/LtCQDmKM9kPbvCEBApK+IXzbcSJ0cIGF6e8gpcRhUDogWZ8JnaWjPXc/fNnBBUKRngiHgTUSivSzDRDgHZQOLvBQgf8rRt+VdBUUhwkU6VpJ+xcOwQUqZr+mR0kvBUgv6cB4+37hQAkXqE8PwGisGhJtN4xAHMzrsgvI7rccXqSvKh6jltGlrOHA3Xk1At3LC4QiPdX9/0ndHpGVvTjR4bZA1ypAKgVcwE5vx74ulwIugDt8e/X7JgfkucBMIAr26ndnB4UCLnDOqvteQsHlgX9N4A+c4cW3DXSPbwAAAABJRU5ErkJggg==)](https://twil.io/learn-open-source)
 
-**The default branch name for this repository has been changed to `main` as of 07/27/2020.**
-
 ## Documentation
 
 The documentation for the Twilio API can be found [here][apidocs].
@@ -36,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.66.0'
+gem 'twilio-ruby', '~> 5.66.1'
 ```
 
 To manually install `twilio-ruby` via [Rubygems][rubygems] simply gem install:
 
 ```bash
-gem install twilio-ruby -v 5.66.0
+gem install twilio-ruby -v 5.66.1
 ```
 
 To build and install the development branch yourself from the latest source:

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

@@ -684,7 +684,6 @@ module Twilio
                   'price_unit' => payload['price_unit'],
                   'direction' => payload['direction'],
                   'answered_by' => payload['answered_by'],
-                  'annotation' => payload['annotation'],
                   'api_version' => payload['api_version'],
                   'forwarded_from' => payload['forwarded_from'],
                   'group_sid' => payload['group_sid'],
@@ -819,12 +818,6 @@ module Twilio
               @properties['answered_by']
             end
 
-            ##
-            # @return [String] The annotation provided for the call
-            def annotation
-              @properties['annotation']
-            end
-
             ##
             # @return [String] The API Version used to create the call
             def api_version

data/lib/twilio-ruby/rest/verify/v2/service/verification.rb

@@ -61,7 +61,8 @@ module Twilio
             #   may include multiple Rate Limit values in each request.
             # @param [Hash] channel_configuration
             #   {`email`}[https://www.twilio.com/docs/verify/email] channel configuration in
-            #   json format. Must include 'from' and 'from_name'.
+            #   json format. The fields 'from' and 'from_name' are optional but if included the
+            #   'from' field must have a valid email address.
             # @param [String] app_hash Your {App
             #   Hash}[https://developers.google.com/identity/sms-retriever/verify#computing_your_apps_hash_string]
             #   to be appended at the end of your verification SMS body. Applies only to SMS.

data/lib/twilio-ruby/rest/verify/v2/verification_attempts_summary.rb

@@ -0,0 +1,234 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Verify < Domain
+      class V2 < Version
+        class VerificationAttemptsSummaryList < ListResource
+          ##
+          # Initialize the VerificationAttemptsSummaryList
+          # @param [Version] version Version that contains the resource
+          # @return [VerificationAttemptsSummaryList] VerificationAttemptsSummaryList
+          def initialize(version)
+            super(version)
+
+            # Path Solution
+            @solution = {}
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '#<Twilio.Verify.V2.VerificationAttemptsSummaryList>'
+          end
+        end
+
+        class VerificationAttemptsSummaryPage < Page
+          ##
+          # Initialize the VerificationAttemptsSummaryPage
+          # @param [Version] version Version that contains the resource
+          # @param [Response] response Response from the API
+          # @param [Hash] solution Path solution for the resource
+          # @return [VerificationAttemptsSummaryPage] VerificationAttemptsSummaryPage
+          def initialize(version, response, solution)
+            super(version, response)
+
+            # Path Solution
+            @solution = solution
+          end
+
+          ##
+          # Build an instance of VerificationAttemptsSummaryInstance
+          # @param [Hash] payload Payload response from the API
+          # @return [VerificationAttemptsSummaryInstance] VerificationAttemptsSummaryInstance
+          def get_instance(payload)
+            VerificationAttemptsSummaryInstance.new(@version, payload, )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '<Twilio.Verify.V2.VerificationAttemptsSummaryPage>'
+          end
+        end
+
+        class VerificationAttemptsSummaryContext < InstanceContext
+          ##
+          # Initialize the VerificationAttemptsSummaryContext
+          # @param [Version] version Version that contains the resource
+          # @return [VerificationAttemptsSummaryContext] VerificationAttemptsSummaryContext
+          def initialize(version)
+            super(version)
+
+            # Path Solution
+            @solution = {}
+            @uri = "/Attempts/Summary"
+          end
+
+          ##
+          # Fetch the VerificationAttemptsSummaryInstance
+          # @param [String] verify_service_sid Filter used to consider only Verification
+          #   Attempts of the given verify service on the summary aggregation.
+          # @param [Time] date_created_after Datetime filter used to consider only
+          #   Verification Attempts created after this datetime on the summary aggregation.
+          #   Given as GMT in RFC 2822 format.
+          # @param [Time] date_created_before Datetime filter used to consider only
+          #   Verification Attempts created before this datetime on the summary aggregation.
+          #   Given as GMT in RFC 2822 format.
+          # @param [String] country Filter used to consider only Verification Attempts sent
+          #   to the specified destination country on the summary aggregation.
+          # @param [verification_attempts_summary.Channels] channel Filter Verification
+          #   Attempts considered on the summary aggregation by communication channel. Valid
+          #   values are `SMS` and `CALL`
+          # @param [String] destination_prefix Filter the Verification Attempts considered
+          #   on the summary aggregation by Destination prefix. It is the prefix of a phone
+          #   number in E.164 format.
+          # @return [VerificationAttemptsSummaryInstance] Fetched VerificationAttemptsSummaryInstance
+          def fetch(verify_service_sid: :unset, date_created_after: :unset, date_created_before: :unset, country: :unset, channel: :unset, destination_prefix: :unset)
+            params = Twilio::Values.of({
+                'VerifyServiceSid' => verify_service_sid,
+                'DateCreatedAfter' => Twilio.serialize_iso8601_datetime(date_created_after),
+                'DateCreatedBefore' => Twilio.serialize_iso8601_datetime(date_created_before),
+                'Country' => country,
+                'Channel' => channel,
+                'DestinationPrefix' => destination_prefix,
+            })
+
+            payload = @version.fetch('GET', @uri, params: params)
+
+            VerificationAttemptsSummaryInstance.new(@version, payload, )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.Verify.V2.VerificationAttemptsSummaryContext #{context}>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.Verify.V2.VerificationAttemptsSummaryContext #{context}>"
+          end
+        end
+
+        class VerificationAttemptsSummaryInstance < InstanceResource
+          ##
+          # Initialize the VerificationAttemptsSummaryInstance
+          # @param [Version] version Version that contains the resource
+          # @param [Hash] payload payload that contains response from Twilio
+          # @return [VerificationAttemptsSummaryInstance] VerificationAttemptsSummaryInstance
+          def initialize(version, payload)
+            super(version)
+
+            # Marshaled Properties
+            @properties = {
+                'total_attempts' => payload['total_attempts'].to_i,
+                'total_converted' => payload['total_converted'].to_i,
+                'total_unconverted' => payload['total_unconverted'].to_i,
+                'conversion_rate_percentage' => payload['conversion_rate_percentage'].to_f,
+                'url' => payload['url'],
+            }
+
+            # Context
+            @instance_context = nil
+            @params = {}
+          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 [VerificationAttemptsSummaryContext] VerificationAttemptsSummaryContext for this VerificationAttemptsSummaryInstance
+          def context
+            unless @instance_context
+              @instance_context = VerificationAttemptsSummaryContext.new(@version, )
+            end
+            @instance_context
+          end
+
+          ##
+          # @return [String] Total of attempts made.
+          def total_attempts
+            @properties['total_attempts']
+          end
+
+          ##
+          # @return [String] Total of attempts confirmed by the end user.
+          def total_converted
+            @properties['total_converted']
+          end
+
+          ##
+          # @return [String] Total of attempts made that were not confirmed by the end user.
+          def total_unconverted
+            @properties['total_unconverted']
+          end
+
+          ##
+          # @return [String] Percentage of the confirmed messages over the total.
+          def conversion_rate_percentage
+            @properties['conversion_rate_percentage']
+          end
+
+          ##
+          # @return [String] The url
+          def url
+            @properties['url']
+          end
+
+          ##
+          # Fetch the VerificationAttemptsSummaryInstance
+          # @param [String] verify_service_sid Filter used to consider only Verification
+          #   Attempts of the given verify service on the summary aggregation.
+          # @param [Time] date_created_after Datetime filter used to consider only
+          #   Verification Attempts created after this datetime on the summary aggregation.
+          #   Given as GMT in RFC 2822 format.
+          # @param [Time] date_created_before Datetime filter used to consider only
+          #   Verification Attempts created before this datetime on the summary aggregation.
+          #   Given as GMT in RFC 2822 format.
+          # @param [String] country Filter used to consider only Verification Attempts sent
+          #   to the specified destination country on the summary aggregation.
+          # @param [verification_attempts_summary.Channels] channel Filter Verification
+          #   Attempts considered on the summary aggregation by communication channel. Valid
+          #   values are `SMS` and `CALL`
+          # @param [String] destination_prefix Filter the Verification Attempts considered
+          #   on the summary aggregation by Destination prefix. It is the prefix of a phone
+          #   number in E.164 format.
+          # @return [VerificationAttemptsSummaryInstance] Fetched VerificationAttemptsSummaryInstance
+          def fetch(verify_service_sid: :unset, date_created_after: :unset, date_created_before: :unset, country: :unset, channel: :unset, destination_prefix: :unset)
+            context.fetch(
+                verify_service_sid: verify_service_sid,
+                date_created_after: date_created_after,
+                date_created_before: date_created_before,
+                country: country,
+                channel: channel,
+                destination_prefix: destination_prefix,
+            )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+            "<Twilio.Verify.V2.VerificationAttemptsSummaryInstance #{values}>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+            "<Twilio.Verify.V2.VerificationAttemptsSummaryInstance #{values}>"
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -18,6 +18,7 @@ module Twilio
           @forms = nil
           @services = nil
           @verification_attempts = nil
+          @verification_attempts_summary = nil
           @templates = nil
         end
 
@@ -68,6 +69,12 @@ module Twilio
           end
         end
 
+        ##
+        # @return [Twilio::REST::Verify::V2::VerificationAttemptsSummaryContext]
+        def verification_attempts_summary
+          @verification_attempts_summary ||= VerificationAttemptsSummaryContext.new self
+        end
+
         ##
         # @return [Twilio::REST::Verify::V2::TemplateContext]
         def templates

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

@@ -55,6 +55,12 @@ module Twilio
         self.v2.verification_attempts(sid)
       end
 
+      ##
+      # @return [Twilio::REST::Verify::V2::VerificationAttemptsSummaryInstance]
+      def verification_attempts_summary
+        self.v2.verification_attempts_summary()
+      end
+
       ##
       # @return [Twilio::REST::Verify::V2::TemplateInstance]
       def templates

data/lib/twilio-ruby/version.rb

@@ -1,3 +1,3 @@
 module Twilio
-    VERSION = '5.66.0'
+    VERSION = '5.66.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: twilio-ruby
 version: !ruby/object:Gem::Version
-  version: 5.66.0
+  version: 5.66.1
 platform: ruby
 authors:
 - Twilio API Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-03-23 00:00:00.000000000 Z
+date: 2022-04-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jwt
@@ -198,6 +198,7 @@ extra_rdoc_files:
 - LICENSE
 files:
 - ".dockerignore"
+- ".github/workflows/pr-lint.yml"
 - ".github/workflows/test-and-deploy.yml"
 - ".gitignore"
 - ".rubocop.yml"
@@ -725,6 +726,7 @@ files:
 - lib/twilio-ruby/rest/verify/v2/service/webhook.rb
 - lib/twilio-ruby/rest/verify/v2/template.rb
 - lib/twilio-ruby/rest/verify/v2/verification_attempt.rb
+- lib/twilio-ruby/rest/verify/v2/verification_attempts_summary.rb
 - lib/twilio-ruby/rest/video.rb
 - lib/twilio-ruby/rest/video/v1.rb
 - lib/twilio-ruby/rest/video/v1/composition.rb