##
#    This code was generated by
#    ___ _ _ _ _ _    _ ____    ____ ____ _    ____ ____ _  _ ____ ____ ____ ___ __   __
#     |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
#     |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
#
#    Twilio - Numbers
#    This is the public Twilio REST API.
#
#    NOTE: This class is auto generated by OpenAPI Generator.
#    https://openapi-generator.tech
#    Do not edit the class manually.
#


module Twilio
    module REST
        class Numbers < NumbersBase
            class V3 < 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 = "/HostedNumbers/HostedNumberOrders"
                        
                    end
                    ##
                    # Create the HostedNumberOrderInstance
                    # @param [String] phone_number The number to host in [+E.164](https://en.wikipedia.org/wiki/E.164) format
                    # @param [Boolean] sms_capability Used to specify that the SMS capability will be hosted on Twilio's platform.
                    # @param [String] account_sid This defaults to the AccountSid of the authorization the user is using. This can be provided to specify a subaccount to add the HostedNumberOrder to.
                    # @param [String] friendly_name A 64 character string that is a human readable text that describes this resource.
                    # @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 [Array[String]] cc_emails Optional. A list of emails that the LOA document for this HostedNumberOrder will be carbon copied to.
                    # @param [String] sms_url The URL that Twilio should request when somebody sends an SMS to the phone number. This will be copied onto the IncomingPhoneNumber resource.
                    # @param [String] sms_method The HTTP method that should be used to request the SmsUrl. Must be either `GET` or `POST`.  This will be copied onto the IncomingPhoneNumber resource.
                    # @param [String] sms_fallback_url A URL that Twilio will request if an error occurs requesting or executing the TwiML defined by SmsUrl. This will be copied onto the IncomingPhoneNumber resource.
                    # @param [String] sms_fallback_method The HTTP method that should be used to request the SmsFallbackUrl. Must be either `GET` or `POST`. This will be copied onto 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.
                    # @param [String] sms_application_sid Optional. The 34 character sid of the application Twilio should use to handle SMS messages sent to this number. If a `SmsApplicationSid` is present, Twilio will ignore all of the SMS urls above and use those set on the application.
                    # @param [String] address_sid Optional. A 34 character string that uniquely identifies the Address resource that represents the address of the owner of this phone number.
                    # @param [String] email Optional. Email of the owner of this phone number that is being hosted.
                    # @param [VerificationType] verification_type 
                    # @param [String] verification_document_sid Optional. The unique sid identifier of the Identity Document that represents the document for verifying ownership of the number to be hosted. Required when VerificationType is phone-bill.
                    # @return [HostedNumberOrderInstance] Created HostedNumberOrderInstance
                    def create(
                        phone_number: nil, 
                        sms_capability: 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, 
                        sms_application_sid: :unset, 
                        address_sid: :unset, 
                        email: :unset, 
                        verification_type: :unset, 
                        verification_document_sid: :unset
                    )

                        data = Twilio::Values.of({
                            'phoneNumber' => phone_number,
                            'smsCapability' => sms_capability,
                            'accountSid' => account_sid,
                            'friendlyName' => friendly_name,
                            'uniqueName' => unique_name,
                            'ccEmails' => Twilio.serialize_list(cc_emails) { |e| e },
                            'smsUrl' => sms_url,
                            'smsMethod' => sms_method,
                            'smsFallbackUrl' => sms_fallback_url,
                            'smsFallbackMethod' => sms_fallback_method,
                            'statusCallbackUrl' => status_callback_url,
                            'statusCallbackMethod' => status_callback_method,
                            'smsApplicationSid' => sms_application_sid,
                            'addressSid' => address_sid,
                            'email' => email,
                            'verificationType' => verification_type,
                            'verificationDocumentSid' => verification_document_sid,
                        })

                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
                        
                        
                        
                        
                        
                        payload = @version.create('POST', @uri, data: data, headers: headers)
                        HostedNumberOrderInstance.new(
                            @version,
                            payload,
                        )
                    end

                


                    # Provide a user friendly representation
                    def to_s
                        '#<Twilio.Numbers.V3.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.Numbers.V3.HostedNumberOrderPage>'
                    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] account_sid The SID of the
                    #   {Account}[https://www.twilio.com/docs/iam/api/account] that created this HostedNumberOrder
                    #   resource.
                    # @param [String] sid The SID of the Call resource to fetch.
                    # @return [HostedNumberOrderInstance] HostedNumberOrderInstance
                    def initialize(version, payload )
                        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'],
                            'failure_reason' => payload['failure_reason'],
                            'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
                            'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
                            'verification_attempts' => payload['verification_attempts'] == nil ? payload['verification_attempts'] : payload['verification_attempts'].to_i,
                            'email' => payload['email'],
                            'cc_emails' => payload['cc_emails'],
                            'url' => payload['url'],
                            'verification_type' => payload['verification_type'],
                            'verification_document_sid' => payload['verification_document_sid'],
                            'extension' => payload['extension'],
                            'call_delay' => payload['call_delay'] == nil ? payload['call_delay'] : payload['call_delay'].to_i,
                            'verification_code' => payload['verification_code'],
                            'verification_call_sids' => payload['verification_call_sids'],
                        }
                    end

                    
                    ##
                    # @return [String] A 34 character string that uniquely identifies this HostedNumberOrder.
                    def sid
                        @properties['sid']
                    end
                    
                    ##
                    # @return [String] A 34 character string that uniquely identifies the account.
                    def account_sid
                        @properties['account_sid']
                    end
                    
                    ##
                    # @return [String] A 34 character string that uniquely identifies the [IncomingPhoneNumber](https://www.twilio.com/docs/phone-numbers/api/incomingphonenumber-resource) resource that represents the phone number being hosted.
                    def incoming_phone_number_sid
                        @properties['incoming_phone_number_sid']
                    end
                    
                    ##
                    # @return [String] A 34 character string that uniquely identifies the Address resource that represents the address of the owner of this phone number.
                    def address_sid
                        @properties['address_sid']
                    end
                    
                    ##
                    # @return [String] A 34 character string that uniquely identifies the [Authorization Document](https://www.twilio.com/docs/phone-numbers/hosted-numbers/hosted-numbers-api/authorization-document-resource) the user needs to sign.
                    def signing_document_sid
                        @properties['signing_document_sid']
                    end
                    
                    ##
                    # @return [String] Phone number to be hosted. This must be in [E.164](https://en.wikipedia.org/wiki/E.164) format, e.g., +16175551212
                    def phone_number
                        @properties['phone_number']
                    end
                    
                    ##
                    # @return [NumbersV3HostedNumbersHostedNumberOrderCapabilities] 
                    def capabilities
                        @properties['capabilities']
                    end
                    
                    ##
                    # @return [String] A 64 character string that is a human-readable text that describes this resource.
                    def friendly_name
                        @properties['friendly_name']
                    end
                    
                    ##
                    # @return [String] Provides a unique and addressable name to be assigned to this HostedNumberOrder, assigned by the developer, to be optionally used in addition to SID.
                    def unique_name
                        @properties['unique_name']
                    end
                    
                    ##
                    # @return [Status] 
                    def status
                        @properties['status']
                    end
                    
                    ##
                    # @return [String] A message that explains why a hosted_number_order went to status \"action-required\"
                    def failure_reason
                        @properties['failure_reason']
                    end
                    
                    ##
                    # @return [Time] The date this resource was created, given as [GMT RFC 2822](http://www.ietf.org/rfc/rfc2822.txt) format.
                    def date_created
                        @properties['date_created']
                    end
                    
                    ##
                    # @return [Time] The date that this resource was updated, given as [GMT RFC 2822](http://www.ietf.org/rfc/rfc2822.txt) format.
                    def date_updated
                        @properties['date_updated']
                    end
                    
                    ##
                    # @return [String] The number of attempts made to verify ownership of the phone number that is being hosted.
                    def verification_attempts
                        @properties['verification_attempts']
                    end
                    
                    ##
                    # @return [String] Email of the owner of this phone number that is being hosted.
                    def email
                        @properties['email']
                    end
                    
                    ##
                    # @return [Array<String>] A list of emails that LOA document for this HostedNumberOrder will be carbon copied to.
                    def cc_emails
                        @properties['cc_emails']
                    end
                    
                    ##
                    # @return [String] The URL of this HostedNumberOrder.
                    def url
                        @properties['url']
                    end
                    
                    ##
                    # @return [VerificationType] 
                    def verification_type
                        @properties['verification_type']
                    end
                    
                    ##
                    # @return [String] A 34 character string that uniquely identifies the Identity Document resource that represents the document for verifying ownership of the number to be hosted.
                    def verification_document_sid
                        @properties['verification_document_sid']
                    end
                    
                    ##
                    # @return [String] A numerical extension to be used when making the ownership verification call.
                    def extension
                        @properties['extension']
                    end
                    
                    ##
                    # @return [String] A value between 0-30 specifying the number of seconds to delay initiating the ownership verification call.
                    def call_delay
                        @properties['call_delay']
                    end
                    
                    ##
                    # @return [String] A verification code provided in the response for a user to enter when they pick up the phone call.
                    def verification_code
                        @properties['verification_code']
                    end
                    
                    ##
                    # @return [Array<String>] A list of 34 character strings that are unique identifiers for the calls placed as part of ownership verification.
                    def verification_call_sids
                        @properties['verification_call_sids']
                    end
                    
                    ##
                    # Provide a user friendly representation
                    def to_s
                        "<Twilio.Numbers.V3.HostedNumberOrderInstance>"
                    end

                    ##
                    # Provide a detailed, user friendly representation
                    def inspect
                        "<Twilio.Numbers.V3.HostedNumberOrderInstance>"
                    end
                end

            end
        end
    end
end
