From d802fb3f22003245707bd2836fe3a9017f92cf19 Mon Sep 17 00:00:00 2001
From: martian56 <fuadelizade469@gmail.com>
Date: Wed, 22 Jul 2026 12:41:10 +0400
Subject: [PATCH] docs: document the enums and use them in the examples

The enums shipped in 0.2.0 with no mention in the README, and the config examples
still passed bare strings. Every snippet here was compiled or run before landing.
---
 CHANGELOG.md |  5 +++++
 README.md    | 40 ++++++++++++++++++++++++++++++++++++++--
 package.json |  2 +-
 3 files changed, 44 insertions(+), 3 deletions(-)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index 24f233e..e686bf2 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -1,5 +1,10 @@
 # Changelog
 
+## 0.2.1
+
+- The README documents the enums and uses them in its examples, instead of the bare strings it
+  still showed.
+
 ## 0.2.0
 
 - Enums for the values the API uses: `Status`, `CardStatus`, `InvoiceStatus`, `B2BStatus`,
diff --git a/README.md b/README.md
index c55e162..19b4d9c 100644
--- a/README.md
+++ b/README.md
@@ -43,12 +43,14 @@ try {
 ## Configuration
 
 ```ts
+import { Currency, EpointClient, Language } from '@martian56/epoint'
+
 new EpointClient({
   publicKey: 'i000000001',
   privateKey: 'your-private-key',
   baseUrl: 'https://epoint.az',
-  language: 'az',
-  currency: 'AZN',
+  language: Language.AZ,
+  currency: Currency.AZN,
   successRedirectUrl: 'https://shop.example/thanks',
   errorRedirectUrl: 'https://shop.example/failed',
 })
@@ -91,6 +93,40 @@ status.raw           // the full response object, snake_case
 
 `getInstallmentPlans` resolves to an array and `listWallets` to a record.
 
+## Enums
+
+Every value the API uses has an enum. They come from the sandbox's own definitions, so they match
+what production sends. Each is a const object with a matching type, so you get both the values
+and the union, and a plain string still works anywhere an enum is accepted.
+
+```ts
+import { Currency, EpointClient, Language, Status } from '@martian56/epoint'
+
+const client = EpointClient.fromEnv({ language: Language.EN, currency: Currency.USD })
+
+const status = await client.getStatus(transaction)
+if (status.status === Status.SUCCESS) {
+  await fulfil(orderId)
+}
+```
+
+| Enum | Values |
+|---|---|
+| `Status` | new, success, failed, error, returned, server_error |
+| `CardStatus` | new, active, pending, rejected, expired, session_expired |
+| `InvoiceStatus` | waiting_for_payment, paid, canceled |
+| `B2BStatus` | PENDING, PROCESSING, SUCCESS, FAILED |
+| `OperationCode` | 001 card registration, 100 payment, 200 registration with payment |
+| `Language` | az, en, ru |
+| `Currency` | AZN, USD, EUR, RUB |
+
+Currency is not uniform across the API. Checkout takes all four, but split, pre-auth, refund,
+reverse, payout and wallet take AZN and nothing else. `SUPPORTED_CURRENCIES` and `AZN_ONLY` hold
+those two sets.
+
+`SETTLED_STATUSES` is what `ok` checks, and `USABLE_CARD_STATUSES` is the set a card has to be in
+before you can charge it.
+
 ## Methods
 
 | Group | Methods |
diff --git a/package.json b/package.json
index 0b13cba..1d0ddaf 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@martian56/epoint",
-  "version": "0.2.0",
+  "version": "0.2.1",
   "description": "TypeScript client for the epoint.az payment gateway",
   "type": "module",
   "license": "MIT",