@didit-protocol/sdk-node 2.9.0 → 2.10.0

package/dist/index.cjs

@@ -282,7 +282,7 @@ function decodeDates(value, plan, named, depth = 0) {
 }
 
 // src/core/version.ts
-var VERSION = "2.9.0";
+var VERSION = "2.10.0";
 
 // src/core/runtime.ts
 function processLike() {
@@ -1175,6 +1175,7 @@ var DATE_PLANS = {
   },
   AddressValidationResponse: { p: { created_at: 1 } },
   AgeEstimationEstimateResponse: { p: { created_at: 1 } },
+  AgentTopUp: { p: { created_at: 1 } },
   AmlMonitoringRetrieveJobResponse: { p: { created_at: 1, completed_at: 1 } },
   AmlRetrieveDatasetFreshnessResponse: { p: { dataset_freshness: "AMLDatasetFreshness" } },
   AmlScreenResponse: {
@@ -1192,6 +1193,7 @@ var DATE_PLANS = {
       updated_at: 1
     }
   },
+  BillingTopUpCharge: { p: { top_up: "AgentTopUp" } },
   BiometricRetention: { p: { deletes_at: 1 } },
   BiometricTemplatesListResponse: {
     p: { results: { i: { p: { retained_at: 1, expires_at: 1, purged_at: 1 } } } }
@@ -2287,7 +2289,12 @@ var Bank = class extends APIResource {
 
 // src/resources/billing.ts
 var BILLING_RETRIEVE_BALANCE = { method: "GET", path: "/v3/billing/balance/" };
-var BILLING_TOP_UP = { method: "POST", path: "/v3/billing/top-up/", body: "json" };
+var BILLING_TOP_UP = {
+  method: "POST",
+  path: "/v3/billing/top-up/",
+  body: "json",
+  dates: "BillingTopUpCharge"
+};
 var Billing = class extends APIResource {
   /**
    * Get credit balance
@@ -2302,9 +2309,24 @@ var Billing = class extends APIResource {
   /**
    * Top up credits
    *
-   * Add credits via a hosted Stripe Checkout session (**\$50 to \$20,000** per top-up). Top-ups are available on the Free, Growth and Scale plans, added at face value with no discount or bonus, and last 12 months; Enterprise annual contracts cannot top up. Redirect the customer to the returned `checkout_session_url`.
+   * Add credits to the organization's balance (**\$50 to \$20,000** per top-up). Top-ups are available on the Free, Growth and Scale plans, added at face value with no discount or bonus, and last 12 months; Enterprise annual contracts cannot top up.
+   *
+   * Two payment methods, chosen with `payment_method`:
+   *
+   * - `checkout` (default): creates a hosted Stripe Checkout session. Redirect the customer to the returned `checkout_session_url` (`200`).
+   * - `saved_card`: charges the organization's saved primary card off-session, now, at the normal self-serve amounts. Send an `Idempotency-Key` header (required for this method). It answers `201` when the card was charged, and `202` when a request with the same key is still being processed.
+   *
+   * **Agent top-ups (`saved_card`).** One switch controls them: "Connected AI agents can top up with your saved card". It is off by default and only a person signed in to the console can turn it on (Billing > Payment methods), never an API key or an agent. While it is on, agents and API keys can top up with the primary saved card. When it is off, the request returns `403` `agent_top_up_not_enabled` with a link a person can use to top up in the console.
+   *
+   * The balance is credited once the payment is confirmed, usually within seconds, and tax is added to the amount charged when it applies, so `total` can be higher than `credit_amount`. Read `GET /v3/billing/balance/` to confirm.
+   *
+   * **Idempotency.** Retrying with the same `Idempotency-Key` and the same amount returns the same top-up and never charges twice. The same key with another amount returns `409` `idempotency_key_conflict`.
+   *
+   * Every error of a `saved_card` request carries a `code` and a `detail`, and most also a `next_step` (read it only when it is present). When the step needs a person (for example `authentication_required`, where the card's bank asks the cardholder to approve and nothing is charged), `next_step.url` is a signed link to the console that opens the Top up dialog with the amount filled in and says which agent asked; nothing is charged until the person pays. Each top-up is marked with the agent's name in billing history and in the ordinary receipt email.
    *
    * `POST /v3/billing/top-up/`
+   *
+   * Accepts `options.idempotencyKey` (header `Idempotency-Key`).
    */
   topUp(params, options) {
     return this._client.request(BILLING_TOP_UP, [], params, options);
@@ -3482,7 +3504,7 @@ var CasesRegulatoryReports = class extends APIResource {
   /**
    * Create report from case
    *
-   * Create a draft FIU report for the case: DRAFT status, auto-populated from the optional template plus the case's subject, linked transactions, and narrative. Validate then finalize to produce the goAML XML and PDF.
+   * Create a draft FIU report for the case: DRAFT status, auto-populated from the optional template plus the case's subject, linked transactions, and narrative. Validate then finalize to produce the goAML XML and PDF. FFR (Confirmed Name Match Report, formerly the Funds Freeze Report) and PNMR (Partial Name Match Report) are activity reports: they report the case's subject, not transactions, so a draft links no transactions by default and the narrative, reason and action are written from the sanctions matches on the case's AML screenings.
    *
    * `POST /v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/regulatory-reports/`
    *
@@ -6335,7 +6357,7 @@ var RegulatoryReports = class extends APIResource {
   /**
    * Finalize report
    *
-   * Re-validate, then render the goAML XML and PDF and upload both to S3. On SAR/STR/TFR reports, this also moves the case's transaction alerts from Pending SAR to SAR filed.
+   * Re-validate, then render the goAML XML and PDF and upload both to S3. On SAR/STR/TFR reports, this also moves the case's transaction alerts from Pending SAR to SAR filed. FFR and PNMR reports do not move alerts.
    *
    * `POST /v3/organization/{organization_id}/application/{application_id}/regulatory-reports/{report_uuid}/finalize/`
    *
@@ -6398,7 +6420,7 @@ var RegulatoryReports = class extends APIResource {
   /**
    * Validate report
    *
-   * Check the report against the obligatory goAML header fields (reporting entity ID, submission code, local currency, action taken, submission date), plus at least one attached transaction and a 2-letter jurisdiction, without generating any files. Also stores the result on the report: validation_errors and validated_at are updated, and a non-finalized report's status moves to VALIDATED (no errors) or back to DRAFT (errors).
+   * Check the report against the obligatory goAML header fields (reporting entity ID, submission code, local currency, action taken, submission date), plus at least one attached transaction and a 2-letter jurisdiction, without generating any files. For jurisdiction AE, once those pass, the report's goAML XML is also checked against the UAE FIU's goAML XML schema and each problem is returned as a field and a message; finalize refuses a report that fails. FFR and PNMR reports need no attached transaction: they require the case to have a subject, otherwise validation_errors contains an error with field `subject`. Also stores the result on the report: validation_errors and validated_at are updated, and a non-finalized report's status moves to VALIDATED (no errors) or back to DRAFT (errors).
    *
    * `POST /v3/organization/{organization_id}/application/{application_id}/regulatory-reports/{report_uuid}/validate/`
    *