payjpv2 1.0.2

data/README.md

@@ -0,0 +1,399 @@
+# payjpv2
+
+A Ruby client library for the PAY.JP v2 API. This SDK provides a convenient way to interact with PAY.JP's payment processing services from Ruby applications.
+
+This Ruby gem is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
+
+- API version: 2.0.0
+- Package version: 1.0.2
+- Generator version: 7.14.0
+- Build package: org.openapitools.codegen.languages.RubyClientCodegen
+
+## Requirements
+
+Ruby 3.2+
+
+## Installation & Usage
+
+### Install from RubyGems
+
+```sh
+gem install payjpv2
+```
+
+### Using Bundler
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'payjpv2', '~> 1.0.2'
+```
+
+Then execute:
+
+```sh
+bundle install
+```
+
+### Install from Git
+
+If you want to use the latest development version, add this to your Gemfile:
+
+```ruby
+gem 'payjpv2', git: 'https://github.com/payjp/payjpv2-ruby.git'
+```
+
+Then import the package:
+
+```ruby
+require 'payjpv2'
+```
+
+## Getting Started
+
+Please follow the [installation](#installation--usage) procedure and then run the following:
+
+```ruby
+require 'payjpv2'
+require 'securerandom'
+
+# Configure Bearer authentication with API key
+# You can set your API key via environment variable or directly in code
+PAYJPv2.configure do |config|
+  config.access_token = ENV['PAYJP_API_KEY']
+end
+
+# Create API instance
+customers_api = PAYJPv2::CustomersApi.new
+
+begin
+  # Create a customer with idempotency key
+  customer_request = PAYJPv2::CustomerCreateRequest.new(
+    email: 'customer@example.com',
+    description: 'Test customer'
+  )
+
+  idempotency_key = SecureRandom.uuid
+  customer = customers_api.create_customer(
+    customer_request,
+    idempotency_key: idempotency_key
+  )
+  puts "Created customer: #{customer.id}"
+  puts "Email: #{customer.email}"
+
+  # Retrieve a customer
+  retrieved = customers_api.get_customer(customer.id)
+  puts "Retrieved customer: #{retrieved.id}"
+
+  # List customers with pagination
+  customer_list = customers_api.get_all_customers(limit: 10)
+  customer_list.data.each do |c|
+    puts "  - #{c.id} (#{c.email || 'no email'})"
+  end
+
+rescue PAYJPv2::ApiError => e
+  puts "API Error: #{e.message}"
+  puts "HTTP status code: #{e.code}" if e.code
+end
+```
+
+## Configuration
+
+### Environment Variables
+
+For security, it's recommended to store your API key in environment variables:
+
+```bash
+export PAYJP_API_KEY=sk_test_xxxxxxxxxxxx
+```
+
+### Configuration Options
+
+```ruby
+PAYJPv2.configure do |config|
+  # API Host (optional, defaults to https://api.pay.jp)
+  config.host = 'https://api.pay.jp'
+
+  # Bearer authentication (recommended)
+  config.access_token = ENV['PAYJP_API_KEY']
+
+  # Or use a proc to dynamically fetch the token
+  config.access_token_getter = -> { fetch_token_from_secure_storage }
+end
+```
+
+### Idempotency Keys
+
+PAY.JP supports idempotency keys to safely retry requests without accidentally performing the same operation twice:
+
+```ruby
+require 'securerandom'
+
+idempotency_key = SecureRandom.uuid
+customer = customers_api.create_customer(
+  customer_request,
+  idempotency_key: idempotency_key
+)
+```
+
+## Accessing HTTP Response Details
+
+By default, API methods return only the response data. If you need access to the HTTP status code and headers, use the `include_http_info` option:
+
+```ruby
+# Default: returns data only
+customer = customers_api.get_customer('cus_xxxxx')
+
+# With include_http_info: returns [data, status_code, headers]
+data, status_code, headers = customers_api.get_customer(
+  'cus_xxxxx',
+  include_http_info: true
+)
+
+puts "Status: #{status_code}"        # => 200
+puts "Headers: #{headers}"           # => { "Content-Type" => "application/json", ... }
+puts "Customer ID: #{data.id}"       # => "cus_xxxxx"
+```
+
+## Error Handling
+
+The SDK raises `PAYJPv2::ApiError` exceptions for API errors:
+
+```ruby
+begin
+  customer = customers_api.create_customer(customer_request)
+rescue PAYJPv2::ApiError => e
+  puts "Error: #{e.message}"
+  puts "Status code: #{e.code}" if e.code
+  puts "Response body: #{e.response_body}" if e.response_body
+  puts "Response headers: #{e.response_headers}" if e.response_headers
+end
+```
+
+### Available Error Attributes
+
+- `e.message` - Error message
+- `e.code` - HTTP status code
+- `e.response_body` - Raw response body
+- `e.response_headers` - Response headers
+
+### Common HTTP Status Codes
+
+- `400` - Invalid request parameters
+- `401` - Authentication error (invalid API key)
+- `403` - Permission error
+- `404` - Resource not found
+- `429` - Rate limit exceeded
+- `500` - Internal server error
+
+## Documentation for API Endpoints
+
+All URIs are relative to *http://localhost*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*PAYJPv2::BalancesApi* | [**create_balance_url**](docs/BalancesApi.md#create_balance_url) | **POST** /v2/balances/{balance_id}/balance_urls | Create Balance Url
+*PAYJPv2::BalancesApi* | [**get_all_balances**](docs/BalancesApi.md#get_all_balances) | **GET** /v2/balances | Get All Balances
+*PAYJPv2::BalancesApi* | [**get_balance**](docs/BalancesApi.md#get_balance) | **GET** /v2/balances/{balance_id} | Get Balance
+*PAYJPv2::CheckoutSessionsApi* | [**create_checkout_session**](docs/CheckoutSessionsApi.md#create_checkout_session) | **POST** /v2/checkout/sessions | Create Checkout Session
+*PAYJPv2::CheckoutSessionsApi* | [**get_all_checkout_session_line_items**](docs/CheckoutSessionsApi.md#get_all_checkout_session_line_items) | **GET** /v2/checkout/sessions/{checkout_session_id}/line_items | Get All Checkout Session Line Items
+*PAYJPv2::CheckoutSessionsApi* | [**get_all_checkout_sessions**](docs/CheckoutSessionsApi.md#get_all_checkout_sessions) | **GET** /v2/checkout/sessions | Get All Checkout Sessions
+*PAYJPv2::CheckoutSessionsApi* | [**get_checkout_session**](docs/CheckoutSessionsApi.md#get_checkout_session) | **GET** /v2/checkout/sessions/{checkout_session_id} | Get Checkout Session
+*PAYJPv2::CheckoutSessionsApi* | [**update_checkout_session**](docs/CheckoutSessionsApi.md#update_checkout_session) | **POST** /v2/checkout/sessions/{checkout_session_id} | Update Checkout Session
+*PAYJPv2::CustomersApi* | [**create_customer**](docs/CustomersApi.md#create_customer) | **POST** /v2/customers | Create Customer
+*PAYJPv2::CustomersApi* | [**delete_customer**](docs/CustomersApi.md#delete_customer) | **DELETE** /v2/customers/{customer_id} | Delete Customer
+*PAYJPv2::CustomersApi* | [**get_all_customers**](docs/CustomersApi.md#get_all_customers) | **GET** /v2/customers | Get All Customers
+*PAYJPv2::CustomersApi* | [**get_customer**](docs/CustomersApi.md#get_customer) | **GET** /v2/customers/{customer_id} | Get Customer
+*PAYJPv2::CustomersApi* | [**get_customer_payment_methods**](docs/CustomersApi.md#get_customer_payment_methods) | **GET** /v2/customers/{customer_id}/payment_methods | Get Customer Payment Methods
+*PAYJPv2::CustomersApi* | [**update_customer**](docs/CustomersApi.md#update_customer) | **POST** /v2/customers/{customer_id} | Update Customer
+*PAYJPv2::EventsApi* | [**get_all_events**](docs/EventsApi.md#get_all_events) | **GET** /v2/events | Get All Events
+*PAYJPv2::EventsApi* | [**get_event**](docs/EventsApi.md#get_event) | **GET** /v2/events/{event_id} | Get Event
+*PAYJPv2::PaymentDisputesApi* | [**get_all_payment_disputes**](docs/PaymentDisputesApi.md#get_all_payment_disputes) | **GET** /v2/payment_disputes | Get All Payment Disputes
+*PAYJPv2::PaymentDisputesApi* | [**get_payment_dispute**](docs/PaymentDisputesApi.md#get_payment_dispute) | **GET** /v2/payment_disputes/{payment_dispute_id} | Get Payment Dispute
+*PAYJPv2::PaymentFlowsApi* | [**cancel_payment_flow**](docs/PaymentFlowsApi.md#cancel_payment_flow) | **POST** /v2/payment_flows/{payment_flow_id}/cancel | Cancel Payment Flow
+*PAYJPv2::PaymentFlowsApi* | [**capture_payment_flow**](docs/PaymentFlowsApi.md#capture_payment_flow) | **POST** /v2/payment_flows/{payment_flow_id}/capture | Capture Payment Flow
+*PAYJPv2::PaymentFlowsApi* | [**confirm_payment_flow**](docs/PaymentFlowsApi.md#confirm_payment_flow) | **POST** /v2/payment_flows/{payment_flow_id}/confirm | Confirm Payment Flow
+*PAYJPv2::PaymentFlowsApi* | [**create_payment_flow**](docs/PaymentFlowsApi.md#create_payment_flow) | **POST** /v2/payment_flows | Create Payment Flow
+*PAYJPv2::PaymentFlowsApi* | [**get_all_payment_flows**](docs/PaymentFlowsApi.md#get_all_payment_flows) | **GET** /v2/payment_flows | Get All Payment Flows
+*PAYJPv2::PaymentFlowsApi* | [**get_payment_flow**](docs/PaymentFlowsApi.md#get_payment_flow) | **GET** /v2/payment_flows/{payment_flow_id} | Get Payment Flow
+*PAYJPv2::PaymentFlowsApi* | [**get_payment_flow_refunds**](docs/PaymentFlowsApi.md#get_payment_flow_refunds) | **GET** /v2/payment_flows/{payment_flow_id}/refunds | Get Payment Flow Refunds
+*PAYJPv2::PaymentFlowsApi* | [**update_payment_flow**](docs/PaymentFlowsApi.md#update_payment_flow) | **POST** /v2/payment_flows/{payment_flow_id} | Update Payment Flow
+*PAYJPv2::PaymentMethodConfigurationsApi* | [**get_all_payment_method_configurations**](docs/PaymentMethodConfigurationsApi.md#get_all_payment_method_configurations) | **GET** /v2/payment_method_configurations | Get All Payment Method Configurations
+*PAYJPv2::PaymentMethodConfigurationsApi* | [**get_payment_method_configuration**](docs/PaymentMethodConfigurationsApi.md#get_payment_method_configuration) | **GET** /v2/payment_method_configurations/{payment_method_configuration_id} | Get Payment Method Configuration
+*PAYJPv2::PaymentMethodConfigurationsApi* | [**update_payment_method_configuration**](docs/PaymentMethodConfigurationsApi.md#update_payment_method_configuration) | **POST** /v2/payment_method_configurations/{payment_method_configuration_id} | Update Payment Method Configuration
+*PAYJPv2::PaymentMethodsApi* | [**attach_payment_method**](docs/PaymentMethodsApi.md#attach_payment_method) | **POST** /v2/payment_methods/{payment_method_id}/attach | Attach Payment Method
+*PAYJPv2::PaymentMethodsApi* | [**create_payment_method**](docs/PaymentMethodsApi.md#create_payment_method) | **POST** /v2/payment_methods | Create Payment Method
+*PAYJPv2::PaymentMethodsApi* | [**detach_payment_method**](docs/PaymentMethodsApi.md#detach_payment_method) | **POST** /v2/payment_methods/{payment_method_id}/detach | Detach Payment Method
+*PAYJPv2::PaymentMethodsApi* | [**get_all_payment_methods**](docs/PaymentMethodsApi.md#get_all_payment_methods) | **GET** /v2/payment_methods | Get All Payment Methods
+*PAYJPv2::PaymentMethodsApi* | [**get_payment_method**](docs/PaymentMethodsApi.md#get_payment_method) | **GET** /v2/payment_methods/{payment_method_id} | Get Payment Method
+*PAYJPv2::PaymentMethodsApi* | [**get_payment_method_by_card**](docs/PaymentMethodsApi.md#get_payment_method_by_card) | **GET** /v2/payment_methods/cards/{card_id} | Get Payment Method By Card
+*PAYJPv2::PaymentMethodsApi* | [**update_payment_method**](docs/PaymentMethodsApi.md#update_payment_method) | **POST** /v2/payment_methods/{payment_method_id} | Update Payment Method
+*PAYJPv2::PaymentRefundsApi* | [**create_payment_refund**](docs/PaymentRefundsApi.md#create_payment_refund) | **POST** /v2/payment_refunds | Create Payment Refund
+*PAYJPv2::PaymentRefundsApi* | [**get_all_payment_refunds**](docs/PaymentRefundsApi.md#get_all_payment_refunds) | **GET** /v2/payment_refunds | Get All Payment Refunds
+*PAYJPv2::PaymentRefundsApi* | [**get_payment_refund**](docs/PaymentRefundsApi.md#get_payment_refund) | **GET** /v2/payment_refunds/{payment_refund_id} | Get Payment Refund
+*PAYJPv2::PaymentRefundsApi* | [**update_payment_refund**](docs/PaymentRefundsApi.md#update_payment_refund) | **POST** /v2/payment_refunds/{payment_refund_id} | Update Payment Refund
+*PAYJPv2::PaymentTransactionsApi* | [**get_all_payment_transactions**](docs/PaymentTransactionsApi.md#get_all_payment_transactions) | **GET** /v2/payment_transactions | Get All Payment Transactions
+*PAYJPv2::PaymentTransactionsApi* | [**get_payment_transaction**](docs/PaymentTransactionsApi.md#get_payment_transaction) | **GET** /v2/payment_transactions/{payment_transaction_id} | Get Payment Transaction
+*PAYJPv2::PricesApi* | [**create_price**](docs/PricesApi.md#create_price) | **POST** /v2/prices | Create Price
+*PAYJPv2::PricesApi* | [**get_all_prices**](docs/PricesApi.md#get_all_prices) | **GET** /v2/prices | Get All Prices
+*PAYJPv2::PricesApi* | [**get_price**](docs/PricesApi.md#get_price) | **GET** /v2/prices/{price_id} | Get Price
+*PAYJPv2::PricesApi* | [**update_price**](docs/PricesApi.md#update_price) | **POST** /v2/prices/{price_id} | Update Price
+*PAYJPv2::ProductsApi* | [**create_product**](docs/ProductsApi.md#create_product) | **POST** /v2/products | Create Product
+*PAYJPv2::ProductsApi* | [**delete_product**](docs/ProductsApi.md#delete_product) | **DELETE** /v2/products/{product_id} | Delete Product
+*PAYJPv2::ProductsApi* | [**get_all_products**](docs/ProductsApi.md#get_all_products) | **GET** /v2/products | Get All Products
+*PAYJPv2::ProductsApi* | [**get_product**](docs/ProductsApi.md#get_product) | **GET** /v2/products/{product_id} | Get Product
+*PAYJPv2::ProductsApi* | [**update_product**](docs/ProductsApi.md#update_product) | **POST** /v2/products/{product_id} | Update Product
+*PAYJPv2::SetupFlowsApi* | [**cancel_setup_flow**](docs/SetupFlowsApi.md#cancel_setup_flow) | **POST** /v2/setup_flows/{setup_flow_id}/cancel | Cancel Setup Flow
+*PAYJPv2::SetupFlowsApi* | [**create_setup_flow**](docs/SetupFlowsApi.md#create_setup_flow) | **POST** /v2/setup_flows | Create Setup Flow
+*PAYJPv2::SetupFlowsApi* | [**get_all_setup_flows**](docs/SetupFlowsApi.md#get_all_setup_flows) | **GET** /v2/setup_flows | Get All Setup Flows
+*PAYJPv2::SetupFlowsApi* | [**get_setup_flow**](docs/SetupFlowsApi.md#get_setup_flow) | **GET** /v2/setup_flows/{setup_flow_id} | Get Setup Flow
+*PAYJPv2::SetupFlowsApi* | [**update_setup_flow**](docs/SetupFlowsApi.md#update_setup_flow) | **POST** /v2/setup_flows/{setup_flow_id} | Update Setup Flow
+*PAYJPv2::StatementsApi* | [**create_statement_url**](docs/StatementsApi.md#create_statement_url) | **POST** /v2/statements/{statement_id}/statement_urls | Create Statement Url
+*PAYJPv2::StatementsApi* | [**get_all_statements**](docs/StatementsApi.md#get_all_statements) | **GET** /v2/statements | Get All Statements
+*PAYJPv2::StatementsApi* | [**get_statement**](docs/StatementsApi.md#get_statement) | **GET** /v2/statements/{statement_id} | Get Statement
+*PAYJPv2::TaxRatesApi* | [**create_tax_rate**](docs/TaxRatesApi.md#create_tax_rate) | **POST** /v2/tax_rates | Create Tax Rate
+*PAYJPv2::TaxRatesApi* | [**get_all_tax_rates**](docs/TaxRatesApi.md#get_all_tax_rates) | **GET** /v2/tax_rates | Get All Tax Rates
+*PAYJPv2::TaxRatesApi* | [**get_tax_rate**](docs/TaxRatesApi.md#get_tax_rate) | **GET** /v2/tax_rates/{tax_rate_id} | Get Tax Rate
+*PAYJPv2::TaxRatesApi* | [**update_tax_rate**](docs/TaxRatesApi.md#update_tax_rate) | **POST** /v2/tax_rates/{tax_rate_id} | Update Tax Rate
+*PAYJPv2::TermsApi* | [**get_all_terms**](docs/TermsApi.md#get_all_terms) | **GET** /v2/terms | Get All Terms
+*PAYJPv2::TermsApi* | [**get_term**](docs/TermsApi.md#get_term) | **GET** /v2/terms/{term_id} | Get Term
+
+
+## Documentation for Models
+
+ - [PAYJPv2::ApplePayConfigRequest](docs/ApplePayConfigRequest.md)
+ - [PAYJPv2::BalanceListResponse](docs/BalanceListResponse.md)
+ - [PAYJPv2::BalanceResponse](docs/BalanceResponse.md)
+ - [PAYJPv2::BalanceState](docs/BalanceState.md)
+ - [PAYJPv2::BalanceURLResponse](docs/BalanceURLResponse.md)
+ - [PAYJPv2::BankInfoResponse](docs/BankInfoResponse.md)
+ - [PAYJPv2::CaptureMethod](docs/CaptureMethod.md)
+ - [PAYJPv2::CardConfigRequest](docs/CardConfigRequest.md)
+ - [PAYJPv2::CheckoutSessionCreateRequest](docs/CheckoutSessionCreateRequest.md)
+ - [PAYJPv2::CheckoutSessionCustomerDetailsAddressResponse](docs/CheckoutSessionCustomerDetailsAddressResponse.md)
+ - [PAYJPv2::CheckoutSessionCustomerDetailsResponse](docs/CheckoutSessionCustomerDetailsResponse.md)
+ - [PAYJPv2::CheckoutSessionDetailsResponse](docs/CheckoutSessionDetailsResponse.md)
+ - [PAYJPv2::CheckoutSessionLineItemDataResponse](docs/CheckoutSessionLineItemDataResponse.md)
+ - [PAYJPv2::CheckoutSessionLineItemListResponse](docs/CheckoutSessionLineItemListResponse.md)
+ - [PAYJPv2::CheckoutSessionListResponse](docs/CheckoutSessionListResponse.md)
+ - [PAYJPv2::CheckoutSessionMode](docs/CheckoutSessionMode.md)
+ - [PAYJPv2::CheckoutSessionPaymentMethodOptionsCardRequest](docs/CheckoutSessionPaymentMethodOptionsCardRequest.md)
+ - [PAYJPv2::CheckoutSessionPaymentMethodOptionsRequest](docs/CheckoutSessionPaymentMethodOptionsRequest.md)
+ - [PAYJPv2::CheckoutSessionStatus](docs/CheckoutSessionStatus.md)
+ - [PAYJPv2::CheckoutSessionSubmitType](docs/CheckoutSessionSubmitType.md)
+ - [PAYJPv2::CheckoutSessionUIMode](docs/CheckoutSessionUIMode.md)
+ - [PAYJPv2::CheckoutSessionUpdateRequest](docs/CheckoutSessionUpdateRequest.md)
+ - [PAYJPv2::Country](docs/Country.md)
+ - [PAYJPv2::Currency](docs/Currency.md)
+ - [PAYJPv2::CustomerCreateRequest](docs/CustomerCreateRequest.md)
+ - [PAYJPv2::CustomerCreation](docs/CustomerCreation.md)
+ - [PAYJPv2::CustomerListResponse](docs/CustomerListResponse.md)
+ - [PAYJPv2::CustomerResponse](docs/CustomerResponse.md)
+ - [PAYJPv2::CustomerUpdateRequest](docs/CustomerUpdateRequest.md)
+ - [PAYJPv2::DisplayPreferenceRequest](docs/DisplayPreferenceRequest.md)
+ - [PAYJPv2::ErrorResponse](docs/ErrorResponse.md)
+ - [PAYJPv2::EventListResponse](docs/EventListResponse.md)
+ - [PAYJPv2::EventResponse](docs/EventResponse.md)
+ - [PAYJPv2::LineItemRequest](docs/LineItemRequest.md)
+ - [PAYJPv2::Locale](docs/Locale.md)
+ - [PAYJPv2::MetadataValue](docs/MetadataValue.md)
+ - [PAYJPv2::PayPayConfigRequest](docs/PayPayConfigRequest.md)
+ - [PAYJPv2::PaymentDisputeListResponse](docs/PaymentDisputeListResponse.md)
+ - [PAYJPv2::PaymentDisputeReason](docs/PaymentDisputeReason.md)
+ - [PAYJPv2::PaymentDisputeResponse](docs/PaymentDisputeResponse.md)
+ - [PAYJPv2::PaymentDisputeStatus](docs/PaymentDisputeStatus.md)
+ - [PAYJPv2::PaymentFlowCancelRequest](docs/PaymentFlowCancelRequest.md)
+ - [PAYJPv2::PaymentFlowCancellationReason](docs/PaymentFlowCancellationReason.md)
+ - [PAYJPv2::PaymentFlowCaptureRequest](docs/PaymentFlowCaptureRequest.md)
+ - [PAYJPv2::PaymentFlowConfirmRequest](docs/PaymentFlowConfirmRequest.md)
+ - [PAYJPv2::PaymentFlowCreateRequest](docs/PaymentFlowCreateRequest.md)
+ - [PAYJPv2::PaymentFlowDataRequest](docs/PaymentFlowDataRequest.md)
+ - [PAYJPv2::PaymentFlowListResponse](docs/PaymentFlowListResponse.md)
+ - [PAYJPv2::PaymentFlowPaymentMethodOptionsCardRequest](docs/PaymentFlowPaymentMethodOptionsCardRequest.md)
+ - [PAYJPv2::PaymentFlowPaymentMethodOptionsRequest](docs/PaymentFlowPaymentMethodOptionsRequest.md)
+ - [PAYJPv2::PaymentFlowResponse](docs/PaymentFlowResponse.md)
+ - [PAYJPv2::PaymentFlowStatus](docs/PaymentFlowStatus.md)
+ - [PAYJPv2::PaymentFlowUpdateRequest](docs/PaymentFlowUpdateRequest.md)
+ - [PAYJPv2::PaymentMethodApplePayCreateRequest](docs/PaymentMethodApplePayCreateRequest.md)
+ - [PAYJPv2::PaymentMethodApplePayUpdateRequest](docs/PaymentMethodApplePayUpdateRequest.md)
+ - [PAYJPv2::PaymentMethodAttachRequest](docs/PaymentMethodAttachRequest.md)
+ - [PAYJPv2::PaymentMethodBillingAddressRequest](docs/PaymentMethodBillingAddressRequest.md)
+ - [PAYJPv2::PaymentMethodBillingAddressResponse](docs/PaymentMethodBillingAddressResponse.md)
+ - [PAYJPv2::PaymentMethodBillingDetailsRequest](docs/PaymentMethodBillingDetailsRequest.md)
+ - [PAYJPv2::PaymentMethodBillingDetailsResponse](docs/PaymentMethodBillingDetailsResponse.md)
+ - [PAYJPv2::PaymentMethodCardBillingDetailsRequest](docs/PaymentMethodCardBillingDetailsRequest.md)
+ - [PAYJPv2::PaymentMethodCardCreateRequest](docs/PaymentMethodCardCreateRequest.md)
+ - [PAYJPv2::PaymentMethodCardDetailsResponse](docs/PaymentMethodCardDetailsResponse.md)
+ - [PAYJPv2::PaymentMethodCardResponse](docs/PaymentMethodCardResponse.md)
+ - [PAYJPv2::PaymentMethodCardUpdateRequest](docs/PaymentMethodCardUpdateRequest.md)
+ - [PAYJPv2::PaymentMethodConfigurationDetailsResponse](docs/PaymentMethodConfigurationDetailsResponse.md)
+ - [PAYJPv2::PaymentMethodConfigurationDisplayPreference](docs/PaymentMethodConfigurationDisplayPreference.md)
+ - [PAYJPv2::PaymentMethodConfigurationListResponse](docs/PaymentMethodConfigurationListResponse.md)
+ - [PAYJPv2::PaymentMethodConfigurationSettingResponse](docs/PaymentMethodConfigurationSettingResponse.md)
+ - [PAYJPv2::PaymentMethodConfigurationUpdateRequest](docs/PaymentMethodConfigurationUpdateRequest.md)
+ - [PAYJPv2::PaymentMethodCreateCardDetailsRequest](docs/PaymentMethodCreateCardDetailsRequest.md)
+ - [PAYJPv2::PaymentMethodCreateRequest](docs/PaymentMethodCreateRequest.md)
+ - [PAYJPv2::PaymentMethodListResponse](docs/PaymentMethodListResponse.md)
+ - [PAYJPv2::PaymentMethodPayPayCreateRequest](docs/PaymentMethodPayPayCreateRequest.md)
+ - [PAYJPv2::PaymentMethodPayPayResponse](docs/PaymentMethodPayPayResponse.md)
+ - [PAYJPv2::PaymentMethodPayPayUpdateRequest](docs/PaymentMethodPayPayUpdateRequest.md)
+ - [PAYJPv2::PaymentMethodResponse](docs/PaymentMethodResponse.md)
+ - [PAYJPv2::PaymentMethodTypes](docs/PaymentMethodTypes.md)
+ - [PAYJPv2::PaymentMethodUpdateRequest](docs/PaymentMethodUpdateRequest.md)
+ - [PAYJPv2::PaymentRefundCreateRequest](docs/PaymentRefundCreateRequest.md)
+ - [PAYJPv2::PaymentRefundListResponse](docs/PaymentRefundListResponse.md)
+ - [PAYJPv2::PaymentRefundReason](docs/PaymentRefundReason.md)
+ - [PAYJPv2::PaymentRefundResponse](docs/PaymentRefundResponse.md)
+ - [PAYJPv2::PaymentRefundStatus](docs/PaymentRefundStatus.md)
+ - [PAYJPv2::PaymentRefundUpdateRequest](docs/PaymentRefundUpdateRequest.md)
+ - [PAYJPv2::PaymentTransactionListResponse](docs/PaymentTransactionListResponse.md)
+ - [PAYJPv2::PaymentTransactionResponse](docs/PaymentTransactionResponse.md)
+ - [PAYJPv2::PaymentTransactionType](docs/PaymentTransactionType.md)
+ - [PAYJPv2::PriceCreateRequest](docs/PriceCreateRequest.md)
+ - [PAYJPv2::PriceDetailsResponse](docs/PriceDetailsResponse.md)
+ - [PAYJPv2::PriceListResponse](docs/PriceListResponse.md)
+ - [PAYJPv2::PriceType](docs/PriceType.md)
+ - [PAYJPv2::PriceUpdateRequest](docs/PriceUpdateRequest.md)
+ - [PAYJPv2::ProductCreateRequest](docs/ProductCreateRequest.md)
+ - [PAYJPv2::ProductDeletedResponse](docs/ProductDeletedResponse.md)
+ - [PAYJPv2::ProductDetailsResponse](docs/ProductDetailsResponse.md)
+ - [PAYJPv2::ProductListResponse](docs/ProductListResponse.md)
+ - [PAYJPv2::ProductUpdateRequest](docs/ProductUpdateRequest.md)
+ - [PAYJPv2::SetupFlowCancelRequest](docs/SetupFlowCancelRequest.md)
+ - [PAYJPv2::SetupFlowCancellationReason](docs/SetupFlowCancellationReason.md)
+ - [PAYJPv2::SetupFlowCreateRequest](docs/SetupFlowCreateRequest.md)
+ - [PAYJPv2::SetupFlowDataRequest](docs/SetupFlowDataRequest.md)
+ - [PAYJPv2::SetupFlowListResponse](docs/SetupFlowListResponse.md)
+ - [PAYJPv2::SetupFlowPaymentMethodOptionsCardRequest](docs/SetupFlowPaymentMethodOptionsCardRequest.md)
+ - [PAYJPv2::SetupFlowPaymentMethodOptionsRequest](docs/SetupFlowPaymentMethodOptionsRequest.md)
+ - [PAYJPv2::SetupFlowResponse](docs/SetupFlowResponse.md)
+ - [PAYJPv2::SetupFlowStatus](docs/SetupFlowStatus.md)
+ - [PAYJPv2::SetupFlowUpdateRequest](docs/SetupFlowUpdateRequest.md)
+ - [PAYJPv2::StatementItemResponse](docs/StatementItemResponse.md)
+ - [PAYJPv2::StatementListResponse](docs/StatementListResponse.md)
+ - [PAYJPv2::StatementResponse](docs/StatementResponse.md)
+ - [PAYJPv2::StatementSubject](docs/StatementSubject.md)
+ - [PAYJPv2::StatementType](docs/StatementType.md)
+ - [PAYJPv2::StatementURLResponse](docs/StatementURLResponse.md)
+ - [PAYJPv2::TaxRateCreateRequest](docs/TaxRateCreateRequest.md)
+ - [PAYJPv2::TaxRateDetailsResponse](docs/TaxRateDetailsResponse.md)
+ - [PAYJPv2::TaxRateListResponse](docs/TaxRateListResponse.md)
+ - [PAYJPv2::TaxRateUpdateRequest](docs/TaxRateUpdateRequest.md)
+ - [PAYJPv2::TermListResponse](docs/TermListResponse.md)
+ - [PAYJPv2::TermResponse](docs/TermResponse.md)
+ - [PAYJPv2::Usage](docs/Usage.md)
+
+
+## Documentation for Authorization
+
+
+Authentication schemes defined for the API:
+### HTTPBasic
+
+- **Type**: HTTP basic authentication
+
+### HTTPBearer
+
+- **Type**: Bearer authentication
+
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+  # no rspec available
+end

data/docs/ApplePayConfigRequest.md

@@ -0,0 +1,18 @@
+# PAYJPv2::ApplePayConfigRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **display_preference** | [**DisplayPreferenceRequest**](DisplayPreferenceRequest.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'payjpv2'
+
+instance = PAYJPv2::ApplePayConfigRequest.new(
+  display_preference: null
+)
+```
+

data/docs/BalanceListResponse.md

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

data/docs/BalanceResponse.md

@@ -0,0 +1,40 @@
+# PAYJPv2::BalanceResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **object** | **String** |  | [optional][default to 'balance'] |
+| **id** | **String** | 残高 ID |  |
+| **livemode** | **Boolean** | 本番環境かどうか |  |
+| **state** | [**BalanceState**](BalanceState.md) | Balance の状態  | 値 | |:---| | **collecting**: 集計中 | | **transfer**: 入金 | | **claim**: 請求 | |  |
+| **statements** | [**Array<StatementResponse>**](StatementResponse.md) | 関連付けられている Statement オブジェクトのリスト |  |
+| **closed** | **Boolean** | この Balance の清算が終了していれば true  state=transfer であれば加盟店口座への入金作業完了、state=claim であれば PAY.JP で請求額の振込が確認できたことを表します。 |  |
+| **closed_date** | **Time** |  |  |
+| **due_date** | **Time** |  |  |
+| **net** | **Integer** | 関連付けられている Statement の総額 |  |
+| **bank_info** | [**BankInfoResponse**](BankInfoResponse.md) |  |  |
+| **created_at** | **Time** | 作成日時 (UTC, ISO 8601 形式) |  |
+| **updated_at** | **Time** | 更新時の日時 (UTC, ISO 8601 形式) |  |
+
+## Example
+
+```ruby
+require 'payjpv2'
+
+instance = PAYJPv2::BalanceResponse.new(
+  object: null,
+  id: null,
+  livemode: null,
+  state: null,
+  statements: null,
+  closed: null,
+  closed_date: null,
+  due_date: null,
+  net: null,
+  bank_info: null,
+  created_at: null,
+  updated_at: null
+)
+```
+

data/docs/BalanceState.md

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

data/docs/BalanceURLResponse.md

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