Class: Twilio::REST::Trusthub::V1::SupportingDocumentContext

Inherits:
InstanceContext
  • Object
show all
Defined in:
lib/twilio-ruby/rest/trusthub/v1/supporting_document.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, sid) ⇒ SupportingDocumentContext

Initialize the SupportingDocumentContext

Parameters:

  • version (Version)

    Version that contains the resource

  • sid (String)

    The unique string created by Twilio to identify the Supporting Document resource.


169
170
171
172
173
174
175
# File 'lib/twilio-ruby/rest/trusthub/v1/supporting_document.rb', line 169

def initialize(version, sid)
  super(version)

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

Instance Method Details

#deleteBoolean

Delete the SupportingDocumentInstance

Returns:

  • (Boolean)

    true if delete succeeds, false otherwise


207
208
209
# File 'lib/twilio-ruby/rest/trusthub/v1/supporting_document.rb', line 207

def delete
   @version.delete('DELETE', @uri)
end

#fetchSupportingDocumentInstance

Fetch the SupportingDocumentInstance

Returns:


180
181
182
183
184
# File 'lib/twilio-ruby/rest/trusthub/v1/supporting_document.rb', line 180

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

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

#inspectObject

Provide a detailed, user friendly representation


220
221
222
223
# File 'lib/twilio-ruby/rest/trusthub/v1/supporting_document.rb', line 220

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

#to_sObject

Provide a user friendly representation


213
214
215
216
# File 'lib/twilio-ruby/rest/trusthub/v1/supporting_document.rb', line 213

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

#update(friendly_name: :unset, attributes: :unset) ⇒ SupportingDocumentInstance

Update the SupportingDocumentInstance

Parameters:

  • friendly_name (String) (defaults to: :unset)

    The string that you assigned to describe the resource.

  • attributes (Hash) (defaults to: :unset)

    The set of parameters that are the attributes of the Supporting Document resource which are derived Supporting Document Types.

Returns:


193
194
195
196
197
198
199
200
201
202
# File 'lib/twilio-ruby/rest/trusthub/v1/supporting_document.rb', line 193

def update(friendly_name: :unset, attributes: :unset)
  data = Twilio::Values.of({
      'FriendlyName' => friendly_name,
      'Attributes' => Twilio.serialize_object(attributes),
  })

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

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