twilio-ruby 5.25.2 → 5.25.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b7446c84d3fdaed8c3eb92e246ecabcb0c86e5976724a89dfd3aceb351fa6fb3
-  data.tar.gz: f2375e0fe848ef5cec994d4deaf5c574b26d713bf2d14b3cbe39f0e21e94d336
+  metadata.gz: bd77745a32efbf1a49af3c876422268d4f97ef2ffe20232d1017601a9794a0c0
+  data.tar.gz: 7d2dc0964c166398c12b1ab1022cc83ca5bd94418ae52a8a60a970c43b9f2dd1
 SHA512:
-  metadata.gz: 30136b3f112902c4fd00f4bee84fddab76b2fbd73d24b82cfb4b0d12e9fb2dd3236be819d9227f0e3b6073ff0625111df62c161305fcb2a8c2f823d605f5125a
-  data.tar.gz: aec7f152ab3c8a5ee3f4068e7d426b0662b7ad7db0da10c4f1205309aa2f4485d4c7940190ad62d2e46f9dedfaac98179513fcddac07a32214de6b1ee2015b51
+  metadata.gz: 9f6db888d496163430367b37eb030b8eba4c5e58e2186f2abd895a034c688f9872753a1ed62bdb063e64d1f1370b9bf0f8c8fbca49a9623b44f3cb229e4b1e75
+  data.tar.gz: df9c5bc3cb0f1caab8cb278625dc275cc3643f4f846ea7489eac804e656dadf085af2b6bc126bbefe61970fe7a5c2d5311f819def58857dbf0b1accc716814cc

data/CHANGES.md

@@ -1,6 +1,17 @@
 twilio-ruby changelog
 =====================
 
+[2019-08-05] Version 5.25.3
+----------------------------
+**Preview**
+- Added support for the header `Twilio-Sandbox-Mode` to mock all Voice dependencies
+
+**Twiml**
+- Add support for `<Siprec>` noun
+- Add support for `<Stream>` noun
+- Create verbs `<Start>` and `<Stop>`
+
+
 [2019-07-24] Version 5.25.2
 ----------------------------
 **Insights**

data/README.md

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

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

@@ -28,6 +28,14 @@ module Twilio
         @v1 ||= V1.new self
       end
 
+      ##
+      # @param [String] sid A 34 character string that uniquely identifies this Service.
+      # @return [Twilio::REST::Authy::V1::ServiceInstance] if sid was passed.
+      # @return [Twilio::REST::Authy::V1::ServiceList]
+      def services(sid=:unset)
+        self.v1.services(sid)
+      end
+
       ##
       # @param [form.FormTypes] form_type The Type of this Form. One of `form-app-push`,
       #   `form-sms` or `form-totp`.
@@ -37,14 +45,6 @@ module Twilio
         self.v1.forms(form_type)
       end
 
-      ##
-      # @param [String] sid A 34 character string that uniquely identifies this Service.
-      # @return [Twilio::REST::Authy::V1::ServiceInstance] if sid was passed.
-      # @return [Twilio::REST::Authy::V1::ServiceList]
-      def services(sid=:unset)
-        self.v1.services(sid)
-      end
-
       ##
       # Provide a user friendly representation
       def to_s

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

@@ -15,8 +15,22 @@ module Twilio
         def initialize(domain)
           super
           @version = 'v1'
-          @forms = nil
           @services = nil
+          @forms = nil
+        end
+
+        ##
+        # @param [String] sid A 34 character string that uniquely identifies this Service.
+        # @return [Twilio::REST::Authy::V1::ServiceContext] if sid was passed.
+        # @return [Twilio::REST::Authy::V1::ServiceList]
+        def services(sid=:unset)
+          if sid.nil?
+            raise ArgumentError, 'sid cannot be nil'
+          elsif sid == :unset
+            @services ||= ServiceList.new self
+          else
+            ServiceContext.new(self, sid)
+          end
         end
 
         ##
@@ -34,20 +48,6 @@ module Twilio
           end
         end
 
-        ##
-        # @param [String] sid A 34 character string that uniquely identifies this Service.
-        # @return [Twilio::REST::Authy::V1::ServiceContext] if sid was passed.
-        # @return [Twilio::REST::Authy::V1::ServiceList]
-        def services(sid=:unset)
-          if sid.nil?
-            raise ArgumentError, 'sid cannot be nil'
-          elsif sid == :unset
-            @services ||= ServiceList.new self
-          else
-            ServiceContext.new(self, sid)
-          end
-        end
-
         ##
         # Provide a user friendly representation
         def to_s

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

@@ -30,6 +30,7 @@ module Twilio
         @authy = nil
         @autopilot = nil
         @chat = nil
+        @conversations = nil
         @fax = nil
         @flex_api = nil
         @insights = nil
@@ -130,6 +131,12 @@ module Twilio
         @chat ||= Chat.new self
       end
 
+      ##
+      # Access the Conversations Twilio Domain
+      def conversations
+        @conversations ||= Conversations.new self
+      end
+
       ##
       # Access the Fax Twilio Domain
       def fax

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

@@ -0,0 +1,53 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Conversations < Domain
+      ##
+      # Initialize the Conversations Domain
+      def initialize(twilio)
+        super
+
+        @base_url = 'https://conversations.twilio.com'
+        @host = 'conversations.twilio.com'
+        @port = 443
+
+        # Versions
+        @v1 = nil
+      end
+
+      ##
+      # Version v1 of conversations
+      def v1
+        @v1 ||= V1.new self
+      end
+
+      ##
+      # @param [String] sid A 34 character string that uniquely identifies this
+      #   resource.
+      # @return [Twilio::REST::Conversations::V1::ConversationInstance] if sid was passed.
+      # @return [Twilio::REST::Conversations::V1::ConversationList]
+      def conversations(sid=:unset)
+        self.v1.conversations(sid)
+      end
+
+      ##
+      # @return [Twilio::REST::Conversations::V1::WebhookInstance]
+      def webhooks
+        self.v1.webhooks()
+      end
+
+      ##
+      # Provide a user friendly representation
+      def to_s
+        '#<Twilio::REST::Conversations>'
+      end
+    end
+  end
+end

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

@@ -0,0 +1,51 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Conversations
+      class V1 < Version
+        ##
+        # Initialize the V1 version of Conversations
+        def initialize(domain)
+          super
+          @version = 'v1'
+          @conversations = nil
+          @webhooks = nil
+        end
+
+        ##
+        # @param [String] sid A 34 character string that uniquely identifies this
+        #   resource.
+        # @return [Twilio::REST::Conversations::V1::ConversationContext] if sid was passed.
+        # @return [Twilio::REST::Conversations::V1::ConversationList]
+        def conversations(sid=:unset)
+          if sid.nil?
+            raise ArgumentError, 'sid cannot be nil'
+          elsif sid == :unset
+            @conversations ||= ConversationList.new self
+          else
+            ConversationContext.new(self, sid)
+          end
+        end
+
+        ##
+        # @return [Twilio::REST::Conversations::V1::WebhookContext]
+        def webhooks
+          @webhooks ||= WebhookContext.new self
+        end
+
+        ##
+        # Provide a user friendly representation
+        def to_s
+          '<Twilio::REST::Conversations::V1>'
+        end
+      end
+    end
+  end
+end

data/lib/twilio-ruby/rest/conversations/v1/conversation.rb

@@ -0,0 +1,471 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Conversations < 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 ConversationList < ListResource
+          ##
+          # Initialize the ConversationList
+          # @param [Version] version Version that contains the resource
+          # @return [ConversationList] ConversationList
+          def initialize(version)
+            super(version)
+
+            # Path Solution
+            @solution = {}
+            @uri = "/Conversations"
+          end
+
+          ##
+          # Retrieve a single page of ConversationInstance records from the API.
+          # Request is executed immediately.
+          # @param [String] friendly_name The human-readable name of this conversation,
+          #   limited to 256 characters. Optional.
+          # @param [Time] date_created The date that this resource was created.
+          # @param [Time] date_updated The date that this resource was last updated.
+          # @param [String] messaging_service_sid The unique id of the [SMS
+          #   Service](https://www.twilio.com/docs/sms/services/api) this conversation belongs
+          #   to.
+          # @return [ConversationInstance] Newly created ConversationInstance
+          def create(friendly_name: :unset, date_created: :unset, date_updated: :unset, messaging_service_sid: :unset)
+            data = Twilio::Values.of({
+                'FriendlyName' => friendly_name,
+                'DateCreated' => Twilio.serialize_iso8601_datetime(date_created),
+                'DateUpdated' => Twilio.serialize_iso8601_datetime(date_updated),
+                'MessagingServiceSid' => messaging_service_sid,
+            })
+
+            payload = @version.create(
+                'POST',
+                @uri,
+                data: data
+            )
+
+            ConversationInstance.new(@version, payload, )
+          end
+
+          ##
+          # Lists ConversationInstance 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 ConversationInstance 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 ConversationInstance 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 ConversationInstance 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 ConversationInstance
+          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
+            )
+            ConversationPage.new(@version, response, @solution)
+          end
+
+          ##
+          # Retrieve a single page of ConversationInstance records from the API.
+          # Request is executed immediately.
+          # @param [String] target_url API-generated URL for the requested results page
+          # @return [Page] Page of ConversationInstance
+          def get_page(target_url)
+            response = @version.domain.request(
+                'GET',
+                target_url
+            )
+            ConversationPage.new(@version, response, @solution)
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '#<Twilio.Conversations.V1.ConversationList>'
+          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 ConversationPage < Page
+          ##
+          # Initialize the ConversationPage
+          # @param [Version] version Version that contains the resource
+          # @param [Response] response Response from the API
+          # @param [Hash] solution Path solution for the resource
+          # @return [ConversationPage] ConversationPage
+          def initialize(version, response, solution)
+            super(version, response)
+
+            # Path Solution
+            @solution = solution
+          end
+
+          ##
+          # Build an instance of ConversationInstance
+          # @param [Hash] payload Payload response from the API
+          # @return [ConversationInstance] ConversationInstance
+          def get_instance(payload)
+            ConversationInstance.new(@version, payload, )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '<Twilio.Conversations.V1.ConversationPage>'
+          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 ConversationContext < InstanceContext
+          ##
+          # Initialize the ConversationContext
+          # @param [Version] version Version that contains the resource
+          # @param [String] sid A 34 character string that uniquely identifies this
+          #   resource.
+          # @return [ConversationContext] ConversationContext
+          def initialize(version, sid)
+            super(version)
+
+            # Path Solution
+            @solution = {sid: sid, }
+            @uri = "/Conversations/#{@solution[:sid]}"
+
+            # Dependents
+            @participants = nil
+            @messages = nil
+            @webhooks = nil
+          end
+
+          ##
+          # Update the ConversationInstance
+          # @param [String] friendly_name The human-readable name of this conversation,
+          #   limited to 256 characters. Optional.
+          # @param [Time] date_created The date that this resource was created.
+          # @param [Time] date_updated The date that this resource was last updated.
+          # @return [ConversationInstance] Updated ConversationInstance
+          def update(friendly_name: :unset, date_created: :unset, date_updated: :unset)
+            data = Twilio::Values.of({
+                'FriendlyName' => friendly_name,
+                'DateCreated' => Twilio.serialize_iso8601_datetime(date_created),
+                'DateUpdated' => Twilio.serialize_iso8601_datetime(date_updated),
+            })
+
+            payload = @version.update(
+                'POST',
+                @uri,
+                data: data,
+            )
+
+            ConversationInstance.new(@version, payload, sid: @solution[:sid], )
+          end
+
+          ##
+          # Deletes the ConversationInstance
+          # @return [Boolean] true if delete succeeds, true otherwise
+          def delete
+            @version.delete('delete', @uri)
+          end
+
+          ##
+          # Fetch a ConversationInstance
+          # @return [ConversationInstance] Fetched ConversationInstance
+          def fetch
+            params = Twilio::Values.of({})
+
+            payload = @version.fetch(
+                'GET',
+                @uri,
+                params,
+            )
+
+            ConversationInstance.new(@version, payload, sid: @solution[:sid], )
+          end
+
+          ##
+          # Access the participants
+          # @return [ParticipantList]
+          # @return [ParticipantContext] if sid was passed.
+          def participants(sid=:unset)
+            raise ArgumentError, 'sid cannot be nil' if sid.nil?
+
+            if sid != :unset
+              return ParticipantContext.new(@version, @solution[:sid], sid, )
+            end
+
+            unless @participants
+              @participants = ParticipantList.new(@version, conversation_sid: @solution[:sid], )
+            end
+
+            @participants
+          end
+
+          ##
+          # Access the messages
+          # @return [MessageList]
+          # @return [MessageContext] if sid was passed.
+          def messages(sid=:unset)
+            raise ArgumentError, 'sid cannot be nil' if sid.nil?
+
+            if sid != :unset
+              return MessageContext.new(@version, @solution[:sid], sid, )
+            end
+
+            unless @messages
+              @messages = MessageList.new(@version, conversation_sid: @solution[:sid], )
+            end
+
+            @messages
+          end
+
+          ##
+          # Access the webhooks
+          # @return [WebhookList]
+          # @return [WebhookContext] if sid was passed.
+          def webhooks(sid=:unset)
+            raise ArgumentError, 'sid cannot be nil' if sid.nil?
+
+            if sid != :unset
+              return WebhookContext.new(@version, @solution[:sid], sid, )
+            end
+
+            unless @webhooks
+              @webhooks = WebhookList.new(@version, conversation_sid: @solution[:sid], )
+            end
+
+            @webhooks
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.Conversations.V1.ConversationContext #{context}>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.Conversations.V1.ConversationContext #{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 ConversationInstance < InstanceResource
+          ##
+          # Initialize the ConversationInstance
+          # @param [Version] version Version that contains the resource
+          # @param [Hash] payload payload that contains response from Twilio
+          # @param [String] sid A 34 character string that uniquely identifies this
+          #   resource.
+          # @return [ConversationInstance] ConversationInstance
+          def initialize(version, payload, sid: nil)
+            super(version)
+
+            # Marshaled Properties
+            @properties = {
+                'account_sid' => payload['account_sid'],
+                'chat_service_sid' => payload['chat_service_sid'],
+                'messaging_service_sid' => payload['messaging_service_sid'],
+                'sid' => payload['sid'],
+                'friendly_name' => payload['friendly_name'],
+                '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 [ConversationContext] ConversationContext for this ConversationInstance
+          def context
+            unless @instance_context
+              @instance_context = ConversationContext.new(@version, @params['sid'], )
+            end
+            @instance_context
+          end
+
+          ##
+          # @return [String] The unique id of the Account responsible for this conversation.
+          def account_sid
+            @properties['account_sid']
+          end
+
+          ##
+          # @return [String] The unique id of the Chat Service this conversation belongs to.
+          def chat_service_sid
+            @properties['chat_service_sid']
+          end
+
+          ##
+          # @return [String] The unique id of the SMS Service this conversation belongs to.
+          def messaging_service_sid
+            @properties['messaging_service_sid']
+          end
+
+          ##
+          # @return [String] A 34 character string that uniquely identifies this resource.
+          def sid
+            @properties['sid']
+          end
+
+          ##
+          # @return [String] The human-readable name of this conversation.
+          def friendly_name
+            @properties['friendly_name']
+          end
+
+          ##
+          # @return [Time] The date that this resource was created.
+          def date_created
+            @properties['date_created']
+          end
+
+          ##
+          # @return [Time] The date that this resource was last updated.
+          def date_updated
+            @properties['date_updated']
+          end
+
+          ##
+          # @return [String] An absolute URL for this conversation.
+          def url
+            @properties['url']
+          end
+
+          ##
+          # @return [String] Absolute URLs to access the Participants of this Conversation.
+          def links
+            @properties['links']
+          end
+
+          ##
+          # Update the ConversationInstance
+          # @param [String] friendly_name The human-readable name of this conversation,
+          #   limited to 256 characters. Optional.
+          # @param [Time] date_created The date that this resource was created.
+          # @param [Time] date_updated The date that this resource was last updated.
+          # @return [ConversationInstance] Updated ConversationInstance
+          def update(friendly_name: :unset, date_created: :unset, date_updated: :unset)
+            context.update(friendly_name: friendly_name, date_created: date_created, date_updated: date_updated, )
+          end
+
+          ##
+          # Deletes the ConversationInstance
+          # @return [Boolean] true if delete succeeds, true otherwise
+          def delete
+            context.delete
+          end
+
+          ##
+          # Fetch a ConversationInstance
+          # @return [ConversationInstance] Fetched ConversationInstance
+          def fetch
+            context.fetch
+          end
+
+          ##
+          # Access the participants
+          # @return [participants] participants
+          def participants
+            context.participants
+          end
+
+          ##
+          # Access the messages
+          # @return [messages] messages
+          def messages
+            context.messages
+          end
+
+          ##
+          # Access the webhooks
+          # @return [webhooks] webhooks
+          def webhooks
+            context.webhooks
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+            "<Twilio.Conversations.V1.ConversationInstance #{values}>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+            "<Twilio.Conversations.V1.ConversationInstance #{values}>"
+          end
+        end
+      end
+    end
+  end
+end