voucherify 8.0.3 → 8.1.0

data/lib/VoucherifySdk/models/orders_import_create_request_body_item.rb

@@ -18,7 +18,7 @@ module VoucherifySdk
     # Unique ID assigned by Voucherify of an existing order that will be linked to the redemption of this request.
     attr_accessor :id
 
-    # Unique source ID of an existing order that will be linked to the redemption of this request.
+    # Unique source ID of an existing order that will be linked to the redemption of this request.  For validation and redemption, if `source_id` is used with an existing order, the original order data will be used, like `items`, `amount`, and so on, not the one sent in the new request.
     attr_accessor :source_id
 
     # The order status.
@@ -39,9 +39,6 @@ module VoucherifySdk
     # A set of custom key/value pairs that you can attach to an order. It can be useful for storing additional information about the order in a structured format. It can be used to define business validation rules or discount formulas.
     attr_accessor :metadata
 
-    # Timestamp representing the date and time when the order was created. The value is shown in the ISO 8601 format.
-    attr_accessor :created_at
-
     # Unique referrer ID.
     attr_accessor :referrer_id
 
@@ -49,6 +46,9 @@ module VoucherifySdk
 
     attr_accessor :referrer
 
+    # Timestamp representing the date and time when the order was created. The value is shown in the ISO 8601 format.
+    attr_accessor :created_at
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -82,10 +82,10 @@ module VoucherifySdk
         :'discount_amount' => :'discount_amount',
         :'items' => :'items',
         :'metadata' => :'metadata',
-        :'created_at' => :'created_at',
         :'referrer_id' => :'referrer_id',
         :'customer' => :'customer',
-        :'referrer' => :'referrer'
+        :'referrer' => :'referrer',
+        :'created_at' => :'created_at'
       }
     end
 
@@ -105,10 +105,10 @@ module VoucherifySdk
         :'discount_amount' => :'Integer',
         :'items' => :'Array<OrderItem>',
         :'metadata' => :'Object',
-        :'created_at' => :'Time',
         :'referrer_id' => :'String',
         :'customer' => :'Customer',
-        :'referrer' => :'Referrer'
+        :'referrer' => :'Referrer',
+        :'created_at' => :'Time'
       }
     end
 
@@ -176,10 +176,6 @@ module VoucherifySdk
         self.metadata = attributes[:'metadata']
       end
 
-      if attributes.key?(:'created_at')
-        self.created_at = attributes[:'created_at']
-      end
-
       if attributes.key?(:'referrer_id')
         self.referrer_id = attributes[:'referrer_id']
       end
@@ -191,6 +187,10 @@ module VoucherifySdk
       if attributes.key?(:'referrer')
         self.referrer = attributes[:'referrer']
       end
+
+      if attributes.key?(:'created_at')
+        self.created_at = attributes[:'created_at']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -223,10 +223,10 @@ module VoucherifySdk
           discount_amount == o.discount_amount &&
           items == o.items &&
           metadata == o.metadata &&
-          created_at == o.created_at &&
           referrer_id == o.referrer_id &&
           customer == o.customer &&
-          referrer == o.referrer
+          referrer == o.referrer &&
+          created_at == o.created_at
     end
 
     # @see the `==` method
@@ -238,7 +238,7 @@ module VoucherifySdk
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, source_id, status, amount, initial_amount, discount_amount, items, metadata, created_at, referrer_id, customer, referrer].hash
+      [id, source_id, status, amount, initial_amount, discount_amount, items, metadata, referrer_id, customer, referrer, created_at].hash
     end
 
     # Builds the object from hash

data/lib/VoucherifySdk/models/orders_update_request_body.rb

@@ -16,7 +16,7 @@ require 'time'
 module VoucherifySdk
   # Request body schema for **PUT** `v1/orders/{orderId}`.
   class OrdersUpdateRequestBody
-    # Unique source ID of an existing order that will be linked to the redemption of this request.
+    # Unique source ID of an existing order that will be linked to the redemption of this request.  For validation and redemption, if `source_id` is used with an existing order, the original order data will be used, like `items`, `amount`, and so on, not the one sent in the new request.
     attr_accessor :source_id
 
     # The order status.

data/lib/VoucherifySdk/models/parameter_filters_list_campaigns_campaign_status.rb

@@ -14,7 +14,7 @@ require 'date'
 require 'time'
 
 module VoucherifySdk
-  # Type of the campaign. Allowed values: `DONE`, `IN_PROGRESS`, `DRAFT`, `FAILED` `MODIFYING`
+  # Status of the campaign. Allowed values: `DONE`, `IN_PROGRESS`, `DRAFT`, `FAILED` `MODIFYING`
   class ParameterFiltersListCampaignsCampaignStatus
     attr_accessor :conditions
 
@@ -40,6 +40,7 @@ module VoucherifySdk
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'conditions'
       ])
     end
 

data/lib/VoucherifySdk/models/parameter_filters_list_campaigns_campaign_status_conditions.rb

@@ -14,6 +14,7 @@ require 'date'
 require 'time'
 
 module VoucherifySdk
+  # Data conditions used to narrow down the data records to be returned in the result.
   class ParameterFiltersListCampaignsCampaignStatusConditions
     # Array of resource values that should be included in the results (multiple values).
     attr_accessor :_in

data/lib/VoucherifySdk/models/parameter_filters_list_campaigns_category_ids.rb

@@ -14,7 +14,7 @@ require 'date'
 require 'time'
 
 module VoucherifySdk
-  # Filter by categories ids
+  # Filter by categories IDs
   class ParameterFiltersListCampaignsCategoryIds
     attr_accessor :conditions
 

data/lib/VoucherifySdk/models/parameter_filters_list_campaigns_is_referral_code.rb

@@ -14,7 +14,7 @@ require 'date'
 require 'time'
 
 module VoucherifySdk
-  # 
+  # Determines if the campaign is or is not a referral campaign.
   class ParameterFiltersListCampaignsIsReferralCode
     # Value is exactly this value (single value).
     attr_accessor :is

data/lib/VoucherifySdk/models/parameters_filters_list_campaign_transactions.rb

@@ -0,0 +1,247 @@
+=begin
+#Voucherify API
+
+#Voucherify promotion engine REST API. Please see https://docs.voucherify.io/docs for more details.
+
+The version of the OpenAPI document: v2018-08-01
+Contact: support@voucherify.io
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 7.0.1
+
+=end
+
+require 'date'
+require 'time'
+
+module VoucherifySdk
+  class ParametersFiltersListCampaignTransactions
+    attr_accessor :junction
+
+    attr_accessor :id
+
+    attr_accessor :voucher_id
+
+    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
+      {
+        :'junction' => :'junction',
+        :'id' => :'id',
+        :'voucher_id' => :'voucher_id'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'junction' => :'Junction',
+        :'id' => :'FilterConditionsString',
+        :'voucher_id' => :'FilterConditionsString'
+      }
+    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 = {})
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'junction')
+        self.junction = attributes[:'junction']
+      end
+
+      if attributes.key?(:'id')
+        self.id = attributes[:'id']
+      end
+
+      if attributes.key?(:'voucher_id')
+        self.voucher_id = attributes[:'voucher_id']
+      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
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = Array.new
+      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?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      true
+    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 &&
+          junction == o.junction &&
+          id == o.id &&
+          voucher_id == o.voucher_id
+    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
+      [junction, id, voucher_id].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)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = nil
+        elsif 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[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      new(transformed_hash)
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def self._deserialize(type, value)
+      case type.to_sym
+      when :Time
+        Time.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
+        # models (e.g. Pet) or oneOf
+        klass = VoucherifySdk.const_get(type)
+        klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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/VoucherifySdk/models/product_collections_create_request_body.rb

@@ -15,7 +15,6 @@ require 'time'
 
 module VoucherifySdk
   class ProductCollectionsCreateRequestBody
-    # Show that the product collection is static (manually selected products).
     attr_accessor :type
 
     # Unique user-defined product collection name.
@@ -77,6 +76,7 @@ module VoucherifySdk
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'type',
         :'name',
         :'products',
         :'filter'
@@ -93,8 +93,6 @@ module VoucherifySdk
 
       if attributes.key?(:'type')
         self.type = attributes[:'type']
-      else
-        self.type = 'STATIC'
       end
 
       if attributes.key?(:'name')
@@ -124,7 +122,7 @@ module VoucherifySdk
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
-      type_validator = EnumAttributeValidator.new('String', ["STATIC"])
+      type_validator = EnumAttributeValidator.new('String', ["STATIC", "AUTO_UPDATE"])
       return false unless type_validator.valid?(@type)
       true
     end

data/lib/VoucherifySdk/models/products_skus_create_request_body.rb

@@ -25,7 +25,7 @@ module VoucherifySdk
     # Unique user-defined SKU name.
     attr_accessor :sku
 
-    # SKU unit price. Value is multiplied by 100 to precisely represent 2 decimal places. For example `10000 cents` for `$100.00`.
+    # SKU unit price. The value is multiplied by 100 to represent 2 decimal places. For example `10000 cents` for `$100.00`.
     attr_accessor :price
 
     # SKU price currency.

data/lib/VoucherifySdk/models/products_skus_create_response_body.rb

@@ -14,7 +14,7 @@ require 'date'
 require 'time'
 
 module VoucherifySdk
-  # Response body schema for **PUT** `v1/products/{productId}/skus`.
+  # Response body schema for **PUT** `v1/products/{productId}/SKUs`.
   class ProductsSkusCreateResponseBody
     # A unique identifier that represents the SKU and is assigned by Voucherify.
     attr_accessor :id

data/lib/VoucherifySdk/models/products_skus_list_response_body.rb

@@ -14,7 +14,7 @@ require 'date'
 require 'time'
 
 module VoucherifySdk
-  # Response body schema for **GET** `v1/products/{productId}/skus`.
+  # Response body schema for **GET** `v1/products/{productId}/SKUs`.
   class ProductsSkusListResponseBody
     # The type of the object represented by JSON. This object stores information about SKUs.
     attr_accessor :object

data/lib/VoucherifySdk/models/products_skus_update_request_body.rb

@@ -19,7 +19,7 @@ module VoucherifySdk
     # Unique user-defined SKU name.
     attr_accessor :sku
 
-    # SKU unit price. Value is multiplied by 100 to precisely represent 2 decimal places. For example `10000 cents` for `$100.00`.
+    # SKU unit price. The value is multiplied by 100 to represent 2 decimal places. For example `10000 cents` for `$100.00`.
     attr_accessor :price
 
     # SKU price currency.

data/lib/VoucherifySdk/models/promotion_tier_campaign.rb

@@ -32,7 +32,7 @@ module VoucherifySdk
 
     attr_accessor :validity_hours
 
-    # A flag indicating whether the campaign is active or not active. A campaign can be disabled even though it's within the active period defined by the `start_date` and `expiration_date` using the <!-- [Disable Campaign](OpenAPI.json/paths/~1campaigns~1{campaignId}~1disable) -->[Disable Campaign](ref:disable-campaign) endpoint.    - `true` indicates an *active* campaign - `false` indicates an *inactive* campaign
+    # A flag indicating whether the campaign is active or not active. A campaign can be disabled even though it's within the active period defined by the `start_date` and `expiration_date` using the [Disable Campaign](/api-reference/disable-campaign) endpoint.    - `true` indicates an *active* campaign - `false` indicates an *inactive* campaign
     attr_accessor :active
 
     # Unique category ID that this campaign belongs to.

data/lib/VoucherifySdk/models/promotions_tiers_create_response_body_campaign.rb

@@ -32,7 +32,7 @@ module VoucherifySdk
 
     attr_accessor :validity_hours
 
-    # A flag indicating whether the campaign is active or not active. A campaign can be disabled even though it's within the active period defined by the `start_date` and `expiration_date` using the <!-- [Disable Campaign](OpenAPI.json/paths/~1campaigns~1{campaignId}~1disable) -->[Disable Campaign](ref:disable-campaign) endpoint.    - `true` indicates an *active* campaign - `false` indicates an *inactive* campaign
+    # A flag indicating whether the campaign is active or not active. A campaign can be disabled even though it's within the active period defined by the `start_date` and `expiration_date` using the [Disable Campaign](/api-reference/disable-campaign) endpoint.    - `true` indicates an *active* campaign - `false` indicates an *inactive* campaign
     attr_accessor :active
 
     # Unique category ID that this campaign belongs to.

data/lib/VoucherifySdk/models/promotions_tiers_disable_response_body_campaign.rb

@@ -32,7 +32,7 @@ module VoucherifySdk
 
     attr_accessor :validity_hours
 
-    # A flag indicating whether the campaign is active or not active. A campaign can be disabled even though it's within the active period defined by the `start_date` and `expiration_date` using the <!-- [Disable Campaign](OpenAPI.json/paths/~1campaigns~1{campaignId}~1disable) -->[Disable Campaign](ref:disable-campaign) endpoint.    - `true` indicates an *active* campaign - `false` indicates an *inactive* campaign
+    # A flag indicating whether the campaign is active or not active. A campaign can be disabled even though it's within the active period defined by the `start_date` and `expiration_date` using the [Disable Campaign](/api-reference/disable-campaign) endpoint.    - `true` indicates an *active* campaign - `false` indicates an *inactive* campaign
     attr_accessor :active
 
     # Unique category ID that this campaign belongs to.

data/lib/VoucherifySdk/models/promotions_tiers_enable_response_body_campaign.rb

@@ -32,7 +32,7 @@ module VoucherifySdk
 
     attr_accessor :validity_hours
 
-    # A flag indicating whether the campaign is active or not active. A campaign can be disabled even though it's within the active period defined by the `start_date` and `expiration_date` using the <!-- [Disable Campaign](OpenAPI.json/paths/~1campaigns~1{campaignId}~1disable) -->[Disable Campaign](ref:disable-campaign) endpoint.    - `true` indicates an *active* campaign - `false` indicates an *inactive* campaign
+    # A flag indicating whether the campaign is active or not active. A campaign can be disabled even though it's within the active period defined by the `start_date` and `expiration_date` using the [Disable Campaign](/api-reference/disable-campaign) endpoint.    - `true` indicates an *active* campaign - `false` indicates an *inactive* campaign
     attr_accessor :active
 
     # Unique category ID that this campaign belongs to.

data/lib/VoucherifySdk/models/promotions_tiers_get_response_body_campaign.rb

@@ -32,7 +32,7 @@ module VoucherifySdk
 
     attr_accessor :validity_hours
 
-    # A flag indicating whether the campaign is active or not active. A campaign can be disabled even though it's within the active period defined by the `start_date` and `expiration_date` using the <!-- [Disable Campaign](OpenAPI.json/paths/~1campaigns~1{campaignId}~1disable) -->[Disable Campaign](ref:disable-campaign) endpoint.    - `true` indicates an *active* campaign - `false` indicates an *inactive* campaign
+    # A flag indicating whether the campaign is active or not active. A campaign can be disabled even though it's within the active period defined by the `start_date` and `expiration_date` using the [Disable Campaign](/api-reference/disable-campaign) endpoint.    - `true` indicates an *active* campaign - `false` indicates an *inactive* campaign
     attr_accessor :active
 
     # Unique category ID that this campaign belongs to.

data/lib/VoucherifySdk/models/promotions_tiers_update_response_body_campaign.rb

@@ -32,7 +32,7 @@ module VoucherifySdk
 
     attr_accessor :validity_hours
 
-    # A flag indicating whether the campaign is active or not active. A campaign can be disabled even though it's within the active period defined by the `start_date` and `expiration_date` using the <!-- [Disable Campaign](OpenAPI.json/paths/~1campaigns~1{campaignId}~1disable) -->[Disable Campaign](ref:disable-campaign) endpoint.    - `true` indicates an *active* campaign - `false` indicates an *inactive* campaign
+    # A flag indicating whether the campaign is active or not active. A campaign can be disabled even though it's within the active period defined by the `start_date` and `expiration_date` using the [Disable Campaign](/api-reference/disable-campaign) endpoint.    - `true` indicates an *active* campaign - `false` indicates an *inactive* campaign
     attr_accessor :active
 
     # Unique category ID that this campaign belongs to.

data/lib/VoucherifySdk/models/qualifications_check_eligibility_request_body.rb

@@ -28,7 +28,9 @@ module VoucherifySdk
 
     attr_accessor :options
 
-    # A set of key/value pairs that you can send in the request body to check against redeemables requiring **redemption** metadata validation rules to be satisfied. The validation runs against rules that are defined through the <!-- [Create Validation Rules](https://docs.voucherify.io/reference/create-validation-rules) -->[Create Validation Rules](ref:create-validation-rules) endpoint or via the Dashboard; in the _Advanced Rule Builder_ &rarr; _Advanced_ &rarr; _Redemption metadata satisfy_ or _Basic Builder_ &rarr; _Attributes match_ &rarr; _REDEMPTION METADATA_. [Read more](https://support.voucherify.io/article/148-how-to-build-a-rule).
+    attr_accessor :session
+
+    # A set of key/value pairs that you can send in the request body to check against redeemables requiring **redemption** metadata validation rules to be satisfied. The validation runs against rules that are defined through the [Create Validation Rules](/api-reference/validation-rules/create-validation-rules) endpoint or with the [Validation Rule Builder](/personalize/create-validation-rules) in the the Dashboard.
     attr_accessor :metadata
 
     class EnumAttributeValidator
@@ -61,6 +63,7 @@ module VoucherifySdk
         :'tracking_id' => :'tracking_id',
         :'scenario' => :'scenario',
         :'options' => :'options',
+        :'session' => :'session',
         :'metadata' => :'metadata'
       }
     end
@@ -78,6 +81,7 @@ module VoucherifySdk
         :'tracking_id' => :'String',
         :'scenario' => :'String',
         :'options' => :'QualificationsOption',
+        :'session' => :'QualificationsCheckEligibilityRequestBodySession',
         :'metadata' => :'Object'
       }
     end
@@ -87,6 +91,7 @@ module VoucherifySdk
       Set.new([
         :'tracking_id',
         :'scenario',
+        :'session',
         :'metadata'
       ])
     end
@@ -119,6 +124,10 @@ module VoucherifySdk
         self.options = attributes[:'options']
       end
 
+      if attributes.key?(:'session')
+        self.session = attributes[:'session']
+      end
+
       if attributes.key?(:'metadata')
         self.metadata = attributes[:'metadata']
       end
@@ -151,6 +160,7 @@ module VoucherifySdk
           tracking_id == o.tracking_id &&
           scenario == o.scenario &&
           options == o.options &&
+          session == o.session &&
           metadata == o.metadata
     end
 
@@ -163,7 +173,7 @@ module VoucherifySdk
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [customer, order, tracking_id, scenario, options, metadata].hash
+      [customer, order, tracking_id, scenario, options, session, metadata].hash
     end
 
     # Builds the object from hash