@rasadov/lumoar-sdk 1.2.6 → 1.3.0

package/docs/ReportGenerate.md

@@ -6,6 +6,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **report_id** | **string** |  | [default to undefined]
+**task_id** | **string** |  | [optional] [default to undefined]
 
 ## Example
 
@@ -14,6 +15,7 @@ import { ReportGenerate } from './api';
 
 const instance: ReportGenerate = {
     report_id,
+    task_id,
 };
 ```
 

package/docs/ReportsApi.md

@@ -7,6 +7,7 @@ All URIs are relative to *http://localhost*
 |[**exportReportV1ReportsExportReportIdGet**](#exportreportv1reportsexportreportidget) | **GET** /v1/reports/export/{report_id} | Export Report|
 |[**generateReportV1ReportsGeneratePost**](#generatereportv1reportsgeneratepost) | **POST** /v1/reports/generate | Generate Report|
 |[**getEvidenceV1ReportsEvidenceReportIdEvidenceIdGet**](#getevidencev1reportsevidencereportidevidenceidget) | **GET** /v1/reports/evidence/{report_id}/{evidence_id} | Get Evidence|
+|[**getReportGenerationStatusV1ReportsGenerateTaskIdStatusGet**](#getreportgenerationstatusv1reportsgeneratetaskidstatusget) | **GET** /v1/reports/generate/{task_id}/status | Get Report Generation Status|
 |[**listReportsV1ReportsListCompanyIdGet**](#listreportsv1reportslistcompanyidget) | **GET** /v1/reports/list/{company_id} | List Reports|
 
 # **exportReportV1ReportsExportReportIdGet**
@@ -83,12 +84,14 @@ const apiInstance = new ReportsApi(configuration);
 
 let companyId: string; // (default to undefined)
 let reportType: ReportType; // (default to undefined)
+let title: string; // (optional) (default to undefined)
 let authorization: string; // (optional) (default to undefined)
 let sessionId: string; // (optional) (default to undefined)
 
 const { status, data } = await apiInstance.generateReportV1ReportsGeneratePost(
     companyId,
     reportType,
+    title,
     authorization,
     sessionId
 );
@@ -100,6 +103,7 @@ const { status, data } = await apiInstance.generateReportV1ReportsGeneratePost(
 |------------- | ------------- | ------------- | -------------|
 | **companyId** | [**string**] |  | defaults to undefined|
 | **reportType** | **ReportType** |  | defaults to undefined|
+| **title** | [**string**] |  | (optional) defaults to undefined|
 | **authorization** | [**string**] |  | (optional) defaults to undefined|
 | **sessionId** | [**string**] |  | (optional) defaults to undefined|
 
@@ -178,6 +182,64 @@ No authorization required
  - **Accept**: application/json
 
 
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Successful Response |  -  |
+|**422** | Validation Error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **getReportGenerationStatusV1ReportsGenerateTaskIdStatusGet**
+> TaskStatusResponse getReportGenerationStatusV1ReportsGenerateTaskIdStatusGet()
+
+Check the status of a report generation background job
+
+### Example
+
+```typescript
+import {
+    ReportsApi,
+    Configuration
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new ReportsApi(configuration);
+
+let taskId: string; // (default to undefined)
+let authorization: string; // (optional) (default to undefined)
+let sessionId: string; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.getReportGenerationStatusV1ReportsGenerateTaskIdStatusGet(
+    taskId,
+    authorization,
+    sessionId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **taskId** | [**string**] |  | defaults to undefined|
+| **authorization** | [**string**] |  | (optional) defaults to undefined|
+| **sessionId** | [**string**] |  | (optional) defaults to undefined|
+
+
+### Return type
+
+**TaskStatusResponse**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
 ### HTTP response details
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|

package/docs/RolesApi.md

@@ -140,11 +140,13 @@ const configuration = new Configuration();
 const apiInstance = new RolesApi(configuration);
 
 let inviteToCompany: InviteToCompany; //
+let companyId: string; // (optional) (default to undefined)
 let authorization: string; // (optional) (default to undefined)
 let sessionId: string; // (optional) (default to undefined)
 
 const { status, data } = await apiInstance.inviteV1RolesInvitesPost(
     inviteToCompany,
+    companyId,
     authorization,
     sessionId
 );
@@ -155,6 +157,7 @@ const { status, data } = await apiInstance.inviteV1RolesInvitesPost(
 |Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
 | **inviteToCompany** | **InviteToCompany**|  | |
+| **companyId** | [**string**] |  | (optional) defaults to undefined|
 | **authorization** | [**string**] |  | (optional) defaults to undefined|
 | **sessionId** | [**string**] |  | (optional) defaults to undefined|
 
@@ -198,11 +201,13 @@ const configuration = new Configuration();
 const apiInstance = new RolesApi(configuration);
 
 let removeFromCompany: RemoveFromCompany; //
+let companyId: string; // (optional) (default to undefined)
 let authorization: string; // (optional) (default to undefined)
 let sessionId: string; // (optional) (default to undefined)
 
 const { status, data } = await apiInstance.removePeopleV1RolesInvitesDelete(
     removeFromCompany,
+    companyId,
     authorization,
     sessionId
 );
@@ -213,6 +218,7 @@ const { status, data } = await apiInstance.removePeopleV1RolesInvitesDelete(
 |Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
 | **removeFromCompany** | **RemoveFromCompany**|  | |
+| **companyId** | [**string**] |  | (optional) defaults to undefined|
 | **authorization** | [**string**] |  | (optional) defaults to undefined|
 | **sessionId** | [**string**] |  | (optional) defaults to undefined|
 

package/docs/SchedulerResponse.md

@@ -0,0 +1,23 @@
+# SchedulerResponse
+
+Response schema for task scheduler request
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**task_id** | **string** |  | [default to undefined]
+**details** | **string** |  | [optional] [default to 'Task scheduler has been successfully started']
+
+## Example
+
+```typescript
+import { SchedulerResponse } from './api';
+
+const instance: SchedulerResponse = {
+    task_id,
+    details,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/TaskStatusResponse.md

@@ -0,0 +1,29 @@
+# TaskStatusResponse
+
+Response schema for checking Celery task status
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**task_id** | **string** |  | [default to undefined]
+**status** | **string** |  | [default to undefined]
+**result** | **{ [key: string]: any; }** |  | [optional] [default to undefined]
+**error** | **string** |  | [optional] [default to undefined]
+**progress** | **{ [key: string]: any; }** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { TaskStatusResponse } from './api';
+
+const instance: TaskStatusResponse = {
+    task_id,
+    status,
+    result,
+    error,
+    progress,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/TasksApi.md

@@ -6,6 +6,7 @@ All URIs are relative to *http://localhost*
 |------------- | ------------- | -------------|
 |[**createTaskV1TasksPost**](#createtaskv1taskspost) | **POST** /v1/tasks/ | Create Task|
 |[**deleteTaskV1TasksDelete**](#deletetaskv1tasksdelete) | **DELETE** /v1/tasks/ | Delete Task|
+|[**getTaskSchedulerStatusV1TasksScheduleTaskIdStatusGet**](#gettaskschedulerstatusv1tasksscheduletaskidstatusget) | **GET** /v1/tasks/schedule/{task_id}/status | Get Task Scheduler Status|
 |[**getTaskV1TasksGetTaskIdGet**](#gettaskv1tasksgettaskidget) | **GET** /v1/tasks/get/{task_id} | Get Task|
 |[**listTasksForCompanyV1TasksCompanyGet**](#listtasksforcompanyv1taskscompanyget) | **GET** /v1/tasks/company | List Tasks For Company|
 |[**listTasksForUserV1TasksUserGet**](#listtasksforuserv1tasksuserget) | **GET** /v1/tasks/user | List Tasks For User|
@@ -121,6 +122,64 @@ No authorization required
  - **Accept**: application/json
 
 
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Successful Response |  -  |
+|**422** | Validation Error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **getTaskSchedulerStatusV1TasksScheduleTaskIdStatusGet**
+> TaskStatusResponse getTaskSchedulerStatusV1TasksScheduleTaskIdStatusGet()
+
+Check the status of a task scheduler background job
+
+### Example
+
+```typescript
+import {
+    TasksApi,
+    Configuration
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new TasksApi(configuration);
+
+let taskId: string; // (default to undefined)
+let authorization: string; // (optional) (default to undefined)
+let sessionId: string; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.getTaskSchedulerStatusV1TasksScheduleTaskIdStatusGet(
+    taskId,
+    authorization,
+    sessionId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **taskId** | [**string**] |  | defaults to undefined|
+| **authorization** | [**string**] |  | (optional) defaults to undefined|
+| **sessionId** | [**string**] |  | (optional) defaults to undefined|
+
+
+### Return type
+
+**TaskStatusResponse**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
 ### HTTP response details
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
@@ -349,7 +408,7 @@ No authorization required
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
 
 # **requestTaskSchedulingV1TasksSchedulePost**
-> Details requestTaskSchedulingV1TasksSchedulePost(schedulerRequest)
+> SchedulerResponse requestTaskSchedulingV1TasksSchedulePost(schedulerRequest)
 
 
 ### Example
@@ -386,7 +445,7 @@ const { status, data } = await apiInstance.requestTaskSchedulingV1TasksScheduleP
 
 ### Return type
 
-**Details**
+**SchedulerResponse**
 
 ### Authorization
 

package/package.json

@@ -4,7 +4,7 @@
     "openapi-generator-cli": "^1.0.0"
   },
   "name": "@rasadov/lumoar-sdk",
-  "version": "1.2.6",
+  "version": "1.3.0",
   "description": "Lumoar API SDK",
   "main": "dist/index.js",
   "directories": {