checkout_sdk 0.3.2 → 1.0.0.beta.0

data/lib/checkout_sdk/disputes/dispute_evidence_request.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Disputes
+    # @!attribute proof_of_delivery_or_service_file
+    #   @return [String]
+    # @!attribute proof_of_delivery_or_service_text
+    #   @return [String]
+    # @!attribute invoice_or_receipt_file
+    #   @return [String]
+    # @!attribute invoice_or_receipt_text
+    #   @return [String]
+    # @!attribute invoice_showing_distinct_transactions_file
+    #   @return [String]
+    # @!attribute invoice_showing_distinct_transactions_text
+    #   @return [String]
+    # @!attribute customer_communication_file
+    #   @return [String]
+    # @!attribute customer_communication_text
+    #   @return [String]
+    # @!attribute refund_or_cancellation_policy_file
+    #   @return [String]
+    # @!attribute refund_or_cancellation_policy_text
+    #   @return [String]
+    # @!attribute recurring_transaction_agreement_file
+    #   @return [String]
+    # @!attribute recurring_transaction_agreement_text
+    #   @return [String]
+    # @!attribute invoice_showing_distinct_transactions_file
+    #   @return [String]
+    # @!attribute invoice_showing_distinct_transactions_text
+    #   @return [String]
+    # @!attribute additional_evidence_file
+    #   @return [String]
+    # @!attribute additional_evidence_text
+    #   @return [String]
+    # @!attribute proof_of_delivery_or_service_date_file
+    #   @return [String]
+    # @!attribute proof_of_delivery_or_service_date_text
+    #   @return [String]
+    class DisputeEvidenceRequest
+      attr_accessor :proof_of_delivery_or_service_file,
+                    :proof_of_delivery_or_service_text,
+                    :invoice_or_receipt_file,
+                    :invoice_or_receipt_text,
+                    :invoice_showing_distinct_transactions_file,
+                    :invoice_showing_distinct_transactions_text,
+                    :customer_communication_file,
+                    :customer_communication_text,
+                    :refund_or_cancellation_policy_file,
+                    :refund_or_cancellation_policy_text,
+                    :recurring_transaction_agreement_file,
+                    :recurring_transaction_agreement_text,
+                    :additional_evidence_file,
+                    :additional_evidence_text,
+                    :proof_of_delivery_or_service_date_file,
+                    :proof_of_delivery_or_service_date_text
+    end
+  end
+end

data/lib/checkout_sdk/disputes/dispute_status.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Disputes
+    module DisputeStatus
+      WON = 'won'
+      LOST = 'lost'
+      EXPIRED = 'expired'
+      ACCEPTED = 'accepted'
+      CANCELED = 'canceled'
+      RESOLVED = 'resolved'
+      ARBITRATION_WON = 'arbitration_won'
+      ARBITRATION_LOST = 'arbitration_lost'
+      EVIDENCE_REQUIRED = 'evidence_required'
+      EVIDENCE_UNDER_REVIEW = 'evidence_under_review'
+      ARBITRATION_UNDER_REVIEW = 'arbitration_under_review'
+    end
+  end
+end

data/lib/checkout_sdk/disputes/disputes.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require 'checkout_sdk/disputes/dispute_evidence_request'
+require 'checkout_sdk/disputes/dispute_status'
+require 'checkout_sdk/disputes/disputes_client'
+require 'checkout_sdk/disputes/disputes_query_filter'

data/lib/checkout_sdk/disputes/disputes_client.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Disputes
+    class DisputesClient < Client
+      DISPUTES = 'disputes'
+      FILES = 'files'
+      ACCEPT = 'accept'
+      EVIDENCE = 'evidence'
+      private_constant :DISPUTES, :FILES, :ACCEPT, :EVIDENCE
+
+      # @param [ApiClient] api_client
+      # @param [CheckoutConfiguration] configuration
+      def initialize(api_client, configuration)
+        super api_client, configuration, CheckoutSdk::AuthorizationType::SECRET_KEY_OR_OAUTH
+      end
+
+      # @param [DisputesQueryFilter] disputes_query_filter
+      def query(disputes_query_filter)
+        api_client.invoke_get(DISPUTES, sdk_authorization, disputes_query_filter)
+      end
+
+      # @param [String] dispute_id
+      def get_dispute_details(dispute_id)
+        api_client.invoke_get(build_path(DISPUTES, dispute_id), sdk_authorization)
+      end
+
+      # @param [String] dispute_id
+      def accept(dispute_id)
+        api_client.invoke_post(build_path(DISPUTES, dispute_id, ACCEPT), sdk_authorization)
+      end
+
+      # @param [String] dispute_id
+      # @param [DisputeEvidence] dispute_evidence
+      def put_evidence(dispute_id, dispute_evidence)
+        api_client.invoke_put(build_path(DISPUTES, dispute_id, EVIDENCE), sdk_authorization, dispute_evidence)
+      end
+
+      # @param [String] dispute_id
+      def get_evidence(dispute_id)
+        api_client.invoke_get(build_path(DISPUTES, dispute_id, EVIDENCE), sdk_authorization)
+      end
+
+      # @param [String] dispute_id
+      def submit_evidence(dispute_id)
+        api_client.invoke_post(build_path(DISPUTES, dispute_id, EVIDENCE), sdk_authorization)
+      end
+
+      # @param [CheckoutSdk::Common::FileRequest] file_request
+      def upload_file(file_request)
+        api_client.submit_file(FILES, sdk_authorization, file_request)
+      end
+    end
+  end
+end

data/lib/checkout_sdk/disputes/disputes_query_filter.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Disputes
+    # @!attribute limit
+    #   @return [Integer]
+    # @!attribute skip
+    #   @return [Integer]
+    # @!attribute from
+    #   @return [DateTime]
+    # @!attribute to
+    #   @return [DateTime]
+    # @!attribute id
+    #   @return [String]
+    # @!attribute statuses
+    #   @return [String] {DisputeStatus}
+    # @!attribute payment_id
+    #   @return [String]
+    # @!attribute payment_reference
+    #   @return [String]
+    # @!attribute payment_arn
+    #   @return [String]
+    # @!attribute this_channel_only
+    #   @return [TrueClass, FalseClass]
+    # @!attribute entity_ids
+    #   @return [String]
+    # @!attribute sub_entity_ids
+    #   @return [String]
+    # @!attribute payment_mcc
+    #   @return [String]
+    class DisputesQueryFilter
+      attr_accessor :limit,
+                    :skip,
+                    :from,
+                    :to,
+                    :id,
+                    :statuses,
+                    :payment_id,
+                    :payment_reference,
+                    :payment_arn,
+                    :this_channel_only,
+                    :entity_ids,
+                    :sub_entity_ids,
+                    :payment_mcc
+    end
+  end
+end

data/lib/checkout_sdk/environment.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  # @!attribute base_uri
+  #   @return [String]
+  # @!attribute authorization_uri
+  #   @return [String]
+  # @!attribute files_uri
+  #   @return [String]
+  # @!attribute transfers_uri
+  #   @return [String]
+  # @!attribute balances_uri
+  #   @return [String]
+  # @!attribute is_sandbox
+  #   @return [String]
+  class Environment
+    attr_reader :base_uri,
+                :authorization_uri,
+                :files_uri,
+                :transfers_uri,
+                :balances_uri,
+                :is_sandbox
+
+    # @param [String] base_uri
+    # @param [String] authorization_uri
+    # @param [String] files_uri
+    # @param [String] transfers_uri
+    # @param [String] balances_uri
+    # @param [TrueClass, FalseClass] is_sandbox
+    def initialize(base_uri, authorization_uri, files_uri, transfers_uri, balances_uri, is_sandbox)
+      @base_uri = base_uri
+      @authorization_uri = authorization_uri
+      @files_uri = files_uri
+      @transfers_uri = transfers_uri
+      @balances_uri = balances_uri
+      @is_sandbox = is_sandbox
+    end
+
+    # @return [CheckoutSdk::Environment]
+    def self.sandbox
+      Environment.new('https://api.sandbox.checkout.com/',
+                      'https://access.sandbox.checkout.com/connect/token',
+                      'https://files.sandbox.checkout.com/',
+                      'https://transfers.sandbox.checkout.com/',
+                      'https://balances.sandbox.checkout.com/',
+                      true)
+    end
+
+    # @return [CheckoutSdk::Environment]
+    def self.production
+      Environment.new('https://api.checkout.com/',
+                      'https://access.checkout.com/connect/token',
+                      'https://files.checkout.com/',
+                      'https://transfers.checkout.com/',
+                      'https://balances.checkout.com/',
+                      false)
+    end
+  end
+end

data/lib/checkout_sdk/error.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  class CheckoutException < StandardError
+  end
+
+  class CheckoutArgumentException < CheckoutException; end
+
+  class CheckoutAuthorizationException < CheckoutException
+    def self.invalid_authorization(authorization_type)
+      CheckoutAuthorizationException.new("Operation requires #{authorization_type} authorization type")
+    end
+
+    def self.invalid_key(key_type)
+      CheckoutAuthorizationException.new("#{key_type} is required for this operation.")
+    end
+  end
+
+  class CheckoutApiException < CheckoutException
+    attr_reader :http_metadata, :error_details
+
+    def initialize(response)
+      @http_metadata = CheckoutUtils.map_to_http_metadata(response)
+      if !http_metadata.body.nil? && http_metadata.body != ''
+        @error_details = JSON.parse(http_metadata.body, object_class: OpenStruct)
+      end
+      super("The API response status code (#{http_metadata.status_code}) does not indicate success.")
+    end
+  end
+end

data/lib/checkout_sdk/forex/forex.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require 'checkout_sdk/forex/quote_request'
+require 'checkout_sdk/forex/forex_client'

data/lib/checkout_sdk/forex/forex_client.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Forex
+    class ForexClient < Client
+      FOREX = 'forex/quotes'
+      private_constant :FOREX
+
+      # @param [ApiClient] api_client
+      # @param [CheckoutConfiguration] configuration
+      def initialize(api_client, configuration)
+        super(api_client, configuration, CheckoutSdk::AuthorizationType::OAUTH)
+      end
+
+      # @param [QuoteRequest] quote_request
+      def request_quote(quote_request)
+        api_client.invoke_post(FOREX, sdk_authorization, quote_request)
+      end
+    end
+  end
+end

data/lib/checkout_sdk/forex/quote_request.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Forex
+    # @!attribute source_currency
+    #   @return [String] {CheckoutSdk::Common::Currency}
+    # @!attribute source_amount
+    #   @return [Integer]
+    # @!attribute destination_currency
+    #   @return [String] {CheckoutSdk::Common::Currency}
+    # @!attribute destination_amount
+    #   @return [Integer]
+    # @!attribute process_channel_id
+    #   @return [String]
+    class QuoteRequest
+      attr_accessor :source_currency,
+                    :source_amount,
+                    :destination_currency,
+                    :destination_amount,
+                    :process_channel_id
+    end
+  end
+end

data/lib/checkout_sdk/http_metadata.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  class HttpMetadata
+    attr_accessor :body,
+                  :status_code,
+                  :headers
+  end
+end

data/lib/checkout_sdk/instruments/create/instrument_bank_account_request.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Instruments
+    # @!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 processing_channel_id
+    #   @return [String]
+    # @!attribute account_holder
+    #   @return [CheckoutSdk::Common::AccountHolder]
+    # @!attribute bank
+    #   @return [CheckoutSdk::Common::BankDetails]
+    # @!attribute customer
+    #   @return [CheckoutSdk::Common::CustomerRequest]
+    class InstrumentBankAccountRequest < InstrumentRequest
+      attr_accessor :account_type,
+                    :account_number,
+                    :bank_code,
+                    :branch_code,
+                    :iban,
+                    :bban,
+                    :swift_bic,
+                    :currency,
+                    :country,
+                    :processing_channel_id,
+                    :account_holder,
+                    :bank,
+                    :customer
+
+      def initialize
+        super CheckoutSdk::Common::InstrumentType::BANK_ACCOUNT
+      end
+    end
+  end
+end

data/lib/checkout_sdk/instruments/create/instrument_request.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Instruments
+    # @!attribute type
+    #   @return [String] {CheckoutSdk::Common::InstrumentType}
+    class InstrumentRequest
+      attr_reader :type
+
+      # @abstract
+      # @param [String]  {CheckoutSdk::Common::InstrumentType}
+      def initialize(type)
+        @type = type
+      end
+    end
+  end
+end

data/lib/checkout_sdk/instruments/create/instrument_token_request.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Instruments
+    # @!attribute token
+    #   @return [String]
+    # @!attribute account_holder
+    #   @return [CheckoutSdk::Common::AccountHolder]
+    # @!attribute customer
+    #   @return [CheckoutSdk::Common::CustomerRequest]
+    class InstrumentTokenRequest < InstrumentRequest
+      attr_accessor :token,
+                    :account_holder,
+                    :customer
+
+      def initialize
+        super CheckoutSdk::Common::InstrumentType::TOKEN
+      end
+    end
+  end
+end

data/lib/checkout_sdk/instruments/get/bank_account_field_query.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Instruments
+    # @!attribute account_holder_type
+    #   @return [String] {CheckoutSdk::Common::AccountHolderType}
+    # @!attribute payment_network
+    #   @return [String] {PaymentNetwork}
+    class BankAccountFieldQuery
+      attr_accessor :account_holder_type,
+                    :payment_network
+    end
+  end
+end

data/lib/checkout_sdk/instruments/get/payment_network.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Instruments
+    module PaymentNetwork
+      LOCAL = 'local'
+      SEPA = 'sepa'
+      FPS = 'Fps'
+      ACH = 'Ach'
+      FEDWIRE = 'Fedwire'
+      SWIFT = 'Swift'
+    end
+  end
+end

data/lib/checkout_sdk/instruments/instruments.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+# Update
+require 'checkout_sdk/instruments/update/update_instrument_request'
+require 'checkout_sdk/instruments/update/update_instrument_card_request'
+require 'checkout_sdk/instruments/update/update_instrument_bank_account_request'
+require 'checkout_sdk/instruments/update/update_instrument_token_request'
+# Get
+require 'checkout_sdk/instruments/get/payment_network'
+require 'checkout_sdk/instruments/get/bank_account_field_query'
+# Create
+require 'checkout_sdk/instruments/create/instrument_request'
+require 'checkout_sdk/instruments/create/instrument_token_request'
+require 'checkout_sdk/instruments/create/instrument_bank_account_request'
+require 'checkout_sdk/instruments/instruments_client'

data/lib/checkout_sdk/instruments/instruments_client.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Instruments
+    class InstrumentsClient < Client
+      INSTRUMENTS = 'instruments'
+      VALIDATION = 'validation/bank-accounts'
+      private_constant :INSTRUMENTS, :VALIDATION
+
+      # @param [ApiClient] api_client
+      # @param [CheckoutConfiguration] configuration
+      def initialize(api_client, configuration)
+        super api_client, configuration, CheckoutSdk::AuthorizationType::SECRET_KEY_OR_OAUTH
+      end
+
+      # @param [CustomerRequest] create_instrument_request
+      def create(create_instrument_request)
+        api_client.invoke_post(INSTRUMENTS, sdk_authorization, create_instrument_request)
+      end
+
+      # @param [String] instrument_id
+      def get(instrument_id)
+        api_client.invoke_get(build_path(INSTRUMENTS, instrument_id), sdk_authorization)
+      end
+
+      # @param [String] instrument_id
+      # @param [UpdateInstrumentRequest] update_instrument_request
+      def update(instrument_id, update_instrument_request)
+        api_client.invoke_patch(build_path(INSTRUMENTS, instrument_id),
+                                sdk_authorization,
+                                update_instrument_request)
+      end
+
+      # @param [String] instrument_id
+      def delete(instrument_id)
+        api_client.invoke_delete(build_path(INSTRUMENTS, instrument_id), sdk_authorization)
+      end
+
+      # @param [String] country {CheckoutSdk::Common::Country}
+      # @param [String] currency {CheckoutSdk::Common::Currency}
+      # @param [BankAccountFieldQuery] bank_account_field_query
+      def get_bank_account_field_formatting(country, currency, bank_account_field_query)
+        api_client.invoke_get(build_path(VALIDATION, country, currency),
+                              sdk_authorization(CheckoutSdk::AuthorizationType::OAUTH),
+                              bank_account_field_query)
+      end
+    end
+  end
+end

data/lib/checkout_sdk/instruments/update/update_instrument_bank_account_request.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Instruments
+    # @!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 processing_channel_id
+    #   @return [String]
+    # @!attribute account_holder
+    #   @return [CheckoutSdk::Common::AccountHolder]
+    # @!attribute bank
+    #   @return [CheckoutSdk::Common::BankDetails]
+    # @!attribute customer
+    #   @return [CheckoutSdk::Common::CustomerRequest]
+    class UpdateInstrumentBankAccountRequest < UpdateInstrumentRequest
+      attr_accessor :account_type,
+                    :account_number,
+                    :bank_code,
+                    :branch_code,
+                    :iban,
+                    :bban,
+                    :swift_bic,
+                    :currency,
+                    :country,
+                    :processing_channel_id,
+                    :account_holder,
+                    :bank,
+                    :customer
+
+      def initialize
+        super CheckoutSdk::Common::InstrumentType::BANK_ACCOUNT
+      end
+    end
+  end
+end

data/lib/checkout_sdk/instruments/update/update_instrument_card_request.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Instruments
+    # @!attribute expiry_month
+    #   @return [Integer]
+    # @!attribute expiry_year
+    #   @return [Integer]
+    # @!attribute name
+    #   @return [String]
+    # @!attribute account_holder
+    #   @return [CheckoutSdk::Common::AccountHolder]
+    # @!attribute customer
+    #   @return [CheckoutSdk::Common::UpdateCustomerRequest]
+    class UpdateInstrumentCardRequest < UpdateInstrumentRequest
+      attr_accessor :expiry_month,
+                    :expiry_year,
+                    :name,
+                    :account_holder,
+                    :customer
+
+      def initialize
+        super CheckoutSdk::Common::InstrumentType::CARD
+      end
+    end
+  end
+end

data/lib/checkout_sdk/instruments/update/update_instrument_request.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Instruments
+    # @!attribute type
+    #   @return [String] {CheckoutSdk::Common::InstrumentType}
+    class UpdateInstrumentRequest
+      attr_reader :type
+
+      # @abstract
+      # @param [String]  {CheckoutSdk::Common::InstrumentType}
+      def initialize(type)
+        @type = type
+      end
+    end
+  end
+end

data/lib/checkout_sdk/instruments/update/update_instrument_token_request.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Instruments
+    # @!attribute token
+    #   @return [String]
+    class UpdateInstrumentTokenRequest < UpdateInstrumentRequest
+      attr_accessor :token
+
+      def initialize
+        super CheckoutSdk::Common::InstrumentType::TOKEN
+      end
+    end
+  end
+end