payjpv2 1.0.2

data/docs/CustomersApi.md

@@ -0,0 +1,443 @@
+# PAYJPv2::CustomersApi
+
+All URIs are relative to *http://localhost*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**create_customer**](CustomersApi.md#create_customer) | **POST** /v2/customers | Create Customer |
+| [**delete_customer**](CustomersApi.md#delete_customer) | **DELETE** /v2/customers/{customer_id} | Delete Customer |
+| [**get_all_customers**](CustomersApi.md#get_all_customers) | **GET** /v2/customers | Get All Customers |
+| [**get_customer**](CustomersApi.md#get_customer) | **GET** /v2/customers/{customer_id} | Get Customer |
+| [**get_customer_payment_methods**](CustomersApi.md#get_customer_payment_methods) | **GET** /v2/customers/{customer_id}/payment_methods | Get Customer Payment Methods |
+| [**update_customer**](CustomersApi.md#update_customer) | **POST** /v2/customers/{customer_id} | Update Customer |
+
+
+## create_customer
+
+> <CustomerResponse> create_customer(customer_create_request)
+
+Create Customer
+
+### 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::CustomersApi.new
+customer_create_request = PAYJPv2::CustomerCreateRequest.new # CustomerCreateRequest | 
+
+begin
+  # Create Customer
+  result = api_instance.create_customer(customer_create_request)
+  p result
+rescue PAYJPv2::ApiError => e
+  puts "Error when calling CustomersApi->create_customer: #{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 Customer
+  data, status_code, headers = api_instance.create_customer(customer_create_request, { include_http_info: true })
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CustomerResponse>
+rescue PAYJPv2::ApiError => e
+  puts "Error when calling CustomersApi->create_customer: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **customer_create_request** | [**CustomerCreateRequest**](CustomerCreateRequest.md) |  |  |
+
+### Return type
+
+[**CustomerResponse**](CustomerResponse.md)
+
+### Authorization
+
+[HTTPBasic](../README.md#HTTPBasic), [HTTPBearer](../README.md#HTTPBearer)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json, application/problem+json
+
+
+## delete_customer
+
+> <CustomerResponse> delete_customer(customer_id)
+
+Delete Customer
+
+### 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::CustomersApi.new
+customer_id = 'customer_id_example' # String | 
+
+begin
+  # Delete Customer
+  result = api_instance.delete_customer(customer_id)
+  p result
+rescue PAYJPv2::ApiError => e
+  puts "Error when calling CustomersApi->delete_customer: #{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 Customer
+  data, status_code, headers = api_instance.delete_customer(customer_id, { include_http_info: true })
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CustomerResponse>
+rescue PAYJPv2::ApiError => e
+  puts "Error when calling CustomersApi->delete_customer: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **customer_id** | **String** |  |  |
+
+### Return type
+
+[**CustomerResponse**](CustomerResponse.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_customers
+
+> <CustomerListResponse> get_all_customers(opts)
+
+Get All Customers
+
+### 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::CustomersApi.new
+opts = {
+  limit: 56, # Integer | 取得するデータの最大件数
+  starting_after: 'starting_after_example', # String | このIDより後のデータを取得
+  ending_before: 'ending_before_example' # String | このIDより前のデータを取得
+}
+
+begin
+  # Get All Customers
+  result = api_instance.get_all_customers(opts)
+  p result
+rescue PAYJPv2::ApiError => e
+  puts "Error when calling CustomersApi->get_all_customers: #{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 Customers
+  data, status_code, headers = api_instance.get_all_customers(opts.merge(include_http_info: true))
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CustomerListResponse>
+rescue PAYJPv2::ApiError => e
+  puts "Error when calling CustomersApi->get_all_customers: #{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
+
+[**CustomerListResponse**](CustomerListResponse.md)
+
+### Authorization
+
+[HTTPBasic](../README.md#HTTPBasic), [HTTPBearer](../README.md#HTTPBearer)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json, application/problem+json
+
+
+## get_customer
+
+> <CustomerResponse> get_customer(customer_id)
+
+Get Customer
+
+### 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::CustomersApi.new
+customer_id = 'customer_id_example' # String | 
+
+begin
+  # Get Customer
+  result = api_instance.get_customer(customer_id)
+  p result
+rescue PAYJPv2::ApiError => e
+  puts "Error when calling CustomersApi->get_customer: #{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 Customer
+  data, status_code, headers = api_instance.get_customer(customer_id, { include_http_info: true })
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CustomerResponse>
+rescue PAYJPv2::ApiError => e
+  puts "Error when calling CustomersApi->get_customer: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **customer_id** | **String** |  |  |
+
+### Return type
+
+[**CustomerResponse**](CustomerResponse.md)
+
+### Authorization
+
+[HTTPBasic](../README.md#HTTPBasic), [HTTPBearer](../README.md#HTTPBearer)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json, application/problem+json
+
+
+## get_customer_payment_methods
+
+> <PaymentMethodListResponse> get_customer_payment_methods(customer_id, opts)
+
+Get Customer 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::CustomersApi.new
+customer_id = 'customer_id_example' # String | 
+opts = {
+  limit: 56, # Integer | 取得するデータの最大件数
+  starting_after: 'starting_after_example', # String | このIDより後のデータを取得
+  ending_before: 'ending_before_example' # String | このIDより前のデータを取得
+}
+
+begin
+  # Get Customer Payment Methods
+  result = api_instance.get_customer_payment_methods(customer_id, opts)
+  p result
+rescue PAYJPv2::ApiError => e
+  puts "Error when calling CustomersApi->get_customer_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 Customer Payment Methods
+  data, status_code, headers = api_instance.get_customer_payment_methods(customer_id, opts.merge(include_http_info: true))
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PaymentMethodListResponse>
+rescue PAYJPv2::ApiError => e
+  puts "Error when calling CustomersApi->get_customer_payment_methods: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **customer_id** | **String** |  |  |
+| **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
+
+
+## update_customer
+
+> <CustomerResponse> update_customer(customer_id, customer_update_request)
+
+Update Customer
+
+### 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::CustomersApi.new
+customer_id = 'customer_id_example' # String | 
+customer_update_request = PAYJPv2::CustomerUpdateRequest.new # CustomerUpdateRequest | 
+
+begin
+  # Update Customer
+  result = api_instance.update_customer(customer_id, customer_update_request)
+  p result
+rescue PAYJPv2::ApiError => e
+  puts "Error when calling CustomersApi->update_customer: #{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 Customer
+  data, status_code, headers = api_instance.update_customer(customer_id, customer_update_request, { include_http_info: true })
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CustomerResponse>
+rescue PAYJPv2::ApiError => e
+  puts "Error when calling CustomersApi->update_customer: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **customer_id** | **String** |  |  |
+| **customer_update_request** | [**CustomerUpdateRequest**](CustomerUpdateRequest.md) |  |  |
+
+### Return type
+
+[**CustomerResponse**](CustomerResponse.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/DisplayPreferenceRequest.md

@@ -0,0 +1,18 @@
+# PAYJPv2::DisplayPreferenceRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **preference** | **String** | この支払い方法がアカウントで有効になっているかどうか  | 値 | |:---| | **on**: この決済手段を決済画面に表示する | | **off**: この決済手段を決済画面に表示しない | | **none**: デフォルト設定を使用 | |  |
+
+## Example
+
+```ruby
+require 'payjpv2'
+
+instance = PAYJPv2::DisplayPreferenceRequest.new(
+  preference: null
+)
+```
+

data/docs/ErrorResponse.md

@@ -0,0 +1,28 @@
+# PAYJPv2::ErrorResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **String** |  |  |
+| **title** | **String** |  |  |
+| **status** | **Integer** |  |  |
+| **detail** | **String** |  | [optional] |
+| **instance** | **String** |  | [optional] |
+| **errors** | **Array<Hash<String, String>>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'payjpv2'
+
+instance = PAYJPv2::ErrorResponse.new(
+  type: null,
+  title: null,
+  status: null,
+  detail: null,
+  instance: null,
+  errors: null
+)
+```
+

data/docs/EventListResponse.md

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

data/docs/EventResponse.md

@@ -0,0 +1,32 @@
+# PAYJPv2::EventResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **object** | **String** |  | [optional][default to 'event'] |
+| **id** | **String** | イベント ID |  |
+| **livemode** | **Boolean** | 本番環境かどうか |  |
+| **type** | **String** | イベントの種類 |  |
+| **pending_webhooks** | **Integer** | 設定された URL への通知が完了していない (2xx のレスポンスが得られていない) webhook の数 |  |
+| **data** | **Hash<String, Object>** | このイベントに関連したリソースオブジェクト |  |
+| **created_at** | **Time** | 作成日時 (UTC, ISO 8601 形式) |  |
+| **updated_at** | **Time** | 更新日時 (UTC, ISO 8601 形式) |  |
+
+## Example
+
+```ruby
+require 'payjpv2'
+
+instance = PAYJPv2::EventResponse.new(
+  object: null,
+  id: null,
+  livemode: null,
+  type: null,
+  pending_webhooks: null,
+  data: null,
+  created_at: null,
+  updated_at: null
+)
+```
+

data/docs/EventsApi.md

@@ -0,0 +1,159 @@
+# PAYJPv2::EventsApi
+
+All URIs are relative to *http://localhost*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_all_events**](EventsApi.md#get_all_events) | **GET** /v2/events | Get All Events |
+| [**get_event**](EventsApi.md#get_event) | **GET** /v2/events/{event_id} | Get Event |
+
+
+## get_all_events
+
+> <EventListResponse> get_all_events(opts)
+
+Get All Events
+
+### 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::EventsApi.new
+opts = {
+  limit: 56, # Integer | 取得するデータの最大件数
+  starting_after: 'starting_after_example', # String | このIDより後のデータを取得
+  ending_before: 'ending_before_example', # String | このIDより前のデータを取得
+  resource_id: 'resource_id_example', # String | 取得する event に紐づく API リソースの ID
+  object: 'object_example', # String | 取得する event に紐づく API リソースの object。値はリソース名 (e.g. customer, payment_flow)
+  type: 'type_example' # String | 取得する event の type
+}
+
+begin
+  # Get All Events
+  result = api_instance.get_all_events(opts)
+  p result
+rescue PAYJPv2::ApiError => e
+  puts "Error when calling EventsApi->get_all_events: #{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 Events
+  data, status_code, headers = api_instance.get_all_events(opts.merge(include_http_info: true))
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <EventListResponse>
+rescue PAYJPv2::ApiError => e
+  puts "Error when calling EventsApi->get_all_events: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **limit** | **Integer** | 取得するデータの最大件数 | [optional][default to 10] |
+| **starting_after** | **String** | このIDより後のデータを取得 | [optional] |
+| **ending_before** | **String** | このIDより前のデータを取得 | [optional] |
+| **resource_id** | **String** | 取得する event に紐づく API リソースの ID | [optional] |
+| **object** | **String** | 取得する event に紐づく API リソースの object。値はリソース名 (e.g. customer, payment_flow) | [optional] |
+| **type** | **String** | 取得する event の type | [optional] |
+
+### Return type
+
+[**EventListResponse**](EventListResponse.md)
+
+### Authorization
+
+[HTTPBasic](../README.md#HTTPBasic), [HTTPBearer](../README.md#HTTPBearer)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json, application/problem+json
+
+
+## get_event
+
+> <EventResponse> get_event(event_id)
+
+Get Event
+
+### 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::EventsApi.new
+event_id = 'event_id_example' # String | 
+
+begin
+  # Get Event
+  result = api_instance.get_event(event_id)
+  p result
+rescue PAYJPv2::ApiError => e
+  puts "Error when calling EventsApi->get_event: #{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 Event
+  data, status_code, headers = api_instance.get_event(event_id, { include_http_info: true })
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <EventResponse>
+rescue PAYJPv2::ApiError => e
+  puts "Error when calling EventsApi->get_event: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **event_id** | **String** |  |  |
+
+### Return type
+
+[**EventResponse**](EventResponse.md)
+
+### Authorization
+
+[HTTPBasic](../README.md#HTTPBasic), [HTTPBearer](../README.md#HTTPBearer)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json, application/problem+json
+