@spare-technologies/spare-api 1.0.0-beta.7

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Spare Technologies Holding Limited
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,428 @@
+# SpareApi TypeScript / Node.js SDK
+
+The official TypeScript SDK for the [SpareApi Open Banking API](https://docs.tryspare.com).
+
+## Table of Contents
+
+- [Installation](#installation)
+- [Versioning](#versioning)
+- [Getting Started](#getting-started)
+  - [Configuration](#configuration)
+  - [Multi-Environment Support](#multi-environment-support)
+  - [Token Management](#token-management)
+- [Error Handling](#error-handling)
+- [Examples](#examples)
+  - [List providers](#list-providers)
+  - [Create a payment request](#create-a-payment-request)
+  - [Check payment consent status](#check-payment-consent-status)
+  - [Get a payment](#get-a-payment)
+  - [Register a bank account](#register-a-bank-account)
+  - [Schedule a mandate](#schedule-a-mandate)
+  - [Spare Link (hosted payments)](#spare-link-hosted-payments)
+    - [Mint a link token](#mint-a-link-token)
+    - [Exchange an authorization code](#exchange-an-authorization-code)
+  - [Request signing (x-signature)](#request-signing-x-signature)
+- [Contributing](#contributing)
+- [License](#license)
+
+## Installation
+
+```sh
+npm install @spare-technologies/spare-api
+# or
+yarn add @spare-technologies/spare-api
+# or
+pnpm add @spare-technologies/spare-api
+```
+
+Requires Node.js 18 or later.
+
+## Versioning
+
+The SDK follows [Semantic Versioning](https://semver.org). Breaking changes are indicated by a major
+version bump. The changelog is available on the [GitHub releases page](https://github.com/spare-technologies/spare-api-ts/releases).
+
+All users are strongly recommended to use a recent version of the library, as older versions may
+not contain support for new endpoints and fields.
+
+## Getting Started
+
+### Configuration
+
+Create a `Configuration` instance with your API credentials. The SDK automatically handles token
+exchange and management:
+
+```ts
+import { SpareApiClient, Configuration } from "@spare-technologies/spare-api";
+
+// Create configuration with your credentials
+const config = new Configuration({
+  appId: process.env.SPARE_APP_ID!,
+  apiKey: process.env.SPARE_API_KEY!,
+  tenant: "UAE", // or "KSA"
+  environment: "sandbox", // or "production"
+});
+
+// Initialize the client (Configuration handles everything: auth, tenant, baseUrl)
+const client = new SpareApiClient({ authProvider: config });
+
+// SDK automatically exchanges credentials for a bearer token on first request
+// Token is cached and refreshed as needed—no manual token handling required
+// X-Tenant header is auto-injected on every request
+const { data: providers } = await client.providers.list({ countryCode: "AE" });
+```
+
+#### Configuration Options
+
+| Option | Required | Type | Default | Description |
+|--------|----------|------|---------|-------------|
+| `appId` | ✅ | string | - | App identifier from Spare dashboard |
+| `apiKey` | ✅ | string | - | API key from Spare dashboard |
+| `tenant` | ✅ | "UAE" \| "KSA" | - | Target tenant |
+| `environment` | ❌ | "sandbox" \| "production" | "sandbox" | API environment |
+| `baseUrl` | ❌ | string | - | Custom base URL (overrides environment) |
+
+### Multi-Environment Support
+
+```ts
+// Sandbox (default)
+const sandboxConfig = new Configuration({
+  appId: "app_sandbox_123",
+  apiKey: "sk_sandbox_456",
+  tenant: "UAE",
+  environment: "sandbox", // Hits https://api.sandbox.tryspare.ae
+});
+
+// Production
+const prodConfig = new Configuration({
+  appId: "app_prod_789",
+  apiKey: "sk_prod_101112",
+  tenant: "UAE",
+  environment: "production", // Hits https://api.tryspare.ae
+});
+
+// Custom Base URL (e.g., local development)
+const localConfig = new Configuration({
+  appId: "app_local_123",
+  apiKey: "sk_local_456",
+  tenant: "UAE",
+  baseUrl: "http://localhost:4000", // Custom URL takes precedence
+});
+```
+
+### Token Management
+
+Configuration handles token exchange and refresh automatically:
+
+1. **First Request**: Credentials are exchanged for an access token via `POST /auth/api-keys/sessions`
+2. **Caching**: Token is cached in memory with a 30-minute TTL
+3. **Auto-Refresh**: When token expires, a new token is automatically fetched via `POST /auth/api-keys/sessions/refresh`
+4. **Concurrent Safety**: Multiple concurrent requests use a single token (no duplicate exchanges)
+
+You don't need to manage tokens manually — Configuration handles it all.
+
+## Error Handling
+
+All non-2xx responses throw a `SpareApiError`. Inspect `statusCode` and `body` to handle
+specific error types:
+
+```ts
+import { SpareApiError } from "@spare-technologies/spare-api";
+
+try {
+  const consent = await client.paymentConsents.get("consent-id");
+} catch (err) {
+  if (err instanceof SpareApiError) {
+    console.error(err.statusCode); // HTTP status — e.g. 404
+    console.error(err.message);    // human-readable message
+    console.error(err.body);       // raw response body
+  }
+  throw err;
+}
+```
+
+## Examples
+
+For more examples see the [API reference documentation](https://docs.tryspare.com/api).
+
+### List providers
+
+Retrieve the open-banking providers available in a given country:
+
+```ts
+const { data: providers } = await client.providers.list({
+  countryCode: "AE",
+});
+
+for (const provider of providers) {
+  console.log(provider.id, provider.name);
+}
+```
+
+### Create a payment request
+
+Payment requests require a request signature. Use `client.crypto.signPayload` to produce the
+detached JWS and pass it as `x-signature`:
+
+```ts
+const body = {
+  type: "SingleInstantPayment",
+  purpose: "ACM",
+  creditorType: "MERCHANT",
+  creditorReference: "INV-10042",
+  creditorAccount: {
+    identification: "AE070331234567890123456",
+    name: "Acme Corp",
+    schemeName: "IBAN",
+  },
+  instructions: {
+    amount: { amount: "250.00", currency: "AED" },
+  },
+};
+
+const xSignature = await client.crypto.signPayload(process.env.SPARE_PRIVATE_KEY_PEM!, body);
+
+const { data: paymentRequest } = await client.paymentRequests.create({
+  ...body,
+  "x-signature": xSignature,
+});
+
+console.log("Payment request:", paymentRequest.id);
+// Redirect the user to this URL to authorise the payment at their bank
+console.log("Authorise at:", paymentRequest.redirectUrl);
+```
+
+### Check payment consent status
+
+After the user authorises at the bank (via `redirectUrl`), consent is created server-side.
+Poll or sync status using `paymentConsents.list`, `paymentConsents.get`, or
+`paymentConsents.sync`:
+
+```ts
+// List all consents (paginated)
+const { data: consents } = await client.paymentConsents.list({ page: 1, perPage: 10 });
+for (const c of consents) {
+  console.log(c.id, c.status);
+}
+
+// Get a specific consent by ID
+const { data: consent } = await client.paymentConsents.get("consent-id");
+console.log("Consent status:", consent.status);
+
+// Force a sync from the bank to get the latest status
+const { data: synced } = await client.paymentConsents.sync({
+  paymentRequestId: paymentRequest.id,
+});
+console.log("Synced status:", synced.status);
+```
+
+### Get a payment
+
+```ts
+const { data: payment } = await client.payments.get(paymentId);
+
+console.log("Status:", payment.status);
+```
+
+### Register a bank account
+
+```ts
+const { data: account } = await client.bankAccounts.create({
+  consentId: consent.id, // consent obtained from paymentConsents.get("consent-id")
+  accountNumber: "1234567890",
+  bankCode: "ADCB",
+});
+
+console.log("Account registered:", account.id);
+```
+
+### Schedule a mandate
+
+Scheduling a mandate also requires a request signature:
+
+```ts
+const mandateBody = {
+  mandateId: "3fa85f64-5717-4562-b3fc-2c963f66afa6",
+  amount: 500,
+  executionDate: "2025-06-01",
+};
+
+const xSignature = await client.crypto.signPayload(process.env.SPARE_PRIVATE_KEY_PEM!, mandateBody);
+
+const { data: transaction } = await client.mandates.schedule({
+  ...mandateBody,
+  "x-signature": xSignature,
+});
+
+console.log("Mandate scheduled:", transaction.id);
+```
+
+### Spare Link (hosted payments)
+
+[Spare Link](https://docs.tryspare.com) is a hosted open-banking payment experience. Your
+**merchant backend** uses this SDK for two server-side steps:
+
+1. **Mint** a short-lived `link_token` via `link.createPaymentToken`
+2. **Exchange** the one-time `exchange_code` from the client Link SDK via `link.exchange`
+
+Pass the `link_token` to the hosted UI SDK on your client (`@sparefinancial/link-web`,
+Flutter `spare_link`, React Native `@sparefinancial/link-react-native`). Those client
+packages handle the bank consent UI — this API SDK covers token mint and exchange only.
+
+#### Mint a link token
+
+```ts
+const paymentRequest = {
+  type: "SingleInstantPayment",
+  purpose: "ACM",
+  creditorType: "MERCHANT",
+  creditorReference: "INV10042",
+  creditorAccount: {
+    identification: "AE070331234567890123456",
+    name: "Acme Corp",
+    schemeName: "IBAN",
+  },
+  instructions: {
+    amount: { amount: "250.00", currency: "AED" },
+  },
+};
+
+const xSignature = await client.crypto.signPayload(
+  process.env.SPARE_PRIVATE_KEY_PEM!,
+  paymentRequest
+);
+
+const { data: linkSession } = await client.link.createPaymentToken({
+  user_ref: "user-123",
+  provider_code: "ENBD", // optional — omit to show bank selection in hosted UI
+  request: paymentRequest,
+  "x-signature": xSignature,
+});
+
+// Pass linkSession.link_token to your frontend Link SDK
+console.log("Link token:", linkSession.link_token);
+console.log("Payment request:", linkSession.request?.id);
+```
+
+#### Exchange an authorization code
+
+After the end-user completes bank authorisation, your client Link SDK fires `onSuccess` with
+an `exchange_code`. Send that code to your backend and exchange it for durable identifiers:
+
+```ts
+const { data: result } = await client.link.exchange({
+  exchange_code: exchangeCodeFromClient,
+});
+
+console.log("Payment ID:", result.paymentId);
+console.log("Consent ID:", result.consentId);
+console.log("Status:", result.paymentStatus);
+```
+
+### Request signing (x-signature)
+
+Certain endpoints — `paymentRequests.create`, `link.createPaymentToken`, and
+`mandates.schedule` — require a detached JWS signature, passed via the `x-signature` field.
+For `link.createPaymentToken`, sign only the nested `request` object (same payload as
+`paymentRequests.create`), not the full Link body. The SDK ships a
+built-in `CryptoHelper` (available as `client.crypto`) so you don't need any external
+crypto library.
+
+**Prerequisites**
+
+1. Generate an EC P-256 key pair and register the public key in your Spare dashboard.
+2. Store the private key securely (environment variable, secret manager).
+
+**Signing a payment request**
+
+```ts
+import { SpareApiClient, Configuration, CryptoHelper } from "@spare-technologies/spare-api";
+
+const config = new Configuration({
+  appId: process.env.SPARE_APP_ID!,
+  apiKey: process.env.SPARE_API_KEY!,
+  tenant: "UAE",
+  environment: "sandbox",
+});
+const client = new SpareApiClient({ authProvider: config });
+
+const privateKeyPem = process.env.SPARE_PRIVATE_KEY_PEM!; // PKCS8 PEM
+
+const body = {
+  type: "SingleInstantPayment",
+  purpose: "ACM",
+  creditorType: "MERCHANT",
+  creditorReference: "INV-10042",
+  creditorAccount: {
+    identification: "AE070331234567890123456",
+    name: "Acme Corp",
+    schemeName: "IBAN",
+  },
+  instructions: {
+    amount: { amount: "250.00", currency: "AED" },
+  },
+};
+
+// 1. Sign the body — client.crypto is a lazily-initialised CryptoHelper instance
+const xSignature = await client.crypto.signPayload(privateKeyPem, body);
+
+// 2. Pass the signature alongside the body
+const { data: paymentRequest } = await client.paymentRequests.create({
+  ...body,
+  "x-signature": xSignature,
+});
+
+console.log("Payment request created:", paymentRequest.id);
+```
+
+**Signing a mandate**
+
+```ts
+const mandateBody = {
+  mandateId: "3fa85f64-5717-4562-b3fc-2c963f66afa6",
+  amount: 500,
+  executionDate: "2025-06-01",
+};
+
+const xSignature = await client.crypto.signPayload(privateKeyPem, mandateBody);
+
+const { data: transaction } = await client.mandates.schedule({
+  ...mandateBody,
+  "x-signature": xSignature,
+});
+
+console.log("Mandate scheduled:", transaction.id);
+```
+
+**Using `CryptoHelper` standalone**
+
+`CryptoHelper` can also be used independently — useful for testing or pre-computing signatures:
+
+```ts
+import { CryptoHelper } from "@spare-technologies/spare-api";
+
+const crypto = new CryptoHelper();
+
+// Canonical JSON (must match what you pass to the API)
+const canonical = crypto.serializePayload(body);
+console.log("Canonical payload:", canonical);
+
+// ES256 detached JWS
+const jws = await crypto.signPayload(privateKeyPem, body);
+console.log("x-signature:", jws); // eyJhbGciOiJFUzI1NiJ9...<sig>
+```
+
+> **Key format**: The private key must be a PKCS8 PEM string starting with
+> `-----BEGIN PRIVATE KEY-----`. Generate one with:
+> ```sh
+> openssl ecparam -genkey -name prime256v1 -noout | openssl pkcs8 -topk8 -nocrypt -out private.pem
+> openssl ec -in private.pem -pubout -out public.pem   # register public.pem in your dashboard
+> ```
+
+## Contributing
+
+See [CONTRIBUTING.md](https://github.com/spare-technologies/spare-api-ts/blob/main/CONTRIBUTING.md).
+
+## License
+
+This SDK is distributed under the [MIT License](https://github.com/spare-technologies/spare-api-ts/blob/main/LICENSE).

package/dist/BaseClient.d.ts

@@ -0,0 +1,50 @@
+import { BearerAuthProvider } from "./auth/BearerAuthProvider.js";
+import * as core from "./core/index.js";
+import type * as environments from "./environments.js";
+export type BaseClientOptions = {
+    environment?: core.Supplier<environments.SpareApiEnvironment | string>;
+    /** Specify a custom URL to connect the client to. */
+    baseUrl?: core.Supplier<string>;
+    /** Override the x-tenant header */
+    tenant?: core.Supplier<string | undefined>;
+    /** Override the x-real-ip header */
+    realIp?: core.Supplier<string | undefined>;
+    /** Additional headers to include in requests. */
+    headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
+    /** The default maximum time to wait for a response in seconds. */
+    timeoutInSeconds?: number;
+    /** The default number of times to retry the request. Defaults to 2. */
+    maxRetries?: number;
+    /** Provide a custom fetch implementation. Useful for platforms that don't have a built-in fetch or need a custom implementation. */
+    fetch?: typeof fetch;
+    /** Configure logging for the client. */
+    logging?: core.logging.LogConfig | core.logging.Logger;
+    /** Custom auth provider (e.g. a Configuration instance from this SDK). */
+    authProvider?: core.AuthProvider;
+} & BearerAuthProvider.AuthOptions;
+export interface BaseRequestOptions {
+    /** The maximum time to wait for a response in seconds. */
+    timeoutInSeconds?: number;
+    /** The number of times to retry the request. Defaults to 2. */
+    maxRetries?: number;
+    /** A hook to abort the request. */
+    abortSignal?: AbortSignal;
+    /** Override the x-tenant header */
+    tenant?: string | undefined;
+    /** Override the x-real-ip header */
+    realIp?: string | undefined;
+    /** Additional query string parameters to include in the request. */
+    queryParams?: Record<string, unknown>;
+    /** Additional headers to include in the request. */
+    headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
+}
+export type NormalizedClientOptions<T extends BaseClientOptions = BaseClientOptions> = T & {
+    logging: core.logging.Logger;
+    authProvider?: core.AuthProvider;
+};
+export type NormalizedClientOptionsWithAuth<T extends BaseClientOptions = BaseClientOptions> = NormalizedClientOptions<T> & {
+    authProvider: core.AuthProvider;
+};
+export declare function normalizeClientOptions<T extends BaseClientOptions = BaseClientOptions>(options: T): NormalizedClientOptions<T>;
+export declare function normalizeClientOptionsWithAuth<T extends BaseClientOptions = BaseClientOptions>(options: T): NormalizedClientOptionsWithAuth<T>;
+//# sourceMappingURL=BaseClient.d.ts.map

package/dist/BaseClient.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"BaseClient.d.ts","sourceRoot":"","sources":["../BaseClient.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,kBAAkB,EAAE,MAAM,8BAA8B,CAAC;AAElE,OAAO,KAAK,IAAI,MAAM,iBAAiB,CAAC;AACxC,OAAO,KAAK,KAAK,YAAY,MAAM,mBAAmB,CAAC;AAEvD,MAAM,MAAM,iBAAiB,GAAG;IAC5B,WAAW,CAAC,EAAE,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC,mBAAmB,GAAG,MAAM,CAAC,CAAC;IACvE,qDAAqD;IACrD,OAAO,CAAC,EAAE,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;IAChC,mCAAmC;IACnC,MAAM,CAAC,EAAE,IAAI,CAAC,QAAQ,CAAC,MAAM,GAAG,SAAS,CAAC,CAAC;IAC3C,oCAAoC;IACpC,MAAM,CAAC,EAAE,IAAI,CAAC,QAAQ,CAAC,MAAM,GAAG,SAAS,CAAC,CAAC;IAC3C,iDAAiD;IACjD,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC,GAAG,IAAI,GAAG,SAAS,CAAC,CAAC;IAC/F,kEAAkE;IAClE,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,uEAAuE;IACvE,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,oIAAoI;IACpI,KAAK,CAAC,EAAE,OAAO,KAAK,CAAC;IACrB,wCAAwC;IACxC,OAAO,CAAC,EAAE,IAAI,CAAC,OAAO,CAAC,SAAS,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC;IACvD,0EAA0E;IAC1E,YAAY,CAAC,EAAE,IAAI,CAAC,YAAY,CAAC;CACpC,GAAG,kBAAkB,CAAC,WAAW,CAAC;AAEnC,MAAM,WAAW,kBAAkB;IAC/B,0DAA0D;IAC1D,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,+DAA+D;IAC/D,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,mCAAmC;IACnC,WAAW,CAAC,EAAE,WAAW,CAAC;IAC1B,mCAAmC;IACnC,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC5B,oCAAoC;IACpC,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC5B,oEAAoE;IACpE,WAAW,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACtC,oDAAoD;IACpD,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC,GAAG,IAAI,GAAG,SAAS,CAAC,CAAC;CAClG;AAED,MAAM,MAAM,uBAAuB,CAAC,CAAC,SAAS,iBAAiB,GAAG,iBAAiB,IAAI,CAAC,GAAG;IACvF,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC;IAC7B,YAAY,CAAC,EAAE,IAAI,CAAC,YAAY,CAAC;CACpC,CAAC;AAEF,MAAM,MAAM,+BAA+B,CAAC,CAAC,SAAS,iBAAiB,GAAG,iBAAiB,IACvF,uBAAuB,CAAC,CAAC,CAAC,GAAG;IACzB,YAAY,EAAE,IAAI,CAAC,YAAY,CAAC;CACnC,CAAC;AAEN,wBAAgB,sBAAsB,CAAC,CAAC,SAAS,iBAAiB,GAAG,iBAAiB,EAClF,OAAO,EAAE,CAAC,GACX,uBAAuB,CAAC,CAAC,CAAC,CAiB5B;AAED,wBAAgB,8BAA8B,CAAC,CAAC,SAAS,iBAAiB,GAAG,iBAAiB,EAC1F,OAAO,EAAE,CAAC,GACX,+BAA+B,CAAC,CAAC,CAAC,CAepC"}

package/dist/BaseClient.js

@@ -0,0 +1,41 @@
+// This file was auto-generated by Fern from our API Definition.
+import { BearerAuthProvider } from "./auth/BearerAuthProvider.js";
+import { mergeHeaders } from "./core/headers.js";
+import * as core from "./core/index.js";
+export function normalizeClientOptions(options) {
+    const headers = mergeHeaders({
+        "X-Fern-Language": "JavaScript",
+        "X-Fern-Runtime": core.RUNTIME.type,
+        "X-Fern-Runtime-Version": core.RUNTIME.version,
+        "x-tenant": options?.tenant,
+        "x-real-ip": options?.realIp,
+    }, options?.headers);
+    return {
+        ...options,
+        logging: core.logging.createLogger(options?.logging),
+        headers,
+    };
+}
+export function normalizeClientOptionsWithAuth(options) {
+    const normalized = normalizeClientOptions(options);
+    // Preserve custom authProvider + extract baseUrl from options
+    const customAuthProvider = options.authProvider;
+    if (customAuthProvider) {
+        normalized.authProvider = customAuthProvider;
+        // If authProvider has getBaseUrl method and no baseUrl provided, use it
+        if (!normalized.baseUrl && typeof customAuthProvider?.getBaseUrl === 'function') {
+            normalized.baseUrl = customAuthProvider.getBaseUrl();
+        }
+        return normalized;
+    }
+    const normalizedWithNoOpAuthProvider = withNoOpAuthProvider(normalized);
+    normalized.authProvider ?? (normalized.authProvider = new BearerAuthProvider(normalizedWithNoOpAuthProvider));
+    return normalized;
+}
+function withNoOpAuthProvider(options) {
+    return {
+        ...options,
+        authProvider: new core.NoOpAuthProvider(),
+    };
+}
+//# sourceMappingURL=BaseClient.js.map

package/dist/BaseClient.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BaseClient.js","sourceRoot":"","sources":["../BaseClient.ts"],"names":[],"mappings":"AAAA,gEAAgE;AAEhE,OAAO,EAAE,kBAAkB,EAAE,MAAM,8BAA8B,CAAC;AAClE,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACjD,OAAO,KAAK,IAAI,MAAM,iBAAiB,CAAC;AAoDxC,MAAM,UAAU,sBAAsB,CAClC,OAAU;IAEV,MAAM,OAAO,GAAG,YAAY,CACxB;QACI,iBAAiB,EAAE,YAAY;QAC/B,gBAAgB,EAAE,IAAI,CAAC,OAAO,CAAC,IAAI;QACnC,wBAAwB,EAAE,IAAI,CAAC,OAAO,CAAC,OAAO;QAC9C,UAAU,EAAE,OAAO,EAAE,MAAM;QAC3B,WAAW,EAAE,OAAO,EAAE,MAAM;KAC/B,EACD,OAAO,EAAE,OAAO,CACnB,CAAC;IAEF,OAAO;QACH,GAAG,OAAO;QACV,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,OAAO,EAAE,OAAO,CAAC;QACpD,OAAO;KACoB,CAAC;AACpC,CAAC;AAED,MAAM,UAAU,8BAA8B,CAC1C,OAAU;IAEV,MAAM,UAAU,GAAG,sBAAsB,CAAC,OAAO,CAAuC,CAAC;IACzF,8DAA8D;IAC9D,MAAM,kBAAkB,GAAI,OAAiD,CAAC,YAAY,CAAC;IAC3F,IAAI,kBAAkB,EAAE,CAAC;QACvB,UAAU,CAAC,YAAY,GAAG,kBAAuC,CAAC;QAClE,wEAAwE;QACxE,IAAI,CAAC,UAAU,CAAC,OAAO,IAAI,OAAQ,kBAA0B,EAAE,UAAU,KAAK,UAAU,EAAE,CAAC;YACzF,UAAU,CAAC,OAAO,GAAI,kBAA0B,CAAC,UAAU,EAAE,CAAC;QAChE,CAAC;QACD,OAAO,UAAU,CAAC;IACpB,CAAC;IACD,MAAM,8BAA8B,GAAG,oBAAoB,CAAC,UAAU,CAAC,CAAC;IACxE,UAAU,CAAC,YAAY,KAAvB,UAAU,CAAC,YAAY,GAAK,IAAI,kBAAkB,CAAC,8BAA8B,CAAC,EAAC;IACnF,OAAO,UAAU,CAAC;AACtB,CAAC;AAED,SAAS,oBAAoB,CACzB,OAAmC;IAEnC,OAAO;QACH,GAAG,OAAO;QACV,YAAY,EAAE,IAAI,IAAI,CAAC,gBAAgB,EAAE;KAC5C,CAAC;AACN,CAAC","sourcesContent":["// This file was auto-generated by Fern from our API Definition.\n\nimport { BearerAuthProvider } from \"./auth/BearerAuthProvider.js\";\nimport { mergeHeaders } from \"./core/headers.js\";\nimport * as core from \"./core/index.js\";\nimport type * as environments from \"./environments.js\";\n\nexport type BaseClientOptions = {\n    environment?: core.Supplier<environments.SpareApiEnvironment | string>;\n    /** Specify a custom URL to connect the client to. */\n    baseUrl?: core.Supplier<string>;\n    /** Override the x-tenant header */\n    tenant?: core.Supplier<string | undefined>;\n    /** Override the x-real-ip header */\n    realIp?: core.Supplier<string | undefined>;\n    /** Additional headers to include in requests. */\n    headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;\n    /** The default maximum time to wait for a response in seconds. */\n    timeoutInSeconds?: number;\n    /** The default number of times to retry the request. Defaults to 2. */\n    maxRetries?: number;\n    /** Provide a custom fetch implementation. Useful for platforms that don't have a built-in fetch or need a custom implementation. */\n    fetch?: typeof fetch;\n    /** Configure logging for the client. */\n    logging?: core.logging.LogConfig | core.logging.Logger;\n    /** Custom auth provider (e.g. a Configuration instance from this SDK). */\n    authProvider?: core.AuthProvider;\n} & BearerAuthProvider.AuthOptions;\n\nexport interface BaseRequestOptions {\n    /** The maximum time to wait for a response in seconds. */\n    timeoutInSeconds?: number;\n    /** The number of times to retry the request. Defaults to 2. */\n    maxRetries?: number;\n    /** A hook to abort the request. */\n    abortSignal?: AbortSignal;\n    /** Override the x-tenant header */\n    tenant?: string | undefined;\n    /** Override the x-real-ip header */\n    realIp?: string | undefined;\n    /** Additional query string parameters to include in the request. */\n    queryParams?: Record<string, unknown>;\n    /** Additional headers to include in the request. */\n    headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;\n}\n\nexport type NormalizedClientOptions<T extends BaseClientOptions = BaseClientOptions> = T & {\n    logging: core.logging.Logger;\n    authProvider?: core.AuthProvider;\n};\n\nexport type NormalizedClientOptionsWithAuth<T extends BaseClientOptions = BaseClientOptions> =\n    NormalizedClientOptions<T> & {\n        authProvider: core.AuthProvider;\n    };\n\nexport function normalizeClientOptions<T extends BaseClientOptions = BaseClientOptions>(\n    options: T,\n): NormalizedClientOptions<T> {\n    const headers = mergeHeaders(\n        {\n            \"X-Fern-Language\": \"JavaScript\",\n            \"X-Fern-Runtime\": core.RUNTIME.type,\n            \"X-Fern-Runtime-Version\": core.RUNTIME.version,\n            \"x-tenant\": options?.tenant,\n            \"x-real-ip\": options?.realIp,\n        },\n        options?.headers,\n    );\n\n    return {\n        ...options,\n        logging: core.logging.createLogger(options?.logging),\n        headers,\n    } as NormalizedClientOptions<T>;\n}\n\nexport function normalizeClientOptionsWithAuth<T extends BaseClientOptions = BaseClientOptions>(\n    options: T,\n): NormalizedClientOptionsWithAuth<T> {\n    const normalized = normalizeClientOptions(options) as NormalizedClientOptionsWithAuth<T>;\n    // Preserve custom authProvider + extract baseUrl from options\n    const customAuthProvider = (options as unknown as { authProvider?: unknown }).authProvider;\n    if (customAuthProvider) {\n      normalized.authProvider = customAuthProvider as core.AuthProvider;\n      // If authProvider has getBaseUrl method and no baseUrl provided, use it\n      if (!normalized.baseUrl && typeof (customAuthProvider as any)?.getBaseUrl === 'function') {\n        normalized.baseUrl = (customAuthProvider as any).getBaseUrl();\n      }\n      return normalized;\n    }\n    const normalizedWithNoOpAuthProvider = withNoOpAuthProvider(normalized);\n    normalized.authProvider ??= new BearerAuthProvider(normalizedWithNoOpAuthProvider);\n    return normalized;\n}\n\nfunction withNoOpAuthProvider<T extends BaseClientOptions = BaseClientOptions>(\n    options: NormalizedClientOptions<T>,\n): NormalizedClientOptionsWithAuth<T> {\n    return {\n        ...options,\n        authProvider: new core.NoOpAuthProvider(),\n    };\n}\n"]}

package/dist/Client.d.ts

@@ -0,0 +1,60 @@
+import { AuthClient } from "./api/resources/auth/client/Client.js";
+import { BankAccountsClient } from "./api/resources/bankAccounts/client/Client.js";
+import { LinkClient } from "./api/resources/link/client/Client.js";
+import { MandatesClient } from "./api/resources/mandates/client/Client.js";
+import { PaymentConsentsClient } from "./api/resources/paymentConsents/client/Client.js";
+import { PaymentPurposeCodesClient } from "./api/resources/paymentPurposeCodes/client/Client.js";
+import { PaymentRequestsClient } from "./api/resources/paymentRequests/client/Client.js";
+import { PaymentsClient } from "./api/resources/payments/client/Client.js";
+import { ProvidersClient } from "./api/resources/providers/client/Client.js";
+import { SavedDebtorAccountsClient } from "./api/resources/savedDebtorAccounts/client/Client.js";
+import { VerificationsClient } from "./api/resources/verifications/client/Client.js";
+import type { BaseClientOptions, BaseRequestOptions } from "./BaseClient.js";
+import { type NormalizedClientOptions } from "./BaseClient.js";
+import * as core from "./core/index.js";
+import { CryptoHelper } from "./crypto.js";
+export declare namespace SpareApiClient {
+    type Options = BaseClientOptions;
+    interface RequestOptions extends BaseRequestOptions {
+    }
+}
+export declare class SpareApiClient {
+    protected readonly _options: NormalizedClientOptions<SpareApiClient.Options>;
+    protected _auth: AuthClient | undefined;
+    protected _paymentConsents: PaymentConsentsClient | undefined;
+    protected _link: LinkClient | undefined;
+    protected _mandates: MandatesClient | undefined;
+    protected _paymentPurposeCodes: PaymentPurposeCodesClient | undefined;
+    protected _paymentRequests: PaymentRequestsClient | undefined;
+    protected _bankAccounts: BankAccountsClient | undefined;
+    protected _savedDebtorAccounts: SavedDebtorAccountsClient | undefined;
+    protected _payments: PaymentsClient | undefined;
+    protected _providers: ProvidersClient | undefined;
+    protected _crypto: CryptoHelper | undefined;
+    protected _verifications: VerificationsClient | undefined;
+    constructor(options?: SpareApiClient.Options);
+    get auth(): AuthClient;
+    get paymentConsents(): PaymentConsentsClient;
+    get link(): LinkClient;
+    get mandates(): MandatesClient;
+    get paymentPurposeCodes(): PaymentPurposeCodesClient;
+    get paymentRequests(): PaymentRequestsClient;
+    get bankAccounts(): BankAccountsClient;
+    get savedDebtorAccounts(): SavedDebtorAccountsClient;
+    get payments(): PaymentsClient;
+    get providers(): ProvidersClient;
+    get verifications(): VerificationsClient;
+    get crypto(): CryptoHelper;
+    /**
+     * Make a passthrough request using the SDK's configured auth, retry, logging, etc.
+     * This is useful for making requests to endpoints not yet supported in the SDK.
+     * The input can be a URL string, URL object, or Request object. Relative paths are resolved against the configured base URL.
+     *
+     * @param {Request | string | URL} input - The URL, path, or Request object.
+     * @param {RequestInit} init - Standard fetch RequestInit options.
+     * @param {core.PassthroughRequest.RequestOptions} requestOptions - Per-request overrides (timeout, retries, headers, abort signal).
+     * @returns {Promise<Response>} A standard Response object.
+     */
+    fetch(input: Request | string | URL, init?: RequestInit, requestOptions?: core.PassthroughRequest.RequestOptions): Promise<Response>;
+}
+//# sourceMappingURL=Client.d.ts.map

package/dist/Client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Client.d.ts","sourceRoot":"","sources":["../Client.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,UAAU,EAAE,MAAM,uCAAuC,CAAC;AACnE,OAAO,EAAE,kBAAkB,EAAE,MAAM,+CAA+C,CAAC;AACnF,OAAO,EAAE,UAAU,EAAE,MAAM,uCAAuC,CAAC;AACnE,OAAO,EAAE,cAAc,EAAE,MAAM,2CAA2C,CAAC;AAC3E,OAAO,EAAE,qBAAqB,EAAE,MAAM,kDAAkD,CAAC;AACzF,OAAO,EAAE,yBAAyB,EAAE,MAAM,sDAAsD,CAAC;AACjG,OAAO,EAAE,qBAAqB,EAAE,MAAM,kDAAkD,CAAC;AACzF,OAAO,EAAE,cAAc,EAAE,MAAM,2CAA2C,CAAC;AAC3E,OAAO,EAAE,eAAe,EAAE,MAAM,4CAA4C,CAAC;AAC7E,OAAO,EAAE,yBAAyB,EAAE,MAAM,sDAAsD,CAAC;AACjG,OAAO,EAAE,mBAAmB,EAAE,MAAM,gDAAgD,CAAC;AACrF,OAAO,KAAK,EAAE,iBAAiB,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAC;AAC7E,OAAO,EAAE,KAAK,uBAAuB,EAA0D,MAAM,iBAAiB,CAAC;AACvH,OAAO,KAAK,IAAI,MAAM,iBAAiB,CAAC;AAExC,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAE3C,MAAM,CAAC,OAAO,WAAW,cAAc,CAAC;IACpC,KAAY,OAAO,GAAG,iBAAiB,CAAC;IAExC,UAAiB,cAAe,SAAQ,kBAAkB;KAAG;CAChE;AAED,qBAAa,cAAc;IACvB,SAAS,CAAC,QAAQ,CAAC,QAAQ,EAAE,uBAAuB,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;IAC7E,SAAS,CAAC,KAAK,EAAE,UAAU,GAAG,SAAS,CAAC;IACxC,SAAS,CAAC,gBAAgB,EAAE,qBAAqB,GAAG,SAAS,CAAC;IAC9D,SAAS,CAAC,KAAK,EAAE,UAAU,GAAG,SAAS,CAAC;IACxC,SAAS,CAAC,SAAS,EAAE,cAAc,GAAG,SAAS,CAAC;IAChD,SAAS,CAAC,oBAAoB,EAAE,yBAAyB,GAAG,SAAS,CAAC;IACtE,SAAS,CAAC,gBAAgB,EAAE,qBAAqB,GAAG,SAAS,CAAC;IAC9D,SAAS,CAAC,aAAa,EAAE,kBAAkB,GAAG,SAAS,CAAC;IACxD,SAAS,CAAC,oBAAoB,EAAE,yBAAyB,GAAG,SAAS,CAAC;IACtE,SAAS,CAAC,SAAS,EAAE,cAAc,GAAG,SAAS,CAAC;IAChD,SAAS,CAAC,UAAU,EAAE,eAAe,GAAG,SAAS,CAAC;IAClD,SAAS,CAAC,OAAO,EAAE,YAAY,GAAG,SAAS,CAAC;IAC5C,SAAS,CAAC,cAAc,EAAE,mBAAmB,GAAG,SAAS,CAAC;gBAE9C,OAAO,GAAE,cAAc,CAAC,OAAY;IAIhD,IAAW,IAAI,IAAI,UAAU,CAE5B;IAED,IAAW,eAAe,IAAI,qBAAqB,CAElD;IAED,IAAW,IAAI,IAAI,UAAU,CAE5B;IAED,IAAW,QAAQ,IAAI,cAAc,CAEpC;IAED,IAAW,mBAAmB,IAAI,yBAAyB,CAE1D;IAED,IAAW,eAAe,IAAI,qBAAqB,CAElD;IAED,IAAW,YAAY,IAAI,kBAAkB,CAE5C;IAED,IAAW,mBAAmB,IAAI,yBAAyB,CAE1D;IAED,IAAW,QAAQ,IAAI,cAAc,CAEpC;IAED,IAAW,SAAS,IAAI,eAAe,CAEtC;IAED,IAAW,aAAa,IAAI,mBAAmB,CAE9C;IAGD,IAAW,MAAM,IAAI,YAAY,CAEhC;IAED;;;;;;;;;OASG;IACU,KAAK,CACd,KAAK,EAAE,OAAO,GAAG,MAAM,GAAG,GAAG,EAC7B,IAAI,CAAC,EAAE,WAAW,EAClB,cAAc,CAAC,EAAE,IAAI,CAAC,kBAAkB,CAAC,cAAc,GACxD,OAAO,CAAC,QAAQ,CAAC;CAevB"}