payjpv2 1.0.2

data/docs/TermsApi.md

@@ -0,0 +1,157 @@
+# PAYJPv2::TermsApi
+
+All URIs are relative to *http://localhost*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_all_terms**](TermsApi.md#get_all_terms) | **GET** /v2/terms | Get All Terms |
+| [**get_term**](TermsApi.md#get_term) | **GET** /v2/terms/{term_id} | Get Term |
+
+
+## get_all_terms
+
+> <TermListResponse> get_all_terms(opts)
+
+Get All Terms
+
+### 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::TermsApi.new
+opts = {
+  limit: 56, # Integer | 取得するデータの最大件数
+  starting_after: 'starting_after_example', # String | このIDより後のデータを取得
+  ending_before: 'ending_before_example', # String | このIDより前のデータを取得
+  since_start_at: Time.parse('2013-10-20T19:20:30+01:00'), # Time | start_at が指定した日付以降のデータを取得
+  until_start_at: Time.parse('2013-10-20T19:20:30+01:00') # Time | start_at が指定した日付以前のデータを取得
+}
+
+begin
+  # Get All Terms
+  result = api_instance.get_all_terms(opts)
+  p result
+rescue PAYJPv2::ApiError => e
+  puts "Error when calling TermsApi->get_all_terms: #{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 Terms
+  data, status_code, headers = api_instance.get_all_terms(opts.merge(include_http_info: true))
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <TermListResponse>
+rescue PAYJPv2::ApiError => e
+  puts "Error when calling TermsApi->get_all_terms: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **limit** | **Integer** | 取得するデータの最大件数 | [optional][default to 10] |
+| **starting_after** | **String** | このIDより後のデータを取得 | [optional] |
+| **ending_before** | **String** | このIDより前のデータを取得 | [optional] |
+| **since_start_at** | **Time** | start_at が指定した日付以降のデータを取得 | [optional] |
+| **until_start_at** | **Time** | start_at が指定した日付以前のデータを取得 | [optional] |
+
+### Return type
+
+[**TermListResponse**](TermListResponse.md)
+
+### Authorization
+
+[HTTPBasic](../README.md#HTTPBasic), [HTTPBearer](../README.md#HTTPBearer)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json, application/problem+json
+
+
+## get_term
+
+> <TermResponse> get_term(term_id)
+
+Get Term
+
+### 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::TermsApi.new
+term_id = 'term_id_example' # String | 
+
+begin
+  # Get Term
+  result = api_instance.get_term(term_id)
+  p result
+rescue PAYJPv2::ApiError => e
+  puts "Error when calling TermsApi->get_term: #{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 Term
+  data, status_code, headers = api_instance.get_term(term_id, { include_http_info: true })
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <TermResponse>
+rescue PAYJPv2::ApiError => e
+  puts "Error when calling TermsApi->get_term: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **term_id** | **String** |  |  |
+
+### Return type
+
+[**TermResponse**](TermResponse.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/Usage.md

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

data/example.rb

@@ -0,0 +1,157 @@
+require 'payjpv2'
+require 'pp'
+require 'securerandom'
+
+# Example usage
+api_host = ENV['PAYJP_API_HOST'] || 'https://api.pay.jp'
+api_key = ENV['PAYJP_API_KEY'] || ''
+
+if api_key.empty?
+  warn "Error: Please set the PAYJP_API_KEY environment variable"
+  exit 1
+end
+
+# Configure authentication method
+PAYJPv2.configure do |config|
+  config.host = api_host
+  config.access_token = api_key
+end
+
+api_instance = PAYJPv2::CustomersApi.new
+checkout_sessions_api = PAYJPv2::CheckoutSessionsApi.new
+products_api = PAYJPv2::ProductsApi.new
+prices_api = PAYJPv2::PricesApi.new
+
+customer_create_request = PAYJPv2::CustomerCreateRequest.new(
+  email: 'jennyrosen@example.com'
+)
+
+# Test idempotency key
+idempotency_key = SecureRandom.uuid
+puts "Using Idempotency-Key: #{idempotency_key}"
+
+begin
+  # 1. Create Customer
+  puts "=== 1. Create Customer ==="
+  result = api_instance.create_customer(
+    customer_create_request,
+    idempotency_key: idempotency_key
+  )
+  customer_id = result.id
+  puts "Created customer: #{customer_id}"
+  puts "Email: #{result.email}\n\n"
+
+  # 2. Get Customer
+  puts "=== 2. Get Customer ==="
+  retrieved = api_instance.get_customer(customer_id)
+  puts "Retrieved customer: #{retrieved.id}"
+  puts "Email: #{retrieved.email}"
+  puts "Description: #{retrieved.description || '(none)'}\n\n"
+
+  # 3. Update Customer
+  puts "=== 3. Update Customer ==="
+  update_request = PAYJPv2::CustomerUpdateRequest.new(
+    email: 'updated@example.com',
+    description: 'Updated description from Ruby SDK'
+  )
+  updated = api_instance.update_customer(customer_id, update_request)
+  puts "Updated customer: #{updated.id}"
+  puts "New email: #{updated.email}"
+  puts "New description: #{updated.description || '(none)'}\n\n"
+
+  # 4. List Customers
+  puts "=== 4. List Customers ==="
+  customer_list = api_instance.get_all_customers(limit: 3)
+  puts "Total customers retrieved: #{customer_list.data.length}"
+  customer_list.data.each do |c|
+    puts "  - #{c.id} (#{c.email || 'no email'})"
+  end
+  puts "\n"
+
+  # 5. Delete Customer
+  puts "=== 5. Delete Customer ==="
+  api_instance.delete_customer(customer_id)
+  puts "Deleted customer: #{customer_id}\n\n"
+
+  # 6. Create Product, Price, and Checkout Session
+  puts "=== 6. Create Product, Price, and Checkout Session ==="
+
+  # 6a. Create Product
+  puts "\n--- 6a. Create Product ---"
+  product_request = PAYJPv2::ProductCreateRequest.new(
+    name: 'Sample Product',
+    description: 'A sample product for checkout session demo',
+    active: true
+  )
+
+  product_idempotency_key = SecureRandom.uuid
+  puts "Using Idempotency-Key: #{product_idempotency_key}"
+
+  product = products_api.create_product(
+    product_request,
+    idempotency_key: product_idempotency_key
+  )
+  product_id = product.id
+  puts "Created product: #{product_id}"
+  puts "Product name: #{product.name}"
+
+  # 6b. Create Price
+  puts "\n--- 6b. Create Price ---"
+  price_request = PAYJPv2::PriceCreateRequest.new(
+    currency: 'jpy',
+    product_id: product_id,
+    unit_amount: 1000,  # 1000 JPY
+    nickname: 'Sample Price - 1000 JPY',
+    active: true
+  )
+
+  price_idempotency_key = SecureRandom.uuid
+  puts "Using Idempotency-Key: #{price_idempotency_key}"
+
+  price = prices_api.create_price(
+    price_request,
+    idempotency_key: price_idempotency_key
+  )
+  price_id = price.id
+  puts "Created price: #{price_id}"
+  puts "Unit amount: #{price.unit_amount} JPY"
+
+  # 6c. Create Checkout Session
+  puts "\n--- 6c. Create Checkout Session ---"
+  line_items = [
+    PAYJPv2::LineItemRequest.new(
+      price_id: price_id,  # Use the actual price ID we just created
+      quantity: 1
+    )
+  ]
+
+  checkout_request = PAYJPv2::CheckoutSessionCreateRequest.new(
+    mode: 'payment',
+    line_items: line_items,
+    success_url: 'https://example.com/success',
+    cancel_url: 'https://example.com/cancel',
+    currency: 'jpy',
+    customer_email: 'test@example.com',
+    locale: 'ja',
+    metadata: { order_id: 'order_123' }
+  )
+
+  checkout_idempotency_key = SecureRandom.uuid
+  puts "Using Idempotency-Key: #{checkout_idempotency_key}"
+
+  checkout_session = checkout_sessions_api.create_checkout_session(
+    checkout_request,
+    idempotency_key: checkout_idempotency_key
+  )
+
+  puts "Created checkout session: #{checkout_session.id}"
+  puts "Session URL: #{checkout_session.url}"
+  puts "Status: #{checkout_session.status}"
+  puts "Mode: #{checkout_session.mode}"
+  puts "Currency: #{checkout_session.currency}\n\n"
+
+  puts "=== All tests passed! ==="
+
+rescue PAYJPv2::ApiError => e
+  puts "Exception when calling CustomersApi->create_customer: #{e}"
+end

data/lib/payjpv2/api/balances_api.rb

@@ -0,0 +1,223 @@
+=begin
+#PAY.JP API v2
+
+#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+The version of the OpenAPI document: 2.0.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.14.0
+
+=end
+
+require 'cgi'
+
+module PAYJPv2
+  class BalancesApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Create Balance Url
+    # @param balance_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :idempotency_key Idempotency key for the request
+    # @option opts [Boolean] :include_http_info If true, returns [data, status_code, headers] instead of just data
+    # @return [BalanceURLResponse, Array] Returns data or [data, status_code, headers] if include_http_info is true
+    def create_balance_url(balance_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: BalancesApi.create_balance_url ...'
+      end
+      # verify the required parameter 'balance_id' is set
+      if @api_client.config.client_side_validation && balance_id.nil?
+        raise ArgumentError, "Missing the required parameter 'balance_id' when calling BalancesApi.create_balance_url"
+      end
+      # resource path
+      local_var_path = '/v2/balances/{balance_id}/balance_urls'.sub('{' + 'balance_id' + '}', CGI.escape(balance_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      header_params['Idempotency-Key'] = opts[:idempotency_key] if opts[:idempotency_key]
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'BalanceURLResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['HTTPBasic', 'HTTPBearer']
+
+      new_options = opts.merge(
+        :operation => :"BalancesApi.create_balance_url",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: BalancesApi#create_balance_url\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+
+      if opts[:include_http_info]
+        [data, status_code, headers]
+      else
+        data
+      end
+    end
+
+    # Get All Balances
+    # @param [Hash] opts the optional parameters
+    # @option opts [Time] :since 指定した日付以降のデータを取得
+    # @option opts [Time] :_until 指定した日付以前のデータを取得
+    # @option opts [Integer] :limit 取得するデータの最大件数 (default to 10)
+    # @option opts [String] :starting_after このIDより後のデータを取得
+    # @option opts [String] :ending_before このIDより前のデータを取得
+    # @option opts [BalanceState] :state state が指定した値であるオブジェクトに限定
+    # @option opts [Boolean] :closed closed が指定した値であるオブジェクトに限定
+    # @option opts [Time] :since_due_date 入金予定日/振込期限日が指定した日時以降のデータのみ取得
+    # @option opts [Time] :until_due_date 入金予定日/振込期限日が指定した日時以前のデータのみ取得
+    # @option opts [String] :idempotency_key Idempotency key for the request
+    # @option opts [Boolean] :include_http_info If true, returns [data, status_code, headers] instead of just data
+    # @return [BalanceListResponse, Array] Returns data or [data, status_code, headers] if include_http_info is true
+    def get_all_balances(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: BalancesApi.get_all_balances ...'
+      end
+      if @api_client.config.client_side_validation && !opts[:limit].nil? && opts[:limit] > 100
+        raise ArgumentError, 'invalid value for "opts[:limit]" when calling BalancesApi.get_all_balances, must be smaller than or equal to 100.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:limit].nil? && opts[:limit] < 1
+        raise ArgumentError, 'invalid value for "opts[:limit]" when calling BalancesApi.get_all_balances, must be greater than or equal to 1.'
+      end
+
+      # resource path
+      local_var_path = '/v2/balances'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:since] = opts[:since] if !opts[:since].nil?
+      query_params[:until] = opts[:_until] if !opts[:_until].nil?
+      query_params[:limit] = opts[:limit] if !opts[:limit].nil?
+      query_params[:starting_after] = opts[:starting_after] if !opts[:starting_after].nil?
+      query_params[:ending_before] = opts[:ending_before] if !opts[:ending_before].nil?
+      query_params[:state] = opts[:state] if !opts[:state].nil?
+      query_params[:closed] = opts[:closed] if !opts[:closed].nil?
+      query_params[:since_due_date] = opts[:since_due_date] if !opts[:since_due_date].nil?
+      query_params[:until_due_date] = opts[:until_due_date] if !opts[:until_due_date].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      header_params['Idempotency-Key'] = opts[:idempotency_key] if opts[:idempotency_key]
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'BalanceListResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['HTTPBasic', 'HTTPBearer']
+
+      new_options = opts.merge(
+        :operation => :"BalancesApi.get_all_balances",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: BalancesApi#get_all_balances\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+
+      if opts[:include_http_info]
+        [data, status_code, headers]
+      else
+        data
+      end
+    end
+
+    # Get Balance
+    # @param balance_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :idempotency_key Idempotency key for the request
+    # @option opts [Boolean] :include_http_info If true, returns [data, status_code, headers] instead of just data
+    # @return [BalanceResponse, Array] Returns data or [data, status_code, headers] if include_http_info is true
+    def get_balance(balance_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: BalancesApi.get_balance ...'
+      end
+      # verify the required parameter 'balance_id' is set
+      if @api_client.config.client_side_validation && balance_id.nil?
+        raise ArgumentError, "Missing the required parameter 'balance_id' when calling BalancesApi.get_balance"
+      end
+      # resource path
+      local_var_path = '/v2/balances/{balance_id}'.sub('{' + 'balance_id' + '}', CGI.escape(balance_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      header_params['Idempotency-Key'] = opts[:idempotency_key] if opts[:idempotency_key]
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'BalanceResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['HTTPBasic', 'HTTPBearer']
+
+      new_options = opts.merge(
+        :operation => :"BalancesApi.get_balance",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: BalancesApi#get_balance\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+
+      if opts[:include_http_info]
+        [data, status_code, headers]
+      else
+        data
+      end
+    end
+  end
+end