Class: Cryptopay::CustomerParams

Inherits:
Object
  • Object
show all
Defined in:
lib/cryptopay/models/customer_params.rb

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CustomerParams

Initializes the object

Parameters:

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

    Model attributes in the form of hash



34
35
36
# File 'lib/cryptopay/models/customer_params.rb', line 34

def initialize(attributes = {})
  @attributes = ENCODER.sanitize(attributes)
end

Class Method Details

.build_from_hash(data) ⇒ Cryptopay::CustomerParams

Builds the object from hash

Parameters:

  • attributes (Hash)

    Model attributes in the form of hash

Returns:



27
28
29
30
# File 'lib/cryptopay/models/customer_params.rb', line 27

def self.build_from_hash(data)
  attributes = ENCODER.build_from_hash(data)
  new(attributes)
end

Instance Method Details

#addressesObject

This array allows you to specify 1 cryptocurrency address for each type of supported cryptocurrencies i.e. BTC, ETH, XRP, LTC and BCH. In case Cryptopay detects a High-Risk transaction, such transaction will not be processed. Instead, it will be sent to the address specified for respective cryptocurrency. If you do not specify any addresses here, High-Risk payments will be put on hold



49
50
51
# File 'lib/cryptopay/models/customer_params.rb', line 49

def addresses
  @attributes[:addresses]
end

#currencyObject

The customer’s currency in your system



44
45
46
# File 'lib/cryptopay/models/customer_params.rb', line 44

def currency
  @attributes[:currency]
end

#idObject

The customer’s reference ID in your system



39
40
41
# File 'lib/cryptopay/models/customer_params.rb', line 39

def id
  @attributes[:id]
end

#inspectObject



83
84
85
# File 'lib/cryptopay/models/customer_params.rb', line 83

def inspect
  "#<#{self.class}:0x#{object_id.to_s(16)}> JSON: " + JSON.pretty_generate(to_hash)
end

#invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
# File 'lib/cryptopay/models/customer_params.rb', line 55

def invalid_properties
  properties = []

  properties.push('invalid value for "id", id cannot be nil.') if id.nil?

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

  addresses&.each_with_index do |item, index|
    item.invalid_properties.each do |prop|
      properties.push("invalid value for \"addresses.#{index}\": #{prop}")
    end
  end

  properties
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



79
80
81
# File 'lib/cryptopay/models/customer_params.rb', line 79

def to_hash
  ENCODER.to_hash(@attributes)
end

#valid?Boolean

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

Returns:

  • (Boolean)

    true if the model is valid



73
74
75
# File 'lib/cryptopay/models/customer_params.rb', line 73

def valid?
  invalid_properties.empty?
end