cryptopay-ruby 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0b9f9de99f5c3cbd724ea0c23f40cbcfddbe1e53e7421dd1ebc7e439f35f4ecc
-  data.tar.gz: f1e875ecee66df1a7bfd860cebbc2ff21a5c6adc352b3d3ee2db716652def832
+  metadata.gz: 565560b9bd60b4439f410a759ef4c51fce1104e29b887a5a70f579f583a96a7a
+  data.tar.gz: a48fe75139c6244dc20fa430633329d7015debd3760bcb38d48e6fa350bf3593
 SHA512:
-  metadata.gz: c7ada56d4edde325ad250fe6e169814a2873379870322b63095fb261e74a3899fcf85dadf209738658e6e19227cd1215c4202851955d5eee5a29b27e2476c9b7
-  data.tar.gz: 1a83aba1a6d7aca51d87e9b71254b80bb1aa7fe8d41e23e2d8d17904adf9cf192535a364aafb64e09507aa1bcd1dffe00e1f45ae483933b4f94c41fe4c35a919
+  metadata.gz: 3c2bac187a5dfc48dcef7691025ac33dd4bf79dd6235f8429f5c827a90e5b4b18ed7a80d6cdb1cdebce6d1974b707aed284a79ca796a8251056113ca1b0e305a
+  data.tar.gz: 4d836911974b0d7a971d5898c678a245e69f0b1b5f4b70aa8977738fbcd68712902161c8da06323b4a280bcf663dd1fbb536efc9031874aedd03b7ce49d915e6

data/README.md

@@ -14,6 +14,7 @@ For more information, please visit [Cryptopay API docs](https://developers.crypt
    * [Accounts](#accounts)
    * [Channels](#channels)
    * [CoinWithdrawals](#coinwithdrawals)
+   * [Coins](#coins)
    * [Customers](#customers)
    * [ExchangeTransfers](#exchangetransfers)
    * [Invoices](#invoices)
@@ -67,7 +68,6 @@ end
 
 ### Accounts
 
-[Accounts API docs](https://developers.cryptopay.me/reference/accounts)
 
 #### List accounts
 
@@ -91,7 +91,7 @@ p result # => <TransactionListResult data=...>
 
 A channel is a static cryptocurrency address that may be assigned to each one of your customers.
 
-[Channels API docs](https://developers.cryptopay.me/reference/payment-channels)
+[Channels API docs](https://developers.cryptopay.me/guides/channels)
 
 #### Create a channel
 
@@ -173,7 +173,7 @@ p result # => <ChannelResult data=...>
 
 In addition to accepting payments through the Cryptopay payment gateway, it is also possible to make payments to your customers in any of the cryptocurrency currently supported by Cryptopay. In Cryptopay, these payments are called “Coin Withdrawal”. The process of requesting coin withdrawal is almost the same for a customer in Cashier as the process of making a deposit with one exception - the customer will need to specify the address of the wallet he wants to send the cryptocurrency to.
 
-[Coin withdrawals API docs](https://developers.cryptopay.me/reference/coin-withdrawals)
+[Coin withdrawals API docs](https://developers.cryptopay.me/guides/payouts)
 
 #### Commit a withdrawal
 
@@ -244,11 +244,21 @@ result = client.coin_withdrawals.retrieve_by_custom_id(custom_id)
 p result # => <CoinWithdrawalResult data=...>
 ```
 
+### Coins
+
+
+#### List supported coins
+
+
+```ruby
+result = client.coins.list
+p result # => <CoinListResult data=...>
+```
+
 ### Customers
 
-Customer objects allow you to reject High-Risk transactions automatically, and to track multiple transactions, that are associated with the same customer
+Customer objects allow you to reject High-Risk transactions automatically, and to track multiple transactions, that are associated with the same customer.
 
-[Customers API docs](https://developers.cryptopay.me/reference/customers)
 
 #### Create a customer
 
@@ -275,7 +285,7 @@ p result # => <CustomerListResult data=...>
 
 
 ```ruby
-customer_id = 'CUSTOMER-123'
+customer_id = "CUSTOMER-123"
 
 result = client.customers.retrieve(customer_id)
 p result # => <CustomerResult data=...>
@@ -285,7 +295,7 @@ p result # => <CustomerResult data=...>
 
 
 ```ruby
-customer_id = 'CUSTOMER-123'
+customer_id = "CUSTOMER-123"
 params = Cryptopay::CustomerUpdateParams.new(
   refund_addresses: {
     'BTC' => '2N9wPGx67zdSeAbXi15qHgoZ9Hb9Uxhd2uQ'
@@ -298,7 +308,6 @@ p result # => <CustomerResult data=...>
 
 ### ExchangeTransfers
 
-[Exchange transfers API docs](https://developers.cryptopay.me/reference/exchange)
 
 #### Commit an exchange transfer
 
@@ -346,7 +355,7 @@ p result # => <ExchangeTransferResult data=...>
 
 An invoice is a request for a cryptocurrency payment which contains a unique BTC, LTC, ETH or XRP address and the amount that has to be paid while the invoice is valid.
 
-[Invoices API docs](https://developers.cryptopay.me/reference/invoices)
+[Invoices API docs](https://developers.cryptopay.me/guides/invoices)
 
 #### Commit invoice recalculation
 
@@ -435,7 +444,6 @@ p result # => <InvoiceResult data=...>
 
 ### Rates
 
-[Public rates API docs](https://developers.cryptopay.me/reference/public-rates)
 
 #### Retrieve all rates
 
@@ -458,7 +466,7 @@ p result # => <RateResult data=...>
 
 ### Risks
 
-[Risks API docs](https://developers.cryptopay.me/reference/risks)
+[Risks API docs](https://developers.cryptopay.me/guides/risks)
 
 #### Score a coin address
 
@@ -476,7 +484,7 @@ p result # => <RiskResult data=...>
 
 ### Transactions
 
-[Transactions API docs](https://developers.cryptopay.me/reference/transactions)
+[Transactions API docs](https://developers.cryptopay.me/guides/transactions)
 
 #### List transactions
 

data/cryptopay.gemspec

@@ -30,11 +30,11 @@ Gem::Specification.new do |s|
 
   s.add_runtime_dependency('faraday', '~> 1.0', '>= 1.0.1')
 
-  s.add_development_dependency('dotenv')
-  s.add_development_dependency('pry-byebug')
-  s.add_development_dependency('rake')
-  s.add_development_dependency('rspec')
-  s.add_development_dependency('rubocop')
-  s.add_development_dependency('vcr')
-  s.add_development_dependency('webmock')
+  s.add_development_dependency('dotenv', '~> 2.7')
+  s.add_development_dependency('pry-byebug', '~> 3.9')
+  s.add_development_dependency('rake', '~> 13.0')
+  s.add_development_dependency('rspec', '~> 3.11')
+  s.add_development_dependency('rubocop', '~> 1.25')
+  s.add_development_dependency('vcr', '~> 6.0')
+  s.add_development_dependency('webmock', '~> 3.14')
 end

data/lib/cryptopay/api/coin_withdrawals.rb

@@ -64,13 +64,18 @@ module Cryptopay
 
     # List network fees
     # @param [Hash] opts the optional parameters
+    # @option opts [Boolean] :all_networks Is `false` if omitted. Set `true` to return network fees for all cryptocurrency networks
     # @return [NetworkFeeListResult]
-    def list_network_fees(_opts = {})
+    def list_network_fees(opts = {})
       path = '/api/coin_withdrawals/network_fees'
 
+      query_params = {}
+      query_params[:all_networks] = opts[:all_networks] unless opts[:all_networks].nil?
+
       req = Request.new(
         method: :get,
-        path: path
+        path: path,
+        query_params: query_params
       )
 
       connection.call(req, return_type: NetworkFeeListResult)

data/lib/cryptopay/api/coins.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+# Auto-generated file
+# DO NOT EDIT
+
+module Cryptopay
+  class Coins
+    def initialize(connection)
+      @connection = connection
+    end
+
+    # List supported coins
+    # @param [Hash] opts the optional parameters
+    # @return [CoinListResult]
+    def list(_opts = {})
+      path = '/api/coins'
+
+      req = Request.new(
+        method: :get,
+        path: path
+      )
+
+      connection.call(req, return_type: CoinListResult)
+    end
+
+    private
+
+    attr_reader :connection
+  end
+end

data/lib/cryptopay/client.rb

@@ -11,7 +11,8 @@ module Cryptopay
                 :exchange_transfers,
                 :customers,
                 :risks,
-                :callbacks
+                :callbacks,
+                :coins
 
     def initialize(&block)
       config = Config.new(&block)
@@ -34,6 +35,7 @@ module Cryptopay
       @exchange_transfers = ExchangeTransfers.new(connection)
       @customers = Customers.new(connection)
       @risks = Risks.new(connection)
+      @coins = Coins.new(connection)
     end
   end
 end

data/lib/cryptopay/models/account.rb

@@ -29,18 +29,22 @@ module Cryptopay
       @attributes = ENCODER.sanitize(attributes)
     end
 
+    # Account ID
     def id
       @attributes[:id]
     end
 
+    # Account currency
     def currency
       @attributes[:currency]
     end
 
+    # Account balance
     def balance
       @attributes[:balance]
     end
 
+    # Project ID which the account belongs to
     def project_id
       @attributes[:project_id]
     end

data/lib/cryptopay/models/account_list_result.rb

@@ -8,10 +8,12 @@ module Cryptopay
     ENCODER = Encoder.new(
       name: 'Cryptopay::AccountListResult',
       attribute_map: {
-        'data': :data
+        'data': :data,
+        'meta': :meta
       },
       types: {
-        'data': :'Array<Account>'
+        'data': :'Array<Account>',
+        'meta': :Pagination
       },
       nullables: []
     )
@@ -27,6 +29,10 @@ module Cryptopay
       @attributes[:data]
     end
 
+    def meta
+      @attributes[:meta]
+    end
+
     # Show invalid properties with the reasons. Usually used together with valid?
     # @return Array for valid properties with the reasons
     def invalid_properties
@@ -40,6 +46,12 @@ module Cryptopay
         end
       end
 
+      properties.push('invalid value for "meta", meta cannot be nil.') if meta.nil?
+
+      meta&.invalid_properties&.each do |prop|
+        properties.push("invalid value for \"meta\": #{prop}")
+      end
+
       properties
     end
 

data/lib/cryptopay/models/channel.rb

@@ -15,6 +15,7 @@ module Cryptopay
         'pay_currency': :pay_currency,
         'receiver_currency': :receiver_currency,
         'address': :address,
+        'network': :network,
         'project_id': :project_id,
         'custom_id': :custom_id,
         'customer_id': :customer_id,
@@ -29,6 +30,7 @@ module Cryptopay
         'pay_currency': :String,
         'receiver_currency': :String,
         'address': :String,
+        'network': :String,
         'project_id': :String,
         'custom_id': :String,
         'customer_id': :String,
@@ -49,6 +51,7 @@ module Cryptopay
       @attributes = ENCODER.sanitize(attributes)
     end
 
+    # Channel ID
     def id
       @attributes[:id]
     end
@@ -57,42 +60,57 @@ module Cryptopay
       @attributes[:status]
     end
 
+    # Channel name
     def name
       @attributes[:name]
     end
 
+    # Channel description
     def description
       @attributes[:description]
     end
 
+    # The cryptocurrency which you want to accept
     def pay_currency
       @attributes[:pay_currency]
     end
 
+    # The currency which all incoming transactions will be converted to
     def receiver_currency
       @attributes[:receiver_currency]
     end
 
+    # Channel description
     def address
       @attributes[:address]
     end
 
+    # Cryptocurrency network
+    def network
+      @attributes[:network]
+    end
+
+    # Project ID
     def project_id
       @attributes[:project_id]
     end
 
+    # The channel 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
 
+    # Channel URI. May be used for generating a QR code
     def uri
       @attributes[:uri]
     end
 
+    # Channel hosted page that renders channel details
     def hosted_page_url
       @attributes[:hosted_page_url]
     end
@@ -120,6 +138,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 "project_id", project_id cannot be nil.') if project_id.nil?
 
       properties.push('invalid value for "uri", uri cannot be nil.') if uri.nil?

data/lib/cryptopay/models/channel_params.rb

@@ -11,6 +11,7 @@ module Cryptopay
         'name': :name,
         'description': :description,
         'pay_currency': :pay_currency,
+        'network': :network,
         'receiver_currency': :receiver_currency,
         'custom_id': :custom_id,
         'customer_id': :customer_id
@@ -19,6 +20,7 @@ module Cryptopay
         'name': :String,
         'description': :String,
         'pay_currency': :String,
+        'network': :String,
         'receiver_currency': :String,
         'custom_id': :String,
         'customer_id': :String
@@ -33,18 +35,27 @@ module Cryptopay
       @attributes = ENCODER.sanitize(attributes)
     end
 
+    # Channel name
     def name
       @attributes[:name]
     end
 
+    # Channel description
     def description
       @attributes[:description]
     end
 
+    # The cryptocurrency which you want to accept
     def pay_currency
       @attributes[:pay_currency]
     end
 
+    # Cryptocurrency network
+    def network
+      @attributes[:network]
+    end
+
+    # The currency which all incoming transactions will be converted to
     def receiver_currency
       @attributes[:receiver_currency]
     end

data/lib/cryptopay/models/channel_payment.rb

@@ -26,6 +26,7 @@ module Cryptopay
         'custom_id': :custom_id,
         'customer_id': :customer_id,
         'address': :address,
+        'network': :network,
         'created_at': :created_at
       },
       types: {
@@ -47,6 +48,7 @@ module Cryptopay
         'custom_id': :String,
         'customer_id': :String,
         'address': :String,
+        'network': :String,
         'created_at': :Time
       },
       nullables: %i[
@@ -65,38 +67,47 @@ module Cryptopay
       @attributes = ENCODER.sanitize(attributes)
     end
 
+    # Channel payment ID
     def id
       @attributes[:id]
     end
 
+    # Channel ID
     def channel_id
       @attributes[:channel_id]
     end
 
+    # Cryptocurrency transaction amount that was received
     def paid_amount
       @attributes[:paid_amount]
     end
 
+    # Cryptocurrency type
     def paid_currency
       @attributes[:paid_currency]
     end
 
+    # Amount credited to your Cryptopay account
     def received_amount
       @attributes[:received_amount]
     end
 
+    # Account currency
     def received_currency
       @attributes[:received_currency]
     end
 
+    # Processing fee
     def fee
       @attributes[:fee]
     end
 
+    # Processing fee currency
     def fee_currency
       @attributes[:fee_currency]
     end
 
+    # Cryptocurrency transaction ID on the blockchain
     def txid
       @attributes[:txid]
     end
@@ -125,18 +136,27 @@ module Cryptopay
       @attributes[:coin_withdrawal_id]
     end
 
+    # Channel payment custom_id value inherited from its parent channel
     def custom_id
       @attributes[:custom_id]
     end
 
+    # The reference ID of your customer
     def customer_id
       @attributes[:customer_id]
     end
 
+    # Channel cryptocurrency address
     def address
       @attributes[:address]
     end
 
+    # Cryptocurrency network
+    def network
+      @attributes[:network]
+    end
+
+    # Channel payment creation date and time
     def created_at
       @attributes[:created_at]
     end

data/lib/cryptopay/models/channel_payment_callback.rb

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

data/lib/cryptopay/models/channel_update_params.rb

@@ -29,10 +29,12 @@ module Cryptopay
       @attributes = ENCODER.sanitize(attributes)
     end
 
+    # Channel name
     def name
       @attributes[:name]
     end
 
+    # Channel description
     def description
       @attributes[:description]
     end

data/lib/cryptopay/models/channels_config.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+# Auto-generated file
+# DO NOT EDIT
+
+module Cryptopay
+  class ChannelsConfig
+    ENCODER = Encoder.new(
+      name: 'Cryptopay::ChannelsConfig',
+      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::ChannelsConfig] 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.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+# Auto-generated file
+# DO NOT EDIT
+
+module Cryptopay
+  class Coin
+    ENCODER = Encoder.new(
+      name: 'Cryptopay::Coin',
+      attribute_map: {
+        'currency': :currency,
+        'name': :name,
+        'logo_url': :logo_url,
+        'networks': :networks
+      },
+      types: {
+        'currency': :String,
+        'name': :String,
+        'logo_url': :String,
+        'networks': :'Array<CoinNetwork>'
+      },
+      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 currency
+      @attributes[:currency]
+    end
+
+    def name
+      @attributes[:name]
+    end
+
+    def logo_url
+      @attributes[:logo_url]
+    end
+
+    def networks
+      @attributes[:networks]
+    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 "currency", currency cannot be nil.') if currency.nil?
+
+      properties.push('invalid value for "name", name cannot be nil.') if name.nil?
+
+      properties.push('invalid value for "logo_url", logo_url cannot be nil.') if logo_url.nil?
+
+      properties.push('invalid value for "networks", networks cannot be nil.') if networks.nil?
+
+      networks&.each_with_index do |item, index|
+        item.invalid_properties.each do |prop|
+          properties.push("invalid value for \"networks.#{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::Coin] 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