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

Inherits:
InstanceContext
  • Object
show all
Defined in:
lib/twilio-ruby/rest/preview/hosted_numbers/authorization_document.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].

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.



202
203
204
205
206
207
208
 
# File 'lib/twilio-ruby/rest/preview/hosted_numbers/authorization_document.rb', line 202

def initialize(version, sid)
  super(version)

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

Instance Method Details

#fetch ⇒ AuthorizationDocumentInstance

Fetch a AuthorizationDocumentInstance

Returns:



213
214
215
216
217
218
219
220
221
222
223
 
# File 'lib/twilio-ruby/rest/preview/hosted_numbers/authorization_document.rb', line 213

def fetch
  params = Twilio::Values.of({})

  payload = @version.fetch(
      'GET',
      @uri,
      params,
  )

  AuthorizationDocumentInstance.new(@version, payload, sid: @solution[:sid])
end

#to_s ⇒ Object

Provide a user friendly representation



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

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) ⇒ AuthorizationDocumentInstance

Update the AuthorizationDocumentInstance

Parameters:

  • hosted_number_order_sids (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 (String) (defaults to: :unset) —

    A list of emails that this AuthorizationDocument will be carbon copied to.

  • status (authorization_document.Status) (defaults to: :unset) —

    The Status of this AuthorizationDocument. User can only update this to ‘opened` when AuthorizationDocument is in `signing`, or `signing` when AuthorizationDocument is in `opened`.

Returns:



241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
 
# File 'lib/twilio-ruby/rest/preview/hosted_numbers/authorization_document.rb', line 241

def update(hosted_number_order_sids: :unset, address_sid: :unset, email: :unset, cc_emails: :unset, status: :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,
  })

  payload = @version.update(
      'POST',
      @uri,
      data: data,
  )

  AuthorizationDocumentInstance.new(@version, payload, sid: @solution[:sid])
end