payjpv2 1.0.2

data/docs/PaymentRefundsApi.md

@@ -0,0 +1,295 @@
+# PAYJPv2::PaymentRefundsApi
+
+All URIs are relative to *http://localhost*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**create_payment_refund**](PaymentRefundsApi.md#create_payment_refund) | **POST** /v2/payment_refunds | Create Payment Refund |
+| [**get_all_payment_refunds**](PaymentRefundsApi.md#get_all_payment_refunds) | **GET** /v2/payment_refunds | Get All Payment Refunds |
+| [**get_payment_refund**](PaymentRefundsApi.md#get_payment_refund) | **GET** /v2/payment_refunds/{payment_refund_id} | Get Payment Refund |
+| [**update_payment_refund**](PaymentRefundsApi.md#update_payment_refund) | **POST** /v2/payment_refunds/{payment_refund_id} | Update Payment Refund |
+
+
+## create_payment_refund
+
+> <PaymentRefundResponse> create_payment_refund(payment_refund_create_request)
+
+Create Payment Refund
+
+### 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::PaymentRefundsApi.new
+payment_refund_create_request = PAYJPv2::PaymentRefundCreateRequest.new({payment_flow_id: 'payment_flow_id_example'}) # PaymentRefundCreateRequest | 
+
+begin
+  # Create Payment Refund
+  result = api_instance.create_payment_refund(payment_refund_create_request)
+  p result
+rescue PAYJPv2::ApiError => e
+  puts "Error when calling PaymentRefundsApi->create_payment_refund: #{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 Payment Refund
+  data, status_code, headers = api_instance.create_payment_refund(payment_refund_create_request, { include_http_info: true })
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PaymentRefundResponse>
+rescue PAYJPv2::ApiError => e
+  puts "Error when calling PaymentRefundsApi->create_payment_refund: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **payment_refund_create_request** | [**PaymentRefundCreateRequest**](PaymentRefundCreateRequest.md) |  |  |
+
+### Return type
+
+[**PaymentRefundResponse**](PaymentRefundResponse.md)
+
+### Authorization
+
+[HTTPBasic](../README.md#HTTPBasic), [HTTPBearer](../README.md#HTTPBearer)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json, application/problem+json
+
+
+## get_all_payment_refunds
+
+> <PaymentRefundListResponse> get_all_payment_refunds(opts)
+
+Get All Payment Refunds
+
+### 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::PaymentRefundsApi.new
+opts = {
+  limit: 56, # Integer | 取得するデータの最大件数
+  starting_after: 'starting_after_example', # String | このIDより後のデータを取得
+  ending_before: 'ending_before_example' # String | このIDより前のデータを取得
+}
+
+begin
+  # Get All Payment Refunds
+  result = api_instance.get_all_payment_refunds(opts)
+  p result
+rescue PAYJPv2::ApiError => e
+  puts "Error when calling PaymentRefundsApi->get_all_payment_refunds: #{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 Payment Refunds
+  data, status_code, headers = api_instance.get_all_payment_refunds(opts.merge(include_http_info: true))
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PaymentRefundListResponse>
+rescue PAYJPv2::ApiError => e
+  puts "Error when calling PaymentRefundsApi->get_all_payment_refunds: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **limit** | **Integer** | 取得するデータの最大件数 | [optional][default to 10] |
+| **starting_after** | **String** | このIDより後のデータを取得 | [optional] |
+| **ending_before** | **String** | このIDより前のデータを取得 | [optional] |
+
+### Return type
+
+[**PaymentRefundListResponse**](PaymentRefundListResponse.md)
+
+### Authorization
+
+[HTTPBasic](../README.md#HTTPBasic), [HTTPBearer](../README.md#HTTPBearer)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json, application/problem+json
+
+
+## get_payment_refund
+
+> <PaymentRefundResponse> get_payment_refund(payment_refund_id)
+
+Get Payment Refund
+
+### 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::PaymentRefundsApi.new
+payment_refund_id = 'payment_refund_id_example' # String | 
+
+begin
+  # Get Payment Refund
+  result = api_instance.get_payment_refund(payment_refund_id)
+  p result
+rescue PAYJPv2::ApiError => e
+  puts "Error when calling PaymentRefundsApi->get_payment_refund: #{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 Payment Refund
+  data, status_code, headers = api_instance.get_payment_refund(payment_refund_id, { include_http_info: true })
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PaymentRefundResponse>
+rescue PAYJPv2::ApiError => e
+  puts "Error when calling PaymentRefundsApi->get_payment_refund: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **payment_refund_id** | **String** |  |  |
+
+### Return type
+
+[**PaymentRefundResponse**](PaymentRefundResponse.md)
+
+### Authorization
+
+[HTTPBasic](../README.md#HTTPBasic), [HTTPBearer](../README.md#HTTPBearer)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json, application/problem+json
+
+
+## update_payment_refund
+
+> <PaymentRefundResponse> update_payment_refund(payment_refund_id, payment_refund_update_request)
+
+Update Payment Refund
+
+### 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::PaymentRefundsApi.new
+payment_refund_id = 'payment_refund_id_example' # String | 
+payment_refund_update_request = PAYJPv2::PaymentRefundUpdateRequest.new # PaymentRefundUpdateRequest | 
+
+begin
+  # Update Payment Refund
+  result = api_instance.update_payment_refund(payment_refund_id, payment_refund_update_request)
+  p result
+rescue PAYJPv2::ApiError => e
+  puts "Error when calling PaymentRefundsApi->update_payment_refund: #{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
+  # Update Payment Refund
+  data, status_code, headers = api_instance.update_payment_refund(payment_refund_id, payment_refund_update_request, { include_http_info: true })
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PaymentRefundResponse>
+rescue PAYJPv2::ApiError => e
+  puts "Error when calling PaymentRefundsApi->update_payment_refund: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **payment_refund_id** | **String** |  |  |
+| **payment_refund_update_request** | [**PaymentRefundUpdateRequest**](PaymentRefundUpdateRequest.md) |  |  |
+
+### Return type
+
+[**PaymentRefundResponse**](PaymentRefundResponse.md)
+
+### Authorization
+
+[HTTPBasic](../README.md#HTTPBasic), [HTTPBearer](../README.md#HTTPBearer)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json, application/problem+json
+

data/docs/PaymentTransactionListResponse.md

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

data/docs/PaymentTransactionResponse.md

@@ -0,0 +1,42 @@
+# PAYJPv2::PaymentTransactionResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **object** | **String** |  | [optional][default to 'payment_transaction'] |
+| **id** | **String** | 決済トランザクション ID |  |
+| **livemode** | **Boolean** | 本番環境かどうか |  |
+| **resource_id** | **String** | PaymentTransaction 生成の元になったリソースの ID |  |
+| **amount** | **Integer** | 金額 |  |
+| **currency** | [**Currency**](Currency.md) | 通貨 |  |
+| **fee_rate** | **String** | 手数料率 |  |
+| **fee** | **Integer** | 手数料 |  |
+| **type** | [**PaymentTransactionType**](PaymentTransactionType.md) | PaymentTransaction の種類  | 値 | |:---| | **payment**: 支払い | | **refund**: 返金 | | **chargeback**: チャージバック | | **chargeback_cancel**: チャージバックのキャンセル |  |  |
+| **payment_method_type** | [**PaymentMethodTypes**](PaymentMethodTypes.md) | 支払い方法の種類 |  |
+| **term_id** | **String** | 集計区間 ID |  |
+| **created_at** | **Time** | 作成日時 (UTC, ISO 8601 形式) |  |
+| **updated_at** | **Time** | 更新日時 (UTC, ISO 8601 形式) |  |
+
+## Example
+
+```ruby
+require 'payjpv2'
+
+instance = PAYJPv2::PaymentTransactionResponse.new(
+  object: null,
+  id: null,
+  livemode: null,
+  resource_id: null,
+  amount: null,
+  currency: null,
+  fee_rate: null,
+  fee: null,
+  type: null,
+  payment_method_type: null,
+  term_id: null,
+  created_at: null,
+  updated_at: null
+)
+```
+

data/docs/PaymentTransactionType.md

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

data/docs/PaymentTransactionsApi.md

@@ -0,0 +1,159 @@
+# PAYJPv2::PaymentTransactionsApi
+
+All URIs are relative to *http://localhost*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_all_payment_transactions**](PaymentTransactionsApi.md#get_all_payment_transactions) | **GET** /v2/payment_transactions | Get All Payment Transactions |
+| [**get_payment_transaction**](PaymentTransactionsApi.md#get_payment_transaction) | **GET** /v2/payment_transactions/{payment_transaction_id} | Get Payment Transaction |
+
+
+## get_all_payment_transactions
+
+> <PaymentTransactionListResponse> get_all_payment_transactions(opts)
+
+Get All Payment Transactions
+
+### 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::PaymentTransactionsApi.new
+opts = {
+  limit: 56, # Integer | 取得するデータの最大件数
+  starting_after: 'starting_after_example', # String | このIDより後のデータを取得
+  ending_before: 'ending_before_example', # String | このIDより前のデータを取得
+  term_id: 'term_id_example', # String | 集計区間 ID
+  type: 'type_example', # String | 取引タイプ
+  payment_method_type: 'payment_method_type_example' # String | 支払い方法タイプ
+}
+
+begin
+  # Get All Payment Transactions
+  result = api_instance.get_all_payment_transactions(opts)
+  p result
+rescue PAYJPv2::ApiError => e
+  puts "Error when calling PaymentTransactionsApi->get_all_payment_transactions: #{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 Payment Transactions
+  data, status_code, headers = api_instance.get_all_payment_transactions(opts.merge(include_http_info: true))
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PaymentTransactionListResponse>
+rescue PAYJPv2::ApiError => e
+  puts "Error when calling PaymentTransactionsApi->get_all_payment_transactions: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **limit** | **Integer** | 取得するデータの最大件数 | [optional][default to 10] |
+| **starting_after** | **String** | このIDより後のデータを取得 | [optional] |
+| **ending_before** | **String** | このIDより前のデータを取得 | [optional] |
+| **term_id** | **String** | 集計区間 ID | [optional] |
+| **type** | **String** | 取引タイプ | [optional] |
+| **payment_method_type** | **String** | 支払い方法タイプ | [optional] |
+
+### Return type
+
+[**PaymentTransactionListResponse**](PaymentTransactionListResponse.md)
+
+### Authorization
+
+[HTTPBasic](../README.md#HTTPBasic), [HTTPBearer](../README.md#HTTPBearer)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json, application/problem+json
+
+
+## get_payment_transaction
+
+> <PaymentTransactionResponse> get_payment_transaction(payment_transaction_id)
+
+Get Payment Transaction
+
+### 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::PaymentTransactionsApi.new
+payment_transaction_id = 'payment_transaction_id_example' # String | 
+
+begin
+  # Get Payment Transaction
+  result = api_instance.get_payment_transaction(payment_transaction_id)
+  p result
+rescue PAYJPv2::ApiError => e
+  puts "Error when calling PaymentTransactionsApi->get_payment_transaction: #{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 Payment Transaction
+  data, status_code, headers = api_instance.get_payment_transaction(payment_transaction_id, { include_http_info: true })
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PaymentTransactionResponse>
+rescue PAYJPv2::ApiError => e
+  puts "Error when calling PaymentTransactionsApi->get_payment_transaction: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **payment_transaction_id** | **String** |  |  |
+
+### Return type
+
+[**PaymentTransactionResponse**](PaymentTransactionResponse.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/PriceCreateRequest.md

@@ -0,0 +1,32 @@
+# PAYJPv2::PriceCreateRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **product_id** | **String** | この価格が紐付く商品の ID |  |
+| **unit_amount** | **Integer** | 価格の単価 |  |
+| **currency** | [**Currency**](Currency.md) | 価格の通貨。現在は `jpy` のみサポートしています。 |  |
+| **id** | **String** | 料金 ID | [optional] |
+| **active** | **Boolean** | 価格が有効かどうか | [optional][default to true] |
+| **nickname** | **String** | 価格の名称。PAY.JP の管理画面で識別するためのもので、顧客には表示されません。 | [optional] |
+| **lookup_key** | **String** | この価格を検索するためのキー | [optional] |
+| **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::PriceCreateRequest.new(
+  product_id: null,
+  unit_amount: null,
+  currency: null,
+  id: null,
+  active: null,
+  nickname: null,
+  lookup_key: null,
+  metadata: null
+)
+```
+

data/docs/PriceDetailsResponse.md

@@ -0,0 +1,42 @@
+# PAYJPv2::PriceDetailsResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **object** | **String** |  | [optional][default to 'price'] |
+| **id** | **String** | 料金 ID |  |
+| **livemode** | **Boolean** | 本番環境かどうか |  |
+| **product_id** | **String** | この価格が紐付く商品の ID |  |
+| **unit_amount** | **Integer** | 価格の単価 |  |
+| **currency** | [**Currency**](Currency.md) | 価格の通貨。現在は `jpy` のみサポートしています。 |  |
+| **active** | **Boolean** | 価格が有効かどうか |  |
+| **nickname** | **String** |  |  |
+| **type** | [**PriceType**](PriceType.md) | 一度限りの購入を表す `one_time` が入ります。 |  |
+| **lookup_key** | **String** |  |  |
+| **metadata** | [**Hash<String, MetadataValue>**](MetadataValue.md) | メタデータ |  |
+| **created_at** | **Time** | 作成日時 (UTC, ISO 8601 形式) |  |
+| **updated_at** | **Time** | 更新日時 (UTC, ISO 8601 形式) |  |
+
+## Example
+
+```ruby
+require 'payjpv2'
+
+instance = PAYJPv2::PriceDetailsResponse.new(
+  object: null,
+  id: null,
+  livemode: null,
+  product_id: null,
+  unit_amount: null,
+  currency: null,
+  active: null,
+  nickname: null,
+  type: null,
+  lookup_key: null,
+  metadata: null,
+  created_at: null,
+  updated_at: null
+)
+```
+

data/docs/PriceListResponse.md

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

data/docs/PriceType.md

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

data/docs/PriceUpdateRequest.md

@@ -0,0 +1,24 @@
+# PAYJPv2::PriceUpdateRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **active** | **Boolean** | 価格が有効かどうか | [optional] |
+| **nickname** | **String** | 価格の名称。PAY.JP の管理画面で識別するためのもので、顧客には表示されません。 | [optional] |
+| **lookup_key** | **String** | この価格を検索するためのキー | [optional] |
+| **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::PriceUpdateRequest.new(
+  active: null,
+  nickname: null,
+  lookup_key: null,
+  metadata: null
+)
+```
+