@product-live/api-sdk 2.5.1 → 2.8.1

package/README.md

@@ -0,0 +1,80 @@
+## @
+
+This generator creates TypeScript/JavaScript client that utilizes fetch-api.
+
+### Building
+
+To build and compile the typescript sources to javascript use:
+```
+npm install
+npm run build
+```
+
+### Publishing
+
+First build the package then run ```npm publish```
+
+### Consuming
+
+Navigate to the folder of your consuming project and run one of the following commands.
+
+_published:_
+
+```
+npm install @ --save
+```
+
+_unPublished (not recommended):_
+
+```
+npm install PATH_TO_GENERATED_PACKAGE --save
+```
+
+### Usage
+
+Below code snippet shows exemplary usage of the configuration and the API based 
+on the typical `PetStore` example used for OpenAPI. 
+
+```
+import * as your_api from 'your_api_package'
+
+// Covers all auth methods included in your OpenAPI yaml definition
+const authConfig: your_api.AuthMethodsConfiguration = {
+    "api_key": "YOUR_API_KEY"
+}
+
+// Implements a simple middleware to modify requests before (`pre`) they are sent
+// and after (`post`) they have been received 
+class Test implements your_api.Middleware {
+    pre(context: your_api.RequestContext): Promise<your_api.RequestContext> {
+        // Modify context here and return
+        return Promise.resolve(context);
+    }
+
+    post(context: your_api.ResponseContext): Promise<your_api.ResponseContext> {
+        return Promise.resolve(context);
+    }
+
+}
+
+// Create configuration parameter object
+const configurationParameters = {
+    httpApi: new your_api.JQueryHttpLibrary(), // Can also be ignored - default is usually fine
+    baseServer: your_api.servers[0], // First server is default
+    authMethods: authConfig, // No auth is default
+    promiseMiddleware: [new Test()],
+}
+
+// Convert to actual configuration
+const config = your_api.createConfiguration(configurationParameters);
+
+// Use configuration with your_api
+const api = new your_api.PetApi(config);
+your_api.Pet p = new your_api.Pet();
+p.name = "My new pet";
+p.photoUrls = [];
+p.tags = [];
+p.status = "available";
+Promise<your_api.Pet> createdPet = api.addPet(p);
+
+```

package/TaskApi.md

@@ -0,0 +1,375 @@
+# .TaskApi
+
+All URIs are relative to *http://localhost*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**createTask**](TaskApi.md#createTask) | **POST** /v1/data_factory/tasks | (Experimental) - Create a Task
+[**deleteTask**](TaskApi.md#deleteTask) | **DELETE** /v1/data_factory/tasks/{id} | (Experimental) - Delete a Task by id
+[**getTaskById**](TaskApi.md#getTaskById) | **GET** /v1/data_factory/tasks/{id} | (Experimental) - Get a Task by id
+[**getTasks**](TaskApi.md#getTasks) | **GET** /v1/data_factory/tasks | (Experimental) - Get a list of Task
+[**pollTaskExecution**](TaskApi.md#pollTaskExecution) | **GET** /v1/data_factory/tasks/{id}/poll | (Experimental) - Poll a task if there is not task to poll, the API returns a `404 Not Found` error
+[**updateTask**](TaskApi.md#updateTask) | **PUT** /v1/data_factory/tasks/{id} | (Experimental) - Update a Task
+
+
+# **createTask**
+> TaskDto createTask(createTaskDto)
+
+
+### Example
+
+
+```typescript
+import {  } from '';
+import * as fs from 'fs';
+
+const configuration = .createConfiguration();
+const apiInstance = new .TaskApi(configuration);
+
+let body:.TaskApiCreateTaskRequest = {
+  // CreateTaskDto
+  createTaskDto: {
+    key: "key_example",
+    description: "description_example",
+    retryCount: 3.14,
+    inputKeys: [
+      {},
+    ],
+    outputKeys: [
+      {},
+    ],
+  },
+};
+
+apiInstance.createTask(body).then((data:any) => {
+  console.log('API called successfully. Returned data: ' + data);
+}).catch((error:any) => console.error(error));
+```
+
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **createTaskDto** | **CreateTaskDto**|  |
+
+
+### Return type
+
+**TaskDto**
+
+### Authorization
+
+[ApiKeyAuthQuery](README.md#ApiKeyAuthQuery), [ApiKeyAuthHeader](README.md#ApiKeyAuthHeader)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**201** | Task successfully created |  -  |
+**400** | Bad Request - Malformed syntax |  -  |
+**401** | Unauthorized |  -  |
+
+[[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)
+
+# **deleteTask**
+> TaskDto deleteTask()
+
+
+### Example
+
+
+```typescript
+import {  } from '';
+import * as fs from 'fs';
+
+const configuration = .createConfiguration();
+const apiInstance = new .TaskApi(configuration);
+
+let body:.TaskApiDeleteTaskRequest = {
+  // string
+  id: "id_example",
+};
+
+apiInstance.deleteTask(body).then((data:any) => {
+  console.log('API called successfully. Returned data: ' + data);
+}).catch((error:any) => console.error(error));
+```
+
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | [**string**] |  | defaults to undefined
+
+
+### Return type
+
+**TaskDto**
+
+### Authorization
+
+[ApiKeyAuthQuery](README.md#ApiKeyAuthQuery), [ApiKeyAuthHeader](README.md#ApiKeyAuthHeader)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**201** | Task with request id successfully deleted |  -  |
+**400** | Bad Request - Malformed syntax |  -  |
+**401** | Unauthorized |  -  |
+**404** | 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)
+
+# **getTaskById**
+> TaskDto getTaskById()
+
+
+### Example
+
+
+```typescript
+import {  } from '';
+import * as fs from 'fs';
+
+const configuration = .createConfiguration();
+const apiInstance = new .TaskApi(configuration);
+
+let body:.TaskApiGetTaskByIdRequest = {
+  // string
+  id: "id_example",
+};
+
+apiInstance.getTaskById(body).then((data:any) => {
+  console.log('API called successfully. Returned data: ' + data);
+}).catch((error:any) => console.error(error));
+```
+
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | [**string**] |  | defaults to undefined
+
+
+### Return type
+
+**TaskDto**
+
+### Authorization
+
+[ApiKeyAuthQuery](README.md#ApiKeyAuthQuery), [ApiKeyAuthHeader](README.md#ApiKeyAuthHeader)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | Task with request id successfully retrieved |  -  |
+**400** | Bad Request - Malformed syntax |  -  |
+**401** | Unauthorized |  -  |
+**404** | 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)
+
+# **getTasks**
+> GetTasks200Response getTasks()
+
+
+### Example
+
+
+```typescript
+import {  } from '';
+import * as fs from 'fs';
+
+const configuration = .createConfiguration();
+const apiInstance = new .TaskApi(configuration);
+
+let body:.TaskApiGetTasksRequest = {
+  // number (optional)
+  size: 10,
+  // number (optional)
+  page: 0,
+};
+
+apiInstance.getTasks(body).then((data:any) => {
+  console.log('API called successfully. Returned data: ' + data);
+}).catch((error:any) => console.error(error));
+```
+
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **size** | [**number**] |  | (optional) defaults to 10
+ **page** | [**number**] |  | (optional) defaults to 0
+
+
+### Return type
+
+**GetTasks200Response**
+
+### Authorization
+
+[ApiKeyAuthQuery](README.md#ApiKeyAuthQuery), [ApiKeyAuthHeader](README.md#ApiKeyAuthHeader)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | Get a list of Task |  -  |
+**400** | Bad Request - Malformed syntax |  -  |
+**401** | Unauthorized |  -  |
+
+[[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)
+
+# **pollTaskExecution**
+> TaskExecutionDto pollTaskExecution()
+
+
+### Example
+
+
+```typescript
+import {  } from '';
+import * as fs from 'fs';
+
+const configuration = .createConfiguration();
+const apiInstance = new .TaskApi(configuration);
+
+let body:.TaskApiPollTaskExecutionRequest = {
+  // string
+  id: "id_example",
+};
+
+apiInstance.pollTaskExecution(body).then((data:any) => {
+  console.log('API called successfully. Returned data: ' + data);
+}).catch((error:any) => console.error(error));
+```
+
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | [**string**] |  | defaults to undefined
+
+
+### Return type
+
+**TaskExecutionDto**
+
+### Authorization
+
+[ApiKeyAuthQuery](README.md#ApiKeyAuthQuery), [ApiKeyAuthHeader](README.md#ApiKeyAuthHeader)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | A task is polled return a task execution |  -  |
+**400** | Bad Request - Malformed syntax |  -  |
+**401** | Unauthorized |  -  |
+**404** | 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)
+
+# **updateTask**
+> TaskDto updateTask(updateTaskDto)
+
+
+### Example
+
+
+```typescript
+import {  } from '';
+import * as fs from 'fs';
+
+const configuration = .createConfiguration();
+const apiInstance = new .TaskApi(configuration);
+
+let body:.TaskApiUpdateTaskRequest = {
+  // string
+  id: "id_example",
+  // UpdateTaskDto
+  updateTaskDto: {
+    key: "key_example",
+    description: "description_example",
+    retryCount: 3.14,
+    inputKeys: [
+      {},
+    ],
+    outputKeys: [
+      {},
+    ],
+    id: "id_example",
+  },
+};
+
+apiInstance.updateTask(body).then((data:any) => {
+  console.log('API called successfully. Returned data: ' + data);
+}).catch((error:any) => console.error(error));
+```
+
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **updateTaskDto** | **UpdateTaskDto**|  |
+ **id** | [**string**] |  | defaults to undefined
+
+
+### Return type
+
+**TaskDto**
+
+### Authorization
+
+[ApiKeyAuthQuery](README.md#ApiKeyAuthQuery), [ApiKeyAuthHeader](README.md#ApiKeyAuthHeader)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**201** | Task successfully updated |  -  |
+**400** | Bad Request - Malformed syntax |  -  |
+**401** | Unauthorized |  -  |
+
+[[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/TaskExecutionApi.md

@@ -0,0 +1,130 @@
+# .TaskExecutionApi
+
+All URIs are relative to *http://localhost*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**getTaskExecutionById**](TaskExecutionApi.md#getTaskExecutionById) | **GET** /v1/data_factory/task_executions/{id} | (Experimental) - Get a Task execution by id
+[**patchTaskExecution**](TaskExecutionApi.md#patchTaskExecution) | **PATCH** /v1/data_factory/task_executions/{id} | (Experimental) - Update running task instance
+
+
+# **getTaskExecutionById**
+> TaskExecutionDto getTaskExecutionById()
+
+
+### Example
+
+
+```typescript
+import {  } from '';
+import * as fs from 'fs';
+
+const configuration = .createConfiguration();
+const apiInstance = new .TaskExecutionApi(configuration);
+
+let body:.TaskExecutionApiGetTaskExecutionByIdRequest = {
+  // string
+  id: "id_example",
+};
+
+apiInstance.getTaskExecutionById(body).then((data:any) => {
+  console.log('API called successfully. Returned data: ' + data);
+}).catch((error:any) => console.error(error));
+```
+
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | [**string**] |  | defaults to undefined
+
+
+### Return type
+
+**TaskExecutionDto**
+
+### Authorization
+
+[ApiKeyAuthQuery](README.md#ApiKeyAuthQuery), [ApiKeyAuthHeader](README.md#ApiKeyAuthHeader)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | Task execution with request id successfully retrieved |  -  |
+**400** | Bad Request - Malformed syntax |  -  |
+**401** | Unauthorized |  -  |
+**404** | 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)
+
+# **patchTaskExecution**
+> TaskExecutionDto patchTaskExecution(patchTaskExecutionDto)
+
+
+### Example
+
+
+```typescript
+import {  } from '';
+import * as fs from 'fs';
+
+const configuration = .createConfiguration();
+const apiInstance = new .TaskExecutionApi(configuration);
+
+let body:.TaskExecutionApiPatchTaskExecutionRequest = {
+  // string
+  id: "id_example",
+  // PatchTaskExecutionDto
+  patchTaskExecutionDto: {
+    id: "id_example",
+    status: "FAILED",
+    output: {},
+  },
+};
+
+apiInstance.patchTaskExecution(body).then((data:any) => {
+  console.log('API called successfully. Returned data: ' + data);
+}).catch((error:any) => console.error(error));
+```
+
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **patchTaskExecutionDto** | **PatchTaskExecutionDto**|  |
+ **id** | [**string**] |  | defaults to undefined
+
+
+### Return type
+
+**TaskExecutionDto**
+
+### Authorization
+
+[ApiKeyAuthQuery](README.md#ApiKeyAuthQuery), [ApiKeyAuthHeader](README.md#ApiKeyAuthHeader)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | Task execution updated successfully |  -  |
+**400** | Bad Request - Malformed syntax |  -  |
+**401** | Unauthorized |  -  |
+**404** | 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)
+
+