@artu-ai/compliance-sdk 0.0.6 → 0.3.0

package/dist/models/ContactMethod.d.ts

@@ -0,0 +1,102 @@
+/**
+ * ContactMethod Model
+ *
+ * Communication channel for a client (email, phone, etc.).
+ */
+import { ContactMethodType, type ContactMethod as ContactMethodSchema } from "@artu-ai/shared";
+import { BaseModel } from "./base";
+/**
+ * Contact method data structure from the API
+ */
+export interface ContactMethodData extends Omit<ContactMethodSchema, "verifiedAt"> {
+    id: string;
+    verifiedAt: string | null;
+    createdAt: string;
+    updatedAt: string;
+}
+/**
+ * ContactMethod Model.
+ *
+ * Provides typed accessors for contact method data with formatting helpers.
+ *
+ * @example
+ * ```typescript
+ * const contacts = await sdk.contactMethods.listByClient("client_123");
+ * for (const contact of contacts) {
+ *   console.log(contact.display);
+ *   console.log(`Verified: ${contact.isVerified}`);
+ * }
+ * ```
+ */
+export declare class ContactMethod extends BaseModel<ContactMethodData> {
+    /**
+     * Unique contact method identifier
+     */
+    get id(): string;
+    /**
+     * ID of the client this contact method belongs to
+     */
+    get clientId(): string;
+    /**
+     * Contact method type (email, phone, mobile, fax, other)
+     */
+    get type(): ContactMethodType;
+    /**
+     * Whether this is the primary contact method for its type
+     */
+    get isPrimary(): boolean;
+    /**
+     * The contact value (email address, phone number, etc.)
+     */
+    get value(): string;
+    /**
+     * Optional label (e.g., "Work", "Personal")
+     */
+    get label(): string | undefined;
+    /**
+     * Whether this contact method has been verified
+     */
+    get isVerified(): boolean;
+    /**
+     * When this contact method was verified
+     */
+    get verifiedAt(): Date | null;
+    /**
+     * External ID
+     */
+    get externalId(): string | undefined;
+    /**
+     * Additional metadata
+     */
+    get metadata(): Record<string, unknown> | undefined;
+    /**
+     * When the contact method was created
+     */
+    get createdAt(): Date;
+    /**
+     * When the contact method was last updated
+     */
+    get updatedAt(): Date;
+    /**
+     * Whether this is an email contact
+     */
+    get isEmail(): boolean;
+    /**
+     * Whether this is a phone contact
+     */
+    get isPhone(): boolean;
+    /**
+     * Whether this is a mobile contact
+     */
+    get isMobile(): boolean;
+    /**
+     * Whether this is a fax contact
+     */
+    get isFax(): boolean;
+    /**
+     * Returns a display string with optional label
+     */
+    get display(): string;
+    toString(): string;
+}
+//# sourceMappingURL=ContactMethod.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ContactMethod.d.ts","sourceRoot":"","sources":["../../src/models/ContactMethod.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EACL,iBAAiB,EACjB,KAAK,aAAa,IAAI,mBAAmB,EAC1C,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAE,SAAS,EAAE,MAAM,QAAQ,CAAC;AAMnC;;GAEG;AACH,MAAM,WAAW,iBACf,SAAQ,IAAI,CAAC,mBAAmB,EAAE,YAAY,CAAC;IAC/C,EAAE,EAAE,MAAM,CAAC;IACX,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;CACnB;AAMD;;;;;;;;;;;;;GAaG;AACH,qBAAa,aAAc,SAAQ,SAAS,CAAC,iBAAiB,CAAC;IAK7D;;OAEG;IACH,IAAI,EAAE,IAAI,MAAM,CAEf;IAED;;OAEG;IACH,IAAI,QAAQ,IAAI,MAAM,CAErB;IAED;;OAEG;IACH,IAAI,IAAI,IAAI,iBAAiB,CAE5B;IAED;;OAEG;IACH,IAAI,SAAS,IAAI,OAAO,CAEvB;IAMD;;OAEG;IACH,IAAI,KAAK,IAAI,MAAM,CAElB;IAED;;OAEG;IACH,IAAI,KAAK,IAAI,MAAM,GAAG,SAAS,CAE9B;IAMD;;OAEG;IACH,IAAI,UAAU,IAAI,OAAO,CAExB;IAED;;OAEG;IACH,IAAI,UAAU,IAAI,IAAI,GAAG,IAAI,CAE5B;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,SAAS,IAAI,IAAI,CAEpB;IAED;;OAEG;IACH,IAAI,SAAS,IAAI,IAAI,CAEpB;IAMD;;OAEG;IACH,IAAI,OAAO,IAAI,OAAO,CAErB;IAED;;OAEG;IACH,IAAI,OAAO,IAAI,OAAO,CAErB;IAED;;OAEG;IACH,IAAI,QAAQ,IAAI,OAAO,CAEtB;IAED;;OAEG;IACH,IAAI,KAAK,IAAI,OAAO,CAEnB;IAMD;;OAEG;IACH,IAAI,OAAO,IAAI,MAAM,CAEpB;IAMQ,QAAQ,IAAI,MAAM;CAG5B"}

package/dist/models/ContactMethod.js

@@ -0,0 +1,152 @@
+/**
+ * ContactMethod Model
+ *
+ * Communication channel for a client (email, phone, etc.).
+ */
+import { ContactMethodType, } from "@artu-ai/shared";
+import { BaseModel } from "./base";
+// ===========================
+// ContactMethod Model
+// ===========================
+/**
+ * ContactMethod Model.
+ *
+ * Provides typed accessors for contact method data with formatting helpers.
+ *
+ * @example
+ * ```typescript
+ * const contacts = await sdk.contactMethods.listByClient("client_123");
+ * for (const contact of contacts) {
+ *   console.log(contact.display);
+ *   console.log(`Verified: ${contact.isVerified}`);
+ * }
+ * ```
+ */
+export class ContactMethod extends BaseModel {
+    // ─────────────────────────────────────────────────────────────────
+    // Core Properties
+    // ─────────────────────────────────────────────────────────────────
+    /**
+     * Unique contact method identifier
+     */
+    get id() {
+        return this._data.id;
+    }
+    /**
+     * ID of the client this contact method belongs to
+     */
+    get clientId() {
+        return this._data.clientId;
+    }
+    /**
+     * Contact method type (email, phone, mobile, fax, other)
+     */
+    get type() {
+        return this._data.type;
+    }
+    /**
+     * Whether this is the primary contact method for its type
+     */
+    get isPrimary() {
+        return this._data.isPrimary;
+    }
+    // ─────────────────────────────────────────────────────────────────
+    // Value Fields
+    // ─────────────────────────────────────────────────────────────────
+    /**
+     * The contact value (email address, phone number, etc.)
+     */
+    get value() {
+        return this._data.value;
+    }
+    /**
+     * Optional label (e.g., "Work", "Personal")
+     */
+    get label() {
+        return this._data.label;
+    }
+    // ─────────────────────────────────────────────────────────────────
+    // Verification
+    // ─────────────────────────────────────────────────────────────────
+    /**
+     * Whether this contact method has been verified
+     */
+    get isVerified() {
+        return this._data.isVerified;
+    }
+    /**
+     * When this contact method was verified
+     */
+    get verifiedAt() {
+        return this._data.verifiedAt ? new Date(this._data.verifiedAt) : null;
+    }
+    // ─────────────────────────────────────────────────────────────────
+    // Metadata
+    // ─────────────────────────────────────────────────────────────────
+    /**
+     * External ID
+     */
+    get externalId() {
+        return this._data.externalId;
+    }
+    /**
+     * Additional metadata
+     */
+    get metadata() {
+        return this._data.metadata;
+    }
+    /**
+     * When the contact method was created
+     */
+    get createdAt() {
+        return new Date(this._data.createdAt);
+    }
+    /**
+     * When the contact method was last updated
+     */
+    get updatedAt() {
+        return new Date(this._data.updatedAt);
+    }
+    // ─────────────────────────────────────────────────────────────────
+    // Type Helpers
+    // ─────────────────────────────────────────────────────────────────
+    /**
+     * Whether this is an email contact
+     */
+    get isEmail() {
+        return this.type === ContactMethodType.Email;
+    }
+    /**
+     * Whether this is a phone contact
+     */
+    get isPhone() {
+        return this.type === ContactMethodType.Phone;
+    }
+    /**
+     * Whether this is a mobile contact
+     */
+    get isMobile() {
+        return this.type === ContactMethodType.Mobile;
+    }
+    /**
+     * Whether this is a fax contact
+     */
+    get isFax() {
+        return this.type === ContactMethodType.Fax;
+    }
+    // ─────────────────────────────────────────────────────────────────
+    // Formatting
+    // ─────────────────────────────────────────────────────────────────
+    /**
+     * Returns a display string with optional label
+     */
+    get display() {
+        return this.label ? `${this.label}: ${this.value}` : this.value;
+    }
+    // ─────────────────────────────────────────────────────────────────
+    // String Representation
+    // ─────────────────────────────────────────────────────────────────
+    toString() {
+        return `ContactMethod(${this.id}, ${this.type}, ${this.value})`;
+    }
+}

package/dist/models/Document.d.ts

@@ -0,0 +1,167 @@
+/**
+ * Document model
+ *
+ * Represents a file uploaded for a client.
+ * Supports jurisdiction-specific document types (MX, US).
+ */
+import { BaseModel } from "./base";
+import { DocumentStatus, DocumentCategory, Jurisdiction, type DocumentResponse } from "@artu-ai/shared";
+/**
+ * Document data as returned by the API.
+ * Uses the centralized type from @artu-ai/shared.
+ */
+export type DocumentData = DocumentResponse;
+/**
+ * Document model - represents an uploaded file.
+ *
+ * @example
+ * ```typescript
+ * const doc = await sdk.documents.retrieve("doc_123");
+ *
+ * console.log(doc.filename);        // "passport.pdf"
+ * console.log(doc.formattedSize);   // "2.5 MB"
+ * console.log(doc.isAvailable);     // true
+ *
+ * if (doc.isMexico) {
+ *   console.log(doc.type); // "ine_front" | "rfc" | etc.
+ * }
+ * ```
+ */
+export declare class Document extends BaseModel<DocumentData> {
+    /**
+     * Unique identifier for the document
+     */
+    get id(): string;
+    /**
+     * ID of the client this document belongs to
+     */
+    get clientId(): string;
+    /**
+     * Jurisdiction for this document (MX, US)
+     */
+    get jurisdiction(): Jurisdiction;
+    /**
+     * Document type (jurisdiction-specific)
+     */
+    get type(): string;
+    /**
+     * Document category (identity, address, financial, etc.)
+     */
+    get category(): DocumentCategory;
+    /**
+     * Document status
+     */
+    get status(): DocumentStatus;
+    /**
+     * Whether a file is attached to this document
+     */
+    get hasFile(): boolean;
+    /**
+     * Original filename (undefined if no file attached)
+     */
+    get filename(): string | undefined;
+    /**
+     * MIME content type (undefined if no file attached)
+     */
+    get contentType(): string | undefined;
+    /**
+     * File size in bytes (undefined if no file attached)
+     */
+    get size(): number | undefined;
+    /**
+     * Human-readable file size (e.g., "2.5 MB")
+     * Returns undefined if no file attached
+     */
+    get formattedSize(): string | undefined;
+    /**
+     * File extension derived from filename
+     * Returns empty string if no file or no extension
+     */
+    get extension(): string;
+    /**
+     * Whether the document is ready for download
+     */
+    get isAvailable(): boolean;
+    /**
+     * Whether the document is pending upload
+     */
+    get isPending(): boolean;
+    /**
+     * Whether the document has been verified
+     */
+    get isVerified(): boolean;
+    /**
+     * Whether the document was rejected
+     */
+    get isRejected(): boolean;
+    /**
+     * Whether the document has expired
+     */
+    get isExpired(): boolean;
+    /**
+     * Document expiration date, if set
+     */
+    get expiresAt(): Date | undefined;
+    /**
+     * Days until document expires (negative if already expired)
+     */
+    get daysUntilExpiry(): number | undefined;
+    /**
+     * Document-specific fields (extracted or provided data)
+     *
+     * For typed fields, use jurisdiction-specific document models:
+     * - MexIneFrontDocument.ineFields
+     * - MexPassportDocument.passportFields
+     * - etc.
+     */
+    get fields(): Record<string, unknown> | undefined;
+    /**
+     * Get a specific field value
+     */
+    getField<T = unknown>(key: string): T | undefined;
+    /**
+     * External ID
+     */
+    get externalId(): string | undefined;
+    /**
+     * Custom metadata attached to the document
+     */
+    get metadata(): Record<string, unknown> | undefined;
+    /**
+     * Get a specific metadata value
+     */
+    getMetadata<T = unknown>(key: string): T | undefined;
+    /**
+     * When the document was created
+     */
+    get createdAt(): Date;
+    /**
+     * When the document was last updated
+     */
+    get updatedAt(): Date;
+    /**
+     * Whether this is a Mexico document
+     */
+    get isMexico(): boolean;
+    /**
+     * Whether this is an identity document
+     */
+    get isIdentityDocument(): boolean;
+    /**
+     * Whether this is an address proof document
+     */
+    get isAddressProof(): boolean;
+    /**
+     * Whether this is a financial document
+     */
+    get isFinancialDocument(): boolean;
+    /**
+     * Whether this is an incorporation document
+     */
+    get isIncorporationDocument(): boolean;
+    /**
+     * Whether this is a tax document
+     */
+    get isTaxDocument(): boolean;
+}
+//# sourceMappingURL=Document.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"Document.d.ts","sourceRoot":"","sources":["../../src/models/Document.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAE,SAAS,EAAE,MAAM,QAAQ,CAAC;AACnC,OAAO,EACL,cAAc,EACd,gBAAgB,EAChB,YAAY,EACZ,KAAK,gBAAgB,EACtB,MAAM,iBAAiB,CAAC;AAMzB;;;GAGG;AACH,MAAM,MAAM,YAAY,GAAG,gBAAgB,CAAC;AAM5C;;;;;;;;;;;;;;;GAeG;AACH,qBAAa,QAAS,SAAQ,SAAS,CAAC,YAAY,CAAC;IAKnD;;OAEG;IACH,IAAI,EAAE,IAAI,MAAM,CAEf;IAED;;OAEG;IACH,IAAI,QAAQ,IAAI,MAAM,CAErB;IAED;;OAEG;IACH,IAAI,YAAY,IAAI,YAAY,CAE/B;IAED;;OAEG;IACH,IAAI,IAAI,IAAI,MAAM,CAEjB;IAED;;OAEG;IACH,IAAI,QAAQ,IAAI,gBAAgB,CAE/B;IAED;;OAEG;IACH,IAAI,MAAM,IAAI,cAAc,CAE3B;IAMD;;OAEG;IACH,IAAI,OAAO,IAAI,OAAO,CAErB;IAED;;OAEG;IACH,IAAI,QAAQ,IAAI,MAAM,GAAG,SAAS,CAEjC;IAED;;OAEG;IACH,IAAI,WAAW,IAAI,MAAM,GAAG,SAAS,CAEpC;IAED;;OAEG;IACH,IAAI,IAAI,IAAI,MAAM,GAAG,SAAS,CAE7B;IAED;;;OAGG;IACH,IAAI,aAAa,IAAI,MAAM,GAAG,SAAS,CAItC;IAED;;;OAGG;IACH,IAAI,SAAS,IAAI,MAAM,CAMtB;IAMD;;OAEG;IACH,IAAI,WAAW,IAAI,OAAO,CAKzB;IAED;;OAEG;IACH,IAAI,SAAS,IAAI,OAAO,CAEvB;IAED;;OAEG;IACH,IAAI,UAAU,IAAI,OAAO,CAExB;IAED;;OAEG;IACH,IAAI,UAAU,IAAI,OAAO,CAExB;IAED;;OAEG;IACH,IAAI,SAAS,IAAI,OAAO,CAIvB;IAMD;;OAEG;IACH,IAAI,SAAS,IAAI,IAAI,GAAG,SAAS,CAEhC;IAED;;OAEG;IACH,IAAI,eAAe,IAAI,MAAM,GAAG,SAAS,CAKxC;IAMD;;;;;;;OAOG;IACH,IAAI,MAAM,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAGhD;IAED;;OAEG;IACH,QAAQ,CAAC,CAAC,GAAG,OAAO,EAAE,GAAG,EAAE,MAAM,GAAG,CAAC,GAAG,SAAS;IAQjD;;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,WAAW,CAAC,CAAC,GAAG,OAAO,EAAE,GAAG,EAAE,MAAM,GAAG,CAAC,GAAG,SAAS;IAQpD;;OAEG;IACH,IAAI,SAAS,IAAI,IAAI,CAEpB;IAED;;OAEG;IACH,IAAI,SAAS,IAAI,IAAI,CAEpB;IAMD;;OAEG;IACH,IAAI,QAAQ,IAAI,OAAO,CAEtB;IAMD;;OAEG;IACH,IAAI,kBAAkB,IAAI,OAAO,CAEhC;IAED;;OAEG;IACH,IAAI,cAAc,IAAI,OAAO,CAE5B;IAED;;OAEG;IACH,IAAI,mBAAmB,IAAI,OAAO,CAEjC;IAED;;OAEG;IACH,IAAI,uBAAuB,IAAI,OAAO,CAErC;IAED;;OAEG;IACH,IAAI,aAAa,IAAI,OAAO,CAE3B;CACF"}