class DocuSign_eSign::Filter
Use this object to create a filtered view of the items in a folder.
Attributes
Access token information.
Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later.
Must be set to "bearer".
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/docusign_esign/models/filter.rb, line 51 def self.attribute_map { :'action_required' => :'actionRequired', :'expires' => :'expires', :'folder_ids' => :'folderIds', :'from_date_time' => :'fromDateTime', :'is_template' => :'isTemplate', :'order' => :'order', :'order_by' => :'orderBy', :'search_target' => :'searchTarget', :'search_text' => :'searchText', :'status' => :'status', :'to_date_time' => :'toDateTime' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/docusign_esign/models/filter.rb, line 86 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?(:'actionRequired') self.action_required = attributes[:'actionRequired'] end if attributes.has_key?(:'expires') self.expires = attributes[:'expires'] end if attributes.has_key?(:'folderIds') self.folder_ids = attributes[:'folderIds'] end if attributes.has_key?(:'fromDateTime') self.from_date_time = attributes[:'fromDateTime'] end if attributes.has_key?(:'isTemplate') self.is_template = attributes[:'isTemplate'] end if attributes.has_key?(:'order') self.order = attributes[:'order'] end if attributes.has_key?(:'orderBy') self.order_by = attributes[:'orderBy'] end if attributes.has_key?(:'searchTarget') self.search_target = attributes[:'searchTarget'] end if attributes.has_key?(:'searchText') self.search_text = attributes[:'searchText'] end if attributes.has_key?(:'status') self.status = attributes[:'status'] end if attributes.has_key?(:'toDateTime') self.to_date_time = attributes[:'toDateTime'] end end
Attribute type mapping.
# File lib/docusign_esign/models/filter.rb, line 68 def self.swagger_types { :'action_required' => :'String', :'expires' => :'String', :'folder_ids' => :'String', :'from_date_time' => :'String', :'is_template' => :'String', :'order' => :'String', :'order_by' => :'String', :'search_target' => :'String', :'search_text' => :'String', :'status' => :'String', :'to_date_time' => :'String' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object
to be compared
# File lib/docusign_esign/models/filter.rb, line 152 def ==(o) return true if self.equal?(o) self.class == o.class && action_required == o.action_required && expires == o.expires && folder_ids == o.folder_ids && from_date_time == o.from_date_time && is_template == o.is_template && order == o.order && order_by == o.order_by && search_target == o.search_target && search_text == o.search_text && status == o.status && to_date_time == o.to_date_time 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/docusign_esign/models/filter.rb, line 204 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 = DocuSign_eSign.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/docusign_esign/models/filter.rb, line 270 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/docusign_esign/models/filter.rb, line 183 def build_from_hash(attributes) return nil unless attributes.is_a?(Hash) self.class.swagger_types.each_pair do |key, type| if type =~ /\AArray<(.*)>/i # check to ensure the input is an array given that 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/docusign_esign/models/filter.rb, line 170 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/docusign_esign/models/filter.rb, line 176 def hash [action_required, expires, folder_ids, from_date_time, is_template, order, order_by, search_target, search_text, status, to_date_time].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
# File lib/docusign_esign/models/filter.rb, line 139 def list_invalid_properties invalid_properties = Array.new invalid_properties end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/docusign_esign/models/filter.rb, line 256 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/docusign_esign/models/filter.rb, line 244 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/docusign_esign/models/filter.rb, line 146 def valid? true end