checkout_sdk 1.0.0.beta.1 → 1.0.0.beta.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a0d976eb888dbeda40a8ece1c8701d3ba7c1cec555699c5953b425c092a3d9b9
-  data.tar.gz: 44ae834bdb42d042f082030b87137261be0a48188d33f8b6c1864e96ea215787
+  metadata.gz: 4986ebc42cf3d03320a66dcaaed808ab1bac043d80cfaa6a67ecc4ba3412fab5
+  data.tar.gz: 954c730bb43ea3cb5b48479879ef602d87312dbbf182ae0d03e97b14b4ecdccb
 SHA512:
-  metadata.gz: f6a38b94c47462ec0837b57be1ac13c4c916acf8eb2360126f9ef4b3a93667fe281ceb0945209ff51d6d72edde1ca1e4596166a75044cdeb3f5a6c5808d48042
-  data.tar.gz: 270e249ce92268f2346f4da01b3a79e83148ff871a8584844db05fdf60ef786fc6051c22f58d94d3d314e800760d5207d7a43b223b307c261638cb3f20bd28af
+  metadata.gz: 8ab5a0ca6991b63ce2eac3d8084009d4fe9e465908db604c795e6f7c5f53c0b64fbc6b45fb7d29aeaacb604e49a8f5d0c2d8f04522bf1fe3db7e7139b42a80de
+  data.tar.gz: c19f5b743b9b51c8f375c980d018b30461aeabee0ae4a5d57536374360cb465aad61d355dd70a30d03e39c6f66ec0f1530aa31938991fb1bfd6d632a30cfb744

data/.rubocop.yml

@@ -22,6 +22,9 @@ Metrics/ParameterLists:
 Metrics/ClassLength:
   Max: 110
 
+Metrics/CyclomaticComplexity:
+  Max: 8
+
 Style/Documentation:
   Enabled: false
 

data/README.md

@@ -113,6 +113,63 @@ All the API responses that do not fall in the 2** status codes will cause a `Che
 exception
 encapsulates the `http_metadata` and a map of `error_details`, if available.
 
+## Custom Http Client
+
+Ruby SDK supports your own configuration for `http client` using `Faraday::Connection` object, you can pass
+through the
+SDK instantiation as follows:
+
+```ruby
+http_client = Faraday.new do |conn|
+  conn.options.timeout = 10
+  conn.proxy "http://localhost:8080"
+end
+
+api = CheckoutSdk.builder
+                 .static_keys
+                 .with_secret_key('secret_key')
+                 .with_public_key('public_key') # optional, only required for operations related with tokens
+                 .with_environment(CheckoutSdk::Environment.sandbox)
+                 .with_http_client(http_client)
+                 .build
+```
+
+You don't need to specify the URL for Faraday constructor the SDK grabs the belong URI from `CheckoutSdk::Environment`
+however if you want to
+use specific URI's without a proxy you can create the `Environment` object as follows.
+
+```ruby
+environment = CheckoutSdk::Environment.new('https://the.base.uri/', # the uri for all CKO operations
+                                           'https://the.oauth.uri/connect/token', # the uri used for OAUTH authorization, only required for OAuth operations
+                                           'https://the.files.uri/', # the uri used for Files operations, only required for Accounts module
+                                           'https://the.transfers.uri/', # the uri used for Transfer operations, only required for Transfers module
+                                           'https://the.balances.uri/', # the uri used for Balances operations, only required for Balances module
+                                           false)
+```
+
+If you want to provide your own `http client` and wants to use the `upload_file` functionality from `Disputes` or `Accounts` modules, you
+also need to specify the custom `http client` for `multipart requests`:
+
+```ruby
+http_client = Faraday.new do |conn|
+  conn.options.timeout = 10
+  conn.proxy "http://localhost:8080"
+end
+
+multipart_client = Faraday.new do |f|
+  f.request :multipart
+end
+
+api = CheckoutSdk.builder
+                 .static_keys
+                 .with_secret_key('secret_key')
+                 .with_public_key('public_key') # optional, only required for operations related with tokens
+                 .with_environment(CheckoutSdk::Environment.sandbox)
+                 .with_http_client(http_client)
+                 .with_multipart_http_client(multipart_client)
+                 .build
+```
+
 ## Building from source
 
 Once you check out the code from GitHub, the project can be built using gem:

data/lib/checkout_sdk/abstract_checkout_sdk_builder.rb

@@ -5,8 +5,10 @@ module CheckoutSdk
     # @!attribute environment
     #   @return [Environment]
     # @!attribute http_client
-    #   @return [Object]
-    attr_accessor :environment, :http_client
+    #   @return [Faraday::Connection]
+    # @!attribute multipart_http_client
+    #   @return [Faraday::Connection]
+    attr_accessor :environment, :http_client, :multipart_http_client
 
     # @param [Environment] environment
     def with_environment(environment)
@@ -14,15 +16,34 @@ module CheckoutSdk
       self
     end
 
+    # @param [Faraday::Connection] http_client
     def with_http_client(http_client)
       @http_client = http_client
       self
     end
 
+    # @param [Faraday::Connection] multipart_http_client
+    def with_multipart_http_client(multipart_http_client)
+      @multipart_http_client = multipart_http_client
+      self
+    end
+
     def build
       with_environment(Environment.sandbox) if environment.nil?
-      raise CheckoutArgumentException, 'HttpClient must be an instance of Faraday::Connection' \
-      if !http_client.nil? && !@http_client.instance_of?(Faraday::Connection)
+      if http_client.nil?
+        @http_client = CheckoutUtils.build_default_client
+      else
+        unless @http_client.instance_of?(Faraday::Connection)
+          raise CheckoutArgumentException, 'http_client must be an instance of Faraday::Connection'
+        end
+      end
+      if multipart_http_client.nil?
+        @multipart_http_client = CheckoutUtils.build_multipart_client
+      else
+        unless @multipart_http_client.instance_of?(Faraday::Connection)
+          raise CheckoutArgumentException, 'multipart_http_client must be an instance of Faraday::Connection'
+        end
+      end
     end
   end
 end

data/lib/checkout_sdk/accounts/account_holder.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Accounts
+    # @!attribute type
+    #   @return [String] {CheckoutSdk::Common::AccountHolderType}
+    # @!attribute tax_id
+    #   @return [String]
+    # @!attribute date_of_birth
+    #   @return [DateOfBirth]
+    # @!attribute country_of_birth
+    #   @return [String] {CheckoutSdk::Common::Country}
+    # @!attribute residential_status
+    #   @return [String]
+    # @!attribute billing_address
+    #   @return [CheckoutSdk::Common::Address]
+    # @!attribute phone
+    #   @return [Phone]
+    # @!attribute identification
+    #   @return [CheckoutSdk::Common::AccountHolderIdentification]
+    # @!attribute email
+    #   @return [String]
+    class AccountHolder
+      attr_accessor :type,
+                    :tax_id,
+                    :date_of_birth,
+                    :country_of_birth,
+                    :residential_status,
+                    :billing_address,
+                    :phone,
+                    :identification,
+                    :email
+    end
+  end
+end

data/lib/checkout_sdk/accounts/accounts.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require 'checkout_sdk/accounts/update_schedule'
+require 'checkout_sdk/accounts/instrument_document'
+require 'checkout_sdk/accounts/schedule_frequency_type'
+require 'checkout_sdk/accounts/identification'
+require 'checkout_sdk/accounts/document'
+require 'checkout_sdk/accounts/individual'
+require 'checkout_sdk/accounts/business_type'
+require 'checkout_sdk/accounts/account_holder'
+require 'checkout_sdk/accounts/entity_financial_details'
+require 'checkout_sdk/accounts/file_request'
+require 'checkout_sdk/accounts/date_of_birth'
+require 'checkout_sdk/accounts/onboard_entity'
+require 'checkout_sdk/accounts/representative'
+require 'checkout_sdk/accounts/place_of_birth'
+require 'checkout_sdk/accounts/payment_instrument'
+require 'checkout_sdk/accounts/entity_document'
+require 'checkout_sdk/accounts/profile'
+require 'checkout_sdk/accounts/accounts_client'
+require 'checkout_sdk/accounts/entity_financial_documents'
+require 'checkout_sdk/accounts/document_type'
+require 'checkout_sdk/accounts/company'
+require 'checkout_sdk/accounts/phone'
+require 'checkout_sdk/accounts/contact_details'
+require 'checkout_sdk/accounts/entity_email_addresses'
+require 'checkout_sdk/accounts/schedule_request'
+require 'checkout_sdk/accounts/schedule_frequency_weekly'
+require 'checkout_sdk/accounts/schedule_frequency_daily'
+require 'checkout_sdk/accounts/schedule_frequency_monthly'

data/lib/checkout_sdk/accounts/accounts_client.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Accounts
+    class AccountsClient < Client
+      attr_reader :files_client
+
+      ACCOUNTS = 'accounts'
+      ENTITIES = 'entities'
+      INSTRUMENT = 'instruments'
+      PAYOUT_SCHEDULE = 'payout-schedules'
+      FILES = 'files'
+      private_constant :ACCOUNTS, :ENTITIES, :INSTRUMENT, :PAYOUT_SCHEDULE, :FILES
+
+      # @param [ApiClient] api_client
+      # @param [ApiClient] files_client
+      # @param [CheckoutConfiguration] configuration
+      def initialize(api_client, files_client, configuration)
+        super(api_client, configuration, CheckoutSdk::AuthorizationType::OAUTH)
+        @files_client = files_client
+      end
+
+      # @param [OnboardEntity] entity_request
+      def create_entity(entity_request)
+        api_client.invoke_post(build_path(ACCOUNTS, ENTITIES), sdk_authorization, entity_request)
+      end
+
+      # @param [String] entity_id
+      def get_entity(entity_id)
+        api_client.invoke_get(build_path(ACCOUNTS, ENTITIES, entity_id), sdk_authorization)
+      end
+
+      # @param [String] entity_id
+      # @param [OnboardEntity] entity_request
+      def update_entity(entity_id, entity_request)
+        api_client.invoke_put(build_path(ACCOUNTS, ENTITIES, entity_id), sdk_authorization, entity_request)
+      end
+
+      # @param [String] entity_id
+      # @param [PaymentInstrument] payment_instrument
+      def create_payment_instrument(entity_id, payment_instrument)
+        api_client.invoke_post(build_path(ACCOUNTS, ENTITIES, entity_id, INSTRUMENT), sdk_authorization,
+                               payment_instrument)
+      end
+
+      # @param [String] entity_id
+      # @param [String] currency {CheckoutSdk::Common::Currency}
+      # @param [UpdateSchedule] update_schedule
+      def update_payout_schedule(entity_id, currency, update_schedule)
+        api_client.invoke_put(build_path(ACCOUNTS, ENTITIES, entity_id, PAYOUT_SCHEDULE), sdk_authorization,
+                              { currency => update_schedule })
+      end
+
+      # @param [String] entity_id
+      def retrieve_payout_schedule(entity_id)
+        api_client.invoke_get(build_path(ACCOUNTS, ENTITIES, entity_id, PAYOUT_SCHEDULE), sdk_authorization)
+      end
+
+      # @param [FileRequest] file_request
+      def upload_file(file_request)
+        files_client.submit_file(FILES, sdk_authorization, file_request)
+      end
+    end
+  end
+end

data/lib/checkout_sdk/accounts/business_type.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Accounts
+    module BusinessType
+      GENERAL_PARTNERSHIP = 'general_partnership'
+      LIMITED_PARTNERSHIP = 'limited_partnership'
+      PUBLIC_LIMITED_COMPANY = 'public_limited_company'
+      LIMITED_COMPANY = 'limited_company'
+      PROFESSIONAL_ASSOCIATION = 'professional_association'
+      UNINCORPORATED_ASSOCIATION = 'unincorporated_association'
+      AUTO_ENTREPRENEUR = 'auto_entrepreneur'
+    end
+  end
+end

data/lib/checkout_sdk/accounts/company.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Accounts
+    # @!attribute business_registration_number
+    #   @return [String]
+    # @!attribute business_type
+    #   @return [String] {BusinessType}
+    # @!attribute legal_name
+    #   @return [String]
+    # @!attribute trading_name
+    #   @return [String]
+    # @!attribute principal_address
+    #   @return [CheckoutSdk::Common::Address]
+    # @!attribute registered_address
+    #   @return [CheckoutSdk::Common::Address]
+    # @!attribute representatives
+    #   @return [Array(Representative)]
+    # @!attribute document
+    #   @return [EntityDocument]
+    # @!attribute financial_details
+    #   @return [EntityFinancialDetails]
+    class Company
+      attr_accessor :business_registration_number,
+                    :business_type,
+                    :legal_name,
+                    :trading_name,
+                    :principal_address,
+                    :registered_address,
+                    :representatives,
+                    :document,
+                    :financial_details
+    end
+  end
+end

data/lib/checkout_sdk/accounts/contact_details.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Accounts
+    # @!attribute phone
+    #   @return [Phone]
+    # @!attribute email_addresses
+    #   @return [EntityEmailAddresses]
+    class ContactDetails
+      attr_accessor :phone,
+                    :email_addresses
+    end
+  end
+end

data/lib/checkout_sdk/accounts/date_of_birth.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Accounts
+    # @!attribute day
+    #   @return [Integer]
+    # @!attribute month
+    #   @return [Integer]
+    # @!attribute year
+    #   @return [Integer]
+    class DateOfBirth
+      attr_accessor :day,
+                    :month,
+                    :year
+    end
+  end
+end

data/lib/checkout_sdk/accounts/document.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Accounts
+    # @!attribute type
+    #   @return [String] {DocumentType}
+    # @!attribute front
+    #   @return [String]
+    # @!attribute back
+    #   @return [String]
+    class Document
+      attr_accessor :type,
+                    :front,
+                    :back
+    end
+  end
+end

data/lib/checkout_sdk/accounts/document_type.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Accounts
+    module DocumentType
+      PASSPORT = 'passport'
+      NATIONAL_IDENTITY_CARD = 'national_identity_card'
+      DRIVING_LICENSE = 'driving_license'
+      CITIZEN_CARD = 'citizen_card'
+      RESIDENCE_PERMIT = 'residence_permit'
+      ELECTORAL_ID = 'electoral_id'
+    end
+  end
+end

data/lib/checkout_sdk/accounts/entity_document.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Accounts
+    # @!attribute type
+    #   @return [String]
+    # @!attribute file_id
+    #   @return [String]
+    class EntityDocument
+      attr_accessor :type,
+                    :file_id
+    end
+  end
+end

data/lib/checkout_sdk/accounts/entity_email_addresses.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Accounts
+    # @!attribute primary
+    #   @return [String]
+    class EntityEmailAddresses
+      attr_accessor :primary
+    end
+  end
+end

data/lib/checkout_sdk/accounts/entity_financial_details.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Accounts
+    # @!attribute annual_processing_volume
+    #   @return [Integer]
+    # @!attribute average_transaction_value
+    #   @return [Integer]
+    # @!attribute highest_transaction_value
+    #   @return [Integer]
+    # @!attribute documents
+    #   @return [EntityFinancialDocuments]
+    class EntityFinancialDetails
+      attr_accessor :annual_processing_volume,
+                    :average_transaction_value,
+                    :highest_transaction_value,
+                    :documents
+    end
+  end
+end

data/lib/checkout_sdk/accounts/entity_financial_documents.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Accounts
+    # @!attribute bank_statement
+    #   @return [EntityDocument]
+    # @!attribute financial_statement
+    #   @return [EntityDocument]
+    class EntityFinancialDocuments
+      attr_accessor :bank_statement,
+                    :financial_statement
+    end
+  end
+end

data/lib/checkout_sdk/accounts/file_request.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Accounts
+    class FileRequest < CheckoutSdk::Common::FileRequest
+    end
+  end
+end

data/lib/checkout_sdk/accounts/identification.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Accounts
+    # @!attribute national_id_number
+    #   @return [String]
+    # @!attribute document
+    #   @return [Document]
+    class Identification
+      attr_accessor :national_id_number,
+                    :document
+    end
+  end
+end

data/lib/checkout_sdk/accounts/individual.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Accounts
+    # @!attribute first_name
+    #   @return [String]
+    # @!attribute middle_name
+    #   @return [String]
+    # @!attribute last_name
+    #   @return [String]
+    # @!attribute legal_name
+    #   @return [String]
+    # @!attribute trading_name
+    #   @return [String]
+    # @!attribute national_tax_id
+    #   @return [String]
+    # @!attribute registered_address
+    #   @return [CheckoutSdk::Common::Address]
+    # @!attribute date_of_birth
+    #   @return [DateOfBirth]
+    # @!attribute place_of_birth
+    #   @return [PlaceOfBirth]
+    # @!attribute identification
+    #   @return [Identification]
+    class Individual
+      attr_accessor :first_name,
+                    :middle_name,
+                    :last_name,
+                    :legal_name,
+                    :trading_name,
+                    :national_tax_id,
+                    :registered_address,
+                    :date_of_birth,
+                    :place_of_birth,
+                    :identification
+    end
+  end
+end

data/lib/checkout_sdk/accounts/instrument_document.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Accounts
+    # @!attribute type
+    #   @return [String]
+    # @!attribute file_id
+    #   @return [String]
+    class InstrumentDocument
+      attr_accessor :type,
+                    :file_id
+    end
+  end
+end

data/lib/checkout_sdk/accounts/onboard_entity.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Accounts
+    # @!attribute reference
+    #   @return [String]
+    # @!attribute contact_details
+    #   @return [ContactDetails]
+    # @!attribute profile
+    #   @return [Profile]
+    # @!attribute company
+    #   @return [Company]
+    # @!attribute individual
+    #   @return [Individual]
+    class OnboardEntity
+      attr_accessor :reference,
+                    :contact_details,
+                    :profile,
+                    :company,
+                    :individual
+    end
+  end
+end

data/lib/checkout_sdk/accounts/payment_instrument.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Accounts
+    # @!attribute type
+    #   @return [String] {CheckoutSdk::Common::InstrumentType}
+    # @!attribute label
+    #   @return [String]
+    # @!attribute account_type
+    #   @return [String] {CheckoutSdk::Common::AccountType}
+    # @!attribute account_number
+    #   @return [String]
+    # @!attribute bank_code
+    #   @return [String]
+    # @!attribute branch_code
+    #   @return [String]
+    # @!attribute iban
+    #   @return [String]
+    # @!attribute bban
+    #   @return [String]
+    # @!attribute swift_bic
+    #   @return [String]
+    # @!attribute currency
+    #   @return [String] {CheckoutSdk::Common::Currency}
+    # @!attribute country
+    #   @return [String] {CheckoutSdk::Common::Country}
+    # @!attribute document
+    #   @return [InstrumentDocument]
+    # @!attribute bank
+    #   @return [BankDetails]
+    # @!attribute account_holder
+    #   @return [AccountHolder]
+    class PaymentInstrument
+      attr_accessor :type,
+                    :label,
+                    :account_type,
+                    :account_number,
+                    :bank_code,
+                    :branch_code,
+                    :iban,
+                    :bban,
+                    :swift_bic,
+                    :currency,
+                    :country,
+                    :document,
+                    :bank,
+                    :account_holder
+    end
+  end
+end

data/lib/checkout_sdk/accounts/phone.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Accounts
+    # @!attribute number
+    #   @return [String]
+    class Phone
+      attr_accessor :number
+    end
+  end
+end

data/lib/checkout_sdk/accounts/place_of_birth.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Accounts
+    # @!attribute country
+    #   @return [String] {CheckoutSdk::Common::Country}
+    class PlaceOfBirth
+      attr_accessor :country
+    end
+  end
+end

data/lib/checkout_sdk/accounts/profile.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Accounts
+    # @!attribute urls
+    #   @return [Array(String)]
+    # @!attribute mccs
+    #   @return [Array(String)]
+    # @!attribute default_holding_currency
+    #   @return [String] {CheckoutSdk::Common::Currency}
+    class Profile
+      attr_accessor :urls,
+                    :mccs,
+                    :default_holding_currency
+    end
+  end
+end