@lightsparkdev/grid 0.2.1

package/resources/transactions.d.ts

@@ -0,0 +1,226 @@
+import { APIResource } from "../core/resource.js";
+import * as TransactionsAPI from "./transactions.js";
+import * as InvitationsAPI from "./invitations.js";
+import * as TransferInAPI from "./transfer-in.js";
+import { TransactionsDefaultPagination } from "./transfer-in.js";
+import { APIPromise } from "../core/api-promise.js";
+import { type DefaultPaginationParams, PagePromise } from "../core/pagination.js";
+import { RequestOptions } from "../internal/request-options.js";
+export declare class Transactions extends APIResource {
+    /**
+     * Retrieve detailed information about a specific transaction.
+     *
+     * @example
+     * ```ts
+     * const transaction = await client.transactions.retrieve(
+     *   'transactionId',
+     * );
+     * ```
+     */
+    retrieve(transactionID: string, options?: RequestOptions): APIPromise<TransferInAPI.Transaction>;
+    /**
+     * Retrieve a paginated list of transactions with optional filtering. The
+     * transactions can be filtered by customer ID, platform customer ID, UMA address,
+     * date range, status, and transaction type.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const transaction of client.transactions.list()) {
+     *   // ...
+     * }
+     * ```
+     */
+    list(query?: TransactionListParams | null | undefined, options?: RequestOptions): PagePromise<TransactionsDefaultPagination, TransferInAPI.Transaction>;
+    /**
+     * Approve a pending incoming payment that was previously acknowledged with a 202
+     * response. This endpoint allows platforms to asynchronously approve payments
+     * after async processing.
+     *
+     * @example
+     * ```ts
+     * const incomingTransaction =
+     *   await client.transactions.approve('transactionId');
+     * ```
+     */
+    approve(transactionID: string, body?: TransactionApproveParams | null | undefined, options?: RequestOptions): APIPromise<IncomingTransaction>;
+    /**
+     * Reject a pending incoming payment that was previously acknowledged with a 202
+     * response. This endpoint allows platforms to asynchronously reject payments after
+     * additional processing.
+     *
+     * @example
+     * ```ts
+     * const incomingTransaction =
+     *   await client.transactions.reject('transactionId');
+     * ```
+     */
+    reject(transactionID: string, body?: TransactionRejectParams | null | undefined, options?: RequestOptions): APIPromise<IncomingTransaction>;
+}
+export interface BaseTransactionSource {
+    /**
+     * Currency code for the source
+     */
+    currency?: string;
+}
+export interface IncomingTransaction extends TransferInAPI.Transaction {
+    /**
+     * Amount received in the recipient's currency
+     */
+    receivedAmount: InvitationsAPI.CurrencyAmount;
+    /**
+     * If the transaction failed, this field provides the reason for failure.
+     */
+    failureReason?: 'LNURLP_FAILED' | 'PAY_REQUEST_FAILED' | 'PAYMENT_APPROVAL_WEBHOOK_ERROR' | 'PAYMENT_APPROVAL_TIMED_OUT' | 'OFFRAMP_FAILED' | 'MISSING_MANDATORY_PAYEE_DATA' | 'QUOTE_EXPIRED' | 'QUOTE_EXECUTION_FAILED';
+    /**
+     * Details about the rate and fees for the transaction.
+     */
+    rateDetails?: IncomingTransaction.RateDetails;
+    /**
+     * Included for all transactions except those with "CREATED" status
+     */
+    reconciliationInstructions?: IncomingTransaction.ReconciliationInstructions;
+    /**
+     * Source account details
+     */
+    source?: TransactionSourceOneOf;
+}
+export declare namespace IncomingTransaction {
+    /**
+     * Details about the rate and fees for the transaction.
+     */
+    interface RateDetails {
+        /**
+         * The fixed fee charged by the Grid product to execute the quote in the smallest
+         * unit of the receiving currency (eg. cents).
+         */
+        gridApiFixedFee: number;
+        /**
+         * The underlying multiplier from the mSATS to the receiving currency, including
+         * variable fees.
+         */
+        gridApiMultiplier: number;
+        /**
+         * The variable fee amount charged by the Grid product to execute the quote in the
+         * smallest unit of the receiving currency (eg. cents). This is the receiving
+         * amount times gridApiVariableFeeRate.
+         */
+        gridApiVariableFeeAmount: number;
+        /**
+         * The variable fee rate charged by the Grid product to execute the quote as a
+         * percentage of the receiving currency amount.
+         */
+        gridApiVariableFeeRate: number;
+    }
+    /**
+     * Included for all transactions except those with "CREATED" status
+     */
+    interface ReconciliationInstructions {
+        /**
+         * Unique reference code that must be included with the payment to match it with
+         * the correct incoming transaction
+         */
+        reference: string;
+    }
+}
+/**
+ * Source account details
+ */
+export type TransactionSourceOneOf = TransactionSourceOneOf.AccountTransactionSource | TransactionSourceOneOf.UmaAddressTransactionSource;
+export declare namespace TransactionSourceOneOf {
+    /**
+     * Source account details
+     */
+    interface AccountTransactionSource extends TransactionsAPI.BaseTransactionSource {
+        /**
+         * Source account identifier
+         */
+        accountId: string;
+        sourceType: 'ACCOUNT';
+    }
+    /**
+     * UMA address source details
+     */
+    interface UmaAddressTransactionSource extends TransactionsAPI.BaseTransactionSource {
+        sourceType: 'UMA_ADDRESS';
+        /**
+         * UMA address of the sender
+         */
+        umaAddress: string;
+    }
+}
+/**
+ * Status of a payment transaction
+ */
+export type TransactionStatus = 'CREATED' | 'PENDING' | 'PROCESSING' | 'COMPLETED' | 'REJECTED' | 'FAILED' | 'REFUNDED' | 'EXPIRED';
+/**
+ * Type of transaction (incoming payment or outgoing payment)
+ */
+export type TransactionType = 'INCOMING' | 'OUTGOING';
+export interface TransactionListParams extends DefaultPaginationParams {
+    /**
+     * Filter by system customer ID
+     */
+    customerId?: string;
+    /**
+     * Filter by end date (inclusive) in ISO 8601 format
+     */
+    endDate?: string;
+    /**
+     * Maximum number of results to return (default 20, max 100)
+     */
+    limit?: number;
+    /**
+     * Filter by platform-specific customer ID
+     */
+    platformCustomerId?: string;
+    /**
+     * Filter by receiver account identifier
+     */
+    receiverAccountIdentifier?: string;
+    /**
+     * Filter by reference
+     */
+    reference?: string;
+    /**
+     * Filter by sender account identifier
+     */
+    senderAccountIdentifier?: string;
+    /**
+     * Order to sort results in
+     */
+    sortOrder?: 'asc' | 'desc';
+    /**
+     * Filter by start date (inclusive) in ISO 8601 format
+     */
+    startDate?: string;
+    /**
+     * Filter by transaction status
+     */
+    status?: TransactionStatus;
+    /**
+     * Filter by transaction type
+     */
+    type?: TransactionType;
+}
+export interface TransactionApproveParams {
+    /**
+     * Information about the recipient, provided by the platform if requested in the
+     * original webhook via `requestedReceiverCustomerInfoFields`.
+     */
+    receiverCustomerInfo?: {
+        [key: string]: unknown;
+    };
+}
+export interface TransactionRejectParams {
+    /**
+     * Optional reason for rejecting the payment. This is just for debugging purposes
+     * or can be used for a platform's own purposes.
+     */
+    reason?: string;
+}
+export declare namespace Transactions {
+    export { type BaseTransactionSource as BaseTransactionSource, type IncomingTransaction as IncomingTransaction, type TransactionSourceOneOf as TransactionSourceOneOf, type TransactionStatus as TransactionStatus, type TransactionType as TransactionType, type TransactionListParams as TransactionListParams, type TransactionApproveParams as TransactionApproveParams, type TransactionRejectParams as TransactionRejectParams, };
+}
+export { type TransactionsDefaultPagination };
+//# sourceMappingURL=transactions.d.ts.map

package/resources/transactions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"transactions.d.ts","sourceRoot":"","sources":["../src/resources/transactions.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,eAAe;OACpB,KAAK,cAAc;OACnB,KAAK,aAAa;OAClB,EAAE,6BAA6B,EAAE;OACjC,EAAE,UAAU,EAAE;OACd,EAAqB,KAAK,uBAAuB,EAAE,WAAW,EAAE;OAChE,EAAE,cAAc,EAAE;AAGzB,qBAAa,YAAa,SAAQ,WAAW;IAC3C;;;;;;;;;OASG;IACH,QAAQ,CAAC,aAAa,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,aAAa,CAAC,WAAW,CAAC;IAIhG;;;;;;;;;;;;OAYG;IACH,IAAI,CACF,KAAK,GAAE,qBAAqB,GAAG,IAAI,GAAG,SAAc,EACpD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,6BAA6B,EAAE,aAAa,CAAC,WAAW,CAAC;IAOxE;;;;;;;;;;OAUG;IACH,OAAO,CACL,aAAa,EAAE,MAAM,EACrB,IAAI,GAAE,wBAAwB,GAAG,IAAI,GAAG,SAAc,EACtD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,mBAAmB,CAAC;IAIlC;;;;;;;;;;OAUG;IACH,MAAM,CACJ,aAAa,EAAE,MAAM,EACrB,IAAI,GAAE,uBAAuB,GAAG,IAAI,GAAG,SAAc,EACrD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,mBAAmB,CAAC;CAGnC;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,mBAAoB,SAAQ,aAAa,CAAC,WAAW;IACpE;;OAEG;IACH,cAAc,EAAE,cAAc,CAAC,cAAc,CAAC;IAE9C;;OAEG;IACH,aAAa,CAAC,EACV,eAAe,GACf,oBAAoB,GACpB,gCAAgC,GAChC,4BAA4B,GAC5B,gBAAgB,GAChB,8BAA8B,GAC9B,eAAe,GACf,wBAAwB,CAAC;IAE7B;;OAEG;IACH,WAAW,CAAC,EAAE,mBAAmB,CAAC,WAAW,CAAC;IAE9C;;OAEG;IACH,0BAA0B,CAAC,EAAE,mBAAmB,CAAC,0BAA0B,CAAC;IAE5E;;OAEG;IACH,MAAM,CAAC,EAAE,sBAAsB,CAAC;CACjC;AAED,yBAAiB,mBAAmB,CAAC;IACnC;;OAEG;IACH,UAAiB,WAAW;QAC1B;;;WAGG;QACH,eAAe,EAAE,MAAM,CAAC;QAExB;;;WAGG;QACH,iBAAiB,EAAE,MAAM,CAAC;QAE1B;;;;WAIG;QACH,wBAAwB,EAAE,MAAM,CAAC;QAEjC;;;WAGG;QACH,sBAAsB,EAAE,MAAM,CAAC;KAChC;IAED;;OAEG;IACH,UAAiB,0BAA0B;QACzC;;;WAGG;QACH,SAAS,EAAE,MAAM,CAAC;KACnB;CACF;AAED;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAC9B,sBAAsB,CAAC,wBAAwB,GAC/C,sBAAsB,CAAC,2BAA2B,CAAC;AAEvD,yBAAiB,sBAAsB,CAAC;IACtC;;OAEG;IACH,UAAiB,wBAAyB,SAAQ,eAAe,CAAC,qBAAqB;QACrF;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB,UAAU,EAAE,SAAS,CAAC;KACvB;IAED;;OAEG;IACH,UAAiB,2BAA4B,SAAQ,eAAe,CAAC,qBAAqB;QACxF,UAAU,EAAE,aAAa,CAAC;QAE1B;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;KACpB;CACF;AAED;;GAEG;AACH,MAAM,MAAM,iBAAiB,GACzB,SAAS,GACT,SAAS,GACT,YAAY,GACZ,WAAW,GACX,UAAU,GACV,QAAQ,GACR,UAAU,GACV,SAAS,CAAC;AAEd;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,UAAU,GAAG,UAAU,CAAC;AAEtD,MAAM,WAAW,qBAAsB,SAAQ,uBAAuB;IACpE;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B;;OAEG;IACH,yBAAyB,CAAC,EAAE,MAAM,CAAC;IAEnC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,uBAAuB,CAAC,EAAE,MAAM,CAAC;IAEjC;;OAEG;IACH,SAAS,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC;IAE3B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,MAAM,CAAC,EAAE,iBAAiB,CAAC;IAE3B;;OAEG;IACH,IAAI,CAAC,EAAE,eAAe,CAAC;CACxB;AAED,MAAM,WAAW,wBAAwB;IACvC;;;OAGG;IACH,oBAAoB,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;CACnD;AAED,MAAM,WAAW,uBAAuB;IACtC;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,CAAC,OAAO,WAAW,YAAY,CAAC;IACpC,OAAO,EACL,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,uBAAuB,IAAI,uBAAuB,GACxD,CAAC;CACH;AAED,OAAO,EAAE,KAAK,6BAA6B,EAAE,CAAC"}

package/resources/transactions.js

@@ -0,0 +1,71 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Transactions = void 0;
+const resource_1 = require("../core/resource.js");
+const pagination_1 = require("../core/pagination.js");
+const path_1 = require("../internal/utils/path.js");
+class Transactions extends resource_1.APIResource {
+    /**
+     * Retrieve detailed information about a specific transaction.
+     *
+     * @example
+     * ```ts
+     * const transaction = await client.transactions.retrieve(
+     *   'transactionId',
+     * );
+     * ```
+     */
+    retrieve(transactionID, options) {
+        return this._client.get((0, path_1.path) `/transactions/${transactionID}`, options);
+    }
+    /**
+     * Retrieve a paginated list of transactions with optional filtering. The
+     * transactions can be filtered by customer ID, platform customer ID, UMA address,
+     * date range, status, and transaction type.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const transaction of client.transactions.list()) {
+     *   // ...
+     * }
+     * ```
+     */
+    list(query = {}, options) {
+        return this._client.getAPIList('/transactions', (pagination_1.DefaultPagination), {
+            query,
+            ...options,
+        });
+    }
+    /**
+     * Approve a pending incoming payment that was previously acknowledged with a 202
+     * response. This endpoint allows platforms to asynchronously approve payments
+     * after async processing.
+     *
+     * @example
+     * ```ts
+     * const incomingTransaction =
+     *   await client.transactions.approve('transactionId');
+     * ```
+     */
+    approve(transactionID, body = {}, options) {
+        return this._client.post((0, path_1.path) `/transactions/${transactionID}/approve`, { body, ...options });
+    }
+    /**
+     * Reject a pending incoming payment that was previously acknowledged with a 202
+     * response. This endpoint allows platforms to asynchronously reject payments after
+     * additional processing.
+     *
+     * @example
+     * ```ts
+     * const incomingTransaction =
+     *   await client.transactions.reject('transactionId');
+     * ```
+     */
+    reject(transactionID, body = {}, options) {
+        return this._client.post((0, path_1.path) `/transactions/${transactionID}/reject`, { body, ...options });
+    }
+}
+exports.Transactions = Transactions;
+//# sourceMappingURL=transactions.js.map

package/resources/transactions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"transactions.js","sourceRoot":"","sources":["../src/resources/transactions.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAM/C,sDAAkG;AAElG,oDAA8C;AAE9C,MAAa,YAAa,SAAQ,sBAAW;IAC3C;;;;;;;;;OASG;IACH,QAAQ,CAAC,aAAqB,EAAE,OAAwB;QACtD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,iBAAiB,aAAa,EAAE,EAAE,OAAO,CAAC,CAAC;IACzE,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,IAAI,CACF,QAAkD,EAAE,EACpD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,eAAe,EAAE,CAAA,8BAA4C,CAAA,EAAE;YAC5F,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;OAUG;IACH,OAAO,CACL,aAAqB,EACrB,OAAoD,EAAE,EACtD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,iBAAiB,aAAa,UAAU,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/F,CAAC;IAED;;;;;;;;;;OAUG;IACH,MAAM,CACJ,aAAqB,EACrB,OAAmD,EAAE,EACrD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,iBAAiB,aAAa,SAAS,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9F,CAAC;CACF;AA3ED,oCA2EC"}

package/resources/transactions.mjs

@@ -0,0 +1,67 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../core/resource.mjs";
+import { DefaultPagination } from "../core/pagination.mjs";
+import { path } from "../internal/utils/path.mjs";
+export class Transactions extends APIResource {
+    /**
+     * Retrieve detailed information about a specific transaction.
+     *
+     * @example
+     * ```ts
+     * const transaction = await client.transactions.retrieve(
+     *   'transactionId',
+     * );
+     * ```
+     */
+    retrieve(transactionID, options) {
+        return this._client.get(path `/transactions/${transactionID}`, options);
+    }
+    /**
+     * Retrieve a paginated list of transactions with optional filtering. The
+     * transactions can be filtered by customer ID, platform customer ID, UMA address,
+     * date range, status, and transaction type.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const transaction of client.transactions.list()) {
+     *   // ...
+     * }
+     * ```
+     */
+    list(query = {}, options) {
+        return this._client.getAPIList('/transactions', (DefaultPagination), {
+            query,
+            ...options,
+        });
+    }
+    /**
+     * Approve a pending incoming payment that was previously acknowledged with a 202
+     * response. This endpoint allows platforms to asynchronously approve payments
+     * after async processing.
+     *
+     * @example
+     * ```ts
+     * const incomingTransaction =
+     *   await client.transactions.approve('transactionId');
+     * ```
+     */
+    approve(transactionID, body = {}, options) {
+        return this._client.post(path `/transactions/${transactionID}/approve`, { body, ...options });
+    }
+    /**
+     * Reject a pending incoming payment that was previously acknowledged with a 202
+     * response. This endpoint allows platforms to asynchronously reject payments after
+     * additional processing.
+     *
+     * @example
+     * ```ts
+     * const incomingTransaction =
+     *   await client.transactions.reject('transactionId');
+     * ```
+     */
+    reject(transactionID, body = {}, options) {
+        return this._client.post(path `/transactions/${transactionID}/reject`, { body, ...options });
+    }
+}
+//# sourceMappingURL=transactions.mjs.map

package/resources/transactions.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"transactions.mjs","sourceRoot":"","sources":["../src/resources/transactions.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAMf,EAAE,iBAAiB,EAA6C;OAEhE,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,YAAa,SAAQ,WAAW;IAC3C;;;;;;;;;OASG;IACH,QAAQ,CAAC,aAAqB,EAAE,OAAwB;QACtD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,iBAAiB,aAAa,EAAE,EAAE,OAAO,CAAC,CAAC;IACzE,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,IAAI,CACF,QAAkD,EAAE,EACpD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,eAAe,EAAE,CAAA,iBAA4C,CAAA,EAAE;YAC5F,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;OAUG;IACH,OAAO,CACL,aAAqB,EACrB,OAAoD,EAAE,EACtD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,iBAAiB,aAAa,UAAU,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/F,CAAC;IAED;;;;;;;;;;OAUG;IACH,MAAM,CACJ,aAAqB,EACrB,OAAmD,EAAE,EACrD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,iBAAiB,aAAa,SAAS,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9F,CAAC;CACF"}

package/resources/transfer-in.d.mts

@@ -0,0 +1,154 @@
+import { APIResource } from "../core/resource.mjs";
+import * as TransferInAPI from "./transfer-in.mjs";
+import * as TransactionsAPI from "./transactions.mjs";
+import { APIPromise } from "../core/api-promise.mjs";
+import { DefaultPagination } from "../core/pagination.mjs";
+import { RequestOptions } from "../internal/request-options.mjs";
+export declare class TransferIn extends APIResource {
+    /**
+     * Transfer funds from an external account to an internal account for a specific
+     * customer. This endpoint should only be used for external account sources with
+     * pull functionality (e.g. ACH Pull). Otherwise, use the paymentInstructions on
+     * the internal account to deposit funds.
+     *
+     * @example
+     * ```ts
+     * const transaction = await client.transferIn.create({
+     *   destination: {
+     *     accountId:
+     *       'InternalAccount:a12dcbd6-dced-4ec4-b756-3c3a9ea3d123',
+     *   },
+     *   source: {
+     *     accountId:
+     *       'ExternalAccount:e85dcbd6-dced-4ec4-b756-3c3a9ea3d965',
+     *   },
+     *   amount: 12550,
+     * });
+     * ```
+     */
+    create(params: TransferInCreateParams, options?: RequestOptions): APIPromise<Transaction>;
+}
+export type TransactionsDefaultPagination = DefaultPagination<Transaction>;
+export interface BaseTransactionDestination {
+    /**
+     * Currency code for the destination
+     */
+    currency?: string;
+}
+export interface Transaction {
+    /**
+     * Unique identifier for the transaction
+     */
+    id: string;
+    /**
+     * System ID of the customer (sender for outgoing, recipient for incoming)
+     */
+    customerId: string;
+    /**
+     * Destination account details
+     */
+    destination: Transaction.AccountTransactionDestination | Transaction.UmaAddressTransactionDestination;
+    /**
+     * Platform-specific ID of the customer (sender for outgoing, recipient for
+     * incoming)
+     */
+    platformCustomerId: string;
+    /**
+     * Status of a payment transaction
+     */
+    status: TransactionsAPI.TransactionStatus;
+    /**
+     * Type of transaction (incoming payment or outgoing payment)
+     */
+    type: TransactionsAPI.TransactionType;
+    /**
+     * Additional information about the counterparty, if available and relevant to the
+     * transaction and platform. Only applicable for transactions to/from UMA
+     * addresses.
+     */
+    counterpartyInformation?: {
+        [key: string]: unknown;
+    };
+    /**
+     * When the transaction was created
+     */
+    createdAt?: string;
+    /**
+     * Optional memo or description for the payment
+     */
+    description?: string;
+    /**
+     * When the payment was or will be settled
+     */
+    settledAt?: string;
+    /**
+     * When the transaction was last updated
+     */
+    updatedAt?: string;
+}
+export declare namespace Transaction {
+    /**
+     * Destination account details
+     */
+    interface AccountTransactionDestination extends TransferInAPI.BaseTransactionDestination {
+        /**
+         * Destination account identifier
+         */
+        accountId: string;
+        destinationType: 'ACCOUNT';
+    }
+    /**
+     * UMA address destination details
+     */
+    interface UmaAddressTransactionDestination extends TransferInAPI.BaseTransactionDestination {
+        destinationType: 'UMA_ADDRESS';
+        /**
+         * UMA address of the recipient
+         */
+        umaAddress: string;
+    }
+}
+export interface TransferInCreateParams {
+    /**
+     * Body param: Destination internal account details
+     */
+    destination: TransferInCreateParams.Destination;
+    /**
+     * Body param: Source external account details
+     */
+    source: TransferInCreateParams.Source;
+    /**
+     * Body param: Amount in the smallest unit of the currency (e.g., cents for
+     * USD/EUR, satoshis for BTC)
+     */
+    amount?: number;
+    /**
+     * Header param: A unique identifier for the request. If the same key is sent
+     * multiple times, the server will return the same response as the first request.
+     */
+    'Idempotency-Key'?: string;
+}
+export declare namespace TransferInCreateParams {
+    /**
+     * Destination internal account details
+     */
+    interface Destination {
+        /**
+         * Reference to an internal account ID
+         */
+        accountId: string;
+    }
+    /**
+     * Source external account details
+     */
+    interface Source {
+        /**
+         * Reference to an external account ID
+         */
+        accountId: string;
+    }
+}
+export declare namespace TransferIn {
+    export { type BaseTransactionDestination as BaseTransactionDestination, type Transaction as Transaction, type TransferInCreateParams as TransferInCreateParams, };
+}
+//# sourceMappingURL=transfer-in.d.mts.map

package/resources/transfer-in.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"transfer-in.d.mts","sourceRoot":"","sources":["../src/resources/transfer-in.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,aAAa;OAClB,KAAK,eAAe;OACpB,EAAE,UAAU,EAAE;OACd,EAAE,iBAAiB,EAAE;OAErB,EAAE,cAAc,EAAE;AAEzB,qBAAa,UAAW,SAAQ,WAAW;IACzC;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,MAAM,CAAC,MAAM,EAAE,sBAAsB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,WAAW,CAAC;CAW1F;AAED,MAAM,MAAM,6BAA6B,GAAG,iBAAiB,CAAC,WAAW,CAAC,CAAC;AAE3E,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,WAAW,EAAE,WAAW,CAAC,6BAA6B,GAAG,WAAW,CAAC,gCAAgC,CAAC;IAEtG;;;OAGG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,MAAM,EAAE,eAAe,CAAC,iBAAiB,CAAC;IAE1C;;OAEG;IACH,IAAI,EAAE,eAAe,CAAC,eAAe,CAAC;IAEtC;;;;OAIG;IACH,uBAAuB,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAErD;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,yBAAiB,WAAW,CAAC;IAC3B;;OAEG;IACH,UAAiB,6BAA8B,SAAQ,aAAa,CAAC,0BAA0B;QAC7F;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB,eAAe,EAAE,SAAS,CAAC;KAC5B;IAED;;OAEG;IACH,UAAiB,gCAAiC,SAAQ,aAAa,CAAC,0BAA0B;QAChG,eAAe,EAAE,aAAa,CAAC;QAE/B;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;KACpB;CACF;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,WAAW,EAAE,sBAAsB,CAAC,WAAW,CAAC;IAEhD;;OAEG;IACH,MAAM,EAAE,sBAAsB,CAAC,MAAM,CAAC;IAEtC;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED,yBAAiB,sBAAsB,CAAC;IACtC;;OAEG;IACH,UAAiB,WAAW;QAC1B;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;KACnB;IAED;;OAEG;IACH,UAAiB,MAAM;QACrB;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;KACnB;CACF;AAED,MAAM,CAAC,OAAO,WAAW,UAAU,CAAC;IAClC,OAAO,EACL,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,sBAAsB,IAAI,sBAAsB,GACtD,CAAC;CACH"}