twilio-ruby 5.2.0 → 5.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8d533d87716914f7de3176c3a076a57f724bddde
-  data.tar.gz: 19f83ab1668c792dd6b392e2d5e22c3d936636c5
+  metadata.gz: 2af2bf820a3fb5e86dac192777b9fa9033838f58
+  data.tar.gz: 9c2a731cf45ccc73b532590f8c557facb6831cce
 SHA512:
-  metadata.gz: 07c6a28ba0ac34f19fb1f0a9eaf69095f459a9bcc09f5c825aac523bdf0e41784458e559bdbd1cfcb0b99374ea63eecb1848f8cf8c65601bc24b7d9f7136163f
-  data.tar.gz: ed1f51c729bd7b1fffe60f2c23fc9e4307826dbd757a7cdfc1bbeffb5c02f8003e50dbb65142dc0207fcebd4dafeb87f2f41731ff7caae4120b5b1c1851216ce
+  metadata.gz: 3ea412fd75b56cd6c192b945a8cb24539137cab3c1d0efe1a6a9d4d503e3b02f6b06b2a7d1905f6d1d1375209b06fe6c9cd6c12a6c886f6bd2942d4da1d6afaf
+  data.tar.gz: 3b5d3ad04265157711e657703e3768ee1140d58b8a927a3f6b152a16881a86308a95a3dbe1ef85d4e85a3ce1e17e9d728150fdf2cf8d711e99af02bbfe28d5d3

data/.rubocop.yml

@@ -6,6 +6,7 @@ AllCops:
     - 'lib/twilio-ruby/rest/**/*'
     - 'spec/integration/**/*'
     - 'lib/twilio-ruby/version.rb'
+    - 'lib/twilio-ruby/twiml/**/*'
 
 Metrics/LineLength:
   Max: 120

data/.travis.yml

@@ -7,7 +7,7 @@ rvm:
   - 2.4.0
   - 2.3.0
   - 2.2.0
-  - 2.1.0
+  - 2.1
   - 2.0.0
 matrix:
   fast_finish: true

data/CHANGES.md

@@ -1,6 +1,15 @@
 twilio-ruby changelog
 =====================
 
+[2017-09-01] Version 5.2.1
+---------------------------
+**Sync**
+- Add support for Streams
+
+**Wireless**
+- Added DataSessions sub-resource to Sims.
+
+
 [2017-08-25] Version 5.2.0
 ---------------------------
 **Library**

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.2.0'
+gem 'twilio-ruby', '~> 5.2.1'
 ```
 
 To manually install `twilio-ruby` via [Rubygems][rubygems] simply gem install:
 
 ```bash
-gem install twilio-ruby -v 5.2.0
+gem install twilio-ruby -v 5.2.1
 ```
 
 To build and install the development branch yourself from the latest source:

data/lib/twilio-ruby/rest/sync/v1/service/sync_stream/stream_message.rb

@@ -0,0 +1,150 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+
+module Twilio
+  module REST
+    class Sync < Domain
+      class V1 < Version
+        class ServiceContext < InstanceContext
+          class SyncStreamContext < InstanceContext
+            ##
+            # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+            class StreamMessageList < ListResource
+              ##
+              # Initialize the StreamMessageList
+              # @param [Version] version Version that contains the resource
+              # @param [String] service_sid The unique SID identifier of the Service Instance.
+              # @param [String] stream_sid The unique 34-character SID identifier of the Stream.
+              # @return [StreamMessageList] StreamMessageList
+              def initialize(version, service_sid: nil, stream_sid: nil)
+                super(version)
+
+                # Path Solution
+                @solution = {
+                    service_sid: service_sid,
+                    stream_sid: stream_sid
+                }
+                @uri = "/Services/#{@solution[:service_sid]}/Streams/#{@solution[:stream_sid]}/Messages"
+              end
+
+              ##
+              # Retrieve a single page of StreamMessageInstance records from the API.
+              # Request is executed immediately.
+              # @param [Hash] data The body of the Stream Message. Arbitrary JSON object,
+              #   maximum size 4KB.
+              # @return [StreamMessageInstance] Newly created StreamMessageInstance
+              def create(data: nil)
+                data = Twilio::Values.of({
+                    'Data' => Twilio.serialize_object(data),
+                })
+
+                payload = @version.create(
+                    'POST',
+                    @uri,
+                    data: data
+                )
+
+                StreamMessageInstance.new(
+                    @version,
+                    payload,
+                    service_sid: @solution[:service_sid],
+                    stream_sid: @solution[:stream_sid],
+                )
+              end
+
+              ##
+              # Provide a user friendly representation
+              def to_s
+                '#<Twilio.Sync.V1.StreamMessageList>'
+              end
+            end
+
+            ##
+            # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+            class StreamMessagePage < Page
+              ##
+              # Initialize the StreamMessagePage
+              # @param [Version] version Version that contains the resource
+              # @param [Response] response Response from the API
+              # @param [Hash] solution Path solution for the resource
+              # @return [StreamMessagePage] StreamMessagePage
+              def initialize(version, response, solution)
+                super(version, response)
+
+                # Path Solution
+                @solution = solution
+              end
+
+              ##
+              # Build an instance of StreamMessageInstance
+              # @param [Hash] payload Payload response from the API
+              # @return [StreamMessageInstance] StreamMessageInstance
+              def get_instance(payload)
+                StreamMessageInstance.new(
+                    @version,
+                    payload,
+                    service_sid: @solution[:service_sid],
+                    stream_sid: @solution[:stream_sid],
+                )
+              end
+
+              ##
+              # Provide a user friendly representation
+              def to_s
+                '<Twilio.Sync.V1.StreamMessagePage>'
+              end
+            end
+
+            ##
+            # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+            class StreamMessageInstance < InstanceResource
+              ##
+              # Initialize the StreamMessageInstance
+              # @param [Version] version Version that contains the resource
+              # @param [Hash] payload payload that contains response from Twilio
+              # @param [String] service_sid The unique SID identifier of the Service Instance.
+              # @param [String] stream_sid The unique 34-character SID identifier of the Stream.
+              # @return [StreamMessageInstance] StreamMessageInstance
+              def initialize(version, payload, service_sid: nil, stream_sid: nil)
+                super(version)
+
+                # Marshaled Properties
+                @properties = {
+                    'sid' => payload['sid'],
+                    'data' => payload['data'],
+                }
+              end
+
+              ##
+              # @return [String] Stream Message SID.
+              def sid
+                @properties['sid']
+              end
+
+              ##
+              # @return [Hash] Stream Message body.
+              def data
+                @properties['data']
+              end
+
+              ##
+              # Provide a user friendly representation
+              def to_s
+                "<Twilio.Sync.V1.StreamMessageInstance>"
+              end
+
+              ##
+              # Provide a detailed, user friendly representation
+              def inspect
+                "<Twilio.Sync.V1.StreamMessageInstance>"
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/twilio-ruby/rest/sync/v1/service/sync_stream.rb

@@ -0,0 +1,401 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+
+module Twilio
+  module REST
+    class Sync < Domain
+      class V1 < Version
+        class ServiceContext < InstanceContext
+          ##
+          # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+          class SyncStreamList < ListResource
+            ##
+            # Initialize the SyncStreamList
+            # @param [Version] version Version that contains the resource
+            # @param [String] service_sid The unique SID identifier of the Service Instance.
+            # @return [SyncStreamList] SyncStreamList
+            def initialize(version, service_sid: nil)
+              super(version)
+
+              # Path Solution
+              @solution = {
+                  service_sid: service_sid
+              }
+              @uri = "/Services/#{@solution[:service_sid]}/Streams"
+            end
+
+            ##
+            # Retrieve a single page of SyncStreamInstance records from the API.
+            # Request is executed immediately.
+            # @param [String] unique_name The unique and addressable name of this Stream.
+            #   Optional, up to 256 characters long.
+            # @return [SyncStreamInstance] Newly created SyncStreamInstance
+            def create(unique_name: :unset)
+              data = Twilio::Values.of({
+                  'UniqueName' => unique_name,
+              })
+
+              payload = @version.create(
+                  'POST',
+                  @uri,
+                  data: data
+              )
+
+              SyncStreamInstance.new(
+                  @version,
+                  payload,
+                  service_sid: @solution[:service_sid],
+              )
+            end
+
+            ##
+            # Lists SyncStreamInstance 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 SyncStreamInstance 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 SyncStreamInstance 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 SyncStreamInstance 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 SyncStreamInstance
+            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
+              )
+              SyncStreamPage.new(@version, response, @solution)
+            end
+
+            ##
+            # Retrieve a single page of SyncStreamInstance records from the API.
+            # Request is executed immediately.
+            # @param [String] target_url API-generated URL for the requested results page
+            # @return [Page] Page of SyncStreamInstance
+            def get_page(target_url)
+              response = @version.domain.request(
+                  'GET',
+                  target_url
+              )
+              SyncStreamPage.new(@version, response, @solution)
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              '#<Twilio.Sync.V1.SyncStreamList>'
+            end
+          end
+
+          ##
+          # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+          class SyncStreamPage < Page
+            ##
+            # Initialize the SyncStreamPage
+            # @param [Version] version Version that contains the resource
+            # @param [Response] response Response from the API
+            # @param [Hash] solution Path solution for the resource
+            # @return [SyncStreamPage] SyncStreamPage
+            def initialize(version, response, solution)
+              super(version, response)
+
+              # Path Solution
+              @solution = solution
+            end
+
+            ##
+            # Build an instance of SyncStreamInstance
+            # @param [Hash] payload Payload response from the API
+            # @return [SyncStreamInstance] SyncStreamInstance
+            def get_instance(payload)
+              SyncStreamInstance.new(
+                  @version,
+                  payload,
+                  service_sid: @solution[:service_sid],
+              )
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              '<Twilio.Sync.V1.SyncStreamPage>'
+            end
+          end
+
+          ##
+          # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+          class SyncStreamContext < InstanceContext
+            ##
+            # Initialize the SyncStreamContext
+            # @param [Version] version Version that contains the resource
+            # @param [String] service_sid The service_sid
+            # @param [String] sid Identifier of the Stream. Either a SID or a unique name.
+            # @return [SyncStreamContext] SyncStreamContext
+            def initialize(version, service_sid, sid)
+              super(version)
+
+              # Path Solution
+              @solution = {
+                  service_sid: service_sid,
+                  sid: sid,
+              }
+              @uri = "/Services/#{@solution[:service_sid]}/Streams/#{@solution[:sid]}"
+
+              # Dependents
+              @stream_messages = nil
+            end
+
+            ##
+            # Fetch a SyncStreamInstance
+            # @return [SyncStreamInstance] Fetched SyncStreamInstance
+            def fetch
+              params = Twilio::Values.of({})
+
+              payload = @version.fetch(
+                  'GET',
+                  @uri,
+                  params,
+              )
+
+              SyncStreamInstance.new(
+                  @version,
+                  payload,
+                  service_sid: @solution[:service_sid],
+                  sid: @solution[:sid],
+              )
+            end
+
+            ##
+            # Deletes the SyncStreamInstance
+            # @return [Boolean] true if delete succeeds, true otherwise
+            def delete
+              @version.delete('delete', @uri)
+            end
+
+            ##
+            # Access the stream_messages
+            # @return [StreamMessageList]
+            # @return [StreamMessageContext]
+            def stream_messages
+              unless @stream_messages
+                @stream_messages = StreamMessageList.new(
+                    @version,
+                    service_sid: @solution[:service_sid],
+                    stream_sid: @solution[:sid],
+                )
+              end
+
+              @stream_messages
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Sync.V1.SyncStreamContext #{context}>"
+            end
+          end
+
+          ##
+          # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+          class SyncStreamInstance < InstanceResource
+            ##
+            # Initialize the SyncStreamInstance
+            # @param [Version] version Version that contains the resource
+            # @param [Hash] payload payload that contains response from Twilio
+            # @param [String] service_sid The unique SID identifier of the Service Instance.
+            # @param [String] sid Identifier of the Stream. Either a SID or a unique name.
+            # @return [SyncStreamInstance] SyncStreamInstance
+            def initialize(version, payload, service_sid: nil, sid: nil)
+              super(version)
+
+              # Marshaled Properties
+              @properties = {
+                  'sid' => payload['sid'],
+                  'unique_name' => payload['unique_name'],
+                  'account_sid' => payload['account_sid'],
+                  'service_sid' => payload['service_sid'],
+                  'url' => payload['url'],
+                  'links' => payload['links'],
+                  'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
+                  'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
+                  'created_by' => payload['created_by'],
+              }
+
+              # Context
+              @instance_context = nil
+              @params = {
+                  'service_sid' => service_sid,
+                  '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 [SyncStreamContext] SyncStreamContext for this SyncStreamInstance
+            def context
+              unless @instance_context
+                @instance_context = SyncStreamContext.new(
+                    @version,
+                    @params['service_sid'],
+                    @params['sid'],
+                )
+              end
+              @instance_context
+            end
+
+            ##
+            # @return [String] Stream SID.
+            def sid
+              @properties['sid']
+            end
+
+            ##
+            # @return [String] Stream unique name.
+            def unique_name
+              @properties['unique_name']
+            end
+
+            ##
+            # @return [String] Twilio Account SID.
+            def account_sid
+              @properties['account_sid']
+            end
+
+            ##
+            # @return [String] Service Instance SID.
+            def service_sid
+              @properties['service_sid']
+            end
+
+            ##
+            # @return [String] URL of this Stream.
+            def url
+              @properties['url']
+            end
+
+            ##
+            # @return [String] Nested resource URLs.
+            def links
+              @properties['links']
+            end
+
+            ##
+            # @return [Time] The date this Stream was created.
+            def date_created
+              @properties['date_created']
+            end
+
+            ##
+            # @return [Time] The date this Stream was updated.
+            def date_updated
+              @properties['date_updated']
+            end
+
+            ##
+            # @return [String] Identity of the Stream creator.
+            def created_by
+              @properties['created_by']
+            end
+
+            ##
+            # Fetch a SyncStreamInstance
+            # @return [SyncStreamInstance] Fetched SyncStreamInstance
+            def fetch
+              context.fetch
+            end
+
+            ##
+            # Deletes the SyncStreamInstance
+            # @return [Boolean] true if delete succeeds, true otherwise
+            def delete
+              context.delete
+            end
+
+            ##
+            # Access the stream_messages
+            # @return [stream_messages] stream_messages
+            def stream_messages
+              context.stream_messages
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+              "<Twilio.Sync.V1.SyncStreamInstance #{values}>"
+            end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+              "<Twilio.Sync.V1.SyncStreamInstance #{values}>"
+            end
+          end
+        end
+      end
+    end
+  end
+end