class KoronaCloudClient::Cashier
Attributes
indicates whether the object is active for use or not
global object uuid (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx)
by default, the md5 hash of the cashiers login code. on GET requests this can be changed via the `displayCashierCredentials=(HASH|PLAIN|NONE)` parameter, on POST and PATCH it is always assumed to be `PLAIN` text.
by default, the md5 hash of the cashiers login password. on GET requests this can be changed via the `displayCashierCredentials=(HASH|PLAIN|NONE)` parameter, on POST and PATCH it is always assumed to be `PLAIN` text.
number of the object, like it is set in backoffice; will be removed when active=false
the revision number of the object. revision numbers are unique per object-type. there is is no object of the same type with identical revision numbers.
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/korona-cloud-client/models/cashier.rb, line 84 def self.attribute_map { :'active' => :'active', :'id' => :'id', :'number' => :'number', :'revision' => :'revision', :'_alias' => :'alias', :'deactivated' => :'deactivated', :'email' => :'email', :'firstname' => :'firstname', :'surname' => :'surname', :'gender' => :'gender', :'login_code' => :'loginCode', :'login_password' => :'loginPassword', :'permissions' => :'permissions', :'role' => :'role', :'bonus_points' => :'bonusPoints', :'background_color' => :'backgroundColor', :'cashier_role' => :'cashierRole', :'create_time' => :'createTime', :'last_receipt_time' => :'lastReceiptTime' } end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/korona-cloud-client/models/cashier.rb, line 299 def self.build_from_hash(attributes) new.build_from_hash(attributes) end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/korona-cloud-client/models/cashier.rb, line 141 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `KoronaCloudClient::Cashier` initialize method" end # check to see if the attribute exists and convert string to symbol for hash key attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.attribute_map.key?(k.to_sym)) fail ArgumentError, "`#{k}` is not a valid attribute in `KoronaCloudClient::Cashier`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect end h[k.to_sym] = v } if attributes.key?(:'active') self.active = attributes[:'active'] end if attributes.key?(:'id') self.id = attributes[:'id'] end if attributes.key?(:'number') self.number = attributes[:'number'] end if attributes.key?(:'revision') self.revision = attributes[:'revision'] end if attributes.key?(:'_alias') self._alias = attributes[:'_alias'] end if attributes.key?(:'deactivated') self.deactivated = attributes[:'deactivated'] end if attributes.key?(:'email') self.email = attributes[:'email'] end if attributes.key?(:'firstname') self.firstname = attributes[:'firstname'] end if attributes.key?(:'surname') self.surname = attributes[:'surname'] end if attributes.key?(:'gender') self.gender = attributes[:'gender'] end if attributes.key?(:'login_code') self.login_code = attributes[:'login_code'] end if attributes.key?(:'login_password') self.login_password = attributes[:'login_password'] end if attributes.key?(:'permissions') if (value = attributes[:'permissions']).is_a?(Array) self.permissions = value end end if attributes.key?(:'role') self.role = attributes[:'role'] end if attributes.key?(:'bonus_points') self.bonus_points = attributes[:'bonus_points'] end if attributes.key?(:'background_color') self.background_color = attributes[:'background_color'] end if attributes.key?(:'cashier_role') self.cashier_role = attributes[:'cashier_role'] end if attributes.key?(:'create_time') self.create_time = attributes[:'create_time'] end if attributes.key?(:'last_receipt_time') self.last_receipt_time = attributes[:'last_receipt_time'] end end
List of attributes with nullable: true
# File lib/korona-cloud-client/models/cashier.rb, line 134 def self.openapi_nullable Set.new([ ]) end
Attribute type mapping.
# File lib/korona-cloud-client/models/cashier.rb, line 109 def self.openapi_types { :'active' => :'Boolean', :'id' => :'String', :'number' => :'String', :'revision' => :'Integer', :'_alias' => :'String', :'deactivated' => :'Boolean', :'email' => :'String', :'firstname' => :'String', :'surname' => :'String', :'gender' => :'String', :'login_code' => :'String', :'login_password' => :'String', :'permissions' => :'Array<String>', :'role' => :'String', :'bonus_points' => :'Integer', :'background_color' => :'Integer', :'cashier_role' => :'ModelReference', :'create_time' => :'Date', :'last_receipt_time' => :'Date' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/korona-cloud-client/models/cashier.rb, line 260 def ==(o) return true if self.equal?(o) self.class == o.class && active == o.active && id == o.id && number == o.number && revision == o.revision && _alias == o._alias && deactivated == o.deactivated && email == o.email && firstname == o.firstname && surname == o.surname && gender == o.gender && login_code == o.login_code && login_password == o.login_password && permissions == o.permissions && role == o.role && bonus_points == o.bonus_points && background_color == o.background_color && cashier_role == o.cashier_role && create_time == o.create_time && last_receipt_time == o.last_receipt_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/korona-cloud-client/models/cashier.rb, line 327 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 KoronaCloudClient.const_get(type).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/korona-cloud-client/models/cashier.rb, line 396 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/korona-cloud-client/models/cashier.rb, line 306 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 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/korona-cloud-client/models/cashier.rb, line 286 def eql?(o) self == o end
Custom attribute writer method checking allowed values (enum). @param [Object] gender Object to be assigned
# File lib/korona-cloud-client/models/cashier.rb, line 250 def gender=(gender) validator = EnumAttributeValidator.new('String', ["MALE", "FEMALE"]) unless validator.valid?(gender) fail ArgumentError, "invalid value for \"gender\", must be one of #{validator.allowable_values}." end @gender = gender end
Calculates hash code according to all attributes. @return [Integer] Hash code
# File lib/korona-cloud-client/models/cashier.rb, line 292 def hash [active, id, number, revision, _alias, deactivated, email, firstname, surname, gender, login_code, login_password, permissions, role, bonus_points, background_color, cashier_role, create_time, last_receipt_time].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
# File lib/korona-cloud-client/models/cashier.rb, line 235 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/korona-cloud-client/models/cashier.rb, line 378 def to_hash hash = {} self.class.attribute_map.each_pair do |attr, param| value = self.send(attr) if value.nil? is_nullable = self.class.openapi_nullable.include?(attr) next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) end hash[param] = _to_hash(value) end hash end
Returns the string representation of the object @return [String] String presentation of the object
# File lib/korona-cloud-client/models/cashier.rb, line 366 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/korona-cloud-client/models/cashier.rb, line 242 def valid? gender_validator = EnumAttributeValidator.new('String', ["MALE", "FEMALE"]) return false unless gender_validator.valid?(@gender) true end