docs: generate report

EXAMPLES.md

@@ -6,6 +6,7 @@
 - [Create Glossary](#create-glossary)
 - [Pre-Translate project](#pre-translate-project)
 - [Download translations](#download-translations)
+- [Generate report](#generate-report)
 
 ---
 
@@ -197,3 +198,36 @@ async function downloadTranslations(projectId: number): Promise<string> {
 downloadTranslations(123);
 
 ```
+
+## Generate report
+
+```typescript
+import crowdin from '@crowdin/crowdin-api-client';
+
+const { reportsApi } = new crowdin({
+    token: 'token',
+    organization: 'org'
+});
+
+async function downloadTranslations(projectId: number): Promise<string> {
+    const result = await reportsApi.generateReport(projectId, {
+        name: 'costs-estimation',
+        schema: {
+            languageId: 'uk',
+        },
+    });
+
+    let status = result.data.status;
+    while (status !== 'finished') {
+        const progress = await reportsApi.checkReportStatus(projectId, result.data.identifier);
+        status = progress.data.status;
+    }
+
+    const report = await reportsApi.downloadReport(projectId, result.data.identifier);
+
+    return report.data.url;
+}
+
+downloadTranslations(123);
+
+```

src/reports/index.ts

@@ -191,7 +191,7 @@ export namespace ReportsModel {
     }
 
     export interface GenerateReportRequest {
-        name: string;
+        name: 'costs-estimation' | 'translation-costs' | 'top-members' | 'contribution-raw-data';
         schema:
             | CostEstimateSchema
             | CostEstimateFuzzyModeSchema

tests/reports/api.test.ts

@@ -11,7 +11,7 @@ describe('Reports API', () => {
     const projectId = 2;
     const groupId = 23;
     const reportId = '123';
-    const reportName = 'testReport';
+    const reportName = 'costs-estimation';
     const downloadLink = 'test.com';
     const schema: ReportsModel.TopMembersSchema = {
         unit: 'chars',