@agent-cards/sdk 0.23.28 → 0.24.0

package/dist/client.d.ts

@@ -7,8 +7,8 @@ import { type VerifoneProfile, type VerifoneSubstitutions } from './verifone.js'
 import { type MerchantSessionCapture } from './merchant-session-probe.js';
 import { type PaddleTokenexServedFacts } from './paddle-tokenex.js';
 import type { PaddleCheckoutCapture } from './paddle-checkout-watch.js';
-import { VoiceModule, type VoiceOptions } from './voice.js';
 import { BuyModule } from './buy.js';
+import { ApprovalsModule } from './approvals.js';
 import { RequestRegistry } from './requests.js';
 import type { ApiTransport } from './api-module.js';
 import { type MicroformField, type MicroformSidecar } from './cybersource-flex.js';
@@ -121,6 +121,15 @@ export declare const SUPPORTED_REGISTRY_FEATURES: readonly string[];
  * recognizer is never in BUILTIN_REGISTRY, so a build reaches it only through a
  * sync that declares its capability, and whether an org may pay through it
  * stays the API's decision.
+ * `bluesnap_hosted_payment_fields`: BlueSnap's Hosted Payment Fields, whose card
+ * number, expiry and code frames each PUT their own field as JSON to the
+ * merchant's payment-fields token. This build pauses the card number PUT, holds
+ * the expiry and code PUTs and answers them with its answer (aci.ts, the JSON
+ * split card), and the cardholder's device sends the whole card in that one PUT
+ * (payment-core processors/bluesnap.js). The request names no amount, so the
+ * agent's pair, above zero, is the one the cardholder approves. Served on the
+ * same terms: only to a build that lists it, for a company Agentcard turned
+ * BlueSnap on for.
  * `creditguard_pps_process`: CreditGuard's hosted payment page (Hyp PPS), whose
  * card submit this build pays only under a prepared checkout that names the
  * framed page (prepare({ psp: 'creditguard', environment, paymentPageUrl })). The
@@ -459,6 +468,18 @@ export declare const SUPPORTED_REGISTRY_FEATURES: readonly string[];
  * page the create names. Served on the same terms: only to a build that lists it, for a company
  * Agentcard turned Pin Payments on for.
  *
+ * `paymentwall_card_token`: the card request Paymentwall's card form (Brick) sends, from its number
+ * frame on pwgateway.com inside Paymentwall's hosted widget or from a merchant's own page: a form POST
+ * to https://pwgateway.com/api/token (https://api.paymentwall.com/api/brick/token for a test key)
+ * under the merchant's public key. This build pauses only the card form's own body at those exact
+ * URLs (payment-core processors/paymentwall.js); a stored card's code, a wallet's token, a brand from
+ * the page's select or any other body there fails in the browser before anything is created. The
+ * cardholder's device sends the request itself with the real card, and the page gets the token answer
+ * payment-core's judge rebuilt. The request names no amount, so the agent's pair, above zero, is the
+ * one the cardholder approves, and the API pays only a Paymentwall project payment-core pins for the
+ * checkout page the create names. Served on the same terms: only to a build that lists it, for a
+ * company Agentcard turned Paymentwall on for.
+ *
  * `sbps_token_jsonp`: SB Payment Service's card token request, the JSONP <script>
  * GET its token script sends to /token/generateToken on token.sps-system.com. This
  * build pauses it only as the browser writes it, aborts any other request on that
@@ -475,6 +496,28 @@ export declare const SUPPORTED_REGISTRY_FEATURES: readonly string[];
  * Served on the same terms, and the API holds the lane to Agentcard's own company
  * until a reviewed change binds the client key to the merchant.
  *
+ * `iyzico_checkout_form`: the card payment iyzico's Checkout Form posts as one JSON request to
+ * api.iyzipay.com/payment/iyzipos/checkoutform/auth/ecom, or initialize3ds/ecom for 3-D Secure
+ * (sandbox-api.iyzipay.com in test), under the form's X-IYZI-TOKEN. This build pauses only the
+ * form's own payment with a new card at those exact URLs (payment-core processors/iyzico.js); a saved
+ * card, a card kept on file, installments and a currency conversion fail in the browser before
+ * anything is created. The cardholder's device sends the payment itself, and the page gets iyzico's
+ * answer as payment-core's judge rebuilt it: the payment done, or the bank's 3-D Secure page, which
+ * the form then runs in the agent's browser. The payment names its price but not its currency, so
+ * authorize() needs the agent's pair, and the API holds its amount to the price. Served on the same
+ * terms, and the API holds the lane to Agentcard's own company.
+ *
+ * `usaepay_payment_key`: the card request USAePay's Pay.js card frame sends as one JSON request to
+ * www.usaepay.com/api/v2/pub/payment_keys (secure.usaepay.com alike; sandbox.usaepay.com in test), under
+ * the merchant's public key in its Authorization. This build pauses only the frame's own card body at
+ * that exact URL (payment-core processors/usaepay.js); a Google Pay or Apple Pay token and a bank
+ * account on the same URL fail in the browser before anything is created. The cardholder's device sends
+ * the card through Agentcard's checkout relay, since USAePay answers no browser origin, and the frame
+ * gets USAePay's single-use payment key as payment-core's judge rebuilt it; the merchant's server
+ * charges that key afterwards. The request names no amount, so authorize() needs the agent's pair, and
+ * the API pays a live key only to a merchant payment-core pins for the checkout page. Served on the same
+ * terms, and the API holds the lane to Agentcard's own company.
+ *
  * `tap_card_sdk_token`: the token request Tap Payments' card frame sends to sdk.tap.company, carrying
  * the card only as one ciphertext the frame writes under the merchant's own RSA key. This build pauses
  * it and writes over the placeholder's ciphertext the one the cardholder's device wrote under the key
@@ -502,6 +545,16 @@ export declare const SUPPORTED_REGISTRY_FEATURES: readonly string[];
  * (agent-amount-processors.json), is the one the cardholder approves. Served on the same terms: only
  * to a build that lists it, for a company Agentcard turned Openpay on for.
  *
+ * `processout_card_token`: the card request ProcessOut.js's card frame sends from js.processout.com to
+ * api.processout.com/cards under the store's project id, only through a prepared checkout: the frame
+ * gives the page 20 seconds from the shop's continue press, so the cardholder approves before it. The
+ * card URL names the project in its query, so the claim binds the request by its project's environment
+ * and its shape, never by the prepared URL. The cardholder's device sends the card to ProcessOut itself
+ * and the frame gets back ProcessOut's token alone, rebuilt by payment-core's judge. The request names
+ * no amount, so the agent's pair, above zero (agent-amount-processors.json), is the one the cardholder
+ * approves. Served on the same terms: only to a build that lists it, for a company Agentcard turned
+ * ProcessOut on for.
+ *
  * `aps_custom_merchant_page`: Amazon Payment Services' custom merchant page, whose own card form
  * posts top-level to /FortAPI/paymentPage on checkout.payfort.com (sbcheckout.payfort.com on APS's
  * sandbox) with service_command=TOKENIZATION. This build pauses that navigation; the cardholder's
@@ -522,6 +575,14 @@ export declare const SUPPORTED_REGISTRY_FEATURES: readonly string[];
  * the cardholder approves, and the API holds its amount to the body's. Served on the same terms: only to a build
  * that lists it, for a company Agentcard turned Nexi Checkout on for.
  *
+ * `oceanpayment_hosted_payment_page`: the card post of Oceanpayment's hosted payment page (secure.oceanpayment.com, where
+ * Oceanpayment's Shopify redirect app sends the buyer), a native form post to /gateway/sendPay;jsessionid=<session> with
+ * the card in clear (test-secure.oceanpayment.com for a test row). This build pauses only that post, exactly as the page's
+ * form action writes it, and aborts every other post to Oceanpayment's two hosts (oceanpayment.ts), so the agent's
+ * placeholder never reaches Oceanpayment; the cardholder's device writes the real card into the paused post and sends it
+ * through the checkout relay. The post names no amount, so the agent's pair, above zero, is the one the cardholder
+ * approves. Served on the same terms: only to a build that lists it, for a company Agentcard turned Oceanpayment on for.
+ *
  * `barion_hosted_payment_page`: Barion's Smart Gateway, whose card-free link
  * (secure.barion.com/Pay?Id=<payment id>, a plain GET the merchant's redirect or script sends
  * the buyer to) this build pauses for the cardholder's device by its exact link (hosted-entry.ts),
@@ -529,6 +590,14 @@ export declare const SUPPORTED_REGISTRY_FEATURES: readonly string[];
  * send (pre-claim.ts, barion.ts). Served on the same terms as Przelewy24's: only to a build that
  * lists it, for a company Agentcard turned Barion on for.
  *
+ * `payplug_hosted_payment_page`: PayPlug's payment page, whose card-free link
+ * (secure.payplug.com/pay/<payment id>, or /pay/test/<payment id>, a plain GET the merchant's
+ * redirect or script sends the buyer to) this build pauses for the cardholder's device by its exact
+ * link (hosted-entry.ts), and whose card post this build never lets the agent's browser send
+ * (pre-claim.ts, payplug.ts). The link names no amount, so authorize() asks for the agent's, above
+ * zero. Served only to a build that lists it, and the API turns PayPlug on for Agentcard's own
+ * company alone.
+ *
  * `paymob_checkout_pay`: the card payment Paymob's own checkout sends, from Unified Checkout
  * (<country>.checkout.paymob.com) or from the Pixel card frame a merchant's page embeds, as JSON to
  * https://<accept|uae|ksa|oman>.paymob.com/api/acceptance/payments/pay. This build pauses only the
@@ -789,6 +858,14 @@ export interface CardEndpointReplay extends ExecutionMetadata {
     body: string;
     withheld: 'card_in_response' | 'unreadable_in_response' | 'refused_step_in_response' | null;
     amountAuthority?: AmountAuthority;
+    /**
+     * The amount the cardholder approved, an integer in the currency's smallest unit with its code, as the API's read
+     * names it; absent when it names none. Nike's order after its card is held to it (nike-order.ts).
+     */
+    approved?: {
+        amount: number;
+        currency: string;
+    };
 }
 /**
  * The device_encrypt flow (Payrails): the cardholder's device encrypted the
@@ -1019,6 +1096,12 @@ export interface AuthorizeInput extends ExecutionMetadata {
     };
     /** Milliseconds from the caller's pay click until the SDK caught the card request, measured on one clock. */
     payToInterceptMs?: number;
+    /**
+     * When the card request paused, in epoch milliseconds on this machine's clock; the adapters fill it. A VTEX Payments
+     * card post, whose checkout gives the post 12 seconds, sends how long ago that was (`paused_ms`), and the API counts
+     * the row's send-by from it.
+     */
+    pausedAt?: number;
     /**
      * WHICH stored card should pay — a vault card id from
      * GET /api/v2/vault_cards. The approval page preselects it (the human can
@@ -1562,13 +1645,6 @@ export interface VaultClientOptions {
      * the error is thrown. Default [500, 1500]; [] disables retries.
      */
     unverifiableRetryDelaysMs?: number[];
-    /**
-     * The voice module: how this product approves purchases by voice, named
-     * once per business, with the Vault return link and the verifier address
-     * beside it. Leave it out and the client approves on Agentcard's page
-     * (`approval: 'sheet'`). See `VoiceOptions`.
-     */
-    voice?: VoiceOptions;
     /**
      * Test mode only: run a merchant-hosted checkout against your own Adyen TEST
      * account. Each entry arms your own endpoint as taking the card request of a
@@ -1626,22 +1702,22 @@ export declare class VaultClient {
      * false: a live client.
      */
     get sandbox(): boolean;
-    /** What every module shares: the token, the HTTP path, the poll settings and the language list. */
+    /** What every module shares: the token, the HTTP path and the poll settings. */
     protected readonly transport: ApiTransport;
-    /**
-     * Approve purchases by voice inside your own product: connect a person once,
-     * create the purchase, ask for the key word, read the result. Same
-     * credentials, same token as the checkout calls. Approves on Agentcard's
-     * page unless `voice: { approval: 'in_app' }` was named at construction.
-     */
-    readonly voice: VoiceModule;
     /**
      * The Purchase API from the same client: ask for a cart on behalf of a
      * person you connected, confirm it by its hash, and name an approval the
-     * person already gave by voice so the API places against it and asks for
-     * nothing a second time. Same credentials, same token as the voice calls.
+     * person already gave so the API places against it and asks for
+     * nothing a second time. Same credentials, same token as the checkout calls.
      */
     readonly buy: BuyModule;
+    /**
+     * Purchases your server creates for a person, approved on Agentcard's page:
+     * create one (`request: 'sandbox'` under a sandbox client), send the person
+     * its `approval_url`, then read the decision or wait for it. Same
+     * credentials, same token as the checkout calls.
+     */
+    readonly approvals: ApprovalsModule;
     /**
      * The request builders: the processor requests a purchase pauses on, the
      * shipped ones and yours (`requests.register`, `requests.build`).
@@ -1865,9 +1941,9 @@ export declare class VaultClient {
      * exactly the approved payment method (the page's own, or written by the
      * adapters in place of a card the confirm carries again).
      * The API allows a card save for any company, for an approval given on the
-     * Vault page, not by voice, with no amount, and a SetupIntent Stripe reports
-     * still confirmable on the same Stripe account; any other answer rejects with
-     * a CheckoutApiError whose code says why (for example `amount_mismatch`, or
+     * Vault page, with no amount, and a SetupIntent Stripe reports still
+     * confirmable on the same Stripe account; any other answer rejects with a
+     * CheckoutApiError whose code says why (for example `amount_mismatch`, or
      * `continuation_invalid` for a confirm that is not a card-free SetupIntent
      * confirm). Nothing
      * is charged: the adapters continue the page's request once this resolves.
@@ -1983,7 +2059,9 @@ export declare class VaultClient {
      * (Stripe did not answer the read-back) is retried on a short backoff
      * instead of being left to the page's own retry loop, and a 409
      * `amount_mismatch` becomes an AmountMismatchError at stage 'create' so the
-     * adapters treat it as an answered request, not a dead page.
+     * adapters treat it as an answered request, not a dead page. `atSend` adds
+     * fields counted as each request leaves, after any token wait, 401 refresh or
+     * backoff, so a field that measures time (VTEX's paused_ms) measures it then.
      */
     private createAuthorization;
     private token;
@@ -2000,9 +2078,13 @@ export declare class VaultClient {
      * Only fetch and a successful response's body read belong to that retry:
      * OAuth, HTTP errors, invalid JSON and every mutation remain outside it.
      * The existing one-time 401 refresh carries the remaining read budget.
+     * `bodyAt`, when given, builds the body as each request leaves, after the
+     * token and on the 401 refresh's resend, in place of `init.body`.
      */
     private call;
     private post;
+    /** A POST whose body is built as each request leaves (call's `bodyAt`), for a body that counts time. */
+    private postAtSend;
     private get;
     private readPreparation;
 }