jamm 2.6.0 → 2.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f15af21a2f10a3f3ea2c5636349ab7449d90997795bb8e9a729d063a02c70040
-  data.tar.gz: 48f9b4782863261fb11c8ce3e37f5f0819c8b87d24136c595df7396a0cbfd3b5
+  metadata.gz: 4b472b4eb5e6fce821a1f661259e31f08e223d7192d12be515c2a6229253a00b
+  data.tar.gz: cfe4d590089f2ba73b3f13f4fa96bf4d20df6c520f2194aa212d509d739f1c9e
 SHA512:
-  metadata.gz: 18be3aac7a0654593d068e7e8f7c889e02d6df8bf66bd6c00d024fd15aeff33f4611055a902f223f4fdfcb7e6dd518c0a3c27659bf79a9f030bcb39846ed9c54
-  data.tar.gz: 214589958f50dda8837dbc9d27017597fb9d88f10ee02923eee15ff278b6b1d5e7f809412dd0c5a6b475a936de575fff6f69c19949a4dec8fa06efcc41baccd2
+  metadata.gz: aaae08e45949517f521919d1f9c29ea9a79c72ac99cec017f07161218399d35a0519070b209acac3eee65ba34c2a55cedf92d6e5ec6dc30681400baaa4df98fb
+  data.tar.gz: 2eaaa934cf8227ab5d583d8d9d479a2a76679fad2f8f526b840efad9352d42e4c948e354fde16b9525cbb7b11d3b954e111658e32a27cb660bcf4fc623565d5e

data/CHANGELOG.md

@@ -5,6 +5,23 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [2.7.0] - 2026-10-05
+
+### Added
+
+- Every request to the Jamm API (not OAuth token requests) sends a `Jamm-API-Version` header defaulting to the API version this SDK was built for (`Jamm::API_VERSION`). To stay on an older version, pass `api_version:` to `Jamm.configure`; a newer one needs an SDK upgrade.
+- New error type `ERROR_TYPE_PAYMENT_CHARGE_OVER_DAILY_LIMIT`: the charge would exceed the daily limit of the buyer's bank account. Retry after midnight JST.
+- Charge webhooks expose `msg.content.metadata`, the map you set when creating the charge, on every charge and refund event. Keys are symbols (`metadata[:order_id]`), and it is `nil` when the charge has none.
+
+### Changed
+
+- The SDK version header is renamed from `X-SDK-Version` to `Jamm-SDK-Version`. If a proxy or firewall allowlists outgoing headers, add `Jamm-SDK-Version`.
+- Webhook parsing accepts both `snake_case` and `camelCase` field names, so a future change to the webhook format won't break it.
+
+### Deprecated
+
+- `ERROR_TYPE_CSV_DUPLICATE_USER` is no longer returned.
+
 ## [2.6.0] - 2026-07-22
 
 ### Fixed

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    jamm (2.6.0)
+    jamm (2.7.0)
       base64 (~> 0.2)
       rest-client (~> 2.0)
       typhoeus (~> 1.0, >= 1.0.1)

data/README.md

@@ -68,6 +68,30 @@ If you want to build the gem from source:
 gem build jamm.gemspec
 ```
 
+## API version
+
+Every request to the Jamm API carries a `Jamm-API-Version` header. It defaults to
+the dated API version this SDK was built against, exposed as `Jamm::API_VERSION`.
+You can pin an older version with `api_version:` in `Jamm.configure`; a newer one
+requires upgrading the SDK. Nil or empty means `Jamm::API_VERSION`.
+
+```ruby
+Jamm.configure(client_id: '...', client_secret: '...', env: 'production', api_version: '2026-08-26')
+```
+
+The API rejects a version it no longer serves; the error lists the versions it does. Responses to a pinned older version follow that version's shape, so fields added since come back empty in this SDK's types.
+
+Every versioned response echoes what served it in two headers:
+`Jamm-API-Version` is the version, and `Jamm-API-Version-Source` is how it was
+chosen: `header` (the version this SDK sent), `pin` (your account's pinned
+version), `default` (no header, and no pin we could read), or `forced` (Jamm
+temporarily served its newest shape, which no dated version describes, so
+`Jamm-API-Version` is omitted). A request rejected before a version is chosen
+carries neither.
+
+OAuth2 token requests are excluded: they go to the identity service, which is
+not versioned.
+
 ## Development
 Test cases can be run with: `bundle exec rake`
 

data/Rakefile

@@ -6,7 +6,13 @@ require 'bundler/gem_tasks'
 
 RuboCop::RakeTask.new
 
-task default: %i[rubocop]
+task default: %i[rubocop test]
+
+desc 'Run unit tests'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = './test/**/*_test.rb'
+end
 
 desc 'Run end-to-end tests'
 Rake::TestTask.new(:e2e) do |t|

data/lib/jamm/api/api/webhook_endpoint_api.rb

@@ -0,0 +1,294 @@
+=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 'cgi'
+
+module Api
+  class WebhookEndpointApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Create TEST webhook endpoint
+    # Create a TEST webhook endpoint pinned to a candidate API version. Real events are mirrored to it at that version.
+    # @param body [CreateWebhookEndpointRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [CreateWebhookEndpointResponse]
+    def create_webhook_endpoint(body, opts = {})
+      data, _status_code, _headers = create_webhook_endpoint_with_http_info(body, opts)
+      data
+    end
+
+    # Create TEST webhook endpoint
+    # Create a TEST webhook endpoint pinned to a candidate API version. Real events are mirrored to it at that version.
+    # @param body [CreateWebhookEndpointRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(CreateWebhookEndpointResponse, Integer, Hash)>] CreateWebhookEndpointResponse data, response status code and response headers
+    def create_webhook_endpoint_with_http_info(body, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: WebhookEndpointApi.create_webhook_endpoint ...'
+      end
+      # verify the required parameter 'body' is set
+      if @api_client.config.client_side_validation && body.nil?
+        fail ArgumentError, "Missing the required parameter 'body' when calling WebhookEndpointApi.create_webhook_endpoint"
+      end
+      # resource path
+      local_var_path = '/v1/webhook-endpoints'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(body)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'CreateWebhookEndpointResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || []
+
+      new_options = opts.merge(
+        :operation => :"WebhookEndpointApi.create_webhook_endpoint",
+        :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: WebhookEndpointApi#create_webhook_endpoint\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Promote webhook endpoint version
+    # Switch the LIVE webhook endpoint to the TEST endpoint's API version in one step and record the previous version.
+    # @param body [Object] 
+    # @param [Hash] opts the optional parameters
+    # @return [PromoteWebhookEndpointResponse]
+    def promote_webhook_endpoint(body, opts = {})
+      data, _status_code, _headers = promote_webhook_endpoint_with_http_info(body, opts)
+      data
+    end
+
+    # Promote webhook endpoint version
+    # Switch the LIVE webhook endpoint to the TEST endpoint&#39;s API version in one step and record the previous version.
+    # @param body [Object] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(PromoteWebhookEndpointResponse, Integer, Hash)>] PromoteWebhookEndpointResponse data, response status code and response headers
+    def promote_webhook_endpoint_with_http_info(body, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: WebhookEndpointApi.promote_webhook_endpoint ...'
+      end
+      # verify the required parameter 'body' is set
+      if @api_client.config.client_side_validation && body.nil?
+        fail ArgumentError, "Missing the required parameter 'body' when calling WebhookEndpointApi.promote_webhook_endpoint"
+      end
+      # resource path
+      local_var_path = '/v1/webhook-endpoints/promote'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(body)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'PromoteWebhookEndpointResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || []
+
+      new_options = opts.merge(
+        :operation => :"WebhookEndpointApi.promote_webhook_endpoint",
+        :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: WebhookEndpointApi#promote_webhook_endpoint\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Roll back webhook endpoint version
+    # Restore the LIVE webhook endpoint to the API version recorded at the last promote.
+    # @param body [Object] 
+    # @param [Hash] opts the optional parameters
+    # @return [RollbackWebhookEndpointResponse]
+    def rollback_webhook_endpoint(body, opts = {})
+      data, _status_code, _headers = rollback_webhook_endpoint_with_http_info(body, opts)
+      data
+    end
+
+    # Roll back webhook endpoint version
+    # Restore the LIVE webhook endpoint to the API version recorded at the last promote.
+    # @param body [Object] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(RollbackWebhookEndpointResponse, Integer, Hash)>] RollbackWebhookEndpointResponse data, response status code and response headers
+    def rollback_webhook_endpoint_with_http_info(body, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: WebhookEndpointApi.rollback_webhook_endpoint ...'
+      end
+      # verify the required parameter 'body' is set
+      if @api_client.config.client_side_validation && body.nil?
+        fail ArgumentError, "Missing the required parameter 'body' when calling WebhookEndpointApi.rollback_webhook_endpoint"
+      end
+      # resource path
+      local_var_path = '/v1/webhook-endpoints/rollback'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(body)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'RollbackWebhookEndpointResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || []
+
+      new_options = opts.merge(
+        :operation => :"WebhookEndpointApi.rollback_webhook_endpoint",
+        :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: WebhookEndpointApi#rollback_webhook_endpoint\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Trigger a test webhook event
+    # Send one synthetic event of the given type to the TEST webhook endpoint, signed and versioned like a production delivery.
+    # @param body [TriggerWebhookEventRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [TriggerWebhookEventResponse]
+    def trigger_webhook_event(body, opts = {})
+      data, _status_code, _headers = trigger_webhook_event_with_http_info(body, opts)
+      data
+    end
+
+    # Trigger a test webhook event
+    # Send one synthetic event of the given type to the TEST webhook endpoint, signed and versioned like a production delivery.
+    # @param body [TriggerWebhookEventRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(TriggerWebhookEventResponse, Integer, Hash)>] TriggerWebhookEventResponse data, response status code and response headers
+    def trigger_webhook_event_with_http_info(body, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: WebhookEndpointApi.trigger_webhook_event ...'
+      end
+      # verify the required parameter 'body' is set
+      if @api_client.config.client_side_validation && body.nil?
+        fail ArgumentError, "Missing the required parameter 'body' when calling WebhookEndpointApi.trigger_webhook_event"
+      end
+      # resource path
+      local_var_path = '/v1/webhook-endpoints/trigger'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(body)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'TriggerWebhookEventResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || []
+
+      new_options = opts.merge(
+        :operation => :"WebhookEndpointApi.trigger_webhook_event",
+        :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: WebhookEndpointApi#trigger_webhook_event\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

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

@@ -0,0 +1,42 @@
+=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
+  class ChargeMessageApiSource
+    UNSPECIFIED = "API_SOURCE_UNSPECIFIED".freeze
+    OFF_SESSION_SYNC = "API_SOURCE_OFF_SESSION_SYNC".freeze
+    OFF_SESSION_ASYNC = "API_SOURCE_OFF_SESSION_ASYNC".freeze
+    ON_SESSION = "API_SOURCE_ON_SESSION".freeze
+
+    def self.all_vars
+      @all_vars ||= [UNSPECIFIED, OFF_SESSION_SYNC, OFF_SESSION_ASYNC, ON_SESSION].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 ChargeMessageApiSource.all_vars.include?(value)
+      raise "Invalid ENUM value #{value} for class #ChargeMessageApiSource"
+    end
+  end
+end

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

@@ -34,7 +34,7 @@ module Api
 
     attr_accessor :gender
 
-    # Arbitrary key-value additional information about the customer. All the existing metadata will be overwritten by the new metadata.  Customerに関する任意のキーと値の追加情報。 すべての既存のメタデータは新しいメタデータで上書きされます。
+    # Arbitrary key-value additional information about the customer. All the existing metadata will be overwritten by the new metadata.  Customerに関する任意のキーと値の追加情報。 すべての既存のメタデータは新しいメタデータで上書きされます。 At most 50 entries; keys up to 64 and values up to 512 characters.  最大50件、キーは64文字、値は512文字までです。
     attr_accessor :metadata
 
     # Attribute mapping from ruby-style variable name to JSON key.

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

@@ -46,7 +46,7 @@ module Api
     # Merchant can optionally set the expiry date for the contract. Defaults to 90 minutes if not specified.  決済の有効期限。未指定の場合は90分後に自動失効します。
     attr_accessor :expires_at
 
-    # Arbitrary key-value additional information about the customer. You can see this information in our merchant dashboard.  Customerに関する任意のキーと値の追加情報。 加盟店ダッシュボードで確認できます。
+    # Arbitrary key-value additional information about the customer. You can see this information in our merchant dashboard.  Customerに関する任意のキーと値の追加情報。 加盟店ダッシュボードで確認できます。 At most 50 entries; keys up to 64 and values up to 512 characters.  最大50件、キーは64文字、値は512文字までです。
     attr_accessor :metadata
 
     # Attribute mapping from ruby-style variable name to JSON key.

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

@@ -62,6 +62,11 @@ module Api
 
     attr_accessor :refund
 
+    attr_accessor :api_source
+
+    # Merchant-supplied metadata attached to the charge at creation, echoed back verbatim. Omitted when the charge carries no metadata.
+    attr_accessor :metadata
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -105,7 +110,9 @@ module Api
         :'consumption_tax' => :'consumptionTax',
         :'error' => :'error',
         :'refund_id' => :'refundId',
-        :'refund' => :'refund'
+        :'refund' => :'refund',
+        :'api_source' => :'apiSource',
+        :'metadata' => :'metadata'
       }
     end
 
@@ -135,7 +142,9 @@ module Api
         :'consumption_tax' => :'Integer',
         :'error' => :'Apiv1Error',
         :'refund_id' => :'String',
-        :'refund' => :'RefundInfo'
+        :'refund' => :'RefundInfo',
+        :'api_source' => :'ChargeMessageApiSource',
+        :'metadata' => :'Hash<String, String>'
       }
     end
 
@@ -237,6 +246,18 @@ module Api
       if attributes.key?(:'refund')
         self.refund = attributes[:'refund']
       end
+
+      if attributes.key?(:'api_source')
+        self.api_source = attributes[:'api_source']
+      else
+        self.api_source = 'API_SOURCE_UNSPECIFIED'
+      end
+
+      if attributes.key?(:'metadata')
+        if (value = attributes[:'metadata']).is_a?(Hash)
+          self.metadata = value
+        end
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -277,7 +298,9 @@ module Api
           consumption_tax == o.consumption_tax &&
           error == o.error &&
           refund_id == o.refund_id &&
-          refund == o.refund
+          refund == o.refund &&
+          api_source == o.api_source &&
+          metadata == o.metadata
     end
 
     # @see the `==` method
@@ -289,7 +312,7 @@ module Api
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, customer, status, description, merchant_name, initial_amount, discount, final_amount, amount_refunded, currency, processed_at, jamm_fee, created_at, updated_at, original_transaction_jamm_fee, consumption_tax, error, refund_id, refund].hash
+      [id, customer, status, description, merchant_name, initial_amount, discount, final_amount, amount_refunded, currency, processed_at, jamm_fee, created_at, updated_at, original_transaction_jamm_fee, consumption_tax, error, refund_id, refund, api_source, metadata].hash
     end
 
     # Builds the object from hash