modulr-api 0.0.16 → 0.0.19

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e538f41d8e5d2d64dc75db3ec234e67367b592262530d926c622280d2557f08e
-  data.tar.gz: 91a2fdd93f8ae2afc8cc94aad9a9884af13dc294666257fc16f105cfec7b7372
+  metadata.gz: 151fec1b59fee97d4c008e8c229acdf65fb948a632443a5bf431fd4ab99db5b2
+  data.tar.gz: edb08a27bdc84da31df9c2f3508ca72968546a988924e798ac6a2de0730b70a3
 SHA512:
-  metadata.gz: 35612c3c6b7d42c447b14808f91c23955cb755ccd02759f0fc445568612374c8efabc74fd79b8f2bde46d353b1b2467e07db1de8f823ab6dfe623cde21782700
-  data.tar.gz: 7194973cdbd13a67fcca831c92547df26f9ee0791c35cd64b1ac6d524dc74843dea2684a961de2d0d15d9966baa6dd1e8a526e6e0d7bb50d08490c1aa6ec7ab2
+  metadata.gz: 8c71349b26005bb7185807f5a3d7d7d474f9a71cf672f8f9b5013e1475f3581a886787a2dadc71e22d6f5f7ffc5c3007aee1a1a51f055d7186a7df4b8ad03c2e
+  data.tar.gz: a3519173719b22f64037939faf62c1efabd95fb7768933c37de3034ce74d26224f70ea068b1935f3d66f3cbfa5ea93ec73039043f294e14320a25626237ee3eb

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    modulr-api (0.0.16)
+    modulr-api (0.0.19)
       faraday (~> 1.0)
       faraday_middleware (~> 1.0)
 

data/README.md

@@ -31,6 +31,85 @@ Run `bin/console` for an interactive prompt to experiment with the code.
 ```rb
 # Find a customer
 client.customers.find(id: "C2188C26")
+
+# Create a customer
+client.customers.create(
+    type: "LLC",
+    legal_entity: "GB",
+    external_reference: "My new customer",
+    name: "string",
+    company_reg_number: "2018123987165432",
+    registered_address: {
+        addressLine1: "string",
+        addressLine2: "string",
+        postTown: "string",
+        postCode: "string",
+        country: "GB",
+        countrySubDivision: "string"
+    },
+    trading_address: {
+        addressLine1: "string",
+        addressLine2: "string",
+        postTown: "string",
+        postCode: "string",
+        country: "GB",
+        countrySubDivision: "string"
+    },
+    industry_code: "string",
+    tcs_version: 0,
+    expected_monthly_spend: 0,
+    associates: [
+        {
+            type: "DIRECTOR",
+            firstName: "string",
+            middleName: "string",
+            lastName: "string",
+            dateOfBirth: "string",
+            ownership: 0,
+            homeAddress: {
+                addressLine1: "string",
+                addressLine2: "string",
+                postTown: "string",
+                postCode: "string",
+                country: "GB",
+                countrySubDivision: "string"
+            },
+            applicant: true,
+            email: "string",
+            phone: "string",
+            documentInfo: [
+                {
+                    path: "string",
+                    fileName: "string",
+                    uploadedDate: "2017-01-28T01:01:01+0000"
+                }
+            ],
+            additionalIdentifiers: [
+                {
+                    type: "BSN",
+                    value: "string"
+                }
+            ],
+            complianceData: {
+                relationship: "string"
+            }
+        }
+    ],
+    document_info: [
+        {
+            path: "string",
+            fileName: "string",
+            uploadedDate: "2017-01-28T01:01:01+0000"
+        }
+    ],
+    provisional_customer_id: "string",
+    customer_trust: {
+        trustNature: "BARE_TRUSTS"
+    },
+    tax_profile: {
+        taxIdentifier: "string"
+    }
+)
 ```
 
 ### Accounts

data/lib/modulr/api/accounts_service.rb

@@ -5,7 +5,7 @@ module Modulr
     class AccountsService < Service
       def find(id:)
         response = client.get("/accounts/#{id}")
-        Resources::Accounts::Account.new(response, response.body)
+        Resources::Accounts::Account.new(response.env[:raw_body], response.body)
       end
 
       def create(customer_id:, currency:, product_code:, **opts)
@@ -16,7 +16,7 @@ module Modulr
         payload[:externalReference] = opts[:external_reference] if opts[:external_reference]
 
         response = client.post("/customers/#{customer_id}/accounts", payload)
-        Resources::Accounts::Account.new(response, response.body)
+        Resources::Accounts::Account.new(response.env[:raw_body], response.body)
       end
 
       def close(account_id:)

data/lib/modulr/api/customers_service.rb

@@ -1,12 +1,40 @@
 # frozen_string_literal: true
 
+# rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+
 module Modulr
   module API
     class CustomersService < Service
       def find(id:)
         response = client.get("/customers/#{id}")
-        Resources::Customers::Customer.new(response, response.body)
+        Resources::Customers::Customer.new(response.env[:raw_body], response.body)
+      end
+
+      def create(type:, legal_entity:, **opts)
+        payload = {
+          type: type,
+          legalEntity: legal_entity,
+        }
+
+        payload[:externalReference] = opts[:external_reference] if opts[:external_reference]
+        payload[:name] = opts[:name] if opts[:name]
+        payload[:companyRegNumber] = opts[:company_reg_number] if opts[:company_reg_number]
+        payload[:registeredAddress] = opts[:registered_address] if opts[:registered_address]
+        payload[:tradingAddress] = opts[:trading_address] if opts[:trading_address]
+        payload[:industryCode] = opts[:industry_code] if opts[:industry_code]
+        payload[:tcsVersion] = opts[:tcs_version] if opts[:tcs_version]
+        payload[:expectedMonthlySpend] = opts[:expected_monthly_spend] if opts[:expected_monthly_spend]
+        payload[:associates] = opts[:associates] if opts[:associates]
+        payload[:documentInfo] = opts[:document_info] if opts[:document_info]
+        payload[:provisionalCustomerId] = opts[:provisional_customer_id] if opts[:provisional_customer_id]
+        payload[:customerTrust] = opts[:customer_trust] if opts[:customer_trust]
+        payload[:taxProfile] = opts[:tax_profile] if opts[:tax_profile]
+
+        response = client.post("/customers", payload)
+        Resources::Customers::Customer.new(response.env[:raw_body], response.body)
       end
     end
   end
 end
+
+# rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity

data/lib/modulr/api/notifications_service.rb

@@ -5,12 +5,12 @@ module Modulr
     class NotificationsService < Service
       def find(id:, **opts)
         response = client.get("#{base_notification_url(opts)}/notifications/#{id}")
-        Resources::Notifications::Notification.new(response, response.body)
+        Resources::Notifications::Notification.new(response.env[:raw_body], response.body)
       end
 
       def list(**opts)
         response = client.get("#{base_notification_url(opts)}/notifications")
-        Resources::Notifications::Collection.new(response, response.body)
+        Resources::Notifications::Collection.new(response.env[:raw_body], response.body)
       end
 
       def create(type:, channel:, destinations:, config:, **opts)
@@ -21,7 +21,17 @@ module Modulr
           config: config,
         }
         response = client.post("#{base_notification_url(opts)}/notifications", payload)
-        Resources::Notifications::Notification.new(response, response.body)
+        Resources::Notifications::Notification.new(response.env[:raw_body], response.body)
+      end
+
+      def update(id:, status:, destinations:, config:, **opts)
+        payload = {
+          status: status,
+          destinations: destinations,
+          config: config,
+        }
+        response = client.put("#{base_notification_url(opts)}/notifications/#{id}", payload)
+        Resources::Notifications::Notification.new(response.env[:raw_body], response.body)
       end
 
       protected def base_notification_url(opts)

data/lib/modulr/api/payments_service.rb

@@ -8,14 +8,14 @@ module Modulr
         payment_attributes = response.body[:content]&.first
         raise NotFoundError, "Payment #{id} not found" unless payment_attributes
 
-        Resources::Payments::Payment.new(response, payment_attributes)
+        Resources::Payments::Payment.new(response.env[:raw_body], payment_attributes)
       end
 
       def list(**opts)
         return find(id: opts[:id]) if opts[:id]
 
         response = client.get("/payments", build_query_params(opts))
-        Resources::Payments::Collection.new(response, response.body[:content])
+        Resources::Payments::Collection.new(response.env[:raw_body], response.body[:content])
       end
 
       # rubocop:disable Metrics/ParameterLists
@@ -32,7 +32,7 @@ module Modulr
         payload[:endToEndReference] = opts[:e2e_reference] if opts[:e2e_reference]
 
         response = client.post("/payments", payload)
-        Resources::Payments::Payment.new(response, response.body)
+        Resources::Payments::Payment.new(response.env[:raw_body], response.body)
       end
       # rubocop:enable Metrics/ParameterLists
 

data/lib/modulr/api/transactions_service.rb

@@ -5,7 +5,7 @@ module Modulr
     class TransactionsService < Service
       def list(account_id:, **opts)
         response = client.get("/accounts/#{account_id}/transactions", build_query_params(opts))
-        Resources::Transactions::Transactions.new(response, response.body[:content])
+        Resources::Transactions::Transactions.new(response.env[:raw_body], response.body[:content])
       end
 
       private def build_query_params(opts) # rubocop:disable Metrics/AbcSize

data/lib/modulr/client.rb

@@ -51,6 +51,10 @@ module Modulr
       execute :post, path, data, options
     end
 
+    def put(path, data = nil, options = {})
+      execute :put, path, data, options
+    end
+
     def execute(method, path, data = nil, options = {})
       request(method, path, data, options)
     end

data/lib/modulr/resources/accounts/account.rb

@@ -23,9 +23,9 @@ module Modulr
         map :createdDate, :created_at
         map :directDebit, :direct_debit
 
-        def initialize(response, attributes = {})
-          super(response, attributes)
-          @identifiers = Accounts::Identifiers.new(response, attributes[:identifiers])
+        def initialize(raw_response, attributes = {})
+          super(raw_response, attributes)
+          @identifiers = Accounts::Identifiers.new(nil, attributes[:identifiers])
         end
       end
     end

data/lib/modulr/resources/accounts/identifiers.rb

@@ -4,8 +4,8 @@ module Modulr
   module Resources
     module Accounts
       class Identifiers < BaseCollection
-        def initialize(response, attributes_collection)
-          super(response, Identifier, attributes_collection)
+        def initialize(raw_response, attributes_collection)
+          super(raw_response, Identifier, attributes_collection)
         end
       end
     end

data/lib/modulr/resources/base.rb

@@ -3,10 +3,11 @@
 module Modulr
   module Resources
     class Base
-      attr_reader :response
+      attr_reader :raw_response
+
+      def initialize(raw_response, attributes = {})
+        @raw_response = raw_response
 
-      def initialize(response, attributes = {})
-        @response = response
         attributes.each do |key, value|
           m = "#{key}=".to_sym
           send(m, value) if respond_to?(m)
@@ -34,7 +35,9 @@ require_relative "notifications/notification"
 require_relative "notifications/config"
 require_relative "notifications/collection"
 require_relative "payments/payment"
-require_relative "payments/details"
+require_relative "payments/counterparty"
+require_relative "payments/details/incoming/general"
+require_relative "payments/details/outgoing/general"
 require_relative "payments/destination"
 require_relative "payments/collection"
 require_relative "transactions/transaction"

data/lib/modulr/resources/base_collection.rb

@@ -3,13 +3,14 @@
 module Modulr
   module Resources
     class BaseCollection
+      attr_reader :raw_response
+
       include Enumerable
-      attr_reader :response
 
-      def initialize(response, item_klass, attributes_collection = [])
-        @response = response
+      def initialize(raw_response, item_klass, attributes_collection = [])
+        @raw_response = raw_response
         @attributes_collection = attributes_collection
-        @items = attributes_collection.map { |attributes_item| item_klass.new(response, attributes_item) }
+        @items = attributes_collection.map { |attributes_item| item_klass.new(nil, attributes_item) }
       end
 
       def each(&block)

data/lib/modulr/resources/notifications/collection.rb

@@ -4,8 +4,8 @@ module Modulr
   module Resources
     module Notifications
       class Collection < BaseCollection
-        def initialize(response, attributes_collection)
-          super(response, Notification, attributes_collection)
+        def initialize(raw_response, attributes_collection)
+          super(raw_response, Notification, attributes_collection)
         end
       end
     end

data/lib/modulr/resources/notifications/notification.rb

@@ -12,9 +12,9 @@ module Modulr
         map :status
         map :destinations
 
-        def initialize(response, attributes = {})
-          super(response, attributes)
-          @config = Config.new(response, attributes[:config])
+        def initialize(raw_response, attributes = {})
+          super(raw_response, attributes)
+          @config = Config.new(nil, attributes[:config])
         end
       end
     end

data/lib/modulr/resources/payments/collection.rb

@@ -4,8 +4,8 @@ module Modulr
   module Resources
     module Payments
       class Collection < BaseCollection
-        def initialize(response, attributes_collection)
-          super(response, Payment, attributes_collection)
+        def initialize(raw_response, attributes_collection)
+          super(raw_response, Payment, attributes_collection)
         end
       end
     end

data/lib/modulr/resources/payments/counterparty.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Modulr
+  module Resources
+    module Payments
+      class Counterparty < Base
+        attr_reader :identifier
+
+        map :name
+        map :address
+
+        def initialize(raw_response, attributes = {})
+          super(raw_response, attributes)
+          @identifier = Accounts::Identifier.new(nil, attributes[:identifier])
+        end
+      end
+    end
+  end
+end

data/lib/modulr/resources/payments/details/incoming/general.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Modulr
+  module Resources
+    module Payments
+      module Details
+        module Incoming
+          class General < Base
+            attr_reader :payer, :payee
+
+            map :created, :created_at
+            map :posted, :posted_at
+            map :retryCount, :retry_count
+            map :reprocess
+            map :sourceService, :source_service
+            map :providerCode, :provider_code
+            map :ledgerBankCode, :ledger_bank_code
+            map :clearingRequired, :clearing_required
+            map :requestReference, :request_reference
+            map :accountNumber, :account_number
+            map :type
+            map :amount
+            map :currency
+            map :description
+            map :originalReference, :original_reference
+            map :schemeId, :scheme_id
+            map :schemeType, :scheme_type
+            map :details, :raw_details
+
+            def initialize(raw_response, attributes = {})
+              super(raw_response, attributes)
+              @payer = Counterparty.new(nil, attributes[:payer])
+              @payee = Counterparty.new(nil, attributes[:payee])
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/modulr/resources/payments/details/outgoing/general.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Modulr
+  module Resources
+    module Payments
+      module Details
+        module Outgoing
+          class General < Base
+            attr_reader :destination
+
+            map :sourceAccountId, :source_account_id
+            map :currency
+            map :amount
+            map :reference
+
+            def initialize(raw_response, attributes = {})
+              super(raw_response, attributes)
+              @destination = Destination.new(nil, attributes[:destination])
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/modulr/resources/payments/payment.rb

@@ -13,9 +13,18 @@ module Modulr
         map :createdDate, :created_at
         map :approvalStatus, :approval_status
 
-        def initialize(response, attributes = {})
-          super(response, attributes)
-          @details = Details.new(response, attributes[:details])
+        def initialize(raw_response, attributes = {})
+          super(raw_response, attributes)
+          @details = parse_details(attributes[:details])
+        end
+
+        private def parse_details(details)
+          case details[:type]
+          when "PI_SEPA_INST", "PI_FAST"
+            Details::Incoming::General.new(nil, details)
+          else
+            Details::Outgoing::General.new(nil, details)
+          end
         end
       end
     end

data/lib/modulr/resources/transactions/collection.rb

@@ -4,8 +4,8 @@ module Modulr
   module Resources
     module Transactions
       class Transactions < BaseCollection
-        def initialize(response, attributes_collection)
-          super(response, Transaction, attributes_collection)
+        def initialize(raw_response, attributes_collection)
+          super(raw_response, Transaction, attributes_collection)
         end
       end
     end

data/lib/modulr/resources/transactions/transaction.rb

@@ -18,8 +18,8 @@ module Modulr
         map :sourceExternalReference, :external_reference
         map :additionalInfo, :additional_info
 
-        def initialize(response, attributes = {})
-          super(response, attributes)
+        def initialize(raw_response, attributes = {})
+          super(raw_response, attributes)
 
           @balance = attributes[:account][:balance]
           @available_balance = attributes[:account][:availableBalance]

data/lib/modulr/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Modulr
-  VERSION = "0.0.16"
+  VERSION = "0.0.19"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: modulr-api
 version: !ruby/object:Gem::Version
-  version: 0.0.16
+  version: 0.0.19
 platform: ruby
 authors:
 - Aitor García Rey
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-03-10 00:00:00.000000000 Z
+date: 2023-04-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -223,8 +223,10 @@ files:
 - lib/modulr/resources/notifications/config.rb
 - lib/modulr/resources/notifications/notification.rb
 - lib/modulr/resources/payments/collection.rb
+- lib/modulr/resources/payments/counterparty.rb
 - lib/modulr/resources/payments/destination.rb
-- lib/modulr/resources/payments/details.rb
+- lib/modulr/resources/payments/details/incoming/general.rb
+- lib/modulr/resources/payments/details/outgoing/general.rb
 - lib/modulr/resources/payments/payment.rb
 - lib/modulr/resources/transactions/collection.rb
 - lib/modulr/resources/transactions/transaction.rb
@@ -254,7 +256,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.6
+rubygems_version: 3.4.10
 signing_key: 
 specification_version: 4
 summary: Ruby client for Modulr Finance API.

data/lib/modulr/resources/payments/details.rb

@@ -1,21 +0,0 @@
-# frozen_string_literal: true
-
-module Modulr
-  module Resources
-    module Payments
-      class Details < Base
-        attr_reader :destination
-
-        map :sourceAccountId, :source_account_id
-        map :currency
-        map :amount
-        map :reference
-
-        def initialize(response, attributes = {})
-          super(response, attributes)
-          @destination = Destination.new(response, attributes[:destination])
-        end
-      end
-    end
-  end
-end