@dfns/sdk 0.1.0-alpha.1

package/codegen/datamodel/ApiKeys/types.d.ts

@@ -0,0 +1,32 @@
+import { EntityId, IsoDatetime } from '../Foundations';
+export type ApiKeyRecord = {
+    id: EntityId;
+    status: ApiKeyStatus;
+    externalId?: string;
+    orgId: EntityId;
+    dateCreated: IsoDatetime;
+    name?: string;
+    authorId: EntityId;
+    scopes: string[];
+};
+export type ApiKeyRecordWithToken = {
+    id: EntityId;
+    status: ApiKeyStatus;
+    externalId?: string;
+    orgId: EntityId;
+    dateCreated: IsoDatetime;
+    name?: string;
+    authorId: EntityId;
+    scopes: string[];
+    token: ApiKeyValue;
+};
+export type ApiKeyValue = string;
+export type CreateApiKeyInput = {
+    scopes: string[];
+    externalId?: string;
+    name: string;
+};
+export declare enum ApiKeyStatus {
+    Active = "Active",
+    Archived = "Archived"
+}

package/codegen/datamodel/ApiKeys/types.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ApiKeyStatus = void 0;
+// FIXME: Missing documentation for ApiKeyStatus
+var ApiKeyStatus;
+(function (ApiKeyStatus) {
+    // FIXME: Missing documentation for Active
+    ApiKeyStatus["Active"] = "Active";
+    // FIXME: Missing documentation for Archived
+    ApiKeyStatus["Archived"] = "Archived";
+})(ApiKeyStatus = exports.ApiKeyStatus || (exports.ApiKeyStatus = {}));

package/codegen/datamodel/Assets/errors.d.ts

@@ -0,0 +1,11 @@
+import { DfnsError } from '../Foundations';
+export declare class InsufficientFunds extends DfnsError {
+    name: string;
+    serviceName: string;
+    message: string;
+    causes?: string[];
+    shouldTriggerInvestigaton: boolean;
+    isDfnsError: boolean;
+    httpStatus: number;
+    errorName: string;
+}

package/codegen/datamodel/Assets/errors.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.InsufficientFunds = void 0;
+const Foundations_1 = require("../Foundations");
+class InsufficientFunds extends Foundations_1.DfnsError {
+    constructor() {
+        super(...arguments);
+        this.name = 'InsufficientFunds';
+        // FIXME: Missing documentation for isDfnsError
+        this.isDfnsError = true;
+        // FIXME: Missing documentation for httpStatus
+        this.httpStatus = 422;
+        // FIXME: Missing documentation for errorName
+        this.errorName = 'Insufficient funds in asset account';
+    }
+}
+exports.InsufficientFunds = InsufficientFunds;

package/codegen/datamodel/Assets/index.d.ts

@@ -0,0 +1,3 @@
+export * from './errors';
+export * from './responses';
+export * from './types';

package/codegen/datamodel/Assets/index.js

@@ -0,0 +1,19 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./errors"), exports);
+__exportStar(require("./responses"), exports);
+__exportStar(require("./types"), exports);

package/codegen/datamodel/Assets/responses.d.ts

@@ -0,0 +1,45 @@
+import { BadRequestError, EntityNotFoundError, ForbiddenError, PaymentRequiredError, UnauthorizedError } from '../Foundations';
+import { InsufficientFunds } from './errors';
+import { AssetAccount, AssetAccountBalance, Payment } from './types';
+export type InitiatePaymentSuccess = Payment;
+export type InitiatePaymentError = {
+    error: BadRequestError | PaymentRequiredError | InsufficientFunds | UnauthorizedError | ForbiddenError | BadRequestError | EntityNotFoundError;
+};
+export type InitiatePaymentResponse = InitiatePaymentSuccess | InitiatePaymentError;
+export type GetPaymentByIdSuccess = Payment;
+export type GetPaymentByIdError = {
+    error: EntityNotFoundError | UnauthorizedError | ForbiddenError | BadRequestError | EntityNotFoundError;
+};
+export type GetPaymentByIdResponse = GetPaymentByIdSuccess | GetPaymentByIdError;
+export type ListPaymentsSuccess = Payment;
+export type ListPaymentsError = {
+    error: EntityNotFoundError | UnauthorizedError | ForbiddenError | BadRequestError | EntityNotFoundError;
+};
+export type ListPaymentsResponse = ListPaymentsSuccess | ListPaymentsError;
+export type CreateAssetAccountSuccess = AssetAccount;
+export type CreateAssetAccountError = {
+    error: EntityNotFoundError | BadRequestError | PaymentRequiredError | UnauthorizedError | ForbiddenError | BadRequestError | EntityNotFoundError;
+};
+export type CreateAssetAccountResponse = CreateAssetAccountSuccess | CreateAssetAccountError;
+export type GetAssetAccountByIdSuccess = AssetAccount;
+export type GetAssetAccountByIdError = {
+    error: UnauthorizedError | ForbiddenError | BadRequestError | EntityNotFoundError;
+};
+export type GetAssetAccountByIdResponse = GetAssetAccountByIdSuccess | GetAssetAccountByIdError;
+export type ListAssetAccountsSuccess = {
+    items: AssetAccount[];
+};
+export type ListAssetAccountsError = {
+    error: UnauthorizedError | ForbiddenError | BadRequestError | EntityNotFoundError;
+};
+export type ListAssetAccountsResponse = ListAssetAccountsSuccess | ListAssetAccountsError;
+export type ArchiveAssetAccountSuccess = AssetAccount;
+export type ArchiveAssetAccountError = {
+    error: EntityNotFoundError | UnauthorizedError | ForbiddenError | BadRequestError | EntityNotFoundError;
+};
+export type ArchiveAssetAccountResponse = ArchiveAssetAccountSuccess | ArchiveAssetAccountError;
+export type GetAssetAccountBalanceByIdSuccess = AssetAccountBalance;
+export type GetAssetAccountBalanceByIdError = {
+    error: UnauthorizedError | ForbiddenError | BadRequestError | EntityNotFoundError;
+};
+export type GetAssetAccountBalanceByIdResponse = GetAssetAccountBalanceByIdSuccess | GetAssetAccountBalanceByIdError;

package/codegen/datamodel/Assets/responses.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/codegen/datamodel/Assets/types.d.ts

@@ -0,0 +1,225 @@
+import { Amount, AssetSymbol, DfnsCertificate, EntityId, Initiator, IntegerPositiveStrict, IsoDatetime, PublicKey, Tag } from '../Foundations';
+export type PaymentInitiation = {
+    id: EntityId;
+    paymentId: EntityId;
+    externalId?: EntityId;
+    status: PaymentInitiationStatus;
+    orgId?: EntityId;
+    initiator: Initiator;
+    assetSymbol: AssetSymbol;
+    amount: Amount;
+    sender: DfnsAssetAccount;
+    receiver: PaymentInstrument;
+    dateInitiated: IsoDatetime;
+    /**
+     * In case payment initiation is rejected by the system, this field will contain information about it.
+     *
+     */
+    rejectionReason?: string;
+};
+export type BlockchainWalletAddress = {
+    kind: PaymentInstrumentKind.BlockchainWalletAddress;
+    address: string;
+};
+export type DfnsAssetAccount = {
+    kind: PaymentInstrumentKind.DfnsAssetAccount;
+    id: EntityId;
+};
+export type AssetAccount = {
+    /**
+     * Multiple tags can be attached to an entity to categorise or otherwise mark it. For example tags could indicate risk (High, Medium, Low), departments (Trading, Sales, IT), purpose (Treasury, Hot, Deposits), and jurisdictions (US, EU, DE).
+     *
+     * Multiple tags can be attached to same entity.
+     */
+    tags?: Tag[];
+    /**
+     * Field can be used if entity is created in external (customer’s) system first. This way the external id can be attached to identify entity from Dfns’s data store.
+     */
+    externalId?: string;
+    /**
+     * Indicates id of the Organisation, such as usually a customer, or sub-devision, sub-tenant, and others.
+     */
+    orgId: EntityId;
+    id: EntityId;
+    /**
+     * Indicates whether account is ready to be used.
+     */
+    status: AssetAccountStatus;
+    /**
+     * Blockchain address for a chosen Blockchain network.
+     */
+    address?: string;
+    /**
+     * `PublicKey` which is used by `AssetAccount`. Usually this is used to derive addresses on a given blockchain network.
+     *
+     * Alternatively can be used to verify signatures produced by the platform.
+     */
+    publicKey?: string;
+    publicKeyId?: EntityId;
+    /**
+     * # [ENUM]
+     *
+     * Asset symbol indicating which asset this account is managing. BTC or ETH are obvious examples, but there are thousands of possible symbols. In case of coins (ERC20 and alike) use `COIN.BLOCKCHAIN` syntax, such as USDC.ETH or USDC.SOL to indicate that USDC on Ethereum or USDC on Solana is required. To get a list of all allowed values, send a `CreateAssetAccount` request with the `assetSymbol` field empty.
+     */
+    assetSymbol: AssetSymbol;
+    /**
+     * Custom name that can be added for an account.
+     */
+    name: string;
+    dateCreated: IsoDatetime;
+    dateUpdate: IsoDatetime;
+    authorizations?: AssetAccountAuthorization[];
+};
+export type Payment = {
+    /**
+     * Multiple tags can be attached to an entity to categorise or otherwise mark it. For example tags could indicate risk (High, Medium, Low), departments (Trading, Sales, IT), purpose (Treasury, Hot, Deposits), and jurisdictions (US, EU, DE).
+     *
+     * Multiple tags can be attached to same entity.
+     */
+    tags?: Tag[];
+    /**
+     * Field can be used if entity is created in external (customer’s) system first. This way the external id can be attached to identify entity from Dfns’s data store.
+     */
+    externalId?: string;
+    /**
+     * Indicates id of the Organisation, such as usually a customer, or sub-devision, sub-tenant, and others.
+     */
+    orgId: EntityId;
+    id: EntityId;
+    status: PaymentStatus;
+    initiator: Initiator;
+    assetAccountId: EntityId;
+    assetSymbol: AssetSymbol;
+    amount: Amount;
+    sender: PaymentInstrument;
+    receiver: PaymentInstrument;
+    /**
+     * SWIFT (MT, ISO15022) field. Represents additional information about payment.
+     *
+     */
+    narrative?: string;
+    note?: string;
+    receiverAddress: string;
+    policyCertificate?: DfnsCertificate;
+    dateCreated: IsoDatetime;
+    dateUpdated: IsoDatetime;
+    dateExecuted?: IsoDatetime;
+    dateBroadcasted?: IsoDatetime;
+    dateFirstConfirmed?: IsoDatetime;
+    dateConfirmed?: IsoDatetime;
+    dateSettled?: IsoDatetime;
+    txHash?: string;
+    blockHeight?: number;
+    direction: PaymentDirection;
+    fee?: Amount;
+};
+export type AssetAccountAuthorization = {
+    kind: AssetAccountAuthorizationKind;
+    entityId: EntityId;
+    permission: AssetAccountPermissions;
+};
+/**
+ * Balance of one asset account.
+ */
+export type AssetAccountBalance = {
+    /**
+     * Id of the AssetAccount.
+     */
+    id: EntityId;
+    /**
+     * Asset Symbol of the account.
+     */
+    assetSymbol: AssetSymbol;
+    /**
+     * Balance of the account.
+     */
+    balance: Amount;
+    maxUnitBalance: Amount;
+};
+export type UpdateAssetAccountPayload = {
+    /**
+     * Indicates whether account is ready to be used.
+     */
+    status: AssetAccountStatus;
+    /**
+     * Blockchain address for a chosen Blockchain network.
+     */
+    address?: string;
+    /**
+     * `PublicKey` which is used by `AssetAccount`. Usually this is used to derive addresses on a given blockchain network.
+     *
+     * Alternatively can be used to verify signatures produced by the platform.
+     */
+    publicKey?: string;
+    /**
+     * Custom name that can be added for an account.
+     */
+    name?: string;
+};
+export type CreateAssetAccountInput = {
+    /**
+     * # [ENUM]
+     *
+     * Asset symbol indicating which asset this account is managing. BTC or ETH are obvious examples, but there are thousands of possible symbols. In case of coins (ERC20 and alike) use `COIN.BLOCKCHAIN` syntax, such as USDC.ETH or USDC.SOL to indicate that USDC on Ethereum or USDC on Solana is required. To get a list of all allowed values, send a `CreateAssetAccount` request with the `assetSymbol` field empty.
+     */
+    assetSymbol: AssetSymbol;
+    groupSize?: IntegerPositiveStrict;
+    groupThreshold?: IntegerPositiveStrict;
+    /**
+     * `PublicKey` which is used by `AssetAccount`. Usually this is used to derive addresses on a given blockchain network.
+     *
+     * Alternatively can be used to verify signatures produced by the platform.
+     */
+    publicKey?: PublicKey;
+    externalId?: string;
+    tags?: Tag[];
+    /**
+     * Custom name that can be added for an account.
+     */
+    name?: string;
+};
+export type CreatePaymentInput = {
+    externalId?: string;
+    assetSymbol: AssetSymbol;
+    amount: Amount;
+    receiver: PaymentInstrument;
+    note?: string;
+    narrative?: string;
+};
+export type PaymentInstrument = BlockchainWalletAddress | DfnsAssetAccount;
+export declare enum PaymentInstrumentKind {
+    DfnsAssetAccount = "DfnsAssetAccount",
+    BlockchainWalletAddress = "BlockchainWalletAddress"
+}
+export declare enum PaymentInitiationStatus {
+    Initiated = "Initiated",
+    Canceled = "Canceled",
+    Rejected = "Rejected"
+}
+export declare enum AssetAccountStatus {
+    Creating = "Creating",
+    Enabled = "Enabled",
+    Failed = "Failed"
+}
+export declare enum PaymentStatus {
+    Initiated = "Initiated",
+    Rejected = "Rejected",
+    Approved = "Approved",
+    Executed = "Executed",
+    Failed = "Failed",
+    Confirmed = "Confirmed"
+}
+export declare enum AssetAccountAuthorizationKind {
+    Employee = "Employee",
+    Group = "Group",
+    ApiKey = "ApiKey"
+}
+export declare enum AssetAccountPermissions {
+    InitiatePayments = "InitiatePayments",
+    ReadBalance = "ReadBalance",
+    ReadPublicKey = "ReadPublicKey"
+}
+export declare enum PaymentDirection {
+    Incoming = "Incoming",
+    Outgoing = "Outgoing"
+}

package/codegen/datamodel/Assets/types.js

@@ -0,0 +1,75 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PaymentDirection = exports.AssetAccountPermissions = exports.AssetAccountAuthorizationKind = exports.PaymentStatus = exports.AssetAccountStatus = exports.PaymentInitiationStatus = exports.PaymentInstrumentKind = void 0;
+// FIXME: Missing documentation for PaymentInstrumentKind
+var PaymentInstrumentKind;
+(function (PaymentInstrumentKind) {
+    // FIXME: Missing documentation for DfnsAssetAccount
+    PaymentInstrumentKind["DfnsAssetAccount"] = "DfnsAssetAccount";
+    // FIXME: Missing documentation for BlockchainWalletAddress
+    PaymentInstrumentKind["BlockchainWalletAddress"] = "BlockchainWalletAddress";
+})(PaymentInstrumentKind = exports.PaymentInstrumentKind || (exports.PaymentInstrumentKind = {}));
+// FIXME: Missing documentation for PaymentInitiationStatus
+var PaymentInitiationStatus;
+(function (PaymentInitiationStatus) {
+    // FIXME: Missing documentation for Initiated
+    PaymentInitiationStatus["Initiated"] = "Initiated";
+    // FIXME: Missing documentation for Canceled
+    PaymentInitiationStatus["Canceled"] = "Canceled";
+    // FIXME: Missing documentation for Rejected
+    PaymentInitiationStatus["Rejected"] = "Rejected";
+})(PaymentInitiationStatus = exports.PaymentInitiationStatus || (exports.PaymentInitiationStatus = {}));
+// FIXME: Missing documentation for AssetAccountStatus
+var AssetAccountStatus;
+(function (AssetAccountStatus) {
+    //Initial state of `AssetAccount` entity, indicating that it’s being created at the moment.
+    AssetAccountStatus["Creating"] = "Creating";
+    // FIXME: Missing documentation for Enabled
+    AssetAccountStatus["Enabled"] = "Enabled";
+    // FIXME: Missing documentation for Failed
+    AssetAccountStatus["Failed"] = "Failed";
+})(AssetAccountStatus = exports.AssetAccountStatus || (exports.AssetAccountStatus = {}));
+// FIXME: Missing documentation for PaymentStatus
+var PaymentStatus;
+(function (PaymentStatus) {
+    //Payment order is received and initiated. It will execute later.
+    PaymentStatus["Initiated"] = "Initiated";
+    //Some Policy blocked the payment, it is not approved.
+    PaymentStatus["Rejected"] = "Rejected";
+    //Payment passed Policies, it is approved.
+    PaymentStatus["Approved"] = "Approved";
+    //Payment is successfully Executed and Broadcasted on the blockchain.
+    PaymentStatus["Executed"] = "Executed";
+    //Payment tried to execute, but failed doing so.
+    PaymentStatus["Failed"] = "Failed";
+    //Payment transaction is confirmed on the blockchain.
+    PaymentStatus["Confirmed"] = "Confirmed";
+})(PaymentStatus = exports.PaymentStatus || (exports.PaymentStatus = {}));
+// FIXME: Missing documentation for AssetAccountAuthorizationKind
+var AssetAccountAuthorizationKind;
+(function (AssetAccountAuthorizationKind) {
+    // FIXME: Missing documentation for Employee
+    AssetAccountAuthorizationKind["Employee"] = "Employee";
+    // FIXME: Missing documentation for Group
+    AssetAccountAuthorizationKind["Group"] = "Group";
+    // FIXME: Missing documentation for ApiKey
+    AssetAccountAuthorizationKind["ApiKey"] = "ApiKey";
+})(AssetAccountAuthorizationKind = exports.AssetAccountAuthorizationKind || (exports.AssetAccountAuthorizationKind = {}));
+// FIXME: Missing documentation for AssetAccountPermissions
+var AssetAccountPermissions;
+(function (AssetAccountPermissions) {
+    // FIXME: Missing documentation for InitiatePayments
+    AssetAccountPermissions["InitiatePayments"] = "InitiatePayments";
+    // FIXME: Missing documentation for ReadBalance
+    AssetAccountPermissions["ReadBalance"] = "ReadBalance";
+    // FIXME: Missing documentation for ReadPublicKey
+    AssetAccountPermissions["ReadPublicKey"] = "ReadPublicKey";
+})(AssetAccountPermissions = exports.AssetAccountPermissions || (exports.AssetAccountPermissions = {}));
+// FIXME: Missing documentation for PaymentDirection
+var PaymentDirection;
+(function (PaymentDirection) {
+    // FIXME: Missing documentation for Incoming
+    PaymentDirection["Incoming"] = "Incoming";
+    // FIXME: Missing documentation for Outgoing
+    PaymentDirection["Outgoing"] = "Outgoing";
+})(PaymentDirection = exports.PaymentDirection || (exports.PaymentDirection = {}));

package/codegen/datamodel/Auth/index.d.ts

@@ -0,0 +1,2 @@
+export * from './responses';
+export * from './types';

package/codegen/datamodel/Auth/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./responses"), exports);
+__exportStar(require("./types"), exports);