twilio-ruby 4.13.0 → 5.0.0.alpha1

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

@@ -0,0 +1,145 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+
+module Twilio
+  module REST
+    class Preview < Domain
+      ##
+      # Initialize the Preview Domain
+      def initialize(twilio)
+        super
+
+        @base_url = 'https://preview.twilio.com'
+        @host = 'preview.twilio.com'
+        @port = 443
+
+        # Versions
+        @sync = nil
+        @wireless = nil
+        @marketplace = nil
+        @bulk_exports = nil
+        @proxy = nil
+        @hosted_numbers = nil
+      end
+
+      ##
+      # Version sync of preview
+      def sync
+        @sync ||= Sync.new self
+      end
+
+      ##
+      # Version wireless of preview
+      def wireless
+        @wireless ||= Wireless.new self
+      end
+
+      ##
+      # Version marketplace of preview
+      def marketplace
+        @marketplace ||= Marketplace.new self
+      end
+
+      ##
+      # Version bulk_exports of preview
+      def bulk_exports
+        @bulk_exports ||= BulkExports.new self
+      end
+
+      ##
+      # Version proxy of preview
+      def proxy
+        @proxy ||= Proxy.new self
+      end
+
+      ##
+      # Version hosted_numbers of preview
+      def hosted_numbers
+        @hosted_numbers ||= HostedNumbers.new self
+      end
+
+      ##
+      # @param [String] sid A 34 character string that uniquely identifies this Service.
+      # @return [Twilio::REST::Preview::Proxy::ServiceInstance] if sid was passed.
+      # @return [Twilio::REST::Preview::Proxy::ServiceList]
+      def services(sid=:unset)
+        self.proxy.services(sid)
+      end
+
+      ##
+      # @param [String] sid The sid
+      # @return [Twilio::REST::Preview::Wireless::CommandInstance] if sid was passed.
+      # @return [Twilio::REST::Preview::Wireless::CommandList]
+      def commands(sid=:unset)
+        self.wireless.commands(sid)
+      end
+
+      ##
+      # @param [String] sid The sid
+      # @return [Twilio::REST::Preview::Wireless::RatePlanInstance] if sid was passed.
+      # @return [Twilio::REST::Preview::Wireless::RatePlanList]
+      def rate_plans(sid=:unset)
+        self.wireless.rate_plans(sid)
+      end
+
+      ##
+      # @param [String] sid The sid
+      # @return [Twilio::REST::Preview::Wireless::SimInstance] if sid was passed.
+      # @return [Twilio::REST::Preview::Wireless::SimList]
+      def sims(sid=:unset)
+        self.wireless.sims(sid)
+      end
+
+      ##
+      # @param [String] sid A 34 character string that uniquely identifies this Add-on.
+      # @return [Twilio::REST::Preview::Marketplace::AvailableAddOnInstance] if sid was passed.
+      # @return [Twilio::REST::Preview::Marketplace::AvailableAddOnList]
+      def available_add_ons(sid=:unset)
+        self.marketplace.available_add_ons(sid)
+      end
+
+      ##
+      # @param [String] sid A 34 character string that uniquely identifies this Add-on
+      #   installation.
+      # @return [Twilio::REST::Preview::Marketplace::InstalledAddOnInstance] if sid was passed.
+      # @return [Twilio::REST::Preview::Marketplace::InstalledAddOnList]
+      def installed_add_ons(sid=:unset)
+        self.marketplace.installed_add_ons(sid)
+      end
+
+      ##
+      # @param [String] resource_type The resource_type
+      # @return [Twilio::REST::Preview::BulkExports::ExportInstance] if resource_type was passed.
+      # @return [Twilio::REST::Preview::BulkExports::ExportList]
+      def exports(resource_type=:unset)
+        self.bulk_exports.exports(resource_type)
+      end
+
+      ##
+      # @param [String] resource_type The resource_type
+      # @return [Twilio::REST::Preview::BulkExports::ExportConfigurationInstance] if resource_type was passed.
+      # @return [Twilio::REST::Preview::BulkExports::ExportConfigurationList]
+      def export_configuration(resource_type=:unset)
+        self.bulk_exports.export_configuration(resource_type)
+      end
+
+      ##
+      # @param [String] sid A 34 character string that uniquely identifies this
+      #   HostedNumberOrder.
+      # @return [Twilio::REST::Preview::HostedNumbers::HostedNumberOrderInstance] if sid was passed.
+      # @return [Twilio::REST::Preview::HostedNumbers::HostedNumberOrderList]
+      def hosted_number_orders(sid=:unset)
+        self.hosted_numbers.hosted_number_orders(sid)
+      end
+
+      ##
+      # Provide a user friendly representation
+      def to_s
+        '#<Twilio::REST::Preview>'
+      end
+    end
+  end
+end

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

@@ -0,0 +1,56 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+
+module Twilio
+  module REST
+    class Preview
+      class BulkExports < Version
+        ##
+        # Initialize the BulkExports version of Preview
+        def initialize(domain)
+          super
+          @version = 'BulkExports'
+          @exports = nil
+          @export_configuration = nil
+        end
+
+        ##
+        # @param [String] resource_type The resource_type
+        # @return [Twilio::REST::Preview::BulkExports::ExportInstance] if resource_type was passed.
+        # @return [Twilio::REST::Preview::BulkExports::ExportList]
+        def exports(resource_type=:unset)
+          if resource_type.nil?
+            raise ArgumentError, 'resource_type cannot be nil'
+          elsif resource_type == :unset
+            @exports ||= ExportList.new self
+          else
+            ExportContext.new(self, resource_type)
+          end
+        end
+
+        ##
+        # @param [String] resource_type The resource_type
+        # @return [Twilio::REST::Preview::BulkExports::ExportConfigurationInstance] if resource_type was passed.
+        # @return [Twilio::REST::Preview::BulkExports::ExportConfigurationList]
+        def export_configuration(resource_type=:unset)
+          if resource_type.nil?
+            raise ArgumentError, 'resource_type cannot be nil'
+          elsif resource_type == :unset
+            @export_configuration ||= ExportConfigurationList.new self
+          else
+            ExportConfigurationContext.new(self, resource_type)
+          end
+        end
+
+        ##
+        # Provide a user friendly representation
+        def to_s
+          '<Twilio::REST::Preview::BulkExports>'
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,203 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+
+module Twilio
+  module REST
+    class Preview < Domain
+      class BulkExports < Version
+        class ExportList < ListResource
+          ##
+          # Initialize the ExportList
+          # @param [Version] version Version that contains the resource
+          # @return [ExportList] ExportList
+          def initialize(version)
+            super(version)
+
+            # Path Solution
+            @solution = {}
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '#<Twilio.Preview.BulkExports.ExportList>'
+          end
+        end
+
+        class ExportPage < Page
+          ##
+          # Initialize the ExportPage
+          # @param [Version] version Version that contains the resource
+          # @param [Response] response Response from the API
+          # @param [Hash] solution Path solution for the resource
+          # @return [ExportPage] ExportPage
+          def initialize(version, response, solution)
+            super(version, response)
+
+            # Path Solution
+            @solution = solution
+          end
+
+          ##
+          # Build an instance of ExportInstance
+          # @param [Hash] payload Payload response from the API
+          # @return [ExportInstance] ExportInstance
+          def get_instance(payload)
+            ExportInstance.new(
+                @version,
+                payload,
+            )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '<Twilio.Preview.BulkExports.ExportPage>'
+          end
+        end
+
+        class ExportContext < InstanceContext
+          ##
+          # Initialize the ExportContext
+          # @param [Version] version Version that contains the resource
+          # @param [String] resource_type The resource_type
+          # @return [ExportContext] ExportContext
+          def initialize(version, resource_type)
+            super(version)
+
+            # Path Solution
+            @solution = {
+                resource_type: resource_type,
+            }
+            @uri = "/Exports/#{@solution[:resource_type]}"
+
+            # Dependents
+            @days = nil
+          end
+
+          ##
+          # Fetch a ExportInstance
+          # @return [ExportInstance] Fetched ExportInstance
+          def fetch
+            params = Twilio::Values.of({})
+
+            payload = @version.fetch(
+                'GET',
+                @uri,
+                params,
+            )
+
+            ExportInstance.new(
+                @version,
+                payload,
+                resource_type: @solution[:resource_type],
+            )
+          end
+
+          ##
+          # Access the days
+          # @return [DayList]
+          # @return [DayContext]
+          def days
+            unless @days
+              @days = DayList.new(
+                  @version,
+                  resource_type: @solution[:resource_type],
+              )
+            end
+
+            @days
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.Preview.BulkExports.ExportContext #{context}>"
+          end
+        end
+
+        class ExportInstance < InstanceResource
+          ##
+          # Initialize the ExportInstance
+          # @param [Version] version Version that contains the resource
+          # @param [Hash] payload payload that contains response from Twilio
+          # @param [String] resource_type The resource_type
+          # @return [ExportInstance] ExportInstance
+          def initialize(version, payload, resource_type: nil)
+            super(version)
+
+            # Marshaled Properties
+            @properties = {
+                'resource_type' => payload['resource_type'],
+                'url' => payload['url'],
+                'links' => payload['links'],
+            }
+
+            # Context
+            @instance_context = nil
+            @params = {
+                'resource_type' => resource_type || @properties['resource_type'],
+            }
+          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 [ExportContext] ExportContext for this ExportInstance
+          def context
+            unless @instance_context
+              @instance_context = ExportContext.new(
+                  @version,
+                  @params['resource_type'],
+              )
+            end
+            @instance_context
+          end
+
+          ##
+          # @return [String] The resource_type
+          def resource_type
+            @properties['resource_type']
+          end
+
+          ##
+          # @return [String] The url
+          def url
+            @properties['url']
+          end
+
+          ##
+          # @return [String] The links
+          def links
+            @properties['links']
+          end
+
+          ##
+          # Fetch a ExportInstance
+          # @return [ExportInstance] Fetched ExportInstance
+          def fetch
+            context.fetch
+          end
+
+          ##
+          # Access the days
+          # @return [days] days
+          def days
+            context.days
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+            "<Twilio.Preview.BulkExports.ExportInstance #{values}>"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/twilio-ruby/rest/preview/bulk_exports/export/day.rb

@@ -0,0 +1,210 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+
+module Twilio
+  module REST
+    class Preview < Domain
+      class BulkExports < Version
+        class ExportContext < InstanceContext
+          class DayList < ListResource
+            ##
+            # Initialize the DayList
+            # @param [Version] version Version that contains the resource
+            # @param [String] resource_type The resource_type
+            # @return [DayList] DayList
+            def initialize(version, resource_type: nil)
+              super(version)
+
+              # Path Solution
+              @solution = {
+                  resource_type: resource_type
+              }
+              @uri = "/Exports/#{@solution[:resource_type]}/Days"
+            end
+
+            ##
+            # Lists DayInstance 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 DayInstance 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 DayInstance 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 DayInstance 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 DayInstance
+            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
+              )
+              DayPage.new(@version, response, @solution)
+            end
+
+            ##
+            # Retrieve a single page of DayInstance records from the API.
+            # Request is executed immediately.
+            # @param [String] target_url API-generated URL for the requested results page
+            # @return [Page] Page of DayInstance
+            def get_page(target_url)
+              response = @version.domain.request(
+                  'GET',
+                  target_url
+              )
+              DayPage.new(@version, response, @solution)
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              '#<Twilio.Preview.BulkExports.DayList>'
+            end
+          end
+
+          class DayPage < Page
+            ##
+            # Initialize the DayPage
+            # @param [Version] version Version that contains the resource
+            # @param [Response] response Response from the API
+            # @param [Hash] solution Path solution for the resource
+            # @return [DayPage] DayPage
+            def initialize(version, response, solution)
+              super(version, response)
+
+              # Path Solution
+              @solution = solution
+            end
+
+            ##
+            # Build an instance of DayInstance
+            # @param [Hash] payload Payload response from the API
+            # @return [DayInstance] DayInstance
+            def get_instance(payload)
+              DayInstance.new(
+                  @version,
+                  payload,
+                  resource_type: @solution[:resource_type],
+              )
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              '<Twilio.Preview.BulkExports.DayPage>'
+            end
+          end
+
+          class DayInstance < InstanceResource
+            ##
+            # Initialize the DayInstance
+            # @param [Version] version Version that contains the resource
+            # @param [Hash] payload payload that contains response from Twilio
+            # @param [String] resource_type The resource_type
+            # @return [DayInstance] DayInstance
+            def initialize(version, payload, resource_type: nil)
+              super(version)
+
+              # Marshaled Properties
+              @properties = {
+                  'redirect_to' => payload['redirect_to'],
+                  'day' => payload['day'],
+                  'size' => payload['size'].to_i,
+                  'resource_type' => payload['resource_type'],
+              }
+            end
+
+            ##
+            # @return [String] The redirect_to
+            def redirect_to
+              @properties['redirect_to']
+            end
+
+            ##
+            # @return [String] The day
+            def day
+              @properties['day']
+            end
+
+            ##
+            # @return [String] The size
+            def size
+              @properties['size']
+            end
+
+            ##
+            # @return [String] The resource_type
+            def resource_type
+              @properties['resource_type']
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              "<Twilio.Preview.BulkExports.DayInstance>"
+            end
+          end
+        end
+      end
+    end
+  end
+end