payjpv2 1.0.2

data/docs/SetupFlowsApi.md

@@ -0,0 +1,371 @@
+# PAYJPv2::SetupFlowsApi
+
+All URIs are relative to *http://localhost*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**cancel_setup_flow**](SetupFlowsApi.md#cancel_setup_flow) | **POST** /v2/setup_flows/{setup_flow_id}/cancel | Cancel Setup Flow |
+| [**create_setup_flow**](SetupFlowsApi.md#create_setup_flow) | **POST** /v2/setup_flows | Create Setup Flow |
+| [**get_all_setup_flows**](SetupFlowsApi.md#get_all_setup_flows) | **GET** /v2/setup_flows | Get All Setup Flows |
+| [**get_setup_flow**](SetupFlowsApi.md#get_setup_flow) | **GET** /v2/setup_flows/{setup_flow_id} | Get Setup Flow |
+| [**update_setup_flow**](SetupFlowsApi.md#update_setup_flow) | **POST** /v2/setup_flows/{setup_flow_id} | Update Setup Flow |
+
+
+## cancel_setup_flow
+
+> <SetupFlowResponse> cancel_setup_flow(setup_flow_id, opts)
+
+Cancel Setup Flow
+
+### 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::SetupFlowsApi.new
+setup_flow_id = 'setup_flow_id_example' # String | 
+opts = {
+  setup_flow_cancel_request: PAYJPv2::SetupFlowCancelRequest.new # SetupFlowCancelRequest | 
+}
+
+begin
+  # Cancel Setup Flow
+  result = api_instance.cancel_setup_flow(setup_flow_id, opts)
+  p result
+rescue PAYJPv2::ApiError => e
+  puts "Error when calling SetupFlowsApi->cancel_setup_flow: #{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
+  # Cancel Setup Flow
+  data, status_code, headers = api_instance.cancel_setup_flow(setup_flow_id, opts.merge(include_http_info: true))
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SetupFlowResponse>
+rescue PAYJPv2::ApiError => e
+  puts "Error when calling SetupFlowsApi->cancel_setup_flow: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **setup_flow_id** | **String** |  |  |
+| **setup_flow_cancel_request** | [**SetupFlowCancelRequest**](SetupFlowCancelRequest.md) |  | [optional] |
+
+### Return type
+
+[**SetupFlowResponse**](SetupFlowResponse.md)
+
+### Authorization
+
+[HTTPBasic](../README.md#HTTPBasic), [HTTPBearer](../README.md#HTTPBearer)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json, application/problem+json
+
+
+## create_setup_flow
+
+> <SetupFlowResponse> create_setup_flow(opts)
+
+Create Setup Flow
+
+### 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::SetupFlowsApi.new
+opts = {
+  setup_flow_create_request: PAYJPv2::SetupFlowCreateRequest.new # SetupFlowCreateRequest | 
+}
+
+begin
+  # Create Setup Flow
+  result = api_instance.create_setup_flow(opts)
+  p result
+rescue PAYJPv2::ApiError => e
+  puts "Error when calling SetupFlowsApi->create_setup_flow: #{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 Setup Flow
+  data, status_code, headers = api_instance.create_setup_flow(opts.merge(include_http_info: true))
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SetupFlowResponse>
+rescue PAYJPv2::ApiError => e
+  puts "Error when calling SetupFlowsApi->create_setup_flow: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **setup_flow_create_request** | [**SetupFlowCreateRequest**](SetupFlowCreateRequest.md) |  | [optional] |
+
+### Return type
+
+[**SetupFlowResponse**](SetupFlowResponse.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_setup_flows
+
+> <SetupFlowListResponse> get_all_setup_flows(opts)
+
+Get All Setup Flows
+
+### 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::SetupFlowsApi.new
+opts = {
+  limit: 56, # Integer | 取得するデータの最大件数
+  starting_after: 'starting_after_example', # String | このIDより後のデータを取得
+  ending_before: 'ending_before_example' # String | このIDより前のデータを取得
+}
+
+begin
+  # Get All Setup Flows
+  result = api_instance.get_all_setup_flows(opts)
+  p result
+rescue PAYJPv2::ApiError => e
+  puts "Error when calling SetupFlowsApi->get_all_setup_flows: #{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 Setup Flows
+  data, status_code, headers = api_instance.get_all_setup_flows(opts.merge(include_http_info: true))
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SetupFlowListResponse>
+rescue PAYJPv2::ApiError => e
+  puts "Error when calling SetupFlowsApi->get_all_setup_flows: #{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
+
+[**SetupFlowListResponse**](SetupFlowListResponse.md)
+
+### Authorization
+
+[HTTPBasic](../README.md#HTTPBasic), [HTTPBearer](../README.md#HTTPBearer)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json, application/problem+json
+
+
+## get_setup_flow
+
+> <SetupFlowResponse> get_setup_flow(setup_flow_id)
+
+Get Setup Flow
+
+### 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::SetupFlowsApi.new
+setup_flow_id = 'setup_flow_id_example' # String | 
+
+begin
+  # Get Setup Flow
+  result = api_instance.get_setup_flow(setup_flow_id)
+  p result
+rescue PAYJPv2::ApiError => e
+  puts "Error when calling SetupFlowsApi->get_setup_flow: #{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 Setup Flow
+  data, status_code, headers = api_instance.get_setup_flow(setup_flow_id, { include_http_info: true })
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SetupFlowResponse>
+rescue PAYJPv2::ApiError => e
+  puts "Error when calling SetupFlowsApi->get_setup_flow: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **setup_flow_id** | **String** |  |  |
+
+### Return type
+
+[**SetupFlowResponse**](SetupFlowResponse.md)
+
+### Authorization
+
+[HTTPBasic](../README.md#HTTPBasic), [HTTPBearer](../README.md#HTTPBearer)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json, application/problem+json
+
+
+## update_setup_flow
+
+> <SetupFlowResponse> update_setup_flow(setup_flow_id, setup_flow_update_request)
+
+Update Setup Flow
+
+### 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::SetupFlowsApi.new
+setup_flow_id = 'setup_flow_id_example' # String | 
+setup_flow_update_request = PAYJPv2::SetupFlowUpdateRequest.new # SetupFlowUpdateRequest | 
+
+begin
+  # Update Setup Flow
+  result = api_instance.update_setup_flow(setup_flow_id, setup_flow_update_request)
+  p result
+rescue PAYJPv2::ApiError => e
+  puts "Error when calling SetupFlowsApi->update_setup_flow: #{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 Setup Flow
+  data, status_code, headers = api_instance.update_setup_flow(setup_flow_id, setup_flow_update_request, { include_http_info: true })
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SetupFlowResponse>
+rescue PAYJPv2::ApiError => e
+  puts "Error when calling SetupFlowsApi->update_setup_flow: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **setup_flow_id** | **String** |  |  |
+| **setup_flow_update_request** | [**SetupFlowUpdateRequest**](SetupFlowUpdateRequest.md) |  |  |
+
+### Return type
+
+[**SetupFlowResponse**](SetupFlowResponse.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/StatementItemResponse.md

@@ -0,0 +1,24 @@
+# PAYJPv2::StatementItemResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **subject** | [**StatementSubject**](StatementSubject.md) | 明細項目の種別 |  |
+| **name** | **String** |  |  |
+| **amount** | **Integer** | 明細項目の金額 |  |
+| **tax_rate** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'payjpv2'
+
+instance = PAYJPv2::StatementItemResponse.new(
+  subject: null,
+  name: null,
+  amount: null,
+  tax_rate: null
+)
+```
+

data/docs/StatementListResponse.md

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

data/docs/StatementResponse.md

@@ -0,0 +1,38 @@
+# PAYJPv2::StatementResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **object** | **String** |  | [optional][default to 'statement'] |
+| **id** | **String** | 明細 ID |  |
+| **livemode** | **Boolean** | 本番環境かどうか |  |
+| **title** | **String** |  |  |
+| **type** | [**StatementType**](StatementType.md) | 取引明細の区分  | 値 | 区分 | 詳細 | |---| --- | --- | | **sales** | 売上 | 決済による売上、決済手数料等 | | **service_fee** | サービス利用料 | 有料プランの月額費用など、sales に含まれないサービス利用料 | | **forfeit** | 残高失効 | - | | **transfer_fee** | 振込手数料 | - | | **misc** | その他 | 調整金など | |  |
+| **term** | [**TermResponse**](TermResponse.md) |  |  |
+| **balance_id** | **String** |  |  |
+| **items** | [**Array<StatementItemResponse>**](StatementItemResponse.md) | 明細項目のリスト |  |
+| **net** | **Integer** | 含まれる statement_item の金額合計 |  |
+| **created_at** | **Time** | 作成日時 (UTC, ISO 8601 形式) |  |
+| **updated_at** | **Time** | 更新日時 (UTC, ISO 8601 形式) |  |
+
+## Example
+
+```ruby
+require 'payjpv2'
+
+instance = PAYJPv2::StatementResponse.new(
+  object: null,
+  id: null,
+  livemode: null,
+  title: null,
+  type: null,
+  term: null,
+  balance_id: null,
+  items: null,
+  net: null,
+  created_at: null,
+  updated_at: null
+)
+```
+

data/docs/StatementSubject.md

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

data/docs/StatementType.md

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

data/docs/StatementURLResponse.md

@@ -0,0 +1,22 @@
+# PAYJPv2::StatementURLResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **object** | **String** |  | [optional][default to 'statement_url'] |
+| **url** | **String** | 取引明細書ダウンロード URL |  |
+| **expires** | **Time** | 有効期限の日付  有効期限は発行から1時間です。 |  |
+
+## Example
+
+```ruby
+require 'payjpv2'
+
+instance = PAYJPv2::StatementURLResponse.new(
+  object: null,
+  url: null,
+  expires: null
+)
+```
+