class VoucherifySdk::ManagementProjectsMetadataSchemaDefinition

Custom definition name. This is also shown in **Project Settings** > **Metadata Schema** in the Voucherify Dashboard.

Attributes

array[RW]

Indicates if the definition is an array.

deleted[RW]

Indicates if the definition has been deleted from the schema.

eq[RW]
exact_length[RW]

Value indicating the exact length. Available only for the ‘string` type.

gt[RW]

A property of ‘number` type must be `greater than` this value. The value should be up to two decimal places.

gte[RW]

A property of ‘number` type must be `greater than or equal` to this value. The value should be up to two decimal places.

lt[RW]

A property of the ‘number` type must have `less than` this value. The value should be up to two decimal places.

lte[RW]

A property of the ‘number` type must be `less than or equal` to this value. The value should be up to two decimal places.

max_length[RW]

Value indicating the maximum length. Available only for the ‘string` type.

min_length[RW]

Value indicating the minimum length. Available only for the ‘string` type.

ne[RW]

Array of values that are not allowed. Available only for the ‘number` type.

object_type[RW]

The name of the custom resource (i.e. a nested object) if the resource has been previously defined. Otherwise, it is ‘null` for other types.

optional[RW]

Indicates if this definition is optional or not for the resource.

type[RW]

Indicates the type of metadata. Note that ‘"geopoint"` type is a paid feature.

Public Class Methods

_deserialize(type, value) click to toggle source

Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data

# File lib/VoucherifySdk/models/management_projects_metadata_schema_definition.rb, line 293
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
acceptable_attributes() click to toggle source

Returns all the JSON keys this model knows about

# File lib/VoucherifySdk/models/management_projects_metadata_schema_definition.rb, line 103
def self.acceptable_attributes
  attribute_map.values
end
attribute_map() click to toggle source

Attribute mapping from ruby-style variable name to JSON key.

# File lib/VoucherifySdk/models/management_projects_metadata_schema_definition.rb, line 83
def self.attribute_map
  {
    :'type' => :'type',
    :'optional' => :'optional',
    :'array' => :'array',
    :'deleted' => :'deleted',
    :'object_type' => :'object_type',
    :'min_length' => :'min_length',
    :'max_length' => :'max_length',
    :'exact_length' => :'exact_length',
    :'eq' => :'eq',
    :'ne' => :'ne',
    :'lt' => :'lt',
    :'lte' => :'lte',
    :'gt' => :'gt',
    :'gte' => :'gte'
  }
end
build_from_hash(attributes) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/VoucherifySdk/models/management_projects_metadata_schema_definition.rb, line 269
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
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# File lib/VoucherifySdk/models/management_projects_metadata_schema_definition.rb, line 149
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?(:'type')
    self.type = attributes[:'type']
  end

  if attributes.key?(:'optional')
    self.optional = attributes[:'optional']
  end

  if attributes.key?(:'array')
    self.array = attributes[:'array']
  end

  if attributes.key?(:'deleted')
    self.deleted = attributes[:'deleted']
  end

  if attributes.key?(:'object_type')
    self.object_type = attributes[:'object_type']
  end

  if attributes.key?(:'min_length')
    self.min_length = attributes[:'min_length']
  end

  if attributes.key?(:'max_length')
    self.max_length = attributes[:'max_length']
  end

  if attributes.key?(:'exact_length')
    self.exact_length = attributes[:'exact_length']
  end

  if attributes.key?(:'eq')
    if (value = attributes[:'eq']).is_a?(Array)
      self.eq = value
    end
  end

  if attributes.key?(:'ne')
    if (value = attributes[:'ne']).is_a?(Array)
      self.ne = value
    end
  end

  if attributes.key?(:'lt')
    self.lt = attributes[:'lt']
  end

  if attributes.key?(:'lte')
    self.lte = attributes[:'lte']
  end

  if attributes.key?(:'gt')
    self.gt = attributes[:'gt']
  end

  if attributes.key?(:'gte')
    self.gte = attributes[:'gte']
  end
end
openapi_nullable() click to toggle source

List of attributes with nullable: true

# File lib/VoucherifySdk/models/management_projects_metadata_schema_definition.rb, line 128
def self.openapi_nullable
  Set.new([
    :'type',
    :'optional',
    :'array',
    :'deleted',
    :'object_type',
    :'min_length',
    :'max_length',
    :'exact_length',
    :'eq',
    :'ne',
    :'lt',
    :'lte',
    :'gt',
    :'gte'
  ])
end
openapi_types() click to toggle source

Attribute type mapping.

# File lib/VoucherifySdk/models/management_projects_metadata_schema_definition.rb, line 108
def self.openapi_types
  {
    :'type' => :'String',
    :'optional' => :'Boolean',
    :'array' => :'Boolean',
    :'deleted' => :'Boolean',
    :'object_type' => :'String',
    :'min_length' => :'Integer',
    :'max_length' => :'Integer',
    :'exact_length' => :'Integer',
    :'eq' => :'Array<Object>',
    :'ne' => :'Array<Float>',
    :'lt' => :'Float',
    :'lte' => :'Float',
    :'gt' => :'Float',
    :'gte' => :'Float'
  }
end

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# File lib/VoucherifySdk/models/management_projects_metadata_schema_definition.rb, line 235
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      type == o.type &&
      optional == o.optional &&
      array == o.array &&
      deleted == o.deleted &&
      object_type == o.object_type &&
      min_length == o.min_length &&
      max_length == o.max_length &&
      exact_length == o.exact_length &&
      eq == o.eq &&
      ne == o.ne &&
      lt == o.lt &&
      lte == o.lte &&
      gt == o.gt &&
      gte == o.gte
end
_to_hash(value) click to toggle source

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/VoucherifySdk/models/management_projects_metadata_schema_definition.rb, line 364
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
eql?(o) click to toggle source

@see the ‘==` method @param [Object] Object to be compared

# File lib/VoucherifySdk/models/management_projects_metadata_schema_definition.rb, line 256
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Integer] Hash code

# File lib/VoucherifySdk/models/management_projects_metadata_schema_definition.rb, line 262
def hash
  [type, optional, array, deleted, object_type, min_length, max_length, exact_length, eq, ne, lt, lte, gt, gte].hash
end
list_invalid_properties() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

# File lib/VoucherifySdk/models/management_projects_metadata_schema_definition.rb, line 218
def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  invalid_properties
end
to_body() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/VoucherifySdk/models/management_projects_metadata_schema_definition.rb, line 340
def to_body
  to_hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/VoucherifySdk/models/management_projects_metadata_schema_definition.rb, line 346
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
to_s() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/VoucherifySdk/models/management_projects_metadata_schema_definition.rb, line 334
def to_s
  to_hash.to_s
end
valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

# File lib/VoucherifySdk/models/management_projects_metadata_schema_definition.rb, line 226
def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  type_validator = EnumAttributeValidator.new('String', ["string", "number", "object", "date", "datetime", "geopoint", "boolean", "image_url"])
  return false unless type_validator.valid?(@type)
  true
end