class DocSpring::HtmlTemplateData
Attributes
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/docspring/models/html_template_data.rb, line 74 def self.attribute_map { :'expiration_interval' => :'expiration_interval', :'webhook_url' => :'webhook_url', :'scss' => :'scss', :'allow_additional_properties' => :'allow_additional_properties', :'expire_after' => :'expire_after', :'description' => :'description', :'public_submissions' => :'public_submissions', :'slack_webhook_url' => :'slack_webhook_url', :'header_html' => :'header_html', :'public_web_form' => :'public_web_form', :'editable_submissions' => :'editable_submissions', :'expire_submissions' => :'expire_submissions', :'name' => :'name', :'footer_html' => :'footer_html', :'html' => :'html', :'template_type' => :'template_type', :'redirect_url' => :'redirect_url' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/docspring/models/html_template_data.rb, line 121 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?(:'scss') self.scss = attributes[:'scss'] end if attributes.has_key?(:'allow_additional_properties') self.allow_additional_properties = attributes[:'allow_additional_properties'] end if attributes.has_key?(:'expire_after') self.expire_after = attributes[:'expire_after'] end if attributes.has_key?(:'description') self.description = attributes[:'description'] 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?(:'header_html') self.header_html = attributes[:'header_html'] 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?(:'footer_html') self.footer_html = attributes[:'footer_html'] end if attributes.has_key?(:'html') self.html = attributes[:'html'] end if attributes.has_key?(:'template_type') self.template_type = attributes[:'template_type'] end if attributes.has_key?(:'redirect_url') self.redirect_url = attributes[:'redirect_url'] end end
Attribute type mapping.
# File lib/docspring/models/html_template_data.rb, line 97 def self.openapi_types { :'expiration_interval' => :'String', :'webhook_url' => :'String', :'scss' => :'String', :'allow_additional_properties' => :'BOOLEAN', :'expire_after' => :'Float', :'description' => :'String', :'public_submissions' => :'BOOLEAN', :'slack_webhook_url' => :'String', :'header_html' => :'String', :'public_web_form' => :'BOOLEAN', :'editable_submissions' => :'BOOLEAN', :'expire_submissions' => :'BOOLEAN', :'name' => :'String', :'footer_html' => :'String', :'html' => :'String', :'template_type' => :'String', :'redirect_url' => :'String' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/docspring/models/html_template_data.rb, line 235 def ==(o) return true if self.equal?(o) self.class == o.class && expiration_interval == o.expiration_interval && webhook_url == o.webhook_url && scss == o.scss && allow_additional_properties == o.allow_additional_properties && expire_after == o.expire_after && description == o.description && public_submissions == o.public_submissions && slack_webhook_url == o.slack_webhook_url && header_html == o.header_html && public_web_form == o.public_web_form && editable_submissions == o.editable_submissions && expire_submissions == o.expire_submissions && name == o.name && footer_html == o.footer_html && html == o.html && template_type == o.template_type && redirect_url == o.redirect_url end
Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data
# File lib/docspring/models/html_template_data.rb, line 293 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 = DocSpring.const_get(type).new temp_model.build_from_hash(value) end end
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash
# File lib/docspring/models/html_template_data.rb, line 359 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
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/docspring/models/html_template_data.rb, line 272 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
@see the `==` method @param [Object] Object to be compared
# File lib/docspring/models/html_template_data.rb, line 259 def eql?(o) self == o end
Custom attribute writer method checking allowed values (enum). @param [Object] expiration_interval
Object to be assigned
# File lib/docspring/models/html_template_data.rb, line 215 def expiration_interval=(expiration_interval) validator = EnumAttributeValidator.new('String', ['minutes', 'hours', 'days']) unless validator.valid?(expiration_interval) fail ArgumentError, 'invalid value for "expiration_interval", must be one of #{validator.allowable_values}.' end @expiration_interval = expiration_interval end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/docspring/models/html_template_data.rb, line 265 def hash [expiration_interval, webhook_url, scss, allow_additional_properties, expire_after, description, public_submissions, slack_webhook_url, header_html, public_web_form, editable_submissions, expire_submissions, name, footer_html, html, template_type, redirect_url].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
# File lib/docspring/models/html_template_data.rb, line 198 def list_invalid_properties invalid_properties = Array.new invalid_properties end
Custom attribute writer method checking allowed values (enum). @param [Object] template_type
Object to be assigned
# File lib/docspring/models/html_template_data.rb, line 225 def template_type=(template_type) validator = EnumAttributeValidator.new('String', ['pdf', 'html']) unless validator.valid?(template_type) fail ArgumentError, 'invalid value for "template_type", must be one of #{validator.allowable_values}.' end @template_type = template_type end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/docspring/models/html_template_data.rb, line 345 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
Returns the string representation of the object @return [String] String presentation of the object
# File lib/docspring/models/html_template_data.rb, line 333 def to_s to_hash.to_s end
Check to see if the all the properties in the model are valid @return true if the model is valid
# File lib/docspring/models/html_template_data.rb, line 205 def valid? expiration_interval_validator = EnumAttributeValidator.new('String', ['minutes', 'hours', 'days']) return false unless expiration_interval_validator.valid?(@expiration_interval) template_type_validator = EnumAttributeValidator.new('String', ['pdf', 'html']) return false unless template_type_validator.valid?(@template_type) true end