payjpv2 1.0.2

data/docs/PaymentMethodsApi.md

@@ -0,0 +1,507 @@
+# PAYJPv2::PaymentMethodsApi
+
+All URIs are relative to *http://localhost*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**attach_payment_method**](PaymentMethodsApi.md#attach_payment_method) | **POST** /v2/payment_methods/{payment_method_id}/attach | Attach Payment Method |
+| [**create_payment_method**](PaymentMethodsApi.md#create_payment_method) | **POST** /v2/payment_methods | Create Payment Method |
+| [**detach_payment_method**](PaymentMethodsApi.md#detach_payment_method) | **POST** /v2/payment_methods/{payment_method_id}/detach | Detach Payment Method |
+| [**get_all_payment_methods**](PaymentMethodsApi.md#get_all_payment_methods) | **GET** /v2/payment_methods | Get All Payment Methods |
+| [**get_payment_method**](PaymentMethodsApi.md#get_payment_method) | **GET** /v2/payment_methods/{payment_method_id} | Get Payment Method |
+| [**get_payment_method_by_card**](PaymentMethodsApi.md#get_payment_method_by_card) | **GET** /v2/payment_methods/cards/{card_id} | Get Payment Method By Card |
+| [**update_payment_method**](PaymentMethodsApi.md#update_payment_method) | **POST** /v2/payment_methods/{payment_method_id} | Update Payment Method |
+
+
+## attach_payment_method
+
+> <PaymentMethodResponse> attach_payment_method(payment_method_id, payment_method_attach_request)
+
+Attach Payment Method
+
+### 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::PaymentMethodsApi.new
+payment_method_id = 'payment_method_id_example' # String | 
+payment_method_attach_request = PAYJPv2::PaymentMethodAttachRequest.new({customer_id: 'customer_id_example'}) # PaymentMethodAttachRequest | 
+
+begin
+  # Attach Payment Method
+  result = api_instance.attach_payment_method(payment_method_id, payment_method_attach_request)
+  p result
+rescue PAYJPv2::ApiError => e
+  puts "Error when calling PaymentMethodsApi->attach_payment_method: #{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
+  # Attach Payment Method
+  data, status_code, headers = api_instance.attach_payment_method(payment_method_id, payment_method_attach_request, { include_http_info: true })
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PaymentMethodResponse>
+rescue PAYJPv2::ApiError => e
+  puts "Error when calling PaymentMethodsApi->attach_payment_method: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **payment_method_id** | **String** |  |  |
+| **payment_method_attach_request** | [**PaymentMethodAttachRequest**](PaymentMethodAttachRequest.md) |  |  |
+
+### Return type
+
+[**PaymentMethodResponse**](PaymentMethodResponse.md)
+
+### Authorization
+
+[HTTPBasic](../README.md#HTTPBasic), [HTTPBearer](../README.md#HTTPBearer)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json, application/problem+json
+
+
+## create_payment_method
+
+> <PaymentMethodResponse> create_payment_method(payment_method_create_request)
+
+Create Payment Method
+
+### 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::PaymentMethodsApi.new
+payment_method_create_request = PAYJPv2::PaymentMethodApplePayCreateRequest.new({type: 'apple_pay', token: 'token_example'}) # PaymentMethodCreateRequest | 
+
+begin
+  # Create Payment Method
+  result = api_instance.create_payment_method(payment_method_create_request)
+  p result
+rescue PAYJPv2::ApiError => e
+  puts "Error when calling PaymentMethodsApi->create_payment_method: #{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 Method
+  data, status_code, headers = api_instance.create_payment_method(payment_method_create_request, { include_http_info: true })
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PaymentMethodResponse>
+rescue PAYJPv2::ApiError => e
+  puts "Error when calling PaymentMethodsApi->create_payment_method: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **payment_method_create_request** | [**PaymentMethodCreateRequest**](PaymentMethodCreateRequest.md) |  |  |
+
+### Return type
+
+[**PaymentMethodResponse**](PaymentMethodResponse.md)
+
+### Authorization
+
+[HTTPBasic](../README.md#HTTPBasic), [HTTPBearer](../README.md#HTTPBearer)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json, application/problem+json
+
+
+## detach_payment_method
+
+> <PaymentMethodResponse> detach_payment_method(payment_method_id)
+
+Detach Payment Method
+
+### 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::PaymentMethodsApi.new
+payment_method_id = 'payment_method_id_example' # String | 
+
+begin
+  # Detach Payment Method
+  result = api_instance.detach_payment_method(payment_method_id)
+  p result
+rescue PAYJPv2::ApiError => e
+  puts "Error when calling PaymentMethodsApi->detach_payment_method: #{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
+  # Detach Payment Method
+  data, status_code, headers = api_instance.detach_payment_method(payment_method_id, { include_http_info: true })
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PaymentMethodResponse>
+rescue PAYJPv2::ApiError => e
+  puts "Error when calling PaymentMethodsApi->detach_payment_method: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **payment_method_id** | **String** |  |  |
+
+### Return type
+
+[**PaymentMethodResponse**](PaymentMethodResponse.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_payment_methods
+
+> <PaymentMethodListResponse> get_all_payment_methods(opts)
+
+Get All Payment Methods
+
+### 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::PaymentMethodsApi.new
+opts = {
+  limit: 56, # Integer | 取得するデータの最大件数
+  starting_after: 'starting_after_example', # String | このIDより後のデータを取得
+  ending_before: 'ending_before_example' # String | このIDより前のデータを取得
+}
+
+begin
+  # Get All Payment Methods
+  result = api_instance.get_all_payment_methods(opts)
+  p result
+rescue PAYJPv2::ApiError => e
+  puts "Error when calling PaymentMethodsApi->get_all_payment_methods: #{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 Methods
+  data, status_code, headers = api_instance.get_all_payment_methods(opts.merge(include_http_info: true))
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PaymentMethodListResponse>
+rescue PAYJPv2::ApiError => e
+  puts "Error when calling PaymentMethodsApi->get_all_payment_methods: #{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
+
+[**PaymentMethodListResponse**](PaymentMethodListResponse.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_method
+
+> <PaymentMethodResponse> get_payment_method(payment_method_id)
+
+Get Payment Method
+
+### 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::PaymentMethodsApi.new
+payment_method_id = 'payment_method_id_example' # String | 
+
+begin
+  # Get Payment Method
+  result = api_instance.get_payment_method(payment_method_id)
+  p result
+rescue PAYJPv2::ApiError => e
+  puts "Error when calling PaymentMethodsApi->get_payment_method: #{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 Method
+  data, status_code, headers = api_instance.get_payment_method(payment_method_id, { include_http_info: true })
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PaymentMethodResponse>
+rescue PAYJPv2::ApiError => e
+  puts "Error when calling PaymentMethodsApi->get_payment_method: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **payment_method_id** | **String** |  |  |
+
+### Return type
+
+[**PaymentMethodResponse**](PaymentMethodResponse.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_method_by_card
+
+> <PaymentMethodResponse> get_payment_method_by_card(card_id)
+
+Get Payment Method By Card
+
+### 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::PaymentMethodsApi.new
+card_id = 'card_id_example' # String | 
+
+begin
+  # Get Payment Method By Card
+  result = api_instance.get_payment_method_by_card(card_id)
+  p result
+rescue PAYJPv2::ApiError => e
+  puts "Error when calling PaymentMethodsApi->get_payment_method_by_card: #{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 Method By Card
+  data, status_code, headers = api_instance.get_payment_method_by_card(card_id, { include_http_info: true })
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PaymentMethodResponse>
+rescue PAYJPv2::ApiError => e
+  puts "Error when calling PaymentMethodsApi->get_payment_method_by_card: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **card_id** | **String** |  |  |
+
+### Return type
+
+[**PaymentMethodResponse**](PaymentMethodResponse.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_method
+
+> <PaymentMethodResponse> update_payment_method(payment_method_id, payment_method_update_request)
+
+Update Payment Method
+
+### 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::PaymentMethodsApi.new
+payment_method_id = 'payment_method_id_example' # String | 
+payment_method_update_request = PAYJPv2::PaymentMethodApplePayUpdateRequest.new({type: 'apple_pay'}) # PaymentMethodUpdateRequest | 
+
+begin
+  # Update Payment Method
+  result = api_instance.update_payment_method(payment_method_id, payment_method_update_request)
+  p result
+rescue PAYJPv2::ApiError => e
+  puts "Error when calling PaymentMethodsApi->update_payment_method: #{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 Method
+  data, status_code, headers = api_instance.update_payment_method(payment_method_id, payment_method_update_request, { include_http_info: true })
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PaymentMethodResponse>
+rescue PAYJPv2::ApiError => e
+  puts "Error when calling PaymentMethodsApi->update_payment_method: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **payment_method_id** | **String** |  |  |
+| **payment_method_update_request** | [**PaymentMethodUpdateRequest**](PaymentMethodUpdateRequest.md) |  |  |
+
+### Return type
+
+[**PaymentMethodResponse**](PaymentMethodResponse.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/PaymentRefundCreateRequest.md

@@ -0,0 +1,24 @@
+# PAYJPv2::PaymentRefundCreateRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **payment_flow_id** | **String** | 返金対象となる PaymentFlow の ID |  |
+| **amount** | **Integer** | 返金金額。省略すると全額返金となります。 | [optional] |
+| **reason** | [**PaymentRefundReason**](PaymentRefundReason.md) | 返金理由  | 値 | |:---| | **duplicate**: 重複した支払い | | **fraudulent**: 不正な支払い | | **requested_by_customer**: 顧客の要求 | | [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::PaymentRefundCreateRequest.new(
+  payment_flow_id: null,
+  amount: null,
+  reason: null,
+  metadata: null
+)
+```
+

data/docs/PaymentRefundListResponse.md

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

data/docs/PaymentRefundReason.md

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

data/docs/PaymentRefundResponse.md

@@ -0,0 +1,36 @@
+# PAYJPv2::PaymentRefundResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **object** | **String** |  | [optional][default to 'payment_refund'] |
+| **id** | **String** | 返金 ID |  |
+| **livemode** | **Boolean** | 本番環境かどうか |  |
+| **payment_flow_id** | **String** | 返金対象となる PaymentFlow の ID |  |
+| **amount** | **Integer** | 返金金額 |  |
+| **status** | [**PaymentRefundStatus**](PaymentRefundStatus.md) | 返金ステータス  <a href=\"https://docs.pay.jp/v2/guide/status-management/refund#%E8%BF%94%E9%87%91%E3%82%B9%E3%83%86%E3%83%BC%E3%82%BF%E3%82%B9%E3%81%AE%E7%9B%A3%E8%A6%96\" target=\"_blank\">返金ステータスの詳細についてはこちらを参照してください。</a>  | 値 | |:---| | **succeeded**: 返金が成功しました | | **failed**: 返金が失敗しました | | **pending**: 返金処理中です | | **canceled**: 返金がキャンセルされました | | **requires_action**: 追加のアクションが必要です | |  |
+| **reason** | [**PaymentRefundReason**](PaymentRefundReason.md) |  |  |
+| **metadata** | [**Hash<String, MetadataValue>**](MetadataValue.md) | メタデータ |  |
+| **created_at** | **Time** | 作成日時 (UTC, ISO 8601 形式) |  |
+| **updated_at** | **Time** | 更新日時 (UTC, ISO 8601 形式) |  |
+
+## Example
+
+```ruby
+require 'payjpv2'
+
+instance = PAYJPv2::PaymentRefundResponse.new(
+  object: null,
+  id: null,
+  livemode: null,
+  payment_flow_id: null,
+  amount: null,
+  status: null,
+  reason: null,
+  metadata: null,
+  created_at: null,
+  updated_at: null
+)
+```
+

data/docs/PaymentRefundStatus.md

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

data/docs/PaymentRefundUpdateRequest.md

@@ -0,0 +1,18 @@
+# PAYJPv2::PaymentRefundUpdateRequest
+
+## 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::PaymentRefundUpdateRequest.new(
+  metadata: null
+)
+```
+