twilio-ruby 5.59.0 → 5.60.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 416d1c29fdeda590addf0bc8929befb23540a3cf775993f2ab89ed27b340dae3
-  data.tar.gz: e779a8b50ef32067bdc24360a332e7a55e321012676504073901fcd44fd16ebb
+  metadata.gz: 449133db663db3b60cc607933b4783cb0aceaeae1d433b4ab0a49b3479a67e21
+  data.tar.gz: 9fb3a8f43bdcfa5fbe10924c2dcfd08c52ef5e81c65993c238987476e7743460
 SHA512:
-  metadata.gz: d3a8c48365975f47830c676157d8b6ef8c8140727816f84c670985d604e5528562f4300ccbdf4b07c76191e2c14ceea3cce9707b5812c1904df10bea2d5a0c7e
-  data.tar.gz: b58105471c3e9affa6df43a40047c6fa698e1121b2a568883ac2e4c038d1c21ce715b8c51a00ba013eb7c2a90249784308706e2266f49d07fef7186a664325f4
+  metadata.gz: 2378219ca67c2272011f66eff0327e903a99abe47b1cf770df03fe831d31e31efc39a6f84764a433b7159b0f2bb43ecf466665b58ca26507613c5037cc2bca2c
+  data.tar.gz: 439ea62d619c181d829a03e5f50e9d20c0271e479ef23abe8363478c09dfa1a25672627de7f3e5617570044af2f48e6250e8f3d87990bd2082a6460148ba2fd8

data/CHANGES.md

@@ -1,6 +1,24 @@
 twilio-ruby changelog
 =====================
 
+[2021-10-18] Version 5.60.0
+---------------------------
+**Library - Feature**
+- [PR #574](https://github.com/twilio/twilio-ruby/pull/574): Add PlaybackGrant. Thanks to [@sarahcstringer](https://github.com/sarahcstringer)!
+
+**Api**
+- Corrected enum values for `emergency_address_status` values in `/IncomingPhoneNumbers` response. **(breaking change)**
+- Clarify `emergency_address_status` values in `/IncomingPhoneNumbers` response.
+
+**Messaging**
+- Add PUT and List brand vettings api
+- Removes beta feature flag based visibility for us_app_to_person_registered and usecase field.Updates test cases to add POLITICAL usecase. **(breaking change)**
+- Add brand_feedback as optional field to BrandRegistrations
+
+**Video**
+- Add `AudioOnly` to create room
+
+
 [2021-10-06] Version 5.59.0
 ---------------------------
 **Library - Fix**

data/README.md

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

data/lib/twilio-ruby/jwt/access_token.rb

@@ -267,6 +267,19 @@ module Twilio
           payload
         end
       end
+
+      class PlaybackGrant
+        include AccessTokenGrant
+        attr_accessor :grant
+
+        def _key
+          'player'
+        end
+
+        def _generate_payload
+          grant
+        end
+      end
     end
   end
 end

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

@@ -331,6 +331,7 @@ module Twilio
                     'voice_url' => payload['voice_url'],
                     'emergency_status' => payload['emergency_status'],
                     'emergency_address_sid' => payload['emergency_address_sid'],
+                    'emergency_address_status' => payload['emergency_address_status'],
                     'bundle_sid' => payload['bundle_sid'],
                     'status' => payload['status'],
                 }
@@ -522,6 +523,12 @@ module Twilio
                 @properties['emergency_address_sid']
               end
 
+              ##
+              # @return [local.EmergencyAddressStatus] State of the emergency address configuration for the phone number
+              def emergency_address_status
+                @properties['emergency_address_status']
+              end
+
               ##
               # @return [String] The SID of the Bundle resource associated with number
               def bundle_sid

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

@@ -330,6 +330,7 @@ module Twilio
                     'voice_url' => payload['voice_url'],
                     'emergency_status' => payload['emergency_status'],
                     'emergency_address_sid' => payload['emergency_address_sid'],
+                    'emergency_address_status' => payload['emergency_address_status'],
                     'bundle_sid' => payload['bundle_sid'],
                     'status' => payload['status'],
                 }
@@ -521,6 +522,12 @@ module Twilio
                 @properties['emergency_address_sid']
               end
 
+              ##
+              # @return [mobile.EmergencyAddressStatus] State of the emergency address configuration for the phone number
+              def emergency_address_status
+                @properties['emergency_address_status']
+              end
+
               ##
               # @return [String] The SID of the Bundle resource associated with number
               def bundle_sid

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

@@ -330,6 +330,7 @@ module Twilio
                     'voice_url' => payload['voice_url'],
                     'emergency_status' => payload['emergency_status'],
                     'emergency_address_sid' => payload['emergency_address_sid'],
+                    'emergency_address_status' => payload['emergency_address_status'],
                     'bundle_sid' => payload['bundle_sid'],
                     'status' => payload['status'],
                 }
@@ -521,6 +522,12 @@ module Twilio
                 @properties['emergency_address_sid']
               end
 
+              ##
+              # @return [toll_free.EmergencyAddressStatus] State of the emergency address configuration for the phone number
+              def emergency_address_status
+                @properties['emergency_address_status']
+              end
+
               ##
               # @return [String] The SID of the Bundle resource associated with number
               def bundle_sid

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

@@ -550,6 +550,7 @@ module Twilio
                   'voice_url' => payload['voice_url'],
                   'emergency_status' => payload['emergency_status'],
                   'emergency_address_sid' => payload['emergency_address_sid'],
+                  'emergency_address_status' => payload['emergency_address_status'],
                   'bundle_sid' => payload['bundle_sid'],
                   'status' => payload['status'],
               }
@@ -756,6 +757,12 @@ module Twilio
               @properties['emergency_address_sid']
             end
 
+            ##
+            # @return [incoming_phone_number.EmergencyAddressStatus] State of the emergency address configuration for the phone number
+            def emergency_address_status
+              @properties['emergency_address_status']
+            end
+
             ##
             # @return [String] The SID of the Bundle resource associated with number
             def bundle_sid

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

@@ -41,6 +41,7 @@ module Twilio
         @insights = nil
         @ip_messaging = nil
         @lookups = nil
+        @media = nil
         @messaging = nil
         @monitor = nil
         @notify = nil
@@ -231,6 +232,12 @@ module Twilio
         @lookups ||= Lookups.new self
       end
 
+      ##
+      # Access the Media Twilio Domain
+      def media
+        @media ||= Media.new self
+      end
+
       ##
       # Access the Messaging Twilio Domain
       def messaging

data/lib/twilio-ruby/rest/media/v1/media_processor.rb

@@ -0,0 +1,384 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Media < Domain
+      class V1 < Version
+        class MediaProcessorList < ListResource
+          ##
+          # Initialize the MediaProcessorList
+          # @param [Version] version Version that contains the resource
+          # @return [MediaProcessorList] MediaProcessorList
+          def initialize(version)
+            super(version)
+
+            # Path Solution
+            @solution = {}
+            @uri = "/MediaProcessors"
+          end
+
+          ##
+          # Create the MediaProcessorInstance
+          # @param [String] extension The {Media
+          #   Extension}[/docs/live/api/media-extensions-overview] name or URL. Ex:
+          #   `video-composer-v1-preview`
+          # @param [String] extension_context The context of the Media Extension,
+          #   represented as a JSON dictionary. See the documentation for the specific {Media
+          #   Extension}[/docs/live/api/media-extensions-overview] you are using for more
+          #   information about the context to send.
+          # @param [Hash] extension_environment User-defined environment variables for the
+          #   Media Extension, represented as a JSON dictionary of key/value strings. See the
+          #   documentation for the specific {Media
+          #   Extension}[/docs/live/api/media-extensions-overview] you are using for more
+          #   information about whether you need to provide this.
+          # @param [String] status_callback The URL to which Twilio will send asynchronous
+          #   webhook requests for every MediaProcessor event. See {Status
+          #   Callbacks}[/docs/live/status-callbacks] for details.
+          # @param [String] status_callback_method The HTTP method Twilio should use to call
+          #   the `status_callback` URL. Can be `POST` or `GET` and the default is `POST`.
+          # @return [MediaProcessorInstance] Created MediaProcessorInstance
+          def create(extension: nil, extension_context: nil, extension_environment: :unset, status_callback: :unset, status_callback_method: :unset)
+            data = Twilio::Values.of({
+                'Extension' => extension,
+                'ExtensionContext' => extension_context,
+                'ExtensionEnvironment' => Twilio.serialize_object(extension_environment),
+                'StatusCallback' => status_callback,
+                'StatusCallbackMethod' => status_callback_method,
+            })
+
+            payload = @version.create('POST', @uri, data: data)
+
+            MediaProcessorInstance.new(@version, payload, )
+          end
+
+          ##
+          # Lists MediaProcessorInstance records from the API as a list.
+          # Unlike stream(), this operation is eager and will load `limit` records into
+          # memory before returning.
+          # @param [media_processor.Order] order The sort order of the list by
+          #   `date_created`. Can be: `asc` (ascending) or `desc` (descending) with `desc` as
+          #   the default.
+          # @param [media_processor.Status] status Status to filter by, with possible values
+          #   `started`, `ended` or `failed`.
+          # @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
+          #    not set will use the default value of 50 records.  If no page_size is defined
+          #    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(order: :unset, status: :unset, limit: nil, page_size: nil)
+            self.stream(order: order, status: status, limit: limit, page_size: page_size).entries
+          end
+
+          ##
+          # Streams MediaProcessorInstance records from the API as an Enumerable.
+          # This operation lazily loads records as efficiently as possible until the limit
+          # is reached.
+          # @param [media_processor.Order] order The sort order of the list by
+          #   `date_created`. Can be: `asc` (ascending) or `desc` (descending) with `desc` as
+          #   the default.
+          # @param [media_processor.Status] status Status to filter by, with possible values
+          #   `started`, `ended` or `failed`.
+          # @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
+          #    not set will use the default value of 50 records. If no page_size is defined
+          #    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(order: :unset, status: :unset, limit: nil, page_size: nil)
+            limits = @version.read_limits(limit, page_size)
+
+            page = self.page(order: order, status: status, page_size: limits[:page_size], )
+
+            @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
+          end
+
+          ##
+          # When passed a block, yields MediaProcessorInstance records from the API.
+          # This operation lazily loads records as efficiently as possible until the limit
+          # is reached.
+          def each
+            limits = @version.read_limits
+
+            page = self.page(page_size: limits[:page_size], )
+
+            @version.stream(page,
+                            limit: limits[:limit],
+                            page_limit: limits[:page_limit]).each {|x| yield x}
+          end
+
+          ##
+          # Retrieve a single page of MediaProcessorInstance records from the API.
+          # Request is executed immediately.
+          # @param [media_processor.Order] order The sort order of the list by
+          #   `date_created`. Can be: `asc` (ascending) or `desc` (descending) with `desc` as
+          #   the default.
+          # @param [media_processor.Status] status Status to filter by, with possible values
+          #   `started`, `ended` or `failed`.
+          # @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 MediaProcessorInstance
+          def page(order: :unset, status: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
+            params = Twilio::Values.of({
+                'Order' => order,
+                'Status' => status,
+                'PageToken' => page_token,
+                'Page' => page_number,
+                'PageSize' => page_size,
+            })
+
+            response = @version.page('GET', @uri, params: params)
+
+            MediaProcessorPage.new(@version, response, @solution)
+          end
+
+          ##
+          # Retrieve a single page of MediaProcessorInstance records from the API.
+          # Request is executed immediately.
+          # @param [String] target_url API-generated URL for the requested results page
+          # @return [Page] Page of MediaProcessorInstance
+          def get_page(target_url)
+            response = @version.domain.request(
+                'GET',
+                target_url
+            )
+            MediaProcessorPage.new(@version, response, @solution)
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '#<Twilio.Media.V1.MediaProcessorList>'
+          end
+        end
+
+        class MediaProcessorPage < Page
+          ##
+          # Initialize the MediaProcessorPage
+          # @param [Version] version Version that contains the resource
+          # @param [Response] response Response from the API
+          # @param [Hash] solution Path solution for the resource
+          # @return [MediaProcessorPage] MediaProcessorPage
+          def initialize(version, response, solution)
+            super(version, response)
+
+            # Path Solution
+            @solution = solution
+          end
+
+          ##
+          # Build an instance of MediaProcessorInstance
+          # @param [Hash] payload Payload response from the API
+          # @return [MediaProcessorInstance] MediaProcessorInstance
+          def get_instance(payload)
+            MediaProcessorInstance.new(@version, payload, )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '<Twilio.Media.V1.MediaProcessorPage>'
+          end
+        end
+
+        class MediaProcessorContext < InstanceContext
+          ##
+          # Initialize the MediaProcessorContext
+          # @param [Version] version Version that contains the resource
+          # @param [String] sid The SID of the MediaProcessor resource to fetch.
+          # @return [MediaProcessorContext] MediaProcessorContext
+          def initialize(version, sid)
+            super(version)
+
+            # Path Solution
+            @solution = {sid: sid, }
+            @uri = "/MediaProcessors/#{@solution[:sid]}"
+          end
+
+          ##
+          # Fetch the MediaProcessorInstance
+          # @return [MediaProcessorInstance] Fetched MediaProcessorInstance
+          def fetch
+            payload = @version.fetch('GET', @uri)
+
+            MediaProcessorInstance.new(@version, payload, sid: @solution[:sid], )
+          end
+
+          ##
+          # Update the MediaProcessorInstance
+          # @param [media_processor.UpdateStatus] status The status of the MediaProcessor.
+          #   Can be `ended`.
+          # @return [MediaProcessorInstance] Updated MediaProcessorInstance
+          def update(status: nil)
+            data = Twilio::Values.of({'Status' => status, })
+
+            payload = @version.update('POST', @uri, data: data)
+
+            MediaProcessorInstance.new(@version, payload, sid: @solution[:sid], )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.Media.V1.MediaProcessorContext #{context}>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.Media.V1.MediaProcessorContext #{context}>"
+          end
+        end
+
+        class MediaProcessorInstance < InstanceResource
+          ##
+          # Initialize the MediaProcessorInstance
+          # @param [Version] version Version that contains the resource
+          # @param [Hash] payload payload that contains response from Twilio
+          # @param [String] sid The SID of the MediaProcessor resource to fetch.
+          # @return [MediaProcessorInstance] MediaProcessorInstance
+          def initialize(version, payload, sid: nil)
+            super(version)
+
+            # Marshaled Properties
+            @properties = {
+                'account_sid' => payload['account_sid'],
+                'sid' => payload['sid'],
+                'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
+                'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
+                'extension' => payload['extension'],
+                'extension_context' => payload['extension_context'],
+                'status' => payload['status'],
+                'url' => payload['url'],
+                'ended_reason' => payload['ended_reason'],
+                'status_callback' => payload['status_callback'],
+                'status_callback_method' => payload['status_callback_method'],
+            }
+
+            # Context
+            @instance_context = nil
+            @params = {'sid' => sid || @properties['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 [MediaProcessorContext] MediaProcessorContext for this MediaProcessorInstance
+          def context
+            unless @instance_context
+              @instance_context = MediaProcessorContext.new(@version, @params['sid'], )
+            end
+            @instance_context
+          end
+
+          ##
+          # @return [String] The SID of the Account that created the resource
+          def account_sid
+            @properties['account_sid']
+          end
+
+          ##
+          # @return [String] The unique string that identifies the resource
+          def sid
+            @properties['sid']
+          end
+
+          ##
+          # @return [Time] The ISO 8601 date and time in GMT when the resource was created
+          def date_created
+            @properties['date_created']
+          end
+
+          ##
+          # @return [Time] The ISO 8601 date and time in GMT when the resource was last updated
+          def date_updated
+            @properties['date_updated']
+          end
+
+          ##
+          # @return [String] The Media Extension name or URL
+          def extension
+            @properties['extension']
+          end
+
+          ##
+          # @return [String] The Media Extension context
+          def extension_context
+            @properties['extension_context']
+          end
+
+          ##
+          # @return [media_processor.Status] The status of the MediaProcessor
+          def status
+            @properties['status']
+          end
+
+          ##
+          # @return [String] The absolute URL of the resource
+          def url
+            @properties['url']
+          end
+
+          ##
+          # @return [String] The reason why a MediaProcessor ended
+          def ended_reason
+            @properties['ended_reason']
+          end
+
+          ##
+          # @return [String] The URL to which Twilio will send MediaProcessor event updates
+          def status_callback
+            @properties['status_callback']
+          end
+
+          ##
+          # @return [String] The HTTP method Twilio should use to call the `status_callback` URL
+          def status_callback_method
+            @properties['status_callback_method']
+          end
+
+          ##
+          # Fetch the MediaProcessorInstance
+          # @return [MediaProcessorInstance] Fetched MediaProcessorInstance
+          def fetch
+            context.fetch
+          end
+
+          ##
+          # Update the MediaProcessorInstance
+          # @param [media_processor.UpdateStatus] status The status of the MediaProcessor.
+          #   Can be `ended`.
+          # @return [MediaProcessorInstance] Updated MediaProcessorInstance
+          def update(status: nil)
+            context.update(status: status, )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+            "<Twilio.Media.V1.MediaProcessorInstance #{values}>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+            "<Twilio.Media.V1.MediaProcessorInstance #{values}>"
+          end
+        end
+      end
+    end
+  end
+end