@lightsparkdev/grid 0.2.1

package/internal/utils/values.mjs

@@ -0,0 +1,94 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { LightsparkGridError } from "../../core/error.mjs";
+// https://url.spec.whatwg.org/#url-scheme-string
+const startsWithSchemeRegexp = /^[a-z][a-z0-9+.-]*:/i;
+export const isAbsoluteURL = (url) => {
+    return startsWithSchemeRegexp.test(url);
+};
+export let isArray = (val) => ((isArray = Array.isArray), isArray(val));
+export let isReadonlyArray = isArray;
+/** Returns an object if the given value isn't an object, otherwise returns as-is */
+export function maybeObj(x) {
+    if (typeof x !== 'object') {
+        return {};
+    }
+    return x ?? {};
+}
+// https://stackoverflow.com/a/34491287
+export function isEmptyObj(obj) {
+    if (!obj)
+        return true;
+    for (const _k in obj)
+        return false;
+    return true;
+}
+// https://eslint.org/docs/latest/rules/no-prototype-builtins
+export function hasOwn(obj, key) {
+    return Object.prototype.hasOwnProperty.call(obj, key);
+}
+export function isObj(obj) {
+    return obj != null && typeof obj === 'object' && !Array.isArray(obj);
+}
+export const ensurePresent = (value) => {
+    if (value == null) {
+        throw new LightsparkGridError(`Expected a value to be given but received ${value} instead.`);
+    }
+    return value;
+};
+export const validatePositiveInteger = (name, n) => {
+    if (typeof n !== 'number' || !Number.isInteger(n)) {
+        throw new LightsparkGridError(`${name} must be an integer`);
+    }
+    if (n < 0) {
+        throw new LightsparkGridError(`${name} must be a positive integer`);
+    }
+    return n;
+};
+export const coerceInteger = (value) => {
+    if (typeof value === 'number')
+        return Math.round(value);
+    if (typeof value === 'string')
+        return parseInt(value, 10);
+    throw new LightsparkGridError(`Could not coerce ${value} (type: ${typeof value}) into a number`);
+};
+export const coerceFloat = (value) => {
+    if (typeof value === 'number')
+        return value;
+    if (typeof value === 'string')
+        return parseFloat(value);
+    throw new LightsparkGridError(`Could not coerce ${value} (type: ${typeof value}) into a number`);
+};
+export const coerceBoolean = (value) => {
+    if (typeof value === 'boolean')
+        return value;
+    if (typeof value === 'string')
+        return value === 'true';
+    return Boolean(value);
+};
+export const maybeCoerceInteger = (value) => {
+    if (value == null) {
+        return undefined;
+    }
+    return coerceInteger(value);
+};
+export const maybeCoerceFloat = (value) => {
+    if (value == null) {
+        return undefined;
+    }
+    return coerceFloat(value);
+};
+export const maybeCoerceBoolean = (value) => {
+    if (value == null) {
+        return undefined;
+    }
+    return coerceBoolean(value);
+};
+export const safeJSON = (text) => {
+    try {
+        return JSON.parse(text);
+    }
+    catch (err) {
+        return undefined;
+    }
+};
+//# sourceMappingURL=values.mjs.map

package/internal/utils/values.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"values.mjs","sourceRoot":"","sources":["../../src/internal/utils/values.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,mBAAmB,EAAE;AAE9B,iDAAiD;AACjD,MAAM,sBAAsB,GAAG,sBAAsB,CAAC;AAEtD,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,GAAW,EAAW,EAAE;IACpD,OAAO,sBAAsB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAC1C,CAAC,CAAC;AAEF,MAAM,CAAC,IAAI,OAAO,GAAG,CAAC,GAAY,EAAoB,EAAE,CAAC,CAAC,CAAC,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC;AACnG,MAAM,CAAC,IAAI,eAAe,GAAG,OAAsD,CAAC;AAEpF,oFAAoF;AACpF,MAAM,UAAU,QAAQ,CAAC,CAAU;IACjC,IAAI,OAAO,CAAC,KAAK,QAAQ,EAAE,CAAC;QAC1B,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,OAAO,CAAC,IAAI,EAAE,CAAC;AACjB,CAAC;AAED,uCAAuC;AACvC,MAAM,UAAU,UAAU,CAAC,GAA8B;IACvD,IAAI,CAAC,GAAG;QAAE,OAAO,IAAI,CAAC;IACtB,KAAK,MAAM,EAAE,IAAI,GAAG;QAAE,OAAO,KAAK,CAAC;IACnC,OAAO,IAAI,CAAC;AACd,CAAC;AAED,6DAA6D;AAC7D,MAAM,UAAU,MAAM,CAA4B,GAAM,EAAE,GAAgB;IACxE,OAAO,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;AACxD,CAAC;AAED,MAAM,UAAU,KAAK,CAAC,GAAY;IAChC,OAAO,GAAG,IAAI,IAAI,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;AACvE,CAAC;AAED,MAAM,CAAC,MAAM,aAAa,GAAG,CAAI,KAA2B,EAAK,EAAE;IACjE,IAAI,KAAK,IAAI,IAAI,EAAE,CAAC;QAClB,MAAM,IAAI,mBAAmB,CAAC,6CAA6C,KAAK,WAAW,CAAC,CAAC;IAC/F,CAAC;IAED,OAAO,KAAK,CAAC;AACf,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,uBAAuB,GAAG,CAAC,IAAY,EAAE,CAAU,EAAU,EAAE;IAC1E,IAAI,OAAO,CAAC,KAAK,QAAQ,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC;QAClD,MAAM,IAAI,mBAAmB,CAAC,GAAG,IAAI,qBAAqB,CAAC,CAAC;IAC9D,CAAC;IACD,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;QACV,MAAM,IAAI,mBAAmB,CAAC,GAAG,IAAI,6BAA6B,CAAC,CAAC;IACtE,CAAC;IACD,OAAO,CAAC,CAAC;AACX,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,KAAc,EAAU,EAAE;IACtD,IAAI,OAAO,KAAK,KAAK,QAAQ;QAAE,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IACxD,IAAI,OAAO,KAAK,KAAK,QAAQ;QAAE,OAAO,QAAQ,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;IAE1D,MAAM,IAAI,mBAAmB,CAAC,oBAAoB,KAAK,WAAW,OAAO,KAAK,iBAAiB,CAAC,CAAC;AACnG,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,KAAc,EAAU,EAAE;IACpD,IAAI,OAAO,KAAK,KAAK,QAAQ;QAAE,OAAO,KAAK,CAAC;IAC5C,IAAI,OAAO,KAAK,KAAK,QAAQ;QAAE,OAAO,UAAU,CAAC,KAAK,CAAC,CAAC;IAExD,MAAM,IAAI,mBAAmB,CAAC,oBAAoB,KAAK,WAAW,OAAO,KAAK,iBAAiB,CAAC,CAAC;AACnG,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,KAAc,EAAW,EAAE;IACvD,IAAI,OAAO,KAAK,KAAK,SAAS;QAAE,OAAO,KAAK,CAAC;IAC7C,IAAI,OAAO,KAAK,KAAK,QAAQ;QAAE,OAAO,KAAK,KAAK,MAAM,CAAC;IACvD,OAAO,OAAO,CAAC,KAAK,CAAC,CAAC;AACxB,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,KAAc,EAAsB,EAAE;IACvE,IAAI,KAAK,IAAI,IAAI,EAAE,CAAC;QAClB,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,OAAO,aAAa,CAAC,KAAK,CAAC,CAAC;AAC9B,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,KAAc,EAAsB,EAAE;IACrE,IAAI,KAAK,IAAI,IAAI,EAAE,CAAC;QAClB,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,OAAO,WAAW,CAAC,KAAK,CAAC,CAAC;AAC5B,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,KAAc,EAAuB,EAAE;IACxE,IAAI,KAAK,IAAI,IAAI,EAAE,CAAC;QAClB,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,OAAO,aAAa,CAAC,KAAK,CAAC,CAAC;AAC9B,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,QAAQ,GAAG,CAAC,IAAY,EAAE,EAAE;IACvC,IAAI,CAAC;QACH,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAC1B,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,OAAO,SAAS,CAAC;IACnB,CAAC;AACH,CAAC,CAAC"}

package/internal/utils.d.mts

@@ -0,0 +1,7 @@
+export * from "./utils/values.mjs";
+export * from "./utils/base64.mjs";
+export * from "./utils/env.mjs";
+export * from "./utils/log.mjs";
+export * from "./utils/uuid.mjs";
+export * from "./utils/sleep.mjs";
+//# sourceMappingURL=utils.d.mts.map

package/internal/utils.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.mts","sourceRoot":"","sources":["../src/internal/utils.ts"],"names":[],"mappings":""}

package/internal/utils.d.ts

@@ -0,0 +1,7 @@
+export * from "./utils/values.js";
+export * from "./utils/base64.js";
+export * from "./utils/env.js";
+export * from "./utils/log.js";
+export * from "./utils/uuid.js";
+export * from "./utils/sleep.js";
+//# sourceMappingURL=utils.d.ts.map

package/internal/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/internal/utils.ts"],"names":[],"mappings":""}

package/internal/utils.js

@@ -0,0 +1,11 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("./tslib.js");
+tslib_1.__exportStar(require("./utils/values.js"), exports);
+tslib_1.__exportStar(require("./utils/base64.js"), exports);
+tslib_1.__exportStar(require("./utils/env.js"), exports);
+tslib_1.__exportStar(require("./utils/log.js"), exports);
+tslib_1.__exportStar(require("./utils/uuid.js"), exports);
+tslib_1.__exportStar(require("./utils/sleep.js"), exports);
+//# sourceMappingURL=utils.js.map

package/internal/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../src/internal/utils.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,4DAA+B;AAC/B,4DAA+B;AAC/B,yDAA4B;AAC5B,yDAA4B;AAC5B,0DAA6B;AAC7B,2DAA8B"}

package/internal/utils.mjs

@@ -0,0 +1,8 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+export * from "./utils/values.mjs";
+export * from "./utils/base64.mjs";
+export * from "./utils/env.mjs";
+export * from "./utils/log.mjs";
+export * from "./utils/uuid.mjs";
+export * from "./utils/sleep.mjs";
+//# sourceMappingURL=utils.mjs.map

package/internal/utils.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.mjs","sourceRoot":"","sources":["../src/internal/utils.ts"],"names":[],"mappings":"AAAA,sFAAsF"}

package/package.json

@@ -0,0 +1,147 @@
+{
+  "name": "@lightsparkdev/grid",
+  "version": "0.2.1",
+  "description": "The official TypeScript library for the Lightspark Grid API",
+  "author": "Lightspark Grid <support@lightspark.com>",
+  "types": "./index.d.ts",
+  "main": "./index.js",
+  "type": "commonjs",
+  "repository": "github:lightsparkdev/grid-js-sdk",
+  "license": "Apache-2.0",
+  "files": [
+    "**/*"
+  ],
+  "private": false,
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {},
+  "exports": {
+    ".": {
+      "require": {
+        "types": "./index.d.ts",
+        "default": "./index.js"
+      },
+      "types": "./index.d.mts",
+      "default": "./index.mjs"
+    },
+    "./api-promise": {
+      "import": "./api-promise.mjs",
+      "require": "./api-promise.js"
+    },
+    "./api-promise.js": {
+      "default": "./api-promise.js"
+    },
+    "./api-promise.mjs": {
+      "default": "./api-promise.mjs"
+    },
+    "./client": {
+      "import": "./client.mjs",
+      "require": "./client.js"
+    },
+    "./client.js": {
+      "default": "./client.js"
+    },
+    "./client.mjs": {
+      "default": "./client.mjs"
+    },
+    "./core/*.mjs": {
+      "default": "./core/*.mjs"
+    },
+    "./core/*.js": {
+      "default": "./core/*.js"
+    },
+    "./core/*": {
+      "import": "./core/*.mjs",
+      "require": "./core/*.js"
+    },
+    "./error": {
+      "import": "./error.mjs",
+      "require": "./error.js"
+    },
+    "./error.js": {
+      "default": "./error.js"
+    },
+    "./error.mjs": {
+      "default": "./error.mjs"
+    },
+    "./index": {
+      "import": "./index.mjs",
+      "require": "./index.js"
+    },
+    "./index.js": {
+      "default": "./index.js"
+    },
+    "./index.mjs": {
+      "default": "./index.mjs"
+    },
+    "./pagination": {
+      "import": "./pagination.mjs",
+      "require": "./pagination.js"
+    },
+    "./pagination.js": {
+      "default": "./pagination.js"
+    },
+    "./pagination.mjs": {
+      "default": "./pagination.mjs"
+    },
+    "./resource": {
+      "import": "./resource.mjs",
+      "require": "./resource.js"
+    },
+    "./resource.js": {
+      "default": "./resource.js"
+    },
+    "./resource.mjs": {
+      "default": "./resource.mjs"
+    },
+    "./resources/*.mjs": {
+      "default": "./resources/*.mjs"
+    },
+    "./resources/*.js": {
+      "default": "./resources/*.js"
+    },
+    "./resources/*": {
+      "import": "./resources/*.mjs",
+      "require": "./resources/*.js"
+    },
+    "./resources": {
+      "import": "./resources.mjs",
+      "require": "./resources.js"
+    },
+    "./resources.js": {
+      "default": "./resources.js"
+    },
+    "./resources.mjs": {
+      "default": "./resources.mjs"
+    },
+    "./uploads": {
+      "import": "./uploads.mjs",
+      "require": "./uploads.js"
+    },
+    "./uploads.js": {
+      "default": "./uploads.js"
+    },
+    "./uploads.mjs": {
+      "default": "./uploads.mjs"
+    },
+    "./version": {
+      "import": "./version.mjs",
+      "require": "./version.js"
+    },
+    "./version.js": {
+      "default": "./version.js"
+    },
+    "./version.mjs": {
+      "default": "./version.mjs"
+    }
+  },
+  "scripts": {
+    "test": "./scripts/test",
+    "build": "./scripts/build",
+    "format": "./scripts/format",
+    "tsn": "ts-node -r tsconfig-paths/register",
+    "lint": "./scripts/lint",
+    "fix": "./scripts/format"
+  }
+}

package/pagination.d.mts

@@ -0,0 +1,2 @@
+export * from "./core/pagination.mjs";
+//# sourceMappingURL=pagination.d.mts.map

package/pagination.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"pagination.d.mts","sourceRoot":"","sources":["src/pagination.ts"],"names":[],"mappings":""}

package/pagination.d.ts

@@ -0,0 +1,2 @@
+export * from "./core/pagination.js";
+//# sourceMappingURL=pagination.d.ts.map

package/pagination.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"pagination.d.ts","sourceRoot":"","sources":["src/pagination.ts"],"names":[],"mappings":""}

package/pagination.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("./internal/tslib.js");
+/** @deprecated Import from ./core/pagination instead */
+tslib_1.__exportStar(require("./core/pagination.js"), exports);
+//# sourceMappingURL=pagination.js.map

package/pagination.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"pagination.js","sourceRoot":"","sources":["src/pagination.ts"],"names":[],"mappings":";;;AAAA,wDAAwD;AACxD,+DAAkC"}

package/pagination.mjs

@@ -0,0 +1,2 @@
+export * from "./core/pagination.mjs";
+//# sourceMappingURL=pagination.mjs.map

package/pagination.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"pagination.mjs","sourceRoot":"","sources":["src/pagination.ts"],"names":[],"mappings":""}

package/resource.d.mts

@@ -0,0 +1,2 @@
+export * from "./core/resource.mjs";
+//# sourceMappingURL=resource.d.mts.map

package/resource.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"resource.d.mts","sourceRoot":"","sources":["src/resource.ts"],"names":[],"mappings":""}

package/resource.d.ts

@@ -0,0 +1,2 @@
+export * from "./core/resource.js";
+//# sourceMappingURL=resource.d.ts.map

package/resource.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"resource.d.ts","sourceRoot":"","sources":["src/resource.ts"],"names":[],"mappings":""}

package/resource.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("./internal/tslib.js");
+/** @deprecated Import from ./core/resource instead */
+tslib_1.__exportStar(require("./core/resource.js"), exports);
+//# sourceMappingURL=resource.js.map

package/resource.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"resource.js","sourceRoot":"","sources":["src/resource.ts"],"names":[],"mappings":";;;AAAA,sDAAsD;AACtD,6DAAgC"}

package/resource.mjs

@@ -0,0 +1,2 @@
+export * from "./core/resource.mjs";
+//# sourceMappingURL=resource.mjs.map

package/resource.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"resource.mjs","sourceRoot":"","sources":["src/resource.ts"],"names":[],"mappings":""}

package/resources/config.d.mts

@@ -0,0 +1,130 @@
+import { APIResource } from "../core/resource.mjs";
+import * as ReceiverAPI from "./receiver.mjs";
+import * as TransactionsAPI from "./transactions.mjs";
+import { APIPromise } from "../core/api-promise.mjs";
+import { RequestOptions } from "../internal/request-options.mjs";
+export declare class Config extends APIResource {
+    /**
+     * Retrieve the current platform configuration
+     *
+     * @example
+     * ```ts
+     * const platformConfig = await client.config.retrieve();
+     * ```
+     */
+    retrieve(options?: RequestOptions): APIPromise<PlatformConfig>;
+    /**
+     * Update the platform configuration settings
+     *
+     * @example
+     * ```ts
+     * const platformConfig = await client.config.update({
+     *   supportedCurrencies: [
+     *     {
+     *       currencyCode: 'USD',
+     *       minAmount: 100,
+     *       maxAmount: 1000000,
+     *       enabledTransactionTypes: ['OUTGOING', 'INCOMING'],
+     *       requiredCounterpartyFields: [
+     *         { name: 'FULL_NAME', mandatory: true },
+     *         { name: 'NATIONALITY', mandatory: true },
+     *         { name: 'BIRTH_DATE', mandatory: true },
+     *       ],
+     *     },
+     *   ],
+     *   umaDomain: 'mycompany.com',
+     *   webhookEndpoint: 'https://api.mycompany.com/webhooks/uma',
+     * });
+     * ```
+     */
+    update(body: ConfigUpdateParams, options?: RequestOptions): APIPromise<PlatformConfig>;
+}
+/**
+ * Name of a type of field containing info about a platform's customer or
+ * counterparty customer.
+ */
+export type CustomerInfoFieldName = 'FULL_NAME' | 'BIRTH_DATE' | 'NATIONALITY' | 'PHONE_NUMBER' | 'EMAIL' | 'POSTAL_ADDRESS' | 'TAX_ID' | 'REGISTRATION_NUMBER' | 'USER_TYPE' | 'COUNTRY_OF_RESIDENCE' | 'ACCOUNT_IDENTIFIER' | 'FI_LEGAL_ENTITY_NAME' | 'FI_ADDRESS' | 'PURPOSE_OF_PAYMENT' | 'ULTIMATE_INSTITUTION_COUNTRY' | 'IDENTIFIER';
+export interface PlatformConfig {
+    /**
+     * System-generated unique identifier
+     */
+    id?: string;
+    /**
+     * Creation timestamp
+     */
+    createdAt?: string;
+    /**
+     * Whether the platform is a regulated financial institution. This is used to
+     * determine if the platform's customers must be KYC/KYB'd by Lightspark via the
+     * KYC link flow. This can only be set by Lightspark during platform creation.
+     */
+    isRegulatedFinancialInstitution?: boolean;
+    /**
+     * The subdomain that incoming requests will be proxied to
+     */
+    proxyUmaSubdomain?: string;
+    /**
+     * List of currencies supported by the platform. This is what the platform's
+     * customers are able to hold, send, and receive.
+     */
+    supportedCurrencies?: Array<PlatformCurrencyConfig>;
+    /**
+     * UMA domain for this platform
+     */
+    umaDomain?: string;
+    /**
+     * Last update timestamp
+     */
+    updatedAt?: string;
+    /**
+     * URL where webhook notifications will be sent
+     */
+    webhookEndpoint?: string;
+}
+export interface PlatformCurrencyConfig {
+    /**
+     * Three-letter currency code (ISO 4217)
+     */
+    currencyCode: string;
+    /**
+     * List of transaction types that are enabled for this currency.
+     */
+    enabledTransactionTypes: Array<TransactionsAPI.TransactionType>;
+    /**
+     * Maximum amount that can be sent in the smallest unit of this currency
+     */
+    maxAmount: number;
+    /**
+     * Minimum amount that can be sent in the smallest unit of this currency
+     */
+    minAmount: number;
+    /**
+     * List of fields which the platform requires from the counterparty institutions
+     * about counterparty customers. Platforms can set mandatory to false if the
+     * platform does not require the field, but would like to have it available. Some
+     * fields may be required by the underlying UMA provider.
+     */
+    requiredCounterpartyFields: Array<ReceiverAPI.CounterpartyFieldDefinition>;
+    /**
+     * List of fields that are required by the underlying UMA provider for this
+     * currency. If the counterparty does not provide these fields, quote requests will
+     * fail.
+     */
+    providerRequiredCounterpartyCustomerFields?: Array<CustomerInfoFieldName>;
+    /**
+     * List of customer info field names that are required by the underlying UMA
+     * provider when creating a customer for this currency. These fields must be
+     * supplied when creating or updating a customer if this currency is intended to be
+     * used by that customer. If no fields are required, this field is omitted.
+     */
+    providerRequiredCustomerFields?: Array<CustomerInfoFieldName>;
+}
+export interface ConfigUpdateParams {
+    supportedCurrencies?: Array<PlatformCurrencyConfig>;
+    umaDomain?: string;
+    webhookEndpoint?: string;
+}
+export declare namespace Config {
+    export { type CustomerInfoFieldName as CustomerInfoFieldName, type PlatformConfig as PlatformConfig, type PlatformCurrencyConfig as PlatformCurrencyConfig, type ConfigUpdateParams as ConfigUpdateParams, };
+}
+//# sourceMappingURL=config.d.mts.map

package/resources/config.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.d.mts","sourceRoot":"","sources":["../src/resources/config.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,WAAW;OAChB,KAAK,eAAe;OACpB,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB,qBAAa,MAAO,SAAQ,WAAW;IACrC;;;;;;;OAOG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,cAAc,CAAC;IAI9D;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,MAAM,CAAC,IAAI,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,cAAc,CAAC;CAGvF;AAED;;;GAGG;AACH,MAAM,MAAM,qBAAqB,GAC7B,WAAW,GACX,YAAY,GACZ,aAAa,GACb,cAAc,GACd,OAAO,GACP,gBAAgB,GAChB,QAAQ,GACR,qBAAqB,GACrB,WAAW,GACX,sBAAsB,GACtB,oBAAoB,GACpB,sBAAsB,GACtB,YAAY,GACZ,oBAAoB,GACpB,8BAA8B,GAC9B,YAAY,CAAC;AAEjB,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;;OAIG;IACH,+BAA+B,CAAC,EAAE,OAAO,CAAC;IAE1C;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;;OAGG;IACH,mBAAmB,CAAC,EAAE,KAAK,CAAC,sBAAsB,CAAC,CAAC;IAEpD;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,uBAAuB,EAAE,KAAK,CAAC,eAAe,CAAC,eAAe,CAAC,CAAC;IAEhE;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;;;OAKG;IACH,0BAA0B,EAAE,KAAK,CAAC,WAAW,CAAC,2BAA2B,CAAC,CAAC;IAE3E;;;;OAIG;IACH,0CAA0C,CAAC,EAAE,KAAK,CAAC,qBAAqB,CAAC,CAAC;IAE1E;;;;;OAKG;IACH,8BAA8B,CAAC,EAAE,KAAK,CAAC,qBAAqB,CAAC,CAAC;CAC/D;AAED,MAAM,WAAW,kBAAkB;IACjC,mBAAmB,CAAC,EAAE,KAAK,CAAC,sBAAsB,CAAC,CAAC;IAEpD,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,MAAM,CAAC,OAAO,WAAW,MAAM,CAAC;IAC9B,OAAO,EACL,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,kBAAkB,IAAI,kBAAkB,GAC9C,CAAC;CACH"}

package/resources/config.d.ts

@@ -0,0 +1,130 @@
+import { APIResource } from "../core/resource.js";
+import * as ReceiverAPI from "./receiver.js";
+import * as TransactionsAPI from "./transactions.js";
+import { APIPromise } from "../core/api-promise.js";
+import { RequestOptions } from "../internal/request-options.js";
+export declare class Config extends APIResource {
+    /**
+     * Retrieve the current platform configuration
+     *
+     * @example
+     * ```ts
+     * const platformConfig = await client.config.retrieve();
+     * ```
+     */
+    retrieve(options?: RequestOptions): APIPromise<PlatformConfig>;
+    /**
+     * Update the platform configuration settings
+     *
+     * @example
+     * ```ts
+     * const platformConfig = await client.config.update({
+     *   supportedCurrencies: [
+     *     {
+     *       currencyCode: 'USD',
+     *       minAmount: 100,
+     *       maxAmount: 1000000,
+     *       enabledTransactionTypes: ['OUTGOING', 'INCOMING'],
+     *       requiredCounterpartyFields: [
+     *         { name: 'FULL_NAME', mandatory: true },
+     *         { name: 'NATIONALITY', mandatory: true },
+     *         { name: 'BIRTH_DATE', mandatory: true },
+     *       ],
+     *     },
+     *   ],
+     *   umaDomain: 'mycompany.com',
+     *   webhookEndpoint: 'https://api.mycompany.com/webhooks/uma',
+     * });
+     * ```
+     */
+    update(body: ConfigUpdateParams, options?: RequestOptions): APIPromise<PlatformConfig>;
+}
+/**
+ * Name of a type of field containing info about a platform's customer or
+ * counterparty customer.
+ */
+export type CustomerInfoFieldName = 'FULL_NAME' | 'BIRTH_DATE' | 'NATIONALITY' | 'PHONE_NUMBER' | 'EMAIL' | 'POSTAL_ADDRESS' | 'TAX_ID' | 'REGISTRATION_NUMBER' | 'USER_TYPE' | 'COUNTRY_OF_RESIDENCE' | 'ACCOUNT_IDENTIFIER' | 'FI_LEGAL_ENTITY_NAME' | 'FI_ADDRESS' | 'PURPOSE_OF_PAYMENT' | 'ULTIMATE_INSTITUTION_COUNTRY' | 'IDENTIFIER';
+export interface PlatformConfig {
+    /**
+     * System-generated unique identifier
+     */
+    id?: string;
+    /**
+     * Creation timestamp
+     */
+    createdAt?: string;
+    /**
+     * Whether the platform is a regulated financial institution. This is used to
+     * determine if the platform's customers must be KYC/KYB'd by Lightspark via the
+     * KYC link flow. This can only be set by Lightspark during platform creation.
+     */
+    isRegulatedFinancialInstitution?: boolean;
+    /**
+     * The subdomain that incoming requests will be proxied to
+     */
+    proxyUmaSubdomain?: string;
+    /**
+     * List of currencies supported by the platform. This is what the platform's
+     * customers are able to hold, send, and receive.
+     */
+    supportedCurrencies?: Array<PlatformCurrencyConfig>;
+    /**
+     * UMA domain for this platform
+     */
+    umaDomain?: string;
+    /**
+     * Last update timestamp
+     */
+    updatedAt?: string;
+    /**
+     * URL where webhook notifications will be sent
+     */
+    webhookEndpoint?: string;
+}
+export interface PlatformCurrencyConfig {
+    /**
+     * Three-letter currency code (ISO 4217)
+     */
+    currencyCode: string;
+    /**
+     * List of transaction types that are enabled for this currency.
+     */
+    enabledTransactionTypes: Array<TransactionsAPI.TransactionType>;
+    /**
+     * Maximum amount that can be sent in the smallest unit of this currency
+     */
+    maxAmount: number;
+    /**
+     * Minimum amount that can be sent in the smallest unit of this currency
+     */
+    minAmount: number;
+    /**
+     * List of fields which the platform requires from the counterparty institutions
+     * about counterparty customers. Platforms can set mandatory to false if the
+     * platform does not require the field, but would like to have it available. Some
+     * fields may be required by the underlying UMA provider.
+     */
+    requiredCounterpartyFields: Array<ReceiverAPI.CounterpartyFieldDefinition>;
+    /**
+     * List of fields that are required by the underlying UMA provider for this
+     * currency. If the counterparty does not provide these fields, quote requests will
+     * fail.
+     */
+    providerRequiredCounterpartyCustomerFields?: Array<CustomerInfoFieldName>;
+    /**
+     * List of customer info field names that are required by the underlying UMA
+     * provider when creating a customer for this currency. These fields must be
+     * supplied when creating or updating a customer if this currency is intended to be
+     * used by that customer. If no fields are required, this field is omitted.
+     */
+    providerRequiredCustomerFields?: Array<CustomerInfoFieldName>;
+}
+export interface ConfigUpdateParams {
+    supportedCurrencies?: Array<PlatformCurrencyConfig>;
+    umaDomain?: string;
+    webhookEndpoint?: string;
+}
+export declare namespace Config {
+    export { type CustomerInfoFieldName as CustomerInfoFieldName, type PlatformConfig as PlatformConfig, type PlatformCurrencyConfig as PlatformCurrencyConfig, type ConfigUpdateParams as ConfigUpdateParams, };
+}
+//# sourceMappingURL=config.d.ts.map

package/resources/config.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../src/resources/config.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,WAAW;OAChB,KAAK,eAAe;OACpB,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB,qBAAa,MAAO,SAAQ,WAAW;IACrC;;;;;;;OAOG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,cAAc,CAAC;IAI9D;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,MAAM,CAAC,IAAI,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,cAAc,CAAC;CAGvF;AAED;;;GAGG;AACH,MAAM,MAAM,qBAAqB,GAC7B,WAAW,GACX,YAAY,GACZ,aAAa,GACb,cAAc,GACd,OAAO,GACP,gBAAgB,GAChB,QAAQ,GACR,qBAAqB,GACrB,WAAW,GACX,sBAAsB,GACtB,oBAAoB,GACpB,sBAAsB,GACtB,YAAY,GACZ,oBAAoB,GACpB,8BAA8B,GAC9B,YAAY,CAAC;AAEjB,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;;OAIG;IACH,+BAA+B,CAAC,EAAE,OAAO,CAAC;IAE1C;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;;OAGG;IACH,mBAAmB,CAAC,EAAE,KAAK,CAAC,sBAAsB,CAAC,CAAC;IAEpD;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,uBAAuB,EAAE,KAAK,CAAC,eAAe,CAAC,eAAe,CAAC,CAAC;IAEhE;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;;;OAKG;IACH,0BAA0B,EAAE,KAAK,CAAC,WAAW,CAAC,2BAA2B,CAAC,CAAC;IAE3E;;;;OAIG;IACH,0CAA0C,CAAC,EAAE,KAAK,CAAC,qBAAqB,CAAC,CAAC;IAE1E;;;;;OAKG;IACH,8BAA8B,CAAC,EAAE,KAAK,CAAC,qBAAqB,CAAC,CAAC;CAC/D;AAED,MAAM,WAAW,kBAAkB;IACjC,mBAAmB,CAAC,EAAE,KAAK,CAAC,sBAAsB,CAAC,CAAC;IAEpD,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,MAAM,CAAC,OAAO,WAAW,MAAM,CAAC;IAC9B,OAAO,EACL,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,kBAAkB,IAAI,kBAAkB,GAC9C,CAAC;CACH"}