komoju-sdk 1.0.0.beta.1

data/docs/SessionsApi.md

@@ -0,0 +1,294 @@
+# Komoju::SessionsApi
+
+All URIs are relative to *https://komoju.com/api/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**cancel_session**](SessionsApi.md#cancel_session) | **POST** /sessions/{id}/cancel | Session: Cancel |
+| [**create_session**](SessionsApi.md#create_session) | **POST** /sessions | Session: Create |
+| [**pay_session**](SessionsApi.md#pay_session) | **POST** /sessions/{id}/pay | Session: Pay |
+| [**show_session**](SessionsApi.md#show_session) | **GET** /sessions/{id} | Session: Show |
+
+## Request Models
+
+- [**CreateSessionRequest**](CreateSessionRequest.md) — used by `create_session`
+- [**PaySessionRequest**](PaySessionRequest.md) — used by `pay_session`
+
+
+## cancel_session
+
+> <Session> cancel_session(id)
+
+Session: Cancel
+
+Cancels a session.
+
+### Examples
+
+```ruby
+require 'time'
+require 'komoju-sdk'
+# setup authorization
+Komoju.configure do |config|
+  # Configure your KOMOJU API key
+  config.api_key = 'YOUR_API_KEY'
+end
+
+api_instance = Komoju::SessionsApi.new
+id = 'id_example' # String | A unique identifier for the session.
+
+begin
+  # Session: Cancel
+  result = api_instance.cancel_session(id)
+  p result
+rescue Komoju::ApiError => e
+  puts "Error when calling SessionsApi->cancel_session: #{e}"
+end
+```
+
+#### Using the cancel_session_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Session>, Integer, Hash)> cancel_session_with_http_info(id)
+
+```ruby
+begin
+  # Session: Cancel
+  data, status_code, headers = api_instance.cancel_session_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Session>
+rescue Komoju::ApiError => e
+  puts "Error when calling SessionsApi->cancel_session_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | A unique identifier for the session. |  |
+
+### Return type
+
+[**Session**](Session.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## create_session
+
+> <Session> create_session(create_session_request)
+
+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.
+
+### Examples
+
+```ruby
+require 'time'
+require 'komoju-sdk'
+# setup authorization
+Komoju.configure do |config|
+  # Configure your KOMOJU API key
+  config.api_key = 'YOUR_API_KEY'
+end
+
+api_instance = Komoju::SessionsApi.new
+create_session_request = Komoju::CreateSessionRequestWithCustomerMode.new({mode: 'customer', amount: 1000, currency: Komoju::Currency::JPY}) # CreateSessionRequest | 
+
+begin
+  # Session: Create
+  result = api_instance.create_session(create_session_request)
+  p result
+rescue Komoju::ApiError => e
+  puts "Error when calling SessionsApi->create_session: #{e}"
+end
+```
+
+#### Using the create_session_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Session>, Integer, Hash)> create_session_with_http_info(create_session_request)
+
+```ruby
+begin
+  # Session: Create
+  data, status_code, headers = api_instance.create_session_with_http_info(create_session_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Session>
+rescue Komoju::ApiError => e
+  puts "Error when calling SessionsApi->create_session_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **create_session_request** | [**CreateSessionRequest**](CreateSessionRequest.md) |  |  |
+
+### Return type
+
+[**Session**](Session.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## pay_session
+
+> <PaySessionResponse> pay_session(id, pay_session_request)
+
+Session: Pay
+
+Provide customer payment details to pay for a session.
+
+### Examples
+
+```ruby
+require 'time'
+require 'komoju-sdk'
+# setup authorization
+Komoju.configure do |config|
+  # Configure your KOMOJU API key
+  config.api_key = 'YOUR_API_KEY'
+end
+
+api_instance = Komoju::SessionsApi.new
+id = 'id_example' # String | A unique identifier for the session.
+pay_session_request = Komoju::PaySessionRequest.new({payment_details: Komoju::PaymentDetailsAU.new({type: 'au'})}) # PaySessionRequest | 
+
+begin
+  # Session: Pay
+  result = api_instance.pay_session(id, pay_session_request)
+  p result
+rescue Komoju::ApiError => e
+  puts "Error when calling SessionsApi->pay_session: #{e}"
+end
+```
+
+#### Using the pay_session_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PaySessionResponse>, Integer, Hash)> pay_session_with_http_info(id, pay_session_request)
+
+```ruby
+begin
+  # Session: Pay
+  data, status_code, headers = api_instance.pay_session_with_http_info(id, pay_session_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PaySessionResponse>
+rescue Komoju::ApiError => e
+  puts "Error when calling SessionsApi->pay_session_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | A unique identifier for the session. |  |
+| **pay_session_request** | [**PaySessionRequest**](PaySessionRequest.md) |  |  |
+
+### Return type
+
+[**PaySessionResponse**](PaySessionResponse.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## show_session
+
+> <Session> show_session(id)
+
+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.
+
+### Examples
+
+```ruby
+require 'time'
+require 'komoju-sdk'
+# setup authorization
+Komoju.configure do |config|
+  # Configure your KOMOJU API key
+  config.api_key = 'YOUR_API_KEY'
+end
+
+api_instance = Komoju::SessionsApi.new
+id = 'id_example' # String | A unique identifier for the session.
+
+begin
+  # Session: Show
+  result = api_instance.show_session(id)
+  p result
+rescue Komoju::ApiError => e
+  puts "Error when calling SessionsApi->show_session: #{e}"
+end
+```
+
+#### Using the show_session_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Session>, Integer, Hash)> show_session_with_http_info(id)
+
+```ruby
+begin
+  # Session: Show
+  data, status_code, headers = api_instance.show_session_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Session>
+rescue Komoju::ApiError => e
+  puts "Error when calling SessionsApi->show_session_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | A unique identifier for the session. |  |
+
+### Return type
+
+[**Session**](Session.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/Settlement.md

@@ -0,0 +1,56 @@
+# Komoju::Settlement
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | A unique 25-character alphanumeric resource identifier. |  |
+| **resource** | **String** | Resource type name, always \"settlement\". |  |
+| **reference** | **String** | Human-readable reference code for this settlement. |  |
+| **status** | [**Status**](Status.md) |  |  |
+| **merchant_name** | **String** | Name of the merchant associated with this settlement. |  |
+| **company_name** | **String** | Legal company name of the merchant. |  |
+| **cycle** | **String** | Settlement cycle identifier (e.g. the week or month period covered). |  |
+| **transaction_amount_cents** | **Integer** | Amount in the lowest denomination of the currency (e.g. cents for USD). |  |
+| **currency** | [**Currency**](Currency.md) |  |  |
+| **fee_amount_cents** | **Integer** | Amount in the lowest denomination of the currency (e.g. cents for USD). |  |
+| **fee_tax_amount_cents** | **Integer** | Amount in the lowest denomination of the currency (e.g. cents for USD). |  |
+| **settlement_amount_cents** | **Integer** | Amount in the lowest denomination of the currency (e.g. cents for USD). |  |
+| **fx_currency** | [**Currency**](Currency.md) |  |  |
+| **fx_conversion_rate** | **String** | Exchange rate applied for FX conversion. |  |
+| **fx_conversion_amount_cents** | **Integer** | Amount in the lowest denomination of the currency (e.g. cents for USD). |  |
+| **bank_transfer_amount_cents** | **Integer** | Amount in the lowest denomination of the currency (e.g. cents for USD). |  |
+| **remittance_amount_cents** | **Integer** | Amount in the lowest denomination of the currency (e.g. cents for USD). |  |
+| **cutoff_time** | **Time** | Cutoff timestamp for transactions included in this settlement. |  |
+| **created_at** | **Time** | Timestamp when this settlement record was created. |  |
+| **download** | [**SettlementDownload**](SettlementDownload.md) |  |  |
+
+## Example
+
+```ruby
+require 'komoju-sdk'
+
+instance = Komoju::Settlement.new(
+  id: null,
+  resource: null,
+  reference: null,
+  status: null,
+  merchant_name: null,
+  company_name: null,
+  cycle: null,
+  transaction_amount_cents: null,
+  currency: null,
+  fee_amount_cents: null,
+  fee_tax_amount_cents: null,
+  settlement_amount_cents: null,
+  fx_currency: null,
+  fx_conversion_rate: null,
+  fx_conversion_amount_cents: null,
+  bank_transfer_amount_cents: null,
+  remittance_amount_cents: null,
+  cutoff_time: null,
+  created_at: null,
+  download: null
+)
+```
+

data/docs/SettlementDownload.md

@@ -0,0 +1,20 @@
+# Komoju::SettlementDownload
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **csv** | **String** | URL to download this settlement in CSV format, or null if unavailable. |  |
+| **xls** | **String** | URL to download this settlement in XLS format, or null if unavailable. |  |
+
+## Example
+
+```ruby
+require 'komoju-sdk'
+
+instance = Komoju::SettlementDownload.new(
+  csv: null,
+  xls: null
+)
+```
+

data/docs/SettlementFrequency.md

@@ -0,0 +1,15 @@
+# Komoju::SettlementFrequency
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'komoju-sdk'
+
+instance = Komoju::SettlementFrequency.new()
+```
+

data/docs/SettlementList.md

@@ -0,0 +1,32 @@
+# Komoju::SettlementList
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **resource** | **String** | Resource type name, always \"settlement_list\". |  |
+| **data** | [**Array<Settlement>**](Settlement.md) | Array of settlement objects for this page. |  |
+| **start_time** | **Time** | Start of the time range for records in this response. |  |
+| **end_time** | **Time** | End of the time range for records in this response. |  |
+| **total** | **Integer** | Total number of records matching the query. |  |
+| **page** | **Integer** | Current page number. |  |
+| **per_page** | **Integer** | Number of results per page. |  |
+| **last_page** | **Integer** | Last available page number. |  |
+
+## Example
+
+```ruby
+require 'komoju-sdk'
+
+instance = Komoju::SettlementList.new(
+  resource: null,
+  data: null,
+  start_time: null,
+  end_time: null,
+  total: null,
+  page: null,
+  per_page: null,
+  last_page: null
+)
+```
+

data/docs/SettlementShow.md

@@ -0,0 +1,70 @@
+# Komoju::SettlementShow
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | A unique 25-character alphanumeric resource identifier. |  |
+| **resource** | **String** | Resource type name, always \"settlement\". |  |
+| **reference** | **String** | Human-readable reference code for this settlement. |  |
+| **status** | [**Status**](Status.md) |  |  |
+| **merchant_name** | **String** | Name of the merchant associated with this settlement. |  |
+| **company_name** | **String** | Legal company name of the merchant. |  |
+| **cycle** | **String** | Settlement cycle identifier (e.g. the week or month period covered). |  |
+| **transaction_amount_cents** | **Integer** | Amount in the lowest denomination of the currency (e.g. cents for USD). |  |
+| **currency** | [**Currency**](Currency.md) |  |  |
+| **fee_amount_cents** | **Integer** | Amount in the lowest denomination of the currency (e.g. cents for USD). |  |
+| **fee_tax_amount_cents** | **Integer** | Amount in the lowest denomination of the currency (e.g. cents for USD). |  |
+| **settlement_amount_cents** | **Integer** | Amount in the lowest denomination of the currency (e.g. cents for USD). |  |
+| **fx_currency** | [**Currency**](Currency.md) |  |  |
+| **fx_conversion_rate** | **String** | Exchange rate applied for FX conversion. |  |
+| **fx_conversion_amount_cents** | **Integer** | Amount in the lowest denomination of the currency (e.g. cents for USD). |  |
+| **bank_transfer_amount_cents** | **Integer** | Amount in the lowest denomination of the currency (e.g. cents for USD). |  |
+| **remittance_amount_cents** | **Integer** | Amount in the lowest denomination of the currency (e.g. cents for USD). |  |
+| **cutoff_time** | **Time** | Cutoff timestamp for transactions included in this settlement. |  |
+| **created_at** | **Time** | Timestamp when this settlement record was created. |  |
+| **download** | [**SettlementDownload**](SettlementDownload.md) |  |  |
+| **payments** | [**SharedDetailsPayments**](SharedDetailsPayments.md) |  |  |
+| **refunds** | [**SharedDetailsRefunds**](SharedDetailsRefunds.md) |  |  |
+| **platform_model** | [**SharedDetailsPlatformModel**](SharedDetailsPlatformModel.md) |  | [optional] |
+| **corrections** | [**SharedDetailsCorrections**](SharedDetailsCorrections.md) |  |  |
+| **komoju_card_charges** | [**SharedDetailsCorrections**](SharedDetailsCorrections.md) |  |  |
+| **disbursements** | [**SharedDetailsDisbursements**](SharedDetailsDisbursements.md) |  |  |
+| **misc** | [**SharedDetailsMisc**](SharedDetailsMisc.md) |  |  |
+
+## Example
+
+```ruby
+require 'komoju-sdk'
+
+instance = Komoju::SettlementShow.new(
+  id: null,
+  resource: null,
+  reference: null,
+  status: null,
+  merchant_name: null,
+  company_name: null,
+  cycle: null,
+  transaction_amount_cents: null,
+  currency: null,
+  fee_amount_cents: null,
+  fee_tax_amount_cents: null,
+  settlement_amount_cents: null,
+  fx_currency: null,
+  fx_conversion_rate: null,
+  fx_conversion_amount_cents: null,
+  bank_transfer_amount_cents: null,
+  remittance_amount_cents: null,
+  cutoff_time: null,
+  created_at: null,
+  download: null,
+  payments: null,
+  refunds: null,
+  platform_model: null,
+  corrections: null,
+  komoju_card_charges: null,
+  disbursements: null,
+  misc: null
+)
+```
+