Class: VoucherifySdk::ReferralsMembersHoldersListResponseBody

Inherits:
Object
  • Object
show all
Defined in:
lib/VoucherifySdk/models/referrals_members_holders_list_response_body.rb

Overview

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ReferralsMembersHoldersListResponseBody

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
 
# 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

Instance Attribute Details

#data ⇒ Object

A dictionary that contains an array of holders.



26
27
28
 
# File 'lib/VoucherifySdk/models/referrals_members_holders_list_response_body.rb', line 26

def data
  @data
end

#data_ref ⇒ Object

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



23
24
25
 
# File 'lib/VoucherifySdk/models/referrals_members_holders_list_response_body.rb', line 23

def data_ref
  @data_ref
end

#has_more ⇒ Object

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.



32
33
34
 
# File 'lib/VoucherifySdk/models/referrals_members_holders_list_response_body.rb', line 32

def has_more
  @has_more
end

#more_starting_after ⇒ Object

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.



35
36
37
 
# File 'lib/VoucherifySdk/models/referrals_members_holders_list_response_body.rb', line 35

def more_starting_after
  @more_starting_after
end

#object ⇒ Object

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



20
21
22
 
# File 'lib/VoucherifySdk/models/referrals_members_holders_list_response_body.rb', line 20

def object
  @object
end

#total ⇒ Object

Total number of holders assigned to the redeemable.



29
30
31
 
# File 'lib/VoucherifySdk/models/referrals_members_holders_list_response_body.rb', line 29

def total
  @total
end

Class Method Details

._deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
 
# 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 ⇒ Object

Returns all the JSON keys this model knows about



50
51
52
 
# File 'lib/VoucherifySdk/models/referrals_members_holders_list_response_body.rb', line 50

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



38
39
40
41
42
43
44
45
46
47
 
# 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) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
 
# 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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



67
68
69
70
71
72
73
74
75
76
 
# 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 ⇒ Object

Attribute type mapping.



55
56
57
58
59
60
61
62
63
64
 
# 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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



134
135
136
137
138
139
140
141
142
143
 
# 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) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



255
256
257
258
259
260
261
262
263
264
265
266
267
 
# 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) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


147
148
149
 
# File 'lib/VoucherifySdk/models/referrals_members_holders_list_response_body.rb', line 147

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



153
154
155
 
# 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 ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



119
120
121
122
123
 
# 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 ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



231
232
233
 
# File 'lib/VoucherifySdk/models/referrals_members_holders_list_response_body.rb', line 231

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



237
238
239
240
241
242
243
244
245
246
247
248
249
 
# 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 ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



225
226
227
 
# File 'lib/VoucherifySdk/models/referrals_members_holders_list_response_body.rb', line 225

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



127
128
129
130
 
# File 'lib/VoucherifySdk/models/referrals_members_holders_list_response_body.rb', line 127

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  true
end