Class: Twilio::REST::Numbers::V2::RegulatoryComplianceList::SupportingDocumentTypeInstance
- Inherits:
-
InstanceResource
- Object
- InstanceResource
- Twilio::REST::Numbers::V2::RegulatoryComplianceList::SupportingDocumentTypeInstance
- Defined in:
- lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/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
220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 |
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/supporting_document_type.rb', line 220 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
241 242 243 244 245 246 |
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/supporting_document_type.rb', line 241 def context unless @instance_context @instance_context = SupportingDocumentTypeContext.new(@version , @params['sid']) end @instance_context end |
#fetch ⇒ SupportingDocumentTypeInstance
Fetch the SupportingDocumentTypeInstance
281 282 283 284 |
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/supporting_document_type.rb', line 281 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.
268 269 270 |
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/supporting_document_type.rb', line 268 def fields @properties['fields'] end |
#friendly_name ⇒ String
Returns A human-readable description of the Supporting Document Type resource.
256 257 258 |
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/supporting_document_type.rb', line 256 def friendly_name @properties['friendly_name'] end |
#inspect ⇒ Object
Provide a detailed, user friendly representation
295 296 297 298 |
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/supporting_document_type.rb', line 295 def inspect values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ") "<Twilio.Numbers.V2.SupportingDocumentTypeInstance #{values}>" end |
#machine_name ⇒ String
Returns The machine-readable description of the Supporting Document Type resource.
262 263 264 |
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/supporting_document_type.rb', line 262 def machine_name @properties['machine_name'] end |
#sid ⇒ String
Returns The unique string that identifies the Supporting Document Type resource.
250 251 252 |
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/supporting_document_type.rb', line 250 def sid @properties['sid'] end |
#to_s ⇒ Object
Provide a user friendly representation
288 289 290 291 |
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/supporting_document_type.rb', line 288 def to_s values = @params.map{|k, v| "#{k}: #{v}"}.join(" ") "<Twilio.Numbers.V2.SupportingDocumentTypeInstance #{values}>" end |
#url ⇒ String
Returns The absolute URL of the Supporting Document Type resource.
274 275 276 |
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/supporting_document_type.rb', line 274 def url @properties['url'] end |