komoju-sdk 1.0.0.beta.1

data/docs/SimulateLiveApplicationPaymentMethodStatusRequest.md

@@ -0,0 +1,18 @@
+# Komoju::SimulateLiveApplicationPaymentMethodStatusRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **status** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'komoju-sdk'
+
+instance = Komoju::SimulateLiveApplicationPaymentMethodStatusRequest.new(
+  status: null
+)
+```
+

data/docs/StatementDescriptor.md

@@ -0,0 +1,26 @@
+# Komoju::StatementDescriptor
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **statement_descriptor** | **String** | Full statement descriptor in Japanese or English. | [optional] |
+| **statement_descriptor_alpha** | **String** | Statement descriptor in alphanumeric characters. | [optional] |
+| **statement_descriptor_kana** | **String** | Statement descriptor in katakana characters. | [optional] |
+| **statement_city** | **String** | Name of the city to be shown on the statement. | [optional] |
+| **contact_phone** | **String** | Contact phone number to be shown on the statement. | [optional] |
+
+## Example
+
+```ruby
+require 'komoju-sdk'
+
+instance = Komoju::StatementDescriptor.new(
+  statement_descriptor: 株式会社KOMOJU,
+  statement_descriptor_alpha: KOMOJU,
+  statement_descriptor_kana: コモジュ,
+  statement_city: Tokyo,
+  contact_phone: 0312345678
+)
+```
+

data/docs/Status.md

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

data/docs/Submerchant.md

@@ -0,0 +1,22 @@
+# Komoju::Submerchant
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **submerchant_id** | **String** | A unique 25-character alphanumeric merchant identifier. |  |
+| **amount** | **Integer** | The amount with tax included, greater than or equal to 0, in the lowest denomination of the currency (e.g. cents for USD). |  |
+| **platform_fee** | **Integer** | The platform fee amount, tax included, greater than or equal to 0, in the lowest denomination of the currency (e.g. cents for USD). |  |
+
+## Example
+
+```ruby
+require 'komoju-sdk'
+
+instance = Komoju::Submerchant.new(
+  submerchant_id: submerc1od2nc89s6u5hh6x4g,
+  amount: 900,
+  platform_fee: 100
+)
+```
+

data/docs/SubmerchantListItem.md

@@ -0,0 +1,36 @@
+# Komoju::SubmerchantListItem
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Unique identifier for this sub-merchant. |  |
+| **live** | **Boolean** | Whether this merchant is operating in live (production) mode. |  |
+| **created_at** | **Time** | Timestamp when this merchant was created. |  |
+| **updated_at** | **Time** | Timestamp when this merchant record was last updated. |  |
+| **account_id** | **String** | Account identifier associated with this merchant. |  |
+| **name** | **String** | Display name of the sub-merchant. |  |
+| **platform_role** | [**MerchantRole**](MerchantRole.md) |  |  |
+| **status** | **String** | Account application status of the merchant. |  |
+| **payments_enabled** | **Boolean** | Whether payments are enabled for this merchant. |  |
+| **payouts_enabled** | **Boolean** | Whether payouts are enabled for this merchant. |  |
+
+## Example
+
+```ruby
+require 'komoju-sdk'
+
+instance = Komoju::SubmerchantListItem.new(
+  id: null,
+  live: null,
+  created_at: null,
+  updated_at: null,
+  account_id: null,
+  name: null,
+  platform_role: null,
+  status: null,
+  payments_enabled: null,
+  payouts_enabled: null
+)
+```
+

data/docs/SubmerchantsList.md

@@ -0,0 +1,28 @@
+# Komoju::SubmerchantsList
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **resource** | **String** | Resource type name for this list. |  |
+| **total** | **Integer** | Amount greater than or equal to 0, in the lowest denomination of the currency (e.g. cents for USD). |  |
+| **page** | **Integer** | Amount greater than or equal to 0, in the lowest denomination of the currency (e.g. cents for USD). |  |
+| **per_page** | **Integer** | Amount greater than or equal to 0, in the lowest denomination of the currency (e.g. cents for USD). |  |
+| **last_page** | **Integer** | Amount greater than or equal to 0, in the lowest denomination of the currency (e.g. cents for USD). |  |
+| **data** | [**Array<SubmerchantListItem>**](SubmerchantListItem.md) | Array of sub-merchant list items for this page. |  |
+
+## Example
+
+```ruby
+require 'komoju-sdk'
+
+instance = Komoju::SubmerchantsList.new(
+  resource: null,
+  total: null,
+  page: null,
+  per_page: null,
+  last_page: null,
+  data: null
+)
+```
+

data/docs/SubmittedField.md

@@ -0,0 +1,30 @@
+# Komoju::SubmittedField
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **field_type** | **String** | The input type for this field (e.g. \"text\", \"file\", \"boolean\"). |  |
+| **field** | **String** | Machine-readable key name of the field. |  |
+| **field_name** | **String** | Human-readable display name of the field. |  |
+| **field_properties** | [**FieldFieldProperties**](FieldFieldProperties.md) |  |  |
+| **position** | **Integer** | Display order position of this field in the application form. |  |
+| **optional** | **Boolean** | Whether this field is optional (true) or required (false). |  |
+| **value** | [**SubmittedFieldAllOfValue**](SubmittedFieldAllOfValue.md) |  |  |
+
+## Example
+
+```ruby
+require 'komoju-sdk'
+
+instance = Komoju::SubmittedField.new(
+  field_type: null,
+  field: null,
+  field_name: null,
+  field_properties: null,
+  position: null,
+  optional: null,
+  value: null
+)
+```
+

data/docs/SubmittedFieldAllOfValue.md

@@ -0,0 +1,59 @@
+# Komoju::SubmittedFieldAllOfValue
+
+## Concrete types
+
+Use one of the following classes when constructing a `SubmittedFieldAllOfValue`:
+
+- [**Boolean**](Boolean.md)
+- [**Integer**](Integer.md)
+- [**String**](String.md)
+
+## Class instance methods
+
+### `openapi_one_of`
+
+Returns the list of classes defined in oneOf.
+
+#### Example
+
+```ruby
+require 'komoju-sdk'
+
+Komoju::SubmittedFieldAllOfValue.openapi_one_of
+# =>
+# [
+#   :'Boolean',
+#   :'Integer',
+#   :'String'
+# ]
+```
+
+### build
+
+Find the appropriate object from the `openapi_one_of` list and casts the data into it.
+
+#### Example
+
+```ruby
+require 'komoju-sdk'
+
+Komoju::SubmittedFieldAllOfValue.build(data)
+# => #<Boolean:0x00007fdd4aab02a0>
+
+Komoju::SubmittedFieldAllOfValue.build(data_that_doesnt_match)
+# => nil
+```
+
+#### Parameters
+
+| Name | Type | Description |
+| ---- | ---- | ----------- |
+| **data** | **Mixed** | data to be matched against the list of oneOf items |
+
+#### Return type
+
+- [Boolean](Boolean.md)
+- [Integer](Integer.md)
+- [String](String.md)
+- `nil` (if no type matches)
+

data/docs/Subscription.md

@@ -0,0 +1,48 @@
+# Komoju::Subscription
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | A unique 25-character alphanumeric resource identifier. |  |
+| **resource** | **String** | Resource type name, always \"subscription\". |  |
+| **status** | **String** | Current status of the subscription (e.g. \"active\", \"cancelled\"). |  |
+| **amount** | **Integer** | Amount greater than or equal to 0, in the lowest denomination of the currency (e.g. cents for USD). |  |
+| **currency** | [**Currency**](Currency.md) |  |  |
+| **customer** | [**SubscriptionCustomer**](SubscriptionCustomer.md) |  |  |
+| **period** | [**SubscriptionPeriod**](SubscriptionPeriod.md) |  |  |
+| **day** | **Integer** | Day of the period on which the subscription is charged. |  |
+| **payment_details** | [**SubscriptionPaymentDetails**](SubscriptionPaymentDetails.md) |  |  |
+| **retry_count** | **Integer** | Number of times payment has been retried after failure. |  |
+| **retry_at** | **Time** | Timestamp of the next scheduled payment retry, or null. |  |
+| **next_capture_at** | **Time** | Timestamp of the next scheduled subscription charge. |  |
+| **created_at** | **Time** | Timestamp when the subscription was created. |  |
+| **ended_at** | **Time** | Timestamp when the subscription ended, or null if still active. |  |
+| **metadata** | **Object** | Arbitrary key-value metadata attached to the subscription. |  |
+| **payments** | **Array<Object>** | Array of payment objects associated with this subscription. |  |
+
+## Example
+
+```ruby
+require 'komoju-sdk'
+
+instance = Komoju::Subscription.new(
+  id: null,
+  resource: null,
+  status: null,
+  amount: null,
+  currency: null,
+  customer: null,
+  period: null,
+  day: null,
+  payment_details: null,
+  retry_count: null,
+  retry_at: null,
+  next_capture_at: null,
+  created_at: null,
+  ended_at: null,
+  metadata: null,
+  payments: null
+)
+```
+

data/docs/SubscriptionCustomer.md

@@ -0,0 +1,30 @@
+# Komoju::SubscriptionCustomer
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** | Internal numeric ID of the customer. |  |
+| **uuid** | **String** | A unique 25-character alphanumeric resource identifier. |  |
+| **merchant_id** | **Integer** | Internal numeric ID of the merchant. |  |
+| **created_at** | **Time** | Timestamp when the customer was created. |  |
+| **updated_at** | **Time** | Timestamp when the customer was last updated. |  |
+| **email** | **String** | Customer's email address. |  |
+| **currency** | [**Currency**](Currency.md) |  |  |
+
+## Example
+
+```ruby
+require 'komoju-sdk'
+
+instance = Komoju::SubscriptionCustomer.new(
+  id: null,
+  uuid: null,
+  merchant_id: null,
+  created_at: null,
+  updated_at: null,
+  email: null,
+  currency: null
+)
+```
+

data/docs/SubscriptionList.md

@@ -0,0 +1,32 @@
+# Komoju::SubscriptionList
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **resource** | **String** | Resource type name, always \"subscription_list\". |  |
+| **data** | [**Array<Subscription>**](Subscription.md) | Array of subscription 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::SubscriptionList.new(
+  resource: null,
+  data: null,
+  start_time: null,
+  end_time: null,
+  total: null,
+  page: null,
+  per_page: null,
+  last_page: null
+)
+```
+

data/docs/SubscriptionPaymentDetails.md

@@ -0,0 +1,24 @@
+# Komoju::SubscriptionPaymentDetails
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **String** | Payment method type for this subscription. |  |
+| **month** | **String** | Card expiry month. |  |
+| **year** | **String** | Card expiry year. |  |
+| **email** | **String** | Customer's email address. |  |
+
+## Example
+
+```ruby
+require 'komoju-sdk'
+
+instance = Komoju::SubscriptionPaymentDetails.new(
+  type: null,
+  month: null,
+  year: null,
+  email: null
+)
+```
+

data/docs/SubscriptionPeriod.md

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