@caraer/client 2.0.437 → 2.0.442

package/docs/FeedsApi.md

@@ -7,7 +7,7 @@ All URIs are relative to *https://v2.api.caraer.com*
 |[**index1**](#index1) | **POST** /api/v2/feeds/index | List feeds|
 
 # **index1**
-> any index1(body)
+> PaginationResponseFeedDTO index1(paginationRequest)
 
 
 ### Example
@@ -15,16 +15,17 @@ All URIs are relative to *https://v2.api.caraer.com*
 ```typescript
 import {
     FeedsApi,
-    Configuration
+    Configuration,
+    PaginationRequest
 } from '@caraer/client';
 
 const configuration = new Configuration();
 const apiInstance = new FeedsApi(configuration);
 
-let body: any; //
+let paginationRequest: PaginationRequest; //
 
 const { status, data } = await apiInstance.index1(
-    body
+    paginationRequest
 );
 ```
 
@@ -32,12 +33,12 @@ const { status, data } = await apiInstance.index1(
 
 |Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
-| **body** | **any**|  | |
+| **paginationRequest** | **PaginationRequest**|  | |
 
 
 ### Return type
 
-**any**
+**PaginationResponseFeedDTO**
 
 ### Authorization
 
@@ -53,6 +54,10 @@ const { status, data } = await apiInstance.index1(
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
 |**200** | OK |  -  |
+|**401** | Authentication is required or the token is invalid. |  -  |
+|**403** | The caller is missing a required role or scope. |  -  |
+|**404** | The requested resource was not found. |  -  |
+|**500** | An internal server error occurred. |  -  |
 
 [[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)
 

package/docs/FileManagementApi.md

@@ -10,7 +10,7 @@ All URIs are relative to *https://v2.api.caraer.com*
 |[**uploadFile2**](#uploadfile2) | **POST** /api/v2/files/ | Upload files|
 
 # **deleteFile**
-> SuccessResponse deleteFile()
+> SuccessResponseVoid deleteFile()
 
 Deletes a file from the S3-compatible storage identified by its unique key.
 
@@ -41,7 +41,7 @@ const { status, data } = await apiInstance.deleteFile(
 
 ### Return type
 
-**SuccessResponse**
+**SuccessResponseVoid**
 
 ### Authorization
 
@@ -59,11 +59,13 @@ const { status, data } = await apiInstance.deleteFile(
 |**200** | File deleted successfully. |  -  |
 |**404** | File not found. |  -  |
 |**500** | Internal server error. |  -  |
+|**401** | Authentication is required or the token is invalid. |  -  |
+|**403** | The caller is missing a required role or scope. |  -  |
 
 [[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)
 
 # **downloadFile**
-> SuccessResponse downloadFile()
+> SuccessResponseString downloadFile()
 
 Generates a pre-signed URL to download a file stored in S3-compatible storage. The URL expiry time and download behavior can be specified using the query parameters.
 
@@ -100,7 +102,7 @@ const { status, data } = await apiInstance.downloadFile(
 
 ### Return type
 
-**SuccessResponse**
+**SuccessResponseString**
 
 ### Authorization
 
@@ -118,11 +120,13 @@ const { status, data } = await apiInstance.downloadFile(
 |**200** | File URL generated successfully. |  -  |
 |**404** | File not found. |  -  |
 |**500** | Internal server error. |  -  |
+|**401** | Authentication is required or the token is invalid. |  -  |
+|**403** | The caller is missing a required role or scope. |  -  |
 
 [[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)
 
 # **listFiles**
-> SuccessResponse listFiles()
+> SuccessResponseListString listFiles()
 
 Lists all files stored in the system or, if a record UUID is provided, lists the files related to that record.
 
@@ -153,7 +157,7 @@ const { status, data } = await apiInstance.listFiles(
 
 ### Return type
 
-**SuccessResponse**
+**SuccessResponseListString**
 
 ### Authorization
 
@@ -170,11 +174,14 @@ const { status, data } = await apiInstance.listFiles(
 |-------------|-------------|------------------|
 |**200** | Files listed successfully. |  -  |
 |**500** | Internal server error. |  -  |
+|**401** | Authentication is required or the token is invalid. |  -  |
+|**403** | The caller is missing a required role or scope. |  -  |
+|**404** | The requested resource was not found. |  -  |
 
 [[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)
 
 # **uploadFile2**
-> SuccessResponse uploadFile2()
+> SuccessResponseListString uploadFile2()
 
 Uploads multiple files to an S3-compatible storage and returns their unique keys. The request must contain one or more files in multipart/form-data format.
 
@@ -205,7 +212,7 @@ const { status, data } = await apiInstance.uploadFile2(
 
 ### Return type
 
-**SuccessResponse**
+**SuccessResponseListString**
 
 ### Authorization
 
@@ -222,7 +229,10 @@ const { status, data } = await apiInstance.uploadFile2(
 |-------------|-------------|------------------|
 |**200** | Files uploaded successfully. |  -  |
 |**400** | Invalid input, e.g., file size exceeds the limit. |  -  |
-|**500** | Internal server error. |  -  |
+|**500** | An internal server error occurred. |  -  |
+|**401** | Authentication is required or the token is invalid. |  -  |
+|**403** | The caller is missing a required role or scope. |  -  |
+|**404** | The requested resource was not found. |  -  |
 
 [[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)
 

package/docs/FilterApi.md

@@ -61,6 +61,9 @@ const { status, data } = await apiInstance.createFilter(
 |**201** | Filter created successfully |  -  |
 |**400** | Invalid input data |  -  |
 |**500** | Internal server error |  -  |
+|**401** | Authentication is required or the token is invalid. |  -  |
+|**403** | The caller is missing a required role or scope. |  -  |
+|**404** | The requested resource was not found. |  -  |
 
 [[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)
 
@@ -114,11 +117,13 @@ const { status, data } = await apiInstance.deleteFilter(
 |**200** | Filter deleted successfully |  -  |
 |**404** | Filter not found |  -  |
 |**500** | Internal server error |  -  |
+|**401** | Authentication is required or the token is invalid. |  -  |
+|**403** | The caller is missing a required role or scope. |  -  |
 
 [[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)
 
 # **getFilter**
-> ShowResponse getFilter()
+> ShowResponseSavedFilterDTO getFilter()
 
 Retrieves details of a saved filter by its UUID.
 
@@ -149,7 +154,7 @@ const { status, data } = await apiInstance.getFilter(
 
 ### Return type
 
-**ShowResponse**
+**ShowResponseSavedFilterDTO**
 
 ### Authorization
 
@@ -167,11 +172,13 @@ const { status, data } = await apiInstance.getFilter(
 |**200** | Filter retrieved successfully |  -  |
 |**404** | Filter not found |  -  |
 |**500** | Internal server error |  -  |
+|**401** | Authentication is required or the token is invalid. |  -  |
+|**403** | The caller is missing a required role or scope. |  -  |
 
 [[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)
 
 # **getFilters**
-> PaginationResponse getFilters(body)
+> PaginationResponseSavedFilterDTO getFilters(paginationRequest)
 
 Fetches a paginated list of saved filters. The request body should contain pagination details such as limit, page, filters, and sort.
 
@@ -180,18 +187,19 @@ Fetches a paginated list of saved filters. The request body should contain pagin
 ```typescript
 import {
     FilterApi,
-    Configuration
+    Configuration,
+    PaginationRequest
 } from '@caraer/client';
 
 const configuration = new Configuration();
 const apiInstance = new FilterApi(configuration);
 
 let objectUuid: string; // (default to undefined)
-let body: any; //Pagination request details
+let paginationRequest: PaginationRequest; //Pagination request details
 
 const { status, data } = await apiInstance.getFilters(
     objectUuid,
-    body
+    paginationRequest
 );
 ```
 
@@ -199,13 +207,13 @@ const { status, data } = await apiInstance.getFilters(
 
 |Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
-| **body** | **any**| Pagination request details | |
+| **paginationRequest** | **PaginationRequest**| Pagination request details | |
 | **objectUuid** | [**string**] |  | defaults to undefined|
 
 
 ### Return type
 
-**PaginationResponse**
+**PaginationResponseSavedFilterDTO**
 
 ### Authorization
 
@@ -223,6 +231,9 @@ const { status, data } = await apiInstance.getFilters(
 |**200** | Filters fetched successfully |  -  |
 |**400** | Bad request |  -  |
 |**500** | Internal server error |  -  |
+|**401** | Authentication is required or the token is invalid. |  -  |
+|**403** | The caller is missing a required role or scope. |  -  |
+|**404** | The requested resource was not found. |  -  |
 
 [[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)
 
@@ -281,6 +292,8 @@ const { status, data } = await apiInstance.updateFilter(
 |**400** | Invalid input data |  -  |
 |**404** | Filter not found |  -  |
 |**500** | Internal server error |  -  |
+|**401** | Authentication is required or the token is invalid. |  -  |
+|**403** | The caller is missing a required role or scope. |  -  |
 
 [[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)
 

package/docs/FlowPaginationRequest.md

@@ -0,0 +1,43 @@
+# FlowPaginationRequest
+
+Request DTO for paginated data flow with filters, sorting, displayed items, and related information.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**crud** | [**CRUD**](CRUD.md) |  | [optional] [default to undefined]
+**showItems** | [**Set<ShowItem>**](ShowItem.md) |  | [optional] [default to undefined]
+**page** | **number** | The page index (one-based) to request. | [optional] [default to undefined]
+**limit** | **number** | The number of records to retrieve per page. | [optional] [default to undefined]
+**filter** | [**Filter**](Filter.md) | Filters applied to the query. | [optional] [default to undefined]
+**sort** | [**Set<SortItem>**](SortItem.md) | Sorting options for the query. | [optional] [default to undefined]
+**show** | [**Array<ShowItem>**](ShowItem.md) | Specifies what data to show in the response. | [optional] [default to undefined]
+**query** | **string** | A free-text search query applied to the records. | [optional] [default to undefined]
+**preview** | **string** | Preview information for the records, if supported. | [optional] [default to undefined]
+**mainObject** | **string** | The main object for categorization or context. | [optional] [default to undefined]
+**column** | **string** | Column name for sorting or filtering data | [optional] [default to undefined]
+**property** | **string** | UUID of the property used in the request | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { FlowPaginationRequest } from '@caraer/client';
+
+const instance: FlowPaginationRequest = {
+    crud,
+    showItems,
+    page,
+    limit,
+    filter,
+    sort,
+    show,
+    query,
+    preview,
+    mainObject,
+    column,
+    property,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)