@delopay/sdk 0.285.0 → 0.289.0

package/dist/internal.cjs

@@ -36,6 +36,7 @@ __export(internal_exports, {
   APPLE_PAY_BUTTON_STYLES: () => APPLE_PAY_BUTTON_STYLES,
   APPLE_PAY_BUTTON_TYPES: () => APPLE_PAY_BUTTON_TYPES,
   Admin: () => Admin,
+  AdminBranding: () => AdminBranding,
   AdminLive: () => AdminLive,
   AdminPortal: () => AdminPortal,
   Analytics: () => Analytics,
@@ -46,6 +47,7 @@ __export(internal_exports, {
   BRANDING_EXPORT_FORMAT: () => BRANDING_EXPORT_FORMAT,
   BRANDING_EXPORT_VERSION: () => BRANDING_EXPORT_VERSION,
   BUILTIN_PAYMENT_ICON_KEYS: () => BUILTIN_PAYMENT_ICON_KEYS,
+  Branding: () => Branding,
   BuyerBlocklist: () => BuyerBlocklist,
   BuyerConversations: () => BuyerConversations,
   BuyerEvidenceReviews: () => BuyerEvidenceReviews,
@@ -69,6 +71,7 @@ __export(internal_exports, {
   CheckoutMethods: () => CheckoutMethods,
   CheckoutRecovery: () => CheckoutRecovery,
   CheckoutSession: () => CheckoutSession,
+  CheckoutTemplates: () => CheckoutTemplates,
   Configs: () => Configs,
   ConnectorRestrictionRules: () => ConnectorRestrictionRules,
   ConnectorRestrictions: () => ConnectorRestrictions,
@@ -181,6 +184,7 @@ __export(internal_exports, {
   anyOf: () => anyOf,
   applyBrandingVariables: () => applyBrandingVariables,
   asAirwallexCardPreset: () => asAirwallexCardPreset,
+  brandingAssetPath: () => brandingAssetPath,
   buildBrandingExport: () => buildBrandingExport,
   builtinPaymentIconDataUri: () => builtinPaymentIconDataUri,
   builtinPaymentIconSvg: () => builtinPaymentIconSvg,
@@ -5268,6 +5272,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 });
@@ -5492,7 +5539,8 @@ var IdentityVerifications = class {
   }
   /**
    * One verification. With `force_sync: true`, a verification the provider
-   * can still change (pending or in review) is read from the provider first.
+   * 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}`
    */
@@ -5504,8 +5552,9 @@ var IdentityVerifications = class {
   }
   /**
    * A subject's latest verification in one environment (live unless
-   * `test_mode: true`), with its checks. This is what risk rules read.
-   * `verification` is `null` when the subject has none.
+   * `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}`
    */
@@ -5530,6 +5579,78 @@ var IdentityVerifications = class {
       { 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
@@ -6268,6 +6389,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) {
@@ -9519,6 +9744,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";
@@ -9798,6 +10058,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);
@@ -9809,6 +10070,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);
@@ -14080,6 +14342,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
@@ -14101,6 +14382,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
@@ -14981,6 +15266,33 @@ var Admin = class {
   }
 };
 
+// src/internal/resources/adminBranding.ts
+var AdminBranding = class {
+  constructor(request) {
+    this.request = request;
+  }
+  /**
+   * What is saved, the value in force for each unset field, and the revision
+   * to send back on the next update.
+   *
+   * `GET /admin-portal/branding`
+   */
+  async retrieve(options) {
+    return this.request("GET", "/admin-portal/branding", { ...options });
+  }
+  /**
+   * Replace the whole branding; all fields `null` clears it. A changed image
+   * or font address is fetched first and refused unless it answers with the
+   * right kind of file. A stale `expected_revision` is refused and changes
+   * nothing.
+   *
+   * `PUT /admin-portal/branding`
+   */
+  async update(params, options) {
+    return this.request("PUT", "/admin-portal/branding", { body: params, ...options });
+  }
+};
+
 // src/internal/resources/adminLive.ts
 var AdminLive = class {
   constructor(request, openStream) {
@@ -15595,6 +15907,32 @@ var AdminPortal = class {
       { body }
     );
   }
+  /**
+   * A member of `merchantId`'s permission overrides.
+   * `GET /admin-portal/accounts/{merchant_id}/members/{user_id}/permission-overrides`
+   *
+   * Any internal role may read them; `can_edit` is `false` for one without
+   * `UsersManage`. A user holding no role in the merchant is a 404 `UR_68`.
+   */
+  async getMemberPermissionOverrides(merchantId, userId) {
+    return this.request(
+      "GET",
+      `/admin-portal/accounts/${encodeURIComponent(merchantId)}/members/${encodeURIComponent(userId)}/permission-overrides`
+    );
+  }
+  /**
+   * Replace a member of `merchantId`'s permission overrides. Needs
+   * `UsersManage`; an operator is not limited by their own access. Recorded
+   * in the merchant's audit log and applied to the member's next request.
+   * `PUT /admin-portal/accounts/{merchant_id}/members/{user_id}/permission-overrides`
+   */
+  async updateMemberPermissionOverrides(merchantId, userId, body) {
+    return this.request(
+      "PUT",
+      `/admin-portal/accounts/${encodeURIComponent(merchantId)}/members/${encodeURIComponent(userId)}/permission-overrides`,
+      { body }
+    );
+  }
   /**
    * Soft-delete a user globally: deactivates the row, blacklists existing
    * JWTs, and wipes credentials. Distinct from `deleteUserRole`, which
@@ -16721,6 +17059,7 @@ var DelopayInternal = class extends Delopay {
     this.adminPortal = new AdminPortal(request);
     const openStream = this.openEventStream.bind(this);
     this.adminLive = new AdminLive(request, openStream);
+    this.adminBranding = new AdminBranding(request);
     this.auditLogs = new AuditLogs(request);
     this.cache = new Cache(request);
     this.cardIssuers = new CardIssuers(request);
@@ -16754,6 +17093,7 @@ var DelopayInternal = class extends Delopay {
   APPLE_PAY_BUTTON_STYLES,
   APPLE_PAY_BUTTON_TYPES,
   Admin,
+  AdminBranding,
   AdminLive,
   AdminPortal,
   Analytics,
@@ -16764,6 +17104,7 @@ var DelopayInternal = class extends Delopay {
   BRANDING_EXPORT_FORMAT,
   BRANDING_EXPORT_VERSION,
   BUILTIN_PAYMENT_ICON_KEYS,
+  Branding,
   BuyerBlocklist,
   BuyerConversations,
   BuyerEvidenceReviews,
@@ -16787,6 +17128,7 @@ var DelopayInternal = class extends Delopay {
   CheckoutMethods,
   CheckoutRecovery,
   CheckoutSession,
+  CheckoutTemplates,
   Configs,
   ConnectorRestrictionRules,
   ConnectorRestrictions,
@@ -16899,6 +17241,7 @@ var DelopayInternal = class extends Delopay {
   anyOf,
   applyBrandingVariables,
   asAirwallexCardPreset,
+  brandingAssetPath,
   buildBrandingExport,
   builtinPaymentIconDataUri,
   builtinPaymentIconSvg,