@dynamic-labs/sdk-api 0.26.0 → 0.28.0

package/src/models/KybVerifyRequest.d.ts

@@ -11,7 +11,6 @@
  */
 import { KybVerifyRequestAdditionalInfo } from './KybVerifyRequestAdditionalInfo';
 import { KybVerifyRequestBusinessData } from './KybVerifyRequestBusinessData';
-import { KybVerifyRequestDocuments } from './KybVerifyRequestDocuments';
 import { KybVerifyRequestOfficers } from './KybVerifyRequestOfficers';
 /**
  *
@@ -32,11 +31,11 @@ export interface KybVerifyRequest {
      */
     businessData?: KybVerifyRequestBusinessData;
     /**
-     * Business documents as base64. Not stored by Redcoast — forwarded to AI Prise's add_business_document endpoint.
-     * @type {Array<KybVerifyRequestDocuments>}
+     * AI Prise document ids returned by uploadKybDocument. Upload each document first, then reference its id here.
+     * @type {Array<string>}
      * @memberof KybVerifyRequest
      */
-    documents?: Array<KybVerifyRequestDocuments>;
+    documentIds?: Array<string>;
     /**
      * Business officers/directors. Not stored by Redcoast — each entry registers a related person and starts their own KYC verification session.
      * @type {Array<KybVerifyRequestOfficers>}
@@ -44,7 +43,7 @@ export interface KybVerifyRequest {
      */
     officers?: Array<KybVerifyRequestOfficers>;
     /**
-     * Officer PII and documents forwarded to AI Prise. Not stored by Redcoast.
+     * Officer PII and document references forwarded to AI Prise. Not stored by Redcoast.
      * @type {Array<KybVerifyRequestAdditionalInfo>}
      * @memberof KybVerifyRequest
      */

package/src/models/KybVerifyRequest.js

@@ -1,7 +1,6 @@
 import { exists } from '../runtime.js';
 import { KybVerifyRequestAdditionalInfoFromJSON, KybVerifyRequestAdditionalInfoToJSON } from './KybVerifyRequestAdditionalInfo.js';
 import { KybVerifyRequestBusinessDataFromJSON, KybVerifyRequestBusinessDataToJSON } from './KybVerifyRequestBusinessData.js';
-import { KybVerifyRequestDocumentsFromJSON, KybVerifyRequestDocumentsToJSON } from './KybVerifyRequestDocuments.js';
 import { KybVerifyRequestOfficersFromJSON, KybVerifyRequestOfficersToJSON } from './KybVerifyRequestOfficers.js';
 
 /* tslint:disable */
@@ -15,7 +14,7 @@ function KybVerifyRequestFromJSONTyped(json, ignoreDiscriminator) {
     return {
         'tier': json['tier'],
         'businessData': !exists(json, 'businessData') ? undefined : KybVerifyRequestBusinessDataFromJSON(json['businessData']),
-        'documents': !exists(json, 'documents') ? undefined : (json['documents'].map(KybVerifyRequestDocumentsFromJSON)),
+        'documentIds': !exists(json, 'documentIds') ? undefined : json['documentIds'],
         'officers': !exists(json, 'officers') ? undefined : (json['officers'].map(KybVerifyRequestOfficersFromJSON)),
         'additionalInfo': !exists(json, 'additionalInfo') ? undefined : (json['additionalInfo'].map(KybVerifyRequestAdditionalInfoFromJSON)),
     };
@@ -30,7 +29,7 @@ function KybVerifyRequestToJSON(value) {
     return {
         'tier': value.tier,
         'businessData': KybVerifyRequestBusinessDataToJSON(value.businessData),
-        'documents': value.documents === undefined ? undefined : (value.documents.map(KybVerifyRequestDocumentsToJSON)),
+        'documentIds': value.documentIds,
         'officers': value.officers === undefined ? undefined : (value.officers.map(KybVerifyRequestOfficersToJSON)),
         'additionalInfo': value.additionalInfo === undefined ? undefined : (value.additionalInfo.map(KybVerifyRequestAdditionalInfoToJSON)),
     };

package/src/models/SanctionsWalletBlockedEventPayload.d.ts

@@ -10,7 +10,15 @@
  * Do not edit the class manually.
  */
 /**
- * Payload of the `sanctions.wallet.blocked` webhook event.
+ * Payload of the `wallet.sanctions.blocked` webhook event, and of its
+ * deprecated `sanctions.wallet.blocked` alias.
+ *
+ * Scope: the sanctions floor only. A block produced by a customer's own
+ * screening policy emits `wallet.addressScreening.blocked` instead, which
+ * carries a `reason` explaining which rule matched. A block with no policy
+ * engine in play — the flag off, or a provider the engine does not
+ * evaluate — emits this event, so an environment that has authored nothing
+ * sees exactly what it saw before.
  *
  * Trigger semantics:
  * - Fires once per user-facing BLOCKED boundary decision (the

package/src/models/ScreeningReason.cjs

@@ -0,0 +1,69 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var runtime = require('../runtime.cjs');
+
+/* tslint:disable */
+/**
+* @export
+* @enum {string}
+*/
+exports.ScreeningReasonProviderEnum = void 0;
+(function (ScreeningReasonProviderEnum) {
+    ScreeningReasonProviderEnum["TrmWalletScreening"] = "trm-wallet-screening";
+    ScreeningReasonProviderEnum["ChainalysisAddressScreening"] = "chainalysis-address-screening";
+    ScreeningReasonProviderEnum["DynamicSanctionsScreening"] = "dynamic-sanctions-screening";
+})(exports.ScreeningReasonProviderEnum || (exports.ScreeningReasonProviderEnum = {})); /**
+* @export
+* @enum {string}
+*/
+exports.ScreeningReasonMatchedEnum = void 0;
+(function (ScreeningReasonMatchedEnum) {
+    ScreeningReasonMatchedEnum["Floor"] = "floor";
+    ScreeningReasonMatchedEnum["Address"] = "address";
+    ScreeningReasonMatchedEnum["Customer"] = "customer";
+    ScreeningReasonMatchedEnum["Default"] = "default";
+})(exports.ScreeningReasonMatchedEnum || (exports.ScreeningReasonMatchedEnum = {}));
+function ScreeningReasonFromJSON(json) {
+    return ScreeningReasonFromJSONTyped(json);
+}
+function ScreeningReasonFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'provider': json['provider'],
+        'matched': json['matched'],
+        'revision': !runtime.exists(json, 'revision') ? undefined : json['revision'],
+        'rule': !runtime.exists(json, 'rule') ? undefined : json['rule'],
+        'category': !runtime.exists(json, 'category') ? undefined : json['category'],
+        'riskType': !runtime.exists(json, 'riskType') ? undefined : json['riskType'],
+        'score': !runtime.exists(json, 'score') ? undefined : json['score'],
+        'risk': !runtime.exists(json, 'risk') ? undefined : json['risk'],
+        'summary': !runtime.exists(json, 'summary') ? undefined : json['summary'],
+    };
+}
+function ScreeningReasonToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'provider': value.provider,
+        'matched': value.matched,
+        'revision': value.revision,
+        'rule': value.rule,
+        'category': value.category,
+        'riskType': value.riskType,
+        'score': value.score,
+        'risk': value.risk,
+        'summary': value.summary,
+    };
+}
+
+exports.ScreeningReasonFromJSON = ScreeningReasonFromJSON;
+exports.ScreeningReasonFromJSONTyped = ScreeningReasonFromJSONTyped;
+exports.ScreeningReasonToJSON = ScreeningReasonToJSON;

package/src/models/ScreeningReason.d.ts

@@ -0,0 +1,112 @@
+/**
+ * Dashboard API
+ * Dashboard API documentation
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Why a screening policy reached its verdict: which layer matched, and what
+ * it matched on in the vendor's own vocabulary.
+ *
+ * Only `provider` and `matched` are always present. The rest depend on the
+ * vendor and on which leaf actually fired — a floor match on a Chainalysis
+ * cluster carries a `category` and no `riskType`.
+ * @export
+ * @interface ScreeningReason
+ */
+export interface ScreeningReason {
+    /**
+     * The vendor whose response produced this verdict.
+     * @type {string}
+     * @memberof ScreeningReason
+     */
+    provider: ScreeningReasonProviderEnum;
+    /**
+     * Which layer decided. `floor` is the non-configurable sanctions
+     * baseline, `address` an allow/deny list entry, `customer` one of the
+     * environment's own rules, `default` the terminal allow. On this event
+     * it is always `customer` or `address`; a floor block emits
+     * `wallet.sanctions.blocked` instead.
+     * @type {string}
+     * @memberof ScreeningReason
+     */
+    matched: ScreeningReasonMatchedEnum;
+    /**
+     * The policy generation that produced this verdict. Scoped to one
+     * screening moment, so two verdicts in the same environment can
+     * legitimately carry different revisions.
+     * @type {number}
+     * @memberof ScreeningReason
+     */
+    revision?: number;
+    /**
+     * The matched rule, verbatim as evaluated. Present only when `matched`
+     * is `customer`: the floor and the terminal allow are generated from
+     * code, so there is nothing stable to point at. Deliberately untyped —
+     * nothing routes on its internal shape, and it is carried for the audit
+     * record.
+     * @type {object}
+     * @memberof ScreeningReason
+     */
+    rule?: object;
+    /**
+     * The vendor's category string, verbatim, in the vendor's own casing.
+     * @type {string}
+     * @memberof ScreeningReason
+     */
+    category?: string;
+    /**
+     * TRM only. `OWNERSHIP`, `COUNTERPARTY` or `INDIRECT`.
+     * @type {string}
+     * @memberof ScreeningReason
+     */
+    riskType?: string;
+    /**
+     * TRM only. The numeric risk score the matched signal carried.
+     * @type {number}
+     * @memberof ScreeningReason
+     */
+    score?: number;
+    /**
+     * Chainalysis only. The risk level the matched signal carried.
+     * @type {string}
+     * @memberof ScreeningReason
+     */
+    risk?: string;
+    /**
+     * Human-readable rendering of what matched, for display and logs.
+     *
+     * DISPLAY ONLY AND NON-CONTRACTUAL: the wording may change in any
+     * release. Do not parse it — route on `category`, `provider` and
+     * `matched` instead.
+     * @type {string}
+     * @memberof ScreeningReason
+     */
+    summary?: string;
+}
+/**
+* @export
+* @enum {string}
+*/
+export declare enum ScreeningReasonProviderEnum {
+    TrmWalletScreening = "trm-wallet-screening",
+    ChainalysisAddressScreening = "chainalysis-address-screening",
+    DynamicSanctionsScreening = "dynamic-sanctions-screening"
+} /**
+* @export
+* @enum {string}
+*/
+export declare enum ScreeningReasonMatchedEnum {
+    Floor = "floor",
+    Address = "address",
+    Customer = "customer",
+    Default = "default"
+}
+export declare function ScreeningReasonFromJSON(json: any): ScreeningReason;
+export declare function ScreeningReasonFromJSONTyped(json: any, ignoreDiscriminator: boolean): ScreeningReason;
+export declare function ScreeningReasonToJSON(value?: ScreeningReason | null): any;

package/src/models/ScreeningReason.js

@@ -0,0 +1,63 @@
+import { exists } from '../runtime.js';
+
+/* tslint:disable */
+/**
+* @export
+* @enum {string}
+*/
+var ScreeningReasonProviderEnum;
+(function (ScreeningReasonProviderEnum) {
+    ScreeningReasonProviderEnum["TrmWalletScreening"] = "trm-wallet-screening";
+    ScreeningReasonProviderEnum["ChainalysisAddressScreening"] = "chainalysis-address-screening";
+    ScreeningReasonProviderEnum["DynamicSanctionsScreening"] = "dynamic-sanctions-screening";
+})(ScreeningReasonProviderEnum || (ScreeningReasonProviderEnum = {})); /**
+* @export
+* @enum {string}
+*/
+var ScreeningReasonMatchedEnum;
+(function (ScreeningReasonMatchedEnum) {
+    ScreeningReasonMatchedEnum["Floor"] = "floor";
+    ScreeningReasonMatchedEnum["Address"] = "address";
+    ScreeningReasonMatchedEnum["Customer"] = "customer";
+    ScreeningReasonMatchedEnum["Default"] = "default";
+})(ScreeningReasonMatchedEnum || (ScreeningReasonMatchedEnum = {}));
+function ScreeningReasonFromJSON(json) {
+    return ScreeningReasonFromJSONTyped(json);
+}
+function ScreeningReasonFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'provider': json['provider'],
+        'matched': json['matched'],
+        'revision': !exists(json, 'revision') ? undefined : json['revision'],
+        'rule': !exists(json, 'rule') ? undefined : json['rule'],
+        'category': !exists(json, 'category') ? undefined : json['category'],
+        'riskType': !exists(json, 'riskType') ? undefined : json['riskType'],
+        'score': !exists(json, 'score') ? undefined : json['score'],
+        'risk': !exists(json, 'risk') ? undefined : json['risk'],
+        'summary': !exists(json, 'summary') ? undefined : json['summary'],
+    };
+}
+function ScreeningReasonToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'provider': value.provider,
+        'matched': value.matched,
+        'revision': value.revision,
+        'rule': value.rule,
+        'category': value.category,
+        'riskType': value.riskType,
+        'score': value.score,
+        'risk': value.risk,
+        'summary': value.summary,
+    };
+}
+
+export { ScreeningReasonFromJSON, ScreeningReasonFromJSONTyped, ScreeningReasonMatchedEnum, ScreeningReasonProviderEnum, ScreeningReasonToJSON };

package/src/models/ScreeningTransactionContext.cjs

@@ -0,0 +1,35 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var runtime = require('../runtime.cjs');
+
+/* tslint:disable */
+function ScreeningTransactionContextFromJSON(json) {
+    return ScreeningTransactionContextFromJSONTyped(json);
+}
+function ScreeningTransactionContextFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'amountUsd': !runtime.exists(json, 'amountUsd') ? undefined : json['amountUsd'],
+        'asset': !runtime.exists(json, 'asset') ? undefined : json['asset'],
+    };
+}
+function ScreeningTransactionContextToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'amountUsd': value.amountUsd,
+        'asset': value.asset,
+    };
+}
+
+exports.ScreeningTransactionContextFromJSON = ScreeningTransactionContextFromJSON;
+exports.ScreeningTransactionContextFromJSONTyped = ScreeningTransactionContextFromJSONTyped;
+exports.ScreeningTransactionContextToJSON = ScreeningTransactionContextToJSON;

package/src/models/ScreeningTransactionContext.d.ts

@@ -0,0 +1,37 @@
+/**
+ * Dashboard API
+ * Dashboard API documentation
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * The transaction the screen was performed for. Every property is optional
+ * and the whole object is omitted when nothing is known, which is the case
+ * on sign-in, connect, prefetch and the signing path.
+ * @export
+ * @interface ScreeningTransactionContext
+ */
+export interface ScreeningTransactionContext {
+    /**
+     * Present only where the value is genuinely established as USD. Omitted
+     * otherwise rather than converted, so an amount condition sits out
+     * instead of firing against the wrong currency.
+     * @type {number}
+     * @memberof ScreeningTransactionContext
+     */
+    amountUsd?: number;
+    /**
+     *
+     * @type {string}
+     * @memberof ScreeningTransactionContext
+     */
+    asset?: string;
+}
+export declare function ScreeningTransactionContextFromJSON(json: any): ScreeningTransactionContext;
+export declare function ScreeningTransactionContextFromJSONTyped(json: any, ignoreDiscriminator: boolean): ScreeningTransactionContext;
+export declare function ScreeningTransactionContextToJSON(value?: ScreeningTransactionContext | null): any;

package/src/models/ScreeningTransactionContext.js

@@ -0,0 +1,29 @@
+import { exists } from '../runtime.js';
+
+/* tslint:disable */
+function ScreeningTransactionContextFromJSON(json) {
+    return ScreeningTransactionContextFromJSONTyped(json);
+}
+function ScreeningTransactionContextFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'amountUsd': !exists(json, 'amountUsd') ? undefined : json['amountUsd'],
+        'asset': !exists(json, 'asset') ? undefined : json['asset'],
+    };
+}
+function ScreeningTransactionContextToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'amountUsd': value.amountUsd,
+        'asset': value.asset,
+    };
+}
+
+export { ScreeningTransactionContextFromJSON, ScreeningTransactionContextFromJSONTyped, ScreeningTransactionContextToJSON };

package/src/models/WalletAddressScreeningAlertedEventPayload.cjs

@@ -0,0 +1,96 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var runtime = require('../runtime.cjs');
+var ScreeningReason = require('./ScreeningReason.cjs');
+var ScreeningTransactionContext = require('./ScreeningTransactionContext.cjs');
+
+/* tslint:disable */
+/**
+* @export
+* @enum {string}
+*/
+exports.WalletAddressScreeningAlertedEventPayloadSanctionsProviderEnum = void 0;
+(function (WalletAddressScreeningAlertedEventPayloadSanctionsProviderEnum) {
+    WalletAddressScreeningAlertedEventPayloadSanctionsProviderEnum["TrmWalletScreening"] = "trm-wallet-screening";
+    WalletAddressScreeningAlertedEventPayloadSanctionsProviderEnum["ChainalysisAddressScreening"] = "chainalysis-address-screening";
+    WalletAddressScreeningAlertedEventPayloadSanctionsProviderEnum["DynamicSanctionsScreening"] = "dynamic-sanctions-screening";
+})(exports.WalletAddressScreeningAlertedEventPayloadSanctionsProviderEnum || (exports.WalletAddressScreeningAlertedEventPayloadSanctionsProviderEnum = {})); /**
+* @export
+* @enum {string}
+*/
+exports.WalletAddressScreeningAlertedEventPayloadOriginEnum = void 0;
+(function (WalletAddressScreeningAlertedEventPayloadOriginEnum) {
+    WalletAddressScreeningAlertedEventPayloadOriginEnum["SignIn"] = "signIn";
+    WalletAddressScreeningAlertedEventPayloadOriginEnum["WalletConnect"] = "walletConnect";
+    WalletAddressScreeningAlertedEventPayloadOriginEnum["CheckoutDestination"] = "checkoutDestination";
+    WalletAddressScreeningAlertedEventPayloadOriginEnum["CheckoutSource"] = "checkoutSource";
+    WalletAddressScreeningAlertedEventPayloadOriginEnum["FlowDestination"] = "flowDestination";
+    WalletAddressScreeningAlertedEventPayloadOriginEnum["FlowSource"] = "flowSource";
+    WalletAddressScreeningAlertedEventPayloadOriginEnum["Api"] = "api";
+    WalletAddressScreeningAlertedEventPayloadOriginEnum["BackgroundPrefetch"] = "backgroundPrefetch";
+    WalletAddressScreeningAlertedEventPayloadOriginEnum["TransactionSigning"] = "transactionSigning";
+    WalletAddressScreeningAlertedEventPayloadOriginEnum["TransactionScreenApi"] = "transactionScreenApi";
+})(exports.WalletAddressScreeningAlertedEventPayloadOriginEnum || (exports.WalletAddressScreeningAlertedEventPayloadOriginEnum = {})); /**
+* @export
+* @enum {string}
+*/
+exports.WalletAddressScreeningAlertedEventPayloadKeyOwnerEnum = void 0;
+(function (WalletAddressScreeningAlertedEventPayloadKeyOwnerEnum) {
+    WalletAddressScreeningAlertedEventPayloadKeyOwnerEnum["Dynamic"] = "dynamic";
+    WalletAddressScreeningAlertedEventPayloadKeyOwnerEnum["CustomerProvided"] = "customerProvided";
+})(exports.WalletAddressScreeningAlertedEventPayloadKeyOwnerEnum || (exports.WalletAddressScreeningAlertedEventPayloadKeyOwnerEnum = {})); /**
+* @export
+* @enum {string}
+*/
+exports.WalletAddressScreeningAlertedEventPayloadActionEnum = void 0;
+(function (WalletAddressScreeningAlertedEventPayloadActionEnum) {
+    WalletAddressScreeningAlertedEventPayloadActionEnum["Alerted"] = "alerted";
+})(exports.WalletAddressScreeningAlertedEventPayloadActionEnum || (exports.WalletAddressScreeningAlertedEventPayloadActionEnum = {}));
+function WalletAddressScreeningAlertedEventPayloadFromJSON(json) {
+    return WalletAddressScreeningAlertedEventPayloadFromJSONTyped(json);
+}
+function WalletAddressScreeningAlertedEventPayloadFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'walletAddress': json['walletAddress'],
+        'chain': !runtime.exists(json, 'chain') ? undefined : json['chain'],
+        'sanctionsProvider': json['sanctionsProvider'],
+        'sanctionCheckRequestId': json['sanctionCheckRequestId'],
+        'categories': json['categories'],
+        'origin': json['origin'],
+        'keyOwner': json['keyOwner'],
+        'screenedAt': (new Date(json['screenedAt'])),
+        'action': json['action'],
+        'reason': ScreeningReason.ScreeningReasonFromJSON(json['reason']),
+        'txContext': !runtime.exists(json, 'txContext') ? undefined : ScreeningTransactionContext.ScreeningTransactionContextFromJSON(json['txContext']),
+    };
+}
+function WalletAddressScreeningAlertedEventPayloadToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'walletAddress': value.walletAddress,
+        'chain': value.chain,
+        'sanctionsProvider': value.sanctionsProvider,
+        'sanctionCheckRequestId': value.sanctionCheckRequestId,
+        'categories': value.categories,
+        'origin': value.origin,
+        'keyOwner': value.keyOwner,
+        'screenedAt': (value.screenedAt.toISOString()),
+        'action': value.action,
+        'reason': ScreeningReason.ScreeningReasonToJSON(value.reason),
+        'txContext': ScreeningTransactionContext.ScreeningTransactionContextToJSON(value.txContext),
+    };
+}
+
+exports.WalletAddressScreeningAlertedEventPayloadFromJSON = WalletAddressScreeningAlertedEventPayloadFromJSON;
+exports.WalletAddressScreeningAlertedEventPayloadFromJSONTyped = WalletAddressScreeningAlertedEventPayloadFromJSONTyped;
+exports.WalletAddressScreeningAlertedEventPayloadToJSON = WalletAddressScreeningAlertedEventPayloadToJSON;