Class: Phyllo::CommerceBalance

Inherits:
Object
  • Object
show all
Defined in:
lib/phyllo/models/commerce_balance.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CommerceBalance

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
 
# File 'lib/phyllo/models/commerce_balance.rb', line 89

def initialize(attributes = {})
  if !attributes.is_a?(Hash)
    fail ArgumentError, "The input argument (attributes) must be a hash in `Phyllo::CommerceBalance` 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 `Phyllo::CommerceBalance`. 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
  }

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#account ⇒ Object

Returns the value of attribute account.



27
28
29
 
# File 'lib/phyllo/models/commerce_balance.rb', line 27

def 
  @account
end

#balance ⇒ Object

List of balances in different currencies on the given date



32
33
34
 
# File 'lib/phyllo/models/commerce_balance.rb', line 32

def balance
  @balance
end

#balance_at ⇒ Object

Date of balance



35
36
37
 
# File 'lib/phyllo/models/commerce_balance.rb', line 35

def balance_at
  @balance_at
end

#created_at ⇒ Object

Object creation time (UTC date and time in ISO 8601 format)



20
21
22
 
# File 'lib/phyllo/models/commerce_balance.rb', line 20

def created_at
  @created_at
end

#id ⇒ Object

Unique ID of the balance.



17
18
19
 
# File 'lib/phyllo/models/commerce_balance.rb', line 17

def id
  @id
end

#platform_profile_id ⇒ Object

Unique profile ID of the user on the work platform. Ex - For YouTube it’s the channel ID and for Instagram it’s the Instagram page ID.



38
39
40
 
# File 'lib/phyllo/models/commerce_balance.rb', line 38

def platform_profile_id
  @platform_profile_id
end

#platform_profile_name ⇒ Object

User’s profile name on the work platform. This is not unique, is displayed prominently on the profile, usually editable and is most commonly associated with that user’s identity on the platform. Ex - For YouTube, it’s the channel name displayed on the channel page and for Instagram / Twitter / TikTok etc, it’s the name displayed on the user’s profile page.



41
42
43
 
# File 'lib/phyllo/models/commerce_balance.rb', line 41

def platform_profile_name
  @platform_profile_name
end

#updated_at ⇒ Object

Object updation time (UTC date and time in ISO 8601 format)



23
24
25
 
# File 'lib/phyllo/models/commerce_balance.rb', line 23

def updated_at
  @updated_at
end

#user ⇒ Object

Returns the value of attribute user.



25
26
27
 
# File 'lib/phyllo/models/commerce_balance.rb', line 25

def user
  @user
end

#work_platform ⇒ Object

Returns the value of attribute work_platform.



29
30
31
 
# File 'lib/phyllo/models/commerce_balance.rb', line 29

def work_platform
  @work_platform
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



256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
 
# File 'lib/phyllo/models/commerce_balance.rb', line 256

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 = Phyllo.const_get(type)
    (klass.respond_to?(:openapi_any_of) || 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



60
61
62
 
# File 'lib/phyllo/models/commerce_balance.rb', line 60

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



44
45
46
47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/phyllo/models/commerce_balance.rb', line 44

def self.attribute_map
  {
    id: :id,
    created_at: :created_at,
    updated_at: :updated_at,
    user: :user,
    account: :account,
    work_platform: :work_platform,
    balance: :balance,
    balance_at: :balance_at,
    platform_profile_id: :platform_profile_id,
    platform_profile_name: :platform_profile_name
  }
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



232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
 
# File 'lib/phyllo/models/commerce_balance.rb', line 232

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.to_s] = 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.to_s] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash[key.to_s] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



81
82
83
84
85
 
# File 'lib/phyllo/models/commerce_balance.rb', line 81

def self.openapi_nullable
  Set.new([
    :platform_profile_name
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



65
66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/phyllo/models/commerce_balance.rb', line 65

def self.openapi_types
  {
    id: :String,
    created_at: :Time,
    updated_at: :Time,
    user: :UserAttribute1,
    account: :AccountAttribute1,
    work_platform: :WorkPlatformAttribute1,
    balance: :"Array<CommerceBalanceAmount1>",
    balance_at: :Time,
    platform_profile_id: :String,
    platform_profile_name: :String
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



202
203
204
205
206
207
208
209
210
211
212
213
214
215
 
# File 'lib/phyllo/models/commerce_balance.rb', line 202

def ==(other)
  return true if equal?(other)
  self.class == other.class &&
    id == other.id &&
    created_at == other.created_at &&
    updated_at == other.updated_at &&
    user == other.user &&
     == other. &&
    work_platform == other.work_platform &&
    balance == other.balance &&
    balance_at == other.balance_at &&
    platform_profile_id == other.platform_profile_id &&
    platform_profile_name == other.platform_profile_name
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



327
328
329
330
331
332
333
334
335
336
337
338
339
 
# File 'lib/phyllo/models/commerce_balance.rb', line 327

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?(other) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


219
220
221
 
# File 'lib/phyllo/models/commerce_balance.rb', line 219

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



225
226
227
 
# File 'lib/phyllo/models/commerce_balance.rb', line 225

def hash
  [id, created_at, updated_at, user, , work_platform, balance, balance_at, platform_profile_id, platform_profile_name].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



147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
 
# File 'lib/phyllo/models/commerce_balance.rb', line 147

def list_invalid_properties
  warn "[DEPRECATED] the `list_invalid_properties` method is obsolete"
  invalid_properties = []
  if @id.nil?
    invalid_properties.push('invalid value for "id", id cannot be nil.')
  end

  if @created_at.nil?
    invalid_properties.push('invalid value for "created_at", created_at cannot be nil.')
  end

  if @updated_at.nil?
    invalid_properties.push('invalid value for "updated_at", updated_at cannot be nil.')
  end

  if @user.nil?
    invalid_properties.push('invalid value for "user", user cannot be nil.')
  end

  if @account.nil?
    invalid_properties.push('invalid value for "account", account cannot be nil.')
  end

  if @work_platform.nil?
    invalid_properties.push('invalid value for "work_platform", work_platform cannot be nil.')
  end

  if @balance_at.nil?
    invalid_properties.push('invalid value for "balance_at", balance_at cannot be nil.')
  end

  if @platform_profile_id.nil?
    invalid_properties.push('invalid value for "platform_profile_id", platform_profile_id cannot be nil.')
  end

  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



303
304
305
 
# File 'lib/phyllo/models/commerce_balance.rb', line 303

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



309
310
311
312
313
314
315
316
317
318
319
320
321
 
# File 'lib/phyllo/models/commerce_balance.rb', line 309

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = 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



297
298
299
 
# File 'lib/phyllo/models/commerce_balance.rb', line 297

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



187
188
189
190
191
192
193
194
195
196
197
198
 
# File 'lib/phyllo/models/commerce_balance.rb', line 187

def valid?
  warn "[DEPRECATED] the `valid?` method is obsolete"
  return false if @id.nil?
  return false if @created_at.nil?
  return false if @updated_at.nil?
  return false if @user.nil?
  return false if @account.nil?
  return false if @work_platform.nil?
  return false if @balance_at.nil?
  return false if @platform_profile_id.nil?
  true
end