cryptopay-ruby 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fb93a5d512a5c50963761dae68e58c82f02d97ac0b645f3a9850ed0c098d30a0
-  data.tar.gz: 0b2590bd8ddebe472f255fd777214fb095f182b28ba05ea993df4217b10dcf98
+  metadata.gz: 18a89097b66be19ae3889c0c2279574f5b2aa917d6d66a5ace4547cd2877538b
+  data.tar.gz: b259cd7c0ef3ebe5e8457118533e3abeb5bd2c033f14b549657c7fcc844015dd
 SHA512:
-  metadata.gz: 502490fdeb6d82851be75a541838219ee3058de3836ee1abb8381b8fe3df1236cc71e8149d27f38fb76907fd1f777ea9fab1a596d3efec5a0a3b2e8574d87660
-  data.tar.gz: 3aaaa5115bee1d8983a756bd59425e656ce7a1f1607fbd324803c09e1cbccd3aa897f021f71992e8fa0286c1724a6cad7b3b20aa51d413b20be97c73b63666aa
+  metadata.gz: 7f4a1fa54fd517d1288a386e115ac2634293c95d0fb1af44e1e4f6af51671d215a42dd51bb4fc5fce201533f3992703a5104e24ef378830e67dfc4bafe704c67
+  data.tar.gz: 411446bfe02bbf5ccac2c906524451bce90c0348ade8da2751038cf8abb707ca916426ed041bc1a8509a835a5473c20e594c3d4e5b0cd1b73c05b2bb344ee8c4

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
 

data/README.md

@@ -20,6 +20,7 @@ For more information, please visit [Cryptopay API docs](https://developers.crypt
    * [Invoices](#invoices)
    * [Rates](#rates)
    * [Risks](#risks)
+   * [Subscriptions](#subscriptions)
    * [Transactions](#transactions)
 * [Callbacks](#callbacks)
 * [Development](#development)
@@ -486,6 +487,65 @@ result = client.risks.score(params)
 p result # => <RiskResult data=...>
 ```
 
+### Subscriptions
+
+
+#### Cancel a subscription
+
+
+```ruby
+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.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
 
 [Transactions API docs](https://developers.cryptopay.me/guides/transactions)

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)
@@ -25,7 +26,7 @@ module Cryptopay
 
     private
 
-    def setup_apis(connection)
+    def setup_apis(connection) # rubocop:disable Metrics/MethodLength
       @invoices = Invoices.new(connection)
       @rates = Rates.new(connection)
       @coin_withdrawals = CoinWithdrawals.new(connection)
@@ -36,6 +37,7 @@ module Cryptopay
       @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/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

data/lib/cryptopay/models/channel_payment.rb

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

@@ -21,6 +21,14 @@ module Cryptopay
     )
     private_constant :ENCODER
 
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Cryptopay::ChannelPaymentCallback] 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 = {})
@@ -67,14 +75,6 @@ module Cryptopay
       invalid_properties.empty?
     end
 
-    # Builds the object from hash
-    # @param [Hash] attributes Model attributes in the form of hash
-    # @return [Cryptopay::ChannelPaymentCallback] 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_payment_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::ChannelPaymentListResult] 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::ChannelPaymentListResult] 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_payment_result.rb

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

@@ -17,6 +17,14 @@ module Cryptopay
     )
     private_constant :ENCODER
 
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Cryptopay::ChannelResult] 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 = {})
@@ -47,14 +55,6 @@ module Cryptopay
       invalid_properties.empty?
     end
 
-    # Builds the object from hash
-    # @param [Hash] attributes Model attributes in the form of hash
-    # @return [Cryptopay::ChannelResult] 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_update_params.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::ChannelUpdateParams] 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 = {})
@@ -66,14 +74,6 @@ module Cryptopay
       invalid_properties.empty?
     end
 
-    # Builds the object from hash
-    # @param [Hash] attributes Model attributes in the form of hash
-    # @return [Cryptopay::ChannelUpdateParams] 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/channels_config.rb

@@ -17,6 +17,14 @@ module Cryptopay
     )
     private_constant :ENCODER
 
+    # 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
+
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
     def initialize(attributes = {})
@@ -43,14 +51,6 @@ module Cryptopay
       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

data/lib/cryptopay/models/coin.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::Coin] 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 = {})
@@ -73,14 +81,6 @@ module Cryptopay
       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