Class: Phyllo::CommercePayout1

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CommercePayout1

Initializes the object

Parameters:

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

    Model attributes in the form of hash



136
137
138
139
140
141
142
143
144
145
146
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
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
 
# File 'lib/phyllo/models/commerce_payout1.rb', line 136

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

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

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

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

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

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

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

  self.payout_at = if attributes.key?(:payout_at)
    attributes[:payout_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_payout1.rb', line 27

def 
  @account
end

#amount ⇒ Object

Amount for the given payout



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

def amount
  @amount
end

#bank_details ⇒ Object

Returns the value of attribute bank_details.



43
44
45
 
# File 'lib/phyllo/models/commerce_payout1.rb', line 43

def bank_details
  @bank_details
end

#created_at ⇒ Object

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



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

def created_at
  @created_at
end

#currency ⇒ Object

3 letter currency code as per ISO 4217



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

def currency
  @currency
end

#external_id ⇒ Object

Payout ID given by the source platform



46
47
48
 
# File 'lib/phyllo/models/commerce_payout1.rb', line 46

def external_id
  @external_id
end

#id ⇒ Object

Unique ID of the payout.



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

def id
  @id
end

#payout_at ⇒ Object

Date or timestamp of payout



49
50
51
 
# File 'lib/phyllo/models/commerce_payout1.rb', line 49

def payout_at
  @payout_at
end

#payout_interval ⇒ Object

Regular interval at which the source platform processes payouts



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

def payout_interval
  @payout_interval
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.



52
53
54
 
# File 'lib/phyllo/models/commerce_payout1.rb', line 52

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.



55
56
57
 
# File 'lib/phyllo/models/commerce_payout1.rb', line 55

def platform_profile_name
  @platform_profile_name
end

#status ⇒ Object

Status of the payout on the source platform



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

def status
  @status
end

#updated_at ⇒ Object

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



23
24
25
 
# File 'lib/phyllo/models/commerce_payout1.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_payout1.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_payout1.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



365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
 
# File 'lib/phyllo/models/commerce_payout1.rb', line 365

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



101
102
103
 
# File 'lib/phyllo/models/commerce_payout1.rb', line 101

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/phyllo/models/commerce_payout1.rb', line 80

def self.attribute_map
  {
    id: :id,
    created_at: :created_at,
    updated_at: :updated_at,
    user: :user,
    account: :account,
    work_platform: :work_platform,
    amount: :amount,
    currency: :currency,
    status: :status,
    payout_interval: :payout_interval,
    bank_details: :bank_details,
    external_id: :external_id,
    payout_at: :payout_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



341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
 
# File 'lib/phyllo/models/commerce_payout1.rb', line 341

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



127
128
129
130
131
132
 
# File 'lib/phyllo/models/commerce_payout1.rb', line 127

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

.openapi_types ⇒ Object

Attribute type mapping.



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
 
# File 'lib/phyllo/models/commerce_payout1.rb', line 106

def self.openapi_types
  {
    id: :String,
    created_at: :Time,
    updated_at: :Time,
    user: :UserAttribute1,
    account: :AccountAttribute1,
    work_platform: :WorkPlatformAttribute1,
    amount: :Float,
    currency: :String,
    status: :String,
    payout_interval: :String,
    bank_details: :CommercePayout1BankDetails,
    external_id: :String,
    payout_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



306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
 
# File 'lib/phyllo/models/commerce_payout1.rb', line 306

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 &&
    amount == other.amount &&
    currency == other.currency &&
    status == other.status &&
    payout_interval == other.payout_interval &&
    bank_details == other.bank_details &&
    external_id == other.external_id &&
    payout_at == other.payout_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



436
437
438
439
440
441
442
443
444
445
446
447
448
 
# File 'lib/phyllo/models/commerce_payout1.rb', line 436

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


328
329
330
 
# File 'lib/phyllo/models/commerce_payout1.rb', line 328

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



334
335
336
 
# File 'lib/phyllo/models/commerce_payout1.rb', line 334

def hash
  [id, created_at, updated_at, user, , work_platform, amount, currency, status, payout_interval, bank_details, external_id, payout_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



212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
 
# File 'lib/phyllo/models/commerce_payout1.rb', line 212

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 @amount.nil?
    invalid_properties.push('invalid value for "amount", amount cannot be nil.')
  end

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

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

  if @payout_at.nil?
    invalid_properties.push('invalid value for "payout_at", payout_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



412
413
414
 
# File 'lib/phyllo/models/commerce_payout1.rb', line 412

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



418
419
420
421
422
423
424
425
426
427
428
429
430
 
# File 'lib/phyllo/models/commerce_payout1.rb', line 418

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



406
407
408
 
# File 'lib/phyllo/models/commerce_payout1.rb', line 406

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



264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
 
# File 'lib/phyllo/models/commerce_payout1.rb', line 264

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 @amount.nil?
  return false if @currency.nil?
  return false if @status.nil?
  status_validator = EnumAttributeValidator.new("String", ["SCHEDULED", "PAID", "IN_TRANSIT", "CANCELLED"])
  return false unless status_validator.valid?(@status)
  payout_interval_validator = EnumAttributeValidator.new("String", ["AUTOMATIC_DAILY", "AUTOMATIC_WEEKLY", "AUTOMATIC_MONTHLY", "MANUAL"])
  return false unless payout_interval_validator.valid?(@payout_interval)
  return false if @payout_at.nil?
  return false if @platform_profile_id.nil?
  true
end