@artu-ai/compliance-sdk 0.0.5 → 0.2.0

package/dist/models/BankAccount.js

@@ -0,0 +1,190 @@
+/**
+ * BankAccount Model
+ *
+ * Bank account information for a client.
+ * Uses discriminated union based on `country` field.
+ */
+import { BankAccountType, } from "@artu-ai/shared";
+import { BaseModel } from "./base";
+// ===========================
+// BankAccount Model
+// ===========================
+/**
+ * BankAccount Model.
+ *
+ * Base class for bank account data. The concrete type depends on
+ * the `country` field:
+ * - `country === "MX"` → MexBankAccount with clabe, codigoBanco, codigoPlaza
+ * - Other countries → GenericBankAccount
+ *
+ * @example
+ * ```typescript
+ * const account = await sdk.bankAccounts.retrieve(id);
+ *
+ * // Check country for type narrowing
+ * if (account.country === "MX") {
+ *   console.log(account.clabe); // MexBankAccount
+ * }
+ * ```
+ */
+export class BankAccount extends BaseModel {
+    // ─────────────────────────────────────────────────────────────────
+    // Core Properties
+    // ─────────────────────────────────────────────────────────────────
+    /**
+     * Unique bank account identifier
+     */
+    get id() {
+        return this._data.id;
+    }
+    /**
+     * ID of the client this bank account belongs to
+     */
+    get clientId() {
+        return this._data.clientId;
+    }
+    /**
+     * Account number
+     */
+    get accountNumber() {
+        return this._data.accountNumber;
+    }
+    /**
+     * Bank name
+     */
+    get bankName() {
+        return this._data.bankName;
+    }
+    /**
+     * Bank code (e.g., SWIFT, routing number)
+     */
+    get bankCode() {
+        return this._data.bankCode;
+    }
+    /**
+     * Country where the bank account is held (ISO 3166-1 alpha-2)
+     *
+     * This is the discriminator field - determines which fields are available.
+     */
+    get country() {
+        return this._data.country;
+    }
+    /**
+     * Account type (checking, savings, investment, other)
+     */
+    get type() {
+        return this._data.type;
+    }
+    /**
+     * Account currency (ISO 4217 code)
+     */
+    get currency() {
+        return this._data.currency;
+    }
+    // ─────────────────────────────────────────────────────────────────
+    // Status
+    // ─────────────────────────────────────────────────────────────────
+    /**
+     * Whether this is the primary bank account
+     */
+    get isPrimary() {
+        return this._data.isPrimary ?? false;
+    }
+    /**
+     * Whether this account is active
+     */
+    get isActive() {
+        return this._data.isActive ?? true;
+    }
+    // ─────────────────────────────────────────────────────────────────
+    // Metadata
+    // ─────────────────────────────────────────────────────────────────
+    /**
+     * Optional label (e.g., "Personal Checking")
+     */
+    get label() {
+        return this._data.label;
+    }
+    /**
+     * External ID
+     */
+    get externalId() {
+        return this._data.externalId;
+    }
+    /**
+     * Additional metadata
+     */
+    get metadata() {
+        return this._data.metadata;
+    }
+    /**
+     * When the bank account was created
+     */
+    get createdAt() {
+        return new Date(this._data.createdAt);
+    }
+    /**
+     * When the bank account was last updated
+     */
+    get updatedAt() {
+        return new Date(this._data.updatedAt);
+    }
+    // ─────────────────────────────────────────────────────────────────
+    // Type Helpers
+    // ─────────────────────────────────────────────────────────────────
+    /**
+     * Whether this is a checking account
+     */
+    get isChecking() {
+        return this.type === BankAccountType.Checking;
+    }
+    /**
+     * Whether this is a savings account
+     */
+    get isSavings() {
+        return this.type === BankAccountType.Savings;
+    }
+    /**
+     * Whether this is an investment account
+     */
+    get isInvestment() {
+        return this.type === BankAccountType.Investment;
+    }
+    /**
+     * Whether this is a Mexican bank account
+     */
+    get isMexican() {
+        return this.country === "MX";
+    }
+    // ─────────────────────────────────────────────────────────────────
+    // Formatting
+    // ─────────────────────────────────────────────────────────────────
+    /**
+     * Returns a masked account number (shows last 4 digits)
+     */
+    get maskedAccountNumber() {
+        const lastFour = this.accountNumber.slice(-4);
+        return `****${lastFour}`;
+    }
+    /**
+     * Returns a display string with bank name and masked account
+     */
+    get display() {
+        return `${this.bankName} (${this.maskedAccountNumber})`;
+    }
+    // ─────────────────────────────────────────────────────────────────
+    // String Representation
+    // ─────────────────────────────────────────────────────────────────
+    toString() {
+        return `BankAccount(${this.id}, ${this.bankName}, ${this.country})`;
+    }
+}
+// ===========================
+// Type Guards
+// ===========================
+/**
+ * Check if value is any type of BankAccount model
+ */
+export function isBankAccount(value) {
+    return value instanceof BankAccount;
+}

package/dist/models/Client.d.ts

@@ -0,0 +1,170 @@
+/**
+ * Base Client Model
+ *
+ * Pure data model with no API calls.
+ * Provides type-safe access to common client properties.
+ */
+import { BaseModel } from "./base";
+import { ClientType } from "@artu-ai/shared";
+import type { BaseClient, Jurisdiction, AddressResponse, ContactMethodResponse, BankAccountResponse, DocumentResponse, LinkedClientResponse, ClientRelationshipType } from "@artu-ai/shared";
+import { Address } from "./Address";
+import { ContactMethod } from "./ContactMethod";
+import { BankAccount } from "./BankAccount";
+import { Document } from "./Document";
+export type ClientData = BaseClient & {
+    id: string;
+    createdAt: string;
+    updatedAt: string;
+    email?: string | null;
+    phone?: string | null;
+    addresses?: AddressResponse[];
+    contactMethods?: ContactMethodResponse[];
+    bankAccounts?: BankAccountResponse[];
+    documents?: DocumentResponse[];
+    linkedClients?: LinkedClientResponse[];
+};
+/**
+ * Base Client Model.
+ *
+ * Pure data model with no API calls.
+ * Extended by jurisdiction-specific models (MexClient, etc.).
+ *
+ * @example
+ * ```typescript
+ * const client = await sdk.clients.retrieve("client_123");
+ * console.log(client.name);
+ * console.log(client.email);
+ * ```
+ */
+export declare class Client extends BaseModel<ClientData> {
+    /**
+     * Unique identifier
+     */
+    get id(): string;
+    /**
+     * Client type: "individual" or "company"
+     */
+    get type(): ClientType;
+    /**
+     * Whether this is an individual (individual)
+     */
+    get isIndividual(): boolean;
+    /**
+     * Whether this is a company (legal entity)
+     */
+    get isCompany(): boolean;
+    /**
+     * Whether this is a trust
+     */
+    get isTrust(): boolean;
+    /**
+     * Full name (individual) or legal name (company)
+     */
+    get name(): string;
+    /**
+     * Nationalities as ISO2 country codes
+     */
+    get nationalities(): string[];
+    /**
+     * Birth date (individuals only)
+     * Returns undefined for companies and trusts
+     */
+    get birthDate(): Date | undefined;
+    /**
+     * Middle name (individuals only)
+     */
+    get middleName(): string | undefined;
+    /**
+     * Last name(s) (individuals only)
+     * Returns as array to support multiple surnames (e.g., Spanish naming)
+     */
+    get lastName(): string[] | undefined;
+    /**
+     * Incorporation date (companies only)
+     * Returns undefined for individuals and trusts
+     */
+    get incorporationDate(): Date | undefined;
+    /**
+     * Formation date (trusts only)
+     * Returns undefined for individuals and companies
+     */
+    get formationDate(): Date | undefined;
+    /**
+     * Primary jurisdiction for compliance purposes.
+     * May be undefined if not set (can be inferred from SDK scope).
+     */
+    get primaryJurisdiction(): Jurisdiction | undefined;
+    /**
+     * Checks if client has data for a specific jurisdiction
+     */
+    hasJurisdiction(jurisdiction: Jurisdiction): boolean;
+    /**
+     * Raw jurisdiction data object
+     */
+    get jurisdictions(): BaseClient["jurisdictions"];
+    /**
+     * External ID for integration with other systems
+     */
+    get externalId(): string | undefined;
+    /**
+     * Custom metadata
+     */
+    get metadata(): Record<string, unknown> | undefined;
+    /**
+     * Primary email (if included)
+     */
+    get email(): string | null | undefined;
+    /**
+     * Primary phone (if included)
+     */
+    get phone(): string | null | undefined;
+    /**
+     * Addresses (if included)
+     */
+    get addresses(): Address[] | undefined;
+    /**
+     * Contact methods (if included)
+     */
+    get contactMethods(): ContactMethod[] | undefined;
+    /**
+     * Bank accounts (if included)
+     */
+    get bankAccounts(): BankAccount[] | undefined;
+    /**
+     * Documents (if included)
+     */
+    get documents(): Document[] | undefined;
+    /**
+     * Linked clients (if included)
+     */
+    get linkedClients(): {
+        relationshipType: ClientRelationshipType;
+        client: Client;
+    }[] | undefined;
+    /**
+     * When the client was created
+     */
+    get createdAt(): Date;
+    /**
+     * When the client was last updated
+     */
+    get updatedAt(): Date;
+    toString(): string;
+}
+/**
+ * Check if value is any type of Client model
+ */
+export declare function isClient(value: unknown): value is Client;
+/**
+ * Check if client is an individual (individual)
+ */
+export declare function isIndividual(client: Client): boolean;
+/**
+ * Check if client is a company (legal entity)
+ */
+export declare function isCompany(client: Client): boolean;
+/**
+ * Check if client is a trust
+ */
+export declare function isTrust(client: Client): boolean;
+//# sourceMappingURL=Client.d.ts.map

package/dist/models/Client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Client.d.ts","sourceRoot":"","sources":["../../src/models/Client.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAE,SAAS,EAAE,MAAM,QAAQ,CAAC;AACnC,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAC7C,OAAO,KAAK,EACV,UAAU,EACV,YAAY,EACZ,eAAe,EACf,qBAAqB,EACrB,mBAAmB,EACnB,gBAAgB,EAChB,oBAAoB,EACpB,sBAAsB,EACvB,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAC5C,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAMtC,MAAM,MAAM,UAAU,GAAG,UAAU,GAAG;IAEpC,EAAE,EAAE,MAAM,CAAC;IACX,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAElB,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,SAAS,CAAC,EAAE,eAAe,EAAE,CAAC;IAC9B,cAAc,CAAC,EAAE,qBAAqB,EAAE,CAAC;IACzC,YAAY,CAAC,EAAE,mBAAmB,EAAE,CAAC;IACrC,SAAS,CAAC,EAAE,gBAAgB,EAAE,CAAC;IAC/B,aAAa,CAAC,EAAE,oBAAoB,EAAE,CAAC;CACxC,CAAC;AAMF;;;;;;;;;;;;GAYG;AACH,qBAAa,MAAO,SAAQ,SAAS,CAAC,UAAU,CAAC;IAK/C;;OAEG;IACH,IAAI,EAAE,IAAI,MAAM,CAEf;IAED;;OAEG;IACH,IAAI,IAAI,IAAI,UAAU,CAErB;IAED;;OAEG;IACH,IAAI,YAAY,IAAI,OAAO,CAE1B;IAED;;OAEG;IACH,IAAI,SAAS,IAAI,OAAO,CAEvB;IAED;;OAEG;IACH,IAAI,OAAO,IAAI,OAAO,CAErB;IAMD;;OAEG;IACH,IAAI,IAAI,IAAI,MAAM,CAEjB;IAED;;OAEG;IACH,IAAI,aAAa,IAAI,MAAM,EAAE,CAE5B;IAMD;;;OAGG;IACH,IAAI,SAAS,IAAI,IAAI,GAAG,SAAS,CAMhC;IAED;;OAEG;IACH,IAAI,UAAU,IAAI,MAAM,GAAG,SAAS,CAInC;IAED;;;OAGG;IACH,IAAI,QAAQ,IAAI,MAAM,EAAE,GAAG,SAAS,CAInC;IAMD;;;OAGG;IACH,IAAI,iBAAiB,IAAI,IAAI,GAAG,SAAS,CAKxC;IAMD;;;OAGG;IACH,IAAI,aAAa,IAAI,IAAI,GAAG,SAAS,CAKpC;IAMD;;;OAGG;IACH,IAAI,mBAAmB,IAAI,YAAY,GAAG,SAAS,CAElD;IAED;;OAEG;IACH,eAAe,CAAC,YAAY,EAAE,YAAY,GAAG,OAAO;IAKpD;;OAEG;IACH,IAAI,aAAa,IAAI,UAAU,CAAC,eAAe,CAAC,CAE/C;IAMD;;OAEG;IACH,IAAI,UAAU,IAAI,MAAM,GAAG,SAAS,CAEnC;IAED;;OAEG;IACH,IAAI,QAAQ,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAElD;IAED;;OAEG;IACH,IAAI,KAAK,IAAI,MAAM,GAAG,IAAI,GAAG,SAAS,CAErC;IAED;;OAEG;IACH,IAAI,KAAK,IAAI,MAAM,GAAG,IAAI,GAAG,SAAS,CAErC;IAED;;OAEG;IACH,IAAI,SAAS,IAAI,OAAO,EAAE,GAAG,SAAS,CAErC;IAED;;OAEG;IACH,IAAI,cAAc,IAAI,aAAa,EAAE,GAAG,SAAS,CAEhD;IAED;;OAEG;IACH,IAAI,YAAY,IAAI,WAAW,EAAE,GAAG,SAAS,CAE5C;IAED;;OAEG;IACH,IAAI,SAAS,IAAI,QAAQ,EAAE,GAAG,SAAS,CAEtC;IAED;;OAEG;IACH,IAAI,aAAa,IACb;QACE,gBAAgB,EAAE,sBAAsB,CAAC;QACzC,MAAM,EAAE,MAAM,CAAC;KAChB,EAAE,GACH,SAAS,CAKZ;IAMD;;OAEG;IACH,IAAI,SAAS,IAAI,IAAI,CAEpB;IAED;;OAEG;IACH,IAAI,SAAS,IAAI,IAAI,CAEpB;IAMQ,QAAQ,IAAI,MAAM;CAG5B;AAMD;;GAEG;AACH,wBAAgB,QAAQ,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,MAAM,CAExD;AAED;;GAEG;AACH,wBAAgB,YAAY,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAEpD;AAED;;GAEG;AACH,wBAAgB,SAAS,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAEjD;AAED;;GAEG;AACH,wBAAgB,OAAO,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAE/C"}

package/dist/models/Client.js

@@ -0,0 +1,257 @@
+/**
+ * Base Client Model
+ *
+ * Pure data model with no API calls.
+ * Provides type-safe access to common client properties.
+ */
+import { BaseModel } from "./base";
+import { ClientType } from "@artu-ai/shared";
+import { Address } from "./Address";
+import { ContactMethod } from "./ContactMethod";
+import { BankAccount } from "./BankAccount";
+import { Document } from "./Document";
+// ===========================
+// Client Model
+// ===========================
+/**
+ * Base Client Model.
+ *
+ * Pure data model with no API calls.
+ * Extended by jurisdiction-specific models (MexClient, etc.).
+ *
+ * @example
+ * ```typescript
+ * const client = await sdk.clients.retrieve("client_123");
+ * console.log(client.name);
+ * console.log(client.email);
+ * ```
+ */
+export class Client extends BaseModel {
+    // ─────────────────────────────────────────────────────────────────
+    // Identity
+    // ─────────────────────────────────────────────────────────────────
+    /**
+     * Unique identifier
+     */
+    get id() {
+        return this._data.id;
+    }
+    /**
+     * Client type: "individual" or "company"
+     */
+    get type() {
+        return this._data.type;
+    }
+    /**
+     * Whether this is an individual (individual)
+     */
+    get isIndividual() {
+        return this._data.type === ClientType.Individual;
+    }
+    /**
+     * Whether this is a company (legal entity)
+     */
+    get isCompany() {
+        return this._data.type === ClientType.Company;
+    }
+    /**
+     * Whether this is a trust
+     */
+    get isTrust() {
+        return this._data.type === ClientType.Trust;
+    }
+    // ─────────────────────────────────────────────────────────────────
+    // Common Fields
+    // ─────────────────────────────────────────────────────────────────
+    /**
+     * Full name (individual) or legal name (company)
+     */
+    get name() {
+        return this._data.name;
+    }
+    /**
+     * Nationalities as ISO2 country codes
+     */
+    get nationalities() {
+        return this._data.nationalities ?? [];
+    }
+    // ─────────────────────────────────────────────────────────────────
+    // Individual-specific fields
+    // ─────────────────────────────────────────────────────────────────
+    /**
+     * Birth date (individuals only)
+     * Returns undefined for companies and trusts
+     */
+    get birthDate() {
+        // Access via record since BaseClient is a discriminated union
+        const raw = this._data.birthDate;
+        return raw ? new Date(raw) : undefined;
+    }
+    /**
+     * Middle name (individuals only)
+     */
+    get middleName() {
+        return this._data.middleName;
+    }
+    /**
+     * Last name(s) (individuals only)
+     * Returns as array to support multiple surnames (e.g., Spanish naming)
+     */
+    get lastName() {
+        return this._data.lastName;
+    }
+    // ─────────────────────────────────────────────────────────────────
+    // Company-specific fields
+    // ─────────────────────────────────────────────────────────────────
+    /**
+     * Incorporation date (companies only)
+     * Returns undefined for individuals and trusts
+     */
+    get incorporationDate() {
+        const raw = this._data.incorporationDate;
+        return raw ? new Date(raw) : undefined;
+    }
+    // ─────────────────────────────────────────────────────────────────
+    // Trust-specific fields
+    // ─────────────────────────────────────────────────────────────────
+    /**
+     * Formation date (trusts only)
+     * Returns undefined for individuals and companies
+     */
+    get formationDate() {
+        const raw = this._data.formationDate;
+        return raw ? new Date(raw) : undefined;
+    }
+    // ─────────────────────────────────────────────────────────────────
+    // Jurisdiction
+    // ─────────────────────────────────────────────────────────────────
+    /**
+     * Primary jurisdiction for compliance purposes.
+     * May be undefined if not set (can be inferred from SDK scope).
+     */
+    get primaryJurisdiction() {
+        return this._data.primaryJurisdiction;
+    }
+    /**
+     * Checks if client has data for a specific jurisdiction
+     */
+    hasJurisdiction(jurisdiction) {
+        if (!this._data.jurisdictions)
+            return false;
+        return jurisdiction in this._data.jurisdictions;
+    }
+    /**
+     * Raw jurisdiction data object
+     */
+    get jurisdictions() {
+        return this._data.jurisdictions ?? {};
+    }
+    // ─────────────────────────────────────────────────────────────────
+    // Metadata
+    // ─────────────────────────────────────────────────────────────────
+    /**
+     * External ID for integration with other systems
+     */
+    get externalId() {
+        return this._data.externalId;
+    }
+    /**
+     * Custom metadata
+     */
+    get metadata() {
+        return this._data.metadata;
+    }
+    /**
+     * Primary email (if included)
+     */
+    get email() {
+        return this._data.email;
+    }
+    /**
+     * Primary phone (if included)
+     */
+    get phone() {
+        return this._data.phone;
+    }
+    /**
+     * Addresses (if included)
+     */
+    get addresses() {
+        return this._data.addresses?.map((a) => new Address(a));
+    }
+    /**
+     * Contact methods (if included)
+     */
+    get contactMethods() {
+        return this._data.contactMethods?.map((c) => new ContactMethod(c));
+    }
+    /**
+     * Bank accounts (if included)
+     */
+    get bankAccounts() {
+        return this._data.bankAccounts?.map((b) => new BankAccount(b));
+    }
+    /**
+     * Documents (if included)
+     */
+    get documents() {
+        return this._data.documents?.map((d) => new Document(d));
+    }
+    /**
+     * Linked clients (if included)
+     */
+    get linkedClients() {
+        return this._data.linkedClients?.map((l) => ({
+            relationshipType: l.relationshipType,
+            client: new Client(l.client),
+        }));
+    }
+    // ─────────────────────────────────────────────────────────────────
+    // Timestamps
+    // ─────────────────────────────────────────────────────────────────
+    /**
+     * When the client was created
+     */
+    get createdAt() {
+        return new Date(this._data.createdAt);
+    }
+    /**
+     * When the client was last updated
+     */
+    get updatedAt() {
+        return new Date(this._data.updatedAt);
+    }
+    // ─────────────────────────────────────────────────────────────────
+    // String Representation
+    // ─────────────────────────────────────────────────────────────────
+    toString() {
+        return `Client(${this.id}, ${this.name})`;
+    }
+}
+// ===========================
+// Type Guards
+// ===========================
+/**
+ * Check if value is any type of Client model
+ */
+export function isClient(value) {
+    return value instanceof Client;
+}
+/**
+ * Check if client is an individual (individual)
+ */
+export function isIndividual(client) {
+    return client.isIndividual;
+}
+/**
+ * Check if client is a company (legal entity)
+ */
+export function isCompany(client) {
+    return client.isCompany;
+}
+/**
+ * Check if client is a trust
+ */
+export function isTrust(client) {
+    return client.isTrust;
+}