twilio-ruby 5.0.0.alpha1 → 5.0.0.rc2

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

@@ -1,42 +0,0 @@
-##
-# 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
-
-        ##
-        # @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)
-          if sid.nil?
-            raise ArgumentError, 'sid cannot be nil'
-          elsif 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/hosted_numbers/hosted_number_order.rb

@@ -1,557 +0,0 @@
-##
-# This code was generated by
-# \ / _    _  _|   _  _
-#  | (_)\/(_)(_|\/| |(/_  v1.0.0
-#       /       /
-
-module Twilio
-  module REST
-    class Preview < Domain
-      class HostedNumbers < Version
-        class HostedNumberOrderList < ListResource
-          ##
-          # Initialize the HostedNumberOrderList
-          # @param [Version] version Version that contains the resource
-          # @return [HostedNumberOrderList] HostedNumberOrderList
-          def initialize(version)
-            super(version)
-
-            # Path Solution
-            @solution = {}
-            @uri = "/HostedNumberOrders"
-          end
-
-          ##
-          # Lists HostedNumberOrderInstance records from the API as a list.
-          # Unlike stream(), this operation is eager and will load `limit` records into
-          # memory before returning.
-          # @param [hosted_number_order.Status] status The Status of this HostedNumberOrder.
-          #   One of `received`, `pending-verification`, `verified`, `pending-loa`,
-          #   `carrier-processing`, `testing`, `completed`, `failed`, or `action-required`.
-          # @param [String] phone_number An E164 formatted phone number hosted by this
-          #   HostedNumberOrder.
-          # @param [String] incoming_phone_number_sid A 34 character string that uniquely
-          #   identifies the IncomingPhoneNumber resource created by this HostedNumberOrder.
-          # @param [String] friendly_name A human readable description of this resource, up
-          #   to 64 characters.
-          # @param [String] unique_name Provides a unique and addressable name to be
-          #   assigned to this HostedNumberOrder, assigned by the developer, to be optionally
-          #   used in addition to SID.
-          # @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(status: :unset, phone_number: :unset, incoming_phone_number_sid: :unset, friendly_name: :unset, unique_name: :unset, limit: nil, page_size: nil)
-            self.stream(
-                status: status,
-                phone_number: phone_number,
-                incoming_phone_number_sid: incoming_phone_number_sid,
-                friendly_name: friendly_name,
-                unique_name: unique_name,
-                limit: limit,
-                page_size: page_size
-            ).entries
-          end
-
-          ##
-          # Streams HostedNumberOrderInstance records from the API as an Enumerable.
-          # This operation lazily loads records as efficiently as possible until the limit
-          # is reached.
-          # @param [hosted_number_order.Status] status The Status of this HostedNumberOrder.
-          #   One of `received`, `pending-verification`, `verified`, `pending-loa`,
-          #   `carrier-processing`, `testing`, `completed`, `failed`, or `action-required`.
-          # @param [String] phone_number An E164 formatted phone number hosted by this
-          #   HostedNumberOrder.
-          # @param [String] incoming_phone_number_sid A 34 character string that uniquely
-          #   identifies the IncomingPhoneNumber resource created by this HostedNumberOrder.
-          # @param [String] friendly_name A human readable description of this resource, up
-          #   to 64 characters.
-          # @param [String] unique_name Provides a unique and addressable name to be
-          #   assigned to this HostedNumberOrder, assigned by the developer, to be optionally
-          #   used in addition to SID.
-          # @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(status: :unset, phone_number: :unset, incoming_phone_number_sid: :unset, friendly_name: :unset, unique_name: :unset, limit: nil, page_size: nil)
-            limits = @version.read_limits(limit, page_size)
-
-            page = self.page(
-                status: status,
-                phone_number: phone_number,
-                incoming_phone_number_sid: incoming_phone_number_sid,
-                friendly_name: friendly_name,
-                unique_name: unique_name,
-                page_size: limits[:page_size],
-            )
-
-            @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
-          end
-
-          ##
-          # When passed a block, yields HostedNumberOrderInstance 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 HostedNumberOrderInstance records from the API.
-          # Request is executed immediately.
-          # @param [hosted_number_order.Status] status The Status of this HostedNumberOrder.
-          #   One of `received`, `pending-verification`, `verified`, `pending-loa`,
-          #   `carrier-processing`, `testing`, `completed`, `failed`, or `action-required`.
-          # @param [String] phone_number An E164 formatted phone number hosted by this
-          #   HostedNumberOrder.
-          # @param [String] incoming_phone_number_sid A 34 character string that uniquely
-          #   identifies the IncomingPhoneNumber resource created by this HostedNumberOrder.
-          # @param [String] friendly_name A human readable description of this resource, up
-          #   to 64 characters.
-          # @param [String] unique_name Provides a unique and addressable name to be
-          #   assigned to this HostedNumberOrder, assigned by the developer, to be optionally
-          #   used in addition to SID.
-          # @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 HostedNumberOrderInstance
-          def page(status: :unset, phone_number: :unset, incoming_phone_number_sid: :unset, friendly_name: :unset, unique_name: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
-            params = Twilio::Values.of({
-                'Status' => status,
-                'PhoneNumber' => phone_number,
-                'IncomingPhoneNumberSid' => incoming_phone_number_sid,
-                'FriendlyName' => friendly_name,
-                'UniqueName' => unique_name,
-                'PageToken' => page_token,
-                'Page' => page_number,
-                'PageSize' => page_size,
-            })
-            response = @version.page(
-                'GET',
-                @uri,
-                params
-            )
-            HostedNumberOrderPage.new(@version, response, @solution)
-          end
-
-          ##
-          # Retrieve a single page of HostedNumberOrderInstance records from the API.
-          # Request is executed immediately.
-          # @param [String] target_url API-generated URL for the requested results page
-          # @return [Page] Page of HostedNumberOrderInstance
-          def get_page(target_url)
-            response = @version.domain.request(
-                'GET',
-                target_url
-            )
-            HostedNumberOrderPage.new(@version, response, @solution)
-          end
-
-          ##
-          # Retrieve a single page of HostedNumberOrderInstance records from the API.
-          # Request is executed immediately.
-          # @param [String] address_sid A 34 character string that uniquely identifies the
-          #   Address resource that represents the address of the owner of this phone number.
-          # @param [String] phone_number An E164 formatted phone number hosted by this
-          #   HostedNumberOrder.
-          # @param [String] iso_country The ISO country code of the phone_number.
-          # @param [Boolean] sms_capability Used to specify that the SMS capability will be
-          #   hosted on Twilio's platform.
-          # @param [String] email Email of the owner of this phone number that is being
-          #   hosted.
-          # @param [String] account_sid Optional. The unique SID identifier of the Account
-          #   or Sub-Account to create this HostedNumberOrder on.
-          # @param [String] friendly_name Optional. A human readable description of this
-          #   resource, up to 64 characters.
-          # @param [String] unique_name Optional. Provides a unique and addressable name to
-          #   be assigned to this HostedNumberOrder, assigned by the developer, to be
-          #   optionally used in addition to SID.
-          # @param [String] cc_emails Optional. A list of emails that LOA document for this
-          #   HostedNumberOrder will be carbon copied to.
-          # @param [String] sms_url Optional. The SMS URL attached to the
-          #   IncomingPhoneNumber resource.
-          # @param [String] sms_method Optional. The SMS Method attached to the
-          #   IncomingPhoneNumber resource.
-          # @param [String] sms_fallback_url Optional. The SMS Fallback URL attached to the
-          #   IncomingPhoneNumber resource.
-          # @param [String] sms_fallback_method Optional. The SMS Fallback Method attached
-          #   to the IncomingPhoneNumber resource.
-          # @param [String] status_callback_url Optional. The Status Callback URL attached
-          #   to the IncomingPhoneNumber resource.
-          # @param [String] status_callback_method Optional. The Status Callback Method
-          #   attached to the IncomingPhoneNumber resource.
-          # @return [HostedNumberOrderInstance] Newly created HostedNumberOrderInstance
-          def create(address_sid: nil, phone_number: nil, iso_country: nil, sms_capability: nil, email: nil, account_sid: :unset, friendly_name: :unset, unique_name: :unset, cc_emails: :unset, sms_url: :unset, sms_method: :unset, sms_fallback_url: :unset, sms_fallback_method: :unset, status_callback_url: :unset, status_callback_method: :unset)
-            data = Twilio::Values.of({
-                'AddressSid' => address_sid,
-                'PhoneNumber' => phone_number,
-                'IsoCountry' => iso_country,
-                'SmsCapability' => sms_capability,
-                'Email' => email,
-                'AccountSid' => account_sid,
-                'FriendlyName' => friendly_name,
-                'UniqueName' => unique_name,
-                'CcEmails' => cc_emails,
-                'SmsUrl' => sms_url,
-                'SmsMethod' => sms_method,
-                'SmsFallbackUrl' => sms_fallback_url,
-                'SmsFallbackMethod' => sms_fallback_method,
-                'StatusCallbackUrl' => status_callback_url,
-                'StatusCallbackMethod' => status_callback_method,
-            })
-
-            payload = @version.create(
-                'POST',
-                @uri,
-                data: data
-            )
-
-            HostedNumberOrderInstance.new(
-                @version,
-                payload,
-            )
-          end
-
-          ##
-          # Provide a user friendly representation
-          def to_s
-            '#<Twilio.Preview.HostedNumbers.HostedNumberOrderList>'
-          end
-        end
-
-        class HostedNumberOrderPage < Page
-          ##
-          # Initialize the HostedNumberOrderPage
-          # @param [Version] version Version that contains the resource
-          # @param [Response] response Response from the API
-          # @param [Hash] solution Path solution for the resource
-          # @return [HostedNumberOrderPage] HostedNumberOrderPage
-          def initialize(version, response, solution)
-            super(version, response)
-
-            # Path Solution
-            @solution = solution
-          end
-
-          ##
-          # Build an instance of HostedNumberOrderInstance
-          # @param [Hash] payload Payload response from the API
-          # @return [HostedNumberOrderInstance] HostedNumberOrderInstance
-          def get_instance(payload)
-            HostedNumberOrderInstance.new(
-                @version,
-                payload,
-            )
-          end
-
-          ##
-          # Provide a user friendly representation
-          def to_s
-            '<Twilio.Preview.HostedNumbers.HostedNumberOrderPage>'
-          end
-        end
-
-        class HostedNumberOrderContext < InstanceContext
-          ##
-          # Initialize the HostedNumberOrderContext
-          # @param [Version] version Version that contains the resource
-          # @param [String] sid A 34 character string that uniquely identifies this
-          #   HostedNumberOrder.
-          # @return [HostedNumberOrderContext] HostedNumberOrderContext
-          def initialize(version, sid)
-            super(version)
-
-            # Path Solution
-            @solution = {
-                sid: sid,
-            }
-            @uri = "/HostedNumberOrders/#{@solution[:sid]}"
-          end
-
-          ##
-          # Fetch a HostedNumberOrderInstance
-          # @return [HostedNumberOrderInstance] Fetched HostedNumberOrderInstance
-          def fetch
-            params = Twilio::Values.of({})
-
-            payload = @version.fetch(
-                'GET',
-                @uri,
-                params,
-            )
-
-            HostedNumberOrderInstance.new(
-                @version,
-                payload,
-                sid: @solution[:sid],
-            )
-          end
-
-          ##
-          # Deletes the HostedNumberOrderInstance
-          # @return [Boolean] true if delete succeeds, true otherwise
-          def delete
-            @version.delete('delete', @uri)
-          end
-
-          ##
-          # Update the HostedNumberOrderInstance
-          # @param [String] friendly_name A human readable description of this resource, up
-          #   to 64 characters.
-          # @param [String] unique_name Provides a unique and addressable name to be
-          #   assigned to this HostedNumberOrder, assigned by the developer, to be optionally
-          #   used in addition to SID.
-          # @param [String] email Email of the owner of this phone number that is being
-          #   hosted.
-          # @param [String] cc_emails Optional. A list of emails that LOA document for this
-          #   HostedNumberOrder will be carbon copied to.
-          # @param [hosted_number_order.Status] status The Status of this HostedNumberOrder.
-          #   User can only update this to `pending-loa` or `pending-verification`.
-          # @param [String] verification_code A verification code that is given to the user
-          #   via a phone call to the phone number that is being hosted.
-          # @return [HostedNumberOrderInstance] Updated HostedNumberOrderInstance
-          def update(friendly_name: :unset, unique_name: :unset, email: :unset, cc_emails: :unset, status: :unset, verification_code: :unset)
-            data = Twilio::Values.of({
-                'FriendlyName' => friendly_name,
-                'UniqueName' => unique_name,
-                'Email' => email,
-                'CcEmails' => cc_emails,
-                'Status' => status,
-                'VerificationCode' => verification_code,
-            })
-
-            payload = @version.update(
-                'POST',
-                @uri,
-                data: data,
-            )
-
-            HostedNumberOrderInstance.new(
-                @version,
-                payload,
-                sid: @solution[:sid],
-            )
-          end
-
-          ##
-          # Provide a user friendly representation
-          def to_s
-            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
-            "#<Twilio.Preview.HostedNumbers.HostedNumberOrderContext #{context}>"
-          end
-        end
-
-        class HostedNumberOrderInstance < InstanceResource
-          ##
-          # Initialize the HostedNumberOrderInstance
-          # @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
-          #   HostedNumberOrder.
-          # @return [HostedNumberOrderInstance] HostedNumberOrderInstance
-          def initialize(version, payload, sid: nil)
-            super(version)
-
-            # Marshaled Properties
-            @properties = {
-                'sid' => payload['sid'],
-                'account_sid' => payload['account_sid'],
-                'incoming_phone_number_sid' => payload['incoming_phone_number_sid'],
-                'address_sid' => payload['address_sid'],
-                'signing_document_sid' => payload['signing_document_sid'],
-                'phone_number' => payload['phone_number'],
-                'capabilities' => payload['capabilities'],
-                'friendly_name' => payload['friendly_name'],
-                'unique_name' => payload['unique_name'],
-                'status' => payload['status'],
-                'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
-                'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
-                'verification_attempts' => payload['verification_attempts'].to_i,
-                'email' => payload['email'],
-                'cc_emails' => payload['cc_emails'],
-                'url' => payload['url'],
-            }
-
-            # 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 [HostedNumberOrderContext] HostedNumberOrderContext for this HostedNumberOrderInstance
-          def context
-            unless @instance_context
-              @instance_context = HostedNumberOrderContext.new(
-                  @version,
-                  @params['sid'],
-              )
-            end
-            @instance_context
-          end
-
-          ##
-          # @return [String] HostedNumberOrder sid.
-          def sid
-            @properties['sid']
-          end
-
-          ##
-          # @return [String] Account Sid.
-          def account_sid
-            @properties['account_sid']
-          end
-
-          ##
-          # @return [String] IncomingPhoneNumber sid.
-          def incoming_phone_number_sid
-            @properties['incoming_phone_number_sid']
-          end
-
-          ##
-          # @return [String] Address sid.
-          def address_sid
-            @properties['address_sid']
-          end
-
-          ##
-          # @return [String] LOA document sid.
-          def signing_document_sid
-            @properties['signing_document_sid']
-          end
-
-          ##
-          # @return [String] An E164 formatted phone number.
-          def phone_number
-            @properties['phone_number']
-          end
-
-          ##
-          # @return [String] A mapping of phone number capabilities.
-          def capabilities
-            @properties['capabilities']
-          end
-
-          ##
-          # @return [String] A human readable description of this resource.
-          def friendly_name
-            @properties['friendly_name']
-          end
-
-          ##
-          # @return [String] A unique, developer assigned name of this HostedNumberOrder.
-          def unique_name
-            @properties['unique_name']
-          end
-
-          ##
-          # @return [hosted_number_order.Status] The Status of this HostedNumberOrder.
-          def status
-            @properties['status']
-          end
-
-          ##
-          # @return [Time] The date this HostedNumberOrder was created.
-          def date_created
-            @properties['date_created']
-          end
-
-          ##
-          # @return [Time] The date this HostedNumberOrder was updated.
-          def date_updated
-            @properties['date_updated']
-          end
-
-          ##
-          # @return [String] The number of verification attempts made to verify ownership of the phone number.
-          def verification_attempts
-            @properties['verification_attempts']
-          end
-
-          ##
-          # @return [String] Email.
-          def email
-            @properties['email']
-          end
-
-          ##
-          # @return [String] A list of emails.
-          def cc_emails
-            @properties['cc_emails']
-          end
-
-          ##
-          # @return [String] The URL of this HostedNumberOrder.
-          def url
-            @properties['url']
-          end
-
-          ##
-          # Fetch a HostedNumberOrderInstance
-          # @return [HostedNumberOrderInstance] Fetched HostedNumberOrderInstance
-          def fetch
-            context.fetch
-          end
-
-          ##
-          # Deletes the HostedNumberOrderInstance
-          # @return [Boolean] true if delete succeeds, true otherwise
-          def delete
-            context.delete
-          end
-
-          ##
-          # Update the HostedNumberOrderInstance
-          # @param [String] friendly_name A human readable description of this resource, up
-          #   to 64 characters.
-          # @param [String] unique_name Provides a unique and addressable name to be
-          #   assigned to this HostedNumberOrder, assigned by the developer, to be optionally
-          #   used in addition to SID.
-          # @param [String] email Email of the owner of this phone number that is being
-          #   hosted.
-          # @param [String] cc_emails Optional. A list of emails that LOA document for this
-          #   HostedNumberOrder will be carbon copied to.
-          # @param [hosted_number_order.Status] status The Status of this HostedNumberOrder.
-          #   User can only update this to `pending-loa` or `pending-verification`.
-          # @param [String] verification_code A verification code that is given to the user
-          #   via a phone call to the phone number that is being hosted.
-          # @return [HostedNumberOrderInstance] Updated HostedNumberOrderInstance
-          def update(friendly_name: :unset, unique_name: :unset, email: :unset, cc_emails: :unset, status: :unset, verification_code: :unset)
-            context.update(
-                friendly_name: friendly_name,
-                unique_name: unique_name,
-                email: email,
-                cc_emails: cc_emails,
-                status: status,
-                verification_code: verification_code,
-            )
-          end
-
-          ##
-          # Provide a user friendly representation
-          def to_s
-            values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
-            "<Twilio.Preview.HostedNumbers.HostedNumberOrderInstance #{values}>"
-          end
-        end
-      end
-    end
-  end
-end