Class: FormAPI::Template
- Inherits:
-
Object
- Object
- FormAPI::Template
- Defined in:
- lib/form_api/models/template.rb
Defined Under Namespace
Classes: EnumAttributeValidator
Instance Attribute Summary collapse
-
#allow_additional_properties ⇒ Object
Returns the value of attribute allow_additional_properties.
-
#document_url ⇒ Object
Returns the value of attribute document_url.
-
#editable_submissions ⇒ Object
Returns the value of attribute editable_submissions.
-
#expiration_interval ⇒ Object
Returns the value of attribute expiration_interval.
-
#expire_after ⇒ Object
Returns the value of attribute expire_after.
-
#expire_submissions ⇒ Object
Returns the value of attribute expire_submissions.
-
#id ⇒ Object
Returns the value of attribute id.
-
#name ⇒ Object
Returns the value of attribute name.
-
#page_dimensions ⇒ Object
Returns the value of attribute page_dimensions.
-
#parent_folder_id ⇒ Object
Returns the value of attribute parent_folder_id.
-
#path ⇒ Object
Returns the value of attribute path.
-
#permanent_document_url ⇒ Object
Returns the value of attribute permanent_document_url.
-
#public_submissions ⇒ Object
Returns the value of attribute public_submissions.
-
#public_web_form ⇒ Object
Returns the value of attribute public_web_form.
-
#redirect_url ⇒ Object
Returns the value of attribute redirect_url.
-
#slack_webhook_url ⇒ Object
Returns the value of attribute slack_webhook_url.
-
#template_type ⇒ Object
Returns the value of attribute template_type.
-
#webhook_url ⇒ Object
Returns the value of attribute webhook_url.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.openapi_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(o) ⇒ Object
Checks equality by comparing each attribute.
-
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type.
-
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(o) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ Template
constructor
Initializes the object.
-
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons.
-
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility).
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
-
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid.
Constructor Details
#initialize(attributes = {}) ⇒ Template
Initializes the object
125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 |
# File 'lib/form_api/models/template.rb', line 125 def initialize(attributes = {}) return unless attributes.is_a?(Hash) # convert string to symbol for hash key attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v } if attributes.has_key?(:'expiration_interval') self.expiration_interval = attributes[:'expiration_interval'] end if attributes.has_key?(:'webhook_url') self.webhook_url = attributes[:'webhook_url'] end if attributes.has_key?(:'parent_folder_id') self.parent_folder_id = attributes[:'parent_folder_id'] end if attributes.has_key?(:'expire_after') self.expire_after = attributes[:'expire_after'] end if attributes.has_key?(:'allow_additional_properties') self.allow_additional_properties = attributes[:'allow_additional_properties'] end if attributes.has_key?(:'public_submissions') self.public_submissions = attributes[:'public_submissions'] end if attributes.has_key?(:'slack_webhook_url') self.slack_webhook_url = attributes[:'slack_webhook_url'] end if attributes.has_key?(:'path') self.path = attributes[:'path'] end if attributes.has_key?(:'public_web_form') self.public_web_form = attributes[:'public_web_form'] end if attributes.has_key?(:'editable_submissions') self.editable_submissions = attributes[:'editable_submissions'] end if attributes.has_key?(:'expire_submissions') self.expire_submissions = attributes[:'expire_submissions'] end if attributes.has_key?(:'name') self.name = attributes[:'name'] end if attributes.has_key?(:'permanent_document_url') self.permanent_document_url = attributes[:'permanent_document_url'] end if attributes.has_key?(:'template_type') self.template_type = attributes[:'template_type'] end if attributes.has_key?(:'id') self.id = attributes[:'id'] end if attributes.has_key?(:'page_dimensions') if (value = attributes[:'page_dimensions']).is_a?(Array) self.page_dimensions = value end end if attributes.has_key?(:'redirect_url') self.redirect_url = attributes[:'redirect_url'] end if attributes.has_key?(:'document_url') self.document_url = attributes[:'document_url'] end end |
Instance Attribute Details
#allow_additional_properties ⇒ Object
Returns the value of attribute allow_additional_properties.
25 26 27 |
# File 'lib/form_api/models/template.rb', line 25 def allow_additional_properties @allow_additional_properties end |
#document_url ⇒ Object
Returns the value of attribute document_url.
51 52 53 |
# File 'lib/form_api/models/template.rb', line 51 def document_url @document_url end |
#editable_submissions ⇒ Object
Returns the value of attribute editable_submissions.
35 36 37 |
# File 'lib/form_api/models/template.rb', line 35 def editable_submissions @editable_submissions end |
#expiration_interval ⇒ Object
Returns the value of attribute expiration_interval.
17 18 19 |
# File 'lib/form_api/models/template.rb', line 17 def expiration_interval @expiration_interval end |
#expire_after ⇒ Object
Returns the value of attribute expire_after.
23 24 25 |
# File 'lib/form_api/models/template.rb', line 23 def expire_after @expire_after end |
#expire_submissions ⇒ Object
Returns the value of attribute expire_submissions.
37 38 39 |
# File 'lib/form_api/models/template.rb', line 37 def expire_submissions @expire_submissions end |
#id ⇒ Object
Returns the value of attribute id.
45 46 47 |
# File 'lib/form_api/models/template.rb', line 45 def id @id end |
#name ⇒ Object
Returns the value of attribute name.
39 40 41 |
# File 'lib/form_api/models/template.rb', line 39 def name @name end |
#page_dimensions ⇒ Object
Returns the value of attribute page_dimensions.
47 48 49 |
# File 'lib/form_api/models/template.rb', line 47 def page_dimensions @page_dimensions end |
#parent_folder_id ⇒ Object
Returns the value of attribute parent_folder_id.
21 22 23 |
# File 'lib/form_api/models/template.rb', line 21 def parent_folder_id @parent_folder_id end |
#path ⇒ Object
Returns the value of attribute path.
31 32 33 |
# File 'lib/form_api/models/template.rb', line 31 def path @path end |
#permanent_document_url ⇒ Object
Returns the value of attribute permanent_document_url.
41 42 43 |
# File 'lib/form_api/models/template.rb', line 41 def permanent_document_url @permanent_document_url end |
#public_submissions ⇒ Object
Returns the value of attribute public_submissions.
27 28 29 |
# File 'lib/form_api/models/template.rb', line 27 def public_submissions @public_submissions end |
#public_web_form ⇒ Object
Returns the value of attribute public_web_form.
33 34 35 |
# File 'lib/form_api/models/template.rb', line 33 def public_web_form @public_web_form end |
#redirect_url ⇒ Object
Returns the value of attribute redirect_url.
49 50 51 |
# File 'lib/form_api/models/template.rb', line 49 def redirect_url @redirect_url end |
#slack_webhook_url ⇒ Object
Returns the value of attribute slack_webhook_url.
29 30 31 |
# File 'lib/form_api/models/template.rb', line 29 def slack_webhook_url @slack_webhook_url end |
#template_type ⇒ Object
Returns the value of attribute template_type.
43 44 45 |
# File 'lib/form_api/models/template.rb', line 43 def template_type @template_type end |
#webhook_url ⇒ Object
Returns the value of attribute webhook_url.
19 20 21 |
# File 'lib/form_api/models/template.rb', line 19 def webhook_url @webhook_url end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 |
# File 'lib/form_api/models/template.rb', line 76 def self.attribute_map { :'expiration_interval' => :'expiration_interval', :'webhook_url' => :'webhook_url', :'parent_folder_id' => :'parent_folder_id', :'expire_after' => :'expire_after', :'allow_additional_properties' => :'allow_additional_properties', :'public_submissions' => :'public_submissions', :'slack_webhook_url' => :'slack_webhook_url', :'path' => :'path', :'public_web_form' => :'public_web_form', :'editable_submissions' => :'editable_submissions', :'expire_submissions' => :'expire_submissions', :'name' => :'name', :'permanent_document_url' => :'permanent_document_url', :'template_type' => :'template_type', :'id' => :'id', :'page_dimensions' => :'page_dimensions', :'redirect_url' => :'redirect_url', :'document_url' => :'document_url' } end |
.openapi_types ⇒ Object
Attribute type mapping.
100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 |
# File 'lib/form_api/models/template.rb', line 100 def self.openapi_types { :'expiration_interval' => :'String', :'webhook_url' => :'String', :'parent_folder_id' => :'String', :'expire_after' => :'Float', :'allow_additional_properties' => :'BOOLEAN', :'public_submissions' => :'BOOLEAN', :'slack_webhook_url' => :'String', :'path' => :'String', :'public_web_form' => :'BOOLEAN', :'editable_submissions' => :'BOOLEAN', :'expire_submissions' => :'BOOLEAN', :'name' => :'String', :'permanent_document_url' => :'String', :'template_type' => :'String', :'id' => :'String', :'page_dimensions' => :'Array<Array<Float>>', :'redirect_url' => :'String', :'document_url' => :'String' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 |
# File 'lib/form_api/models/template.rb', line 233 def ==(o) return true if self.equal?(o) self.class == o.class && expiration_interval == o.expiration_interval && webhook_url == o.webhook_url && parent_folder_id == o.parent_folder_id && expire_after == o.expire_after && allow_additional_properties == o.allow_additional_properties && public_submissions == o.public_submissions && slack_webhook_url == o.slack_webhook_url && path == o.path && public_web_form == o.public_web_form && editable_submissions == o.editable_submissions && expire_submissions == o.expire_submissions && name == o.name && permanent_document_url == o.permanent_document_url && template_type == o.template_type && id == o.id && page_dimensions == o.page_dimensions && redirect_url == o.redirect_url && document_url == o.document_url end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 |
# File 'lib/form_api/models/template.rb', line 292 def _deserialize(type, value) case type.to_sym when :DateTime DateTime.parse(value) when :Date Date.parse(value) when :String value.to_s when :Integer value.to_i when :Float value.to_f when :BOOLEAN if value.to_s =~ /\A(true|t|yes|y|1)\z/i true else false end when :Object # generic object (usually a Hash), return directly value when /\AArray<(?<inner_type>.+)>\z/ inner_type = Regexp.last_match[:inner_type] value.map { |v| _deserialize(inner_type, v) } when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/ k_type = Regexp.last_match[:k_type] v_type = Regexp.last_match[:v_type] {}.tap do |hash| value.each do |k, v| hash[_deserialize(k_type, k)] = _deserialize(v_type, v) end end else # model temp_model = FormAPI.const_get(type).new temp_model.build_from_hash(value) end end |
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value
358 359 360 361 362 363 364 365 366 367 368 369 370 |
# File 'lib/form_api/models/template.rb', line 358 def _to_hash(value) if value.is_a?(Array) value.compact.map { |v| _to_hash(v) } elsif value.is_a?(Hash) {}.tap do |hash| value.each { |k, v| hash[k] = _to_hash(v) } end elsif value.respond_to? :to_hash value.to_hash else value end end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 |
# File 'lib/form_api/models/template.rb', line 271 def build_from_hash(attributes) return nil unless attributes.is_a?(Hash) self.class.openapi_types.each_pair do |key, type| if type =~ /\AArray<(.*)>/i # check to ensure the input is an array given that the the attribute # is documented as an array but the input is not if attributes[self.class.attribute_map[key]].is_a?(Array) self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) }) end elsif !attributes[self.class.attribute_map[key]].nil? self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) end # or else data not found in attributes(hash), not an issue as the data can be optional end self end |
#eql?(o) ⇒ Boolean
258 259 260 |
# File 'lib/form_api/models/template.rb', line 258 def eql?(o) self == o end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
264 265 266 |
# File 'lib/form_api/models/template.rb', line 264 def hash [expiration_interval, webhook_url, parent_folder_id, expire_after, allow_additional_properties, public_submissions, slack_webhook_url, path, public_web_form, editable_submissions, expire_submissions, name, permanent_document_url, template_type, id, page_dimensions, redirect_url, document_url].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
208 209 210 211 |
# File 'lib/form_api/models/template.rb', line 208 def list_invalid_properties invalid_properties = Array.new invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
338 339 340 |
# File 'lib/form_api/models/template.rb', line 338 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
344 345 346 347 348 349 350 351 352 |
# File 'lib/form_api/models/template.rb', line 344 def to_hash hash = {} self.class.attribute_map.each_pair do |attr, param| value = self.send(attr) next if value.nil? hash[param] = _to_hash(value) end hash end |
#to_s ⇒ String
Returns the string representation of the object
332 333 334 |
# File 'lib/form_api/models/template.rb', line 332 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
215 216 217 218 219 |
# File 'lib/form_api/models/template.rb', line 215 def valid? expiration_interval_validator = EnumAttributeValidator.new('String', ['minutes', 'hours', 'days']) return false unless expiration_interval_validator.valid?(@expiration_interval) true end |