class Yapstone::MarketplaceProductSubResource

Marketplace product definition in contract resource.

Attributes

asset_id[RW]

The unique id of the Asset Resource.

charges_status[RW]
consents[RW]

An array of consents.

payment_platform[RW]

The platform to initiate payments on.

payout_instruments[RW]

An array of payout instruments.

payout_mode[RW]

The type of Payout Mode

refund_status[RW]
settlement_currency[RW]

The ISO currency code enum for settlements.

status[RW]
subscription_type[RW]

Subscription Type

token_for_processing[RW]

The token to use when making payments.

Public Class Methods

attribute_map() click to toggle source

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

# File lib/yapstone-so/models/marketplace_product_sub_resource.rb, line 71
def self.attribute_map
  {
    :'consents' => :'consents',
    :'asset_id' => :'assetId',
    :'payout_mode' => :'payoutMode',
    :'settlement_currency' => :'settlementCurrency',
    :'subscription_type' => :'subscriptionType',
    :'status' => :'status',
    :'charges_status' => :'chargesStatus',
    :'refund_status' => :'refundStatus',
    :'token_for_processing' => :'tokenForProcessing',
    :'payment_platform' => :'paymentPlatform',
    :'payout_instruments' => :'payoutInstruments'
  }
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/yapstone-so/models/marketplace_product_sub_resource.rb, line 246
def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end
new(attributes = {}) click to toggle source

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

# File lib/yapstone-so/models/marketplace_product_sub_resource.rb, line 114
def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Yapstone::MarketplaceProductSubResource` 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 `Yapstone::MarketplaceProductSubResource`. 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?(:'consents')
    if (value = attributes[:'consents']).is_a?(Array)
      self.consents = value
    end
  end

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

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

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

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

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

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

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

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

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

  if attributes.key?(:'payout_instruments')
    if (value = attributes[:'payout_instruments']).is_a?(Array)
      self.payout_instruments = value
    end
  end
end
openapi_all_of() click to toggle source

List of class defined in allOf (OpenAPI v3)

# File lib/yapstone-so/models/marketplace_product_sub_resource.rb, line 105
def self.openapi_all_of
  [
  :'MarketplaceProductExtra',
  :'ProductRead'
  ]
end
openapi_types() click to toggle source

Attribute type mapping.

# File lib/yapstone-so/models/marketplace_product_sub_resource.rb, line 88
def self.openapi_types
  {
    :'consents' => :'Array<ConsentResource>',
    :'asset_id' => :'String',
    :'payout_mode' => :'String',
    :'settlement_currency' => :'String',
    :'subscription_type' => :'String',
    :'status' => :'StatusReasonResource',
    :'charges_status' => :'ActionStatusResource',
    :'refund_status' => :'ActionStatusResource',
    :'token_for_processing' => :'String',
    :'payment_platform' => :'String',
    :'payout_instruments' => :'Array<MarketplaceProductPayoutInstrumentResource>'
  }
end

Public Instance Methods

==(o) click to toggle source

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

# File lib/yapstone-so/models/marketplace_product_sub_resource.rb, line 215
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      consents == o.consents &&
      asset_id == o.asset_id &&
      payout_mode == o.payout_mode &&
      settlement_currency == o.settlement_currency &&
      subscription_type == o.subscription_type &&
      status == o.status &&
      charges_status == o.charges_status &&
      refund_status == o.refund_status &&
      token_for_processing == o.token_for_processing &&
      payment_platform == o.payment_platform &&
      payout_instruments == o.payout_instruments
end
_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/yapstone-so/models/marketplace_product_sub_resource.rb, line 274
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
    Yapstone.const_get(type).build_from_hash(value)
  end
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/yapstone-so/models/marketplace_product_sub_resource.rb, line 339
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
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/yapstone-so/models/marketplace_product_sub_resource.rb, line 253
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
eql?(o) click to toggle source

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

# File lib/yapstone-so/models/marketplace_product_sub_resource.rb, line 233
def eql?(o)
  self == o
end
hash() click to toggle source

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

# File lib/yapstone-so/models/marketplace_product_sub_resource.rb, line 239
def hash
  [consents, asset_id, payout_mode, settlement_currency, subscription_type, status, charges_status, refund_status, token_for_processing, payment_platform, payout_instruments].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/yapstone-so/models/marketplace_product_sub_resource.rb, line 178
def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end
payment_platform=(payment_platform) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] payment_platform Object to be assigned

# File lib/yapstone-so/models/marketplace_product_sub_resource.rb, line 205
def payment_platform=(payment_platform)
  validator = EnumAttributeValidator.new('String', ["DOMESTIC", "INTERNATIONAL"])
  unless validator.valid?(payment_platform)
    fail ArgumentError, "invalid value for \"payment_platform\", must be one of #{validator.allowable_values}."
  end
  @payment_platform = payment_platform
end
payout_mode=(payout_mode) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] payout_mode Object to be assigned

# File lib/yapstone-so/models/marketplace_product_sub_resource.rb, line 195
def payout_mode=(payout_mode)
  validator = EnumAttributeValidator.new('String', ["POST_CHECK_IN", "POST_BOOKING", "NONE", "STANDARD", "ADVANCED"])
  unless validator.valid?(payout_mode)
    fail ArgumentError, "invalid value for \"payout_mode\", must be one of #{validator.allowable_values}."
  end
  @payout_mode = payout_mode
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/yapstone-so/models/marketplace_product_sub_resource.rb, line 319
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/yapstone-so/models/marketplace_product_sub_resource.rb, line 325
def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    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/yapstone-so/models/marketplace_product_sub_resource.rb, line 313
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/yapstone-so/models/marketplace_product_sub_resource.rb, line 185
def valid?
  payout_mode_validator = EnumAttributeValidator.new('String', ["POST_CHECK_IN", "POST_BOOKING", "NONE", "STANDARD", "ADVANCED"])
  return false unless payout_mode_validator.valid?(@payout_mode)
  payment_platform_validator = EnumAttributeValidator.new('String', ["DOMESTIC", "INTERNATIONAL"])
  return false unless payment_platform_validator.valid?(@payment_platform)
  true
end