class VoucherifySdk::OrdersCreateResponseBody

Response body schema for POST ‘v1/orders`.

Attributes

amount[RW]

A positive integer in the smallest currency unit (e.g. 100 cents for $1.00) representing the total amount of the order. This is the sum of the order items’ amounts.

applied_discount_amount[RW]

This field shows the order-level discount applied.

created_at[RW]

Timestamp representing the date and time when the order was created. The value is shown in the ISO 8601 format.

customer[RW]
customer_id[RW]

Unique customer ID of the customer making the purchase.

discount_amount[RW]

Sum of all order-level discounts applied to the order.

id[RW]

Unique ID assigned by Voucherify of an existing order that will be linked to the redemption of this request.

initial_amount[RW]

A positive integer in the smallest currency unit (e.g. 100 cents for $1.00) representing the total amount of the order. This is the sum of the order items’ amounts.

items[RW]

Array of items applied to the order. It can include up 500 items.

items_applied_discount_amount[RW]

Sum of all product-specific discounts applied in a particular request. ‘sum(items, i => i.applied_discount_amount)`

items_discount_amount[RW]

Sum of all product-specific discounts applied to the order.

metadata[RW]

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.

object[RW]

The type of the object represented by JSON.

redemptions[RW]
referrer[RW]
referrer_id[RW]

Unique referrer ID.

source_id[RW]

Unique source ID of an existing order that will be linked to the redemption of this request.

status[RW]

The order status.

total_amount[RW]

Order amount after undoing all the discounts through the rollback redemption.

total_applied_discount_amount[RW]

Sum of all order-level AND all product-specific discounts applied in a particular request. ‘total_applied_discount_amount` = `applied_discount_amount` + `items_applied_discount_amount`

total_discount_amount[RW]

Sum of all order-level AND all product-specific discounts applied to the order.

updated_at[RW]

Timestamp representing the date and time when the order was last updated in ISO 8601 format.

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/orders_create_response_body.rb, line 381
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/orders_create_response_body.rb, line 133
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/orders_create_response_body.rb, line 105
def self.attribute_map
  {
    :'id' => :'id',
    :'source_id' => :'source_id',
    :'status' => :'status',
    :'amount' => :'amount',
    :'initial_amount' => :'initial_amount',
    :'discount_amount' => :'discount_amount',
    :'items_discount_amount' => :'items_discount_amount',
    :'total_discount_amount' => :'total_discount_amount',
    :'total_amount' => :'total_amount',
    :'applied_discount_amount' => :'applied_discount_amount',
    :'items_applied_discount_amount' => :'items_applied_discount_amount',
    :'total_applied_discount_amount' => :'total_applied_discount_amount',
    :'items' => :'items',
    :'metadata' => :'metadata',
    :'object' => :'object',
    :'created_at' => :'created_at',
    :'updated_at' => :'updated_at',
    :'customer_id' => :'customer_id',
    :'referrer_id' => :'referrer_id',
    :'customer' => :'customer',
    :'referrer' => :'referrer',
    :'redemptions' => :'redemptions'
  }
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/orders_create_response_body.rb, line 357
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/orders_create_response_body.rb, line 193
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?(:'id')
    self.id = attributes[:'id']
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

  if attributes.key?(:'object')
    self.object = attributes[:'object']
  else
    self.object = 'order'
  end

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

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

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

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

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

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

  if attributes.key?(:'redemptions')
    if (value = attributes[:'redemptions']).is_a?(Hash)
      self.redemptions = value
    end
  end
end
openapi_nullable() click to toggle source

List of attributes with nullable: true

# File lib/VoucherifySdk/models/orders_create_response_body.rb, line 166
def self.openapi_nullable
  Set.new([
    :'id',
    :'source_id',
    :'status',
    :'amount',
    :'initial_amount',
    :'discount_amount',
    :'items_discount_amount',
    :'total_discount_amount',
    :'total_amount',
    :'applied_discount_amount',
    :'items_applied_discount_amount',
    :'total_applied_discount_amount',
    :'items',
    :'metadata',
    :'object',
    :'created_at',
    :'updated_at',
    :'customer_id',
    :'referrer_id',
    :'redemptions'
  ])
end
openapi_types() click to toggle source

Attribute type mapping.

# File lib/VoucherifySdk/models/orders_create_response_body.rb, line 138
def self.openapi_types
  {
    :'id' => :'String',
    :'source_id' => :'String',
    :'status' => :'String',
    :'amount' => :'Integer',
    :'initial_amount' => :'Integer',
    :'discount_amount' => :'Integer',
    :'items_discount_amount' => :'Integer',
    :'total_discount_amount' => :'Integer',
    :'total_amount' => :'Integer',
    :'applied_discount_amount' => :'Integer',
    :'items_applied_discount_amount' => :'Integer',
    :'total_applied_discount_amount' => :'Integer',
    :'items' => :'Array<OrderCalculatedItem>',
    :'metadata' => :'Object',
    :'object' => :'String',
    :'created_at' => :'Time',
    :'updated_at' => :'Time',
    :'customer_id' => :'String',
    :'referrer_id' => :'String',
    :'customer' => :'CustomerId',
    :'referrer' => :'ReferrerId',
    :'redemptions' => :'Hash<String, OrderRedemptionsEntry>'
  }
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/orders_create_response_body.rb, line 315
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      source_id == o.source_id &&
      status == o.status &&
      amount == o.amount &&
      initial_amount == o.initial_amount &&
      discount_amount == o.discount_amount &&
      items_discount_amount == o.items_discount_amount &&
      total_discount_amount == o.total_discount_amount &&
      total_amount == o.total_amount &&
      applied_discount_amount == o.applied_discount_amount &&
      items_applied_discount_amount == o.items_applied_discount_amount &&
      total_applied_discount_amount == o.total_applied_discount_amount &&
      items == o.items &&
      metadata == o.metadata &&
      object == o.object &&
      created_at == o.created_at &&
      updated_at == o.updated_at &&
      customer_id == o.customer_id &&
      referrer_id == o.referrer_id &&
      customer == o.customer &&
      referrer == o.referrer &&
      redemptions == o.redemptions
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/orders_create_response_body.rb, line 452
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/orders_create_response_body.rb, line 344
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/orders_create_response_body.rb, line 350
def hash
  [id, source_id, status, amount, initial_amount, discount_amount, items_discount_amount, total_discount_amount, total_amount, applied_discount_amount, items_applied_discount_amount, total_applied_discount_amount, items, metadata, object, created_at, updated_at, customer_id, referrer_id, customer, referrer, redemptions].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/orders_create_response_body.rb, line 296
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/orders_create_response_body.rb, line 428
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/orders_create_response_body.rb, line 434
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/orders_create_response_body.rb, line 422
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/orders_create_response_body.rb, line 304
def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  status_validator = EnumAttributeValidator.new('String', ["CREATED", "PAID", "CANCELED", "FULFILLED"])
  return false unless status_validator.valid?(@status)
  object_validator = EnumAttributeValidator.new('String', ["order"])
  return false unless object_validator.valid?(@object)
  true
end