cryptopay-ruby 0.1.0 → 1.0.0

data/lib/cryptopay/models/coin_destination_tag.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+# Auto-generated file
+# DO NOT EDIT
+
+module Cryptopay
+  class CoinDestinationTag
+    ENCODER = Encoder.new(
+      name: 'Cryptopay::CoinDestinationTag',
+      attribute_map: {
+        'required': :required,
+        'name': :name
+      },
+      types: {
+        'required': :Boolean,
+        'name': :String
+      },
+      nullables: []
+    )
+    private_constant :ENCODER
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      @attributes = ENCODER.sanitize(attributes)
+    end
+
+    def required
+      @attributes[:required]
+    end
+
+    def name
+      @attributes[:name]
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def invalid_properties
+      properties = []
+
+      properties.push('invalid value for "required", required cannot be nil.') if required.nil?
+
+      properties.push('invalid value for "name", name cannot be nil.') if name.nil?
+
+      properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      invalid_properties.empty?
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Cryptopay::CoinDestinationTag] Returns the model itself
+    def self.build_from_hash(data)
+      attributes = ENCODER.build_from_hash(data)
+      new(attributes)
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      ENCODER.to_hash(@attributes)
+    end
+
+    def inspect
+      "#<#{self.class}:0x#{object_id.to_s(16)}> JSON: " + JSON.pretty_generate(to_hash)
+    end
+  end
+end

data/lib/cryptopay/models/coin_list_result.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+# Auto-generated file
+# DO NOT EDIT
+
+module Cryptopay
+  class CoinListResult
+    ENCODER = Encoder.new(
+      name: 'Cryptopay::CoinListResult',
+      attribute_map: {
+        'data': :data
+      },
+      types: {
+        'data': :'Array<Coin>'
+      },
+      nullables: []
+    )
+    private_constant :ENCODER
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      @attributes = ENCODER.sanitize(attributes)
+    end
+
+    def data
+      @attributes[:data]
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def invalid_properties
+      properties = []
+
+      properties.push('invalid value for "data", data cannot be nil.') if data.nil?
+
+      data&.each_with_index do |item, index|
+        item.invalid_properties.each do |prop|
+          properties.push("invalid value for \"data.#{index}\": #{prop}")
+        end
+      end
+
+      properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      invalid_properties.empty?
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Cryptopay::CoinListResult] Returns the model itself
+    def self.build_from_hash(data)
+      attributes = ENCODER.build_from_hash(data)
+      new(attributes)
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      ENCODER.to_hash(@attributes)
+    end
+
+    def inspect
+      "#<#{self.class}:0x#{object_id.to_s(16)}> JSON: " + JSON.pretty_generate(to_hash)
+    end
+  end
+end

data/lib/cryptopay/models/coin_network.rb

@@ -0,0 +1,128 @@
+# frozen_string_literal: true
+
+# Auto-generated file
+# DO NOT EDIT
+
+module Cryptopay
+  class CoinNetwork
+    ENCODER = Encoder.new(
+      name: 'Cryptopay::CoinNetwork',
+      attribute_map: {
+        'network': :network,
+        'name': :name,
+        'precision': :precision,
+        'destination_tag': :destination_tag,
+        'invoices': :invoices,
+        'channels': :channels,
+        'coin_withdrawals': :coin_withdrawals
+      },
+      types: {
+        'network': :String,
+        'name': :String,
+        'precision': :Integer,
+        'destination_tag': :CoinDestinationTag,
+        'invoices': :InvoicesConfig,
+        'channels': :ChannelsConfig,
+        'coin_withdrawals': :CoinWithdrawalsConfig
+      },
+      nullables: [
+        :destination_tag
+      ]
+    )
+    private_constant :ENCODER
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      @attributes = ENCODER.sanitize(attributes)
+    end
+
+    def network
+      @attributes[:network]
+    end
+
+    def name
+      @attributes[:name]
+    end
+
+    def precision
+      @attributes[:precision]
+    end
+
+    def destination_tag
+      @attributes[:destination_tag]
+    end
+
+    def invoices
+      @attributes[:invoices]
+    end
+
+    def channels
+      @attributes[:channels]
+    end
+
+    def coin_withdrawals
+      @attributes[:coin_withdrawals]
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def invalid_properties
+      properties = []
+
+      properties.push('invalid value for "network", network cannot be nil.') if network.nil?
+
+      properties.push('invalid value for "name", name cannot be nil.') if name.nil?
+
+      properties.push('invalid value for "precision", precision cannot be nil.') if precision.nil?
+
+      destination_tag&.invalid_properties&.each do |prop|
+        properties.push("invalid value for \"destination_tag\": #{prop}")
+      end
+
+      properties.push('invalid value for "invoices", invoices cannot be nil.') if invoices.nil?
+
+      invoices&.invalid_properties&.each do |prop|
+        properties.push("invalid value for \"invoices\": #{prop}")
+      end
+
+      properties.push('invalid value for "channels", channels cannot be nil.') if channels.nil?
+
+      channels&.invalid_properties&.each do |prop|
+        properties.push("invalid value for \"channels\": #{prop}")
+      end
+
+      properties.push('invalid value for "coin_withdrawals", coin_withdrawals cannot be nil.') if coin_withdrawals.nil?
+
+      coin_withdrawals&.invalid_properties&.each do |prop|
+        properties.push("invalid value for \"coin_withdrawals\": #{prop}")
+      end
+
+      properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      invalid_properties.empty?
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Cryptopay::CoinNetwork] Returns the model itself
+    def self.build_from_hash(data)
+      attributes = ENCODER.build_from_hash(data)
+      new(attributes)
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      ENCODER.to_hash(@attributes)
+    end
+
+    def inspect
+      "#<#{self.class}:0x#{object_id.to_s(16)}> JSON: " + JSON.pretty_generate(to_hash)
+    end
+  end
+end

data/lib/cryptopay/models/coin_withdrawal.rb

@@ -12,6 +12,7 @@ module Cryptopay
         'custom_id': :custom_id,
         'customer_id': :customer_id,
         'address': :address,
+        'network': :network,
         'txid': :txid,
         'status': :status,
         'charged_amount': :charged_amount,
@@ -31,6 +32,7 @@ module Cryptopay
         'custom_id': :String,
         'customer_id': :String,
         'address': :String,
+        'network': :String,
         'txid': :String,
         'status': :CoinWithdrawalStatus,
         'charged_amount': :Decimal,
@@ -60,22 +62,32 @@ module Cryptopay
       @attributes = ENCODER.sanitize(attributes)
     end
 
+    # Coin withdrawal ID
     def id
       @attributes[:id]
     end
 
+    # Payment reference ID in your system
     def custom_id
       @attributes[:custom_id]
     end
 
+    # The reference ID of your customer
     def customer_id
       @attributes[:customer_id]
     end
 
+    # Recipient's cryptocurrency wallet address
     def address
       @attributes[:address]
     end
 
+    # Cryptocurrency network
+    def network
+      @attributes[:network]
+    end
+
+    # Cryptocurrency transaction ID on the blockchain
     def txid
       @attributes[:txid]
     end
@@ -84,22 +96,27 @@ module Cryptopay
       @attributes[:status]
     end
 
+    # Payment amount. Amount charged from your account
     def charged_amount
       @attributes[:charged_amount]
     end
 
+    # Account currency the payment has been sent from
     def charged_currency
       @attributes[:charged_currency]
     end
 
+    # Cryptocurrency transaction amount. Exact amount received by a recipient
     def received_amount
       @attributes[:received_amount]
     end
 
+    # Cryptocurrency type
     def received_currency
       @attributes[:received_currency]
     end
 
+    # Network fee amount
     def network_fee
       @attributes[:network_fee]
     end
@@ -124,6 +141,7 @@ module Cryptopay
       @attributes[:risk]
     end
 
+    # Coin withdrawal creation date and time
     def created_at
       @attributes[:created_at]
     end
@@ -135,6 +153,8 @@ module Cryptopay
 
       properties.push('invalid value for "address", address cannot be nil.') if address.nil?
 
+      properties.push('invalid value for "network", network cannot be nil.') if network.nil?
+
       properties.push('invalid value for "status", status cannot be nil.') if status.nil?
 
       if !status.nil? && !%w[new pending on_hold processing sent completed failed cancelled].include?(status)

data/lib/cryptopay/models/coin_withdrawal_callback.rb

@@ -46,10 +46,6 @@ module Cryptopay
 
       properties.push('invalid value for "type", type cannot be nil.') if type.nil?
 
-      if !type.nil? && !['CoinWithdrawal'].include?(type)
-        properties.push('invalid value for type, must be one of "CoinWithdrawal"')
-      end
-
       properties.push('invalid value for "event", event cannot be nil.') if event.nil?
 
       if !event.nil? && !%w[created status_changed].include?(event)

data/lib/cryptopay/models/coin_withdrawal_params.rb

@@ -11,6 +11,7 @@ module Cryptopay
         'address': :address,
         'charged_currency': :charged_currency,
         'received_currency': :received_currency,
+        'network': :network,
         'charged_amount': :charged_amount,
         'charged_amount_to_send': :charged_amount_to_send,
         'received_amount': :received_amount,
@@ -23,6 +24,7 @@ module Cryptopay
         'address': :String,
         'charged_currency': :String,
         'received_currency': :String,
+        'network': :String,
         'charged_amount': :Decimal,
         'charged_amount_to_send': :Decimal,
         'received_amount': :Decimal,
@@ -45,26 +47,37 @@ module Cryptopay
       @attributes = ENCODER.sanitize(attributes)
     end
 
+    # A recipient's cryptocurrency wallet address
     def address
       @attributes[:address]
     end
 
+    # An account currency to send a transaction from
     def charged_currency
       @attributes[:charged_currency]
     end
 
+    # Cryptocurrency type
     def received_currency
       @attributes[:received_currency]
     end
 
+    # Cryptocurrency network
+    def network
+      @attributes[:network]
+    end
+
+    # All applicable fees will be deducted from this amount before processing a transaction instead of adding them on top it
     def charged_amount
       @attributes[:charged_amount]
     end
 
+    # An exact transaction amount to send. All applicable fees will be added on top of this amount and debited from your account
     def charged_amount_to_send
       @attributes[:charged_amount_to_send]
     end
 
+    # An exact transaction amount to send. All applicable fees will be added on top of this amount and debited from your account. Use this parameter if you want to send a transaction from cryptocurrency accounts only
     def received_amount
       @attributes[:received_amount]
     end
@@ -83,7 +96,7 @@ module Cryptopay
       @attributes[:network_fee_level]
     end
 
-    # Set `true` by default. Set `false` for two-step withdrawal and commit it within 30 seconds
+    # Is `false` if omitted. Set `true` to turn off two-step withdrawal. Set `false` for two-step withdrawal and commit it within 30 seconds
     def force_commit
       @attributes[:force_commit]
     end

data/lib/cryptopay/models/coin_withdrawals_config.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+# Auto-generated file
+# DO NOT EDIT
+
+module Cryptopay
+  class CoinWithdrawalsConfig
+    ENCODER = Encoder.new(
+      name: 'Cryptopay::CoinWithdrawalsConfig',
+      attribute_map: {
+        'enabled': :enabled
+      },
+      types: {
+        'enabled': :Boolean
+      },
+      nullables: []
+    )
+    private_constant :ENCODER
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      @attributes = ENCODER.sanitize(attributes)
+    end
+
+    def enabled
+      @attributes[:enabled]
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def invalid_properties
+      properties = []
+
+      properties.push('invalid value for "enabled", enabled cannot be nil.') if enabled.nil?
+
+      properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      invalid_properties.empty?
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Cryptopay::CoinWithdrawalsConfig] Returns the model itself
+    def self.build_from_hash(data)
+      attributes = ENCODER.build_from_hash(data)
+      new(attributes)
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      ENCODER.to_hash(@attributes)
+    end
+
+    def inspect
+      "#<#{self.class}:0x#{object_id.to_s(16)}> JSON: " + JSON.pretty_generate(to_hash)
+    end
+  end
+end

data/lib/cryptopay/models/customer.rb

@@ -15,7 +15,7 @@ module Cryptopay
       types: {
         'id': :String,
         'currency': :String,
-        'refund_addresses': :Object
+        'refund_addresses': :'Hash<String, String>'
       },
       nullables: []
     )
@@ -51,6 +51,8 @@ module Cryptopay
 
       properties.push('invalid value for "currency", currency cannot be nil.') if currency.nil?
 
+      properties.push('invalid value for "refund_addresses", refund_addresses cannot be nil.') if refund_addresses.nil?
+
       properties
     end
 

data/lib/cryptopay/models/customer_params.rb

@@ -15,7 +15,7 @@ module Cryptopay
       types: {
         'id': :String,
         'currency': :String,
-        'refund_addresses': :Object
+        'refund_addresses': :'Hash<String, String>'
       },
       nullables: []
     )
@@ -37,7 +37,7 @@ module Cryptopay
       @attributes[:currency]
     end
 
-    # This object allows you 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
+    # This object 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
     def refund_addresses
       @attributes[:refund_addresses]
     end

data/lib/cryptopay/models/customer_update_params.rb

@@ -13,7 +13,7 @@ module Cryptopay
       },
       types: {
         'currency': :String,
-        'refund_addresses': :Object
+        'refund_addresses': :'Hash<String, String>'
       },
       nullables: []
     )
@@ -30,7 +30,7 @@ module Cryptopay
       @attributes[:currency]
     end
 
-    # This object allows you 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
+    # This object 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
     def refund_addresses
       @attributes[:refund_addresses]
     end

data/lib/cryptopay/models/exchange_transfer.rb

@@ -37,26 +37,32 @@ module Cryptopay
       @attributes = ENCODER.sanitize(attributes)
     end
 
+    # Exchange transaction ID
     def id
       @attributes[:id]
     end
 
+    # Amount converted
     def charged_amount
       @attributes[:charged_amount]
     end
 
+    # Account currency the funds converted from
     def charged_currency
       @attributes[:charged_currency]
     end
 
+    # Amount to be received upon exchange execution
     def received_amount
       @attributes[:received_amount]
     end
 
+    # Account currency the funds converted to
     def received_currency
       @attributes[:received_currency]
     end
 
+    # Exchange transaction reference ID in your system
     def custom_id
       @attributes[:custom_id]
     end

data/lib/cryptopay/models/exchange_transfer_params.rb

@@ -36,26 +36,32 @@ module Cryptopay
       @attributes = ENCODER.sanitize(attributes)
     end
 
+    # Account currency the funds to be converted from
     def charged_currency
       @attributes[:charged_currency]
     end
 
+    # Amount to be converted
     def charged_amount
       @attributes[:charged_amount]
     end
 
+    # Account currency the funds to be converted to
     def received_currency
       @attributes[:received_currency]
     end
 
+    # Amount to be received upon exchange execution
     def received_amount
       @attributes[:received_amount]
     end
 
+    # Exchange transaction reference ID in your system
     def custom_id
       @attributes[:custom_id]
     end
 
+    # Is `false` if omitted. Set `true` to turn off two-step exchange. Set `false` for two-step exchange and commit it within 30 seconds
     def force_commit
       @attributes[:force_commit]
     end

data/lib/cryptopay/models/invoice.rb

@@ -14,6 +14,7 @@ module Cryptopay
         'status': :status,
         'status_context': :status_context,
         'address': :address,
+        'network': :network,
         'uri': :uri,
         'price_amount': :price_amount,
         'price_currency': :price_currency,
@@ -40,6 +41,7 @@ module Cryptopay
         'status': :InvoiceStatus,
         'status_context': :InvoiceStatusContext,
         'address': :String,
+        'network': :String,
         'uri': :String,
         'price_amount': :Decimal,
         'price_currency': :String,
@@ -52,7 +54,7 @@ module Cryptopay
         'transactions': :'Array<InvoiceTransaction>',
         'name': :String,
         'description': :String,
-        'metadata': :Object,
+        'metadata': :'Hash<String, String>',
         'success_redirect_url': :String,
         'unsuccess_redirect_url': :String,
         'hosted_page_url': :String,
@@ -106,6 +108,11 @@ module Cryptopay
       @attributes[:address]
     end
 
+    # Cryptocurrency network
+    def network
+      @attributes[:network]
+    end
+
     # Invoice URI. May be used for generating a QR code
     def uri
       @attributes[:uri]
@@ -212,6 +219,8 @@ module Cryptopay
 
       properties.push('invalid value for "address", address cannot be nil.') if address.nil?
 
+      properties.push('invalid value for "network", network cannot be nil.') if network.nil?
+
       properties.push('invalid value for "uri", uri cannot be nil.') if uri.nil?
 
       properties.push('invalid value for "price_amount", price_amount cannot be nil.') if price_amount.nil?

data/lib/cryptopay/models/invoice_callback.rb

@@ -46,8 +46,6 @@ module Cryptopay
 
       properties.push('invalid value for "type", type cannot be nil.') if type.nil?
 
-      properties.push('invalid value for type, must be one of "Invoice"') if !type.nil? && !['Invoice'].include?(type)
-
       properties.push('invalid value for "event", event cannot be nil.') if event.nil?
 
       if !event.nil? && !%w[created refunded recalculated status_changed transaction_created transaction_confirmed].include?(event)