talon_one 3.0.2 → 4.0.0

data/lib/talon_one/models/ledger_points_entry_integration_api.rb

@@ -0,0 +1,400 @@
+=begin
+#Talon.One API
+
+#Use the Talon.One API to integrate with your application and to manage applications and campaigns:  - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns.  ## Determining the base URL of the endpoints  The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` 
+
+The version of the OpenAPI document: 
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.3.1
+
+=end
+
+require 'date'
+
+module TalonOne
+  # Loyalty profile points with start and expiry dates.
+  class LedgerPointsEntryIntegrationAPI
+    # ID of the transaction that adds loyalty points.
+    attr_accessor :id
+
+    # Date and time the loyalty points were added.
+    attr_accessor :created
+
+    # ID of the loyalty program.
+    attr_accessor :program_id
+
+    # ID of the customer session where points were added.
+    attr_accessor :customer_session_id
+
+    # Name or reason of the transaction that adds loyalty points.
+    attr_accessor :name
+
+    # When points become active. Possible values:   - `immediate`: Points are active immediately.   - `timestamp value`: Points become active at a given date and time. 
+    attr_accessor :start_date
+
+    # Date when points expire. Possible values are:   - `unlimited`: Points have no expiration date.   - `timestamp value`: Points expire on the given date and time. 
+    attr_accessor :expiry_date
+
+    # ID of the subledger.
+    attr_accessor :subledger_id
+
+    # Amount of loyalty points added in the transaction.
+    attr_accessor :amount
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'id' => :'id',
+        :'created' => :'created',
+        :'program_id' => :'programId',
+        :'customer_session_id' => :'customerSessionId',
+        :'name' => :'name',
+        :'start_date' => :'startDate',
+        :'expiry_date' => :'expiryDate',
+        :'subledger_id' => :'subledgerId',
+        :'amount' => :'amount'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'id' => :'Integer',
+        :'created' => :'DateTime',
+        :'program_id' => :'Integer',
+        :'customer_session_id' => :'String',
+        :'name' => :'String',
+        :'start_date' => :'String',
+        :'expiry_date' => :'String',
+        :'subledger_id' => :'String',
+        :'amount' => :'Float'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `TalonOne::LedgerPointsEntryIntegrationAPI` 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 `TalonOne::LedgerPointsEntryIntegrationAPI`. 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?(:'id')
+        self.id = attributes[:'id']
+      end
+
+      if attributes.key?(:'created')
+        self.created = attributes[:'created']
+      end
+
+      if attributes.key?(:'program_id')
+        self.program_id = attributes[:'program_id']
+      end
+
+      if attributes.key?(:'customer_session_id')
+        self.customer_session_id = attributes[:'customer_session_id']
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.key?(:'start_date')
+        self.start_date = attributes[:'start_date']
+      end
+
+      if attributes.key?(:'expiry_date')
+        self.expiry_date = attributes[:'expiry_date']
+      end
+
+      if attributes.key?(:'subledger_id')
+        self.subledger_id = attributes[:'subledger_id']
+      end
+
+      if attributes.key?(:'amount')
+        self.amount = attributes[:'amount']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      if @id.nil?
+        invalid_properties.push('invalid value for "id", id cannot be nil.')
+      end
+
+      if @created.nil?
+        invalid_properties.push('invalid value for "created", created cannot be nil.')
+      end
+
+      if @program_id.nil?
+        invalid_properties.push('invalid value for "program_id", program_id cannot be nil.')
+      end
+
+      if !@customer_session_id.nil? && @customer_session_id.to_s.length > 255
+        invalid_properties.push('invalid value for "customer_session_id", the character length must be smaller than or equal to 255.')
+      end
+
+      if @name.nil?
+        invalid_properties.push('invalid value for "name", name cannot be nil.')
+      end
+
+      if @name.to_s.length > 255
+        invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 255.')
+      end
+
+      if @start_date.nil?
+        invalid_properties.push('invalid value for "start_date", start_date cannot be nil.')
+      end
+
+      if @start_date.to_s.length > 64
+        invalid_properties.push('invalid value for "start_date", the character length must be smaller than or equal to 64.')
+      end
+
+      if @expiry_date.nil?
+        invalid_properties.push('invalid value for "expiry_date", expiry_date cannot be nil.')
+      end
+
+      if @subledger_id.nil?
+        invalid_properties.push('invalid value for "subledger_id", subledger_id cannot be nil.')
+      end
+
+      if @subledger_id.to_s.length > 64
+        invalid_properties.push('invalid value for "subledger_id", the character length must be smaller than or equal to 64.')
+      end
+
+      if @amount.nil?
+        invalid_properties.push('invalid value for "amount", amount cannot be nil.')
+      end
+
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      return false if @id.nil?
+      return false if @created.nil?
+      return false if @program_id.nil?
+      return false if !@customer_session_id.nil? && @customer_session_id.to_s.length > 255
+      return false if @name.nil?
+      return false if @name.to_s.length > 255
+      return false if @start_date.nil?
+      return false if @start_date.to_s.length > 64
+      return false if @expiry_date.nil?
+      return false if @subledger_id.nil?
+      return false if @subledger_id.to_s.length > 64
+      return false if @amount.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] customer_session_id Value to be assigned
+    def customer_session_id=(customer_session_id)
+      if !customer_session_id.nil? && customer_session_id.to_s.length > 255
+        fail ArgumentError, 'invalid value for "customer_session_id", the character length must be smaller than or equal to 255.'
+      end
+
+      @customer_session_id = customer_session_id
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] name Value to be assigned
+    def name=(name)
+      if name.nil?
+        fail ArgumentError, 'name cannot be nil'
+      end
+
+      if name.to_s.length > 255
+        fail ArgumentError, 'invalid value for "name", the character length must be smaller than or equal to 255.'
+      end
+
+      @name = name
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] start_date Value to be assigned
+    def start_date=(start_date)
+      if start_date.nil?
+        fail ArgumentError, 'start_date cannot be nil'
+      end
+
+      if start_date.to_s.length > 64
+        fail ArgumentError, 'invalid value for "start_date", the character length must be smaller than or equal to 64.'
+      end
+
+      @start_date = start_date
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] subledger_id Value to be assigned
+    def subledger_id=(subledger_id)
+      if subledger_id.nil?
+        fail ArgumentError, 'subledger_id cannot be nil'
+      end
+
+      if subledger_id.to_s.length > 64
+        fail ArgumentError, 'invalid value for "subledger_id", the character length must be smaller than or equal to 64.'
+      end
+
+      @subledger_id = subledger_id
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          id == o.id &&
+          created == o.created &&
+          program_id == o.program_id &&
+          customer_session_id == o.customer_session_id &&
+          name == o.name &&
+          start_date == o.start_date &&
+          expiry_date == o.expiry_date &&
+          subledger_id == o.subledger_id &&
+          amount == o.amount
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [id, created, program_id, customer_session_id, name, start_date, expiry_date, subledger_id, amount].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      new.build_from_hash(attributes)
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    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
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    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
+        TalonOne.const_get(type).build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    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
+
+    # 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
+    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
+  end
+end

data/lib/talon_one/models/login_params.rb

@@ -15,7 +15,7 @@ require 'date'
 module TalonOne
   # 
   class LoginParams
-    # The email address associated with your account.
+    # The email address associated with the user profile.
     attr_accessor :email
 
     # The password for your account.

data/lib/talon_one/models/loyalty.rb

@@ -13,7 +13,7 @@ OpenAPI Generator version: 4.3.1
 require 'date'
 
 module TalonOne
-  # Customer specific information about loyalty points.
+  # Customer-specific information about loyalty points.
   class Loyalty
     # Displays information about the balances of the loyalty cards.
     attr_accessor :cards

data/lib/talon_one/models/loyalty_ledger_transactions.rb

@@ -15,7 +15,7 @@ require 'date'
 module TalonOne
   # List of loyalty ledger transactions.
   class LoyaltyLedgerTransactions
-    # true means there is more data in the source collection to request.
+    # If `true`, it means that there is more data to request in the source collection.
     attr_accessor :has_more
 
     # List of transaction entries from a loyalty ledger.

data/lib/talon_one/models/loyalty_program.rb

@@ -45,6 +45,18 @@ module TalonOne
     # Indicates if this program is a live or sandbox program. Programs of a given type can only be connected to Applications of the same type.
     attr_accessor :sandbox
 
+    # The policy that defines which date is used to calculate the expiration date of a customer's current tier.  - `tier_start_date`: The tier expiration date is calculated based on when the customer joined the current tier.  - `program_join_date`: The tier expiration date is calculated based on when the customer joined the loyalty program. 
+    attr_accessor :tiers_expiration_policy
+
+    # The amount of time after which the tier expires.  The time format is an **integer** followed by one letter indicating the time unit. Examples: `30s`, `40m`, `1h`, `5D`, `7W`, `10M`, `15Y`.  Available units:  - `s`: seconds - `m`: minutes - `h`: hours - `D`: days - `W`: weeks - `M`: months - `Y`: years  You can round certain units up or down: - `_D` for rounding down days only. Signifies the start of the day. - `_U` for rounding up days, weeks, months and years. Signifies the end of the day, week, month or year. 
+    attr_accessor :tiers_expire_in
+
+    # Customers's tier downgrade policy.  - `one_down`: Once the tier expires and if the user doesn't have enough points to stay in the tier, the user is downgraded one tier down.  - `balance_based`: Once the tier expires, the user's tier is evaluated based on the amount of active points the user has at this instant. 
+    attr_accessor :tiers_downgrade_policy
+
+    # The policy that defines when the customer joins the loyalty program.   - `not_join`: The customer does not join the loyalty program but can still earn and spend loyalty points.       **Note**: The customer does not have a program join date.   - `points_activated`: The customer joins the loyalty program only when their earned loyalty points become active for the first time.   - `points_earned`: The customer joins the loyalty program when they earn loyalty points for the first time. 
+    attr_accessor :program_join_policy
+
     # The ID of the Talon.One account that owns this program.
     attr_accessor :account_id
 
@@ -60,6 +72,37 @@ module TalonOne
     # Defines the type of loyalty program: - `true`: the program is a card-based. - `false`: the program is profile-based. 
     attr_accessor :card_based
 
+    # `True` if the tier definitions can be updated. 
+    attr_accessor :can_update_tiers
+
+    # Indicates whether the program join policy can be updated. The join policy can be updated when this value is set to `true`. 
+    attr_accessor :can_update_join_policy
+
+    # `True` if the program can be upgraded to use the `tiersExpireIn` and `tiersDowngradePolicy` properties. 
+    attr_accessor :can_upgrade_to_advanced_tiers
+
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -73,11 +116,18 @@ module TalonOne
         :'allow_subledger' => :'allowSubledger',
         :'users_per_card_limit' => :'usersPerCardLimit',
         :'sandbox' => :'sandbox',
+        :'tiers_expiration_policy' => :'tiersExpirationPolicy',
+        :'tiers_expire_in' => :'tiersExpireIn',
+        :'tiers_downgrade_policy' => :'tiersDowngradePolicy',
+        :'program_join_policy' => :'programJoinPolicy',
         :'account_id' => :'accountID',
         :'name' => :'name',
         :'tiers' => :'tiers',
         :'timezone' => :'timezone',
-        :'card_based' => :'cardBased'
+        :'card_based' => :'cardBased',
+        :'can_update_tiers' => :'canUpdateTiers',
+        :'can_update_join_policy' => :'canUpdateJoinPolicy',
+        :'can_upgrade_to_advanced_tiers' => :'canUpgradeToAdvancedTiers'
       }
     end
 
@@ -94,11 +144,18 @@ module TalonOne
         :'allow_subledger' => :'Boolean',
         :'users_per_card_limit' => :'Integer',
         :'sandbox' => :'Boolean',
+        :'tiers_expiration_policy' => :'String',
+        :'tiers_expire_in' => :'String',
+        :'tiers_downgrade_policy' => :'String',
+        :'program_join_policy' => :'String',
         :'account_id' => :'Integer',
         :'name' => :'String',
         :'tiers' => :'Array<LoyaltyTier>',
         :'timezone' => :'String',
-        :'card_based' => :'Boolean'
+        :'card_based' => :'Boolean',
+        :'can_update_tiers' => :'Boolean',
+        :'can_update_join_policy' => :'Boolean',
+        :'can_upgrade_to_advanced_tiers' => :'Boolean'
       }
     end
 
@@ -165,6 +222,22 @@ module TalonOne
         self.sandbox = attributes[:'sandbox']
       end
 
+      if attributes.key?(:'tiers_expiration_policy')
+        self.tiers_expiration_policy = attributes[:'tiers_expiration_policy']
+      end
+
+      if attributes.key?(:'tiers_expire_in')
+        self.tiers_expire_in = attributes[:'tiers_expire_in']
+      end
+
+      if attributes.key?(:'tiers_downgrade_policy')
+        self.tiers_downgrade_policy = attributes[:'tiers_downgrade_policy']
+      end
+
+      if attributes.key?(:'program_join_policy')
+        self.program_join_policy = attributes[:'program_join_policy']
+      end
+
       if attributes.key?(:'account_id')
         self.account_id = attributes[:'account_id']
       end
@@ -188,6 +261,22 @@ module TalonOne
       else
         self.card_based = false
       end
+
+      if attributes.key?(:'can_update_tiers')
+        self.can_update_tiers = attributes[:'can_update_tiers']
+      else
+        self.can_update_tiers = false
+      end
+
+      if attributes.key?(:'can_update_join_policy')
+        self.can_update_join_policy = attributes[:'can_update_join_policy']
+      end
+
+      if attributes.key?(:'can_upgrade_to_advanced_tiers')
+        self.can_upgrade_to_advanced_tiers = attributes[:'can_upgrade_to_advanced_tiers']
+      else
+        self.can_upgrade_to_advanced_tiers = false
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -270,6 +359,12 @@ module TalonOne
       return false if @allow_subledger.nil?
       return false if !@users_per_card_limit.nil? && @users_per_card_limit < 0
       return false if @sandbox.nil?
+      tiers_expiration_policy_validator = EnumAttributeValidator.new('String', ["tier_start_date", "program_join_date"])
+      return false unless tiers_expiration_policy_validator.valid?(@tiers_expiration_policy)
+      tiers_downgrade_policy_validator = EnumAttributeValidator.new('String', ["one_down", "balance_based"])
+      return false unless tiers_downgrade_policy_validator.valid?(@tiers_downgrade_policy)
+      program_join_policy_validator = EnumAttributeValidator.new('String', ["not_join", "points_activated", "points_earned"])
+      return false unless program_join_policy_validator.valid?(@program_join_policy)
       return false if @account_id.nil?
       return false if @name.nil?
       return false if @timezone.nil?
@@ -288,6 +383,36 @@ module TalonOne
       @users_per_card_limit = users_per_card_limit
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] tiers_expiration_policy Object to be assigned
+    def tiers_expiration_policy=(tiers_expiration_policy)
+      validator = EnumAttributeValidator.new('String', ["tier_start_date", "program_join_date"])
+      unless validator.valid?(tiers_expiration_policy)
+        fail ArgumentError, "invalid value for \"tiers_expiration_policy\", must be one of #{validator.allowable_values}."
+      end
+      @tiers_expiration_policy = tiers_expiration_policy
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] tiers_downgrade_policy Object to be assigned
+    def tiers_downgrade_policy=(tiers_downgrade_policy)
+      validator = EnumAttributeValidator.new('String', ["one_down", "balance_based"])
+      unless validator.valid?(tiers_downgrade_policy)
+        fail ArgumentError, "invalid value for \"tiers_downgrade_policy\", must be one of #{validator.allowable_values}."
+      end
+      @tiers_downgrade_policy = tiers_downgrade_policy
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] program_join_policy Object to be assigned
+    def program_join_policy=(program_join_policy)
+      validator = EnumAttributeValidator.new('String', ["not_join", "points_activated", "points_earned"])
+      unless validator.valid?(program_join_policy)
+        fail ArgumentError, "invalid value for \"program_join_policy\", must be one of #{validator.allowable_values}."
+      end
+      @program_join_policy = program_join_policy
+    end
+
     # Custom attribute writer method with validation
     # @param [Object] timezone Value to be assigned
     def timezone=(timezone)
@@ -317,11 +442,18 @@ module TalonOne
           allow_subledger == o.allow_subledger &&
           users_per_card_limit == o.users_per_card_limit &&
           sandbox == o.sandbox &&
+          tiers_expiration_policy == o.tiers_expiration_policy &&
+          tiers_expire_in == o.tiers_expire_in &&
+          tiers_downgrade_policy == o.tiers_downgrade_policy &&
+          program_join_policy == o.program_join_policy &&
           account_id == o.account_id &&
           name == o.name &&
           tiers == o.tiers &&
           timezone == o.timezone &&
-          card_based == o.card_based
+          card_based == o.card_based &&
+          can_update_tiers == o.can_update_tiers &&
+          can_update_join_policy == o.can_update_join_policy &&
+          can_upgrade_to_advanced_tiers == o.can_upgrade_to_advanced_tiers
     end
 
     # @see the `==` method
@@ -333,7 +465,7 @@ module TalonOne
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, created, title, description, subscribed_applications, default_validity, default_pending, allow_subledger, users_per_card_limit, sandbox, account_id, name, tiers, timezone, card_based].hash
+      [id, created, title, description, subscribed_applications, default_validity, default_pending, allow_subledger, users_per_card_limit, sandbox, tiers_expiration_policy, tiers_expire_in, tiers_downgrade_policy, program_join_policy, account_id, name, tiers, timezone, card_based, can_update_tiers, can_update_join_policy, can_upgrade_to_advanced_tiers].hash
     end
 
     # Builds the object from hash