@delopay/sdk 0.280.0 → 0.289.0

package/dist/{chunk-3CHJT5YW.js → chunk-ZZEGL45P.js}

@@ -2782,6 +2782,29 @@ var Payments = class {
       body: params ?? {}
     });
   }
+  /**
+   * Mark a payment as an integration test, or remove the mark.
+   *
+   * A marked payment stays live or test as it was; only analytics leave it
+   * out, from their next refresh on. Every change is recorded in the
+   * payment's status history with the person who made it. Needs a dashboard
+   * JWT with write access to transactions. Asking for the mark the payment
+   * already carries changes nothing (`changed: false`).
+   *
+   * `POST /payments/{paymentId}/integration-test`
+   *
+   * @example
+   * ```typescript
+   * const { is_integration_test } = await delopay.payments.setIntegrationTest('pay_123', {
+   *   is_integration_test: true,
+   * });
+   * ```
+   */
+  async setIntegrationTest(paymentId, params) {
+    return this.request("POST", `/payments/${encodeURIComponent(paymentId)}/integration-test`, {
+      body: params
+    });
+  }
   /**
    * List payment intents, optionally filtered by customer or date range.
    *
@@ -4945,6 +4968,49 @@ var Users = class {
       body: params
     });
   }
+  /**
+   * A member's permission overrides in your merchant: every area that can be
+   * overridden at their level, with what their roles give, the level set for
+   * them, and what they have. `GET /user/employees/{user_id}/permission-overrides`
+   *
+   * Needs the *Users* read permission, and answers only for a member
+   * `listUsersInLineage` shows you (any other id is a 404 `UR_68`).
+   * `can_edit`, `can_raise` and each area's `grantable_level` say what you
+   * may change.
+   */
+  async getMemberPermissionOverrides(userId) {
+    return this.request(
+      "GET",
+      `/user/employees/${encodeURIComponent(userId)}/permission-overrides`
+    );
+  }
+  /**
+   * Replace a member's permission overrides. An area left out goes back to
+   * what their roles give. `PUT /user/employees/{user_id}/permission-overrides`
+   *
+   * Needs the *Users* write permission and a member within your reach, other
+   * than yourself. Keeping or lowering is always allowed; a gain must stay
+   * within what you hold in that area, and a gain above the member's roles
+   * needs `can_raise`. The change is audited and applies to the member's next
+   * request. A refusal is a `UR_68` whose `data` is
+   * `{ reason: 'permission_overrides', refusal }` (see
+   * {@link PermissionOverrideRefusal}).
+   */
+  async updateMemberPermissionOverrides(userId, params) {
+    return this.request(
+      "PUT",
+      `/user/employees/${encodeURIComponent(userId)}/permission-overrides`,
+      { body: params }
+    );
+  }
+  /**
+   * The permission overrides your own session acts under, sorted by area.
+   * An area named here has exactly that level, whatever a broader legacy area
+   * of the role would suggest. `GET /user/role/permission-overrides`
+   */
+  async getOwnPermissionOverrides() {
+    return this.request("GET", "/user/role/permission-overrides");
+  }
   /** Sign in via OIDC. `POST /user/oidc` */
   async signInOidc(params) {
     return this.request("POST", "/user/oidc", { body: params });
@@ -5139,6 +5205,150 @@ var Verification = class {
   }
 };
 
+// src/resources/identityVerifications.ts
+var IdentityVerifications = class {
+  constructor(request) {
+    this.request = request;
+  }
+  /**
+   * Start a verification of a person or a business. The provider-side
+   * workflow decides the checks. With a `return_url`, the provider's session
+   * is created at once and its page returned in `verification_url`. With a
+   * `payment_id` and no `return_url`, the payment's checkout starts it.
+   *
+   * `POST /identity-verifications`
+   */
+  async create(params, options) {
+    return this.request("POST", "/identity-verifications", { body: params, ...options });
+  }
+  /**
+   * The merchant's verifications, newest first. A caller limited to one shop
+   * sees that shop's only.
+   *
+   * `GET /identity-verifications`
+   */
+  async list(query, options) {
+    return this.request("GET", "/identity-verifications", {
+      query,
+      ...options
+    });
+  }
+  /**
+   * One verification. With `force_sync: true`, a verification the provider
+   * can still change (pending or in review, or a subject under ongoing AML
+   * monitoring) is read from the provider first.
+   *
+   * `GET /identity-verifications/{verification_id}`
+   */
+  async retrieve(verificationId, query, options) {
+    return this.request("GET", `/identity-verifications/${encodeURIComponent(verificationId)}`, {
+      query,
+      ...options
+    });
+  }
+  /**
+   * A subject's latest verification in one environment (live unless
+   * `test_mode: true`), with its checks, and the subject's verification under
+   * ongoing AML monitoring. This is what risk rules read. `verification` and
+   * `aml_monitoring` are `null` when the subject has none.
+   *
+   * `GET /identity-verifications/subjects/{subject_reference}`
+   */
+  async subject(subjectReference, query, options) {
+    return this.request(
+      "GET",
+      `/identity-verifications/subjects/${encodeURIComponent(subjectReference)}`,
+      { query, ...options }
+    );
+  }
+  /**
+   * The provider-side workflows an account can run in one environment, read
+   * from the provider with that environment's credentials. Pass a `flow_id`
+   * as `provider_flow_id` to {@link IdentityVerifications.create}.
+   *
+   * `GET /identity-verifications/accounts/{merchant_connector_id}/flows`
+   */
+  async flows(merchantConnectorId, query, options) {
+    return this.request(
+      "GET",
+      `/identity-verifications/accounts/${encodeURIComponent(merchantConnectorId)}/flows`,
+      { query, ...options }
+    );
+  }
+  /**
+   * Switch ongoing AML monitoring of a verification's subject. The provider
+   * then keeps re-screening the subject against sanctions, PEP and
+   * adverse-media lists, and every change it reports is recorded. Only a
+   * verified person or business can be enrolled; monitoring can be switched
+   * off at any time. Needs permission to edit customers.
+   *
+   * `POST /identity-verifications/{verification_id}/aml-monitoring`
+   */
+  async setAmlMonitoring(verificationId, params, options) {
+    return this.request(
+      "POST",
+      `/identity-verifications/${encodeURIComponent(verificationId)}/aml-monitoring`,
+      { body: params, ...options }
+    );
+  }
+  /**
+   * Every change of the subject's AML result the provider reported while the
+   * subject was monitored, newest first, at most 100.
+   *
+   * `GET /identity-verifications/{verification_id}/aml-events`
+   */
+  async amlEvents(verificationId, options) {
+    return this.request(
+      "GET",
+      `/identity-verifications/${encodeURIComponent(verificationId)}/aml-events`,
+      options
+    );
+  }
+  /**
+   * A payment's screening by the transaction monitoring of the shop's
+   * screening account. Recorded only: it never holds or refuses the payment.
+   * Answers 404 when the payment has no screening. Needs permission to read
+   * payments.
+   *
+   * `GET /identity-verifications/payment-screenings/{payment_id}`
+   */
+  async paymentScreening(paymentId, options) {
+    return this.request(
+      "GET",
+      `/identity-verifications/payment-screenings/${encodeURIComponent(paymentId)}`,
+      options
+    );
+  }
+  /**
+   * Whether an account screens its shop's payments. Needs permission to read
+   * connectors.
+   *
+   * `GET /identity-verifications/accounts/{merchant_connector_id}/payment-screening`
+   */
+  async paymentScreeningSetting(merchantConnectorId, options) {
+    return this.request(
+      "GET",
+      `/identity-verifications/accounts/${encodeURIComponent(merchantConnectorId)}/payment-screening`,
+      options
+    );
+  }
+  /**
+   * Switch screening of the account's shop's payments. Switched on, every
+   * payment of the shop that succeeds from then on is screened shortly after,
+   * in the payment's own environment. A shop has at most one screening
+   * account. Needs permission to edit connectors.
+   *
+   * `PUT /identity-verifications/accounts/{merchant_connector_id}/payment-screening`
+   */
+  async updatePaymentScreeningSetting(merchantConnectorId, params, options) {
+    return this.request(
+      "PUT",
+      `/identity-verifications/accounts/${encodeURIComponent(merchantConnectorId)}/payment-screening`,
+      { body: params, ...options }
+    );
+  }
+};
+
 // src/resources/webhooks.ts
 function isSubscriptionLifecycleWebhook(object) {
   return typeof object.transition_id === "string";
@@ -5875,6 +6085,110 @@ var ShopLabels = class {
   }
 };
 
+// src/resources/checkoutTemplates.ts
+var CheckoutTemplates = class {
+  constructor(request) {
+    this.request = request;
+  }
+  /**
+   * The merchant's templates, each with the shops on it and whether each
+   * runs the template's current settings.
+   * `GET /checkout-templates/{merchantId}`
+   */
+  async list(merchantId) {
+    return this.request("GET", `/checkout-templates/${encodeURIComponent(merchantId)}`);
+  }
+  /**
+   * Create a template, empty or copied from a shop's current settings. The
+   * shop copied from is not changed.
+   * `POST /checkout-templates/{merchantId}`
+   */
+  async create(merchantId, params) {
+    return this.request("POST", `/checkout-templates/${encodeURIComponent(merchantId)}`, {
+      body: params
+    });
+  }
+  /** `GET /checkout-templates/{merchantId}/{templateId}` */
+  async retrieve(merchantId, templateId) {
+    return this.request(
+      "GET",
+      `/checkout-templates/${encodeURIComponent(merchantId)}/${encodeURIComponent(templateId)}`
+    );
+  }
+  /**
+   * Rename a template. A name another template of the merchant holds is
+   * refused.
+   * `POST /checkout-templates/{merchantId}/{templateId}`
+   */
+  async rename(merchantId, templateId, params) {
+    return this.request(
+      "POST",
+      `/checkout-templates/${encodeURIComponent(merchantId)}/${encodeURIComponent(templateId)}`,
+      { body: params }
+    );
+  }
+  /**
+   * Delete a template. Refused while a shop is on it.
+   * `DELETE /checkout-templates/{merchantId}/{templateId}`
+   */
+  async delete(merchantId, templateId) {
+    return this.request(
+      "DELETE",
+      `/checkout-templates/${encodeURIComponent(merchantId)}/${encodeURIComponent(templateId)}`
+    );
+  }
+  /**
+   * Put shops on the template and copy its settings into them; a shop on
+   * another template moves. Each shop is reported on its own: one with
+   * `blockers` is left unchanged. `dry_run` changes nothing and reports what
+   * would change.
+   * `POST /checkout-templates/{merchantId}/{templateId}/shops`
+   */
+  async assign(merchantId, templateId, params) {
+    return this.request(
+      "POST",
+      `/checkout-templates/${encodeURIComponent(merchantId)}/${encodeURIComponent(templateId)}/shops`,
+      {
+        body: params
+      }
+    );
+  }
+  /**
+   * Take a shop off the template. It keeps every setting it has, as its own.
+   * `DELETE /checkout-templates/{merchantId}/{templateId}/shops/{profileId}`
+   */
+  async unassign(merchantId, templateId, profileId) {
+    return this.request(
+      "DELETE",
+      `/checkout-templates/${encodeURIComponent(merchantId)}/${encodeURIComponent(templateId)}/shops/${encodeURIComponent(profileId)}`
+    );
+  }
+  /**
+   * Copy the template's current settings into its shops, all or the ones
+   * named.
+   * `POST /checkout-templates/{merchantId}/{templateId}/apply`
+   */
+  async apply(merchantId, templateId, params = {}) {
+    return this.request(
+      "POST",
+      `/checkout-templates/${encodeURIComponent(merchantId)}/${encodeURIComponent(templateId)}/apply`,
+      {
+        body: params
+      }
+    );
+  }
+  /**
+   * The template a shop is on, if any. Readable by the shop's own members.
+   * `GET /checkout-templates/{merchantId}/shops/{profileId}`
+   */
+  async ofShop(merchantId, profileId) {
+    return this.request(
+      "GET",
+      `/checkout-templates/${encodeURIComponent(merchantId)}/shops/${encodeURIComponent(profileId)}`
+    );
+  }
+};
+
 // src/resources/buyerConversations.ts
 var BuyerConversations = class {
   constructor(request) {
@@ -7328,7 +7642,48 @@ var CheckoutMethods = class {
       query: { merchant_id: merchantId }
     });
   }
+  /**
+   * The shop's checkout entries: separate ways into the hosted checkout of
+   * one payment (`?entry=<key>`), such as a card form embedded in the shop's
+   * page, a "Pay with crypto" checkout and an "Other payment methods"
+   * checkout, each in its own named look. Live's by default; `environment:
+   * 'test'` reads the Test checkout's, used by payments with `test_mode: true`.
+   * Refused (403) to a caller that may not see or change every method.
+   * `GET /checkout-methods/{profile_id}/entries` (`/test/entries`)
+   */
+  async entries(merchantId, profileId, params = {}) {
+    return this.request("GET", entriesPath(profileId, params.environment), {
+      query: { merchant_id: merchantId }
+    });
+  }
+  /**
+   * Replace the shop's entries of one environment. Refused when a key is
+   * malformed or used twice, when an entry lists a method, group or card form
+   * that environment's layout does not place, or when a card entry's
+   * `other_entry` is not another `methods` entry.
+   * `PUT /checkout-methods/{profile_id}/entries` (`/test/entries`)
+   */
+  async updateEntries(merchantId, profileId, body, params = {}) {
+    return this.request("PUT", entriesPath(profileId, params.environment), {
+      query: { merchant_id: merchantId },
+      body
+    });
+  }
+  /**
+   * Delete every entry of one environment. A link that still names an entry
+   * then offers nothing.
+   * `DELETE /checkout-methods/{profile_id}/entries` (`/test/entries`)
+   */
+  async clearEntries(merchantId, profileId, params = {}) {
+    return this.request("DELETE", entriesPath(profileId, params.environment), {
+      query: { merchant_id: merchantId }
+    });
+  }
 };
+function entriesPath(profileId, environment) {
+  const shop = `/checkout-methods/${encodeURIComponent(profileId)}`;
+  return environment === "test" ? `${shop}/test/entries` : `${shop}/entries`;
+}
 
 // src/resources/subscriptions.ts
 var Subscriptions = class {
@@ -9085,6 +9440,41 @@ var Live = class {
   }
 };
 
+// src/resources/deploymentBranding.ts
+function brandingAssetPath(asset, version) {
+  const path = `/branding/assets/${encodeURIComponent(asset)}`;
+  return version ? `${path}?v=${encodeURIComponent(version)}` : path;
+}
+var Branding = class {
+  constructor(request, baseUrl) {
+    this.request = request;
+    this.baseUrl = baseUrl;
+  }
+  /**
+   * The saved branding. A `null` field means "keep your own default".
+   *
+   * Branding is cosmetic, so treat any failure as "nothing saved": routers
+   * from before this route answer 404, and a page must never wait long for
+   * it. Pass a `signal` (e.g. `AbortSignal.timeout(2500)`) to bound the call
+   * including its retries; a `timeout` alone applies to each attempt.
+   *
+   * `GET /branding`
+   */
+  async retrieve(options) {
+    return this.request("GET", "/branding", { ...options });
+  }
+  /**
+   * The address of one branding image or font file on this client's base
+   * URL, for an `<img src>` or a `@font-face` `src`. See
+   * {@link brandingAssetPath}.
+   *
+   * `GET /branding/assets/{asset}`
+   */
+  assetUrl(asset, version) {
+    return `${this.baseUrl}${brandingAssetPath(asset, version)}`;
+  }
+};
+
 // src/client.ts
 var PRODUCTION_URL = "https://api.delopay.net";
 var SANDBOX_URL = "https://sandbox.delopay.net";
@@ -9346,6 +9736,7 @@ var Delopay = class {
     this.profileAcquirers = new ProfileAcquirers(request);
     this.authentication = new Authentication(request);
     this.verification = new Verification(request);
+    this.identityVerifications = new IdentityVerifications(request);
     this.users = new Users(request);
     this.apiKeys = new ApiKeys(request);
     this.billing = new Billing(request);
@@ -9363,6 +9754,7 @@ var Delopay = class {
     this.messageTemplates = new MessageTemplates(request);
     this.risk = new Risk(request);
     this.live = new Live(request, openStream);
+    this.branding = new Branding(request, this.baseUrl);
     this.subscriptions = new Subscriptions(request);
     this.buyerPortal = new BuyerPortal(request);
     this.buyerAccount = new BuyerAccount(request);
@@ -9374,6 +9766,7 @@ var Delopay = class {
     this.sellToRestrictions = new SellToRestrictions(request);
     this.buyerBlocklist = new BuyerBlocklist(request);
     this.shopLabels = new ShopLabels(request);
+    this.checkoutTemplates = new CheckoutTemplates(request);
     this.buyerConversations = new BuyerConversations(request);
     this.buyerEvidence = new BuyerEvidenceReviews(request);
     this.checkoutRecovery = new CheckoutRecovery(request);
@@ -13207,6 +13600,10 @@ var CheckoutSession = class {
    * `cardAccount` name that form's connector and account; absent or blank
    * matches any.
    *
+   * `entry` opens one of the shop's checkout entries (`?entry=`): the layout
+   * holds only that entry's methods and is drawn in its named look, and
+   * `entry` on the answer says whether it had anything to offer.
+   *
    * `GET /payment-link/data/{merchantId}/{paymentId}`
    */
   async fetchCheckoutData(params, options) {
@@ -13220,7 +13617,8 @@ var CheckoutSession = class {
           country: country || void 0,
           card_only: params?.cardOnly || void 0,
           card_provider: params?.cardOnly ? params.cardProvider?.trim() || void 0 : void 0,
-          card_account: params?.cardOnly ? params.cardAccount?.trim() || void 0 : void 0
+          card_account: params?.cardOnly ? params.cardAccount?.trim() || void 0 : void 0,
+          entry: params?.entry?.trim() || void 0
         },
         ...options,
         headers: {
@@ -13640,6 +14038,25 @@ var CheckoutSession = class {
       headers: this.bearerHeaders(options?.headers)
     });
   }
+  /**
+   * Reserve this payment attempt before a hosted card form contacts Stripe,
+   * Airwallex, or NomuPay. Send the provider object rendered to this checkout
+   * and retain the same `flow_id` across retries and any 3-D Secure step.
+   *
+   * Only `authorized: true` permits the form to contact its processor. A
+   * competing flow receives `false` and must reload; an unresolved provider
+   * outcome stays reserved, regardless of elapsed time. A buyer-blocklist
+   * refusal throws a `DelopayError` with code `DE_14`.
+   *
+   * `POST /payment-link/{merchantId}/{paymentId}/browser-card-claim`
+   */
+  async claimBrowserCard(params, options) {
+    return this.client.request("POST", `${this.linkBase}/browser-card-claim`, {
+      body: params,
+      ...options,
+      headers: this.bearerHeaders(options?.headers)
+    });
+  }
   /**
    * Confirm the Stripe card form's PaymentIntent through the router, for a
    * checkout payload with `card_connector_server_confirm: true`. Stripe refuses
@@ -13661,6 +14078,10 @@ var CheckoutSession = class {
    * and that secret confirms nothing without the secret key — then call this
    * again without a payment method to finalize.
    *
+   * Reserve the attempt with {@link claimBrowserCard} first. Send its granted
+   * `flow_id` as `browser_flow_id` on both the initial and post-action confirm;
+   * an omitted, null or nonholder flow is refused with `400` and code `IR_16`.
+   *
    * A PaymentMethod rules out what `stripe.createPaymentMethod` cannot
    * produce: Stripe names Amazon Pay and Klarna in the Express Checkout
    * Element, which need `stripe.createConfirmationToken` instead. Neither can
@@ -13701,6 +14122,43 @@ var CheckoutSession = class {
       headers: this.bearerHeaders(options?.headers)
     });
   }
+  /**
+   * The payment's identity verification step: whether the payment asked for
+   * one, its outcome, and the provider's page while it is pending. A pending
+   * verification is read from the provider first, so call this when the buyer
+   * comes back from the provider's page.
+   *
+   * `required` is `false` when the payment asked for no verification.
+   * `can_retry` is `true` after an expired or abandoned attempt; start a new
+   * one with {@link CheckoutSession.startIdentityVerification}.
+   *
+   * `GET /payment-link/{merchantId}/{paymentId}/identity-verification`
+   */
+  async identityVerification(options) {
+    return this.client.request("GET", `${this.linkBase}/identity-verification`, {
+      ...options,
+      headers: this.bearerHeaders(options?.headers)
+    });
+  }
+  /**
+   * Resume the payment's pending identity verification, start it, or start a
+   * new attempt after an expired or abandoned one. Send the buyer to the
+   * returned `verification_url`; the provider sends them back to `return_url`,
+   * which must be on the payment's checkout origin.
+   *
+   * Refusals throw a `DelopayError`: `400` when the return URL is not on the
+   * payment's checkout or the verification is already decided, `404` when the
+   * payment asked for no verification.
+   *
+   * `POST /payment-link/{merchantId}/{paymentId}/identity-verification`
+   */
+  async startIdentityVerification(params, options) {
+    return this.client.request("POST", `${this.linkBase}/identity-verification`, {
+      body: params,
+      ...options,
+      headers: this.bearerHeaders(options?.headers)
+    });
+  }
   /**
    * Ask whether NomuPay's COPYandPAY widget may submit a card, from the
    * form's pre-submit hook.
@@ -14423,6 +14881,20 @@ function focusedCheckoutUrl(params) {
   if (params.customFieldsCollected) query.set("cf", "1");
   return `${path}?${query.toString()}`;
 }
+function checkoutEntryUrl(params) {
+  const base = params.checkoutBaseUrl.replace(/\/+$/, "");
+  const path = params.paymentLinkId && OPAQUE_PAYMENT_LINK_ID.test(params.paymentLinkId) ? `${base}/pay/${params.paymentLinkId}` : `${base}/pay/${encodeURIComponent(params.merchantId)}/${encodeURIComponent(
+    params.paymentId
+  )}`;
+  const query = new URLSearchParams({ entry: params.entry.trim() });
+  if (params.locale) query.set("locale", params.locale);
+  return `${path}?${query.toString()}`;
+}
+function isCheckoutOpenEntryMessage(data) {
+  if (typeof data !== "object" || data === null) return false;
+  const message = data;
+  return message.type === "open_entry" && typeof message.source === "string" && typeof message.payment_id === "string" && typeof message.entry === "string" && typeof message.url === "string";
+}
 var CHECKOUT_EVENT_KINDS = [
   "native_pane_selected",
   "native_pane_tab_opened",
@@ -14457,6 +14929,7 @@ export {
   PaypalDisputes,
   WhopResolutionCases,
   Search,
+  IdentityVerifications,
   isSubscriptionLifecycleWebhook,
   isSubscriptionDisputeWebhook,
   Webhooks,
@@ -14472,6 +14945,7 @@ export {
   SellToRestrictions,
   BuyerBlocklist,
   ShopLabels,
+  CheckoutTemplates,
   BuyerConversations,
   BuyerEvidenceReviews,
   CheckoutRecovery,
@@ -14492,6 +14966,8 @@ export {
   LiveEventStream,
   openLiveStream,
   Live,
+  brandingAssetPath,
+  Branding,
   Delopay,
   leaf,
   allOf,
@@ -14698,6 +15174,8 @@ export {
   decodePanes,
   encodePanes,
   focusedCheckoutUrl,
+  checkoutEntryUrl,
+  isCheckoutOpenEntryMessage,
   CHECKOUT_EVENT_KINDS,
   STRIPE_NATIVE_PANE_METHODS,
   NATIVE_PANE_ICON_KEYS,
@@ -14709,4 +15187,4 @@ export {
   decodeNativePanes,
   encodeNativePanes
 };
-//# sourceMappingURL=chunk-3CHJT5YW.js.map
+//# sourceMappingURL=chunk-ZZEGL45P.js.map