cryptopay-ruby 2.0.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fb93a5d512a5c50963761dae68e58c82f02d97ac0b645f3a9850ed0c098d30a0
-  data.tar.gz: 0b2590bd8ddebe472f255fd777214fb095f182b28ba05ea993df4217b10dcf98
+  metadata.gz: 9b7b5b9797e07653c96e6c8e9e89838d4ad67db7d4c31df93971c78697125446
+  data.tar.gz: ad3a36fae0973cde9845e898b4ad6f4eb795957af856d8cfadb95215a2e1dfff
 SHA512:
-  metadata.gz: 502490fdeb6d82851be75a541838219ee3058de3836ee1abb8381b8fe3df1236cc71e8149d27f38fb76907fd1f777ea9fab1a596d3efec5a0a3b2e8574d87660
-  data.tar.gz: 3aaaa5115bee1d8983a756bd59425e656ce7a1f1607fbd324803c09e1cbccd3aa897f021f71992e8fa0286c1724a6cad7b3b20aa51d413b20be97c73b63666aa
+  metadata.gz: 84f5d30d964c10af04fff1f1a77e83b28352b42faaf63f2862b2a2a47fe81238b4545be53e95c14ef8a11f1823a1344913ad7cf9fa01dfbb3424109ab0ffce64
+  data.tar.gz: ff88be658db23f44d892a60aa1a9da21efa9631f42a222d1f34934f8c42211fc4b4c748f826cf51a0071f19a7910106739895f5a5dd24aac334658a781291194

data/.github/workflows/ci.yml

@@ -22,7 +22,12 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby-version: [2.6, 2.7, 3.0]
+        ruby-version:
+          - '2.6'
+          - '2.7'
+          - '3.0'
+          - '3.1'
+          - '3.2'
     steps:
     - uses: actions/checkout@v2
     - name: Set up Ruby

data/.rubocop.yml

@@ -18,6 +18,9 @@ Style/GuardClause:
 Style/Copyright:
   Enabled: false
 
+Style/DisableCopsWithinSourceCodeDirective:
+  Enabled: false
+
 Style/Documentation:
   Enabled: false
 
@@ -102,3 +105,6 @@ Metrics/MethodLength:
 Naming/PredicateName:
   Exclude:
     - lib/cryptopay/models/**/*
+
+Naming/VariableNumber:
+  AllowedIdentifiers: line_1, line_2

data/README.md

@@ -19,7 +19,7 @@ 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)
 * [Development](#development)
@@ -468,22 +468,63 @@ result = client.rates.retrieve(base_currency, quote_currency)
 p result # => <RateResult data=...>
 ```
 
-### Risks
+### Subscriptions
 
-[Risks API docs](https://developers.cryptopay.me/guides/risks)
 
-#### Score a coin address
+#### Cancel a subscription
 
 
 ```ruby
-params = Cryptopay::RiskParams.new(
-  address: '2N9wPGx67zdSeAbXi15qHgoZ9Hb9Uxhd2uQ',
-  currency: 'BTC',
-  type: 'source_of_funds'
+subscription_id = 'de37fb63-986b-4f83-bf9f-612734316fdc'
+
+result = client.subscriptions.cancel(subscription_id)
+p result # => <SubscriptionResult data=...>
+```
+
+#### Create a subscription
+
+
+```ruby
+params = Cryptopay::SubscriptionParams.new(
+  name: 'Subscription name',
+  amount: '100.0',
+  currency: 'EUR',
+  period: 'month',
+  period_quantity: 3,
+  payer_email: 'user@example.com',
+  starts_at: Time.now.utc + 7 * 24 * 3600
 )
 
-result = client.risks.score(params)
-p result # => <RiskResult data=...>
+result = client.subscriptions.create(params)
+p result # => <SubscriptionResult data=...>
+```
+
+#### List subscriptions
+
+
+```ruby
+result = client.subscriptions.list
+p result # => <SubscriptionListResult data=...>
+```
+
+#### Retrieve a subscription
+
+
+```ruby
+subscription_id = '64249ede-8969-4d5c-a042-806f9c3e7db3'
+
+result = client.subscriptions.retrieve(subscription_id)
+p result # => <SubscriptionResult data=...>
+```
+
+#### Retrieve a subscription by custom_id
+
+
+```ruby
+custom_id = 'PAYMENT-123'
+
+result = client.subscriptions.retrieve_by_custom_id(custom_id)
+p result # => <SubscriptionResult data=...>
 ```
 
 ### Transactions

data/lib/cryptopay/api/coin_withdrawals.rb

@@ -26,6 +26,7 @@ module Cryptopay
     end
 
     # Create a withdrawal
+    # To create a withdrawal you need to use either `charged_amount`, `charged_amount_to_send` or `received_amount` parameters in your request body.
     # @param coin_withdrawal_params [CoinWithdrawalParams]
     # @param [Hash] opts the optional parameters
     # @return [CoinWithdrawalResult]

data/lib/cryptopay/api/invoices.rb

@@ -88,6 +88,7 @@ module Cryptopay
     # @param [Hash] opts the optional parameters
     # @option opts [String] :customer_id The internal ID of your customer that the transaction relates to
     # @option opts [String] :starting_after Pagination parameter. ID to start after
+    # @option opts [String] :subscription_id
     # @return [InvoiceListResult]
     def list(opts = {})
       path = '/api/invoices'
@@ -95,6 +96,7 @@ module Cryptopay
       query_params = {}
       query_params[:customer_id] = opts[:customer_id] unless opts[:customer_id].nil?
       query_params[:starting_after] = opts[:starting_after] unless opts[:starting_after].nil?
+      query_params[:subscription_id] = opts[:subscription_id] unless opts[:subscription_id].nil?
 
       req = Request.new(
         method: :get,

data/lib/cryptopay/api/subscriptions.rb

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+# Auto-generated file
+# DO NOT EDIT
+
+module Cryptopay
+  class Subscriptions
+    def initialize(connection)
+      @connection = connection
+    end
+
+    # Cancel a subscription
+    # @param subscription_id [String] Subscription ID
+    # @param [Hash] opts the optional parameters
+    # @return [SubscriptionResult]
+    def cancel(subscription_id, _opts = {})
+      path = '/api/subscriptions/{subscription_id}/cancel'
+      path = path.sub('{subscription_id}', CGI.escape(subscription_id.to_s))
+
+      req = Request.new(
+        method: :post,
+        path: path
+      )
+
+      connection.call(req, return_type: SubscriptionResult)
+    end
+
+    # Create a subscription
+    # @param subscription_params [SubscriptionParams]
+    # @param [Hash] opts the optional parameters
+    # @return [SubscriptionResult]
+    def create(subscription_params, _opts = {})
+      path = '/api/subscriptions'
+
+      req = Request.new(
+        method: :post,
+        path: path,
+        body_params: subscription_params
+      )
+
+      connection.call(req, return_type: SubscriptionResult)
+    end
+
+    # List subscriptions
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :starting_after Pagination parameter. ID to start after
+    # @return [SubscriptionListResult]
+    def list(opts = {})
+      path = '/api/subscriptions'
+
+      query_params = {}
+      query_params[:starting_after] = opts[:starting_after] unless opts[:starting_after].nil?
+
+      req = Request.new(
+        method: :get,
+        path: path,
+        query_params: query_params
+      )
+
+      connection.call(req, return_type: SubscriptionListResult)
+    end
+
+    # Retrieve a subscription
+    # @param subscription_id [String] Subscription ID
+    # @param [Hash] opts the optional parameters
+    # @return [SubscriptionResult]
+    def retrieve(subscription_id, _opts = {})
+      path = '/api/subscriptions/{subscription_id}'
+      path = path.sub('{subscription_id}', CGI.escape(subscription_id.to_s))
+
+      req = Request.new(
+        method: :get,
+        path: path
+      )
+
+      connection.call(req, return_type: SubscriptionResult)
+    end
+
+    # Retrieve a subscription by custom_id
+    # @param custom_id [String]
+    # @param [Hash] opts the optional parameters
+    # @return [SubscriptionResult]
+    def retrieve_by_custom_id(custom_id, _opts = {})
+      path = '/api/subscriptions/custom_id/{custom_id}'
+      path = path.sub('{custom_id}', CGI.escape(custom_id.to_s))
+
+      req = Request.new(
+        method: :get,
+        path: path
+      )
+
+      connection.call(req, return_type: SubscriptionResult)
+    end
+
+    private
+
+    attr_reader :connection
+  end
+end

data/lib/cryptopay/client.rb

@@ -12,7 +12,8 @@ module Cryptopay
                 :customers,
                 :risks,
                 :callbacks,
-                :coins
+                :coins,
+                :subscriptions
 
     def initialize(&block)
       config = Config.new(&block)
@@ -34,8 +35,8 @@ 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
   end
 end

data/lib/cryptopay/models/account.rb

@@ -23,6 +23,14 @@ module Cryptopay
     )
     private_constant :ENCODER
 
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Cryptopay::Account] 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 = {})
@@ -71,14 +79,6 @@ module Cryptopay
       invalid_properties.empty?
     end
 
-    # Builds the object from hash
-    # @param [Hash] attributes Model attributes in the form of hash
-    # @return [Cryptopay::Account] 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

data/lib/cryptopay/models/account_list_result.rb

@@ -19,6 +19,14 @@ module Cryptopay
     )
     private_constant :ENCODER
 
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Cryptopay::AccountListResult] 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 = {})
@@ -61,14 +69,6 @@ module Cryptopay
       invalid_properties.empty?
     end
 
-    # Builds the object from hash
-    # @param [Hash] attributes Model attributes in the form of hash
-    # @return [Cryptopay::AccountListResult] 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

data/lib/cryptopay/models/beneficiary.rb

@@ -0,0 +1,97 @@
+# 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`.
+    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
+
+      pattern = Regexp.new(/^[a-zA-Z0-9\s-]+$/)
+      properties.push("invalid value for \"name\", must conform to the pattern #{pattern}.") if name !~ pattern
+
+      properties.push('invalid value for "address", address cannot be nil.') if address.nil?
+
+      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,113 @@
+# 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 = []
+
+      properties.push('invalid value for "country", country cannot be nil.') if country.nil?
+
+      if 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/callback.rb

@@ -10,7 +10,7 @@ module Cryptopay
 
     # Builds the object
     # @param [Mixed] Data to be matched against the list of oneOf items
-    # @return [Cryptopay::ChannelPaymentCallback, Cryptopay::CoinWithdrawalCallback, Cryptopay::InvoiceCallback, nil] Returns the model or nil
+    # @return [Cryptopay::ChannelPaymentCallback, Cryptopay::CoinWithdrawalCallback, Cryptopay::InvoiceCallback, Cryptopay::SubscriptionCallback, nil] Returns the model or nil
     def self.build_from_hash(data)
       case data[DISCRIMINATOR_NAME]
       when 'ChannelPayment'
@@ -19,6 +19,8 @@ module Cryptopay
         CoinWithdrawalCallback.build_from_hash(data)
       when 'Invoice'
         InvoiceCallback.build_from_hash(data)
+      when 'Subscription'
+        SubscriptionCallback.build_from_hash(data)
       end
     end
   end

data/lib/cryptopay/models/channel.rb

@@ -45,6 +45,14 @@ module Cryptopay
     )
     private_constant :ENCODER
 
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Cryptopay::Channel] 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 = {})
@@ -155,14 +163,6 @@ module Cryptopay
       invalid_properties.empty?
     end
 
-    # Builds the object from hash
-    # @param [Hash] attributes Model attributes in the form of hash
-    # @return [Cryptopay::Channel] 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

data/lib/cryptopay/models/channel_list_result.rb

@@ -19,6 +19,14 @@ module Cryptopay
     )
     private_constant :ENCODER
 
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Cryptopay::ChannelListResult] 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 = {})
@@ -61,14 +69,6 @@ module Cryptopay
       invalid_properties.empty?
     end
 
-    # Builds the object from hash
-    # @param [Hash] attributes Model attributes in the form of hash
-    # @return [Cryptopay::ChannelListResult] 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

data/lib/cryptopay/models/channel_params.rb

@@ -29,6 +29,14 @@ module Cryptopay
     )
     private_constant :ENCODER
 
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Cryptopay::ChannelParams] 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 = {})
@@ -92,14 +100,6 @@ module Cryptopay
       invalid_properties.empty?
     end
 
-    # Builds the object from hash
-    # @param [Hash] attributes Model attributes in the form of hash
-    # @return [Cryptopay::ChannelParams] 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