payjpv2 1.0.2

data/docs/StatementsApi.md

@@ -0,0 +1,231 @@
+# PAYJPv2::StatementsApi
+
+All URIs are relative to *http://localhost*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**create_statement_url**](StatementsApi.md#create_statement_url) | **POST** /v2/statements/{statement_id}/statement_urls | Create Statement Url |
+| [**get_all_statements**](StatementsApi.md#get_all_statements) | **GET** /v2/statements | Get All Statements |
+| [**get_statement**](StatementsApi.md#get_statement) | **GET** /v2/statements/{statement_id} | Get Statement |
+
+
+## create_statement_url
+
+> <StatementURLResponse> create_statement_url(statement_id)
+
+Create Statement Url
+
+### 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::StatementsApi.new
+statement_id = 'statement_id_example' # String | 
+
+begin
+  # Create Statement Url
+  result = api_instance.create_statement_url(statement_id)
+  p result
+rescue PAYJPv2::ApiError => e
+  puts "Error when calling StatementsApi->create_statement_url: #{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 Statement Url
+  data, status_code, headers = api_instance.create_statement_url(statement_id, { include_http_info: true })
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <StatementURLResponse>
+rescue PAYJPv2::ApiError => e
+  puts "Error when calling StatementsApi->create_statement_url: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **statement_id** | **String** |  |  |
+
+### Return type
+
+[**StatementURLResponse**](StatementURLResponse.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_statements
+
+> <StatementListResponse> get_all_statements(opts)
+
+Get All Statements
+
+### 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::StatementsApi.new
+opts = {
+  since: Time.parse('2013-10-20T19:20:30+01:00'), # Time | 指定した日付以降のデータを取得
+  _until: Time.parse('2013-10-20T19:20:30+01:00'), # Time | 指定した日付以前のデータを取得
+  limit: 56, # Integer | 取得するデータの最大件数
+  starting_after: 'starting_after_example', # String | このIDより後のデータを取得
+  ending_before: 'ending_before_example', # String | このIDより前のデータを取得
+  type: PAYJPv2::StatementType::SALES, # StatementType | 明細タイプでフィルタ
+  term_id: 'term_id_example' # String | 集計区間 ID でフィルタ
+}
+
+begin
+  # Get All Statements
+  result = api_instance.get_all_statements(opts)
+  p result
+rescue PAYJPv2::ApiError => e
+  puts "Error when calling StatementsApi->get_all_statements: #{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 Statements
+  data, status_code, headers = api_instance.get_all_statements(opts.merge(include_http_info: true))
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <StatementListResponse>
+rescue PAYJPv2::ApiError => e
+  puts "Error when calling StatementsApi->get_all_statements: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **since** | **Time** | 指定した日付以降のデータを取得 | [optional] |
+| **_until** | **Time** | 指定した日付以前のデータを取得 | [optional] |
+| **limit** | **Integer** | 取得するデータの最大件数 | [optional][default to 10] |
+| **starting_after** | **String** | このIDより後のデータを取得 | [optional] |
+| **ending_before** | **String** | このIDより前のデータを取得 | [optional] |
+| **type** | [**StatementType**](.md) | 明細タイプでフィルタ | [optional] |
+| **term_id** | **String** | 集計区間 ID でフィルタ | [optional] |
+
+### Return type
+
+[**StatementListResponse**](StatementListResponse.md)
+
+### Authorization
+
+[HTTPBasic](../README.md#HTTPBasic), [HTTPBearer](../README.md#HTTPBearer)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json, application/problem+json
+
+
+## get_statement
+
+> <StatementResponse> get_statement(statement_id)
+
+Get Statement
+
+### 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::StatementsApi.new
+statement_id = 'statement_id_example' # String | 
+
+begin
+  # Get Statement
+  result = api_instance.get_statement(statement_id)
+  p result
+rescue PAYJPv2::ApiError => e
+  puts "Error when calling StatementsApi->get_statement: #{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 Statement
+  data, status_code, headers = api_instance.get_statement(statement_id, { include_http_info: true })
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <StatementResponse>
+rescue PAYJPv2::ApiError => e
+  puts "Error when calling StatementsApi->get_statement: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **statement_id** | **String** |  |  |
+
+### Return type
+
+[**StatementResponse**](StatementResponse.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/TaxRateCreateRequest.md

@@ -0,0 +1,30 @@
+# PAYJPv2::TaxRateCreateRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **display_name** | **String** | 表示名。顧客に表示されます。 |  |
+| **inclusive** | **Boolean** | 税込みかどうか。税込 = `true` 税抜 = `false` |  |
+| **percentage** | **Float** | 税率を % 単位で指定します（例: 10%の場合は「10」と入力） |  |
+| **active** | **Boolean** | この税率が有効であるかどうか。無効にした場合でも、すでに設定されている定期課金などでは使用可能です。 | [optional][default to true] |
+| **country** | [**Country**](Country.md) | 有効な2文字の <a href=\"https://ja.wikipedia.org/wiki/ISO_3166-1\" target=\"_blank\">ISO 国コード</a> | [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::TaxRateCreateRequest.new(
+  display_name: null,
+  inclusive: null,
+  percentage: null,
+  active: null,
+  country: null,
+  description: null,
+  metadata: null
+)
+```
+

data/docs/TaxRateDetailsResponse.md

@@ -0,0 +1,34 @@
+# PAYJPv2::TaxRateDetailsResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **object** | **String** |  | [optional][default to 'tax_rate'] |
+| **id** | **String** | 税率 ID |  |
+| **display_name** | **String** | 表示名。顧客に表示されます。 |  |
+| **inclusive** | **Boolean** | 税込みかどうか。税込 = `true` 税抜 = `false` |  |
+| **percentage** | **Float** | 税率 (% 単位) |  |
+| **active** | **Boolean** | この税率が有効であるかどうか |  |
+| **country** | [**Country**](Country.md) |  |  |
+| **description** | **String** |  |  |
+| **metadata** | [**Hash<String, MetadataValue>**](MetadataValue.md) | メタデータ |  |
+
+## Example
+
+```ruby
+require 'payjpv2'
+
+instance = PAYJPv2::TaxRateDetailsResponse.new(
+  object: null,
+  id: null,
+  display_name: null,
+  inclusive: null,
+  percentage: null,
+  active: null,
+  country: null,
+  description: null,
+  metadata: null
+)
+```
+

data/docs/TaxRateListResponse.md

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

data/docs/TaxRateUpdateRequest.md

@@ -0,0 +1,26 @@
+# PAYJPv2::TaxRateUpdateRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **active** | **Boolean** | この税率が有効であるかどうか。無効にした場合でも、すでに設定されている定期課金などでは使用可能です。 | [optional] |
+| **country** | [**Country**](Country.md) | 有効な2文字の <a href=\"https://ja.wikipedia.org/wiki/ISO_3166-1\" target=\"_blank\">ISO 国コード</a> | [optional] |
+| **description** | **String** | 説明。管理画面内のみで表示され、顧客には表示されません。 | [optional] |
+| **display_name** | **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::TaxRateUpdateRequest.new(
+  active: null,
+  country: null,
+  description: null,
+  display_name: null,
+  metadata: null
+)
+```
+

data/docs/TaxRatesApi.md

@@ -0,0 +1,295 @@
+# PAYJPv2::TaxRatesApi
+
+All URIs are relative to *http://localhost*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**create_tax_rate**](TaxRatesApi.md#create_tax_rate) | **POST** /v2/tax_rates | Create Tax Rate |
+| [**get_all_tax_rates**](TaxRatesApi.md#get_all_tax_rates) | **GET** /v2/tax_rates | Get All Tax Rates |
+| [**get_tax_rate**](TaxRatesApi.md#get_tax_rate) | **GET** /v2/tax_rates/{tax_rate_id} | Get Tax Rate |
+| [**update_tax_rate**](TaxRatesApi.md#update_tax_rate) | **POST** /v2/tax_rates/{tax_rate_id} | Update Tax Rate |
+
+
+## create_tax_rate
+
+> <TaxRateDetailsResponse> create_tax_rate(tax_rate_create_request)
+
+Create Tax Rate
+
+### 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::TaxRatesApi.new
+tax_rate_create_request = PAYJPv2::TaxRateCreateRequest.new({display_name: 'display_name_example', inclusive: false, percentage: 3.56}) # TaxRateCreateRequest | 
+
+begin
+  # Create Tax Rate
+  result = api_instance.create_tax_rate(tax_rate_create_request)
+  p result
+rescue PAYJPv2::ApiError => e
+  puts "Error when calling TaxRatesApi->create_tax_rate: #{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 Tax Rate
+  data, status_code, headers = api_instance.create_tax_rate(tax_rate_create_request, { include_http_info: true })
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <TaxRateDetailsResponse>
+rescue PAYJPv2::ApiError => e
+  puts "Error when calling TaxRatesApi->create_tax_rate: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **tax_rate_create_request** | [**TaxRateCreateRequest**](TaxRateCreateRequest.md) |  |  |
+
+### Return type
+
+[**TaxRateDetailsResponse**](TaxRateDetailsResponse.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_tax_rates
+
+> <TaxRateListResponse> get_all_tax_rates(opts)
+
+Get All Tax Rates
+
+### 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::TaxRatesApi.new
+opts = {
+  limit: 56, # Integer | 取得するデータの最大件数
+  starting_after: 'starting_after_example', # String | このIDより後のデータを取得
+  ending_before: 'ending_before_example' # String | このIDより前のデータを取得
+}
+
+begin
+  # Get All Tax Rates
+  result = api_instance.get_all_tax_rates(opts)
+  p result
+rescue PAYJPv2::ApiError => e
+  puts "Error when calling TaxRatesApi->get_all_tax_rates: #{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 Tax Rates
+  data, status_code, headers = api_instance.get_all_tax_rates(opts.merge(include_http_info: true))
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <TaxRateListResponse>
+rescue PAYJPv2::ApiError => e
+  puts "Error when calling TaxRatesApi->get_all_tax_rates: #{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
+
+[**TaxRateListResponse**](TaxRateListResponse.md)
+
+### Authorization
+
+[HTTPBasic](../README.md#HTTPBasic), [HTTPBearer](../README.md#HTTPBearer)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json, application/problem+json
+
+
+## get_tax_rate
+
+> <TaxRateDetailsResponse> get_tax_rate(tax_rate_id)
+
+Get Tax Rate
+
+### 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::TaxRatesApi.new
+tax_rate_id = 'tax_rate_id_example' # String | 
+
+begin
+  # Get Tax Rate
+  result = api_instance.get_tax_rate(tax_rate_id)
+  p result
+rescue PAYJPv2::ApiError => e
+  puts "Error when calling TaxRatesApi->get_tax_rate: #{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 Tax Rate
+  data, status_code, headers = api_instance.get_tax_rate(tax_rate_id, { include_http_info: true })
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <TaxRateDetailsResponse>
+rescue PAYJPv2::ApiError => e
+  puts "Error when calling TaxRatesApi->get_tax_rate: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **tax_rate_id** | **String** |  |  |
+
+### Return type
+
+[**TaxRateDetailsResponse**](TaxRateDetailsResponse.md)
+
+### Authorization
+
+[HTTPBasic](../README.md#HTTPBasic), [HTTPBearer](../README.md#HTTPBearer)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json, application/problem+json
+
+
+## update_tax_rate
+
+> <TaxRateDetailsResponse> update_tax_rate(tax_rate_id, tax_rate_update_request)
+
+Update Tax Rate
+
+### 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::TaxRatesApi.new
+tax_rate_id = 'tax_rate_id_example' # String | 
+tax_rate_update_request = PAYJPv2::TaxRateUpdateRequest.new # TaxRateUpdateRequest | 
+
+begin
+  # Update Tax Rate
+  result = api_instance.update_tax_rate(tax_rate_id, tax_rate_update_request)
+  p result
+rescue PAYJPv2::ApiError => e
+  puts "Error when calling TaxRatesApi->update_tax_rate: #{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 Tax Rate
+  data, status_code, headers = api_instance.update_tax_rate(tax_rate_id, tax_rate_update_request, { include_http_info: true })
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <TaxRateDetailsResponse>
+rescue PAYJPv2::ApiError => e
+  puts "Error when calling TaxRatesApi->update_tax_rate: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **tax_rate_id** | **String** |  |  |
+| **tax_rate_update_request** | [**TaxRateUpdateRequest**](TaxRateUpdateRequest.md) |  |  |
+
+### Return type
+
+[**TaxRateDetailsResponse**](TaxRateDetailsResponse.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/TermListResponse.md

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

data/docs/TermResponse.md

@@ -0,0 +1,28 @@
+# PAYJPv2::TermResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **object** | **String** |  | [optional][default to 'term'] |
+| **id** | **String** | 集計区間 ID |  |
+| **livemode** | **Boolean** | 本番環境かどうか |  |
+| **start_at** | **Time** | 区間開始時刻 |  |
+| **end_at** | **Time** | 区間終了時刻  Term が表す区間は start_at 以上 end_at 未満の範囲となります。 翌サイクルの Term の場合 null を返します。 |  |
+| **closed** | **Boolean** | 締め処理が完了済みなら true |  |
+
+## Example
+
+```ruby
+require 'payjpv2'
+
+instance = PAYJPv2::TermResponse.new(
+  object: null,
+  id: null,
+  livemode: null,
+  start_at: null,
+  end_at: null,
+  closed: null
+)
+```
+