@delopay/sdk 0.35.1 → 0.37.0

package/README.md

@@ -273,6 +273,36 @@ const all = await delopay.subscriptions.list({ limit: 20 }, opts);
 Each billing cycle raises an invoice (`sub.invoice`) with its own payment leg
 (`sub.payment`); track cycle outcomes via the subscription/invoice webhooks.
 
+### Platform fee rules
+
+Price the platform fee by payment method, connector, amount, currency or card
+network. Build the rule program with `feeProgram()` — rules are tried in order,
+first match wins, otherwise the default applies:
+
+```typescript
+import { Delopay, feeProgram } from '@delopay/sdk';
+
+const delopay = new Delopay(process.env.DELOPAY_API_KEY ?? '');
+
+const algorithm = feeProgram()
+  .rule({ name: 'crypto', when: { paymentMethod: 'crypto' }, fee: { percentage: 1.0 } })
+  .rule({
+    name: 'card_on_cryptomus',
+    when: { paymentMethod: 'card', connector: 'cryptomus' },
+    fee: { percentage: 2.0 },
+  })
+  .otherwise({ percentage: 3.0 })
+  .build();
+
+await delopay.fees.rules.upsert({ algorithm }, 'merchant_abc123');
+
+const program = await delopay.fees.rules.retrieve('merchant_abc123'); // or null
+await delopay.fees.rules.delete('merchant_abc123'); // revert to flat schedules
+```
+
+Merchants without a rule program keep their existing flat fee schedules / volume
+tier unchanged.
+
 ### Webhook verification
 
 Delopay signs each outgoing webhook with HMAC-SHA512 over the raw request body and delivers the hex-encoded digest in the `X-Webhook-Signature-512` header. Use `express.raw()` (not `express.json()`) so the bytes reach the verifier unchanged.

package/dist/{chunk-45OPT3EW.js → chunk-IQKFNKHU.js}

@@ -625,6 +625,7 @@ var Events = class {
 var Fees = class {
   constructor(request) {
     this.request = request;
+    this.rules = new FeeRulesManager(request);
   }
   /**
    * Create a merchant-scoped fee schedule (optionally per-shop).
@@ -666,6 +667,46 @@ var Fees = class {
     return this.request("DELETE", `/merchant-fees/${encodeURIComponent(feeId)}`);
   }
 };
+var FeeRulesManager = class {
+  constructor(request) {
+    this.request = request;
+  }
+  /**
+   * Create or replace the merchant's fee-rule program (a new active version;
+   * the previous version is deactivated server-side).
+   *
+   * @param params - The program plus optional name / shop scope / validity window.
+   * @param merchantId - The merchant account ID.
+   */
+  async upsert(params, merchantId) {
+    const body = { ...params, fee_owner: "merchant" };
+    return this.request("PUT", "/merchant-fees/rules", {
+      body,
+      query: { merchant_id: merchantId }
+    });
+  }
+  /**
+   * Retrieve the merchant's active fee-rule program, or `null` if none.
+   *
+   * @param merchantId - The merchant account ID.
+   */
+  async retrieve(merchantId) {
+    return this.request("GET", "/merchant-fees/rules", {
+      query: { merchant_id: merchantId }
+    });
+  }
+  /**
+   * Deactivate the merchant's active fee-rule program (falls back to the flat
+   * fee schedules / volume tier). Idempotent.
+   *
+   * @param merchantId - The merchant account ID.
+   */
+  async delete(merchantId) {
+    await this.request("DELETE", "/merchant-fees/rules", {
+      query: { merchant_id: merchantId }
+    });
+  }
+};
 
 // src/resources/mandates.ts
 var Mandates = class {
@@ -2314,51 +2355,23 @@ var Webhooks = {
 };
 
 // src/resources/analytics.ts
-var AnalyticsDomain = class {
-  constructor(request, domain) {
-    this.request = request;
-    this.domain = domain;
-  }
-  /** Get metrics. `POST /analytics/metrics/{domain}` */
-  async metrics(params, scope) {
-    const prefix = scope ? `/analytics/${scope}` : "/analytics";
-    return this.request("POST", `${prefix}/metrics/${encodeURIComponent(this.domain)}`, {
-      body: [params]
-    });
-  }
-  /** Get filters. `POST /analytics/filters/{domain}` */
-  async filters(params, scope) {
-    const prefix = scope ? `/analytics/${scope}` : "/analytics";
-    return this.request("POST", `${prefix}/filters/${encodeURIComponent(this.domain)}`, {
-      body: params
-    });
-  }
-  /** Generate report. `POST /analytics/report/{domain}` */
-  async report(params, scope) {
-    const prefix = scope ? `/analytics/${scope}` : "/analytics";
-    return this.request("POST", `${prefix}/report/${encodeURIComponent(this.domain)}`, {
-      body: params
-    });
-  }
-  /** Sankey chart data. `POST /analytics/metrics/{domain}/sankey` */
-  async sankey(params, scope) {
-    const prefix = scope ? `/analytics/${scope}` : "/analytics";
-    return this.request("POST", `${prefix}/metrics/${encodeURIComponent(this.domain)}/sankey`, {
-      body: params
-    });
-  }
-};
 var Analytics = class {
   constructor(request) {
     this.request = request;
-    this.payments = new AnalyticsDomain(request, "payments");
-    this.refunds = new AnalyticsDomain(request, "refunds");
-    this.disputes = new AnalyticsDomain(request, "disputes");
-    this.authEvents = new AnalyticsDomain(request, "auth_events");
-    this.sdkEvents = new AnalyticsDomain(request, "sdk_events");
-    this.frm = new AnalyticsDomain(request, "frm");
-    this.apiEvents = new AnalyticsDomain(request, "api_events");
-    this.routing = new AnalyticsDomain(request, "routing");
+  }
+  /**
+   * Scoped, drill-level analytics dashboard for the authenticated merchant
+   * (the same engine as the admin portal, pinned server-side to your own
+   * merchant). The server ignores `merchant_id` — it always scopes to your
+   * merchant, and to your single shop for profile-scoped users — so pass only
+   * `project_id` / `shop_id` to drill and the window / `sections` fields.
+   * Returns one drill level: the scope's daily series + previous window,
+   * processor mix and direct children. `GET /analytics/scope`
+   */
+  async scope(params) {
+    return this.request("GET", "/analytics/scope", {
+      query: params
+    });
   }
   /** Global search. `POST /analytics/search` */
   async search(params) {
@@ -3017,6 +3030,74 @@ var Delopay = class {
 /** Utility for verifying incoming webhook signatures (static, no instance needed). */
 Delopay.webhooks = Webhooks;
 
+// src/feeProgram.ts
+function toFeeOutput(spec) {
+  const hasPct = spec.percentage != null;
+  const hasFlat = spec.flat != null;
+  const feeType = hasPct && hasFlat ? "combined" : hasFlat ? "flat" : "percentage";
+  return {
+    fee_type: feeType,
+    percentage_fee: spec.percentage ?? null,
+    flat_fee_amount: spec.flat ?? null,
+    flat_fee_currency: spec.flatCurrency ?? null,
+    min_fee_amount: spec.min ?? null,
+    max_fee_amount: spec.max ?? null
+  };
+}
+function enumCondition(lhs, value) {
+  return { lhs, comparison: "equal", value: { type: "enum_variant", value }, metadata: {} };
+}
+function numberCondition(lhs, comparison, value) {
+  return { lhs, comparison, value: { type: "number", value }, metadata: {} };
+}
+function buildConditions(when = {}, raw = []) {
+  const out = [];
+  if (when.paymentMethod != null) out.push(enumCondition("payment_method", when.paymentMethod));
+  if (when.connector != null) out.push(enumCondition("connector", when.connector));
+  if (when.currency != null) out.push(enumCondition("currency", when.currency));
+  if (when.cardNetwork != null) out.push(enumCondition("card_network", when.cardNetwork));
+  if (when.amountEquals != null) out.push(numberCondition("amount", "equal", when.amountEquals));
+  if (when.amountGreaterThan != null) {
+    out.push(numberCondition("amount", "greater_than", when.amountGreaterThan));
+  }
+  if (when.amountLessThan != null) {
+    out.push(numberCondition("amount", "less_than", when.amountLessThan));
+  }
+  out.push(...raw);
+  return out;
+}
+var FeeProgramBuilder = class {
+  constructor() {
+    this.rules = [];
+    this.defaultFee = null;
+  }
+  /** Append a rule. Provided `when`/`rawConditions` are ANDed. */
+  rule(input) {
+    this.rules.push({
+      name: input.name,
+      connectorSelection: { fee: toFeeOutput(input.fee) },
+      statements: [{ condition: buildConditions(input.when, input.rawConditions) }]
+    });
+    return this;
+  }
+  /** Set the default selection (applied when no rule matches). */
+  otherwise(fee) {
+    this.defaultFee = toFeeOutput(fee);
+    return this;
+  }
+  /** Produce the wire-ready program. */
+  build() {
+    return {
+      defaultSelection: { fee: this.defaultFee },
+      rules: this.rules,
+      metadata: {}
+    };
+  }
+};
+function feeProgram() {
+  return new FeeProgramBuilder();
+}
+
 // src/branding.ts
 var FONT_STACKS = {
   inter: "'Inter Variable', 'Inter', system-ui, -apple-system, sans-serif",
@@ -3663,6 +3744,8 @@ export {
   Regions,
   Subscriptions,
   Delopay,
+  FeeProgramBuilder,
+  feeProgram,
   fontStack,
   radiusValue,
   fontWeightValue,
@@ -3692,4 +3775,4 @@ export {
   applyBrandingVariables,
   shadowFor
 };
-//# sourceMappingURL=chunk-45OPT3EW.js.map
+//# sourceMappingURL=chunk-IQKFNKHU.js.map