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.



157
158
159
160
161
162
163
164
165
 
# File 'lib/twilio-ruby/rest/trusthub/v1/supporting_document.rb', line 157

def initialize(version, sid)
    super(version)

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

    
end

Instance Method Details

#delete ⇒ Boolean

Delete the SupportingDocumentInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



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

def delete

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

#fetch ⇒ SupportingDocumentInstance

Fetch the SupportingDocumentInstance

Returns:



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

def fetch

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

#inspect ⇒ Object

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_s ⇒ Object

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 (Object) (defaults to: :unset) —

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

Returns:



192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
 
# File 'lib/twilio-ruby/rest/trusthub/v1/supporting_document.rb', line 192

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