@lightsparkdev/grid 0.2.1

package/resources/invitations.d.ts

@@ -0,0 +1,166 @@
+import { APIResource } from "../core/resource.js";
+import * as QuotesAPI from "./quotes.js";
+import { APIPromise } from "../core/api-promise.js";
+import { RequestOptions } from "../internal/request-options.js";
+export declare class Invitations extends APIResource {
+    /**
+     * Create an UMA invitation from a given platform customer.
+     *
+     * @example
+     * ```ts
+     * const umaInvitation = await client.invitations.create({
+     *   inviterUma: '$inviter@uma.domain',
+     * });
+     * ```
+     */
+    create(body: InvitationCreateParams, options?: RequestOptions): APIPromise<UmaInvitation>;
+    /**
+     * Retrieve details about an UMA invitation by its invitation code.
+     *
+     * @example
+     * ```ts
+     * const umaInvitation = await client.invitations.retrieve(
+     *   'invitationCode',
+     * );
+     * ```
+     */
+    retrieve(invitationCode: string, options?: RequestOptions): APIPromise<UmaInvitation>;
+    /**
+     * Cancel a pending UMA invitation. Only the inviter or platform can cancel an
+     * invitation.
+     *
+     * When an invitation is cancelled:
+     *
+     * 1. The invitation status changes from PENDING to CANCELLED
+     * 2. The invitation can no longer be claimed
+     * 3. The invitation URL will show as cancelled when accessed
+     *
+     * Only pending invitations can be cancelled. Attempting to cancel an invitation
+     * that is already claimed, expired, or cancelled will result in an error.
+     *
+     * @example
+     * ```ts
+     * const umaInvitation = await client.invitations.cancel(
+     *   'invitationCode',
+     * );
+     * ```
+     */
+    cancel(invitationCode: string, options?: RequestOptions): APIPromise<UmaInvitation>;
+    /**
+     * Claim an UMA invitation by associating it with an invitee UMA address.
+     *
+     * When an invitation is successfully claimed:
+     *
+     * 1. The invitation status changes from PENDING to CLAIMED
+     * 2. The invitee UMA address is associated with the invitation
+     * 3. An INVITATION_CLAIMED webhook is triggered to notify the platform that
+     *    created the invitation
+     *
+     * This endpoint allows customers to accept invitations sent to them by other UMA
+     * customers.
+     *
+     * @example
+     * ```ts
+     * const umaInvitation = await client.invitations.claim(
+     *   'invitationCode',
+     *   { inviteeUma: '$invitee@uma.domain' },
+     * );
+     * ```
+     */
+    claim(invitationCode: string, body: InvitationClaimParams, options?: RequestOptions): APIPromise<UmaInvitation>;
+}
+export interface CurrencyAmount {
+    /**
+     * Amount in the smallest unit of the currency (e.g., cents for USD/EUR, satoshis
+     * for BTC)
+     */
+    amount: number;
+    currency: QuotesAPI.Currency;
+}
+export interface UmaInvitation {
+    /**
+     * The unique code of the invitation
+     */
+    code: string;
+    /**
+     * When the invitation was created
+     */
+    createdAt: string;
+    /**
+     * The UMA address of the inviter
+     */
+    inviterUma: string;
+    /**
+     * The status of the invitation
+     */
+    status: 'PENDING' | 'CLAIMED' | 'EXPIRED' | 'CANCELLED';
+    /**
+     * The URL where this invitation can be claimed.
+     */
+    url: string;
+    /**
+     * The amount to send to the invitee when the invitation is claimed. This is
+     * optional and if not provided, the invitee will not receive any amount. Note that
+     * the actual sending of the amount must be done by the inviter platform once the
+     * INVITATION_CLAIMED webhook is received. If the inviter platform either does not
+     * send the payment or the payment fails, the invitee will not receive this amount.
+     * This field is primarily used for display purposes on the claiming side of the
+     * invitation. This field is useful for "send-by-link" style customer flows where
+     * an inviter can send a payment simply by sharing a link without knowing the
+     * receiver's UMA address. Note that these sends can only be sender-locked, meaning
+     * that the sender will not know ahead of time how much the receiver will receive
+     * in the receiving currency.
+     */
+    amountToSend?: CurrencyAmount;
+    /**
+     * When the invitation was claimed if it has been claimed
+     */
+    claimedAt?: string;
+    /**
+     * When the invitation expires (if at all)
+     */
+    expiresAt?: string;
+    /**
+     * The inviter's first name. Will be displayed when the recipient clicks the invite
+     * link
+     */
+    firstName?: string;
+    /**
+     * The UMA address of the invitee
+     */
+    inviteeUma?: string;
+}
+export interface InvitationCreateParams {
+    /**
+     * The UMA address of the customer creating the invitation
+     */
+    inviterUma: string;
+    /**
+     * An amount to send (in the smallest unit of the customer's currency) to the
+     * invitee when the invitation is claimed. This is optional and if not provided,
+     * the invitee will not receive any amount. Note that the actual sending of the
+     * amount must be done by the inviter platform once the INVITATION_CLAIMED webhook
+     * is received. If the inviter platform either does not send the payment or the
+     * payment fails, the invitee will not receive this amount. This field is primarily
+     * used for display purposes on the claiming side of the invitation.
+     */
+    amountToSend?: number;
+    /**
+     * When the invitation expires (if at all)
+     */
+    expiresAt?: string;
+    /**
+     * First name of the invitee to show as part of the invite
+     */
+    firstName?: string;
+}
+export interface InvitationClaimParams {
+    /**
+     * The UMA address of the customer claiming the invitation
+     */
+    inviteeUma: string;
+}
+export declare namespace Invitations {
+    export { type CurrencyAmount as CurrencyAmount, type UmaInvitation as UmaInvitation, type InvitationCreateParams as InvitationCreateParams, type InvitationClaimParams as InvitationClaimParams, };
+}
+//# sourceMappingURL=invitations.d.ts.map

package/resources/invitations.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"invitations.d.ts","sourceRoot":"","sources":["../src/resources/invitations.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,SAAS;OACd,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,WAAY,SAAQ,WAAW;IAC1C;;;;;;;;;OASG;IACH,MAAM,CAAC,IAAI,EAAE,sBAAsB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,aAAa,CAAC;IAIzF;;;;;;;;;OASG;IACH,QAAQ,CAAC,cAAc,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,aAAa,CAAC;IAIrF;;;;;;;;;;;;;;;;;;;OAmBG;IACH,MAAM,CAAC,cAAc,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,aAAa,CAAC;IAInF;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,KAAK,CACH,cAAc,EAAE,MAAM,EACtB,IAAI,EAAE,qBAAqB,EAC3B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,aAAa,CAAC;CAG7B;AAED,MAAM,WAAW,cAAc;IAC7B;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf,QAAQ,EAAE,SAAS,CAAC,QAAQ,CAAC;CAC9B;AAED,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,MAAM,EAAE,SAAS,GAAG,SAAS,GAAG,SAAS,GAAG,WAAW,CAAC;IAExD;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;;;;;;;;;;;OAYG;IACH,YAAY,CAAC,EAAE,cAAc,CAAC;IAE9B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;;;;;;OAQG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,CAAC,OAAO,WAAW,WAAW,CAAC;IACnC,OAAO,EACL,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,qBAAqB,IAAI,qBAAqB,GACpD,CAAC;CACH"}

package/resources/invitations.js

@@ -0,0 +1,83 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Invitations = void 0;
+const resource_1 = require("../core/resource.js");
+const path_1 = require("../internal/utils/path.js");
+class Invitations extends resource_1.APIResource {
+    /**
+     * Create an UMA invitation from a given platform customer.
+     *
+     * @example
+     * ```ts
+     * const umaInvitation = await client.invitations.create({
+     *   inviterUma: '$inviter@uma.domain',
+     * });
+     * ```
+     */
+    create(body, options) {
+        return this._client.post('/invitations', { body, ...options });
+    }
+    /**
+     * Retrieve details about an UMA invitation by its invitation code.
+     *
+     * @example
+     * ```ts
+     * const umaInvitation = await client.invitations.retrieve(
+     *   'invitationCode',
+     * );
+     * ```
+     */
+    retrieve(invitationCode, options) {
+        return this._client.get((0, path_1.path) `/invitations/${invitationCode}`, options);
+    }
+    /**
+     * Cancel a pending UMA invitation. Only the inviter or platform can cancel an
+     * invitation.
+     *
+     * When an invitation is cancelled:
+     *
+     * 1. The invitation status changes from PENDING to CANCELLED
+     * 2. The invitation can no longer be claimed
+     * 3. The invitation URL will show as cancelled when accessed
+     *
+     * Only pending invitations can be cancelled. Attempting to cancel an invitation
+     * that is already claimed, expired, or cancelled will result in an error.
+     *
+     * @example
+     * ```ts
+     * const umaInvitation = await client.invitations.cancel(
+     *   'invitationCode',
+     * );
+     * ```
+     */
+    cancel(invitationCode, options) {
+        return this._client.post((0, path_1.path) `/invitations/${invitationCode}/cancel`, options);
+    }
+    /**
+     * Claim an UMA invitation by associating it with an invitee UMA address.
+     *
+     * When an invitation is successfully claimed:
+     *
+     * 1. The invitation status changes from PENDING to CLAIMED
+     * 2. The invitee UMA address is associated with the invitation
+     * 3. An INVITATION_CLAIMED webhook is triggered to notify the platform that
+     *    created the invitation
+     *
+     * This endpoint allows customers to accept invitations sent to them by other UMA
+     * customers.
+     *
+     * @example
+     * ```ts
+     * const umaInvitation = await client.invitations.claim(
+     *   'invitationCode',
+     *   { inviteeUma: '$invitee@uma.domain' },
+     * );
+     * ```
+     */
+    claim(invitationCode, body, options) {
+        return this._client.post((0, path_1.path) `/invitations/${invitationCode}/claim`, { body, ...options });
+    }
+}
+exports.Invitations = Invitations;
+//# sourceMappingURL=invitations.js.map

package/resources/invitations.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"invitations.js","sourceRoot":"","sources":["../src/resources/invitations.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAI/C,oDAA8C;AAE9C,MAAa,WAAY,SAAQ,sBAAW;IAC1C;;;;;;;;;OASG;IACH,MAAM,CAAC,IAA4B,EAAE,OAAwB;QAC3D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,cAAc,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACjE,CAAC;IAED;;;;;;;;;OASG;IACH,QAAQ,CAAC,cAAsB,EAAE,OAAwB;QACvD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,gBAAgB,cAAc,EAAE,EAAE,OAAO,CAAC,CAAC;IACzE,CAAC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH,MAAM,CAAC,cAAsB,EAAE,OAAwB;QACrD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,gBAAgB,cAAc,SAAS,EAAE,OAAO,CAAC,CAAC;IACjF,CAAC;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,KAAK,CACH,cAAsB,EACtB,IAA2B,EAC3B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,gBAAgB,cAAc,QAAQ,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7F,CAAC;CACF;AAjFD,kCAiFC"}

package/resources/invitations.mjs

@@ -0,0 +1,79 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../core/resource.mjs";
+import { path } from "../internal/utils/path.mjs";
+export class Invitations extends APIResource {
+    /**
+     * Create an UMA invitation from a given platform customer.
+     *
+     * @example
+     * ```ts
+     * const umaInvitation = await client.invitations.create({
+     *   inviterUma: '$inviter@uma.domain',
+     * });
+     * ```
+     */
+    create(body, options) {
+        return this._client.post('/invitations', { body, ...options });
+    }
+    /**
+     * Retrieve details about an UMA invitation by its invitation code.
+     *
+     * @example
+     * ```ts
+     * const umaInvitation = await client.invitations.retrieve(
+     *   'invitationCode',
+     * );
+     * ```
+     */
+    retrieve(invitationCode, options) {
+        return this._client.get(path `/invitations/${invitationCode}`, options);
+    }
+    /**
+     * Cancel a pending UMA invitation. Only the inviter or platform can cancel an
+     * invitation.
+     *
+     * When an invitation is cancelled:
+     *
+     * 1. The invitation status changes from PENDING to CANCELLED
+     * 2. The invitation can no longer be claimed
+     * 3. The invitation URL will show as cancelled when accessed
+     *
+     * Only pending invitations can be cancelled. Attempting to cancel an invitation
+     * that is already claimed, expired, or cancelled will result in an error.
+     *
+     * @example
+     * ```ts
+     * const umaInvitation = await client.invitations.cancel(
+     *   'invitationCode',
+     * );
+     * ```
+     */
+    cancel(invitationCode, options) {
+        return this._client.post(path `/invitations/${invitationCode}/cancel`, options);
+    }
+    /**
+     * Claim an UMA invitation by associating it with an invitee UMA address.
+     *
+     * When an invitation is successfully claimed:
+     *
+     * 1. The invitation status changes from PENDING to CLAIMED
+     * 2. The invitee UMA address is associated with the invitation
+     * 3. An INVITATION_CLAIMED webhook is triggered to notify the platform that
+     *    created the invitation
+     *
+     * This endpoint allows customers to accept invitations sent to them by other UMA
+     * customers.
+     *
+     * @example
+     * ```ts
+     * const umaInvitation = await client.invitations.claim(
+     *   'invitationCode',
+     *   { inviteeUma: '$invitee@uma.domain' },
+     * );
+     * ```
+     */
+    claim(invitationCode, body, options) {
+        return this._client.post(path `/invitations/${invitationCode}/claim`, { body, ...options });
+    }
+}
+//# sourceMappingURL=invitations.mjs.map

package/resources/invitations.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"invitations.mjs","sourceRoot":"","sources":["../src/resources/invitations.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAIf,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,WAAY,SAAQ,WAAW;IAC1C;;;;;;;;;OASG;IACH,MAAM,CAAC,IAA4B,EAAE,OAAwB;QAC3D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,cAAc,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACjE,CAAC;IAED;;;;;;;;;OASG;IACH,QAAQ,CAAC,cAAsB,EAAE,OAAwB;QACvD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,gBAAgB,cAAc,EAAE,EAAE,OAAO,CAAC,CAAC;IACzE,CAAC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH,MAAM,CAAC,cAAsB,EAAE,OAAwB;QACrD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,gBAAgB,cAAc,SAAS,EAAE,OAAO,CAAC,CAAC;IACjF,CAAC;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,KAAK,CACH,cAAsB,EACtB,IAA2B,EAC3B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,gBAAgB,cAAc,QAAQ,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7F,CAAC;CACF"}

package/resources/plaid.d.mts

@@ -0,0 +1,101 @@
+import { APIResource } from "../core/resource.mjs";
+import * as ExternalAccountsAPI from "./customers/external-accounts.mjs";
+import { APIPromise } from "../core/api-promise.mjs";
+import { RequestOptions } from "../internal/request-options.mjs";
+export declare class Plaid extends APIResource {
+    /**
+     * Creates a Plaid Link token that can be used to initialize Plaid Link in your
+     * application. The Link token is used to authenticate the customer and allow them
+     * to select their bank account.
+     *
+     * **Async Flow:**
+     *
+     * 1. Platform calls this endpoint to get a link_token and callbackUrl
+     * 2. Platform displays Plaid Link UI to the end customer using the link_token
+     * 3. End customer authenticates with their bank and selects an account
+     * 4. Plaid returns a public_token to the platform
+     * 5. Platform POSTs the public_token to the callbackUrl
+     * 6. Lightspark exchanges the public_token with Plaid and creates the external
+     *    account asynchronously
+     * 7. Platform receives a webhook notification when the external account is ready
+     *
+     * @example
+     * ```ts
+     * const response = await client.plaid.createLinkToken({
+     *   customerId:
+     *     'Customer:019542f5-b3e7-1d02-0000-000000000001',
+     * });
+     * ```
+     */
+    createLinkToken(body: PlaidCreateLinkTokenParams, options?: RequestOptions): APIPromise<PlaidCreateLinkTokenResponse>;
+    /**
+     * After the customer completes Plaid Link authentication, the platform should POST
+     * the public_token to this callback URL (provided in the link token response).
+     *
+     * This will trigger asynchronous processing:
+     *
+     * 1. Lightspark exchanges the public_token for an access_token with Plaid
+     * 2. Lightspark retrieves and verifies the account details
+     * 3. An external account is created
+     * 4. A webhook notification is sent to the platform when complete
+     *
+     * @example
+     * ```ts
+     * const externalAccount =
+     *   await client.plaid.submitPublicToken(
+     *     'link-sandbox-abc123xyz-1234-5678',
+     *     {
+     *       publicToken:
+     *         'public-sandbox-12345678-1234-1234-1234-123456789012',
+     *       accountId: 'plaid_account_id_123',
+     *     },
+     *   );
+     * ```
+     */
+    submitPublicToken(plaidLinkToken: string, body: PlaidSubmitPublicTokenParams, options?: RequestOptions): APIPromise<ExternalAccountsAPI.ExternalAccount>;
+}
+export interface PlaidCreateLinkTokenResponse {
+    /**
+     * The URL where the platform should POST the public_token after the customer
+     * completes Plaid Link authentication. This will trigger asynchronous external
+     * account creation. The URL includes the linkToken as the path parameter.
+     */
+    callbackUrl: string;
+    /**
+     * The ISO 8601 timestamp when this link token expires. Link tokens typically
+     * expire after 4 hours.
+     */
+    expiration: string;
+    /**
+     * The Plaid Link token to be used to initialize Plaid Link in your application.
+     * This token is single-use and expires after the specified expiration time.
+     */
+    linkToken: string;
+    /**
+     * A unique identifier for this request, useful for debugging
+     */
+    requestId?: string;
+}
+export interface PlaidCreateLinkTokenParams {
+    /**
+     * The ID of the customer for whom to create the Plaid Link token and external
+     * account
+     */
+    customerId: string;
+}
+export interface PlaidSubmitPublicTokenParams {
+    /**
+     * The public token returned by Plaid Link after the customer successfully
+     * authenticates and selects an account.
+     */
+    publicToken: string;
+    /**
+     * Optional Plaid account ID if the customer selected a specific account. If not
+     * provided, the default account will be used.
+     */
+    accountId?: string;
+}
+export declare namespace Plaid {
+    export { type PlaidCreateLinkTokenResponse as PlaidCreateLinkTokenResponse, type PlaidCreateLinkTokenParams as PlaidCreateLinkTokenParams, type PlaidSubmitPublicTokenParams as PlaidSubmitPublicTokenParams, };
+}
+//# sourceMappingURL=plaid.d.mts.map

package/resources/plaid.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"plaid.d.mts","sourceRoot":"","sources":["../src/resources/plaid.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,mBAAmB;OACxB,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,KAAM,SAAQ,WAAW;IACpC;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,eAAe,CACb,IAAI,EAAE,0BAA0B,EAChC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,4BAA4B,CAAC;IAI3C;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,iBAAiB,CACf,cAAc,EAAE,MAAM,EACtB,IAAI,EAAE,4BAA4B,EAClC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,mBAAmB,CAAC,eAAe,CAAC;CAGnD;AAED,MAAM,WAAW,4BAA4B;IAC3C;;;;OAIG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,0BAA0B;IACzC;;;OAGG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,4BAA4B;IAC3C;;;OAGG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,OAAO,EACL,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,4BAA4B,IAAI,4BAA4B,GAClE,CAAC;CACH"}

package/resources/plaid.d.ts

@@ -0,0 +1,101 @@
+import { APIResource } from "../core/resource.js";
+import * as ExternalAccountsAPI from "./customers/external-accounts.js";
+import { APIPromise } from "../core/api-promise.js";
+import { RequestOptions } from "../internal/request-options.js";
+export declare class Plaid extends APIResource {
+    /**
+     * Creates a Plaid Link token that can be used to initialize Plaid Link in your
+     * application. The Link token is used to authenticate the customer and allow them
+     * to select their bank account.
+     *
+     * **Async Flow:**
+     *
+     * 1. Platform calls this endpoint to get a link_token and callbackUrl
+     * 2. Platform displays Plaid Link UI to the end customer using the link_token
+     * 3. End customer authenticates with their bank and selects an account
+     * 4. Plaid returns a public_token to the platform
+     * 5. Platform POSTs the public_token to the callbackUrl
+     * 6. Lightspark exchanges the public_token with Plaid and creates the external
+     *    account asynchronously
+     * 7. Platform receives a webhook notification when the external account is ready
+     *
+     * @example
+     * ```ts
+     * const response = await client.plaid.createLinkToken({
+     *   customerId:
+     *     'Customer:019542f5-b3e7-1d02-0000-000000000001',
+     * });
+     * ```
+     */
+    createLinkToken(body: PlaidCreateLinkTokenParams, options?: RequestOptions): APIPromise<PlaidCreateLinkTokenResponse>;
+    /**
+     * After the customer completes Plaid Link authentication, the platform should POST
+     * the public_token to this callback URL (provided in the link token response).
+     *
+     * This will trigger asynchronous processing:
+     *
+     * 1. Lightspark exchanges the public_token for an access_token with Plaid
+     * 2. Lightspark retrieves and verifies the account details
+     * 3. An external account is created
+     * 4. A webhook notification is sent to the platform when complete
+     *
+     * @example
+     * ```ts
+     * const externalAccount =
+     *   await client.plaid.submitPublicToken(
+     *     'link-sandbox-abc123xyz-1234-5678',
+     *     {
+     *       publicToken:
+     *         'public-sandbox-12345678-1234-1234-1234-123456789012',
+     *       accountId: 'plaid_account_id_123',
+     *     },
+     *   );
+     * ```
+     */
+    submitPublicToken(plaidLinkToken: string, body: PlaidSubmitPublicTokenParams, options?: RequestOptions): APIPromise<ExternalAccountsAPI.ExternalAccount>;
+}
+export interface PlaidCreateLinkTokenResponse {
+    /**
+     * The URL where the platform should POST the public_token after the customer
+     * completes Plaid Link authentication. This will trigger asynchronous external
+     * account creation. The URL includes the linkToken as the path parameter.
+     */
+    callbackUrl: string;
+    /**
+     * The ISO 8601 timestamp when this link token expires. Link tokens typically
+     * expire after 4 hours.
+     */
+    expiration: string;
+    /**
+     * The Plaid Link token to be used to initialize Plaid Link in your application.
+     * This token is single-use and expires after the specified expiration time.
+     */
+    linkToken: string;
+    /**
+     * A unique identifier for this request, useful for debugging
+     */
+    requestId?: string;
+}
+export interface PlaidCreateLinkTokenParams {
+    /**
+     * The ID of the customer for whom to create the Plaid Link token and external
+     * account
+     */
+    customerId: string;
+}
+export interface PlaidSubmitPublicTokenParams {
+    /**
+     * The public token returned by Plaid Link after the customer successfully
+     * authenticates and selects an account.
+     */
+    publicToken: string;
+    /**
+     * Optional Plaid account ID if the customer selected a specific account. If not
+     * provided, the default account will be used.
+     */
+    accountId?: string;
+}
+export declare namespace Plaid {
+    export { type PlaidCreateLinkTokenResponse as PlaidCreateLinkTokenResponse, type PlaidCreateLinkTokenParams as PlaidCreateLinkTokenParams, type PlaidSubmitPublicTokenParams as PlaidSubmitPublicTokenParams, };
+}
+//# sourceMappingURL=plaid.d.ts.map

package/resources/plaid.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"plaid.d.ts","sourceRoot":"","sources":["../src/resources/plaid.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,mBAAmB;OACxB,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,KAAM,SAAQ,WAAW;IACpC;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,eAAe,CACb,IAAI,EAAE,0BAA0B,EAChC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,4BAA4B,CAAC;IAI3C;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,iBAAiB,CACf,cAAc,EAAE,MAAM,EACtB,IAAI,EAAE,4BAA4B,EAClC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,mBAAmB,CAAC,eAAe,CAAC;CAGnD;AAED,MAAM,WAAW,4BAA4B;IAC3C;;;;OAIG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,0BAA0B;IACzC;;;OAGG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,4BAA4B;IAC3C;;;OAGG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,OAAO,EACL,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,4BAA4B,IAAI,4BAA4B,GAClE,CAAC;CACH"}

package/resources/plaid.js

@@ -0,0 +1,64 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Plaid = void 0;
+const resource_1 = require("../core/resource.js");
+const path_1 = require("../internal/utils/path.js");
+class Plaid extends resource_1.APIResource {
+    /**
+     * Creates a Plaid Link token that can be used to initialize Plaid Link in your
+     * application. The Link token is used to authenticate the customer and allow them
+     * to select their bank account.
+     *
+     * **Async Flow:**
+     *
+     * 1. Platform calls this endpoint to get a link_token and callbackUrl
+     * 2. Platform displays Plaid Link UI to the end customer using the link_token
+     * 3. End customer authenticates with their bank and selects an account
+     * 4. Plaid returns a public_token to the platform
+     * 5. Platform POSTs the public_token to the callbackUrl
+     * 6. Lightspark exchanges the public_token with Plaid and creates the external
+     *    account asynchronously
+     * 7. Platform receives a webhook notification when the external account is ready
+     *
+     * @example
+     * ```ts
+     * const response = await client.plaid.createLinkToken({
+     *   customerId:
+     *     'Customer:019542f5-b3e7-1d02-0000-000000000001',
+     * });
+     * ```
+     */
+    createLinkToken(body, options) {
+        return this._client.post('/plaid/link-tokens', { body, ...options });
+    }
+    /**
+     * After the customer completes Plaid Link authentication, the platform should POST
+     * the public_token to this callback URL (provided in the link token response).
+     *
+     * This will trigger asynchronous processing:
+     *
+     * 1. Lightspark exchanges the public_token for an access_token with Plaid
+     * 2. Lightspark retrieves and verifies the account details
+     * 3. An external account is created
+     * 4. A webhook notification is sent to the platform when complete
+     *
+     * @example
+     * ```ts
+     * const externalAccount =
+     *   await client.plaid.submitPublicToken(
+     *     'link-sandbox-abc123xyz-1234-5678',
+     *     {
+     *       publicToken:
+     *         'public-sandbox-12345678-1234-1234-1234-123456789012',
+     *       accountId: 'plaid_account_id_123',
+     *     },
+     *   );
+     * ```
+     */
+    submitPublicToken(plaidLinkToken, body, options) {
+        return this._client.post((0, path_1.path) `/plaid/callback/${plaidLinkToken}`, { body, ...options });
+    }
+}
+exports.Plaid = Plaid;
+//# sourceMappingURL=plaid.js.map

package/resources/plaid.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"plaid.js","sourceRoot":"","sources":["../src/resources/plaid.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAI/C,oDAA8C;AAE9C,MAAa,KAAM,SAAQ,sBAAW;IACpC;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,eAAe,CACb,IAAgC,EAChC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,oBAAoB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvE,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,iBAAiB,CACf,cAAsB,EACtB,IAAkC,EAClC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,mBAAmB,cAAc,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1F,CAAC;CACF;AA/DD,sBA+DC"}