jamm 2.0.0 → 2.2.0

data/lib/jamm/api/models/v1_refund_info.rb

@@ -0,0 +1,275 @@
+=begin
+#Jamm API
+
+#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+The version of the OpenAPI document: 1.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.9.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Api
+  # RefundInfo contains refund-specific details for refund and refund_failed webhook events.
+  class RefundInfo
+    # External refund identifier (rfd-*).
+    attr_accessor :refund_id
+
+    # Amount refunded for this event.
+    attr_accessor :amount_refunded
+
+    # Jamm fee for this refund event.
+    attr_accessor :jamm_fee
+
+    # Consumption tax (10% of the Jamm fee).
+    attr_accessor :consumption_tax
+
+    # Whether the original transaction's Jamm fee was waived (true for same-day cancel).
+    attr_accessor :original_transaction_fee_waived
+
+    attr_accessor :error
+
+    # When the refund was processed (not present on refund_failed events).
+    attr_accessor :processed_at
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'refund_id' => :'refundId',
+        :'amount_refunded' => :'amountRefunded',
+        :'jamm_fee' => :'jammFee',
+        :'consumption_tax' => :'consumptionTax',
+        :'original_transaction_fee_waived' => :'originalTransactionFeeWaived',
+        :'error' => :'error',
+        :'processed_at' => :'processedAt'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'refund_id' => :'String',
+        :'amount_refunded' => :'Integer',
+        :'jamm_fee' => :'Integer',
+        :'consumption_tax' => :'Integer',
+        :'original_transaction_fee_waived' => :'Boolean',
+        :'error' => :'Apiv1Error',
+        :'processed_at' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Api::RefundInfo` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Api::RefundInfo`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'refund_id')
+        self.refund_id = attributes[:'refund_id']
+      end
+
+      if attributes.key?(:'amount_refunded')
+        self.amount_refunded = attributes[:'amount_refunded']
+      end
+
+      if attributes.key?(:'jamm_fee')
+        self.jamm_fee = attributes[:'jamm_fee']
+      end
+
+      if attributes.key?(:'consumption_tax')
+        self.consumption_tax = attributes[:'consumption_tax']
+      end
+
+      if attributes.key?(:'original_transaction_fee_waived')
+        self.original_transaction_fee_waived = attributes[:'original_transaction_fee_waived']
+      end
+
+      if attributes.key?(:'error')
+        self.error = attributes[:'error']
+      end
+
+      if attributes.key?(:'processed_at')
+        self.processed_at = attributes[:'processed_at']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = Array.new
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          refund_id == o.refund_id &&
+          amount_refunded == o.amount_refunded &&
+          jamm_fee == o.jamm_fee &&
+          consumption_tax == o.consumption_tax &&
+          original_transaction_fee_waived == o.original_transaction_fee_waived &&
+          error == o.error &&
+          processed_at == o.processed_at
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [refund_id, amount_refunded, jamm_fee, consumption_tax, original_transaction_fee_waived, error, processed_at].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = nil
+        elsif type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      new(transformed_hash)
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def self._deserialize(type, value)
+      case type.to_sym
+      when :Time
+        Time.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        # models (e.g. Pet) or oneOf
+        klass = Api.const_get(type)
+        klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+
+end

data/lib/jamm/api/models/v1_refund_request.rb

@@ -14,7 +14,7 @@ require 'date'
 require 'time'
 
 module Api
-  # Request message for refunding a charge. The refund is always processed asynchronously. The final result is delivered via webhook (`charge_refund`).
+  # Request message for refunding a charge. The refund is always processed asynchronously. The final result is delivered via webhook (`refund_succeeded`).
   class RefundRequest
     # The charge ID to refund.  返金する決済のID。  @gotags: validate:\"required\"
     attr_accessor :charge_id
@@ -22,11 +22,15 @@ module Api
     # Optional refund amount in JPY. If omitted, the full refundable amount is used.  返金金額（日本円）。 省略した場合、全額返金となります。
     attr_accessor :amount
 
+    # When true, only attempts cancellation without falling back to bank transfer refund. Defaults to false (fallback enabled).  trueの場合、キャンセルのみを試行し、銀行振込返金への フォールバックを行いません。デフォルトはfalse（フォールバック有効）。
+    attr_accessor :cancel_only
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'charge_id' => :'chargeId',
-        :'amount' => :'amount'
+        :'amount' => :'amount',
+        :'cancel_only' => :'cancelOnly'
       }
     end
 
@@ -39,7 +43,8 @@ module Api
     def self.openapi_types
       {
         :'charge_id' => :'String',
-        :'amount' => :'Integer'
+        :'amount' => :'Integer',
+        :'cancel_only' => :'Boolean'
       }
     end
 
@@ -71,6 +76,10 @@ module Api
       if attributes.key?(:'amount')
         self.amount = attributes[:'amount']
       end
+
+      if attributes.key?(:'cancel_only')
+        self.cancel_only = attributes[:'cancel_only']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -94,7 +103,8 @@ module Api
       return true if self.equal?(o)
       self.class == o.class &&
           charge_id == o.charge_id &&
-          amount == o.amount
+          amount == o.amount &&
+          cancel_only == o.cancel_only
     end
 
     # @see the `==` method
@@ -106,7 +116,7 @@ module Api
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [charge_id, amount].hash
+      [charge_id, amount, cancel_only].hash
     end
 
     # Builds the object from hash

data/lib/jamm/api/models/v1_withdraw_async_request.rb

@@ -14,17 +14,21 @@ require 'date'
 require 'time'
 
 module Api
-  # This message represents a request to withdraw money from a customer asynchronously. It contains the customer ID and the amount to withdraw.
+  # This message represents a request to withdraw money from a customer asynchronously. It contains the customer ID and the amount to withdraw. Supports triggerError in charge.metadata for test error simulation. See InitialCharge.metadata.
   class WithdrawAsyncRequest
     attr_accessor :customer
 
     attr_accessor :charge
 
+    # Merchant-supplied idempotency key for retry safety. When present, a retry with the same (merchant, idempotency_key) returns the original charge instead of creating a new one. When absent (empty), the server generates a UUID per call (current behavior). ASCII only, 1-255 chars matching ^[a-zA-Z0-9_\\-]{1,255}$.
+    attr_accessor :idempotency_key
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'customer' => :'customer',
-        :'charge' => :'charge'
+        :'charge' => :'charge',
+        :'idempotency_key' => :'idempotencyKey'
       }
     end
 
@@ -37,7 +41,8 @@ module Api
     def self.openapi_types
       {
         :'customer' => :'String',
-        :'charge' => :'InitialCharge'
+        :'charge' => :'InitialCharge',
+        :'idempotency_key' => :'String'
       }
     end
 
@@ -69,6 +74,10 @@ module Api
       if attributes.key?(:'charge')
         self.charge = attributes[:'charge']
       end
+
+      if attributes.key?(:'idempotency_key')
+        self.idempotency_key = attributes[:'idempotency_key']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -92,7 +101,8 @@ module Api
       return true if self.equal?(o)
       self.class == o.class &&
           customer == o.customer &&
-          charge == o.charge
+          charge == o.charge &&
+          idempotency_key == o.idempotency_key
     end
 
     # @see the `==` method
@@ -104,7 +114,7 @@ module Api
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [customer, charge].hash
+      [customer, charge, idempotency_key].hash
     end
 
     # Builds the object from hash

data/lib/jamm/api/models/v1_withdraw_request.rb

@@ -14,7 +14,7 @@ require 'date'
 require 'time'
 
 module Api
-  # This message represents a request to withdraw money from a customer. It contains the customer ID and the amount to withdraw.
+  # This message represents a request to withdraw money from a customer. It contains the customer ID and the amount to withdraw. Supports triggerError in charge.metadata for test error simulation. See InitialCharge.metadata.
   class WithdrawRequest
     attr_accessor :customer
 

data/lib/jamm/api.rb

@@ -33,6 +33,7 @@ require 'jamm/api/models/v1_bank_quota'
 require 'jamm/api/models/v1_bank_scheduled_maintenance_period'
 require 'jamm/api/models/v1_buyer'
 require 'jamm/api/models/v1_charge'
+require 'jamm/api/models/v1_charge_error'
 require 'jamm/api/models/v1_charge_message'
 require 'jamm/api/models/v1_charge_message_status'
 require 'jamm/api/models/v1_charge_result'
@@ -79,6 +80,7 @@ require 'jamm/api/models/v1_pagination'
 require 'jamm/api/models/v1_payment_authorization_status'
 require 'jamm/api/models/v1_payment_link'
 require 'jamm/api/models/v1_ping_response'
+require 'jamm/api/models/v1_refund_info'
 require 'jamm/api/models/v1_refund_request'
 require 'jamm/api/models/v1_refund_response'
 require 'jamm/api/models/v1_search_banks_response'

data/lib/jamm/payment.rb

@@ -3,6 +3,7 @@
 require 'rest-client'
 require 'json'
 require 'base64'
+require 'securerandom'
 require 'jamm/errors'
 
 module Jamm
@@ -50,6 +51,29 @@ module Jamm
       raise Jamm::ApiError.from_error(e)
     end
 
+    # Auto-fills idempotency_key with a UUID when the caller did not supply one,
+    # so every async charge is retry-safe by default. A caller-supplied key is
+    # left untouched so explicit retries reuse the same value.
+    def self.off_session_async(customer:, charge:, idempotency_key: nil, merchant: nil)
+      key =
+        if idempotency_key.nil? || idempotency_key.strip.empty?
+          SecureRandom.uuid
+        else
+          idempotency_key
+        end
+
+      request = Jamm::OpenAPI::OffSessionPaymentAsyncRequest.new(
+        customer: customer,
+        charge: charge,
+        idempotency_key: key
+      )
+
+      handler = Jamm::Client.handler(merchant: merchant)
+      Jamm::OpenAPI::PaymentApi.new(handler).async_off_session_payment(request)
+    rescue Jamm::OpenAPI::ApiError => e
+      raise Jamm::ApiError.from_error(e)
+    end
+
     def self.get(charge_id, merchant: nil)
       handler = Jamm::Client.handler(merchant: merchant)
 

data/lib/jamm/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Jamm
-  VERSION = '2.0.0'
+  VERSION = '2.2.0'
 end

data/lib/jamm/webhook.rb

@@ -22,7 +22,11 @@ module Jamm
         out.content = Jamm::OpenAPI::ChargeMessage.new(json[:content])
         return out
 
-      when Jamm::OpenAPI::EventType::CHARGE_REFUND
+      when Jamm::OpenAPI::EventType::REFUND_SUCCEEDED
+        out.content = Jamm::OpenAPI::ChargeMessage.new(json[:content])
+        return out
+
+      when Jamm::OpenAPI::EventType::REFUND_FAILED
         out.content = Jamm::OpenAPI::ChargeMessage.new(json[:content])
         return out
 

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: jamm
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.2.0
 platform: ruby
 authors:
 - Jamm
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-03-16 00:00:00.000000000 Z
+date: 2026-05-25 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: base64
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +66,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rubocop.yml"
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE
@@ -83,6 +98,7 @@ files:
 - lib/jamm/api/models/v1_bank_scheduled_maintenance_period.rb
 - lib/jamm/api/models/v1_buyer.rb
 - lib/jamm/api/models/v1_charge.rb
+- lib/jamm/api/models/v1_charge_error.rb
 - lib/jamm/api/models/v1_charge_message.rb
 - lib/jamm/api/models/v1_charge_message_status.rb
 - lib/jamm/api/models/v1_charge_result.rb
@@ -129,6 +145,7 @@ files:
 - lib/jamm/api/models/v1_payment_authorization_status.rb
 - lib/jamm/api/models/v1_payment_link.rb
 - lib/jamm/api/models/v1_ping_response.rb
+- lib/jamm/api/models/v1_refund_info.rb
 - lib/jamm/api/models/v1_refund_request.rb
 - lib/jamm/api/models/v1_refund_response.rb
 - lib/jamm/api/models/v1_search_banks_response.rb