@valeryverkhoturov/wb-api-client 1.20260920.0

package/README.md

@@ -0,0 +1,251 @@
+# wb-api-client — TypeScript
+
+Auto-generated TypeScript client for the [Wildberries Seller API](https://dev.wildberries.ru/). One package, thirteen sub-modules — one per API category. This README is regenerated on every release, so it always matches the code in this tree.
+
+## Install
+
+```bash
+npm install @valeryverkhoturov/wb-api-client
+```
+
+## Authentication
+
+Every module accepts the same WB bearer JWT. The token is stored in a redacting wrapper — an internal `SecretString` class — so it does not leak under logs / `console.log` unless you explicitly ask for the raw value with `.exposeSecret()`.
+
+```ts
+import { Configuration } from "@valeryverkhoturov/wb-api-client/items";
+
+const cfg = new Configuration({});
+cfg.setAccessToken("<your WB JWT>");
+```
+
+## Modules
+
+Each row below is a sub-module you can import independently. Import path is `@valeryverkhoturov/wb-api-client/<slug>`.
+
+| Slug | Category | APIs |
+|---|---|---|
+| [`general`](https://dev.wildberries.ru/openapi/api-information) | Общее | `APIApi`, `DefaultApi`, `WBAPIApi` |
+| [`items`](https://dev.wildberries.ru/openapi/item-management) | Работа с товарами | `DefaultApi` |
+| [`orders-fbs`](https://dev.wildberries.ru/openapi/orders-fbs) | Заказы FBS | `DefaultApi`, `FBSApi` |
+| [`orders-dbw`](https://dev.wildberries.ru/openapi/orders-dbw) | Заказы DBW | `DBWApi` |
+| [`dbs`](https://dev.wildberries.ru/openapi/dbs) | DBS | `DBSApi` |
+| [`in-store-pickup`](https://dev.wildberries.ru/openapi/in-store-pickup) | Самовывоз | `DefaultApi` |
+| [`orders-fbw`](https://dev.wildberries.ru/openapi/orders-fbw) | Поставки FBW | `DefaultApi` |
+| [`promotion`](https://dev.wildberries.ru/openapi/promotion) | Маркетинг и продвижение | `DefaultApi` |
+| [`communications`](https://dev.wildberries.ru/openapi/customer-communication) | Общение с покупателями | `DefaultApi` |
+| [`rates`](https://dev.wildberries.ru/openapi/rates) | Тарифы | `DefaultApi` |
+| [`analytics`](https://dev.wildberries.ru/openapi/analytics) | Аналитика и данные | `CSVApi`, `DefaultApi` |
+| [`reports`](https://dev.wildberries.ru/openapi/reports) | Отчёты | `CApi`, `DefaultApi` |
+| [`finances`](https://dev.wildberries.ru/openapi/documents-and-accounting) | Документы и бухгалтерия | `DefaultApi` |
+
+## Per-module usage
+
+### general — Общее
+
+В этом разделе: [общая информация о WB API](https://dev.wildberries.ru/openapi/api-information#tag/introduction) как [начать работу с WB API](https://dev.wildberries.ru/openapi/api-information#tag/introduction/Kak-nachat-rabotu-s-API) ка…
+
+**Reference:** https://dev.wildberries.ru/openapi/api-information
+
+**APIs:** `APIApi`, `DefaultApi`, `WBAPIApi`
+
+```ts
+import { Configuration, APIApi } from "@valeryverkhoturov/wb-api-client/general";
+
+const cfg = new Configuration({});
+cfg.setAccessToken("<your WB JWT>");
+const api = new APIApi(cfg);
+```
+
+### items — Работа с товарами
+
+С помощью методов этого раздела вы можете: [создавать](https://dev.wildberries.ru/openapi/item-management#tag/listingItems) и [редактировать](https://dev.wildberries.ru/openapi/item-management#tag/listings) карточки товаров получать [кат…
+
+**Reference:** https://dev.wildberries.ru/openapi/item-management
+
+**APIs:** `DefaultApi`
+
+```ts
+import { Configuration, DefaultApi } from "@valeryverkhoturov/wb-api-client/items";
+
+const cfg = new Configuration({});
+cfg.setAccessToken("<your WB JWT>");
+const api = new DefaultApi(cfg);
+```
+
+### orders-fbs — Заказы FBS
+
+С помощью методов раздела Заказы FBS (Fulfillment by Seller) вы можете: получать информацию о [сборочных заданиях](https://dev.wildberries.ru/openapi/orders-fbs#tag/fbsAssemblyOrders) и их статусах, отменять сборочные задания, получать с…
+
+**Reference:** https://dev.wildberries.ru/openapi/orders-fbs
+
+**APIs:** `DefaultApi`, `FBSApi`
+
+```ts
+import { Configuration, DefaultApi } from "@valeryverkhoturov/wb-api-client/orders-fbs";
+
+const cfg = new Configuration({});
+cfg.setAccessToken("<your WB JWT>");
+const api = new DefaultApi(cfg);
+```
+
+### orders-dbw — Заказы DBW
+
+С помощью методов Заказы DBW (Деливери WB) вы можете: получать информацию о [сборочных заданиях](https://dev.wildberries.ru/openapi/orders-dbw#tag/dbwAssemblyOrders), управлять статусами и отменять сборочные задания получать, добавлять,…
+
+**Reference:** https://dev.wildberries.ru/openapi/orders-dbw
+
+**APIs:** `DBWApi`
+
+```ts
+import { Configuration, DBWApi } from "@valeryverkhoturov/wb-api-client/orders-dbw";
+
+const cfg = new Configuration({});
+cfg.setAccessToken("<your WB JWT>");
+const api = new DBWApi(cfg);
+```
+
+### dbs — DBS
+
+Узнать больше о модели DBS можно в [справочном центре](https://seller.wildberries.ru/instructions/category/6572e024-7428-4db1-86a8-a4c7dbebbfcf?goBackOption=prevRoute&categoryId=5a8e1202-0865-45b7-acae-5d0afc7add56)
+
+**Reference:** https://dev.wildberries.ru/openapi/dbs
+
+**APIs:** `DBSApi`
+
+```ts
+import { Configuration, DBSApi } from "@valeryverkhoturov/wb-api-client/dbs";
+
+const cfg = new Configuration({});
+cfg.setAccessToken("<your WB JWT>");
+const api = new DBSApi(cfg);
+```
+
+### in-store-pickup — Самовывоз
+
+Управление [сборочными заданиями](https://dev.wildberries.ru/openapi/in-store-pickup#tag/inStorePickupAssemblyOrders) и [идентификаторами маркировки](https://dev.wildberries.ru/openapi/in-store-pickup#tag/inStorePickupLabelIdentifiers) С…
+
+**Reference:** https://dev.wildberries.ru/openapi/in-store-pickup
+
+**APIs:** `DefaultApi`
+
+```ts
+import { Configuration, DefaultApi } from "@valeryverkhoturov/wb-api-client/in-store-pickup";
+
+const cfg = new Configuration({});
+cfg.setAccessToken("<your WB JWT>");
+const api = new DefaultApi(cfg);
+```
+
+### orders-fbw — Поставки FBW
+
+Узнать больше о поставках FBW можно в [справочном центре](https://seller.wildberries.ru/instructions/subcategory/5a8e1202-0865-45b7-acae-5d0afc7add56?goBackOption=prevRoute&categoryId=479385c6-de01-4b4d-ad4e-ed941e65582e)
+
+**Reference:** https://dev.wildberries.ru/openapi/orders-fbw
+
+**APIs:** `DefaultApi`
+
+```ts
+import { Configuration, DefaultApi } from "@valeryverkhoturov/wb-api-client/orders-fbw";
+
+const cfg = new Configuration({});
+cfg.setAccessToken("<your WB JWT>");
+const api = new DefaultApi(cfg);
+```
+
+### promotion — Маркетинг и продвижение
+
+Узнать больше о маркетинге и продвижении можно в [справочном центре](https://seller.wildberries.ru/instructions/category/59d92bd3-6ea0-40f2-b762-ca8835d7d42e?goBackOption=prevRoute&categoryId=479385c6-de01-4b4d-ad4e-ed941e65582e)
+
+**Reference:** https://dev.wildberries.ru/openapi/promotion
+
+**APIs:** `DefaultApi`
+
+```ts
+import { Configuration, DefaultApi } from "@valeryverkhoturov/wb-api-client/promotion";
+
+const cfg = new Configuration({});
+cfg.setAccessToken("<your WB JWT>");
+const api = new DefaultApi(cfg);
+```
+
+### communications — Общение с покупателями
+
+Узнать больше об общении с покупателями можно в [справочном центре](https://seller.wildberries.ru/instructions/category/f7f6c465-dd12-422d-80a0-a6d9562115d5?goBackOption=prevRoute&categoryId=30817062-14cc-4a82-bc78-3600c2b0685b)
+
+**Reference:** https://dev.wildberries.ru/openapi/customer-communication
+
+**APIs:** `DefaultApi`
+
+```ts
+import { Configuration, DefaultApi } from "@valeryverkhoturov/wb-api-client/communications";
+
+const cfg = new Configuration({});
+cfg.setAccessToken("<your WB JWT>");
+const api = new DefaultApi(cfg);
+```
+
+### rates — Тарифы
+
+Узнать больше о тарифах можно в [справочном центре](https://seller.wildberries.ru/instructions/ru/ru/material/fees-site-section)
+
+**Reference:** https://dev.wildberries.ru/openapi/rates
+
+**APIs:** `DefaultApi`
+
+```ts
+import { Configuration, DefaultApi } from "@valeryverkhoturov/wb-api-client/rates";
+
+const cfg = new Configuration({});
+cfg.setAccessToken("<your WB JWT>");
+const api = new DefaultApi(cfg);
+```
+
+### analytics — Аналитика и данные
+
+Узнать больше об аналитике и данных можно в [справочном центре](https://seller.wildberries.ru/instructions/ru/ru/subcategory/seller-analytics)
+
+**Reference:** https://dev.wildberries.ru/openapi/analytics
+
+**APIs:** `CSVApi`, `DefaultApi`
+
+```ts
+import { Configuration, CSVApi } from "@valeryverkhoturov/wb-api-client/analytics";
+
+const cfg = new Configuration({});
+cfg.setAccessToken("<your WB JWT>");
+const api = new CSVApi(cfg);
+```
+
+### reports — Отчёты
+
+Узнать больше об отчётах можно в [справочном центре](https://seller.wildberries.ru/instructions/subcategory/5f2162c5-069b-416d-a4e1-48da2a76e6b0)
+
+**Reference:** https://dev.wildberries.ru/openapi/reports
+
+**APIs:** `CApi`, `DefaultApi`
+
+```ts
+import { Configuration, CApi } from "@valeryverkhoturov/wb-api-client/reports";
+
+const cfg = new Configuration({});
+cfg.setAccessToken("<your WB JWT>");
+const api = new CApi(cfg);
+```
+
+### finances — Документы и бухгалтерия
+
+Узнать больше о документах и бухгалтерии можно в [справочном центре](https://seller.wildberries.ru/instructions/category/ba929b64-1f89-4426-82d7-ce998ee552bd?goBackOption=prevRoute&categoryId=3c971375-9939-45e8-ab82-376019be8942)
+
+**Reference:** https://dev.wildberries.ru/openapi/documents-and-accounting
+
+**APIs:** `DefaultApi`
+
+```ts
+import { Configuration, DefaultApi } from "@valeryverkhoturov/wb-api-client/finances";
+
+const cfg = new Configuration({});
+cfg.setAccessToken("<your WB JWT>");
+const api = new DefaultApi(cfg);
+```
+