@dfns/sdk 0.3.0 → 0.3.2

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

@@ -1,270 +0,0 @@
-import { Amount, BlockchainAddress, IntegerPositiveStrict, IsoDatetime } from '../Foundations';
-export type BtcBlock = {
-    hash: string;
-    number: number;
-    timestamp: IsoDatetime;
-    transactions: BtcTransaction[];
-};
-export type BtcTransaction = {
-    hash: string;
-    blockNumber: number;
-    size: number;
-    weight: number;
-    locktime: number;
-    vins: BtcTransactionInput[];
-    vouts: BtcTransactionOutput[];
-    coinbase: boolean;
-    fee?: Amount;
-};
-export type BtcTransactionInput = {
-    hash: string;
-    index: number;
-    address?: BlockchainAddress;
-    value?: Amount;
-};
-export type BtcTransactionOutput = {
-    index: number;
-    address?: BlockchainAddress;
-    value: Amount;
-};
-export type EvmBlock = {
-    hash: string;
-    number: number;
-    timestamp: IsoDatetime;
-    transactions: EvmTransaction[];
-};
-export type EvmTransaction = {
-    hash: string;
-    blockNumber: number;
-    nonce: number;
-    from: BlockchainAddress;
-    to?: BlockchainAddress;
-    value: Amount;
-    data?: string;
-    signature: string;
-    gasLimit: Amount;
-    gasPrice?: Amount;
-    maxFeePerGas?: Amount;
-    maxPriorityFeePerGas?: Amount;
-    receipt?: EvmTransactionReceipt;
-    logs?: EvmLog[];
-};
-export type EvmTransactionReceipt = {
-    gasUsed: Amount;
-    effectiveGasPrice: Amount;
-    fee: Amount;
-    status: TransactionStatus;
-    error?: string;
-};
-export type Erc20Log = {
-    kind: EvmLogKind.Erc20;
-    index: number;
-    address: BlockchainAddress;
-    from: BlockchainAddress;
-    to: BlockchainAddress;
-    value: Amount;
-};
-export type Erc721Log = {
-    kind: EvmLogKind.Erc721;
-    index: number;
-    address: BlockchainAddress;
-    from: BlockchainAddress;
-    to: BlockchainAddress;
-    tokenId: string;
-};
-export type EvmUntypedLog = {
-    kind: EvmLogKind.Unknown;
-    index: number;
-    address: BlockchainAddress;
-    topics: string[];
-    data: string;
-};
-export type EvmFeeEstimates = {
-    safeLow: Eip1559Fee;
-    standard: Eip1559Fee;
-    fast: Eip1559Fee;
-    estimatedBaseFee: string;
-    blockNumber: IntegerPositiveStrict;
-    kind: FeeEstimationKind;
-};
-export type Eip1559Fee = {
-    maxPriorityFee: string;
-    maxFee: string;
-};
-export type CallViewFunctionInput = {
-    data: string;
-    contract: string;
-};
-export type CallViewFunctionResult = {
-    data: string;
-};
-export type TrxBlock = {
-    hash: string;
-    number: number;
-    timestamp: IsoDatetime;
-    transactions: TrxTransaction[];
-};
-export type TrxTransaction = {
-    hash: string;
-    blockNumber: number;
-    feeLimit?: Amount;
-    from: BlockchainAddress;
-    receipt: TrxReceipt;
-};
-export type TrxTransferTransaction = {
-    hash: string;
-    blockNumber: number;
-    feeLimit?: Amount;
-    from: BlockchainAddress;
-    receipt: TrxReceipt;
-    kind: TrxTransactionKind.TransferContract;
-    to: BlockchainAddress;
-    amount: Amount;
-};
-export type TrxTransferAssetTransaction = {
-    hash: string;
-    blockNumber: number;
-    feeLimit?: Amount;
-    from: BlockchainAddress;
-    receipt: TrxReceipt;
-    kind: TrxTransactionKind.TransferAssetContract;
-    asset: string;
-    to: BlockchainAddress;
-    amount: Amount;
-};
-export type TrxSmartContractTransaction = {
-    hash: string;
-    blockNumber: number;
-    feeLimit?: Amount;
-    from: BlockchainAddress;
-    receipt: TrxReceipt;
-    kind: TrxTransactionKind.TriggerSmartContract;
-    contract: BlockchainAddress;
-    data: string;
-    logs: EvmLog[];
-};
-export type TrxUntypedTransaction = {
-    hash: string;
-    blockNumber: number;
-    feeLimit?: Amount;
-    from: BlockchainAddress;
-    receipt: TrxReceipt;
-    kind: TrxTransactionKind;
-    parameters: Record<string, unknown>;
-};
-export type TrxReceipt = {
-    fee?: Amount;
-    energyFee?: Amount;
-    energyUsage?: Amount;
-    netFee?: Amount;
-    netUsage?: Amount;
-    status: TransactionStatus;
-    error?: string;
-};
-export type XrpBlock = {
-    hash: string;
-    number: number;
-    timestamp: IsoDatetime;
-    transactions: XrpTransaction[];
-};
-export type XrpTransaction = {
-    hash: string;
-    blockNumber: number;
-    account: BlockchainAddress;
-    fee: Amount;
-    status: TransactionStatus;
-    error?: string;
-};
-export type XrpPaymentTransaction = {
-    hash: string;
-    blockNumber: number;
-    account: BlockchainAddress;
-    fee: Amount;
-    status: TransactionStatus;
-    error?: string;
-    kind: XrpTransactionKind.Payment;
-    to: BlockchainAddress;
-    currency?: string;
-    issuer?: BlockchainAddress;
-    amount: Amount;
-};
-export type XrpUntypedTransaction = {
-    hash: string;
-    blockNumber: number;
-    account: BlockchainAddress;
-    fee: Amount;
-    status: TransactionStatus;
-    error?: string;
-    kind: XrpTransactionKind;
-};
-export type SolBlock = {
-    hash: string;
-    number: number;
-    timestamp: IsoDatetime;
-    transactions: SolTransaction[];
-};
-export type SolTransaction = {
-    hash: string;
-    blockNumber: number;
-    version: string;
-    from: BlockchainAddress;
-    instructions: SolInstruction[];
-    fee: Amount;
-    status: TransactionStatus;
-    error?: string;
-};
-export type SolInstruction = {
-    index: string;
-    program: BlockchainAddress;
-};
-export type SolSystemTransferInstruction = {
-    index: string;
-    program: BlockchainAddress;
-    kind: SolInstructionKind.SystemTransfer;
-    from: BlockchainAddress;
-    to: BlockchainAddress;
-    value: Amount;
-};
-export type SolTokenTransferInstruction = {
-    index: string;
-    program: BlockchainAddress;
-    kind: SolInstructionKind.TokenTransfer;
-    mint: BlockchainAddress;
-    from: BlockchainAddress;
-    fromTokenAccount: BlockchainAddress;
-    to: BlockchainAddress;
-    toTokenAccount: BlockchainAddress;
-    value: Amount;
-};
-export type SolUntypedInstruction = {
-    index: string;
-    program: BlockchainAddress;
-    accounts: BlockchainAddress[];
-    data: string;
-};
-export type EvmLog = Erc20Log | Erc721Log | EvmUntypedLog;
-export declare enum EvmLogKind {
-    Unknown = "Unknown",
-    Erc20 = "Erc20",
-    Erc721 = "Erc721"
-}
-export declare enum TransactionStatus {
-    SUCCESS = "SUCCESS",
-    FAILED = "FAILED"
-}
-export declare enum TrxTransactionKind {
-    TransferContract = "TransferContract",
-    TransferAssetContract = "TransferAssetContract",
-    TriggerSmartContract = "TriggerSmartContract"
-}
-export declare enum XrpTransactionKind {
-    Payment = "Payment"
-}
-export declare enum SolInstructionKind {
-    SystemTransfer = "SystemTransfer",
-    TokenTransfer = "TokenTransfer"
-}
-export declare enum FeeEstimationKind {
-    Eip1559 = "Eip1559",
-    EthLegacy = "EthLegacy"
-}

package/codegen/datamodel/Blockchains/types.js

@@ -1,53 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.FeeEstimationKind = exports.SolInstructionKind = exports.XrpTransactionKind = exports.TrxTransactionKind = exports.TransactionStatus = exports.EvmLogKind = void 0;
-// FIXME: Missing documentation for EvmLogKind
-var EvmLogKind;
-(function (EvmLogKind) {
-    // FIXME: Missing documentation for Unknown
-    EvmLogKind["Unknown"] = "Unknown";
-    // FIXME: Missing documentation for Erc20
-    EvmLogKind["Erc20"] = "Erc20";
-    // FIXME: Missing documentation for Erc721
-    EvmLogKind["Erc721"] = "Erc721";
-})(EvmLogKind || (exports.EvmLogKind = EvmLogKind = {}));
-// FIXME: Missing documentation for TransactionStatus
-var TransactionStatus;
-(function (TransactionStatus) {
-    // FIXME: Missing documentation for SUCCESS
-    TransactionStatus["SUCCESS"] = "SUCCESS";
-    // FIXME: Missing documentation for FAILED
-    TransactionStatus["FAILED"] = "FAILED";
-})(TransactionStatus || (exports.TransactionStatus = TransactionStatus = {}));
-// FIXME: Missing documentation for TrxTransactionKind
-var TrxTransactionKind;
-(function (TrxTransactionKind) {
-    // FIXME: Missing documentation for TransferContract
-    TrxTransactionKind["TransferContract"] = "TransferContract";
-    // FIXME: Missing documentation for TransferAssetContract
-    TrxTransactionKind["TransferAssetContract"] = "TransferAssetContract";
-    // FIXME: Missing documentation for TriggerSmartContract
-    TrxTransactionKind["TriggerSmartContract"] = "TriggerSmartContract";
-})(TrxTransactionKind || (exports.TrxTransactionKind = TrxTransactionKind = {}));
-// FIXME: Missing documentation for XrpTransactionKind
-var XrpTransactionKind;
-(function (XrpTransactionKind) {
-    // FIXME: Missing documentation for Payment
-    XrpTransactionKind["Payment"] = "Payment";
-})(XrpTransactionKind || (exports.XrpTransactionKind = XrpTransactionKind = {}));
-// FIXME: Missing documentation for SolInstructionKind
-var SolInstructionKind;
-(function (SolInstructionKind) {
-    // FIXME: Missing documentation for SystemTransfer
-    SolInstructionKind["SystemTransfer"] = "SystemTransfer";
-    // FIXME: Missing documentation for TokenTransfer
-    SolInstructionKind["TokenTransfer"] = "TokenTransfer";
-})(SolInstructionKind || (exports.SolInstructionKind = SolInstructionKind = {}));
-// FIXME: Missing documentation for FeeEstimationKind
-var FeeEstimationKind;
-(function (FeeEstimationKind) {
-    // FIXME: Missing documentation for Eip1559
-    FeeEstimationKind["Eip1559"] = "Eip1559";
-    // FIXME: Missing documentation for EthLegacy
-    FeeEstimationKind["EthLegacy"] = "EthLegacy";
-})(FeeEstimationKind || (exports.FeeEstimationKind = FeeEstimationKind = {}));

package/codegen/datamodel/Orgs/errors.js

@@ -1 +0,0 @@
-"use strict";

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

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

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

@@ -1,45 +0,0 @@
-import { BadRequestError, EntityNotFoundError, ForbiddenError, UnauthorizedError } from '../Foundations';
-import { Org, OrgEmployee } from './types';
-export type GetEmployeeByIdSuccess = OrgEmployee;
-export type GetEmployeeByIdError = {
-    error: EntityNotFoundError | ForbiddenError | UnauthorizedError | ForbiddenError | BadRequestError | EntityNotFoundError;
-};
-export type GetEmployeeByIdResponse = GetEmployeeByIdSuccess | GetEmployeeByIdError;
-export type ListEmployeesSuccess = {
-    items: OrgEmployee[];
-};
-export type ListEmployeesError = {
-    error: ForbiddenError | UnauthorizedError | ForbiddenError | BadRequestError | EntityNotFoundError;
-};
-export type ListEmployeesResponse = ListEmployeesSuccess | ListEmployeesError;
-export type CreateOrgSuccess = Org;
-export type CreateOrgError = {
-    error: ForbiddenError | BadRequestError | EntityNotFoundError;
-};
-export type CreateOrgResponse = CreateOrgSuccess | CreateOrgError;
-export type ListOrgsSuccess = {
-    items: Org[];
-};
-export type ListOrgsError = {
-    error: ForbiddenError | BadRequestError | EntityNotFoundError;
-};
-export type ListOrgsResponse = ListOrgsSuccess | ListOrgsError;
-export type ListPackageVersionsSuccess = {
-    items: Org[];
-};
-export type ListPackageVersionsError = {
-    error: ForbiddenError | BadRequestError | EntityNotFoundError;
-};
-export type ListPackageVersionsResponse = ListPackageVersionsSuccess | ListPackageVersionsError;
-export type CreateOrgSettingSuccess = Org;
-export type CreateOrgSettingError = {
-    error: ForbiddenError | BadRequestError | EntityNotFoundError;
-};
-export type CreateOrgSettingResponse = CreateOrgSettingSuccess | CreateOrgSettingError;
-export type ListOrgSettingsSuccess = {
-    items: Org[];
-};
-export type ListOrgSettingsError = {
-    error: ForbiddenError | BadRequestError | EntityNotFoundError;
-};
-export type ListOrgSettingsResponse = ListOrgSettingsSuccess | ListOrgSettingsError;

package/codegen/datamodel/Orgs/responses.js

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

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

@@ -1,240 +0,0 @@
-import { Countries, Email, EntityId, IdentityIssuer, IsoDate, IsoDatetime } from '../Foundations';
-/**
- * `Org` encapsulates information about a Dfns’s customer .
- */
-export type Org = {
-    /**
-     * Unique organisation identifier.
-     */
-    id: EntityId;
-    /**
-     * Full legal name of the organisation, including suffixes such as LLC, Limited, etc.
-     */
-    legalName: string;
-    /**
-     * Trading name by which company is known. For example "Panasonic" instead of "Panasonic Holdings Corporation".
-     */
-    tradingName?: string;
-    /**
-     * Country where organisation is head quartered, and default jurisdiction if applies.
-     */
-    country: Countries;
-    /**
-     * Date when organisation was incorporated.
-     */
-    dateOfIncorporation: IsoDate;
-    /**
-     * Date when organisation was onboarded in Dfns.
-     */
-    dateOnboarded: IsoDatetime;
-    /**
-     * Status of the organisation. Indicates whether organisation is currently operational. See `OrgStatus` for details.
-     */
-    status: OrgStatus;
-    /**
-     * List of employee users that are onboarded within organisation
-     */
-    employees: OrgEmployee[];
-    /**
-     * List of groups available within organisation, to which users (i.e. employees) can belong to.
-     */
-    groups?: EmployeeGroup[];
-};
-/**
- * `OrgEmployee` is a type of `User` that has access to Dfns API. `OrgEmployee` always maps to a given Natural Person (i.e. human). There are other users such as service accounts, that can be mapped to servers and other technical entities.
- */
-export type OrgEmployee = {
-    /**
-     * Unique employee identifier.
-     */
-    id: EntityId;
-    /**
-     * Status of the employee. Identifies if given user can perform any actions or not. See `OrgEmployeeStatus` for more details.
-     */
-    status: OrgEmployeeStatus;
-    /**
-     * Indicates organisation to which employee belongs to.
-     */
-    orgId: string;
-    /**
-     * Employee's username. Usually it is an email.
-     */
-    username: string;
-    /**
-     * Employee email.
-     */
-    email: Email;
-    /**
-     * Identity issuer (eg Auth0). Empty if it's the default one (Dfns one). The issuer will be filled for non-Dfns issuers.
-     */
-    issuer: IdentityIssuer;
-    /**
-     * Date when employee was created.
-     */
-    dateCreated: IsoDatetime;
-    /**
-     * Date when employee record was last updated.
-     */
-    dateUpdated: IsoDatetime;
-    /**
-     * Employee's full legal name.
-     */
-    fullName: string;
-    /**
-     * Employee's date of birth.
-     */
-    dateOfBirth?: IsoDate;
-    /**
-     * List of groups to which employee belongs to.
-     */
-    groups?: EmployeeGroup[];
-};
-/**
- * Used to group `OrgEmployees` by various criteria. Such as jurisdiction, department, access rights.
- */
-export type EmployeeGroup = {
-    /**
-     * Name of the `Group`
-     */
-    name: string;
-};
-/**
- * Operation Payload used to create new `OrgEmployee` record.
- */
-export type CreateOrgEmployeePayload = {
-    /**
-     * Employee’s username.
-     */
-    username: string;
-    /**
-     * Employee’s email.
-     */
-    email: Email;
-    /**
-     * Identity issuer (eg Auth0). Empty if it's the default one (Dfns one). The issuer will be filled for non-Dfns issuers.
-     */
-    issuer?: string;
-    /**
-     * Employee's full legal name.
-     */
-    fullName: string;
-    /**
-     * Employee's date of birth.
-     */
-    dateOfBirth?: IsoDate;
-};
-export type OrgApiKey = {
-    apiKeyId: EntityId;
-    orgId: EntityId;
-};
-export type CreateEmployee = {
-    /**
-     * Employee’s username.
-     */
-    username: string;
-    /**
-     * Employee’s email.
-     */
-    email: Email;
-    /**
-     * Identity issuer (eg Auth0). Empty if it's the default one (Dfns one). The issuer will be filled for non-Dfns issuers.
-     */
-    issuer?: string;
-    /**
-     * Employee's full legal name.
-     */
-    fullName: string;
-    /**
-     * Employee's date of birth.
-     */
-    dateOfBirth?: IsoDate;
-    authVersionToUse?: AuthSystemVersion;
-};
-export type UpdateEmployee = {
-    /**
-     * Employee's full legal name.
-     *
-     */
-    fullName?: string;
-    /**
-     * Employee's date of birth.
-     */
-    dateOfBirth?: IsoDate;
-    /**
-     * Status of the employee. Identifies if given user can perform any actions or not. See `OrgEmployeeStatus` for more details.
-     */
-    status?: OrgEmployeeStatus;
-};
-export type UpdateOrg = {
-    /**
-     * Full legal name of the organisation, including suffixes such as LLC, Limited, etc.
-     */
-    legalName?: string;
-    /**
-     * Trading name by which company is known. For example "Panasonic" instead of "Panasonic Holdings Corporation".
-     */
-    tradingName?: string;
-    /**
-     * Date when organisation was incorporated.
-     */
-    dateOfIncorporation?: IsoDate;
-    /**
-     * Country where organisation is head quartered, and default jurisdiction if applies.
-     */
-    country?: Countries;
-    /**
-     * Date when organisation was onboarded in Dfns.
-     */
-    dateOnboarded?: IsoDate;
-};
-export type CreateOrg = {
-    /**
-     * Full legal name of the organisation, including suffixes such as LLC, Limited, etc.
-     */
-    legalName: string;
-    /**
-     * Trading name by which company is known. For example "Panasonic" instead of "Panasonic Holdings Corporation".
-     */
-    tradingName: string;
-    /**
-     * Date when organisation was incorporated.
-     */
-    dateOfIncorporation: IsoDate;
-    /**
-     * Country where organisation is head quartered, and default jurisdiction if applies.
-     */
-    country: Countries;
-    /**
-     * Date when organisation was onboarded in Dfns.
-     */
-    dateOnboarded?: IsoDate;
-    /**
-     * List of `CreateOrgEmpoyeePayload` for the organisations. These employees will be created for this org.
-     */
-    employees?: CreateOrgEmployeePayload[];
-    authVersionToUse?: AuthSystemVersion;
-    /**
-     * Indicates signing cluster identifier.
-     */
-    clusterId?: string;
-};
-/**
- * Indicates customer’s status within a lifecycle.
- */
-export declare enum OrgStatus {
-    Archived = "Archived",
-    Disabled = "Disabled",
-    Enabled = "Enabled",
-    Creating = "Creating",
-    Approved = "Approved"
-}
-export declare enum OrgEmployeeStatus {
-    Enabled = "Enabled",
-    Disabled = "Disabled",
-    Archived = "Archived"
-}
-export declare enum AuthSystemVersion {
-    AuthV1 = "AuthV1",
-    AuthV2 = "AuthV2",
-    All = "All"
-}

package/codegen/datamodel/Orgs/types.js

@@ -1,39 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.AuthSystemVersion = exports.OrgEmployeeStatus = exports.OrgStatus = void 0;
-/**
- * Indicates customer’s status within a lifecycle.
- */
-var OrgStatus;
-(function (OrgStatus) {
-    //Customer is archived and no longer functional. Customer will have to go through re-onboarding to be enabled again.
-    OrgStatus["Archived"] = "Archived";
-    //Customer is disabled. Usually temporary action, in case something goes wrong.
-    OrgStatus["Disabled"] = "Disabled";
-    //Customer is enabled and operational.
-    OrgStatus["Enabled"] = "Enabled";
-    //Customer is being created at the moment.
-    OrgStatus["Creating"] = "Creating";
-    //Customer is approved to be created and initialized.
-    OrgStatus["Approved"] = "Approved";
-})(OrgStatus || (exports.OrgStatus = OrgStatus = {}));
-// FIXME: Missing documentation for OrgEmployeeStatus
-var OrgEmployeeStatus;
-(function (OrgEmployeeStatus) {
-    //OrgEmployee is enabled and active.
-    OrgEmployeeStatus["Enabled"] = "Enabled";
-    //OrgEmployee is temporary disabled.
-    OrgEmployeeStatus["Disabled"] = "Disabled";
-    //OrgEmployee is deleted, and archived for audit purposes.
-    OrgEmployeeStatus["Archived"] = "Archived";
-})(OrgEmployeeStatus || (exports.OrgEmployeeStatus = OrgEmployeeStatus = {}));
-// FIXME: Missing documentation for AuthSystemVersion
-var AuthSystemVersion;
-(function (AuthSystemVersion) {
-    // FIXME: Missing documentation for AuthV1
-    AuthSystemVersion["AuthV1"] = "AuthV1";
-    // FIXME: Missing documentation for AuthV2
-    AuthSystemVersion["AuthV2"] = "AuthV2";
-    // FIXME: Missing documentation for All
-    AuthSystemVersion["All"] = "All";
-})(AuthSystemVersion || (exports.AuthSystemVersion = AuthSystemVersion = {}));

package/codegen/datamodel/Permissions/errors.js

@@ -1 +0,0 @@
-"use strict";

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

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

package/codegen/datamodel/Permissions/index.js

@@ -1,18 +0,0 @@
-"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);