payjpv2 1.0.2

data/docs/BalancesApi.md

@@ -0,0 +1,235 @@
+# PAYJPv2::BalancesApi
+
+All URIs are relative to *http://localhost*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**create_balance_url**](BalancesApi.md#create_balance_url) | **POST** /v2/balances/{balance_id}/balance_urls | Create Balance Url |
+| [**get_all_balances**](BalancesApi.md#get_all_balances) | **GET** /v2/balances | Get All Balances |
+| [**get_balance**](BalancesApi.md#get_balance) | **GET** /v2/balances/{balance_id} | Get Balance |
+
+
+## create_balance_url
+
+> <BalanceURLResponse> create_balance_url(balance_id)
+
+Create Balance Url
+
+### Examples
+
+```ruby
+require 'time'
+require 'payjpv2'
+# setup authorization
+PAYJPv2.configure do |config|
+  # Configure HTTP basic authorization: HTTPBasic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+
+  # Configure Bearer authorization: HTTPBearer
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = PAYJPv2::BalancesApi.new
+balance_id = 'balance_id_example' # String | 
+
+begin
+  # Create Balance Url
+  result = api_instance.create_balance_url(balance_id)
+  p result
+rescue PAYJPv2::ApiError => e
+  puts "Error when calling BalancesApi->create_balance_url: #{e}"
+end
+```
+
+#### Using the include_http_info option
+
+To get response data along with status code and headers, use the `include_http_info: true` option.
+
+```ruby
+begin
+  # Create Balance Url
+  data, status_code, headers = api_instance.create_balance_url(balance_id, { include_http_info: true })
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <BalanceURLResponse>
+rescue PAYJPv2::ApiError => e
+  puts "Error when calling BalancesApi->create_balance_url: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **balance_id** | **String** |  |  |
+
+### Return type
+
+[**BalanceURLResponse**](BalanceURLResponse.md)
+
+### Authorization
+
+[HTTPBasic](../README.md#HTTPBasic), [HTTPBearer](../README.md#HTTPBearer)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json, application/problem+json
+
+
+## get_all_balances
+
+> <BalanceListResponse> get_all_balances(opts)
+
+Get All Balances
+
+### Examples
+
+```ruby
+require 'time'
+require 'payjpv2'
+# setup authorization
+PAYJPv2.configure do |config|
+  # Configure HTTP basic authorization: HTTPBasic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+
+  # Configure Bearer authorization: HTTPBearer
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = PAYJPv2::BalancesApi.new
+opts = {
+  since: Time.parse('2013-10-20T19:20:30+01:00'), # Time | 指定した日付以降のデータを取得
+  _until: Time.parse('2013-10-20T19:20:30+01:00'), # Time | 指定した日付以前のデータを取得
+  limit: 56, # Integer | 取得するデータの最大件数
+  starting_after: 'starting_after_example', # String | このIDより後のデータを取得
+  ending_before: 'ending_before_example', # String | このIDより前のデータを取得
+  state: PAYJPv2::BalanceState::COLLECTING, # BalanceState | state が指定した値であるオブジェクトに限定
+  closed: true, # Boolean | closed が指定した値であるオブジェクトに限定
+  since_due_date: Time.parse('2013-10-20T19:20:30+01:00'), # Time | 入金予定日/振込期限日が指定した日時以降のデータのみ取得
+  until_due_date: Time.parse('2013-10-20T19:20:30+01:00') # Time | 入金予定日/振込期限日が指定した日時以前のデータのみ取得
+}
+
+begin
+  # Get All Balances
+  result = api_instance.get_all_balances(opts)
+  p result
+rescue PAYJPv2::ApiError => e
+  puts "Error when calling BalancesApi->get_all_balances: #{e}"
+end
+```
+
+#### Using the include_http_info option
+
+To get response data along with status code and headers, use the `include_http_info: true` option.
+
+```ruby
+begin
+  # Get All Balances
+  data, status_code, headers = api_instance.get_all_balances(opts.merge(include_http_info: true))
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <BalanceListResponse>
+rescue PAYJPv2::ApiError => e
+  puts "Error when calling BalancesApi->get_all_balances: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **since** | **Time** | 指定した日付以降のデータを取得 | [optional] |
+| **_until** | **Time** | 指定した日付以前のデータを取得 | [optional] |
+| **limit** | **Integer** | 取得するデータの最大件数 | [optional][default to 10] |
+| **starting_after** | **String** | このIDより後のデータを取得 | [optional] |
+| **ending_before** | **String** | このIDより前のデータを取得 | [optional] |
+| **state** | [**BalanceState**](.md) | state が指定した値であるオブジェクトに限定 | [optional] |
+| **closed** | **Boolean** | closed が指定した値であるオブジェクトに限定 | [optional] |
+| **since_due_date** | **Time** | 入金予定日/振込期限日が指定した日時以降のデータのみ取得 | [optional] |
+| **until_due_date** | **Time** | 入金予定日/振込期限日が指定した日時以前のデータのみ取得 | [optional] |
+
+### Return type
+
+[**BalanceListResponse**](BalanceListResponse.md)
+
+### Authorization
+
+[HTTPBasic](../README.md#HTTPBasic), [HTTPBearer](../README.md#HTTPBearer)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json, application/problem+json
+
+
+## get_balance
+
+> <BalanceResponse> get_balance(balance_id)
+
+Get Balance
+
+### Examples
+
+```ruby
+require 'time'
+require 'payjpv2'
+# setup authorization
+PAYJPv2.configure do |config|
+  # Configure HTTP basic authorization: HTTPBasic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+
+  # Configure Bearer authorization: HTTPBearer
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = PAYJPv2::BalancesApi.new
+balance_id = 'balance_id_example' # String | 
+
+begin
+  # Get Balance
+  result = api_instance.get_balance(balance_id)
+  p result
+rescue PAYJPv2::ApiError => e
+  puts "Error when calling BalancesApi->get_balance: #{e}"
+end
+```
+
+#### Using the include_http_info option
+
+To get response data along with status code and headers, use the `include_http_info: true` option.
+
+```ruby
+begin
+  # Get Balance
+  data, status_code, headers = api_instance.get_balance(balance_id, { include_http_info: true })
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <BalanceResponse>
+rescue PAYJPv2::ApiError => e
+  puts "Error when calling BalancesApi->get_balance: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **balance_id** | **String** |  |  |
+
+### Return type
+
+[**BalanceResponse**](BalanceResponse.md)
+
+### Authorization
+
+[HTTPBasic](../README.md#HTTPBasic), [HTTPBearer](../README.md#HTTPBearer)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json, application/problem+json
+

data/docs/BankInfoResponse.md

@@ -0,0 +1,28 @@
+# PAYJPv2::BankInfoResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **bank_code** | **String** | 銀行コード |  |
+| **bank_branch_code** | **String** | 支店番号 |  |
+| **bank_account_type** | **String** | 口座種別 |  |
+| **bank_account_number** | **String** | 口座番号 |  |
+| **bank_account_holder_name** | **String** | 口座名義 |  |
+| **bank_account_status** | **String** | 最新振込結果  | 値 | |:---| | **success**: 成功 | | **failed**: 失敗 | | **pending**: 初回振込み前 | |  |
+
+## Example
+
+```ruby
+require 'payjpv2'
+
+instance = PAYJPv2::BankInfoResponse.new(
+  bank_code: null,
+  bank_branch_code: null,
+  bank_account_type: null,
+  bank_account_number: null,
+  bank_account_holder_name: null,
+  bank_account_status: null
+)
+```
+

data/docs/CaptureMethod.md

@@ -0,0 +1,15 @@
+# PAYJPv2::CaptureMethod
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'payjpv2'
+
+instance = PAYJPv2::CaptureMethod.new()
+```
+

data/docs/CardConfigRequest.md

@@ -0,0 +1,18 @@
+# PAYJPv2::CardConfigRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **display_preference** | [**DisplayPreferenceRequest**](DisplayPreferenceRequest.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'payjpv2'
+
+instance = PAYJPv2::CardConfigRequest.new(
+  display_preference: null
+)
+```
+

data/docs/CheckoutSessionCreateRequest.md

@@ -0,0 +1,52 @@
+# PAYJPv2::CheckoutSessionCreateRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **mode** | [**CheckoutSessionMode**](CheckoutSessionMode.md) | Checkout Session のモード  | 指定できる値 | |:---| | **payment**: 支払いモードで Checkout Session を作成します。 | | **setup**: セットアップモードで Checkout Session を作成します。 | |  |
+| **client_reference_id** | **String** | ID | [optional] |
+| **customer_id** | **String** | 顧客 ID | [optional] |
+| **customer_email** | **String** | 顧客オブジェクトを作成する時に使われます。指定されていない場合、顧客にメールアドレスの入力を求めます。すでに顧客のメールアドレスを持っている場合は、このパラメータを使ってあらかじめ情報を入力しておくことが可能です。 | [optional] |
+| **customer_creation** | [**CustomerCreation**](CustomerCreation.md) | Checkout Session の確定時に Customer を作成するかどうかを指定します。<br> `payment` および `setup` モードでのみ設定可能です。 | [optional] |
+| **line_items** | [**Array<LineItemRequest>**](LineItemRequest.md) | 顧客が購入する商品のリストです。このパラメーターを使用して、1回限りまたは定期的な料金を渡します。  `payment` モードの場合、最大100個のラインアイテムを使用できます。 | [optional] |
+| **metadata** | [**Hash<String, MetadataValue>**](MetadataValue.md) | キーバリューの任意のデータを格納できます。20件まで登録可能で、空文字列を指定するとそのキーを削除できます。<a href=\"https://docs.pay.jp/v2/guide/developers/metadata\">詳細はメタデータのドキュメントを参照してください。</a> | [optional] |
+| **success_url** | **String** | 支払いや設定が完了した際に、PAY.JP が顧客をリダイレクトする URL。成功した Checkout Session からの情報をページで使用したい場合は、成功ページのカスタマイズに関するガイドをお読みください。 | [optional] |
+| **cancel_url** | **String** | キャンセル時のリダイレクト URL | [optional] |
+| **currency** | [**Currency**](Currency.md) | 価格の通貨。現在は `jpy` のみサポートしています。 | [optional] |
+| **expires_at** | **Time** | Checkout Session の有効期限が失効する日時 | [optional] |
+| **locale** | [**Locale**](Locale.md) | Checkout 画面の表示言語を指定します。  | 指定できる値 | |:---| | **ja**: 日本語で表示します。 | | [optional] |
+| **payment_method_types** | [**Array<PaymentMethodTypes>**](PaymentMethodTypes.md) | この PaymentFlow で使用できる支払い方法の種類（カードなど）のリストです。指定しない場合、管理画面で利用可能な状態にしている支払い方法を自動的に表示します。 | [optional] |
+| **payment_method_options** | [**CheckoutSessionPaymentMethodOptionsRequest**](CheckoutSessionPaymentMethodOptionsRequest.md) | この PaymentFlow の支払い方法の個別設定 | [optional] |
+| **payment_flow_data** | [**PaymentFlowDataRequest**](PaymentFlowDataRequest.md) | `payment` モード指定時に PaymentFlow 作成に使用するパラメーター | [optional] |
+| **submit_type** | [**CheckoutSessionSubmitType**](CheckoutSessionSubmitType.md) | Checkout の画面上に表示される送信ボタンなど、ページ上の関連テキストをカスタマイズするために使用されます。<br> `submit_type` は、`payment` モードの Checkout Session でのみ指定できます。未指定時、あるいは `auto` の場合、`pay` が使用されます。  | 指定できる値 | |:---| | **auto**: `pay` が使用されます。 | | **pay**: 「支払う」（デフォルト） | | **book**: 「予約する」 | | **donate**: 「寄付する」 | | [optional] |
+| **setup_flow_data** | [**SetupFlowDataRequest**](SetupFlowDataRequest.md) | `setup` モードの Checkout Session を作成する際、SetupFlow の作成に渡されるパラメーター | [optional] |
+| **ui_mode** | [**CheckoutSessionUIMode**](CheckoutSessionUIMode.md) | Checkout Session の UI モード。デフォルトは `hosted` です。  | 指定できる値 | |:---| | **hosted**: PAY.JP でホスティングしている画面を使用します。 | | [optional] |
+
+## Example
+
+```ruby
+require 'payjpv2'
+
+instance = PAYJPv2::CheckoutSessionCreateRequest.new(
+  mode: null,
+  client_reference_id: null,
+  customer_id: null,
+  customer_email: null,
+  customer_creation: null,
+  line_items: null,
+  metadata: null,
+  success_url: null,
+  cancel_url: null,
+  currency: null,
+  expires_at: null,
+  locale: null,
+  payment_method_types: null,
+  payment_method_options: null,
+  payment_flow_data: null,
+  submit_type: null,
+  setup_flow_data: null,
+  ui_mode: null
+)
+```
+

data/docs/CheckoutSessionCustomerDetailsAddressResponse.md

@@ -0,0 +1,28 @@
+# PAYJPv2::CheckoutSessionCustomerDetailsAddressResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **country** | **String** |  |  |
+| **zip** | **String** |  |  |
+| **state** | **String** |  |  |
+| **city** | **String** |  |  |
+| **line1** | **String** |  |  |
+| **line2** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'payjpv2'
+
+instance = PAYJPv2::CheckoutSessionCustomerDetailsAddressResponse.new(
+  country: null,
+  zip: null,
+  state: null,
+  city: null,
+  line1: null,
+  line2: null
+)
+```
+

data/docs/CheckoutSessionCustomerDetailsResponse.md

@@ -0,0 +1,24 @@
+# PAYJPv2::CheckoutSessionCustomerDetailsResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** |  |  |
+| **email** | **String** |  |  |
+| **phone** | **String** |  |  |
+| **address** | [**CheckoutSessionCustomerDetailsAddressResponse**](CheckoutSessionCustomerDetailsAddressResponse.md) |  |  |
+
+## Example
+
+```ruby
+require 'payjpv2'
+
+instance = PAYJPv2::CheckoutSessionCustomerDetailsResponse.new(
+  name: null,
+  email: null,
+  phone: null,
+  address: null
+)
+```
+

data/docs/CheckoutSessionDetailsResponse.md

@@ -0,0 +1,66 @@
+# PAYJPv2::CheckoutSessionDetailsResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **object** | **String** |  | [optional][default to 'checkout.session'] |
+| **id** | **String** | Checkout Session ID |  |
+| **livemode** | **Boolean** | 本番環境かどうか |  |
+| **amount_subtotal** | **Integer** |  |  |
+| **amount_total** | **Integer** |  |  |
+| **customer_id** | **String** |  |  |
+| **customer_email** | **String** |  |  |
+| **customer_details** | [**CheckoutSessionCustomerDetailsResponse**](CheckoutSessionCustomerDetailsResponse.md) |  | [optional] |
+| **expires_at** | **Time** |  |  |
+| **currency** | [**Currency**](Currency.md) | 価格の通貨。現在は `jpy` のみサポートしています。 |  |
+| **locale** | [**Locale**](Locale.md) |  |  |
+| **payment_flow_id** | **String** |  | [optional] |
+| **payment_method_types** | [**Array<PaymentMethodTypes>**](PaymentMethodTypes.md) |  |  |
+| **payment_method_options** | **Hash<String, Object>** |  |  |
+| **setup_flow_id** | **String** |  | [optional] |
+| **submit_type** | [**CheckoutSessionSubmitType**](CheckoutSessionSubmitType.md) |  |  |
+| **mode** | [**CheckoutSessionMode**](CheckoutSessionMode.md) | Checkout Session のモード  | 値 | |:---| | **payment**: 支払いモード | | **setup**: セットアップモード | |  |
+| **ui_mode** | [**CheckoutSessionUIMode**](CheckoutSessionUIMode.md) | Checkout Session の UI モード  | 値 | |:---| | **hosted**: PAY.JP でホスティングしている画面を使用します。 | |  |
+| **status** | [**CheckoutSessionStatus**](CheckoutSessionStatus.md) | チェックアウトセッションのステータス |  |
+| **success_url** | **String** |  |  |
+| **cancel_url** | **String** |  |  |
+| **url** | **String** | URL |  |
+| **metadata** | [**Hash<String, MetadataValue>**](MetadataValue.md) | メタデータ |  |
+| **created_at** | **Time** | 作成日時 (UTC, ISO 8601 形式) |  |
+| **updated_at** | **Time** | 更新日時 (UTC, ISO 8601 形式) |  |
+
+## Example
+
+```ruby
+require 'payjpv2'
+
+instance = PAYJPv2::CheckoutSessionDetailsResponse.new(
+  object: null,
+  id: null,
+  livemode: null,
+  amount_subtotal: null,
+  amount_total: null,
+  customer_id: null,
+  customer_email: null,
+  customer_details: null,
+  expires_at: null,
+  currency: null,
+  locale: null,
+  payment_flow_id: null,
+  payment_method_types: null,
+  payment_method_options: null,
+  setup_flow_id: null,
+  submit_type: null,
+  mode: null,
+  ui_mode: null,
+  status: null,
+  success_url: null,
+  cancel_url: null,
+  url: null,
+  metadata: null,
+  created_at: null,
+  updated_at: null
+)
+```
+

data/docs/CheckoutSessionLineItemDataResponse.md

@@ -0,0 +1,34 @@
+# PAYJPv2::CheckoutSessionLineItemDataResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **object** | **String** |  | [optional][default to 'line_item'] |
+| **id** | **String** | ID |  |
+| **amount_subtotal** | **Integer** | 割引や税金が適用される前のすべての商品の合計金額 |  |
+| **amount_tax** | **Integer** | 税額 |  |
+| **amount_total** | **Integer** | 割引と税金が適用された後のすべての商品の合計金額 |  |
+| **currency** | [**Currency**](Currency.md) | 価格の通貨。現在は `jpy` のみサポートしています。 |  |
+| **description** | **String** |  |  |
+| **price** | [**PriceDetailsResponse**](PriceDetailsResponse.md) | 料金情報 |  |
+| **quantity** | **Integer** | 数量 |  |
+
+## Example
+
+```ruby
+require 'payjpv2'
+
+instance = PAYJPv2::CheckoutSessionLineItemDataResponse.new(
+  object: null,
+  id: null,
+  amount_subtotal: null,
+  amount_tax: null,
+  amount_total: null,
+  currency: null,
+  description: null,
+  price: null,
+  quantity: null
+)
+```
+

data/docs/CheckoutSessionLineItemListResponse.md

@@ -0,0 +1,24 @@
+# PAYJPv2::CheckoutSessionLineItemListResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **object** | **String** |  | [optional][default to 'list'] |
+| **url** | **String** | リスト取得URL |  |
+| **has_more** | **Boolean** | 次のページがあるかどうか |  |
+| **data** | [**Array<CheckoutSessionLineItemDataResponse>**](CheckoutSessionLineItemDataResponse.md) |  |  |
+
+## Example
+
+```ruby
+require 'payjpv2'
+
+instance = PAYJPv2::CheckoutSessionLineItemListResponse.new(
+  object: null,
+  url: null,
+  has_more: null,
+  data: null
+)
+```
+

data/docs/CheckoutSessionListResponse.md

@@ -0,0 +1,24 @@
+# PAYJPv2::CheckoutSessionListResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **object** | **String** |  | [optional][default to 'list'] |
+| **url** | **String** | リスト取得URL |  |
+| **has_more** | **Boolean** | 次のページがあるかどうか |  |
+| **data** | [**Array<CheckoutSessionDetailsResponse>**](CheckoutSessionDetailsResponse.md) |  |  |
+
+## Example
+
+```ruby
+require 'payjpv2'
+
+instance = PAYJPv2::CheckoutSessionListResponse.new(
+  object: null,
+  url: null,
+  has_more: null,
+  data: null
+)
+```
+

data/docs/CheckoutSessionMode.md

@@ -0,0 +1,15 @@
+# PAYJPv2::CheckoutSessionMode
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'payjpv2'
+
+instance = PAYJPv2::CheckoutSessionMode.new()
+```
+

data/docs/CheckoutSessionPaymentMethodOptionsCardRequest.md

@@ -0,0 +1,20 @@
+# PAYJPv2::CheckoutSessionPaymentMethodOptionsCardRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **request_extended_authorization** | **String** | オーソリ期間の延長要求  | 指定できる値 | |:---| | **if_available**: オーソリ期間の延長が可能な場合に延長要求を行います。 | | **never**: オーソリ期間の延長要求を行いません。 | | [optional] |
+| **request_three_d_secure** | **String** | 3D セキュア認証の要求方法  | 指定できる値 | |:---| | **any**: 3D セキュア認証を要求します。 | | **automatic**: 必要な場合にのみ 3D セキュア認証を要求します。 | | [optional] |
+
+## Example
+
+```ruby
+require 'payjpv2'
+
+instance = PAYJPv2::CheckoutSessionPaymentMethodOptionsCardRequest.new(
+  request_extended_authorization: null,
+  request_three_d_secure: null
+)
+```
+

data/docs/CheckoutSessionPaymentMethodOptionsRequest.md

@@ -0,0 +1,18 @@
+# PAYJPv2::CheckoutSessionPaymentMethodOptionsRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **card** | [**CheckoutSessionPaymentMethodOptionsCardRequest**](CheckoutSessionPaymentMethodOptionsCardRequest.md) | カード支払い方法に関するオプション | [optional] |
+
+## Example
+
+```ruby
+require 'payjpv2'
+
+instance = PAYJPv2::CheckoutSessionPaymentMethodOptionsRequest.new(
+  card: null
+)
+```
+

data/docs/CheckoutSessionStatus.md

@@ -0,0 +1,15 @@
+# PAYJPv2::CheckoutSessionStatus
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'payjpv2'
+
+instance = PAYJPv2::CheckoutSessionStatus.new()
+```
+

data/docs/CheckoutSessionSubmitType.md

@@ -0,0 +1,15 @@
+# PAYJPv2::CheckoutSessionSubmitType
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'payjpv2'
+
+instance = PAYJPv2::CheckoutSessionSubmitType.new()
+```
+

data/docs/CheckoutSessionUIMode.md

@@ -0,0 +1,15 @@
+# PAYJPv2::CheckoutSessionUIMode
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'payjpv2'
+
+instance = PAYJPv2::CheckoutSessionUIMode.new()
+```
+

data/docs/CheckoutSessionUpdateRequest.md

@@ -0,0 +1,18 @@
+# PAYJPv2::CheckoutSessionUpdateRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **metadata** | [**Hash<String, MetadataValue>**](MetadataValue.md) | キーバリューの任意のデータを格納できます。20件まで登録可能で、空文字列を指定するとそのキーを削除できます。<a href=\"https://docs.pay.jp/v2/guide/developers/metadata\">詳細はメタデータのドキュメントを参照してください。</a> | [optional] |
+
+## Example
+
+```ruby
+require 'payjpv2'
+
+instance = PAYJPv2::CheckoutSessionUpdateRequest.new(
+  metadata: null
+)
+```
+