Skip to content

Commit dbceccc

Browse files
committed
fix(docs): Correct SDK method name getOrdersNew in all documentation
Fix incorrect method name getNewOrders() to getOrdersNew() throughout the codebase. The SDK method is named getOrdersNew(), not getNewOrders(). This fixes CI validation errors that were incorrectly flagging valid SDK method calls as non-existent. Changes: - Examples: Fixed 5 TypeScript files - Documentation: Fixed 14 markdown files - Both ordersFBS and inStorePickup modules affected Files modified: - examples/orders-fbs-fulfillment.ts - examples/integration-product-order-finance.ts - examples/in-store-pickup-workflow.ts - docs/FAQ.md, GLOSSARY.md, performance-tuning.md - docs/ru/README.md, FAQ.md, GLOSSARY.md, performance-tuning.md - docs/examples/* (multiple files) - docs/api/classes/* (TypeDoc generated files) Historical files in docs/stories/ and docs/qa/stories/ were intentionally left unchanged as they represent task specifications and historical records.
1 parent 1509197 commit dbceccc

19 files changed

+34
-34
lines changed

docs/FAQ.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -207,7 +207,7 @@ console.log(result.nmId); // New product ID
207207
### 13. How do I fetch new orders (FBS)?
208208

209209
```typescript
210-
const orders = await sdk.ordersFBS.getNewOrders();
210+
const orders = await sdk.ordersFBS.getOrdersNew();
211211

212212
for (const order of orders.orders) {
213213
console.log(`Order ${order.orderId}: ${order.status}`);
@@ -525,7 +525,7 @@ export const handler = async (event) => {
525525
timeout: 25000 // Lambda timeout - 5s buffer
526526
});
527527

528-
const orders = await sdk.ordersFBS.getNewOrders();
528+
const orders = await sdk.ordersFBS.getOrdersNew();
529529
return { statusCode: 200, body: JSON.stringify(orders) };
530530
};
531531
```

docs/GLOSSARY.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -413,7 +413,7 @@ Main SDK class serving as entry point and module aggregator. Exposes all 11 API
413413
```typescript
414414
const sdk = new WildberriesSDK({ apiKey });
415415
sdk.products.getProductList();
416-
sdk.ordersFBS.getNewOrders();
416+
sdk.ordersFBS.getOrdersNew();
417417
```
418418

419419
**Location:** `src/index.ts`

docs/api/classes/MetadataValidationError.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ try {
3131
console.log('Current status:', statuses.orders[0].supplierStatus);
3232

3333
// Check required metadata
34-
const newOrders = await sdk.inStorePickup.getNewOrders();
34+
const newOrders = await sdk.inStorePickup.getOrdersNew();
3535
const order = newOrders.orders.find(o => o.id === 12345);
3636
console.log('Required metadata:', order?.requiredMeta);
3737
}

docs/api/classes/WildberriesSDK.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -95,12 +95,12 @@ const sdk = new WildberriesSDK({
9595
| ------ | ------ | ------ | ------ | ------ |
9696
| <a id="general"></a> `general` | `readonly` | [`GeneralModule`](GeneralModule.md) | General API module Provides access to general utility endpoints: - Ping (connectivity testing) - Server timestamps **See** [GeneralModule](GeneralModule.md) for available methods **Example** `const response = await sdk.general.ping(); console.log('Server time:', response.TS);` | [index.ts:92](https://github.com/salacoste/daytona-wildberries-typescript-sdk/blob/c8fc381eae7a16d563b3d9f7ec9624f796368e0c/src/index.ts#L92) |
9797
| <a id="products"></a> `products` | `readonly` | [`ProductsModule`](ProductsModule.md) | Products API module Provides access to product management endpoints: - Product card creation and editing - Category and characteristic management - Media (images, videos) upload - Pricing and stock management **See** [ProductsModule](ProductsModule.md) for available methods **Example** `// Get parent categories const parents = await sdk.products.getParentAll(); // Get categories by parent const categories = await sdk.products.getObjectAll({ parentID: 479 }); // Get characteristics for a category const characteristics = await sdk.products.getObjectCharc(105);` | [index.ts:117](https://github.com/salacoste/daytona-wildberries-typescript-sdk/blob/c8fc381eae7a16d563b3d9f7ec9624f796368e0c/src/index.ts#L117) |
98-
| <a id="ordersfbs"></a> `ordersFBS` | `readonly` | [`OrdersFbsModule`](OrdersFbsModule.md) | Orders FBS (Fulfillment by Seller) API module Provides access to FBS order management endpoints: - New order retrieval - Order listing with filters and pagination - Order status tracking (supplier and WB system status) **See** [OrdersFbsModule](OrdersFbsModule.md) for available methods **Example** `// Get new orders awaiting processing const newOrders = await sdk.ordersFBS.getNewOrders(); // Get orders from last 7 days const sevenDaysAgo = Math.floor(Date.now() / 1000) - (7 * 24 * 60 * 60); const orders = await sdk.ordersFBS.getOrders({ dateFrom: sevenDaysAgo }); // Check order statuses const orderIds = orders.orders.map(o => o.id); const statuses = await sdk.ordersFBS.getOrderStatuses(orderIds);` | [index.ts:143](https://github.com/salacoste/daytona-wildberries-typescript-sdk/blob/c8fc381eae7a16d563b3d9f7ec9624f796368e0c/src/index.ts#L143) |
98+
| <a id="ordersfbs"></a> `ordersFBS` | `readonly` | [`OrdersFbsModule`](OrdersFbsModule.md) | Orders FBS (Fulfillment by Seller) API module Provides access to FBS order management endpoints: - New order retrieval - Order listing with filters and pagination - Order status tracking (supplier and WB system status) **See** [OrdersFbsModule](OrdersFbsModule.md) for available methods **Example** `// Get new orders awaiting processing const newOrders = await sdk.ordersFBS.getOrdersNew(); // Get orders from last 7 days const sevenDaysAgo = Math.floor(Date.now() / 1000) - (7 * 24 * 60 * 60); const orders = await sdk.ordersFBS.getOrders({ dateFrom: sevenDaysAgo }); // Check order statuses const orderIds = orders.orders.map(o => o.id); const statuses = await sdk.ordersFBS.getOrderStatuses(orderIds);` | [index.ts:143](https://github.com/salacoste/daytona-wildberries-typescript-sdk/blob/c8fc381eae7a16d563b3d9f7ec9624f796368e0c/src/index.ts#L143) |
9999
| <a id="ordersfbw"></a> `ordersFBW` | `readonly` | [`OrdersFbwModule`](OrdersFbwModule.md) | Orders FBW (Fulfillment by Wildberries) API module Provides access to FBW warehouse supply and acceptance endpoints: - Warehouse selection and availability - Acceptance coefficient checking - Supply planning and management - Transit tariff calculation **See** [OrdersFbwModule](OrdersFbwModule.md) for available methods **Example** `// Get available warehouses const warehouses = await sdk.ordersFBW.getWarehouses(); // Check acceptance coefficients for next 14 days const coefficients = await sdk.ordersFBW.getAcceptanceCoefficients(); // Get acceptance options for goods const goods = [{ barcode: '1234567891234', quantity: 10 }]; const options = await sdk.ordersFBW.getAcceptanceOptions(goods); // Get supply details const details = await sdk.ordersFBW.getSupplyDetails(12345);` | [index.ts:172](https://github.com/salacoste/daytona-wildberries-typescript-sdk/blob/c8fc381eae7a16d563b3d9f7ec9624f796368e0c/src/index.ts#L172) |
100100
| <a id="finances"></a> `finances` | `readonly` | [`FinancesModule`](FinancesModule.md) | Finances API module Provides access to financial data endpoints: - Balance and transaction retrieval - Financial reports (sales reports by period) - Document management (categories, list, download) **See** [FinancesModule](FinancesModule.md) for available methods **Example** `// Get current balance const balance = await sdk.finances.getBalance(); console.log(`Available: ${balance.for_withdraw} ${balance.currency}`); // Get transaction history const transactions = await sdk.finances.getTransactions({ dateFrom: '2024-01-01', dateTo: '2024-01-31', period: 'weekly' }); // Download documents const docs = await sdk.finances.getDocuments();` | [index.ts:201](https://github.com/salacoste/daytona-wildberries-typescript-sdk/blob/c8fc381eae7a16d563b3d9f7ec9624f796368e0c/src/index.ts#L201) |
101101
| <a id="analytics"></a> `analytics` | `readonly` | [`AnalyticsModule`](AnalyticsModule.md) | Analytics API module Provides access to analytics and reporting endpoints: - Sales funnel conversion metrics - Product performance tracking - Search query analysis - Category-level analytics - CSV report generation **See** [AnalyticsModule](AnalyticsModule.md) for available methods **Example** `// Get sales funnel metrics const funnel = await sdk.analytics.getSalesFunnel({ period: { begin: '2024-01-01 00:00:00', end: '2024-01-31 23:59:59' } }); // Track product performance const performance = await sdk.analytics.getProductPerformance( [12345, 67890], { from: '2024-01-01', to: '2024-01-31' } );` | [index.ts:232](https://github.com/salacoste/daytona-wildberries-typescript-sdk/blob/c8fc381eae7a16d563b3d9f7ec9624f796368e0c/src/index.ts#L232) |
102102
| <a id="communications"></a> `communications` | `readonly` | [`CommunicationsModule`](CommunicationsModule.md) | Communications API module Provides access to customer communication endpoints: **Chat Management:** - Get all chat conversations - Poll for new chat events - Send messages to customers (with file attachments) - Extract chat metadata (replySign, chatID) **Product Q&A Management:** - Get product questions (answered/unanswered, with filtering) - Answer or reject customer questions - Mark questions as viewed **Customer Reviews Management:** - Get customer reviews (answered/unanswered, with filtering) - View review details (text, photos, videos, ratings) - Respond to reviews - Edit review responses **See** [CommunicationsModule](CommunicationsModule.md) for available methods **Example** `// Chat: Get all chats and send a message const chats = await sdk.communications.getChats(); const replySign = chats.result[0].replySign; await sdk.communications.sendMessage(replySign, 'Thank you for your message!'); // Q&A: Get and answer product questions const questions = await sdk.communications.getQuestions({ isAnswered: false, take: 10, skip: 0, }); await sdk.communications.answerQuestion(questions.data.questions[0].id, 'This product is made of cotton.'); // Reviews: Get and respond to customer reviews const reviews = await sdk.communications.getReviews({ isAnswered: false, take: 10, skip: 0, }); await sdk.communications.respondToReview(reviews.data.feedbacks[0].id, 'Thank you for your feedback!');` | [index.ts:282](https://github.com/salacoste/daytona-wildberries-typescript-sdk/blob/c8fc381eae7a16d563b3d9f7ec9624f796368e0c/src/index.ts#L282) |
103103
| <a id="reports"></a> `reports` | `readonly` | [`ReportsModule`](ReportsModule.md) | Reports API module Provides access to reporting and analytics data endpoints: - Inbound shipments (incomes) with pagination - Stock levels with quantity breakdown - Customer orders tracking - Sales and returns analysis - Excise/compliance reports - Async warehouse remains reports **See** [ReportsModule](ReportsModule.md) for available methods **Example** `// Get inbound shipments const incomes = await sdk.reports.getIncomes('2024-01-01'); // Get current stock levels const stocks = await sdk.reports.getStocks('2024-01-01'); // Generate and download warehouse remains report const task = await sdk.reports.createWarehouseRemainsReport({ locale: 'ru' }); const status = await sdk.reports.checkReportStatus(task.data.taskId, 'warehouse_remains'); if (status.data.status === 'done') { const blob = await sdk.reports.downloadReport(task.data.taskId, 'warehouse_remains'); }` | [index.ts:313](https://github.com/salacoste/daytona-wildberries-typescript-sdk/blob/c8fc381eae7a16d563b3d9f7ec9624f796368e0c/src/index.ts#L313) |
104104
| <a id="promotion"></a> `promotion` | `readonly` | [`PromotionModule`](PromotionModule.md) | Promotion API module Provides access to promotional campaign endpoints: - Campaign creation, management, and control - Campaign count and information retrieval - Auction (manual bid) campaign management - Configuration values and minimum bids - Budget deposits and management - Product and category selection for campaigns - Statistics and performance tracking **See** [PromotionModule](PromotionModule.md) for available methods **Example** `// Get campaign count summary const summary = await sdk.promotion.getPromotionCount(); // Create a new campaign const campaignId = await sdk.promotion.createSeacatSaveAd({ name: 'Winter Sale Campaign', nms: [12345, 67890], bid_type: 'manual', placement_types: ['search', 'recommendations'] }); // Get minimum bids for products const minBids = await sdk.promotion.createBidsMin({ advert_id: campaignId, nm_ids: [12345, 67890], payment_type: 'cpm', placement_types: ['search', 'recommendation'] });` | [index.ts:351](https://github.com/salacoste/daytona-wildberries-typescript-sdk/blob/c8fc381eae7a16d563b3d9f7ec9624f796368e0c/src/index.ts#L351) |
105105
| <a id="tariffs"></a> `tariffs` | `readonly` | [`TariffsModule`](TariffsModule.md) | Tariffs API module Provides access to tariff and commission information: - Commission rates by category - Box storage tariffs - Pallet storage tariffs - Return handling tariffs **See** [TariffsModule](TariffsModule.md) for available methods **Example** `// Get commission rates for all categories const commissions = await sdk.tariffs.getTariffsCommission(); // Get box storage tariffs const boxTariffs = await sdk.tariffs.getTariffsBox(); // Get pallet storage tariffs const palletTariffs = await sdk.tariffs.getTariffsPallet(); // Get return handling tariffs const returnTariffs = await sdk.tariffs.getTariffsReturn();` | [index.ts:379](https://github.com/salacoste/daytona-wildberries-typescript-sdk/blob/c8fc381eae7a16d563b3d9f7ec9624f796368e0c/src/index.ts#L379) |
106-
| <a id="instorepickup"></a> `inStorePickup` | `readonly` | [`InStorePickupModule`](InStorePickupModule.md) | In-Store Pickup API module (Click & Collect) Provides comprehensive methods for managing click & collect orders: - Order assembly lifecycle management (new → confirm → prepare → receive/reject) - Customer verification at pickup - Product metadata management (SGTIN, UIN, IMEI, GTIN) - Order queries and status tracking **See** [InStorePickupModule](InStorePickupModule.md) for available methods **Examples** `// 1. Get new pickup orders const newOrders = await sdk.inStorePickup.getNewOrders(); const order = newOrders.orders[0]; // 2. Confirm and start assembly await sdk.inStorePickup.confirmOrder(order.id); // 3. Complete assembly await sdk.inStorePickup.prepareOrder(order.id); // 4. Customer arrives - verify identity const verification = await sdk.inStorePickup.verifyCustomerIdentity({ orderCode: order.orderCode, passcode: '1234' // From customer's app }); // 5. Complete handover await sdk.inStorePickup.receiveOrder(order.id);` `// Set SGTIN codes (Честный знак marking) await sdk.inStorePickup.setSGTINCode(orderId, ['1234567890123456']); // Set IMEI for electronics await sdk.inStorePickup.setIMEICode(orderId, '123456789012345'); // Get all metadata const metadata = await sdk.inStorePickup.getOrderMetadata(orderId);` | [index.ts:426](https://github.com/salacoste/daytona-wildberries-typescript-sdk/blob/c8fc381eae7a16d563b3d9f7ec9624f796368e0c/src/index.ts#L426) |
106+
| <a id="instorepickup"></a> `inStorePickup` | `readonly` | [`InStorePickupModule`](InStorePickupModule.md) | In-Store Pickup API module (Click & Collect) Provides comprehensive methods for managing click & collect orders: - Order assembly lifecycle management (new → confirm → prepare → receive/reject) - Customer verification at pickup - Product metadata management (SGTIN, UIN, IMEI, GTIN) - Order queries and status tracking **See** [InStorePickupModule](InStorePickupModule.md) for available methods **Examples** `// 1. Get new pickup orders const newOrders = await sdk.inStorePickup.getOrdersNew(); const order = newOrders.orders[0]; // 2. Confirm and start assembly await sdk.inStorePickup.confirmOrder(order.id); // 3. Complete assembly await sdk.inStorePickup.prepareOrder(order.id); // 4. Customer arrives - verify identity const verification = await sdk.inStorePickup.verifyCustomerIdentity({ orderCode: order.orderCode, passcode: '1234' // From customer's app }); // 5. Complete handover await sdk.inStorePickup.receiveOrder(order.id);` `// Set SGTIN codes (Честный знак marking) await sdk.inStorePickup.setSGTINCode(orderId, ['1234567890123456']); // Set IMEI for electronics await sdk.inStorePickup.setIMEICode(orderId, '123456789012345'); // Get all metadata const metadata = await sdk.inStorePickup.getOrderMetadata(orderId);` | [index.ts:426](https://github.com/salacoste/daytona-wildberries-typescript-sdk/blob/c8fc381eae7a16d563b3d9f7ec9624f796368e0c/src/index.ts#L426) |

docs/examples/advanced/custom-retry.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -320,7 +320,7 @@ async function withFallback<T>(
320320

321321
// Usage: Try real-time data, fall back to cached
322322
const orders = await withFallback(
323-
() => sdk.ordersFBS.getNewOrders(),
323+
() => sdk.ordersFBS.getOrdersNew(),
324324
() => getCachedOrders() // Your caching implementation
325325
);
326326
```

docs/examples/advanced/multi-module.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ async function getOrderDashboard(): Promise<OrderDashboard> {
3131
questionsResponse,
3232
reviewsResponse
3333
] = await Promise.all([
34-
sdk.ordersFBS.getNewOrders(),
34+
sdk.ordersFBS.getOrdersNew(),
3535
sdk.finances.getBalance(),
3636
sdk.communications.getQuestionsCountUnanswered(),
3737
sdk.communications.getReviewsCount({ isAnswered: false })
@@ -65,7 +65,7 @@ async function processNewOrders(): Promise<OrderFulfillmentResult[]> {
6565
const results: OrderFulfillmentResult[] = [];
6666

6767
// 1. Get new orders
68-
const { orders } = await sdk.ordersFBS.getNewOrders();
68+
const { orders } = await sdk.ordersFBS.getOrdersNew();
6969

7070
if (!orders?.length) {
7171
console.log('No new orders to process');

docs/examples/basic/single-call.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -73,8 +73,8 @@ Total balance: 150000.00 RUB
7373
### Get New Orders (FBS)
7474

7575
```typescript
76-
async function getNewOrders() {
77-
const orders = await sdk.ordersFBS.getNewOrders();
76+
async function getOrdersNew() {
77+
const orders = await sdk.ordersFBS.getOrdersNew();
7878

7979
console.log('New orders count:', orders.orders?.length ?? 0);
8080

@@ -88,7 +88,7 @@ async function getNewOrders() {
8888
return orders;
8989
}
9090

91-
getNewOrders();
91+
getOrdersNew();
9292
```
9393

9494
### Get Commission Tariffs

docs/examples/intermediate/batch-operations.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ async function fetchAllData() {
4747
] = await Promise.all([
4848
sdk.products.getParentAll(),
4949
sdk.finances.getBalance(),
50-
sdk.ordersFBS.getNewOrders(),
50+
sdk.ordersFBS.getOrdersNew(),
5151
sdk.tariffs.getTariffsCommission()
5252
]);
5353

docs/examples/intermediate/rate-limiting.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ async function fetchMultipleEndpoints() {
3636
const [categories, balance, orders] = await Promise.all([
3737
sdk.products.getParentAll(),
3838
sdk.finances.getBalance(),
39-
sdk.ordersFBS.getNewOrders()
39+
sdk.ordersFBS.getOrdersNew()
4040
]);
4141

4242
return { categories, balance, orders };

docs/examples/use-cases/order-processing.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@ const sdk = new WildberriesSDK({
1515
apiKey: process.env.WB_API_KEY!
1616
});
1717

18-
async function getNewOrders() {
19-
const response = await sdk.ordersFBS.getNewOrders();
18+
async function getOrdersNew() {
19+
const response = await sdk.ordersFBS.getOrdersNew();
2020

2121
console.log(`New orders: ${response.orders?.length ?? 0}`);
2222

@@ -31,7 +31,7 @@ async function getNewOrders() {
3131
return response.orders ?? [];
3232
}
3333

34-
const orders = await getNewOrders();
34+
const orders = await getOrdersNew();
3535
```
3636

3737
## Get Orders with Filters
@@ -142,7 +142,7 @@ async function processNewOrders(): Promise<ProcessedOrder[]> {
142142
const results: ProcessedOrder[] = [];
143143

144144
// 1. Get new orders
145-
const { orders } = await sdk.ordersFBS.getNewOrders();
145+
const { orders } = await sdk.ordersFBS.getOrdersNew();
146146

147147
if (!orders?.length) {
148148
console.log('No new orders to process');

0 commit comments

Comments
 (0)