twilio-ruby 5.0.0.rc20 → 5.0.0.rc21

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

@@ -0,0 +1,35 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+
+module Twilio
+  module REST
+    class Preview
+      class HostedNumbers < Version
+        ##
+        # Initialize the HostedNumbers version of Preview
+        def initialize(domain)
+          super
+          @version = 'HostedNumbers'
+          @hosted_number_orders = nil
+        end
+
+        def hosted_number_orders(sid=:unset)
+          if sid == :unset
+            @hosted_number_orders ||= HostedNumberOrderList.new self
+          else
+            HostedNumberOrderContext.new(self, sid)
+          end
+        end
+
+        ##
+        # Provide a user friendly representation
+        def to_s
+          '<Twilio::REST::Preview::HostedNumbers>'
+        end
+      end
+    end
+  end
+end

data/lib/twilio-ruby/rest/preview/proxy/service/phone_number.rb

@@ -0,0 +1,336 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+
+module Twilio
+  module REST
+    class Preview < Domain
+      class Proxy < Version
+        class ServiceContext < InstanceContext
+          class PhoneNumberList < ListResource
+            ##
+            # Initialize the PhoneNumberList
+            # @param [Version] version Version that contains the resource
+            # @param [String] service_sid The unique SID identifier of the Service.
+            # @return [PhoneNumberList] PhoneNumberList
+            def initialize(version, service_sid: nil)
+              super(version)
+
+              # Path Solution
+              @solution = {
+                  service_sid: service_sid
+              }
+              @uri = "/Services/#{@solution[:service_sid]}/PhoneNumbers"
+            end
+
+            ##
+            # Retrieve a single page of PhoneNumberInstance records from the API.
+            # Request is executed immediately.
+            # @param [String] sid The phone-number Sid that uniquely identifies this resource
+            # @return [PhoneNumberInstance] Newly created PhoneNumberInstance
+            def create(sid: nil)
+              data = {
+                  'Sid' => sid,
+              }
+
+              payload = @version.create(
+                  'POST',
+                  @uri,
+                  data: data
+              )
+
+              return PhoneNumberInstance.new(
+                  @version,
+                  payload,
+                  service_sid: @solution[:service_sid],
+              )
+            end
+
+            ##
+            # Lists PhoneNumberInstance 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 PhoneNumberInstance 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 PhoneNumberInstance records from the API.
+            # 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)
+            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 PhoneNumberInstance 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 PhoneNumberInstance
+            def page(page_token: nil, page_number: nil, page_size: nil)
+              params = {
+                  'PageToken' => page_token,
+                  'Page' => page_number,
+                  'PageSize' => page_size,
+              }
+              response = @version.page(
+                  'GET',
+                  @uri,
+                  params
+              )
+              return PhoneNumberPage.new(@version, response, @solution)
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              '#<Twilio.Preview.Proxy.PhoneNumberList>'
+            end
+          end
+
+          class PhoneNumberPage < Page
+            ##
+            # Initialize the PhoneNumberPage
+            # @param [Version] version Version that contains the resource
+            # @param [Response] response Response from the API
+            # @param [Hash] solution Path solution for the resource
+            # @param [String] service_sid The unique SID identifier of the Service.
+            # @return [PhoneNumberPage] PhoneNumberPage
+            def initialize(version, response, solution)
+              super(version, response)
+
+              # Path Solution
+              @solution = solution
+            end
+
+            ##
+            # Build an instance of PhoneNumberInstance
+            # @param [Hash] payload Payload response from the API
+            # @return [PhoneNumberInstance] PhoneNumberInstance
+            def get_instance(payload)
+              return PhoneNumberInstance.new(
+                  @version,
+                  payload,
+                  service_sid: @solution[:service_sid],
+              )
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              '<Twilio.Preview.Proxy.PhoneNumberPage>'
+            end
+          end
+
+          class PhoneNumberContext < InstanceContext
+            ##
+            # Initialize the PhoneNumberContext
+            # @param [Version] version Version that contains the resource
+            # @param [String] service_sid The service_sid
+            # @param [String] sid The phone-number Sid that uniquely identifies this resource
+            # @return [PhoneNumberContext] PhoneNumberContext
+            def initialize(version, service_sid, sid)
+              super(version)
+
+              # Path Solution
+              @solution = {
+                  service_sid: service_sid,
+                  sid: sid,
+              }
+              @uri = "/Services/#{@solution[:service_sid]}/PhoneNumbers/#{@solution[:sid]}"
+            end
+
+            ##
+            # Deletes the PhoneNumberInstance
+            # @return [Boolean] true if delete succeeds, true otherwise
+            def delete
+              return @version.delete('delete', @uri)
+            end
+
+            ##
+            # Fetch a PhoneNumberInstance
+            # @return [PhoneNumberInstance] Fetched PhoneNumberInstance
+            def fetch
+              params = {}
+
+              payload = @version.fetch(
+                  'GET',
+                  @uri,
+                  params,
+              )
+
+              return PhoneNumberInstance.new(
+                  @version,
+                  payload,
+                  service_sid: @solution[:service_sid],
+                  sid: @solution[:sid],
+              )
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Preview.Proxy.PhoneNumberContext #{context}>"
+            end
+          end
+
+          class PhoneNumberInstance < InstanceResource
+            ##
+            # Initialize the PhoneNumberInstance
+            # @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.
+            # @param [String] sid The phone-number Sid that uniquely identifies this resource
+            # @return [PhoneNumberInstance] PhoneNumberInstance
+            def initialize(version, payload, service_sid: nil, sid: nil)
+              super(version)
+
+              # Marshaled Properties
+              @properties = {
+                  'sid' => payload['sid'],
+                  'account_sid' => payload['account_sid'],
+                  'service_sid' => payload['service_sid'],
+                  'date_created' => Twilio.deserialize_iso8601(payload['date_created']),
+                  'date_updated' => Twilio.deserialize_iso8601(payload['date_updated']),
+                  'phone_number' => payload['phone_number'],
+                  'country_code' => payload['country_code'],
+                  'capabilities' => payload['capabilities'],
+                  'url' => payload['url'],
+              }
+
+              # 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
+            # @param [Version] version Version that contains the resource
+            # @return [PhoneNumberContext] PhoneNumberContext for this PhoneNumberInstance
+            def context
+              unless @instance_context
+                @instance_context = PhoneNumberContext.new(
+                    @version,
+                    @params['service_sid'],
+                    @params['sid'],
+                )
+              end
+              @instance_context
+            end
+
+            def sid
+              @properties['sid']
+            end
+
+            def account_sid
+              @properties['account_sid']
+            end
+
+            def service_sid
+              @properties['service_sid']
+            end
+
+            def date_created
+              @properties['date_created']
+            end
+
+            def date_updated
+              @properties['date_updated']
+            end
+
+            def phone_number
+              @properties['phone_number']
+            end
+
+            def country_code
+              @properties['country_code']
+            end
+
+            def capabilities
+              @properties['capabilities']
+            end
+
+            def url
+              @properties['url']
+            end
+
+            ##
+            # Deletes the PhoneNumberInstance
+            # @return [Boolean] true if delete succeeds, true otherwise
+            def delete
+              context.delete
+            end
+
+            ##
+            # Fetch a PhoneNumberInstance
+            # @return [PhoneNumberInstance] Fetched PhoneNumberInstance
+            def fetch
+              context.fetch
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+              "<Twilio.Preview.Proxy.PhoneNumberInstance #{values}>"
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/twilio-ruby/rest/preview/proxy/service/session/interaction.rb

@@ -0,0 +1,393 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+
+module Twilio
+  module REST
+    class Preview < Domain
+      class Proxy < Version
+        class ServiceContext < InstanceContext
+          class SessionContext < InstanceContext
+            class InteractionList < ListResource
+              ##
+              # Initialize the InteractionList
+              # @param [Version] version Version that contains the resource
+              # @param [String] service_sid The unique SID identifier of the Service.
+              # @param [String] session_sid The unique SID identifier of the Session.
+              # @return [InteractionList] InteractionList
+              def initialize(version, service_sid: nil, session_sid: nil)
+                super(version)
+
+                # Path Solution
+                @solution = {
+                    service_sid: service_sid,
+                    session_sid: session_sid
+                }
+                @uri = "/Services/#{@solution[:service_sid]}/Sessions/#{@solution[:session_sid]}/Interactions"
+              end
+
+              ##
+              # Lists InteractionInstance records from the API as a list.
+              # Unlike stream(), this operation is eager and will load `limit` records into
+              # memory before returning.
+              # @param [interaction.ResourceStatus] inbound_participant_status The Inbound
+              #   Participant Status of this Interaction. One of `completed`, `in-progress` or
+              #   `failed`.
+              # @param [interaction.ResourceStatus] outbound_participant_status The Outbound
+              #   Participant Status of this Interaction. One of `completed`, `in-progress` 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(inbound_participant_status: nil, outbound_participant_status: nil, limit: nil, page_size: nil)
+                self.stream(
+                    inbound_participant_status: inbound_participant_status,
+                    outbound_participant_status: outbound_participant_status,
+                    limit: limit,
+                    page_size: page_size
+                ).entries
+              end
+
+              ##
+              # Streams InteractionInstance records from the API as an Enumerable.
+              # This operation lazily loads records as efficiently as possible until the limit
+              # is reached.
+              # @param [interaction.ResourceStatus] inbound_participant_status The Inbound
+              #   Participant Status of this Interaction. One of `completed`, `in-progress` or
+              #   `failed`.
+              # @param [interaction.ResourceStatus] outbound_participant_status The Outbound
+              #   Participant Status of this Interaction. One of `completed`, `in-progress` 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(inbound_participant_status: nil, outbound_participant_status: nil, limit: nil, page_size: nil)
+                limits = @version.read_limits(limit, page_size)
+
+                page = self.page(
+                    inbound_participant_status: inbound_participant_status,
+                    outbound_participant_status: outbound_participant_status,
+                    page_size: limits[:page_size],
+                )
+
+                @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
+              end
+
+              ##
+              # When passed a block, yields InteractionInstance records from the API.
+              # This operation lazily loads records as efficiently as possible until the limit
+              # is reached.
+              # @param [interaction.ResourceStatus] inbound_participant_status The Inbound
+              #   Participant Status of this Interaction. One of `completed`, `in-progress` or
+              #   `failed`.
+              # @param [interaction.ResourceStatus] outbound_participant_status The Outbound
+              #   Participant Status of this Interaction. One of `completed`, `in-progress` 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)
+              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 InteractionInstance records from the API.
+              # Request is executed immediately.
+              # @param [interaction.ResourceStatus] inbound_participant_status The Inbound
+              #   Participant Status of this Interaction. One of `completed`, `in-progress` or
+              #   `failed`.
+              # @param [interaction.ResourceStatus] outbound_participant_status The Outbound
+              #   Participant Status of this Interaction. One of `completed`, `in-progress` 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 InteractionInstance
+              def page(inbound_participant_status: nil, outbound_participant_status: nil, page_token: nil, page_number: nil, page_size: nil)
+                params = {
+                    'InboundParticipantStatus' => inbound_participant_status,
+                    'OutboundParticipantStatus' => outbound_participant_status,
+                    'PageToken' => page_token,
+                    'Page' => page_number,
+                    'PageSize' => page_size,
+                }
+                response = @version.page(
+                    'GET',
+                    @uri,
+                    params
+                )
+                return InteractionPage.new(@version, response, @solution)
+              end
+
+              ##
+              # Provide a user friendly representation
+              def to_s
+                '#<Twilio.Preview.Proxy.InteractionList>'
+              end
+            end
+
+            class InteractionPage < Page
+              ##
+              # Initialize the InteractionPage
+              # @param [Version] version Version that contains the resource
+              # @param [Response] response Response from the API
+              # @param [Hash] solution Path solution for the resource
+              # @param [String] service_sid The unique SID identifier of the Service.
+              # @param [String] session_sid The unique SID identifier of the Session.
+              # @return [InteractionPage] InteractionPage
+              def initialize(version, response, solution)
+                super(version, response)
+
+                # Path Solution
+                @solution = solution
+              end
+
+              ##
+              # Build an instance of InteractionInstance
+              # @param [Hash] payload Payload response from the API
+              # @return [InteractionInstance] InteractionInstance
+              def get_instance(payload)
+                return InteractionInstance.new(
+                    @version,
+                    payload,
+                    service_sid: @solution[:service_sid],
+                    session_sid: @solution[:session_sid],
+                )
+              end
+
+              ##
+              # Provide a user friendly representation
+              def to_s
+                '<Twilio.Preview.Proxy.InteractionPage>'
+              end
+            end
+
+            class InteractionContext < InstanceContext
+              ##
+              # Initialize the InteractionContext
+              # @param [Version] version Version that contains the resource
+              # @param [String] service_sid The unique SID identifier of the Service.
+              # @param [String] session_sid The unique SID identifier of the Session.
+              # @param [String] sid A 34 character string that uniquely identifies this
+              #   Interaction.
+              # @return [InteractionContext] InteractionContext
+              def initialize(version, service_sid, session_sid, sid)
+                super(version)
+
+                # Path Solution
+                @solution = {
+                    service_sid: service_sid,
+                    session_sid: session_sid,
+                    sid: sid,
+                }
+                @uri = "/Services/#{@solution[:service_sid]}/Sessions/#{@solution[:session_sid]}/Interactions/#{@solution[:sid]}"
+              end
+
+              ##
+              # Fetch a InteractionInstance
+              # @return [InteractionInstance] Fetched InteractionInstance
+              def fetch
+                params = {}
+
+                payload = @version.fetch(
+                    'GET',
+                    @uri,
+                    params,
+                )
+
+                return InteractionInstance.new(
+                    @version,
+                    payload,
+                    service_sid: @solution[:service_sid],
+                    session_sid: @solution[:session_sid],
+                    sid: @solution[:sid],
+                )
+              end
+
+              ##
+              # Provide a user friendly representation
+              def to_s
+                context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+                "#<Twilio.Preview.Proxy.InteractionContext #{context}>"
+              end
+            end
+
+            class InteractionInstance < InstanceResource
+              ##
+              # Initialize the InteractionInstance
+              # @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.
+              # @param [String] session_sid The unique SID identifier of the Session.
+              # @param [String] sid A 34 character string that uniquely identifies this
+              #   Interaction.
+              # @return [InteractionInstance] InteractionInstance
+              def initialize(version, payload, service_sid: nil, session_sid: nil, sid: nil)
+                super(version)
+
+                # Marshaled Properties
+                @properties = {
+                    'sid' => payload['sid'],
+                    'session_sid' => payload['session_sid'],
+                    'service_sid' => payload['service_sid'],
+                    'account_sid' => payload['account_sid'],
+                    'data' => payload['data'],
+                    'status' => payload['status'],
+                    'inbound_participant_sid' => payload['inbound_participant_sid'],
+                    'inbound_resource_sid' => payload['inbound_resource_sid'],
+                    'inbound_resource_status' => payload['inbound_resource_status'],
+                    'inbound_resource_type' => payload['inbound_resource_type'],
+                    'inbound_resource_url' => payload['inbound_resource_url'],
+                    'outbound_participant_sid' => payload['outbound_participant_sid'],
+                    'outbound_resource_sid' => payload['outbound_resource_sid'],
+                    'outbound_resource_status' => payload['outbound_resource_status'],
+                    'outbound_resource_type' => payload['outbound_resource_type'],
+                    'outbound_resource_url' => payload['outbound_resource_url'],
+                    'date_created' => Twilio.deserialize_iso8601(payload['date_created']),
+                    'date_updated' => Twilio.deserialize_iso8601(payload['date_updated']),
+                    'url' => payload['url'],
+                }
+
+                # Context
+                @instance_context = nil
+                @params = {
+                    'service_sid' => service_sid,
+                    'session_sid' => session_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
+              # @param [Version] version Version that contains the resource
+              # @return [InteractionContext] InteractionContext for this InteractionInstance
+              def context
+                unless @instance_context
+                  @instance_context = InteractionContext.new(
+                      @version,
+                      @params['service_sid'],
+                      @params['session_sid'],
+                      @params['sid'],
+                  )
+                end
+                @instance_context
+              end
+
+              def sid
+                @properties['sid']
+              end
+
+              def session_sid
+                @properties['session_sid']
+              end
+
+              def service_sid
+                @properties['service_sid']
+              end
+
+              def account_sid
+                @properties['account_sid']
+              end
+
+              def data
+                @properties['data']
+              end
+
+              def status
+                @properties['status']
+              end
+
+              def inbound_participant_sid
+                @properties['inbound_participant_sid']
+              end
+
+              def inbound_resource_sid
+                @properties['inbound_resource_sid']
+              end
+
+              def inbound_resource_status
+                @properties['inbound_resource_status']
+              end
+
+              def inbound_resource_type
+                @properties['inbound_resource_type']
+              end
+
+              def inbound_resource_url
+                @properties['inbound_resource_url']
+              end
+
+              def outbound_participant_sid
+                @properties['outbound_participant_sid']
+              end
+
+              def outbound_resource_sid
+                @properties['outbound_resource_sid']
+              end
+
+              def outbound_resource_status
+                @properties['outbound_resource_status']
+              end
+
+              def outbound_resource_type
+                @properties['outbound_resource_type']
+              end
+
+              def outbound_resource_url
+                @properties['outbound_resource_url']
+              end
+
+              def date_created
+                @properties['date_created']
+              end
+
+              def date_updated
+                @properties['date_updated']
+              end
+
+              def url
+                @properties['url']
+              end
+
+              ##
+              # Fetch a InteractionInstance
+              # @return [InteractionInstance] Fetched InteractionInstance
+              def fetch
+                context.fetch
+              end
+
+              ##
+              # Provide a user friendly representation
+              def to_s
+                values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+                "<Twilio.Preview.Proxy.InteractionInstance #{values}>"
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end