@enfuce/nextgen-sdk 0.0.9 → 0.0.11

package/README.md

@@ -19,8 +19,8 @@ OAuth2 `client_credentials` bearer token:
 ```typescript
 import { oauth, card, config } from '@enfuce/nextgen-sdk';
 
-// Identify the host by tenant + environment; the config helper derives every URL from it.
-const te = { tenant: '<tenant>', environment: 'eu.live.prod' };
+// Set the tenant + environment once; the config helper derives every base URL (and the token URL) from it.
+const te = { tenant: '<tenant>', environment: '<environment>' };
 
 // One token manager (cached client-credentials grant) — reuse it across every module.
 const clientCredentialsManager = oauth.clientCredentials({
@@ -39,10 +39,10 @@ const client = card.CardClient.builder()
 const { data } = await client.getCardApi().getCard(cardId, 'you@example.com');
 ```
 
-`.oauth(clientCredentialsManager)` attaches the token at the transport layer, so it works uniformly
-for every module — including ones whose spec declares no security scheme
-(e.g. `exchangeRate.ExchangeRateClient`). See [Client customization](#client-customization) for
-transport tuning (timeouts, proxy, interceptors).
+`environment` is the target platform — e.g. `ext-uat1-sandbox` (sandbox) or `eu.live.prod`
+(production). One `clientCredentialsManager` authenticates every module, so build it once and reuse it
+across all your clients. See [Client customization](#client-customization) for transport tuning
+(timeouts, proxy, interceptors).
 
 Keeping the token URL separate from the client identity? Pass a `ClientCredentials` — e.g. with the
 `config` helper deriving the URL:
@@ -110,12 +110,12 @@ const client = card.CardClient.builder()
 
 ## API modules
 
-Each module builds the same way — pick the base URL for the module's host
+Each module builds the same way — set its base URL with the matching accessor
 (`config.issuerBaseUrl`, `config.processorBaseUrl`, or `config.exchangeRateBaseUrl`) and reuse the
-shared `clientCredentialsManager`. Every call resolves to an axios response, so read `.data`. The
-snippets below assume `te` and `clientCredentialsManager` are in scope.
+shared `clientCredentialsManager`. Every call resolves to an axios response, so read `.data`.
+Snippets assume `te` and `clientCredentialsManager` are in scope.
 
-### `cardholder` — issuer host
+### `cardholder` — `issuerBaseUrl`
 
 ```typescript
 import { cardholder, config } from '@enfuce/nextgen-sdk';
@@ -127,7 +127,7 @@ const { data: cards } = await client.getCardsByCardholderIdApi()
   .getCardsByCardholderId(cardholderId, undefined, undefined, 'you@example.com');
 ```
 
-### `card` — issuer host
+### `card` — `issuerBaseUrl`
 
 ```typescript
 import { card, config } from '@enfuce/nextgen-sdk';
@@ -138,7 +138,7 @@ const { data } = await client.getCardApi().getCard(cardId, 'you@example.com');
 await client.updateCardApi().activateCard(cardId, undefined, 'you@example.com'); // (id, idempotencyKey, auditUser)
 ```
 
-### `wallet` — issuer host
+### `wallet` — `issuerBaseUrl`
 
 ```typescript
 import { wallet, config } from '@enfuce/nextgen-sdk';
@@ -148,7 +148,7 @@ const client = wallet.WalletClient.builder().baseUrl(config.issuerBaseUrl(te)).o
 const { data: tokens } = await client.getTokensApi().getTokens(cardId, false, undefined, 'you@example.com');
 ```
 
-### `pin` — issuer host
+### `pin` — `issuerBaseUrl`
 
 ```typescript
 import { pin, config } from '@enfuce/nextgen-sdk';
@@ -158,7 +158,7 @@ const client = pin.PinClient.builder().baseUrl(config.issuerBaseUrl(te)).oauth(c
 const { data } = await client.pINOperationsUsingPKIApi().viewPin(viewPinRequestBody, 'you@example.com');
 ```
 
-### `exchangeRate` — exchange-rate host
+### `exchangeRate` — `exchangeRateBaseUrl`
 
 ```typescript
 import { exchangeRate, config } from '@enfuce/nextgen-sdk';
@@ -169,7 +169,7 @@ const { data: currencies } = await client.getECBSupportedCurrenciesApi().getEcbS
 const { data: rate } = await client.getECBExchangeRateApi().getEcbRateV1('EUR', 'USD');
 ```
 
-### `threeds` — processor host
+### `threeds` — `processorBaseUrl`
 
 ```typescript
 import { threeds, config } from '@enfuce/nextgen-sdk';
@@ -179,7 +179,7 @@ const client = threeds.ThreedsClient.builder().baseUrl(config.processorBaseUrl(t
 await client.threeDSApi().handleAuthenticationChallengeResult(challengeResultBody);
 ```
 
-### `cards` — processor host
+### `cards` — `processorBaseUrl`
 
 ```typescript
 import { cards, config } from '@enfuce/nextgen-sdk';
@@ -189,11 +189,11 @@ const client = cards.CardsClient.builder().baseUrl(config.processorBaseUrl(te)).
 await client.cardsApi().resetPinCounter(cardId, sequenceNumber);
 ```
 
-## Webhooks (model-only modules)
+## Webhooks
 
-Some APIs describe payloads Enfuce sends **to you** — you implement the endpoint, Enfuce POSTs to it.
-These specs are shipped **model-only**: the namespace exports just the payload types (no
-`<Module>Client`, no API classes). Use the types to type the inbound request body:
+These are the calls Enfuce makes **to you**: you host the endpoint and Enfuce POSTs to it. Such
+modules export only the payload types — there is no client to call, since your app receives these
+rather than requesting them. Use the types to type the inbound request body:
 
 ```typescript
 import type { issuerEvents } from '@enfuce/nextgen-sdk';
@@ -222,13 +222,13 @@ const decision: authorisationControl.AuthResponseBody = {
 | `transactionEvent` | `TransactionEvent` |
 
 > A runnable Express example of all of the above (both the API modules and the webhook receivers)
-> lives in [`examples/backends/typescript`](../../examples/backends/typescript).
+> lives in [`examples/backends/typescript`](https://gitlab.com/enfuce/mycore/client-sdks/-/tree/master/examples/backends/typescript).
 
-## File Parsing (model-only module)
+## File parsing
 
-Some specs describe a **file** Enfuce produces for you to ingest (not an HTTP API). These are shipped
-**model-only** too — the namespace exports just the types, and you parse the file's JSON into them.
-`clearingFileCopy` is a clearing (settlement) file: a `FileData` header plus a list of records.
+Enfuce delivers some data as a **file** rather than an HTTP API. These modules export only the
+types — parse the file's JSON into them. `clearingFileCopy` is a clearing (settlement) file: a
+`FileData` header plus a list of records.
 
 ```typescript
 import type { clearingFileCopy } from '@enfuce/nextgen-sdk';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@enfuce/nextgen-sdk",
-  "version": "0.0.9",
+  "version": "0.0.11",
   "description": "Enfuce nextgen client SDK (TypeScript). One namespaced export per API.",
   "publishConfig": {
     "access": "public"