jamm 1.0.13 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2232efb82324373026a66792ac9c2a421d295fd5be23d8f115dc54bc72649565
-  data.tar.gz: 36db3f76d2f1db72ad87ba4161f7434b317b5240940562ed127377cb3fde8a30
+  metadata.gz: 6078aaa5f3504c091900869e1d978883fc7b125e6ce2eb101330f8a124d780f2
+  data.tar.gz: 8e2b2876e53ca8a7da4d1c9e0f52d02e5e2607cc74654b3cee7fa4eb39662b72
 SHA512:
-  metadata.gz: 1f3eaaa8eff333ac9bb5166175d7776050397b91b69ac62797c76dd2e87e9ba94198746b4a0ea17cdab3676455082ff0e2ebfb92d2ac77e49c718b1000126827
-  data.tar.gz: 53ea2655047fdbe962abd20d0f63c3afd7abb4f64a4ced118d81cc17c7aaa8a31c2fc4640d85f934383077977c71a206f34ee91ebf695dea1fe1ab081082058c
+  metadata.gz: 20bd0ebbe9f53d0a57a6319921a6fcdfb7de101e007d0325d6abcec25be72ad0617bec80e837937447231dad4d97ee3c90a7ea0c35483dce52f1d6b079a7a627
+  data.tar.gz: aa38acca7378be10d5b71dedd66b03b1f3a675a98a654e0fbcade89ca55c5e91fd54aacd81670d34dc7eb86a2545a805e01664270a94b59031b9c3070f8b6fc1

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    jamm (1.0.13)
+    jamm (1.1.1)
       rest-client (~> 2.0)
       typhoeus (~> 1.0, >= 1.0.1)
 

data/lib/jamm/api/api/payment_api.rb

@@ -22,7 +22,7 @@ module Api
 
     # Use existing contract with charge
     # Use existing contract with charge
-    # @param body [AddChargeRequest]
+    # @param body [AddChargeRequest] This message represents a request to add a charge to an existing customer. It contains all necessary information to process a new payment transaction.
     # @param [Hash] opts the optional parameters
     # @return [AddChargeResponse]
     def add_charge(body, opts = {})
@@ -32,7 +32,7 @@ module Api
 
     # Use existing contract with charge
     # Use existing contract with charge
-    # @param body [AddChargeRequest]
+    # @param body [AddChargeRequest] This message represents a request to add a charge to an existing customer. It contains all necessary information to process a new payment transaction.
     # @param [Hash] opts the optional parameters
     # @return [Array<(AddChargeResponse, Integer, Hash)>] AddChargeResponse data, response status code and response headers
     def add_charge_with_http_info(body, opts = {})
@@ -83,7 +83,7 @@ module Api
 
     # Create a contract with initial charge
     # Create a contract with initial charge
-    # @param body [CreateContractWithChargeRequest]
+    # @param body [CreateContractWithChargeRequest] Request message for creating a new contract with an immediate initial charge. This combines contract creation and charging in a single operation.
     # @param [Hash] opts the optional parameters
     # @return [CreateContractWithChargeResponse]
     def create_contract_with_charge(body, opts = {})
@@ -93,7 +93,7 @@ module Api
 
     # Create a contract with initial charge
     # Create a contract with initial charge
-    # @param body [CreateContractWithChargeRequest]
+    # @param body [CreateContractWithChargeRequest] Request message for creating a new contract with an immediate initial charge. This combines contract creation and charging in a single operation.
     # @param [Hash] opts the optional parameters
     # @return [Array<(CreateContractWithChargeResponse, Integer, Hash)>] CreateContractWithChargeResponse data, response status code and response headers
     def create_contract_with_charge_with_http_info(body, opts = {})
@@ -144,7 +144,7 @@ module Api
 
     # Create a contract without initial charge (contract only)
     # Create a contract without initial charge (contract only)
-    # @param body [CreateContractWithoutChargeRequest]
+    # @param body [CreateContractWithoutChargeRequest] Request message for creating a new contract without an initial charge. This is typically used when setting up a billing relationship before any actual charges are processed.
     # @param [Hash] opts the optional parameters
     # @return [CreateContractWithoutChargeResponse]
     def create_contract_without_charge(body, opts = {})
@@ -154,7 +154,7 @@ module Api
 
     # Create a contract without initial charge (contract only)
     # Create a contract without initial charge (contract only)
-    # @param body [CreateContractWithoutChargeRequest]
+    # @param body [CreateContractWithoutChargeRequest] Request message for creating a new contract without an initial charge. This is typically used when setting up a billing relationship before any actual charges are processed.
     # @param [Hash] opts the optional parameters
     # @return [Array<(CreateContractWithoutChargeResponse, Integer, Hash)>] CreateContractWithoutChargeResponse data, response status code and response headers
     def create_contract_without_charge_with_http_info(body, opts = {})
@@ -327,7 +327,7 @@ module Api
 
     # Withdraw money from customer immediately, without redirect
     # This call is synchronous. The money will be withdrawn immediately.
-    # @param body [WithdrawRequest]
+    # @param body [WithdrawRequest] This message represents a request to withdraw money from a customer. It contains the customer ID and the amount to withdraw.
     # @param [Hash] opts the optional parameters
     # @return [WithdrawResponse]
     def withdraw(body, opts = {})
@@ -337,7 +337,7 @@ module Api
 
     # Withdraw money from customer immediately, without redirect
     # This call is synchronous. The money will be withdrawn immediately.
-    # @param body [WithdrawRequest]
+    # @param body [WithdrawRequest] This message represents a request to withdraw money from a customer. It contains the customer ID and the amount to withdraw.
     # @param [Hash] opts the optional parameters
     # @return [Array<(WithdrawResponse, Integer, Hash)>] WithdrawResponse data, response status code and response headers
     def withdraw_with_http_info(body, opts = {})

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

@@ -0,0 +1,239 @@
+# frozen_string_literal: true
+
+# #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
+#
+
+require 'date'
+require 'time'
+
+module Api
+  class Apiv1Status
+    attr_accessor :payment, :kyc
+
+    class EnumAttributeValidator
+      attr_reader :datatype, :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :payment => :payment,
+        :kyc => :kyc
+      }
+    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
+      {
+        :payment => :PaymentAuthorizationStatus,
+        :kyc => :KycStatus
+      }
+    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 = {})
+      raise ArgumentError, 'The input argument (attributes) must be a hash in `Api::Apiv1Status` initialize method' unless attributes.is_a?(Hash)
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) do |(k, v), h|
+        raise ArgumentError, "`#{k}` is not a valid attribute in `Api::Apiv1Status`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect unless self.class.attribute_map.key?(k.to_sym)
+
+        h[k.to_sym] = v
+      end
+
+      self.payment = if attributes.key?(:payment)
+                       attributes[:payment]
+                     else
+                       'PAYMENT_AUTHORIZATION_STATUS_UNSPECIFIED'
+                     end
+
+      self.kyc = if attributes.key?(:kyc)
+                   attributes[:kyc]
+                 else
+                   'KYC_STATUS_UNSPECIFIED'
+                 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'
+      []
+    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 ==(other)
+      return true if equal?(other)
+
+      self.class == other.class &&
+        payment == other.payment &&
+        kyc == other.kyc
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(other)
+      self == other
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [payment, kyc].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.to_s] = 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
+          transformed_hash[key.to_s] = attributes[attribute_map[key]].map { |v| _deserialize(::Regexp.last_match(1), v) } if attributes[attribute_map[key]].is_a?(Array)
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash[key.to_s] = _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 = 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_add_charge_request.rb

@@ -14,6 +14,7 @@ require 'date'
 require 'time'
 
 module Api
+  # This message represents a request to add a charge to an existing customer. It contains all necessary information to process a new payment transaction.
   class AddChargeRequest
     attr_accessor :customer, :charge, :redirect
 

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

@@ -14,6 +14,7 @@ require 'date'
 require 'time'
 
 module Api
+  # This message represents the response after processing an AddChargeRequest. It contains information about the created charge, customer details, and a payment link that can be used to complete the payment if needed.
   class AddChargeResponse
     attr_accessor :charge, :customer, :payment_link
 

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

@@ -0,0 +1,217 @@
+# frozen_string_literal: true
+
+# #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
+#
+
+require 'date'
+require 'time'
+
+module Api
+  class BankInformation
+    attr_accessor :account_number, :bank_name, :branch_name
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :account_number => :accountNumber,
+        :bank_name => :bankName,
+        :branch_name => :branchName
+      }
+    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
+      {
+        :account_number => :String,
+        :bank_name => :String,
+        :branch_name => :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 = {})
+      raise ArgumentError, 'The input argument (attributes) must be a hash in `Api::BankInformation` initialize method' unless attributes.is_a?(Hash)
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) do |(k, v), h|
+        raise ArgumentError, "`#{k}` is not a valid attribute in `Api::BankInformation`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect unless self.class.attribute_map.key?(k.to_sym)
+
+        h[k.to_sym] = v
+      end
+
+      self.account_number = attributes[:account_number] if attributes.key?(:account_number)
+
+      self.bank_name = attributes[:bank_name] if attributes.key?(:bank_name)
+
+      return unless attributes.key?(:branch_name)
+
+      self.branch_name = attributes[:branch_name]
+    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'
+      []
+    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 ==(other)
+      return true if equal?(other)
+
+      self.class == other.class &&
+        account_number == other.account_number &&
+        bank_name == other.bank_name &&
+        branch_name == other.branch_name
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(other)
+      self == other
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [account_number, bank_name, branch_name].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.to_s] = 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
+          transformed_hash[key.to_s] = attributes[attribute_map[key]].map { |v| _deserialize(::Regexp.last_match(1), v) } if attributes[attribute_map[key]].is_a?(Array)
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash[key.to_s] = _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 = 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_buyer.rb

@@ -22,6 +22,9 @@ module Api
     # A flag whether Jamm to force KYC for the customer.  初回購入時に購入者に対してKYCを強制するかどうかのフラグです。
     attr_accessor :force_kyc
 
+    # Phone number of the customer. You can update this value later through the UpdateCustomer endpoint.  e.g. - 09012345678  Customerの電話番号。 この値は UpdateCustomer エンドポイントを通じて後で更新できます。
+    attr_accessor :phone
+
     # Name of the customer. You can update this value later through the UpdateCustomer endpoint.  e.g. - John Appleseed - 山田太郎  購入者の氏名。 この値は UpdateCustomer エンドポイントを通じて後で更新できます。
     attr_accessor :name
 
@@ -51,6 +54,7 @@ module Api
       {
         :email => :email,
         :force_kyc => :forceKyc,
+        :phone => :phone,
         :name => :name,
         :katakana_last_name => :katakanaLastName,
         :katakana_first_name => :katakanaFirstName,
@@ -72,6 +76,7 @@ module Api
       {
         :email => :String,
         :force_kyc => :Boolean,
+        :phone => :String,
         :name => :String,
         :katakana_last_name => :String,
         :katakana_first_name => :String,
@@ -104,6 +109,8 @@ module Api
 
       self.force_kyc = attributes[:force_kyc] if attributes.key?(:force_kyc)
 
+      self.phone = attributes[:phone] if attributes.key?(:phone)
+
       self.name = attributes[:name] if attributes.key?(:name)
 
       self.katakana_last_name = attributes[:katakana_last_name] if attributes.key?(:katakana_last_name)
@@ -146,6 +153,7 @@ module Api
       self.class == other.class &&
         email == other.email &&
         force_kyc == other.force_kyc &&
+        phone == other.phone &&
         name == other.name &&
         katakana_last_name == other.katakana_last_name &&
         katakana_first_name == other.katakana_first_name &&
@@ -165,7 +173,7 @@ module Api
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [email, force_kyc, name, katakana_last_name, katakana_first_name, address, birth_date, gender, expires_at, metadata].hash
+      [email, force_kyc, phone, name, katakana_last_name, katakana_first_name, address, birth_date, gender, expires_at, metadata].hash
     end
 
     # Builds the object from hash

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

@@ -16,7 +16,7 @@ require 'time'
 module Api
   # Charge represents a charge information for the customer.
   class Charge
-    # 決済ID (例: chg-1234567890)  @gotags: validate:\"required\"
+    # 決済ID (例: trx-1234567890)  @gotags: validate:\"required\"
     attr_accessor :id
 
     # Amount of the charge in Japanese Yen. The amount must be the total price of the product/service including tax.  決済金額。日本円で指定してください。 金額は商品/サービスの合計金額 (税込) を指定してください。  @gotags: validate:\"gte=1,lte=500000\"

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

@@ -20,9 +20,10 @@ module Api
     FAILURE = 'STATUS_FAILURE'
     WAITING_EKYC = 'STATUS_WAITING_EKYC'
     BLOCKING = 'STATUS_BLOCKING'
+    CANCELLED = 'STATUS_CANCELLED'
 
     def self.all_vars
-      @all_vars ||= [UNSPECIFIED, SUCCESS, FAILURE, WAITING_EKYC, BLOCKING].freeze
+      @all_vars ||= [UNSPECIFIED, SUCCESS, FAILURE, WAITING_EKYC, BLOCKING, CANCELLED].freeze
     end
 
     # Builds the enum from string

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

@@ -14,6 +14,7 @@ require 'date'
 require 'time'
 
 module Api
+  # Contains the result of a charge operation.
   class ChargeResult
     attr_accessor :charge_id, :description, :merchant_name, :initial_amount, :discount, :final_amount, :amount_refunded, :currency, :token_id, :metadata, :created_at, :updated_at, :processed_at
 

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

@@ -14,6 +14,7 @@ require 'date'
 require 'time'
 
 module Api
+  # Request message for creating a new contract with an immediate initial charge. This combines contract creation and charging in a single operation.
   class CreateContractWithChargeRequest
     attr_accessor :buyer, :charge, :redirect
 

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

@@ -14,6 +14,7 @@ require 'date'
 require 'time'
 
 module Api
+  # Response message after successfully creating a contract with an initial charge. Contains all information about the created contract, charge, customer, and payment link for further interactions.
   class CreateContractWithChargeResponse
     attr_accessor :contract, :charge, :customer, :payment_link
 

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

@@ -14,6 +14,7 @@ require 'date'
 require 'time'
 
 module Api
+  # Request message for creating a new contract without an initial charge. This is typically used when setting up a billing relationship before any actual charges are processed.
   class CreateContractWithoutChargeRequest
     attr_accessor :buyer, :redirect
 

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

@@ -14,6 +14,7 @@ require 'date'
 require 'time'
 
 module Api
+  # Response message after successfully creating a contract without a charge. Contains all the information needed for subsequent interactions with the contract and customer.
   class CreateContractWithoutChargeResponse
     attr_accessor :contract, :customer, :payment_link
 

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

@@ -16,15 +16,16 @@ require 'time'
 module Api
   # Customer object.
   class Customer
-    attr_accessor :id, :email, :ekyc_completed, :activated, :created_at, :updated_at
+    attr_accessor :id, :email, :activated, :status, :bank_information, :created_at, :updated_at
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :id => :id,
         :email => :email,
-        :ekyc_completed => :ekycCompleted,
         :activated => :activated,
+        :status => :status,
+        :bank_information => :bankInformation,
         :created_at => :createdAt,
         :updated_at => :updatedAt
       }
@@ -40,8 +41,9 @@ module Api
       {
         :id => :String,
         :email => :String,
-        :ekyc_completed => :Boolean,
         :activated => :Boolean,
+        :status => :Apiv1Status,
+        :bank_information => :BankInformation,
         :created_at => :Time,
         :updated_at => :Time
       }
@@ -68,10 +70,12 @@ module Api
 
       self.email = attributes[:email] if attributes.key?(:email)
 
-      self.ekyc_completed = attributes[:ekyc_completed] if attributes.key?(:ekyc_completed)
-
       self.activated = attributes[:activated] if attributes.key?(:activated)
 
+      self.status = attributes[:status] if attributes.key?(:status)
+
+      self.bank_information = attributes[:bank_information] if attributes.key?(:bank_information)
+
       self.created_at = attributes[:created_at] if attributes.key?(:created_at)
 
       return unless attributes.key?(:updated_at)
@@ -101,8 +105,9 @@ module Api
       self.class == other.class &&
         id == other.id &&
         email == other.email &&
-        ekyc_completed == other.ekyc_completed &&
         activated == other.activated &&
+        status == other.status &&
+        bank_information == other.bank_information &&
         created_at == other.created_at &&
         updated_at == other.updated_at
     end
@@ -116,7 +121,7 @@ module Api
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, email, ekyc_completed, activated, created_at, updated_at].hash
+      [id, email, activated, status, bank_information, created_at, updated_at].hash
     end
 
     # Builds the object from hash

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

@@ -20,11 +20,12 @@ module Api
     CHARGE_UPDATED = 'EVENT_TYPE_CHARGE_UPDATED'
     CHARGE_SUCCESS = 'EVENT_TYPE_CHARGE_SUCCESS'
     CHARGE_FAIL = 'EVENT_TYPE_CHARGE_FAIL'
+    CHARGE_CANCEL = 'EVENT_TYPE_CHARGE_CANCEL'
     CONTRACT_ACTIVATED = 'EVENT_TYPE_CONTRACT_ACTIVATED'
     TESTING = 'EVENT_TYPE_TESTING'
 
     def self.all_vars
-      @all_vars ||= [UNSPECIFIED, CHARGE_CREATED, CHARGE_UPDATED, CHARGE_SUCCESS, CHARGE_FAIL, CONTRACT_ACTIVATED, TESTING].freeze
+      @all_vars ||= [UNSPECIFIED, CHARGE_CREATED, CHARGE_UPDATED, CHARGE_SUCCESS, CHARGE_FAIL, CHARGE_CANCEL, CONTRACT_ACTIVATED, TESTING].freeze
     end
 
     # Builds the enum from string

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

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+# #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
+#
+
+require 'date'
+require 'time'
+
+module Api
+  class KycStatus
+    UNSPECIFIED = 'KYC_STATUS_UNSPECIFIED'
+    APPROVED = 'KYC_STATUS_APPROVED'
+    NOT_SUBMITTED = 'KYC_STATUS_NOT_SUBMITTED'
+    IN_REVIEW = 'KYC_STATUS_IN_REVIEW'
+    DENIED = 'KYC_STATUS_DENIED'
+
+    def self.all_vars
+      @all_vars ||= [UNSPECIFIED, APPROVED, NOT_SUBMITTED, IN_REVIEW, DENIED].freeze
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def self.build_from_hash(value)
+      new.build_from_hash(value)
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def build_from_hash(value)
+      return value if KycStatus.all_vars.include?(value)
+
+      raise "Invalid ENUM value #{value} for class #KycStatus"
+    end
+  end
+end

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

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+# #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
+#
+
+require 'date'
+require 'time'
+
+module Api
+  class PaymentAuthorizationStatus
+    UNSPECIFIED = 'PAYMENT_AUTHORIZATION_STATUS_UNSPECIFIED'
+    AUTHORIZED = 'PAYMENT_AUTHORIZATION_STATUS_AUTHORIZED'
+    NOT_AUTHORIZED = 'PAYMENT_AUTHORIZATION_STATUS_NOT_AUTHORIZED'
+
+    def self.all_vars
+      @all_vars ||= [UNSPECIFIED, AUTHORIZED, NOT_AUTHORIZED].freeze
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def self.build_from_hash(value)
+      new.build_from_hash(value)
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def build_from_hash(value)
+      return value if PaymentAuthorizationStatus.all_vars.include?(value)
+
+      raise "Invalid ENUM value #{value} for class #PaymentAuthorizationStatus"
+    end
+  end
+end

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

@@ -14,6 +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.
   class WithdrawRequest
     attr_accessor :customer, :charge
 

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

@@ -14,6 +14,7 @@ require 'date'
 require 'time'
 
 module Api
+  # This message represents the response after processing a WithdrawRequest. It contains information about the customer and the charge.
   class WithdrawResponse
     attr_accessor :customer, :charge
 

data/lib/jamm/api.rb

@@ -17,11 +17,13 @@ require 'jamm/api/version'
 require 'jamm/api/configuration'
 
 # Models
+require 'jamm/api/models/apiv1_status'
 require 'jamm/api/models/customer_service_update_customer_body'
 require 'jamm/api/models/googlerpc_status'
 require 'jamm/api/models/protobuf_any'
 require 'jamm/api/models/v1_add_charge_request'
 require 'jamm/api/models/v1_add_charge_response'
+require 'jamm/api/models/v1_bank_information'
 require 'jamm/api/models/v1_buyer'
 require 'jamm/api/models/v1_charge'
 require 'jamm/api/models/v1_charge_message'
@@ -45,11 +47,13 @@ require 'jamm/api/models/v1_get_charges_response'
 require 'jamm/api/models/v1_get_contract_response'
 require 'jamm/api/models/v1_get_customer_response'
 require 'jamm/api/models/v1_initial_charge'
+require 'jamm/api/models/v1_kyc_status'
 require 'jamm/api/models/v1_merchant'
 require 'jamm/api/models/v1_merchant_customer'
 require 'jamm/api/models/v1_merchant_webhook_message'
 require 'jamm/api/models/v1_message_response'
 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_url'

data/lib/jamm/charge.rb

@@ -15,6 +15,8 @@ module Jamm
       )
 
       Jamm::OpenAPI::PaymentApi.new(Jamm::Client.handler).add_charge(request)
+    rescue Jamm::OpenAPI::ApiError => e
+      raise Jamm::ApiError.from_error(e)
     end
 
     def self.create_without_redirect(customer:, charge:)
@@ -24,12 +26,16 @@ module Jamm
       )
 
       Jamm::OpenAPI::PaymentApi.new(Jamm::Client.handler).withdraw(request)
+    rescue Jamm::OpenAPI::ApiError => e
+      raise Jamm::ApiError.from_error(e)
     end
 
     def self.get(charge_id)
       Jamm::OpenAPI::PaymentApi.new(Jamm::Client.handler).get_charge(charge_id)
     rescue Jamm::OpenAPI::ApiError => e
-      [404].include?(e.code) ? nil : raise
+      return nil if e.code == 404
+
+      raise Jamm::ApiError.from_error(e)
     end
 
     def self.list(customer:, pagination: nil)

data/lib/jamm/contract.rb

@@ -15,6 +15,8 @@ module Jamm
       )
 
       Jamm::OpenAPI::PaymentApi.new(Jamm::Client.handler).create_contract_with_charge(request)
+    rescue Jamm::OpenAPI::ApiError => e
+      raise Jamm::ApiError.from_error(e)
     end
 
     def self.create_without_charge(buyer:, redirect:)
@@ -24,12 +26,14 @@ module Jamm
       )
 
       Jamm::OpenAPI::PaymentApi.new(Jamm::Client.handler).create_contract_without_charge(request)
+    rescue Jamm::OpenAPI::ApiError => e
+      raise Jamm::ApiError.from_error(e)
     end
 
     def self.get(customer_id)
       Jamm::OpenAPI::CustomerApi.new(Jamm::Client.handler).get_contract(customer_id)
     rescue Jamm::OpenAPI::ApiError => e
-      [404].include?(e.code) ? nil : raise
+      [404].include?(e.code) ? nil : Jamm::ApiError.from_error(e)
     end
   end
 end

data/lib/jamm/customer.rb

@@ -14,6 +14,8 @@ module Jamm
       )
 
       r.customer
+    rescue Jamm::OpenAPI::ApiError => e
+      raise Jamm::ApiError.from_error(e)
     end
 
     def self.get(id_or_email)
@@ -27,23 +29,31 @@ module Jamm
 
       r.customer
     rescue Jamm::OpenAPI::ApiError => e
-      [404].include?(e.code) ? nil : raise
+      return nil if [404].include?(e.code)
+
+      raise Jamm::ApiError.from_error(e)
     end
 
     def self.get_contract(id)
       Jamm::OpenAPI::CustomerApi.new(Jamm::Client.handler).get_contract(id)
     rescue Jamm::OpenAPI::ApiError => e
-      [404].include?(e.code) ? nil : raise
+      return nil if [404].include?(e.code)
+
+      raise Jamm::ApiError.from_error(e)
     end
 
     def self.update(id, params)
       r = Jamm::OpenAPI::CustomerApi.new(Jamm::Client.handler).update(id, params)
 
       r.customer
+    rescue Jamm::OpenAPI::ApiError => e
+      raise Jamm::ApiError.from_error(e)
     end
 
     def self.delete(id)
       Jamm::OpenAPI::CustomerApi.new(Jamm::Client.handler).delete(id)
+    rescue Jamm::OpenAPI::ApiError => e
+      raise Jamm::ApiError.from_error(e)
     end
   end
 end

data/lib/jamm/errors.rb

@@ -23,4 +23,98 @@ module Jamm
   # OAuthError is raised when a request to AWS cognito failed
   class OAuthError < JammError
   end
+
+  class InvalidSignatureError < StandardError
+  end
+
+  # Purpose of this error handler is to normalize Jamm's custom error
+  # and OpenAPI's generated error, and enforce Jamm's custom error format.
+  #
+  # - Jamm:    code is string, message is string originating from Jamm's protobuf definition.
+  # - OpenAPI: code is integer, message is string originating from ConnectRPC error format.
+  class ApiError < StandardError
+    attr_reader :code, :error_code, :message, :headers, :body
+
+    # Add this class method to convert StandardError to ApiError
+    def self.from_error(e)
+      new(
+        code: e.code,
+        message: e.message,
+        response_headers: e.response_headers,
+        response_body: e.response_body
+      )
+    end
+
+    def initialize(args = {})
+      # Check code existence and convert to string if it's integer
+      @code = args[:code]
+      @message = args[:message]
+      @headers = args[:response_headers]
+
+      raw_body = if args[:response_body].nil?
+                   {}
+                 elsif args[:response_body].is_a?(Hash)
+                   args[:response_body]
+                 elsif args[:response_body].is_a?(String)
+                   begin
+                     JSON.parse(args[:response_body])
+                   rescue StandardError
+                     {}
+                   end
+                 else
+                   {}
+                 end
+
+      @body = {}
+      raw_body.each do |k, v|
+        next if k == 'code'
+
+        @body[k.to_sym] = v if k.respond_to?(:to_sym)
+      end
+
+      # Set human readable error type based on error code
+      # https://github.com/connectrpc/connect-go/blob/d7c0966751650b41a9f1794513592e81b9beed45/code.go#L34
+      @body[:error] = case raw_body['code']
+                      when 1
+                        'CANCELED'
+                      when 2
+                        'UNKNOWN'
+                      when 3
+                        'INVALID_ARGUMENT'
+                      when 4
+                        'DEADLINE_EXCEEDED'
+                      when 5
+                        'NOT_FOUND'
+                      when 6
+                        'ALREADY_EXISTS'
+                      when 7
+                        'PERMISSION_DENIED'
+                      when 8
+                        'RESOURCE_EXHAUSTED'
+                      when 9
+                        'FAILED_PRECONDITION'
+                      when 10
+                        'ABORTED'
+                      when 11
+                        'OUT_OF_RANGE'
+                      when 12
+                        'UNIMPLEMENTED'
+                      when 13
+                        'INTERNAL'
+                      when 14
+                        'UNAVAILABLE'
+                      when 15
+                        'DATA_LOSS'
+                      when 16
+                        'UNAUTHENTICATED'
+                      end
+
+      super(message)
+    end
+
+    def to_s
+      status_string = @code.nil? ? '' : "(Status #{@code}) "
+      "#{status_string}#{@message}"
+    end
+  end
 end

data/lib/jamm/healthcheck.rb

@@ -9,6 +9,8 @@ module Jamm
   module Healthcheck
     def self.ping
       Jamm::OpenAPI::HealthcheckApi.new(Jamm::Client.handler).ping
+    rescue Jamm::OpenAPI::ApiError => e
+      raise Jamm::ApiError.from_error(e)
     end
   end
 end

data/lib/jamm/version.rb

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

data/lib/jamm/webhook.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'openssl'
 require 'rest-client'
 require 'json'
 require 'base64'
@@ -21,6 +22,10 @@ module Jamm
         out.content = Jamm::OpenAPI::ChargeMessage.new(json[:content])
         return out
 
+      when Jamm::OpenAPI::EventType::CHARGE_CANCEL
+        out.content = Jamm::OpenAPI::ChargeMessage.new(json[:content])
+        return out
+
       when Jamm::OpenAPI::EventType::CHARGE_SUCCESS
         out.content = Jamm::OpenAPI::ChargeMessage.new(json[:content])
         return out
@@ -36,5 +41,37 @@ module Jamm
 
       raise 'Unknown event type'
     end
+
+    # Verify message
+    def self.verify(data:, signature:)
+      raise ArgumentError, 'data cannot be nil' if data.nil?
+      raise ArgumentError, 'signature cannot be nil' if signature.nil?
+
+      # Convert the JSON to a string
+      json = JSON.dump(data)
+
+      digest = OpenSSL::HMAC.hexdigest(OpenSSL::Digest.new('sha256'), Jamm.client_secret, json)
+      given = "sha256=#{digest}"
+
+      return if secure_compare(given, signature)
+
+      raise Jamm::InvalidSignatureError, 'Digests do not match'
+    end
+
+    # Securely compare two strings of equal length.
+    # This method is a port of ActiveSupport::SecurityUtils.secure_compare
+    # which works on non-Rails platforms.
+    def self.secure_compare(a, b)
+      return false unless a.bytesize == b.bytesize
+
+      # Unpack strings into arrays of bytes
+      a_bytes = a.unpack('C*')
+      b_bytes = b.unpack('C*')
+      result = 0
+
+      # XOR each byte and accumulate the result
+      a_bytes.zip(b_bytes) { |x, y| result |= x ^ y }
+      result.zero?
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jamm
 version: !ruby/object:Gem::Version
-  version: 1.0.13
+  version: 1.1.1
 platform: ruby
 authors:
 - Jamm
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-01-10 00:00:00.000000000 Z
+date: 2025-04-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -67,11 +67,13 @@ files:
 - lib/jamm/api/api_client.rb
 - lib/jamm/api/api_error.rb
 - lib/jamm/api/configuration.rb
+- lib/jamm/api/models/apiv1_status.rb
 - lib/jamm/api/models/customer_service_update_customer_body.rb
 - lib/jamm/api/models/googlerpc_status.rb
 - lib/jamm/api/models/protobuf_any.rb
 - lib/jamm/api/models/v1_add_charge_request.rb
 - lib/jamm/api/models/v1_add_charge_response.rb
+- lib/jamm/api/models/v1_bank_information.rb
 - lib/jamm/api/models/v1_buyer.rb
 - lib/jamm/api/models/v1_charge.rb
 - lib/jamm/api/models/v1_charge_message.rb
@@ -95,11 +97,13 @@ files:
 - lib/jamm/api/models/v1_get_contract_response.rb
 - lib/jamm/api/models/v1_get_customer_response.rb
 - lib/jamm/api/models/v1_initial_charge.rb
+- lib/jamm/api/models/v1_kyc_status.rb
 - lib/jamm/api/models/v1_merchant.rb
 - lib/jamm/api/models/v1_merchant_customer.rb
 - lib/jamm/api/models/v1_merchant_webhook_message.rb
 - lib/jamm/api/models/v1_message_response.rb
 - lib/jamm/api/models/v1_pagination.rb
+- 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_update_customer_response.rb