class VoucherifySdk::ReferralsMembersHoldersListResponseBody

Response body schema for GET ‘v1/referrals/{campaignId}/members/{memberId}/holders` and for GET `v1/referrals/members/{memberId}/holders`

Attributes

data[RW]

A dictionary that contains an array of holders.

data_ref[RW]

Identifies the name of the JSON property that contains the array of holders.

has_more[RW]

As query results are always limited (by the limit parameter), the ‘has_more` flag indicates if there are more records for given filter parameters. This lets you know if you can run another request with a `starting_after_id` query or a different limit to get more records returned in the results.

more_starting_after[RW]

Returns an ID that can be used to return another page of results. Use the ID in the ‘starting_after_id` query parameter to display another page of the results occuring after the field with that ID.

object[RW]

The type of the object represented by JSON. This object stores information about redeemables holders

total[RW]

Total number of holders assigned to the redeemable.

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/referrals_members_holders_list_response_body.rb, line 184
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/referrals_members_holders_list_response_body.rb, line 50
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/referrals_members_holders_list_response_body.rb, line 38
def self.attribute_map
  {
    :'object' => :'object',
    :'data_ref' => :'data_ref',
    :'data' => :'data',
    :'total' => :'total',
    :'has_more' => :'has_more',
    :'more_starting_after' => :'more_starting_after'
  }
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/referrals_members_holders_list_response_body.rb, line 160
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/referrals_members_holders_list_response_body.rb, line 80
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?(:'object')
    self.object = attributes[:'object']
  else
    self.object = 'list'
  end

  if attributes.key?(:'data_ref')
    self.data_ref = attributes[:'data_ref']
  else
    self.data_ref = 'data'
  end

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

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

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

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

List of attributes with nullable: true

# File lib/VoucherifySdk/models/referrals_members_holders_list_response_body.rb, line 67
def self.openapi_nullable
  Set.new([
    :'object',
    :'data_ref',
    :'data',
    :'total',
    :'has_more',
    :'more_starting_after'
  ])
end
openapi_types() click to toggle source

Attribute type mapping.

# File lib/VoucherifySdk/models/referrals_members_holders_list_response_body.rb, line 55
def self.openapi_types
  {
    :'object' => :'String',
    :'data_ref' => :'String',
    :'data' => :'Array<RedeemableHolder>',
    :'total' => :'Integer',
    :'has_more' => :'Boolean',
    :'more_starting_after' => :'String'
  }
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/referrals_members_holders_list_response_body.rb, line 134
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      object == o.object &&
      data_ref == o.data_ref &&
      data == o.data &&
      total == o.total &&
      has_more == o.has_more &&
      more_starting_after == o.more_starting_after
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/referrals_members_holders_list_response_body.rb, line 255
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/referrals_members_holders_list_response_body.rb, line 147
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/referrals_members_holders_list_response_body.rb, line 153
def hash
  [object, data_ref, data, total, has_more, more_starting_after].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/referrals_members_holders_list_response_body.rb, line 119
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/referrals_members_holders_list_response_body.rb, line 231
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/referrals_members_holders_list_response_body.rb, line 237
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/referrals_members_holders_list_response_body.rb, line 225
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/referrals_members_holders_list_response_body.rb, line 127
def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  true
end