Class: Twilio::REST::Preview::HostedNumbers::AuthorizationDocumentContext

Inherits:
InstanceContext
  • Object
show all
Defined in:
lib/twilio-ruby/rest/preview/hosted_numbers/authorization_document.rb,
lib/twilio-ruby/rest/preview/hosted_numbers/authorization_document/dependent_hosted_number_order.rb

Overview

PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact [email protected].

Defined Under Namespace

Classes: DependentHostedNumberOrderInstance, DependentHostedNumberOrderList, DependentHostedNumberOrderPage

Instance Method Summary collapse

Constructor Details

#initialize(version, sid) ⇒ AuthorizationDocumentContext

Initialize the AuthorizationDocumentContext

Parameters:

  • version (Version) —

    Version that contains the resource

  • sid (String) —

    A 34 character string that uniquely identifies this AuthorizationDocument.



180
181
182
183
184
185
186
187
188
189
 
# File 'lib/twilio-ruby/rest/preview/hosted_numbers/authorization_document.rb', line 180

def initialize(version, sid)
    super(version)

    # Path Solution
    @solution = { sid: sid,  }
    @uri = "/AuthorizationDocuments/#{@solution[:sid]}"

    # Dependents
    @dependent_hosted_number_orders = nil
end

Instance Method Details

#dependent_hosted_number_orders ⇒ DependentHostedNumberOrderList, DependentHostedNumberOrderContext

Access the dependent_hosted_number_orders

Returns:



245
246
247
248
249
250
251
 
# File 'lib/twilio-ruby/rest/preview/hosted_numbers/authorization_document.rb', line 245

def dependent_hosted_number_orders
  unless @dependent_hosted_number_orders
    @dependent_hosted_number_orders = DependentHostedNumberOrderList.new(
            @version, signing_document_sid: @solution[:sid], )
  end
  @dependent_hosted_number_orders
end

#fetch ⇒ AuthorizationDocumentInstance

Fetch the AuthorizationDocumentInstance

Returns:



193
194
195
196
197
198
199
200
201
 
# File 'lib/twilio-ruby/rest/preview/hosted_numbers/authorization_document.rb', line 193

def fetch

    payload = @version.fetch('GET', @uri)
    AuthorizationDocumentInstance.new(
        @version,
        payload,
        sid: @solution[:sid],
    )
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



262
263
264
265
 
# File 'lib/twilio-ruby/rest/preview/hosted_numbers/authorization_document.rb', line 262

def inspect
    context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
    "#<Twilio.Preview.HostedNumbers.AuthorizationDocumentContext #{context}>"
end

#to_s ⇒ Object

Provide a user friendly representation



255
256
257
258
 
# File 'lib/twilio-ruby/rest/preview/hosted_numbers/authorization_document.rb', line 255

def to_s
    context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
    "#<Twilio.Preview.HostedNumbers.AuthorizationDocumentContext #{context}>"
end

#update(hosted_number_order_sids: :unset, address_sid: :unset, email: :unset, cc_emails: :unset, status: :unset, contact_title: :unset, contact_phone_number: :unset) ⇒ AuthorizationDocumentInstance

Update the AuthorizationDocumentInstance

Parameters:

  • hosted_number_order_sids (Array[String]) (defaults to: :unset) —

    A list of HostedNumberOrder sids that this AuthorizationDocument will authorize for hosting phone number capabilities on Twilio’s platform.

  • address_sid (String) (defaults to: :unset) —

    A 34 character string that uniquely identifies the Address resource that is associated with this AuthorizationDocument.

  • email (String) (defaults to: :unset) —

    Email that this AuthorizationDocument will be sent to for signing.

  • cc_emails (Array[String]) (defaults to: :unset) —

    Email recipients who will be informed when an Authorization Document has been sent and signed

  • status (Status) (defaults to: :unset)
  • contact_title (String) (defaults to: :unset) —

    The title of the person authorized to sign the Authorization Document for this phone number.

  • contact_phone_number (String) (defaults to: :unset) —

    The contact phone number of the person authorized to sign the Authorization Document.

Returns:



213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
 
# File 'lib/twilio-ruby/rest/preview/hosted_numbers/authorization_document.rb', line 213

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)
    AuthorizationDocumentInstance.new(
        @version,
        payload,
        sid: @solution[:sid],
    )
end