@ordanetwork/sdk 2.0.1 → 2.1.0-beta.1

package/dist/types/types/sender.d.ts

@@ -0,0 +1,161 @@
+/**
+ * Sender (Avenia KYC) Types
+ *
+ * Mirrors the Public API contract for the `senders` resource
+ * (POST/GET /v1/senders). The response shapes here are the
+ * SDK-facing equivalents of `PublicApiSenderResponse` and its
+ * nested types on the backend.
+ */
+export type SenderKycStatus = 'AWAITING_UPLOAD' | 'PROCESSING' | 'APPROVED' | 'REJECTED' | 'EXPIRED';
+/**
+ * Selfie upload instructions for a sender's KYC.
+ *
+ * Both branches carry every key; the off-discriminant fields are `null`.
+ * - `liveness`: complete a hosted liveness check at `livenessUrl`
+ *   (with `livenessSessionId`); `uploadUrl` is null.
+ * - `presigned`: PUT the selfie image to `uploadUrl`; liveness fields are null.
+ */
+export interface SenderSelfie {
+    method: 'liveness' | 'presigned';
+    uploadUrl: string | null;
+    livenessUrl: string | null;
+    livenessSessionId: string | null;
+}
+/**
+ * Presigned upload URLs for the sender's identity document.
+ * `uploadUrlBack` is null for single-sided documents (e.g. passport).
+ */
+export interface SenderIdDocument {
+    uploadUrlFront: string;
+    uploadUrlBack: string | null;
+}
+/**
+ * KYC sub-resource on a sender. `selfie`/`idDocument` are only present while
+ * the KYC state permits uploads (AWAITING_UPLOAD, or a retryable REJECTED/EXPIRED).
+ */
+export interface SenderKyc {
+    status: SenderKycStatus;
+    retryable: boolean | null;
+    rejectionReason: string | null;
+    selfie: SenderSelfie | null;
+    idDocument: SenderIdDocument | null;
+}
+export interface SenderFiatSettlement {
+    id: string;
+    toCurrency: string;
+    method: string;
+    pixDetails?: {
+        pixKey: string;
+        keyType?: string | null;
+    } | null;
+    ibanDetails?: {
+        iban: string;
+        bankAccount?: string | null;
+        bankBranch?: string | null;
+        bankAccountType?: string | null;
+    } | null;
+    cbuDetails?: {
+        cbu: string;
+        cvu?: string | null;
+    } | null;
+}
+export interface SenderKycInformation {
+    taxId: string;
+    taxIdCountry: string;
+    name: string;
+    email: string;
+}
+/**
+ * A sender as returned by the Public API.
+ * `createdAt`/`updatedAt` are ISO strings over HTTP (typed as `string | Date`
+ * to match the rest of the SDK's response models).
+ */
+export interface SenderResponse {
+    id: string;
+    name: string | null;
+    isActive: boolean;
+    projectId: string;
+    organizationId: string;
+    fromChain?: string | null;
+    fromAddress?: string | null;
+    fiatSettlement?: SenderFiatSettlement | null;
+    kycInformation?: SenderKycInformation | null;
+    kyc: SenderKyc | null;
+    createdAt: string | Date;
+    updatedAt: string | Date;
+}
+export type SenderDocumentType = 'ID' | 'PASSPORT' | 'DRIVERS-LICENSE';
+/**
+ * KYC information supplied when creating a sender.
+ * `name`, `email`, and `documentType` are required; the remaining fields are
+ * optional and may be supplied to satisfy higher KYC levels.
+ */
+export interface SenderKycInformationInput {
+    name: string;
+    email: string;
+    documentType: SenderDocumentType;
+    /**
+     * Whether the identity document has both a front and a back side to upload.
+     * When omitted the backend infers it from `documentType` (passport is
+     * single-sided; ID and driver's license are double-sided). Set it explicitly
+     * to override that default, e.g. to upload only the front of an ID. It drives
+     * whether a back upload URL is minted on the returned `kyc.idDocument`.
+     */
+    isDoubleSided?: boolean;
+    dateOfBirth?: string;
+    documentNumber?: string;
+    countryOfDocument?: string;
+    country?: string;
+    state?: string;
+    city?: string;
+    zipCode?: string;
+    streetAddress?: string;
+    phone?: string;
+    taxId?: string;
+    taxIdCountry?: string;
+}
+export interface CreateSenderParams {
+    taxId: string;
+    taxIdCountry: string;
+    kycInformation: SenderKycInformationInput;
+    fiatSettlementDetails?: {
+        toCurrency: string;
+        pixKey?: string;
+        bankAccount?: string;
+        bankBranch?: string;
+        bankAccountType?: string;
+        iban?: string;
+        cbuCvu?: string;
+    };
+}
+/**
+ * Response from POST /v1/senders.
+ *
+ * Carries the full sender (with nested `kyc`) plus `wasExisting`:
+ * - `wasExisting === false`: a new sender was created (HTTP 201).
+ * - `wasExisting === true`: an existing sender was returned/retried (HTTP 200).
+ *
+ * A terminal-rejection (HTTP 403) is surfaced as a `ForbiddenError`, not
+ * returned here.
+ */
+export type CreateSenderResponse = SenderResponse & {
+    wasExisting: boolean;
+};
+export interface ListSendersParams {
+    cursor?: string;
+    limit?: number;
+    /** Public KYC status filter. Accepts one value or a comma-separated list. */
+    kycStatus?: SenderKycStatus | string;
+    isActive?: boolean;
+    taxId?: string;
+    sort?: 'name' | 'createdAt';
+    order?: 'asc' | 'desc';
+}
+export interface ListSendersResponse {
+    data: SenderResponse[];
+    pagination: {
+        nextCursor: string | null;
+        hasMore: boolean;
+    };
+}
+//# sourceMappingURL=sender.d.ts.map

package/dist/types/types/sender.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sender.d.ts","sourceRoot":"","sources":["../../../src/types/sender.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,MAAM,MAAM,eAAe,GACvB,iBAAiB,GACjB,YAAY,GACZ,UAAU,GACV,UAAU,GACV,SAAS,CAAC;AAEd;;;;;;;GAOG;AACH,MAAM,WAAW,YAAY;IAC3B,MAAM,EAAE,UAAU,GAAG,WAAW,CAAC;IACjC,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,iBAAiB,EAAE,MAAM,GAAG,IAAI,CAAC;CAClC;AAED;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAC/B,cAAc,EAAE,MAAM,CAAC;IACvB,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;CAC9B;AAED;;;GAGG;AACH,MAAM,WAAW,SAAS;IACxB,MAAM,EAAE,eAAe,CAAC;IACxB,SAAS,EAAE,OAAO,GAAG,IAAI,CAAC;IAC1B,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B,MAAM,EAAE,YAAY,GAAG,IAAI,CAAC;IAC5B,UAAU,EAAE,gBAAgB,GAAG,IAAI,CAAC;CACrC;AAED,MAAM,WAAW,oBAAoB;IACnC,EAAE,EAAE,MAAM,CAAC;IACX,UAAU,EAAE,MAAM,CAAC;IACnB,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,CAAC,EAAE;QACX,MAAM,EAAE,MAAM,CAAC;QACf,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACzB,GAAG,IAAI,CAAC;IACT,WAAW,CAAC,EAAE;QACZ,IAAI,EAAE,MAAM,CAAC;QACb,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAC5B,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAC3B,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACjC,GAAG,IAAI,CAAC;IACT,UAAU,CAAC,EAAE;QACX,GAAG,EAAE,MAAM,CAAC;QACZ,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACrB,GAAG,IAAI,CAAC;CACV;AAED,MAAM,WAAW,oBAAoB;IACnC,KAAK,EAAE,MAAM,CAAC;IACd,YAAY,EAAE,MAAM,CAAC;IACrB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;;;GAIG;AACH,MAAM,WAAW,cAAc;IAC7B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IACpB,QAAQ,EAAE,OAAO,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,cAAc,EAAE,MAAM,CAAC;IACvB,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,cAAc,CAAC,EAAE,oBAAoB,GAAG,IAAI,CAAC;IAC7C,cAAc,CAAC,EAAE,oBAAoB,GAAG,IAAI,CAAC;IAC7C,GAAG,EAAE,SAAS,GAAG,IAAI,CAAC;IACtB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B;AAED,MAAM,MAAM,kBAAkB,GAAG,IAAI,GAAG,UAAU,GAAG,iBAAiB,CAAC;AAEvE;;;;GAIG;AACH,MAAM,WAAW,yBAAyB;IACxC,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,YAAY,EAAE,kBAAkB,CAAC;IACjC;;;;;;OAMG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,kBAAkB;IACjC,KAAK,EAAE,MAAM,CAAC;IACd,YAAY,EAAE,MAAM,CAAC;IACrB,cAAc,EAAE,yBAAyB,CAAC;IAC1C,qBAAqB,CAAC,EAAE;QACtB,UAAU,EAAE,MAAM,CAAC;QACnB,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,eAAe,CAAC,EAAE,MAAM,CAAC;QACzB,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,MAAM,CAAC,EAAE,MAAM,CAAC;KACjB,CAAC;CACH;AAED;;;;;;;;;GASG;AACH,MAAM,MAAM,oBAAoB,GAAG,cAAc,GAAG;IAClD,WAAW,EAAE,OAAO,CAAC;CACtB,CAAC;AAEF,MAAM,WAAW,iBAAiB;IAChC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,6EAA6E;IAC7E,SAAS,CAAC,EAAE,eAAe,GAAG,MAAM,CAAC;IACrC,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,IAAI,CAAC,EAAE,MAAM,GAAG,WAAW,CAAC;IAC5B,KAAK,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,mBAAmB;IAClC,IAAI,EAAE,cAAc,EAAE,CAAC;IACvB,UAAU,EAAE;QACV,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;QAC1B,OAAO,EAAE,OAAO,CAAC;KAClB,CAAC;CACH"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ordanetwork/sdk",
-  "version": "2.0.1",
+  "version": "2.1.0-beta.1",
   "description": "TypeScript SDK for orda API",
   "main": "./dist/cjs/index.js",
   "module": "./dist/esm/index.js",