komoju-sdk 1.0.0.beta.1

data/spec/api/platform_model_api_spec.rb

@@ -0,0 +1,394 @@
+=begin
+#KOMOJU API
+
+#Full featured access to the KOMOJU payments system.
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.9.0
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for Komoju::PlatformModelApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'PlatformModelApi' do
+  before do
+    # run before each test
+    @api_instance = Komoju::PlatformModelApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of PlatformModelApi' do
+    it 'should create an instance of PlatformModelApi' do
+      expect(@api_instance).to be_instance_of(Komoju::PlatformModelApi)
+    end
+  end
+
+  # unit tests for balance_transfer
+  # Balance: Transfer
+  # Transfers funds from the currently authenticated merchant's balance to another associated merchant for the given `currency`.
+  # @param currency 
+  # @param balance_transfer_request 
+  # @param [Hash] opts the optional parameters
+  # @return [Transfer]
+  describe 'balance_transfer test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for create_file
+  # File: Create
+  # Creates a new file for the current merchant.
+  # @param merchant_id 
+  # @param create_file_request 
+  # @param [Hash] opts the optional parameters
+  # @return [MerchantFile]
+  describe 'create_file test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for create_merchant
+  # Merchant: Create
+  # Creates a new merchant.
+  # @param create_merchant_request 
+  # @param [Hash] opts the optional parameters
+  # @return [SerializedSubmerchant]
+  describe 'create_merchant test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for create_merchant_balance_transfer
+  # Balance: Transfer
+  # Creates a balance transfer between associated merchants for a given `amount` and `currency`.
+  # @param merchant_id 
+  # @param currency 
+  # @param create_merchant_balance_transfer_request 
+  # @param [Hash] opts the optional parameters
+  # @return [BalanceTransferServiceRecord]
+  describe 'create_merchant_balance_transfer test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for edit_merchant_balance_settings
+  # Balances: Edit Settings
+  # Given a currency, edit the payout settings of the currently authenticated merchant or one of its sub-merchants.
+  # @param merchant_id 
+  # @param currency 
+  # @param edit_merchant_balance_settings_request 
+  # @param [Hash] opts the optional parameters
+  # @return [MerchantBalance]
+  describe 'edit_merchant_balance_settings test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for list_live_application_payment_methods
+  # Live Application: Payment Methods
+  # List submitted/unsubmitted payment methods
+  # @param merchant_id 
+  # @param [Hash] opts the optional parameters
+  # @option opts [Locale] :locale 
+  # @return [PaymentMethodsList]
+  describe 'list_live_application_payment_methods test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for list_merchants
+  # Merchant: List
+  # Retrieves a paginated list of sub-merchants. Results can be filtered by `live` status, `platform_role`, account `status`, and whether payments or payouts are enabled.
+  # @param [Hash] opts the optional parameters
+  # @option opts [Time] :start_time Query for records created after this time.
+  # @option opts [Time] :end_time Query for records created before this time.
+  # @option opts [Integer] :per_page How many objects per page.
+  # @option opts [Integer] :page Page number to query for.
+  # @option opts [Boolean] :live 
+  # @option opts [MerchantRole] :platform_role 
+  # @option opts [String] :status 
+  # @option opts [Boolean] :payments_enabled 
+  # @option opts [Boolean] :payouts_enabled 
+  # @return [SubmerchantsList]
+  describe 'list_merchants test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for list_submerchant_payments
+  # Payment: List for Merchant
+  # Retrieves a paginated list of payments. Pagination can be configured with `page` and `per_page` parameters.  Payments can be filtered by `currency`, `external_order_num`, and `status`.  A time range can be specified with `start_time`, and `end_time`.
+  # @param merchant_id 
+  # @param [Hash] opts the optional parameters
+  # @option opts [Time] :start_time Query for records created after this time.
+  # @option opts [Time] :end_time Query for records created before this time.
+  # @option opts [Integer] :per_page How many objects per page.
+  # @option opts [Integer] :page Page number to query for.
+  # @option opts [Currency] :currency 
+  # @option opts [String] :external_order_num 
+  # @option opts [PaymentStatus] :status 
+  # @return [PlatformMerchantPaymentList]
+  describe 'list_submerchant_payments test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for list_submerchant_settlements
+  # Settlement: List
+  # Lists out past settlements from most-recent to least-recent.
+  # @param merchant_id 
+  # @param [Hash] opts the optional parameters
+  # @return [SettlementList]
+  describe 'list_submerchant_settlements test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for merchant_balance_transactions
+  # Balance: Transactions
+  # Given a currency, view the ledger transactions of the currently authenticated merchant or one of its sub-merchants. Will split ledger transactions into line items when appropriate.
+  # @param merchant_id 
+  # @param currency 
+  # @param [Hash] opts the optional parameters
+  # @option opts [Time] :start_time Query for records created after this time.
+  # @option opts [Time] :end_time Query for records created before this time.
+  # @option opts [Integer] :per_page How many objects per page.
+  # @option opts [Integer] :page Page number to query for.
+  # @option opts [String] :type 
+  # @return [BalanceTransactionList]
+  describe 'merchant_balance_transactions test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for show_file
+  # File: Show
+  # Retrieves an existing file of the current merchant.
+  # @param merchant_id 
+  # @param id 
+  # @param [Hash] opts the optional parameters
+  # @return [MerchantFile]
+  describe 'show_file test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for show_live_application
+  # Live Application: Show
+  # Shows the live application status of the applicant merchant
+  # @param merchant_id 
+  # @param [Hash] opts the optional parameters
+  # @option opts [Locale] :locale 
+  # @return [LiveApplicationWithSubmittedFields]
+  describe 'show_live_application test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for show_live_application_payment_method
+  # Live Application: Show Payment Method
+  # Shows the payment method status of the applicant merchant
+  # @param merchant_id 
+  # @param payment_method 
+  # @param [Hash] opts the optional parameters
+  # @option opts [Locale] :locale 
+  # @return [LiveApplicationWithSubmittedFields]
+  describe 'show_live_application_payment_method test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for show_merchant
+  # Merchant: Show
+  # Retrieves the details of a sub-merchant by its `id`, including account settings, payout configuration, and live status.
+  # @param id 
+  # @param [Hash] opts the optional parameters
+  # @return [SerializedSubmerchant]
+  describe 'show_merchant test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for show_merchant_balance
+  # Balance: Show
+  # Given a currency, view the unsettled balance of the currently authenticated merchant or one of its sub-merchants.
+  # @param merchant_id 
+  # @param currency 
+  # @param [Hash] opts the optional parameters
+  # @return [BalanceShow]
+  describe 'show_merchant_balance test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for show_merchant_balance_settings
+  # Balance: Show Settings
+  # Given a currency, view the payout settings of the currently authenticated merchant or one of its sub-merchants.
+  # @param merchant_id 
+  # @param currency 
+  # @param [Hash] opts the optional parameters
+  # @return [BalanceSettings]
+  describe 'show_merchant_balance_settings test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for show_merchant_balance_transaction
+  # Balance: Transaction
+  # Given a currency and a transaction UUID, view the corresponding ledger transaction of the currently authenticated merchant or one of its sub-merchants. Will return one entry per line item of the transaction.
+  # @param merchant_id 
+  # @param currency 
+  # @param transaction_uuid 
+  # @param [Hash] opts the optional parameters
+  # @return [Array<Transaction>]
+  describe 'show_merchant_balance_transaction test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for show_submerchant_settlement
+  # Settlement: Show
+  # View a settlement given an &#x60;id&#x60;.
+  # @param merchant_id 
+  # @param id 
+  # @param [Hash] opts the optional parameters
+  # @return [SettlementShow]
+  describe 'show_submerchant_settlement test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for simulate_live_application_payment_method_status
+  # Live Application: Simulate Payment Method Status
+  # Simulate status change on payment method for test merchants
+  # @param merchant_id 
+  # @param payment_method 
+  # @param simulate_live_application_payment_method_status_request 
+  # @param [Hash] opts the optional parameters
+  # @return [PaymentMethodStatus]
+  describe 'simulate_live_application_payment_method_status test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for simulate_live_application_status
+  # Live Application: Simulate Status
+  # Simulate status change on applications for test merchants. In order for status to be changed to \&quot;accepted,\&quot; at least one payment method must be approved.
+  # @param merchant_id 
+  # @param simulate_live_application_payment_method_status_request 
+  # @param [Hash] opts the optional parameters
+  # @return [MerchantSubmissionStatus]
+  describe 'simulate_live_application_status test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for submerchant_settlement_csv
+  # Settlement: CSV
+  # View a settlement in CSV format given an &#x60;id&#x60;.
+  # @param merchant_id 
+  # @param id 
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'submerchant_settlement_csv test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for submerchant_settlement_pdf
+  # Settlement: PDF
+  # View a settlement in PDF format given an &#x60;id&#x60;.
+  # @param merchant_id 
+  # @param id 
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'submerchant_settlement_pdf test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for submerchant_settlement_xls
+  # Settlement: XLS
+  # View a settlement in XLS format given an &#x60;id&#x60;.
+  # @param merchant_id 
+  # @param id 
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'submerchant_settlement_xls test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for update_live_application
+  # Live Application: Update
+  # Updates the live application for the applicant merchant
+  # @param merchant_id 
+  # @param live_application_request 
+  # @param [Hash] opts the optional parameters
+  # @return [LiveApplication]
+  describe 'update_live_application test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for update_live_application_payment_method
+  # Live Application: Update Payment Method
+  # Update the payment method application of the applicant merchant
+  # @param merchant_id 
+  # @param payment_method 
+  # @param update_payment_method_request 
+  # @param [Hash] opts the optional parameters
+  # @return [LiveApplication]
+  describe 'update_live_application_payment_method test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for update_merchant
+  # Merchant: Update
+  # Updates a sub-merchant&#39;s settings, including payment and payout toggles, email notification preferences, and payment method expiry settings.
+  # @param id 
+  # @param update_merchant_request 
+  # @param [Hash] opts the optional parameters
+  # @return [SerializedSubmerchant]
+  describe 'update_merchant test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end

data/spec/api/secure_tokens_api_spec.rb

@@ -0,0 +1,59 @@
+=begin
+#KOMOJU API
+
+#Full featured access to the KOMOJU payments system.
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.9.0
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for Komoju::SecureTokensApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'SecureTokensApi' do
+  before do
+    # run before each test
+    @api_instance = Komoju::SecureTokensApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of SecureTokensApi' do
+    it 'should create an instance of SecureTokensApi' do
+      expect(@api_instance).to be_instance_of(Komoju::SecureTokensApi)
+    end
+  end
+
+  # unit tests for create_secure_token
+  # SecureToken: Create
+  # Creates a SecureToken with the given credit card `payment_details` or `customer` ID.  There are two ways to create a SecureToken:  - Using `payment_details` with credit card information. - Using `customer` ID, which is a unique identifier for a customer created via the [Customer: Create](https://doc.komoju.com/reference/createcustomer) endpoint. Customer's saved payment details will be used as `payment_details`.  It is recommended to have a client application make this request directly so that sensitive payment information (e.g. credit card number) doesn't hit your server. Receiving credit card numbers requires your business to be PCI-DSS compliant. Once you create a secure token using a customer's credit card details, you can redirect the customer to the authentication url to perform 3DS authentication. Once a secure token has been authenticated, the secure token id can safely be sent to your server and used as `payment_details` to a future KOMOJU API request.
+  # @param create_secure_token_request 
+  # @param [Hash] opts the optional parameters
+  # @return [SecureToken]
+  describe 'create_secure_token test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for show_secure_token
+  # SecureToken: Show
+  # Retrieves a single SecureToken object by its `id`.
+  # @param id A unique identifier for the SecureToken.
+  # @param [Hash] opts the optional parameters
+  # @return [SecureToken]
+  describe 'show_secure_token test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end

data/spec/api/sessions_api_spec.rb

@@ -0,0 +1,84 @@
+=begin
+#KOMOJU API
+
+#Full featured access to the KOMOJU payments system.
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.9.0
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for Komoju::SessionsApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'SessionsApi' do
+  before do
+    # run before each test
+    @api_instance = Komoju::SessionsApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of SessionsApi' do
+    it 'should create an instance of SessionsApi' do
+      expect(@api_instance).to be_instance_of(Komoju::SessionsApi)
+    end
+  end
+
+  # unit tests for cancel_session
+  # Session: Cancel
+  # Cancels a session.
+  # @param id A unique identifier for the session.
+  # @param [Hash] opts the optional parameters
+  # @return [Session]
+  describe 'cancel_session test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for create_session
+  # Session: Create
+  # Creates a session. There're 3 modes for the session:  * `payment`: A payment will be created after user completed the session (default). * `customer`: A customer will be created instead of a payment, or updated if `customer_id` is given. This customer resource can then be used to perform delayed billing or subscriptions. * `customer_payment`: A payment will be created, and customer will be created or updated. You can use this mode to charge money upfront and save customer's payment details in one go.
+  # @param create_session_request 
+  # @param [Hash] opts the optional parameters
+  # @return [Session]
+  describe 'create_session test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for pay_session
+  # Session: Pay
+  # Provide customer payment details to pay for a session.
+  # @param id A unique identifier for the session.
+  # @param pay_session_request 
+  # @param [Hash] opts the optional parameters
+  # @return [PaySessionResponse]
+  describe 'pay_session test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for show_session
+  # Session: Show
+  # Retrieves a Session given its ID.  A Session's status changes when the user completes or cancels their payment. You can listen for those events via webhooks, or use this API to poll for changes.
+  # @param id A unique identifier for the session.
+  # @param [Hash] opts the optional parameters
+  # @return [Session]
+  describe 'show_session test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end

data/spec/api/settlements_api_spec.rb

@@ -0,0 +1,111 @@
+=begin
+#KOMOJU API
+
+#Full featured access to the KOMOJU payments system.
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.9.0
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for Komoju::SettlementsApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'SettlementsApi' do
+  before do
+    # run before each test
+    @api_instance = Komoju::SettlementsApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of SettlementsApi' do
+    it 'should create an instance of SettlementsApi' do
+      expect(@api_instance).to be_instance_of(Komoju::SettlementsApi)
+    end
+  end
+
+  # unit tests for list_settlements
+  # Settlement: Index
+  # Retrieves a paginated list of settlements from most-recent to least-recent. Pagination can be configured with `page` and `per_page` parameters.
+  # @param [Hash] opts the optional parameters
+  # @option opts [Time] :start_time Query for records created after this time.
+  # @option opts [Time] :end_time Query for records created before this time.
+  # @option opts [Integer] :per_page How many objects per page.
+  # @option opts [Integer] :page Page number to query for.
+  # @return [SettlementList]
+  describe 'list_settlements test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for show_settlement
+  # Settlement: Show
+  # Retrieves a single settlement by its `id`, including a breakdown of payments, refunds, fees, corrections, and disbursements.
+  # @param id 
+  # @param [Hash] opts the optional parameters
+  # @return [SettlementShow]
+  describe 'show_settlement test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for show_settlement_csv
+  # Settlement: CSV
+  # Retrieves the settlement in CSV format.
+  # @param id 
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'show_settlement_csv test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for show_settlement_pdf
+  # Settlement: PDF
+  # Retrieves the settlement in PDF format.
+  # @param id 
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'show_settlement_pdf test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for show_settlement_xls
+  # Settlement: XLS
+  # Retrieves the settlement in XLS format.
+  # @param id 
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'show_settlement_xls test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for show_transaction
+  # Balance: Transaction
+  # Retrieves a single ledger transaction by its UUID for the given currency.
+  # @param currency 
+  # @param transaction_uuid 
+  # @param [Hash] opts the optional parameters
+  # @return [Transaction]
+  describe 'show_transaction test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end