twilio-ruby 5.5.1 → 5.58.3

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

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -29,9 +31,11 @@ module Twilio
           # memory before returning.
           # @param [String] email Email that this AuthorizationDocument will be sent to for
           #   signing.
-          # @param [authorization_document.Status] status The Status of this
-          #   AuthorizationDocument. One of `opened`, `signing`, `signed`, `canceled`, or
-          #   `failed`.
+          # @param [authorization_document.Status] status Status of an instance resource. It
+          #   can hold one of the values: 1. opened 2. signing, 3. signed LOA, 4. canceled, 5.
+          #   failed. See the section entitled {Status
+          #   Values}[https://www.twilio.com/docs/api/phone-numbers/hosted-number-authorization-documents#status-values]
+          #   for more information on each of these statuses.
           # @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
@@ -49,9 +53,11 @@ module Twilio
           # is reached.
           # @param [String] email Email that this AuthorizationDocument will be sent to for
           #   signing.
-          # @param [authorization_document.Status] status The Status of this
-          #   AuthorizationDocument. One of `opened`, `signing`, `signed`, `canceled`, or
-          #   `failed`.
+          # @param [authorization_document.Status] status Status of an instance resource. It
+          #   can hold one of the values: 1. opened 2. signing, 3. signed LOA, 4. canceled, 5.
+          #   failed. See the section entitled {Status
+          #   Values}[https://www.twilio.com/docs/api/phone-numbers/hosted-number-authorization-documents#status-values]
+          #   for more information on each of these statuses.
           # @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
@@ -62,7 +68,7 @@ module Twilio
           def stream(email: :unset, status: :unset, limit: nil, page_size: nil)
             limits = @version.read_limits(limit, page_size)
 
-            page = self.page(email: email, status: status, page_size: limits[:page_size])
+            page = self.page(email: email, status: status, page_size: limits[:page_size], )
 
             @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
           end
@@ -74,7 +80,7 @@ module Twilio
           def each
             limits = @version.read_limits
 
-            page = self.page(page_size: limits[:page_size])
+            page = self.page(page_size: limits[:page_size], )
 
             @version.stream(page,
                             limit: limits[:limit],
@@ -86,9 +92,11 @@ module Twilio
           # Request is executed immediately.
           # @param [String] email Email that this AuthorizationDocument will be sent to for
           #   signing.
-          # @param [authorization_document.Status] status The Status of this
-          #   AuthorizationDocument. One of `opened`, `signing`, `signed`, `canceled`, or
-          #   `failed`.
+          # @param [authorization_document.Status] status Status of an instance resource. It
+          #   can hold one of the values: 1. opened 2. signing, 3. signed LOA, 4. canceled, 5.
+          #   failed. See the section entitled {Status
+          #   Values}[https://www.twilio.com/docs/api/phone-numbers/hosted-number-authorization-documents#status-values]
+          #   for more information on each of these statuses.
           # @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
@@ -101,11 +109,9 @@ module Twilio
                 'Page' => page_number,
                 'PageSize' => page_size,
             })
-            response = @version.page(
-                'GET',
-                @uri,
-                params
-            )
+
+            response = @version.page('GET', @uri, params: params)
+
             AuthorizationDocumentPage.new(@version, response, @solution)
           end
 
@@ -123,33 +129,34 @@ module Twilio
           end
 
           ##
-          # Retrieve a single page of AuthorizationDocumentInstance records from the API.
-          # Request is executed immediately.
-          # @param [String] hosted_number_order_sids A list of HostedNumberOrder sids that
-          #   this AuthorizationDocument will authorize for hosting phone number capabilities
-          #   on Twilio's platform.
+          # Create the AuthorizationDocumentInstance
+          # @param [Array[String]] hosted_number_order_sids A list of HostedNumberOrder sids
+          #   that this AuthorizationDocument will authorize for hosting phone number
+          #   capabilities on Twilio's platform.
           # @param [String] address_sid A 34 character string that uniquely identifies the
           #   Address resource that is associated with this AuthorizationDocument.
           # @param [String] email Email that this AuthorizationDocument will be sent to for
           #   signing.
-          # @param [String] cc_emails A list of emails that this AuthorizationDocument will
-          #   be carbon copied to.
-          # @return [AuthorizationDocumentInstance] Newly created AuthorizationDocumentInstance
-          def create(hosted_number_order_sids: nil, address_sid: nil, email: nil, cc_emails: :unset)
+          # @param [String] contact_title The title of the person authorized to sign the
+          #   Authorization Document for this phone number.
+          # @param [String] contact_phone_number The contact phone number of the person
+          #   authorized to sign the Authorization Document.
+          # @param [Array[String]] cc_emails Email recipients who will be informed when an
+          #   Authorization Document has been sent and signed.
+          # @return [AuthorizationDocumentInstance] Created AuthorizationDocumentInstance
+          def create(hosted_number_order_sids: nil, address_sid: nil, email: nil, contact_title: nil, contact_phone_number: nil, cc_emails: :unset)
             data = Twilio::Values.of({
                 'HostedNumberOrderSids' => Twilio.serialize_list(hosted_number_order_sids) { |e| e },
                 'AddressSid' => address_sid,
                 'Email' => email,
+                'ContactTitle' => contact_title,
+                'ContactPhoneNumber' => contact_phone_number,
                 'CcEmails' => Twilio.serialize_list(cc_emails) { |e| e },
             })
 
-            payload = @version.create(
-                'POST',
-                @uri,
-                data: data
-            )
+            payload = @version.create('POST', @uri, data: data)
 
-            AuthorizationDocumentInstance.new(@version, payload)
+            AuthorizationDocumentInstance.new(@version, payload, )
           end
 
           ##
@@ -180,7 +187,7 @@ module Twilio
           # @param [Hash] payload Payload response from the API
           # @return [AuthorizationDocumentInstance] AuthorizationDocumentInstance
           def get_instance(payload)
-            AuthorizationDocumentInstance.new(@version, payload)
+            AuthorizationDocumentInstance.new(@version, payload, )
           end
 
           ##
@@ -203,57 +210,72 @@ module Twilio
             super(version)
 
             # Path Solution
-            @solution = {sid: sid}
+            @solution = {sid: sid, }
             @uri = "/AuthorizationDocuments/#{@solution[:sid]}"
+
+            # Dependents
+            @dependent_hosted_number_orders = nil
           end
 
           ##
-          # Fetch a AuthorizationDocumentInstance
+          # Fetch the AuthorizationDocumentInstance
           # @return [AuthorizationDocumentInstance] Fetched AuthorizationDocumentInstance
           def fetch
-            params = Twilio::Values.of({})
+            payload = @version.fetch('GET', @uri)
 
-            payload = @version.fetch(
-                'GET',
-                @uri,
-                params,
-            )
-
-            AuthorizationDocumentInstance.new(@version, payload, sid: @solution[:sid])
+            AuthorizationDocumentInstance.new(@version, payload, sid: @solution[:sid], )
           end
 
           ##
           # Update the AuthorizationDocumentInstance
-          # @param [String] hosted_number_order_sids A list of HostedNumberOrder sids that
-          #   this AuthorizationDocument will authorize for hosting phone number capabilities
-          #   on Twilio's platform.
+          # @param [Array[String]] hosted_number_order_sids A list of HostedNumberOrder sids
+          #   that this AuthorizationDocument will authorize for hosting phone number
+          #   capabilities on Twilio's platform.
           # @param [String] address_sid A 34 character string that uniquely identifies the
           #   Address resource that is associated with this AuthorizationDocument.
           # @param [String] email Email that this AuthorizationDocument will be sent to for
           #   signing.
-          # @param [String] cc_emails A list of emails that this AuthorizationDocument will
-          #   be carbon copied to.
-          # @param [authorization_document.Status] status The Status of this
-          #   AuthorizationDocument. User can only update this to `opened` when
-          #   AuthorizationDocument is in `signing`, or `signing` when AuthorizationDocument
-          #   is in `opened`.
+          # @param [Array[String]] cc_emails Email recipients who will be informed when an
+          #   Authorization Document has been sent and signed
+          # @param [authorization_document.Status] status Status of an instance resource. It
+          #   can hold one of the values: 1. opened 2. signing, 3. signed LOA, 4. canceled, 5.
+          #   failed. See the section entitled {Status
+          #   Values}[https://www.twilio.com/docs/api/phone-numbers/hosted-number-authorization-documents#status-values]
+          #   for more information on each of these statuses.
+          # @param [String] contact_title The title of the person authorized to sign the
+          #   Authorization Document for this phone number.
+          # @param [String] contact_phone_number The contact phone number of the person
+          #   authorized to sign the Authorization Document.
           # @return [AuthorizationDocumentInstance] Updated AuthorizationDocumentInstance
-          def update(hosted_number_order_sids: :unset, address_sid: :unset, email: :unset, cc_emails: :unset, status: :unset)
+          def update(hosted_number_order_sids: :unset, address_sid: :unset, email: :unset, cc_emails: :unset, status: :unset, contact_title: :unset, contact_phone_number: :unset)
             data = Twilio::Values.of({
                 'HostedNumberOrderSids' => Twilio.serialize_list(hosted_number_order_sids) { |e| e },
                 'AddressSid' => address_sid,
                 'Email' => email,
                 'CcEmails' => Twilio.serialize_list(cc_emails) { |e| e },
                 'Status' => status,
+                'ContactTitle' => contact_title,
+                'ContactPhoneNumber' => contact_phone_number,
             })
 
-            payload = @version.update(
-                'POST',
-                @uri,
-                data: data,
-            )
+            payload = @version.update('POST', @uri, data: data)
+
+            AuthorizationDocumentInstance.new(@version, payload, sid: @solution[:sid], )
+          end
+
+          ##
+          # Access the dependent_hosted_number_orders
+          # @return [DependentHostedNumberOrderList]
+          # @return [DependentHostedNumberOrderContext]
+          def dependent_hosted_number_orders
+            unless @dependent_hosted_number_orders
+              @dependent_hosted_number_orders = DependentHostedNumberOrderList.new(
+                  @version,
+                  signing_document_sid: @solution[:sid],
+              )
+            end
 
-            AuthorizationDocumentInstance.new(@version, payload, sid: @solution[:sid])
+            @dependent_hosted_number_orders
           end
 
           ##
@@ -262,6 +284,13 @@ module Twilio
             context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
             "#<Twilio.Preview.HostedNumbers.AuthorizationDocumentContext #{context}>"
           end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.Preview.HostedNumbers.AuthorizationDocumentContext #{context}>"
+          end
         end
 
         ##
@@ -287,11 +316,12 @@ module Twilio
                 'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
                 'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
                 'url' => payload['url'],
+                'links' => payload['links'],
             }
 
             # Context
             @instance_context = nil
-            @params = {'sid' => sid || @properties['sid']}
+            @params = {'sid' => sid || @properties['sid'], }
           end
 
           ##
@@ -300,7 +330,7 @@ module Twilio
           # @return [AuthorizationDocumentContext] AuthorizationDocumentContext for this AuthorizationDocumentInstance
           def context
             unless @instance_context
-              @instance_context = AuthorizationDocumentContext.new(@version, @params['sid'])
+              @instance_context = AuthorizationDocumentContext.new(@version, @params['sid'], )
             end
             @instance_context
           end
@@ -330,7 +360,7 @@ module Twilio
           end
 
           ##
-          # @return [String] A list of emails.
+          # @return [Array[String]] A list of emails.
           def cc_emails
             @properties['cc_emails']
           end
@@ -354,7 +384,13 @@ module Twilio
           end
 
           ##
-          # Fetch a AuthorizationDocumentInstance
+          # @return [String] The links
+          def links
+            @properties['links']
+          end
+
+          ##
+          # Fetch the AuthorizationDocumentInstance
           # @return [AuthorizationDocumentInstance] Fetched AuthorizationDocumentInstance
           def fetch
             context.fetch
@@ -362,30 +398,44 @@ module Twilio
 
           ##
           # Update the AuthorizationDocumentInstance
-          # @param [String] hosted_number_order_sids A list of HostedNumberOrder sids that
-          #   this AuthorizationDocument will authorize for hosting phone number capabilities
-          #   on Twilio's platform.
+          # @param [Array[String]] hosted_number_order_sids A list of HostedNumberOrder sids
+          #   that this AuthorizationDocument will authorize for hosting phone number
+          #   capabilities on Twilio's platform.
           # @param [String] address_sid A 34 character string that uniquely identifies the
           #   Address resource that is associated with this AuthorizationDocument.
           # @param [String] email Email that this AuthorizationDocument will be sent to for
           #   signing.
-          # @param [String] cc_emails A list of emails that this AuthorizationDocument will
-          #   be carbon copied to.
-          # @param [authorization_document.Status] status The Status of this
-          #   AuthorizationDocument. User can only update this to `opened` when
-          #   AuthorizationDocument is in `signing`, or `signing` when AuthorizationDocument
-          #   is in `opened`.
+          # @param [Array[String]] cc_emails Email recipients who will be informed when an
+          #   Authorization Document has been sent and signed
+          # @param [authorization_document.Status] status Status of an instance resource. It
+          #   can hold one of the values: 1. opened 2. signing, 3. signed LOA, 4. canceled, 5.
+          #   failed. See the section entitled {Status
+          #   Values}[https://www.twilio.com/docs/api/phone-numbers/hosted-number-authorization-documents#status-values]
+          #   for more information on each of these statuses.
+          # @param [String] contact_title The title of the person authorized to sign the
+          #   Authorization Document for this phone number.
+          # @param [String] contact_phone_number The contact phone number of the person
+          #   authorized to sign the Authorization Document.
           # @return [AuthorizationDocumentInstance] Updated AuthorizationDocumentInstance
-          def update(hosted_number_order_sids: :unset, address_sid: :unset, email: :unset, cc_emails: :unset, status: :unset)
+          def update(hosted_number_order_sids: :unset, address_sid: :unset, email: :unset, cc_emails: :unset, status: :unset, contact_title: :unset, contact_phone_number: :unset)
             context.update(
                 hosted_number_order_sids: hosted_number_order_sids,
                 address_sid: address_sid,
                 email: email,
                 cc_emails: cc_emails,
                 status: status,
+                contact_title: contact_title,
+                contact_phone_number: contact_phone_number,
             )
           end
 
+          ##
+          # Access the dependent_hosted_number_orders
+          # @return [dependent_hosted_number_orders] dependent_hosted_number_orders
+          def dependent_hosted_number_orders
+            context.dependent_hosted_number_orders
+          end
+
           ##
           # Provide a user friendly representation
           def to_s