Class: Twilio::REST::Verify::V2::FormInstance
- Inherits:
-
InstanceResource
- Object
- InstanceResource
- Twilio::REST::Verify::V2::FormInstance
- Defined in:
- lib/twilio-ruby/rest/verify/v2/form.rb
Instance Method Summary collapse
-
#context ⇒ FormContext
Generate an instance context for the instance, the context is capable of performing various actions.
-
#fetch ⇒ FormInstance
Fetch the FormInstance.
-
#form_meta ⇒ Hash
Additional information for the available forms for this type.
- #form_type ⇒ FormTypes
-
#forms ⇒ Hash
Object that contains the available forms for this type.
-
#initialize(version, payload, form_type: nil) ⇒ FormInstance
constructor
Initialize the FormInstance.
-
#inspect ⇒ Object
Provide a detailed, user friendly representation.
-
#to_s ⇒ Object
Provide a user friendly representation.
-
#url ⇒ String
The URL to access the forms for this type.
Constructor Details
#initialize(version, payload, form_type: nil) ⇒ FormInstance
Initialize the FormInstance
126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 |
# File 'lib/twilio-ruby/rest/verify/v2/form.rb', line 126 def initialize(version, payload , form_type: nil) super(version) # Marshaled Properties @properties = { 'form_type' => payload['form_type'], 'forms' => payload['forms'], 'form_meta' => payload['form_meta'], 'url' => payload['url'], } # Context @instance_context = nil @params = { 'form_type' => form_type || @properties['form_type'] , } end |
Instance Method Details
#context ⇒ FormContext
Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context
146 147 148 149 150 151 |
# File 'lib/twilio-ruby/rest/verify/v2/form.rb', line 146 def context unless @instance_context @instance_context = FormContext.new(@version , @params['form_type']) end @instance_context end |
#fetch ⇒ FormInstance
Fetch the FormInstance
180 181 182 183 |
# File 'lib/twilio-ruby/rest/verify/v2/form.rb', line 180 def fetch context.fetch end |
#form_meta ⇒ Hash
Returns Additional information for the available forms for this type. E.g. The separator string used for ‘binding` in a Factor push.
167 168 169 |
# File 'lib/twilio-ruby/rest/verify/v2/form.rb', line 167 def @properties['form_meta'] end |
#form_type ⇒ FormTypes
155 156 157 |
# File 'lib/twilio-ruby/rest/verify/v2/form.rb', line 155 def form_type @properties['form_type'] end |
#forms ⇒ Hash
Returns Object that contains the available forms for this type. This available forms are given in the standard [JSON Schema](json-schema.org/) format.
161 162 163 |
# File 'lib/twilio-ruby/rest/verify/v2/form.rb', line 161 def forms @properties['forms'] end |
#inspect ⇒ Object
Provide a detailed, user friendly representation
194 195 196 197 |
# File 'lib/twilio-ruby/rest/verify/v2/form.rb', line 194 def inspect values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ") "<Twilio.Verify.V2.FormInstance #{values}>" end |
#to_s ⇒ Object
Provide a user friendly representation
187 188 189 190 |
# File 'lib/twilio-ruby/rest/verify/v2/form.rb', line 187 def to_s values = @params.map{|k, v| "#{k}: #{v}"}.join(" ") "<Twilio.Verify.V2.FormInstance #{values}>" end |
#url ⇒ String
Returns The URL to access the forms for this type.
173 174 175 |
# File 'lib/twilio-ruby/rest/verify/v2/form.rb', line 173 def url @properties['url'] end |