airwallex 0.9.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0fc42ac04f0af0416fc2fe200f747a17ec326ea5b071a40d5965043da1ebfd7c
-  data.tar.gz: bfc8c907e1ce9d0e702e124bdf0c85f1fb8827f7c90b0b4382665b5a4f1ade00
+  metadata.gz: '018417ed2b3091ca1c5eafdf99df79c1a81be1d13ddda2524a917d2bc9a2c3ff'
+  data.tar.gz: 0abdb483ebe91136353cc77efb5023cb1d0a05b3fd986c8c3ba59750dfeccfdd
 SHA512:
-  metadata.gz: 952b7120270923df264d701e631570a673584fd08f73502dc3ec36ff19bdd47577d6d799928cdae40781813cbd5f881de7ce4dcca3488e10ee5ff4d46f67da76
-  data.tar.gz: 440bfe68c53e17f2a5b30856f6de51257fffdc32c38e459ebe82d8604c9b018d58ee6369249bc2e2907701f0c79f43bdd9005c08eaaf19aa9ceb81486a2e9999
+  metadata.gz: 1b48a815ca9ca948b4695cfa28b12e70c5dc21a7c6ff37781d20fe0b2f219b12daf205ec997eaaf51eca19bce49d3ffd0fbb890773cd99f5573c4733680e1ec6
+  data.tar.gz: ff66015473fee32cd8ec4bd7cdbb03072b340111d1c354db181c07e0722c936d7b14565210eabd6583f8cd223be9f4c96889b1e329a79b41709ed4626b474427

data/CHANGELOG.md

@@ -1,5 +1,25 @@
 ## [Unreleased]
 
+## [0.10.0] - 2026-09-29
+
+### Added
+
+- `RFI.retrieve` (`GET /api/v1/rfis/{id}`) and `RFI.list` (`GET /api/v1/rfis`, filterable by
+  `statuses`, `types`, `from_created_at`, `end_created_at`, `page_size`). Both take
+  `headers:` for `x-on-behalf-of`
+- `RFI.list` supports bookmark pagination: `has_more`/`next_cursor` come from `page_after`, and
+  `next_page`/`auto_paging_each` request `page: <page_after>`
+- `ListObject` accepts `cursor_param:` (defaults to `:next_cursor`) and `opts:`, and forwards
+  the original `opts` (e.g. `headers:`) to subsequent pages. Resources that don't pass these
+  behave exactly as before
+- `RFI.simulate_create`/`.simulate_close`/`.simulate_follow_up` and the instance
+  `#simulate_close`/`#simulate_follow_up` accept an optional trailing `opts` hash with `headers:`
+
+### Changed
+
+- `RFI.resource_path` is now `/api/v1/rfis`; the simulation path moved to `RFI::SIMULATION_PATH`
+  (`/api/v1/simulation/rfis`). Simulation methods hit the same URLs as before
+
 ## [0.9.0] - 2026-09-09
 
 ### Added

data/README.md

@@ -16,6 +16,7 @@ This gem provides a Ruby interface to Airwallex's payment infrastructure, design
 - **Billing**: Products, prices, billing customers, and subscriptions for recurring/instalment billing
 - **Recurring Payments**: Payment consents and payment sources for merchant-initiated (off-session) charges
 - **Scale**: Connected accounts, funds splits, and charges for platforms onboarding sub-merchants
+- **Compliance**: Retrieve and list Requests for Information (RFIs), including for connected accounts
 - **Sandbox Simulations**: Deposits, issuing transactions, disputes, transfer status, Direct Debit mandates, connected account/offboarding review outcomes, RFIs, and POS terminals — see [Sandbox Simulations](#sandbox-simulations)
 - **Idempotency**: Automatic request deduplication for safe retries
 - **Pagination**: Unified interface over cursor-based and offset-based pagination
@@ -417,6 +418,26 @@ split.release
 charge = Airwallex::Charge.retrieve('charge_id')
 ```
 
+### Requests for Information (RFIs)
+
+RFIs are compliance questions Airwallex raises against an account. They use
+bookmark pagination (`page_after`/`page`), which `ListObject` handles for you,
+and connected accounts are addressed with `x-on-behalf-of`, which is kept
+across pages. The API key needs the **Risk → Request for Information (RFI):
+Read** permission, or Airwallex responds with 401 (`Airwallex::AuthenticationError`).
+
+```ruby
+headers = { 'x-on-behalf-of' => 'acct_123' }
+
+rfi = Airwallex::RFI.retrieve('rfi_123', headers: headers)
+rfi.status                           # => "ACTION_REQUIRED"
+rfi.active_request[:questions].first # => { id: ..., title: { en: ... }, answer: { type: "ATTACHMENT" }, ... }
+
+# statuses/types are comma-separated strings; page_size is 1-2000 (default 100)
+Airwallex::RFI.list({ statuses: 'ACTION_REQUIRED', types: 'KYC,KYC_ONGOING' }, headers: headers)
+              .auto_paging_each { |r| puts r.id }
+```
+
 ### Sandbox Simulations
 
 Sandbox-only endpoints (`/api/v1/simulation/...`) that stand in for the bank,
@@ -621,6 +642,14 @@ rfi.simulate_follow_up(questions: [{ answer: { type: 'TEXT' } }])
 # Class-level equivalents take an rfi_id directly instead of an instance
 Airwallex::RFI.simulate_close('rfi_123')
 Airwallex::RFI.simulate_follow_up('rfi_123', questions: [{ answer: { type: 'TEXT' } }])
+
+# Raise an RFI against a connected account — params need braces when
+# followed by opts. Fails with BadRequestError ("ongoing RFI case exists")
+# if the account already has an open RFI.
+Airwallex::RFI.simulate_create(
+  { type: 'KYC', questions: [{ answer: { type: 'TEXT' } }] },
+  headers: { 'x-on-behalf-of' => 'acct_123' }
+)
 ```
 
 #### POS Terminals
@@ -679,7 +708,8 @@ transfer = Airwallex::Transfer.create(
 
 ### Pagination
 
-Unified interface across both cursor-based and offset-based endpoints:
+Unified interface across cursor-based, offset-based, and bookmark-based (RFI) endpoints.
+Any `headers:` passed to `.list` (e.g. `x-on-behalf-of`) are kept on every page:
 
 ```ruby
 # Auto-pagination with enumerable
@@ -852,8 +882,8 @@ end
   - Cardholder (simulate_pass_review)
 - **In-Person Payments** (sandbox Simulation only):
   - POSTerminal (simulate_turn_on, simulate_turn_off, simulate_generate_activation_code, simulate_confirm_payment_intent, simulate_payment_scenarios)
-- **Compliance** (sandbox Simulation only):
-  - RFI (simulate_create, simulate_close, simulate_follow_up)
+- **Compliance**:
+  - RFI (retrieve, list, plus sandbox simulate_create, simulate_close, simulate_follow_up)
 - **Webhooks**: Event handling, HMAC-SHA256 signature verification
 
 ### Coming in Future Versions

data/lib/airwallex/list_object.rb

@@ -6,12 +6,19 @@ module Airwallex
 
     attr_reader :data, :has_more, :next_cursor
 
-    def initialize(data:, has_more:, resource_class:, next_cursor: nil, params: {})
+    # @param cursor_param [Symbol] query param the next cursor is sent as
+    #   (e.g. :page for bookmark-paginated endpoints like RFI)
+    # @param opts [Hash] the original request opts (e.g. headers:), forwarded
+    #   to every subsequent page so x-on-behalf-of etc. are kept
+    def initialize(data:, has_more:, resource_class:, next_cursor: nil, params: {}, # rubocop:disable Metrics/ParameterLists
+                   cursor_param: :next_cursor, opts: {})
       @data = data.map { |item| resource_class.new(item) }
       @has_more = has_more
       @next_cursor = next_cursor
       @resource_class = resource_class
       @params = params
+      @cursor_param = cursor_param
+      @opts = opts
     end
 
     def each(&)
@@ -49,7 +56,7 @@ module Airwallex
 
       if @next_cursor
         # Cursor-based pagination
-        next_params[:next_cursor] = @next_cursor
+        next_params[@cursor_param] = @next_cursor
       else
         # Offset-based pagination
         page_size = @params[:page_size] || @params[:limit] || 20
@@ -57,7 +64,7 @@ module Airwallex
         next_params[:offset] = current_offset + page_size
       end
 
-      @resource_class.list(next_params)
+      @opts.empty? ? @resource_class.list(next_params) : @resource_class.list(next_params, @opts)
     end
 
     # Automatically iterate through all pages

data/lib/airwallex/resources/rfi.rb

@@ -5,11 +5,31 @@ module Airwallex
   # Airwallex raises against your account (KYC, an ongoing KYC review, a
   # cardholder, a transaction, payment enablement, or merchant risk).
   #
-  # This gem currently only implements the sandbox Simulation endpoints
-  # (there is no live create — real RFIs originate from Airwallex's own
-  # compliance review, same as Dispute). See
+  # Supports retrieving and listing real RFIs, plus the sandbox Simulation
+  # endpoints for raising, closing and following up on them (there is no
+  # live create — real RFIs originate from Airwallex's own compliance
+  # review, same as Dispute). See
+  # https://www.airwallex.com/docs/api/risk/request_for_information_rfi and
   # https://www.airwallex.com/docs/api/simulation/request-for-information
   #
+  # Statuses: ACTION_REQUIRED, ANSWERED, CLOSED. Types: KYC, KYC_ONGOING,
+  # CARDHOLDER, TRANSACTION, PAYMENT_ENABLEMENT, MERCHANT_RISK.
+  #
+  # Reading RFIs requires the API key's "Risk → Request for Information
+  # (RFI): Read" permission — without it Airwallex returns 401
+  # (AuthenticationError).
+  #
+  # @example Retrieve an RFI for a connected account
+  #   rfi = Airwallex::RFI.retrieve("rfi_123", headers: { "x-on-behalf-of" => "acct_123" })
+  #   rfi.status                           # => "ACTION_REQUIRED"
+  #   rfi.active_request[:questions].first # => { id: ..., title: { en: ... }, ... }
+  #
+  # @example List open RFIs, following every page
+  #   Airwallex::RFI.list(
+  #     { statuses: "ACTION_REQUIRED" },
+  #     headers: { "x-on-behalf-of" => "acct_123" }
+  #   ).auto_paging_each { |rfi| puts rfi.id }
+  #
   # @example Raise a KYC RFI, then close it
   #   rfi = Airwallex::RFI.simulate_create(
   #     type: "KYC",
@@ -17,9 +37,42 @@ module Airwallex
   #   )
   #   rfi.simulate_close
   class RFI < APIResource
-    # @return [String] API resource path for simulated RFI actions
+    extend APIOperations::Retrieve
+    extend APIOperations::List
+
+    # Sandbox-only — see https://www.airwallex.com/docs/api/simulation/request-for-information
+    SIMULATION_PATH = "/api/v1/simulation/rfis"
+
+    # @return [String] API resource path for RFIs
     def self.resource_path
-      "/api/v1/simulation/rfis"
+      "/api/v1/rfis"
+    end
+
+    # List RFIs. Unlike most resources, RFIs use bookmark pagination: the
+    # response carries page_after/page_before instead of has_more/next_cursor,
+    # and the next page is requested with page: <page_after>.
+    #
+    # @param params [Hash] page: (bookmark), page_size: (1-2000, default
+    #   100), statuses: / types: (comma-separated strings, e.g.
+    #   "ACTION_REQUIRED,ANSWERED"), from_created_at: / end_created_at:
+    #   (ISO8601)
+    # @param opts [Hash] headers: (e.g. { "x-on-behalf-of" => account_id }),
+    #   kept on every subsequent page
+    # @return [ListObject<RFI>]
+    def self.list(params = {}, opts = {})
+      response = Airwallex.client.get(resource_path, params, opts[:headers] || {})
+      items = extract_data(response)
+      page_after = response.is_a?(Hash) ? response[:page_after] || response["page_after"] : nil
+
+      ListObject.new(
+        data: items,
+        has_more: !page_after.nil? && !items.empty?,
+        next_cursor: page_after,
+        cursor_param: :page,
+        resource_class: self,
+        params: params,
+        opts: opts
+      )
     end
 
     # Simulate Airwallex raising an RFI
@@ -28,18 +81,20 @@ module Airwallex
     #   "CARDHOLDER", "TRANSACTION", "PAYMENT_ENABLEMENT",
     #   "MERCHANT_RISK"); questions: (required, array of
     #   { answer: { type: }, sources: [] })
+    # @param opts [Hash] headers: (e.g. { "x-on-behalf-of" => account_id })
     # @return [RFI]
-    def self.simulate_create(params = {})
-      response = Airwallex.client.post("#{resource_path}/create", params)
+    def self.simulate_create(params = {}, opts = {})
+      response = Airwallex.client.post("#{SIMULATION_PATH}/create", params, opts[:headers] || {})
       new(response)
     end
 
     # Simulate closing an RFI
     #
     # @param rfi_id [String]
+    # @param opts [Hash] headers: (e.g. { "x-on-behalf-of" => account_id })
     # @return [RFI]
-    def self.simulate_close(rfi_id)
-      response = Airwallex.client.post("#{resource_path}/#{rfi_id}/close", {})
+    def self.simulate_close(rfi_id, opts = {})
+      response = Airwallex.client.post("#{SIMULATION_PATH}/#{rfi_id}/close", {}, opts[:headers] || {})
       new(response)
     end
 
@@ -49,17 +104,19 @@ module Airwallex
     # @param rfi_id [String]
     # @param params [Hash] questions: (required, array of
     #   { id: } or { answer: { type: }, sources: [] })
+    # @param opts [Hash] headers: (e.g. { "x-on-behalf-of" => account_id })
     # @return [RFI]
-    def self.simulate_follow_up(rfi_id, params = {})
-      response = Airwallex.client.post("#{resource_path}/#{rfi_id}/follow_up", params)
+    def self.simulate_follow_up(rfi_id, params = {}, opts = {})
+      response = Airwallex.client.post("#{SIMULATION_PATH}/#{rfi_id}/follow_up", params, opts[:headers] || {})
       new(response)
     end
 
     # Simulate closing this RFI
     #
+    # @param opts [Hash] headers: (e.g. { "x-on-behalf-of" => account_id })
     # @return [RFI] self
-    def simulate_close
-      response = Airwallex.client.post("#{self.class.resource_path}/#{id}/close", {})
+    def simulate_close(opts = {})
+      response = Airwallex.client.post("#{SIMULATION_PATH}/#{id}/close", {}, opts[:headers] || {})
       refresh_from(response)
       self
     end
@@ -67,9 +124,10 @@ module Airwallex
     # Simulate a follow-up on this RFI
     #
     # @param params [Hash] questions: (required)
+    # @param opts [Hash] headers: (e.g. { "x-on-behalf-of" => account_id })
     # @return [RFI] self
-    def simulate_follow_up(params = {})
-      response = Airwallex.client.post("#{self.class.resource_path}/#{id}/follow_up", params)
+    def simulate_follow_up(params = {}, opts = {})
+      response = Airwallex.client.post("#{SIMULATION_PATH}/#{id}/follow_up", params, opts[:headers] || {})
       refresh_from(response)
       self
     end

data/lib/airwallex/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Airwallex
-  VERSION = "0.9.0"
+  VERSION = "0.10.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: airwallex
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.10.0
 platform: ruby
 authors:
 - Chayut Orapinpatipat
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2026-09-09 00:00:00.000000000 Z
+date: 2026-09-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -144,7 +144,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.5.16
 signing_key:
 specification_version: 4
 summary: Production-grade Ruby client for the Airwallex API