cryptopay-ruby 2.1.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 18a89097b66be19ae3889c0c2279574f5b2aa917d6d66a5ace4547cd2877538b
-  data.tar.gz: b259cd7c0ef3ebe5e8457118533e3abeb5bd2c033f14b549657c7fcc844015dd
+  metadata.gz: ef84c8ae3650cba4ab5f4fce1e22df6e9762b9dce8cfda0671fb141eee38efc5
+  data.tar.gz: f740121751b90551e1caa0108fac4fab7570b9c8e08b8c2714e9dae6b42fb34d
 SHA512:
-  metadata.gz: 7f4a1fa54fd517d1288a386e115ac2634293c95d0fb1af44e1e4f6af51671d215a42dd51bb4fc5fce201533f3992703a5104e24ef378830e67dfc4bafe704c67
-  data.tar.gz: 411446bfe02bbf5ccac2c906524451bce90c0348ade8da2751038cf8abb707ca916426ed041bc1a8509a835a5473c20e594c3d4e5b0cd1b73c05b2bb344ee8c4
+  metadata.gz: 8833dd9bdba6ba96d906d3cb945e320cabeb7a94a625aa8eba15f0c501af05dd396e44678077246f2d6d7eaf9acb93b9d9552d65dc138c9234c26d86e4eb01c5
+  data.tar.gz: 50d32b002e455292b9ec8f3a47961fe92829862d9cec35ebed1f80decadb6940f016ad62eedff175bc3c182af7d93e6279982e89fbc5497babb70821dd72665a

data/.rubocop.yml

@@ -105,3 +105,6 @@ Metrics/MethodLength:
 Naming/PredicateName:
   Exclude:
     - lib/cryptopay/models/**/*
+
+Naming/VariableNumber:
+  AllowedIdentifiers: line_1, line_2

data/README.md

@@ -19,7 +19,6 @@ For more information, please visit [Cryptopay API docs](https://developers.crypt
    * [ExchangeTransfers](#exchangetransfers)
    * [Invoices](#invoices)
    * [Rates](#rates)
-   * [Risks](#risks)
    * [Subscriptions](#subscriptions)
    * [Transactions](#transactions)
 * [Callbacks](#callbacks)
@@ -205,6 +204,19 @@ params = Cryptopay::CoinWithdrawalParams.new(
   force_commit: true
 )
 
+result = client.coin_withdrawals.create(params)
+p result # => <CoinWithdrawalResult data=...>
+# New amounts example
+params = Cryptopay::CoinWithdrawalParams.new(
+  address: '2Mz3bcjSVHG8uQJpNjmCxp24VdTjwaqmFcJ',
+  amount: '100.0',
+  amount_currency: 'EUR',
+  received_currency: 'BTC',
+  amount_includes_processing_fee: true,
+  amount_includes_network_fee: true,
+  force_commit: true
+)
+
 result = client.coin_withdrawals.create(params)
 p result # => <CoinWithdrawalResult data=...>
 ```
@@ -403,9 +415,8 @@ p result # => <InvoiceRecalculationResult data=...>
 
 ```ruby
 invoice_id = '7e274430-e20f-4321-8748-20824287ae44'
-invoice_refund_params = Cryptopay::InvoiceRefundParams.new(address: '0xf3532c1fd002665ec54d46a50787e0c69c76cd44')
 
-result = client.invoices.create_refund(invoice_id, invoice_refund_params)
+result = client.invoices.create_refund(invoice_id)
 p result # => <InvoiceRefundResult data=...>
 ```
 
@@ -469,24 +480,6 @@ result = client.rates.retrieve(base_currency, quote_currency)
 p result # => <RateResult data=...>
 ```
 
-### Risks
-
-[Risks API docs](https://developers.cryptopay.me/guides/risks)
-
-#### Score a coin address
-
-
-```ruby
-params = Cryptopay::RiskParams.new(
-  address: '2N9wPGx67zdSeAbXi15qHgoZ9Hb9Uxhd2uQ',
-  currency: 'BTC',
-  type: 'source_of_funds'
-)
-
-result = client.risks.score(params)
-p result # => <RiskResult data=...>
-```
-
 ### Subscriptions
 
 

data/lib/cryptopay/api/coin_withdrawals.rb

@@ -26,6 +26,7 @@ module Cryptopay
     end
 
     # Create a withdrawal
+    # To create a withdrawal you must provide either the legacy amount fields (`charged_amount`, `charged_amount_to_send`, `received_amount`) or the new amount fields (`amount`, `amount_currency`, `amount_includes_processing_fee`, `amount_includes_network_fee`). Mixing legacy and new amount fields in one request is not allowed.
     # @param coin_withdrawal_params [CoinWithdrawalParams]
     # @param [Hash] opts the optional parameters
     # @return [CoinWithdrawalResult]

data/lib/cryptopay/api/invoices.rb

@@ -65,19 +65,19 @@ module Cryptopay
     end
 
     # Create invoice refund
-    # This endpoint allows you to create invoice refunds.
+    # This endpoint allows you to create invoice refunds to your cryptocurrency account.
     # @param invoice_id [String] Invoice ID
-    # @param invoice_refund_params [InvoiceRefundParams]
     # @param [Hash] opts the optional parameters
+    # @option opts [Object] :body
     # @return [InvoiceRefundResult]
-    def create_refund(invoice_id, invoice_refund_params, _opts = {})
+    def create_refund(invoice_id, opts = {})
       path = '/api/invoices/{invoice_id}/refunds'
       path = path.sub('{invoice_id}', CGI.escape(invoice_id.to_s))
 
       req = Request.new(
         method: :post,
         path: path,
-        body_params: invoice_refund_params
+        body_params: opts[:body] || {}
       )
 
       connection.call(req, return_type: InvoiceRefundResult)

data/lib/cryptopay/client.rb

@@ -26,7 +26,7 @@ module Cryptopay
 
     private
 
-    def setup_apis(connection) # rubocop:disable Metrics/MethodLength
+    def setup_apis(connection)
       @invoices = Invoices.new(connection)
       @rates = Rates.new(connection)
       @coin_withdrawals = CoinWithdrawals.new(connection)
@@ -35,7 +35,6 @@ module Cryptopay
       @transactions = Transactions.new(connection)
       @exchange_transfers = ExchangeTransfers.new(connection)
       @customers = Customers.new(connection)
-      @risks = Risks.new(connection)
       @coins = Coins.new(connection)
       @subscriptions = Subscriptions.new(connection)
     end

data/lib/cryptopay/models/beneficiary.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+# Auto-generated file
+# DO NOT EDIT
+
+module Cryptopay
+  # Beneficiary information.
+  class Beneficiary
+    ENCODER = Encoder.new(
+      name: 'Cryptopay::Beneficiary',
+      attribute_map: {
+        'type': :type,
+        'name': :name,
+        'address': :address
+      },
+      types: {
+        'type': :BeneficiaryType,
+        'name': :String,
+        'address': :BeneficiaryAddress
+      },
+      nullables: []
+    )
+    private_constant :ENCODER
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Cryptopay::Beneficiary] Returns the model itself
+    def self.build_from_hash(data)
+      attributes = ENCODER.build_from_hash(data)
+      new(attributes)
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      @attributes = ENCODER.sanitize(attributes)
+    end
+
+    def type
+      @attributes[:type]
+    end
+
+    # The registered name of the company for a `legal_person` or the full name for a `natural_person`. Note that only following symbols will be stored, regardless of the input value: letters of any language, digits `0-9`, symbols `&` `!` `,` `.` `-` and single spaces. Symbols `\\`, `/`, newlines and tabs will be replaced with spaces. Everything else will be removed, including double spaces and spaces in the end.
+    def name
+      @attributes[:name]
+    end
+
+    def address
+      @attributes[:address]
+    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 "type", type cannot be nil.') if type.nil?
+
+      if !type.nil? && !%w[natural_person legal_person].include?(type)
+        properties.push('invalid value for type, must be one of "natural_person", "legal_person"')
+      end
+
+      properties.push('invalid value for "name", name cannot be nil.') if name.nil?
+
+      if name.to_s.length > 100
+        properties.push('invalid value for "name", the character length must be smaller than or equal to 100.')
+      end
+
+      address&.invalid_properties&.each do |prop|
+        properties.push("invalid value for \"address\": #{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
+
+    # 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/beneficiary_address.rb

@@ -0,0 +1,111 @@
+# frozen_string_literal: true
+
+# Auto-generated file
+# DO NOT EDIT
+
+module Cryptopay
+  class BeneficiaryAddress
+    ENCODER = Encoder.new(
+      name: 'Cryptopay::BeneficiaryAddress',
+      attribute_map: {
+        'country': :country,
+        'city': :city,
+        'line_1': :line_1,
+        'line_2': :line_2,
+        'post_code': :post_code
+      },
+      types: {
+        'country': :String,
+        'city': :String,
+        'line_1': :String,
+        'line_2': :String,
+        'post_code': :String
+      },
+      nullables: []
+    )
+    private_constant :ENCODER
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Cryptopay::BeneficiaryAddress] Returns the model itself
+    def self.build_from_hash(data)
+      attributes = ENCODER.build_from_hash(data)
+      new(attributes)
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      @attributes = ENCODER.sanitize(attributes)
+    end
+
+    # The 2-letter ISO country code of the address.
+    def country
+      @attributes[:country]
+    end
+
+    # The city of the address.
+    def city
+      @attributes[:city]
+    end
+
+    # First line of the address.
+    def line_1
+      @attributes[:line_1]
+    end
+
+    # Second line of the address.
+    def line_2
+      @attributes[:line_2]
+    end
+
+    # Postal code of the address.
+    def post_code
+      @attributes[:post_code]
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def invalid_properties
+      properties = []
+
+      if !country.nil? && country.to_s.length > 2
+        properties.push('invalid value for "country", the character length must be smaller than or equal to 2.')
+      end
+
+      if !city.nil? && city.to_s.length > 35
+        properties.push('invalid value for "city", the character length must be smaller than or equal to 35.')
+      end
+
+      if !line_1.nil? && line_1.to_s.length > 70
+        properties.push('invalid value for "line_1", the character length must be smaller than or equal to 70.')
+      end
+
+      if !line_2.nil? && line_2.to_s.length > 70
+        properties.push('invalid value for "line_2", the character length must be smaller than or equal to 70.')
+      end
+
+      if !post_code.nil? && post_code.to_s.length > 16
+        properties.push('invalid value for "post_code", the character length must be smaller than or equal to 16.')
+      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
+
+    # 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/beneficiary_type.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+# Auto-generated file
+# DO NOT EDIT
+
+module Cryptopay
+  module BeneficiaryType
+    NATURAL_PERSON = 'natural_person'
+    LEGAL_PERSON = 'legal_person'
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def self.build_from_hash(value)
+      value
+    end
+  end
+end

data/lib/cryptopay/models/coin_withdrawal_params.rb

@@ -18,7 +18,13 @@ module Cryptopay
         'custom_id': :custom_id,
         'customer_id': :customer_id,
         'network_fee_level': :network_fee_level,
-        'force_commit': :force_commit
+        'force_commit': :force_commit,
+        'travel_rule_compliant': :travel_rule_compliant,
+        'beneficiary': :beneficiary,
+        'amount': :amount,
+        'amount_currency': :amount_currency,
+        'amount_includes_processing_fee': :amount_includes_processing_fee,
+        'amount_includes_network_fee': :amount_includes_network_fee
       },
       types: {
         'address': :String,
@@ -31,7 +37,13 @@ module Cryptopay
         'custom_id': :String,
         'customer_id': :String,
         'network_fee_level': :NetworkFeeLevel,
-        'force_commit': :Boolean
+        'force_commit': :Boolean,
+        'travel_rule_compliant': :Boolean,
+        'beneficiary': :Beneficiary,
+        'amount': :Decimal,
+        'amount_currency': :String,
+        'amount_includes_processing_fee': :Boolean,
+        'amount_includes_network_fee': :Boolean
       },
       nullables: %i[
         charged_amount
@@ -75,17 +87,17 @@ module Cryptopay
       @attributes[:network]
     end
 
-    # All applicable fees will be deducted from this amount before processing a transaction instead of adding them on top it
+    # The exact amount to debit from your account in `charged_currency`. 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
+    # The exact transaction amount to send in `charged_currency`. 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
+    # The exact transaction amount to send in `received_currency`. All applicable fees will be added on top of this amount and debited from your account.
     def received_amount
       @attributes[:received_amount]
     end
@@ -109,6 +121,35 @@ module Cryptopay
       @attributes[:force_commit]
     end
 
+    # Is `false` if omitted. Set `true` to turn on beneficiary data validations
+    def travel_rule_compliant
+      @attributes[:travel_rule_compliant]
+    end
+
+    def beneficiary
+      @attributes[:beneficiary]
+    end
+
+    # Transaction amount for new calculation
+    def amount
+      @attributes[:amount]
+    end
+
+    # An currency of the transaction amount
+    def amount_currency
+      @attributes[:amount_currency]
+    end
+
+    # Whether the amount includes processing fee
+    def amount_includes_processing_fee
+      @attributes[:amount_includes_processing_fee]
+    end
+
+    # Whether the amount includes network fee
+    def amount_includes_network_fee
+      @attributes[:amount_includes_network_fee]
+    end
+
     # Show invalid properties with the reasons. Usually used together with valid?
     # @return Array for valid properties with the reasons
     def invalid_properties
@@ -126,6 +167,10 @@ module Cryptopay
         properties.push('invalid value for network_fee_level, must be one of "fast", "average", "slow"')
       end
 
+      beneficiary&.invalid_properties&.each do |prop|
+        properties.push("invalid value for \"beneficiary\": #{prop}")
+      end
+
       properties
     end
 

data/lib/cryptopay/require.rb

@@ -6,6 +6,9 @@
 # Models
 require 'cryptopay/models/account'
 require 'cryptopay/models/account_list_result'
+require 'cryptopay/models/beneficiary'
+require 'cryptopay/models/beneficiary_address'
+require 'cryptopay/models/beneficiary_type'
 require 'cryptopay/models/callback'
 require 'cryptopay/models/channel'
 require 'cryptopay/models/channel_list_result'
@@ -53,7 +56,6 @@ require 'cryptopay/models/invoice_recalculation_params'
 require 'cryptopay/models/invoice_recalculation_result'
 require 'cryptopay/models/invoice_refund'
 require 'cryptopay/models/invoice_refund_list_result'
-require 'cryptopay/models/invoice_refund_params'
 require 'cryptopay/models/invoice_refund_result'
 require 'cryptopay/models/invoice_result'
 require 'cryptopay/models/invoice_status'
@@ -69,9 +71,6 @@ require 'cryptopay/models/rate_result'
 require 'cryptopay/models/rates_result'
 require 'cryptopay/models/risk'
 require 'cryptopay/models/risk_level'
-require 'cryptopay/models/risk_params'
-require 'cryptopay/models/risk_result'
-require 'cryptopay/models/risk_type'
 require 'cryptopay/models/subscription'
 require 'cryptopay/models/subscription_callback'
 require 'cryptopay/models/subscription_callback_event'
@@ -93,6 +92,5 @@ require 'cryptopay/api/customers'
 require 'cryptopay/api/exchange_transfers'
 require 'cryptopay/api/invoices'
 require 'cryptopay/api/rates'
-require 'cryptopay/api/risks'
 require 'cryptopay/api/subscriptions'
 require 'cryptopay/api/transactions'

data/lib/cryptopay/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Cryptopay
-  VERSION = '2.1.0'
+  VERSION = '3.0.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cryptopay-ruby
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Cryptopay
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-07-18 00:00:00.000000000 Z
+date: 2025-10-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -165,6 +165,9 @@ files:
 - lib/cryptopay/errors.rb
 - lib/cryptopay/models/account.rb
 - lib/cryptopay/models/account_list_result.rb
+- lib/cryptopay/models/beneficiary.rb
+- lib/cryptopay/models/beneficiary_address.rb
+- lib/cryptopay/models/beneficiary_type.rb
 - lib/cryptopay/models/callback.rb
 - lib/cryptopay/models/channel.rb
 - lib/cryptopay/models/channel_list_result.rb
@@ -268,7 +271,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.20
+rubygems_version: 3.3.26
 signing_key:
 specification_version: 4
 summary: The official Ruby gem for the Cryptopay API