@dynamic-labs/sdk-api 0.17.0 → 0.18.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dynamic-labs/sdk-api",
-  "version": "0.17.0",
+  "version": "0.18.0",
   "author": "Dynamic Labs",
   "license": "Apache-2.0",
   "publishConfig": {

package/src/models/ChainalysisRuleField.cjs

@@ -17,12 +17,14 @@ Object.defineProperty(exports, '__esModule', { value: true });
  */
 /**
  * Absolute paths compare against the response; bare names compare against the
- * bound element of the enclosing `exists`. Categories lowercase both sides
- * before matching, which is how the vendor returns them. `risk` and
- * `ruleTriggered.risk` are the ordered scale Low, Medium, High, Severe, and a
- * vendor value off that scale evaluates to unknown rather than to a neighbour.
+ * bound element of the enclosing `exists` — `category` under
+ * `addressIdentifications`, `exposures` or `triggers`; `exposureType`,
+ * `direction` and `value` under `exposures`; `percentage` and the
+ * `ruleTriggered` fields under `triggers`. Core fields work here too, and are
+ * the only ones a pre-screen rule may use. String fields lowercase both sides
+ * before comparing, except `exposureType`, whose vocabulary is closed.
  * `cluster` and `ruleTriggered` are nullable, so a field beneath either is
- * unknown when the parent is absent.
+ * unknown.
  * @export
  * @enum {string}
  */

package/src/models/ChainalysisRuleField.d.ts

@@ -11,12 +11,14 @@
  */
 /**
  * Absolute paths compare against the response; bare names compare against the
- * bound element of the enclosing `exists`. Categories lowercase both sides
- * before matching, which is how the vendor returns them. `risk` and
- * `ruleTriggered.risk` are the ordered scale Low, Medium, High, Severe, and a
- * vendor value off that scale evaluates to unknown rather than to a neighbour.
+ * bound element of the enclosing `exists` — `category` under
+ * `addressIdentifications`, `exposures` or `triggers`; `exposureType`,
+ * `direction` and `value` under `exposures`; `percentage` and the
+ * `ruleTriggered` fields under `triggers`. Core fields work here too, and are
+ * the only ones a pre-screen rule may use. String fields lowercase both sides
+ * before comparing, except `exposureType`, whose vocabulary is closed.
  * `cluster` and `ruleTriggered` are nullable, so a field beneath either is
- * unknown when the parent is absent.
+ * unknown.
  * @export
  * @enum {string}
  */

package/src/models/ChainalysisRuleField.js

@@ -13,12 +13,14 @@
  */
 /**
  * Absolute paths compare against the response; bare names compare against the
- * bound element of the enclosing `exists`. Categories lowercase both sides
- * before matching, which is how the vendor returns them. `risk` and
- * `ruleTriggered.risk` are the ordered scale Low, Medium, High, Severe, and a
- * vendor value off that scale evaluates to unknown rather than to a neighbour.
+ * bound element of the enclosing `exists` — `category` under
+ * `addressIdentifications`, `exposures` or `triggers`; `exposureType`,
+ * `direction` and `value` under `exposures`; `percentage` and the
+ * `ruleTriggered` fields under `triggers`. Core fields work here too, and are
+ * the only ones a pre-screen rule may use. String fields lowercase both sides
+ * before comparing, except `exposureType`, whose vocabulary is closed.
  * `cluster` and `ruleTriggered` are nullable, so a field beneath either is
- * unknown when the parent is absent.
+ * unknown.
  * @export
  * @enum {string}
  */

package/src/models/ScreeningCoreField.cjs

@@ -16,9 +16,11 @@ Object.defineProperty(exports, '__esModule', { value: true });
  * Do not edit the class manually.
  */
 /**
- * Fields available regardless of vendor. `tx.amountUsd` is populated only where
- * an amount in established USD exists, so a rule using it sits out (unknown) on
- * the signing path rather than firing.
+ * Fields needing no vendor response, so they work in both phases, and the only
+ * fields a pre-screen rule may use. `tx.amountUsd` and `tx.asset` are present
+ * only where the request establishes them; neither is available on the signing
+ * path. `address` compares case-sensitively, since base58 chains are
+ * case-significant. An absent field compares unknown, so the rule sits out.
  * @export
  * @enum {string}
  */

package/src/models/ScreeningCoreField.d.ts

@@ -10,9 +10,11 @@
  * Do not edit the class manually.
  */
 /**
- * Fields available regardless of vendor. `tx.amountUsd` is populated only where
- * an amount in established USD exists, so a rule using it sits out (unknown) on
- * the signing path rather than firing.
+ * Fields needing no vendor response, so they work in both phases, and the only
+ * fields a pre-screen rule may use. `tx.amountUsd` and `tx.asset` are present
+ * only where the request establishes them; neither is available on the signing
+ * path. `address` compares case-sensitively, since base58 chains are
+ * case-significant. An absent field compares unknown, so the rule sits out.
  * @export
  * @enum {string}
  */

package/src/models/ScreeningCoreField.js

@@ -12,9 +12,11 @@
  * Do not edit the class manually.
  */
 /**
- * Fields available regardless of vendor. `tx.amountUsd` is populated only where
- * an amount in established USD exists, so a rule using it sits out (unknown) on
- * the signing path rather than firing.
+ * Fields needing no vendor response, so they work in both phases, and the only
+ * fields a pre-screen rule may use. `tx.amountUsd` and `tx.asset` are present
+ * only where the request establishes them; neither is available on the signing
+ * path. `address` compares case-sensitively, since base58 chains are
+ * case-significant. An absent field compares unknown, so the rule sits out.
  * @export
  * @enum {string}
  */

package/src/models/TrmRuleField.cjs

@@ -17,12 +17,11 @@ Object.defineProperty(exports, '__esModule', { value: true });
  */
 /**
  * Absolute paths compare against the response; bare names compare against the
- * bound element of the enclosing `exists`. Category strings match
- * case-sensitively: TRM returns them TitleCase and `Sanctions` stops matching
- * if folded. The indicator score is `categoryRiskScoreLevel`, the wire name;
- * TRM has no `severity` field at any level, and `riskScoreLevel` belongs to an
- * entity, which means something different. Scores compare numerically against
- * the values TRM emits (1, 5, 10, 15); labels are display-only.
+ * bound element of the enclosing `exists` — `category`, `riskType` and
+ * `categoryRiskScoreLevel` under `trm.addressRiskIndicators`; `category`,
+ * `isVasp` and `riskScoreLevel` under `trm.entities`. Core fields work here
+ * too, and are the only ones a pre-screen rule may use. Category strings match
+ * case-sensitively; TRM returns them TitleCase.
  * @export
  * @enum {string}
  */

package/src/models/TrmRuleField.d.ts

@@ -11,12 +11,11 @@
  */
 /**
  * Absolute paths compare against the response; bare names compare against the
- * bound element of the enclosing `exists`. Category strings match
- * case-sensitively: TRM returns them TitleCase and `Sanctions` stops matching
- * if folded. The indicator score is `categoryRiskScoreLevel`, the wire name;
- * TRM has no `severity` field at any level, and `riskScoreLevel` belongs to an
- * entity, which means something different. Scores compare numerically against
- * the values TRM emits (1, 5, 10, 15); labels are display-only.
+ * bound element of the enclosing `exists` — `category`, `riskType` and
+ * `categoryRiskScoreLevel` under `trm.addressRiskIndicators`; `category`,
+ * `isVasp` and `riskScoreLevel` under `trm.entities`. Core fields work here
+ * too, and are the only ones a pre-screen rule may use. Category strings match
+ * case-sensitively; TRM returns them TitleCase.
  * @export
  * @enum {string}
  */

package/src/models/TrmRuleField.js

@@ -13,12 +13,11 @@
  */
 /**
  * Absolute paths compare against the response; bare names compare against the
- * bound element of the enclosing `exists`. Category strings match
- * case-sensitively: TRM returns them TitleCase and `Sanctions` stops matching
- * if folded. The indicator score is `categoryRiskScoreLevel`, the wire name;
- * TRM has no `severity` field at any level, and `riskScoreLevel` belongs to an
- * entity, which means something different. Scores compare numerically against
- * the values TRM emits (1, 5, 10, 15); labels are display-only.
+ * bound element of the enclosing `exists` — `category`, `riskType` and
+ * `categoryRiskScoreLevel` under `trm.addressRiskIndicators`; `category`,
+ * `isVasp` and `riskScoreLevel` under `trm.entities`. Core fields work here
+ * too, and are the only ones a pre-screen rule may use. Category strings match
+ * case-sensitively; TRM returns them TitleCase.
  * @export
  * @enum {string}
  */