twilio-ruby 5.36.0 → 5.37.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e0442d91ae15369f07249085856a03505c1beb0a71d76c88862ad992e3fcb390
-  data.tar.gz: 01f4add7958ec84a106489a68aece150618496782c1902720ed61722c95b9eb1
+  metadata.gz: 8a5c3a5328774c9a62a5bc9c1ff6c5e8938fdf26c2e79c1a408fde52a3aef190
+  data.tar.gz: 066e9a04142cdcbe8638908d37fd5344387db572650f3eb155edc05511ba3e3d
 SHA512:
-  metadata.gz: 5a38fb1c3693fa9ce9450d37447d75fb7000f7c547f46b2a1af638327f8ca3ecc639755caf2ddbf1145f366d4ecb9b78cfaab139adc0d45c97854a9a7fbdbcc8
-  data.tar.gz: 991079bc47595a00e3f2bc02063891af980dec39f2a814fd80d04d5a895d1c5d87839f3bc4c278ee66fa291bd7a3b14494326fc81d178f554891266f500d17aa
+  metadata.gz: c2bf78da3f3bbbe12183da2fbff0c9353637a489d07fab78ef5c0b213865c4b9ed4368798888b79adb518df1f042bdd1272d0e7379f0b21ed587cc15c2d85c82
+  data.tar.gz: 50a5abff923ede90115ad0987c8d1ff3e3c68a24faf055bfa2b8829c06d1af3b6cac19533791fa235dafcd865ce99810ba70d68c495001840bb41c5eb93162ad

data/CHANGES.md

@@ -1,6 +1,43 @@
 twilio-ruby changelog
 =====================
 
+[2020-06-10] Version 5.37.0
+---------------------------
+**Library - Docs**
+- [PR #514](https://github.com/twilio/twilio-ruby/pull/514): link to handling exceptions. Thanks to [@thinkingserious](https://github.com/thinkingserious)!
+- [PR #513](https://github.com/twilio/twilio-ruby/pull/513): link to custom HTTP client instructions. Thanks to [@thinkingserious](https://github.com/thinkingserious)!
+
+**Api**
+- Added `pstnconnectivity` to `usage_record` API
+
+**Autopilot**
+- Add dialogue_sid param to Query list resource
+
+**Contacts**
+- Added contacts channel create, update, read, delete API definition
+- Added contacts Get API definition
+- Added contacts Update API definition
+- Added contacts Delete API definition
+- Added contacts Search API definition
+- Added AccountSID to CFD CREATE and GET Responses
+- Added contacts location Create, update, read and delete API definitions
+
+**Notify**
+- delivery_callback_url and delivery_callback_enabled added
+
+**Numbers**
+- Add `provisionally-approved` as a Bundle status
+
+**Preview**
+- `BrandsInformation` endpoint now returns a single `BrandsInformation`
+- Deleted phone number required field in the brand phone number endpoint from `kyc-api`
+- Removed insights `preview API` from API Definitions **(breaking change)**
+- Added `BrandsInformation` endpoint to query brands information stored in KYC
+
+**Supersim**
+- Require a Network Access Profile when creating a Fleet **(breaking change)**
+
+
 [2020-05-27] Version 5.36.0
 ---------------------------
 **Api**

data/README.md

@@ -32,13 +32,13 @@ This library supports the following Ruby implementations:
 To install using [Bundler][bundler] grab the latest stable version:
 
 ```ruby
-gem 'twilio-ruby', '~> 5.36.0'
+gem 'twilio-ruby', '~> 5.37.0'
 ```
 
 To manually install `twilio-ruby` via [Rubygems][rubygems] simply gem install:
 
 ```bash
-gem install twilio-ruby -v 5.36.0
+gem install twilio-ruby -v 5.37.0
 ```
 
 To build and install the development branch yourself from the latest source:
@@ -66,6 +66,8 @@ auth_token = 'yyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy'
 
 ### Specify a Region and/or Edge
 
+To take advantage of Twilio's [Global Infrastructure](https://www.twilio.com/docs/global-infrastructure), specify the target Region and/or Edge for the client:
+
 ```ruby
 # set up a client to talk to the Twilio REST API over a specific region and edge
 @client = Twilio::REST::Client.new account_sid, auth_token, nil, 'au1'
@@ -121,16 +123,20 @@ message_sid = 'SMxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'
 @client.http_client.adapter = :typhoeus
 ```
 
+To use a custom HTTP client with this helper library, please see the [Twilio documentation](https://www.twilio.com/docs/libraries/ruby/custom-http-clients).
+
 ### Handling Errors
 
 ```ruby
 begin
   messages = @client.messages.list(limit: 20)
-rescue Twilio::REST::TwilioError => e
+rescue Twilio::REST::RestError => e
   puts e.message
 end
 ```
 
+For more descriptive exception types, please see the [Twilio documentation](https://www.twilio.com/docs/libraries/ruby/usage-guide#error-handling).
+
 ### Getting Started With Client Capability Tokens
 
 If you just need to generate a Capability Token for use with Twilio Client, you can do this:

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

@@ -343,8 +343,9 @@ module Twilio
               # @param [String] conference_sid The SID of the conference with the participant to
               #   fetch.
               # @param [String] call_sid The
-              #   [Call](https://www.twilio.com/docs/voice/api/call-resource) SID of the resource
-              #   to fetch.
+              #   [Call](https://www.twilio.com/docs/voice/api/call-resource) SID or label of the
+              #   participant to fetch. Non URL safe characters in a label must be percent
+              #   encoded, for example, a space character is represented as %20.
               # @return [ParticipantContext] ParticipantContext
               def initialize(version, account_sid, conference_sid, call_sid)
                 super(version)
@@ -475,8 +476,9 @@ module Twilio
               #   Participant resource.
               # @param [String] conference_sid The SID of the conference the participant is in.
               # @param [String] call_sid The
-              #   [Call](https://www.twilio.com/docs/voice/api/call-resource) SID of the resource
-              #   to fetch.
+              #   [Call](https://www.twilio.com/docs/voice/api/call-resource) SID or label of the
+              #   participant to fetch. Non URL safe characters in a label must be percent
+              #   encoded, for example, a space character is represented as %20.
               # @return [ParticipantInstance] ParticipantInstance
               def initialize(version, payload, account_sid: nil, conference_sid: nil, call_sid: nil)
                 super(version)

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

@@ -117,10 +117,10 @@ module Twilio
               # Marshaled Properties
               @properties = {
                   'account_sid' => payload['account_sid'],
-                  'phone_number' => payload['phone_number'],
-                  'friendly_name' => payload['friendly_name'],
-                  'validation_code' => payload['validation_code'].to_i,
                   'call_sid' => payload['call_sid'],
+                  'friendly_name' => payload['friendly_name'],
+                  'phone_number' => payload['phone_number'],
+                  'validation_code' => payload['validation_code'],
               }
             end
 
@@ -131,9 +131,9 @@ module Twilio
             end
 
             ##
-            # @return [String] The phone number to verify in E.164 format
-            def phone_number
-              @properties['phone_number']
+            # @return [String] The SID of the Call the resource is associated with
+            def call_sid
+              @properties['call_sid']
             end
 
             ##
@@ -143,15 +143,15 @@ module Twilio
             end
 
             ##
-            # @return [String] The 6 digit validation code that someone must enter to validate the Caller ID  when `phone_number` is called
-            def validation_code
-              @properties['validation_code']
+            # @return [String] The phone number to verify in E.164 format
+            def phone_number
+              @properties['phone_number']
             end
 
             ##
-            # @return [String] The SID of the Call the resource is associated with
-            def call_sid
-              @properties['call_sid']
+            # @return [String] The 6 digit validation code that someone must enter to validate the Caller ID  when `phone_number` is called
+            def validation_code
+              @properties['validation_code']
             end
 
             ##

data/lib/twilio-ruby/rest/autopilot/v1/assistant/query.rb

@@ -39,6 +39,8 @@ module Twilio
             #   Build](https://www.twilio.com/docs/autopilot/api/model-build) to be queried.
             # @param [String] status The status of the resources to read. Can be:
             #   `pending-review`, `reviewed`, or `discarded`
+            # @param [String] dialogue_sid The SID of the
+            #   [Dialogue](https://www.twilio.com/docs/autopilot/api/dialogue).
             # @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
@@ -46,11 +48,12 @@ module Twilio
             #    but a limit is defined, stream() will attempt to read the limit with the most
             #    efficient page size, i.e. min(limit, 1000)
             # @return [Array] Array of up to limit results
-            def list(language: :unset, model_build: :unset, status: :unset, limit: nil, page_size: nil)
+            def list(language: :unset, model_build: :unset, status: :unset, dialogue_sid: :unset, limit: nil, page_size: nil)
               self.stream(
                   language: language,
                   model_build: model_build,
                   status: status,
+                  dialogue_sid: dialogue_sid,
                   limit: limit,
                   page_size: page_size
               ).entries
@@ -66,6 +69,8 @@ module Twilio
             #   Build](https://www.twilio.com/docs/autopilot/api/model-build) to be queried.
             # @param [String] status The status of the resources to read. Can be:
             #   `pending-review`, `reviewed`, or `discarded`
+            # @param [String] dialogue_sid The SID of the
+            #   [Dialogue](https://www.twilio.com/docs/autopilot/api/dialogue).
             # @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
@@ -73,13 +78,14 @@ module Twilio
             #    but a limit is defined, stream() will attempt to read the limit with the most
             #    efficient page size, i.e. min(limit, 1000)
             # @return [Enumerable] Enumerable that will yield up to limit results
-            def stream(language: :unset, model_build: :unset, status: :unset, limit: nil, page_size: nil)
+            def stream(language: :unset, model_build: :unset, status: :unset, dialogue_sid: :unset, limit: nil, page_size: nil)
               limits = @version.read_limits(limit, page_size)
 
               page = self.page(
                   language: language,
                   model_build: model_build,
                   status: status,
+                  dialogue_sid: dialogue_sid,
                   page_size: limits[:page_size],
               )
 
@@ -109,15 +115,18 @@ module Twilio
             #   Build](https://www.twilio.com/docs/autopilot/api/model-build) to be queried.
             # @param [String] status The status of the resources to read. Can be:
             #   `pending-review`, `reviewed`, or `discarded`
+            # @param [String] dialogue_sid The SID of the
+            #   [Dialogue](https://www.twilio.com/docs/autopilot/api/dialogue).
             # @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
             # @return [Page] Page of QueryInstance
-            def page(language: :unset, model_build: :unset, status: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
+            def page(language: :unset, model_build: :unset, status: :unset, dialogue_sid: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
               params = Twilio::Values.of({
                   'Language' => language,
                   'ModelBuild' => model_build,
                   'Status' => status,
+                  'DialogueSid' => dialogue_sid,
                   'PageToken' => page_token,
                   'Page' => page_number,
                   'PageSize' => page_size,

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

@@ -60,8 +60,11 @@ module Twilio
           #   `false` and the default is `true`.
           # @param [String] alexa_skill_id Deprecated.
           # @param [String] default_alexa_notification_protocol_version Deprecated.
+          # @param [String] delivery_callback_url URL to send delivery status callback.
+          # @param [Boolean] delivery_callback_enabled Callback configuration that enables
+          #   delivery callbacks, default false
           # @return [ServiceInstance] Newly created ServiceInstance
-          def create(friendly_name: :unset, apn_credential_sid: :unset, gcm_credential_sid: :unset, messaging_service_sid: :unset, facebook_messenger_page_id: :unset, default_apn_notification_protocol_version: :unset, default_gcm_notification_protocol_version: :unset, fcm_credential_sid: :unset, default_fcm_notification_protocol_version: :unset, log_enabled: :unset, alexa_skill_id: :unset, default_alexa_notification_protocol_version: :unset)
+          def create(friendly_name: :unset, apn_credential_sid: :unset, gcm_credential_sid: :unset, messaging_service_sid: :unset, facebook_messenger_page_id: :unset, default_apn_notification_protocol_version: :unset, default_gcm_notification_protocol_version: :unset, fcm_credential_sid: :unset, default_fcm_notification_protocol_version: :unset, log_enabled: :unset, alexa_skill_id: :unset, default_alexa_notification_protocol_version: :unset, delivery_callback_url: :unset, delivery_callback_enabled: :unset)
             data = Twilio::Values.of({
                 'FriendlyName' => friendly_name,
                 'ApnCredentialSid' => apn_credential_sid,
@@ -75,6 +78,8 @@ module Twilio
                 'LogEnabled' => log_enabled,
                 'AlexaSkillId' => alexa_skill_id,
                 'DefaultAlexaNotificationProtocolVersion' => default_alexa_notification_protocol_version,
+                'DeliveryCallbackUrl' => delivery_callback_url,
+                'DeliveryCallbackEnabled' => delivery_callback_enabled,
             })
 
             payload = @version.create(
@@ -399,6 +404,8 @@ module Twilio
                 'links' => payload['links'],
                 'alexa_skill_id' => payload['alexa_skill_id'],
                 'default_alexa_notification_protocol_version' => payload['default_alexa_notification_protocol_version'],
+                'delivery_callback_url' => payload['delivery_callback_url'],
+                'delivery_callback_enabled' => payload['delivery_callback_enabled'],
             }
 
             # Context
@@ -525,6 +532,18 @@ module Twilio
             @properties['default_alexa_notification_protocol_version']
           end
 
+          ##
+          # @return [String] Webhook URL
+          def delivery_callback_url
+            @properties['delivery_callback_url']
+          end
+
+          ##
+          # @return [Boolean] Enable delivery callbacks
+          def delivery_callback_enabled
+            @properties['delivery_callback_enabled']
+          end
+
           ##
           # Deletes the ServiceInstance
           # @return [Boolean] true if delete succeeds, false otherwise

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

@@ -186,6 +186,12 @@ module Twilio
         self.trusted_comms.branded_calls()
       end
 
+      ##
+      # @return [Twilio::REST::Preview::TrustedComms::BrandsInformationInstance]
+      def brands_information
+        self.trusted_comms.brands_information()
+      end
+
       ##
       # @param [String] sid A 34 character string that uniquely identifies this
       #   Business.

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

@@ -16,6 +16,7 @@ module Twilio
           super
           @version = 'TrustedComms'
           @branded_calls = nil
+          @brands_information = nil
           @businesses = nil
           @cps = nil
           @current_calls = nil
@@ -28,6 +29,12 @@ module Twilio
           @branded_calls ||= BrandedCallList.new self
         end
 
+        ##
+        # @return [Twilio::REST::Preview::TrustedComms::BrandsInformationContext]
+        def brands_information
+          @brands_information ||= BrandsInformationContext.new self
+        end
+
         ##
         # @param [String] sid A 34 character string that uniquely identifies this
         #   Business.

data/lib/twilio-ruby/rest/preview/trusted_comms/brands_information.rb

@@ -0,0 +1,193 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Preview < Domain
+      class TrustedComms < 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 BrandsInformationList < ListResource
+          ##
+          # Initialize the BrandsInformationList
+          # @param [Version] version Version that contains the resource
+          # @return [BrandsInformationList] BrandsInformationList
+          def initialize(version)
+            super(version)
+
+            # Path Solution
+            @solution = {}
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '#<Twilio.Preview.TrustedComms.BrandsInformationList>'
+          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 BrandsInformationPage < Page
+          ##
+          # Initialize the BrandsInformationPage
+          # @param [Version] version Version that contains the resource
+          # @param [Response] response Response from the API
+          # @param [Hash] solution Path solution for the resource
+          # @return [BrandsInformationPage] BrandsInformationPage
+          def initialize(version, response, solution)
+            super(version, response)
+
+            # Path Solution
+            @solution = solution
+          end
+
+          ##
+          # Build an instance of BrandsInformationInstance
+          # @param [Hash] payload Payload response from the API
+          # @return [BrandsInformationInstance] BrandsInformationInstance
+          def get_instance(payload)
+            BrandsInformationInstance.new(@version, payload, )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '<Twilio.Preview.TrustedComms.BrandsInformationPage>'
+          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 BrandsInformationContext < InstanceContext
+          ##
+          # Initialize the BrandsInformationContext
+          # @param [Version] version Version that contains the resource
+          # @return [BrandsInformationContext] BrandsInformationContext
+          def initialize(version)
+            super(version)
+
+            # Path Solution
+            @solution = {}
+            @uri = "/BrandsInformation"
+          end
+
+          ##
+          # Fetch a BrandsInformationInstance
+          # @return [BrandsInformationInstance] Fetched BrandsInformationInstance
+          def fetch
+            params = Twilio::Values.of({})
+
+            payload = @version.fetch(
+                'GET',
+                @uri,
+                params,
+            )
+
+            BrandsInformationInstance.new(@version, payload, )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.Preview.TrustedComms.BrandsInformationContext #{context}>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.Preview.TrustedComms.BrandsInformationContext #{context}>"
+          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 BrandsInformationInstance < InstanceResource
+          ##
+          # Initialize the BrandsInformationInstance
+          # @param [Version] version Version that contains the resource
+          # @param [Hash] payload payload that contains response from Twilio
+          # @return [BrandsInformationInstance] BrandsInformationInstance
+          def initialize(version, payload)
+            super(version)
+
+            # Marshaled Properties
+            @properties = {
+                'update_time' => Twilio.deserialize_iso8601_datetime(payload['update_time']),
+                'file_link' => payload['file_link'],
+                'file_link_ttl_in_seconds' => payload['file_link_ttl_in_seconds'],
+                '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 [BrandsInformationContext] BrandsInformationContext for this BrandsInformationInstance
+          def context
+            unless @instance_context
+              @instance_context = BrandsInformationContext.new(@version, )
+            end
+            @instance_context
+          end
+
+          ##
+          # @return [Time] Creation time of the information retrieved
+          def update_time
+            @properties['update_time']
+          end
+
+          ##
+          # @return [String] The URL to the brands information
+          def file_link
+            @properties['file_link']
+          end
+
+          ##
+          # @return [String] How long will be the `file_link` valid
+          def file_link_ttl_in_seconds
+            @properties['file_link_ttl_in_seconds']
+          end
+
+          ##
+          # @return [String] The URL of this resource
+          def url
+            @properties['url']
+          end
+
+          ##
+          # Fetch a BrandsInformationInstance
+          # @return [BrandsInformationInstance] Fetched BrandsInformationInstance
+          def fetch
+            context.fetch
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+            "<Twilio.Preview.TrustedComms.BrandsInformationInstance #{values}>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+            "<Twilio.Preview.TrustedComms.BrandsInformationInstance #{values}>"
+          end
+        end
+      end
+    end
+  end
+end