Class: Twilio::REST::Trusthub::V1::SupportingDocumentTypeInstance
- Inherits:
-
InstanceResource
- Object
- InstanceResource
- Twilio::REST::Trusthub::V1::SupportingDocumentTypeInstance
- Defined in:
- lib/twilio-ruby/rest/trusthub/v1/supporting_document_type.rb
Instance Method Summary collapse
-
#context ⇒ SupportingDocumentTypeContext
Generate an instance context for the instance, the context is capable of performing various actions.
-
#fetch ⇒ SupportingDocumentTypeInstance
Fetch the SupportingDocumentTypeInstance.
-
#fields ⇒ Array<Hash>
The required information for creating a Supporting Document.
-
#friendly_name ⇒ String
A human-readable description of the Supporting Document Type resource.
-
#initialize(version, payload, sid: nil) ⇒ SupportingDocumentTypeInstance
constructor
Initialize the SupportingDocumentTypeInstance.
-
#inspect ⇒ Object
Provide a detailed, user friendly representation.
-
#machine_name ⇒ String
The machine-readable description of the Supporting Document Type resource.
-
#sid ⇒ String
The unique string that identifies the Supporting Document Type resource.
-
#to_s ⇒ Object
Provide a user friendly representation.
-
#url ⇒ String
The absolute URL of the Supporting Document Type resource.
Constructor Details
#initialize(version, payload, sid: nil) ⇒ SupportingDocumentTypeInstance
Initialize the SupportingDocumentTypeInstance
209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 |
# File 'lib/twilio-ruby/rest/trusthub/v1/supporting_document_type.rb', line 209 def initialize(version, payload , sid: nil) super(version) # Marshaled Properties @properties = { 'sid' => payload['sid'], 'friendly_name' => payload['friendly_name'], 'machine_name' => payload['machine_name'], 'fields' => payload['fields'], 'url' => payload['url'], } # Context @instance_context = nil @params = { 'sid' => sid || @properties['sid'] , } end |
Instance Method Details
#context ⇒ SupportingDocumentTypeContext
Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context
230 231 232 233 234 235 |
# File 'lib/twilio-ruby/rest/trusthub/v1/supporting_document_type.rb', line 230 def context unless @instance_context @instance_context = SupportingDocumentTypeContext.new(@version , @params['sid']) end @instance_context end |
#fetch ⇒ SupportingDocumentTypeInstance
Fetch the SupportingDocumentTypeInstance
270 271 272 273 |
# File 'lib/twilio-ruby/rest/trusthub/v1/supporting_document_type.rb', line 270 def fetch context.fetch end |
#fields ⇒ Array<Hash>
Returns The required information for creating a Supporting Document. The required fields will change as regulatory needs change and will differ for businesses and individuals.
257 258 259 |
# File 'lib/twilio-ruby/rest/trusthub/v1/supporting_document_type.rb', line 257 def fields @properties['fields'] end |
#friendly_name ⇒ String
Returns A human-readable description of the Supporting Document Type resource.
245 246 247 |
# File 'lib/twilio-ruby/rest/trusthub/v1/supporting_document_type.rb', line 245 def friendly_name @properties['friendly_name'] end |
#inspect ⇒ Object
Provide a detailed, user friendly representation
284 285 286 287 |
# File 'lib/twilio-ruby/rest/trusthub/v1/supporting_document_type.rb', line 284 def inspect values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ") "<Twilio.Trusthub.V1.SupportingDocumentTypeInstance #{values}>" end |
#machine_name ⇒ String
Returns The machine-readable description of the Supporting Document Type resource.
251 252 253 |
# File 'lib/twilio-ruby/rest/trusthub/v1/supporting_document_type.rb', line 251 def machine_name @properties['machine_name'] end |
#sid ⇒ String
Returns The unique string that identifies the Supporting Document Type resource.
239 240 241 |
# File 'lib/twilio-ruby/rest/trusthub/v1/supporting_document_type.rb', line 239 def sid @properties['sid'] end |
#to_s ⇒ Object
Provide a user friendly representation
277 278 279 280 |
# File 'lib/twilio-ruby/rest/trusthub/v1/supporting_document_type.rb', line 277 def to_s values = @params.map{|k, v| "#{k}: #{v}"}.join(" ") "<Twilio.Trusthub.V1.SupportingDocumentTypeInstance #{values}>" end |
#url ⇒ String
Returns The absolute URL of the Supporting Document Type resource.
263 264 265 |
# File 'lib/twilio-ruby/rest/trusthub/v1/supporting_document_type.rb', line 263 def url @properties['url'] end |