class YousignClient::OperationInput
Attributes
Mode of authentication
Status of operation
Type of operation
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/yousign_client/models/operation_input.rb, line 57 def self.attribute_map { :'type' => :'type', :'mode' => :'mode', :'all_members' => :'allMembers', :'members' => :'members', :'status' => :'status', :'comment' => :'comment', :'metadata' => :'metadata' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/yousign_client/models/operation_input.rb, line 84 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?(:'type') self.type = attributes[:'type'] end if attributes.has_key?(:'mode') self.mode = attributes[:'mode'] end if attributes.has_key?(:'allMembers') self.all_members = attributes[:'allMembers'] else self.all_members = false end if attributes.has_key?(:'members') if (value = attributes[:'members']).is_a?(Array) self.members = value end end if attributes.has_key?(:'status') self.status = attributes[:'status'] end if attributes.has_key?(:'comment') self.comment = attributes[:'comment'] end if attributes.has_key?(:'metadata') self.metadata = attributes[:'metadata'] end end
Attribute type mapping.
# File lib/yousign_client/models/operation_input.rb, line 70 def self.swagger_types { :'type' => :'String', :'mode' => :'String', :'all_members' => :'BOOLEAN', :'members' => :'Array<String>', :'status' => :'String', :'comment' => :'String', :'metadata' => :'OperationOutputMetadata' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/yousign_client/models/operation_input.rb, line 184 def ==(o) return true if self.equal?(o) self.class == o.class && type == o.type && mode == o.mode && all_members == o.all_members && members == o.members && status == o.status && comment == o.comment && metadata == o.metadata 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/yousign_client/models/operation_input.rb, line 232 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 = YousignClient.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/yousign_client/models/operation_input.rb, line 298 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/yousign_client/models/operation_input.rb, line 211 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/yousign_client/models/operation_input.rb, line 198 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/yousign_client/models/operation_input.rb, line 204 def hash [type, mode, all_members, members, status, comment, metadata].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
# File lib/yousign_client/models/operation_input.rb, line 125 def list_invalid_properties invalid_properties = Array.new if @type.nil? invalid_properties.push('invalid value for "type", type cannot be nil.') end if @mode.nil? invalid_properties.push('invalid value for "mode", mode cannot be nil.') end invalid_properties end
Custom attribute writer method checking allowed values (enum). @param [Object] mode Object to be assigned
# File lib/yousign_client/models/operation_input.rb, line 164 def mode=(mode) validator = EnumAttributeValidator.new('String', ['sms', 'inwebo', 'email']) unless validator.valid?(mode) fail ArgumentError, 'invalid value for "mode", must be one of #{validator.allowable_values}.' end @mode = mode end
Custom attribute writer method checking allowed values (enum). @param [Object] status Object to be assigned
# File lib/yousign_client/models/operation_input.rb, line 174 def status=(status) validator = EnumAttributeValidator.new('String', ['pending', 'done', 'error']) unless validator.valid?(status) fail ArgumentError, 'invalid value for "status", must be one of #{validator.allowable_values}.' end @status = status end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/yousign_client/models/operation_input.rb, line 284 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/yousign_client/models/operation_input.rb, line 272 def to_s to_hash.to_s end
Custom attribute writer method checking allowed values (enum). @param [Object] type Object to be assigned
# File lib/yousign_client/models/operation_input.rb, line 154 def type=(type) validator = EnumAttributeValidator.new('String', ['accept', 'refuse']) unless validator.valid?(type) fail ArgumentError, 'invalid value for "type", must be one of #{validator.allowable_values}.' end @type = type end
Check to see if the all the properties in the model are valid @return true if the model is valid
# File lib/yousign_client/models/operation_input.rb, line 140 def valid? return false if @type.nil? type_validator = EnumAttributeValidator.new('String', ['accept', 'refuse']) return false unless type_validator.valid?(@type) return false if @mode.nil? mode_validator = EnumAttributeValidator.new('String', ['sms', 'inwebo', 'email']) return false unless mode_validator.valid?(@mode) status_validator = EnumAttributeValidator.new('String', ['pending', 'done', 'error']) return false unless status_validator.valid?(@status) true end