twilio-ruby 5.6.1 → 5.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1730c56fd67a4a8a538aa475394d5ffff5f45608
-  data.tar.gz: 9713a07ed9639618bbacf581f8b38f5c826cbca9
+  metadata.gz: f8a92e178cfc380c3fc508787840bf7988811dab
+  data.tar.gz: 597a1df255cfd8542a868c06e5519d1576f0d80d
 SHA512:
-  metadata.gz: 9a476d20c60f239465c765c1f77e6785bf4da6768d77a63b40aadc960f4a39129eff164f67653c2801e784a1921499dd4cad7cd8cbefd7c4262b55b7ac4afd9b
-  data.tar.gz: be0a53c0177968fd0536c0dc62723a795d9e9972652fe0615ecd80cebee20a2f90da9c982f56dc15702ebb472c45b2404bd010da1121d5c29b1d18e82263156e
+  metadata.gz: d3ac5a9a007c736cc73ead9711c5790fe51d9ad7750f4b9f82e55c59f1c6f9af3682d1710069d594c4ca74b1afadf0c5bf41c9e9ab64c00ee5f94d4add8ba3fa
+  data.tar.gz: 31cb8f8246a185a8bad889687e4f321df5a32e6307431fb8902f7be355e27dded56856a2a9be1b42fc2cd29402dad60d7826d8d115f417a0f89d64b54449dcbc

data/CHANGES.md

@@ -1,6 +1,24 @@
 twilio-ruby changelog
 =====================
 
+[2018-01-30] Version 5.6.2
+---------------------------
+**Api**
+- Add `studio-engagements` usage key
+
+**Preview**
+- Remove Studio Engagement Deletion
+
+**Studio**
+- Initial Release
+
+**Video**
+- [omit] Beta: Allow updates to `SubscribedTracks`.
+- Add `SubscribedTracks`.
+- Add track name to Video Recording resource
+- Add Composition and Composition Media resources
+
+
 [2018-01-22] Version 5.6.1
 ---------------------------
 **Api**

data/README.md

@@ -27,13 +27,13 @@ in-line code documentation here in the library.
 To install using [Bundler][bundler] grab the latest stable version:
 
 ```ruby
-gem 'twilio-ruby', '~> 5.6.1'
+gem 'twilio-ruby', '~> 5.6.2'
 ```
 
 To manually install `twilio-ruby` via [Rubygems][rubygems] simply gem install:
 
 ```bash
-gem install twilio-ruby -v 5.6.1
+gem install twilio-ruby -v 5.6.2
 ```
 
 To build and install the development branch yourself from the latest source:

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

@@ -40,6 +40,7 @@ module Twilio
         @messaging = nil
         @wireless = nil
         @sync = nil
+        @studio = nil
       end
 
       ##
@@ -183,6 +184,12 @@ module Twilio
         @sync ||= Sync.new self
       end
 
+      ##
+      # Access the Studio Twilio Domain
+      def studio
+        @studio ||= Studio.new self
+      end
+
       ##
       # @param [String] sid The sid
       # @return [Twilio::REST::Api::V2010::AccountContext::AddressInstance] if sid was passed.

data/lib/twilio-ruby/rest/preview/studio/flow/engagement.rb

@@ -199,13 +199,6 @@ module Twilio
               EngagementInstance.new(@version, payload, flow_sid: @solution[:flow_sid], sid: @solution[:sid], )
             end
 
-            ##
-            # Deletes the EngagementInstance
-            # @return [Boolean] true if delete succeeds, true otherwise
-            def delete
-              @version.delete('delete', @uri)
-            end
-
             ##
             # Access the steps
             # @return [StepList]
@@ -349,13 +342,6 @@ module Twilio
               context.fetch
             end
 
-            ##
-            # Deletes the EngagementInstance
-            # @return [Boolean] true if delete succeeds, true otherwise
-            def delete
-              context.delete
-            end
-
             ##
             # Access the steps
             # @return [steps] steps

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

@@ -0,0 +1,44 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+
+module Twilio
+  module REST
+    class Studio < Domain
+      ##
+      # Initialize the Studio Domain
+      def initialize(twilio)
+        super
+
+        @base_url = 'https://studio.twilio.com'
+        @host = 'studio.twilio.com'
+        @port = 443
+
+        # Versions
+        @v1 = nil
+      end
+
+      ##
+      # Version v1 of studio
+      def v1
+        @v1 ||= V1.new self
+      end
+
+      ##
+      # @param [String] sid The sid
+      # @return [Twilio::REST::Studio::V1::FlowInstance] if sid was passed.
+      # @return [Twilio::REST::Studio::V1::FlowList]
+      def flows(sid=:unset)
+        self.v1.flows(sid)
+      end
+
+      ##
+      # Provide a user friendly representation
+      def to_s
+        '#<Twilio::REST::Studio>'
+      end
+    end
+  end
+end

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

@@ -0,0 +1,41 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+
+module Twilio
+  module REST
+    class Studio
+      class V1 < Version
+        ##
+        # Initialize the V1 version of Studio
+        def initialize(domain)
+          super
+          @version = 'v1'
+          @flows = nil
+        end
+
+        ##
+        # @param [String] sid The sid
+        # @return [Twilio::REST::Studio::V1::FlowContext] if sid was passed.
+        # @return [Twilio::REST::Studio::V1::FlowList]
+        def flows(sid=:unset)
+          if sid.nil?
+            raise ArgumentError, 'sid cannot be nil'
+          elsif sid == :unset
+            @flows ||= FlowList.new self
+          else
+            FlowContext.new(self, sid)
+          end
+        end
+
+        ##
+        # Provide a user friendly representation
+        def to_s
+          '<Twilio::REST::Studio::V1>'
+        end
+      end
+    end
+  end
+end

data/lib/twilio-ruby/rest/studio/v1/flow.rb

@@ -0,0 +1,346 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+
+module Twilio
+  module REST
+    class Studio < Domain
+      class V1 < Version
+        ##
+        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+        class FlowList < ListResource
+          ##
+          # Initialize the FlowList
+          # @param [Version] version Version that contains the resource
+          # @return [FlowList] FlowList
+          def initialize(version)
+            super(version)
+
+            # Path Solution
+            @solution = {}
+            @uri = "/Flows"
+          end
+
+          ##
+          # Lists FlowInstance records from the API as a list.
+          # Unlike stream(), this operation is eager and will load `limit` records into
+          # memory before returning.
+          # @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(limit: nil, page_size: nil)
+            self.stream(limit: limit, page_size: page_size).entries
+          end
+
+          ##
+          # Streams FlowInstance records from the API as an Enumerable.
+          # This operation lazily loads records as efficiently as possible until the limit
+          # is reached.
+          # @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(limit: nil, page_size: nil)
+            limits = @version.read_limits(limit, page_size)
+
+            page = self.page(page_size: limits[:page_size], )
+
+            @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
+          end
+
+          ##
+          # When passed a block, yields FlowInstance 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 FlowInstance records from the API.
+          # Request is executed immediately.
+          # @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 FlowInstance
+          def page(page_token: :unset, page_number: :unset, page_size: :unset)
+            params = Twilio::Values.of({
+                'PageToken' => page_token,
+                'Page' => page_number,
+                'PageSize' => page_size,
+            })
+            response = @version.page(
+                'GET',
+                @uri,
+                params
+            )
+            FlowPage.new(@version, response, @solution)
+          end
+
+          ##
+          # Retrieve a single page of FlowInstance records from the API.
+          # Request is executed immediately.
+          # @param [String] target_url API-generated URL for the requested results page
+          # @return [Page] Page of FlowInstance
+          def get_page(target_url)
+            response = @version.domain.request(
+                'GET',
+                target_url
+            )
+            FlowPage.new(@version, response, @solution)
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '#<Twilio.Studio.V1.FlowList>'
+          end
+        end
+
+        ##
+        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+        class FlowPage < Page
+          ##
+          # Initialize the FlowPage
+          # @param [Version] version Version that contains the resource
+          # @param [Response] response Response from the API
+          # @param [Hash] solution Path solution for the resource
+          # @return [FlowPage] FlowPage
+          def initialize(version, response, solution)
+            super(version, response)
+
+            # Path Solution
+            @solution = solution
+          end
+
+          ##
+          # Build an instance of FlowInstance
+          # @param [Hash] payload Payload response from the API
+          # @return [FlowInstance] FlowInstance
+          def get_instance(payload)
+            FlowInstance.new(@version, payload, )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '<Twilio.Studio.V1.FlowPage>'
+          end
+        end
+
+        ##
+        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+        class FlowContext < InstanceContext
+          ##
+          # Initialize the FlowContext
+          # @param [Version] version Version that contains the resource
+          # @param [String] sid The sid
+          # @return [FlowContext] FlowContext
+          def initialize(version, sid)
+            super(version)
+
+            # Path Solution
+            @solution = {sid: sid, }
+            @uri = "/Flows/#{@solution[:sid]}"
+
+            # Dependents
+            @engagements = nil
+          end
+
+          ##
+          # Fetch a FlowInstance
+          # @return [FlowInstance] Fetched FlowInstance
+          def fetch
+            params = Twilio::Values.of({})
+
+            payload = @version.fetch(
+                'GET',
+                @uri,
+                params,
+            )
+
+            FlowInstance.new(@version, payload, sid: @solution[:sid], )
+          end
+
+          ##
+          # Deletes the FlowInstance
+          # @return [Boolean] true if delete succeeds, true otherwise
+          def delete
+            @version.delete('delete', @uri)
+          end
+
+          ##
+          # Access the engagements
+          # @return [EngagementList]
+          # @return [EngagementContext] if sid was passed.
+          def engagements(sid=:unset)
+            raise ArgumentError, 'sid cannot be nil' if sid.nil?
+
+            if sid != :unset
+              return EngagementContext.new(@version, @solution[:sid], sid, )
+            end
+
+            unless @engagements
+              @engagements = EngagementList.new(@version, flow_sid: @solution[:sid], )
+            end
+
+            @engagements
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.Studio.V1.FlowContext #{context}>"
+          end
+        end
+
+        ##
+        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+        class FlowInstance < InstanceResource
+          ##
+          # Initialize the FlowInstance
+          # @param [Version] version Version that contains the resource
+          # @param [Hash] payload payload that contains response from Twilio
+          # @param [String] sid The sid
+          # @return [FlowInstance] FlowInstance
+          def initialize(version, payload, sid: nil)
+            super(version)
+
+            # Marshaled Properties
+            @properties = {
+                'sid' => payload['sid'],
+                'account_sid' => payload['account_sid'],
+                'friendly_name' => payload['friendly_name'],
+                'status' => payload['status'],
+                'version' => payload['version'].to_i,
+                'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
+                'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
+                'url' => payload['url'],
+                'links' => payload['links'],
+            }
+
+            # 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 [FlowContext] FlowContext for this FlowInstance
+          def context
+            unless @instance_context
+              @instance_context = FlowContext.new(@version, @params['sid'], )
+            end
+            @instance_context
+          end
+
+          ##
+          # @return [String] The sid
+          def sid
+            @properties['sid']
+          end
+
+          ##
+          # @return [String] The account_sid
+          def account_sid
+            @properties['account_sid']
+          end
+
+          ##
+          # @return [String] The friendly_name
+          def friendly_name
+            @properties['friendly_name']
+          end
+
+          ##
+          # @return [flow.Status] The status
+          def status
+            @properties['status']
+          end
+
+          ##
+          # @return [String] The version
+          def version
+            @properties['version']
+          end
+
+          ##
+          # @return [Time] The date_created
+          def date_created
+            @properties['date_created']
+          end
+
+          ##
+          # @return [Time] The date_updated
+          def date_updated
+            @properties['date_updated']
+          end
+
+          ##
+          # @return [String] The url
+          def url
+            @properties['url']
+          end
+
+          ##
+          # @return [String] The links
+          def links
+            @properties['links']
+          end
+
+          ##
+          # Fetch a FlowInstance
+          # @return [FlowInstance] Fetched FlowInstance
+          def fetch
+            context.fetch
+          end
+
+          ##
+          # Deletes the FlowInstance
+          # @return [Boolean] true if delete succeeds, true otherwise
+          def delete
+            context.delete
+          end
+
+          ##
+          # Access the engagements
+          # @return [engagements] engagements
+          def engagements
+            context.engagements
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+            "<Twilio.Studio.V1.FlowInstance #{values}>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+            "<Twilio.Studio.V1.FlowInstance #{values}>"
+          end
+        end
+      end
+    end
+  end
+end