payjpv2 1.0.2

data/docs/ProductsApi.md

@@ -0,0 +1,365 @@
+# PAYJPv2::ProductsApi
+
+All URIs are relative to *http://localhost*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**create_product**](ProductsApi.md#create_product) | **POST** /v2/products | Create Product |
+| [**delete_product**](ProductsApi.md#delete_product) | **DELETE** /v2/products/{product_id} | Delete Product |
+| [**get_all_products**](ProductsApi.md#get_all_products) | **GET** /v2/products | Get All Products |
+| [**get_product**](ProductsApi.md#get_product) | **GET** /v2/products/{product_id} | Get Product |
+| [**update_product**](ProductsApi.md#update_product) | **POST** /v2/products/{product_id} | Update Product |
+
+
+## create_product
+
+> <ProductDetailsResponse> create_product(product_create_request)
+
+Create Product
+
+### 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::ProductsApi.new
+product_create_request = PAYJPv2::ProductCreateRequest.new({name: 'name_example'}) # ProductCreateRequest | 
+
+begin
+  # Create Product
+  result = api_instance.create_product(product_create_request)
+  p result
+rescue PAYJPv2::ApiError => e
+  puts "Error when calling ProductsApi->create_product: #{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 Product
+  data, status_code, headers = api_instance.create_product(product_create_request, { include_http_info: true })
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ProductDetailsResponse>
+rescue PAYJPv2::ApiError => e
+  puts "Error when calling ProductsApi->create_product: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **product_create_request** | [**ProductCreateRequest**](ProductCreateRequest.md) |  |  |
+
+### Return type
+
+[**ProductDetailsResponse**](ProductDetailsResponse.md)
+
+### Authorization
+
+[HTTPBasic](../README.md#HTTPBasic), [HTTPBearer](../README.md#HTTPBearer)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json, application/problem+json
+
+
+## delete_product
+
+> <ProductDeletedResponse> delete_product(product_id)
+
+Delete Product
+
+### 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::ProductsApi.new
+product_id = 'product_id_example' # String | 
+
+begin
+  # Delete Product
+  result = api_instance.delete_product(product_id)
+  p result
+rescue PAYJPv2::ApiError => e
+  puts "Error when calling ProductsApi->delete_product: #{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
+  # Delete Product
+  data, status_code, headers = api_instance.delete_product(product_id, { include_http_info: true })
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ProductDeletedResponse>
+rescue PAYJPv2::ApiError => e
+  puts "Error when calling ProductsApi->delete_product: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **product_id** | **String** |  |  |
+
+### Return type
+
+[**ProductDeletedResponse**](ProductDeletedResponse.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_products
+
+> <ProductListResponse> get_all_products(opts)
+
+Get All Products
+
+### 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::ProductsApi.new
+opts = {
+  limit: 56, # Integer | 取得するデータの最大件数
+  starting_after: 'starting_after_example', # String | このIDより後のデータを取得
+  ending_before: 'ending_before_example' # String | このIDより前のデータを取得
+}
+
+begin
+  # Get All Products
+  result = api_instance.get_all_products(opts)
+  p result
+rescue PAYJPv2::ApiError => e
+  puts "Error when calling ProductsApi->get_all_products: #{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 Products
+  data, status_code, headers = api_instance.get_all_products(opts.merge(include_http_info: true))
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ProductListResponse>
+rescue PAYJPv2::ApiError => e
+  puts "Error when calling ProductsApi->get_all_products: #{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
+
+[**ProductListResponse**](ProductListResponse.md)
+
+### Authorization
+
+[HTTPBasic](../README.md#HTTPBasic), [HTTPBearer](../README.md#HTTPBearer)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json, application/problem+json
+
+
+## get_product
+
+> <ProductDetailsResponse> get_product(product_id)
+
+Get Product
+
+### 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::ProductsApi.new
+product_id = 'product_id_example' # String | 
+
+begin
+  # Get Product
+  result = api_instance.get_product(product_id)
+  p result
+rescue PAYJPv2::ApiError => e
+  puts "Error when calling ProductsApi->get_product: #{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 Product
+  data, status_code, headers = api_instance.get_product(product_id, { include_http_info: true })
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ProductDetailsResponse>
+rescue PAYJPv2::ApiError => e
+  puts "Error when calling ProductsApi->get_product: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **product_id** | **String** |  |  |
+
+### Return type
+
+[**ProductDetailsResponse**](ProductDetailsResponse.md)
+
+### Authorization
+
+[HTTPBasic](../README.md#HTTPBasic), [HTTPBearer](../README.md#HTTPBearer)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json, application/problem+json
+
+
+## update_product
+
+> <ProductDetailsResponse> update_product(product_id, product_update_request)
+
+Update Product
+
+### 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::ProductsApi.new
+product_id = 'product_id_example' # String | 
+product_update_request = PAYJPv2::ProductUpdateRequest.new # ProductUpdateRequest | 
+
+begin
+  # Update Product
+  result = api_instance.update_product(product_id, product_update_request)
+  p result
+rescue PAYJPv2::ApiError => e
+  puts "Error when calling ProductsApi->update_product: #{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 Product
+  data, status_code, headers = api_instance.update_product(product_id, product_update_request, { include_http_info: true })
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ProductDetailsResponse>
+rescue PAYJPv2::ApiError => e
+  puts "Error when calling ProductsApi->update_product: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **product_id** | **String** |  |  |
+| **product_update_request** | [**ProductUpdateRequest**](ProductUpdateRequest.md) |  |  |
+
+### Return type
+
+[**ProductDetailsResponse**](ProductDetailsResponse.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/SetupFlowCancelRequest.md

@@ -0,0 +1,18 @@
+# PAYJPv2::SetupFlowCancelRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **cancellation_reason** | [**SetupFlowCancellationReason**](SetupFlowCancellationReason.md) | この SetupFlow のキャンセル理由。  | 値 | |:---| | **abandoned**: 顧客が SetupFlow を完了しなかった場合。 | | **requested_by_customer**: 顧客がキャンセルを要求した場合。 | | **duplicate**: 支払い方法が重複している場合。 | | [optional] |
+
+## Example
+
+```ruby
+require 'payjpv2'
+
+instance = PAYJPv2::SetupFlowCancelRequest.new(
+  cancellation_reason: null
+)
+```
+

data/docs/SetupFlowCancellationReason.md

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

data/docs/SetupFlowCreateRequest.md

@@ -0,0 +1,28 @@
+# PAYJPv2::SetupFlowCreateRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **customer_id** | **String** | この SetupFlow に関連付ける顧客の ID。SetupFlow により作られた PaymentMethod はこの顧客に紐付きます。 | [optional] |
+| **payment_method_options** | [**SetupFlowPaymentMethodOptionsRequest**](SetupFlowPaymentMethodOptionsRequest.md) | この SetupFlow 固有の支払い方法の設定 | [optional] |
+| **payment_method_types** | **Array<String>** | この SetupFlow で使用できる支払い方法の種類のリスト。 指定しない場合は、PAY.JP は支払い方法の設定から利用可能な支払い方法を動的に表示します。 | [optional] |
+| **usage** | [**Usage**](Usage.md) | 支払い方法が今後どのように使用されるかを指定します。指定されていない場合、この値はデフォルトで `off_session` になります。  | 値 | |:---| | **off_session**: 定期課金など、顧客がカートなどの決済フローにいるかどうか不明な場合は `off_session` を使用してください。 | | **on_session**: 顧客がカートなどの決済フローにいる場合にのみ支払い方法を利用する場合は `on_session` を使用してください。 | | [optional] |
+| **description** | **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::SetupFlowCreateRequest.new(
+  customer_id: null,
+  payment_method_options: null,
+  payment_method_types: null,
+  usage: null,
+  description: null,
+  metadata: null
+)
+```
+

data/docs/SetupFlowDataRequest.md

@@ -0,0 +1,20 @@
+# PAYJPv2::SetupFlowDataRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **description** | **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::SetupFlowDataRequest.new(
+  description: null,
+  metadata: null
+)
+```
+

data/docs/SetupFlowListResponse.md

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

data/docs/SetupFlowPaymentMethodOptionsCardRequest.md

@@ -0,0 +1,18 @@
+# PAYJPv2::SetupFlowPaymentMethodOptionsCardRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **request_three_d_secure** | **String** | 3D セキュア認証の要求方法。  | 値 | |:---| | **any**: 3D セキュア認証を要求します。 | | **automatic**: 必要な場合にのみ 3D セキュア認証を要求します。 |  | [optional] |
+
+## Example
+
+```ruby
+require 'payjpv2'
+
+instance = PAYJPv2::SetupFlowPaymentMethodOptionsCardRequest.new(
+  request_three_d_secure: null
+)
+```
+

data/docs/SetupFlowPaymentMethodOptionsRequest.md

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

data/docs/SetupFlowResponse.md

@@ -0,0 +1,50 @@
+# PAYJPv2::SetupFlowResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **object** | **String** |  | [optional][default to 'setup_flow'] |
+| **id** | **String** | ID |  |
+| **livemode** | **Boolean** | 本番環境かどうか |  |
+| **client_secret** | **String** | この SetupFlow のクライアントシークレットです。フロントエンドで公開鍵と合わせて使用し、SetupFlow の取得や支払い方法の登録処理を行います。**この値はこの SetupFlow を利用する顧客以外へ公開しないでください。 |  |
+| **customer_id** | **String** |  |  |
+| **description** | **String** |  |  |
+| **metadata** | [**Hash<String, MetadataValue>**](MetadataValue.md) | メタデータ |  |
+| **payment_method_id** | **String** |  |  |
+| **payment_method_options** | **Hash<String, Object>** |  |  |
+| **payment_method_types** | [**Array<PaymentMethodTypes>**](PaymentMethodTypes.md) | この SetupFlow で使用できる支払い方法の種類のリスト |  |
+| **status** | [**SetupFlowStatus**](SetupFlowStatus.md) | この SetupFlow のステータスです。<a href=\"https://docs.pay.jp/v2/guide/payments/setupflow#setup-flow-%E3%81%AE%E3%82%B9%E3%83%86%E3%83%BC%E3%82%BF%E3%82%B9\" target=\"_blank\">ステータスの詳細についてはこちらをご覧ください。</a>  | 値 | |:---| | **requires_payment_method**: 支払い方法が必要です。 | | **requires_confirmation**: 確認が必要です。 | | **requires_action**: 顧客のアクションが必要です。 | | **processing**: 処理中です。 | | **succeeded**: 成功しました。 | | **canceled**: キャンセルされました。 | |  |
+| **next_action** | **Hash<String, Object>** |  |  |
+| **return_url** | **String** |  |  |
+| **last_setup_error** | **Hash<String, Object>** |  |  |
+| **cancellation_reason** | [**SetupFlowCancellationReason**](SetupFlowCancellationReason.md) |  |  |
+| **created_at** | **Time** | 作成日時 (UTC, ISO 8601 形式) |  |
+| **updated_at** | **Time** | 更新日時 (UTC, ISO 8601 形式) |  |
+
+## Example
+
+```ruby
+require 'payjpv2'
+
+instance = PAYJPv2::SetupFlowResponse.new(
+  object: null,
+  id: null,
+  livemode: null,
+  client_secret: null,
+  customer_id: null,
+  description: null,
+  metadata: null,
+  payment_method_id: null,
+  payment_method_options: null,
+  payment_method_types: null,
+  status: null,
+  next_action: null,
+  return_url: null,
+  last_setup_error: null,
+  cancellation_reason: null,
+  created_at: null,
+  updated_at: null
+)
+```
+

data/docs/SetupFlowStatus.md

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

data/docs/SetupFlowUpdateRequest.md

@@ -0,0 +1,26 @@
+# PAYJPv2::SetupFlowUpdateRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **customer_id** | **String** | この SetupFlow に関連付ける顧客の ID。SetupFlow により作られた PaymentMethod はこの顧客に紐付きます。 | [optional] |
+| **payment_method_options** | [**SetupFlowPaymentMethodOptionsRequest**](SetupFlowPaymentMethodOptionsRequest.md) | この SetupFlow 固有の支払い方法の設定 | [optional] |
+| **payment_method_types** | **Array<String>** | この SetupFlow で使用できる支払い方法の種類のリスト。 指定しない場合は、PAY.JP は支払い方法の設定から利用可能な支払い方法を動的に表示します。 | [optional] |
+| **description** | **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::SetupFlowUpdateRequest.new(
+  customer_id: null,
+  payment_method_options: null,
+  payment_method_types: null,
+  description: null,
+  metadata: null
+)
+```
+