@product-live/api-sdk 2.4.1 → 2.8.1

package/DataFactoryFileApi.md

@@ -0,0 +1,182 @@
+# .DataFactoryFileApi
+
+All URIs are relative to *http://localhost*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**getFileById**](DataFactoryFileApi.md#getFileById) | **GET** /v1/data_factory/files/{id} | (Experimental) - Get a Data Factory File by id
+[**getFiles**](DataFactoryFileApi.md#getFiles) | **GET** /v1/data_factory/files | (Experimental) - Get a list of Data Factory File
+[**uploadFile**](DataFactoryFileApi.md#uploadFile) | **POST** /v1/data_factory/files | Post a file so it can be consume by a Data Factory job
+
+
+# **getFileById**
+> FileDto getFileById()
+
+
+### Example
+
+
+```typescript
+import {  } from '';
+import * as fs from 'fs';
+
+const configuration = .createConfiguration();
+const apiInstance = new .DataFactoryFileApi(configuration);
+
+let body:.DataFactoryFileApiGetFileByIdRequest = {
+  // string
+  id: "id_example",
+};
+
+apiInstance.getFileById(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
+
+**FileDto**
+
+### 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** | Data Factory File 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)
+
+# **getFiles**
+> GetFiles200Response getFiles()
+
+
+### Example
+
+
+```typescript
+import {  } from '';
+import * as fs from 'fs';
+
+const configuration = .createConfiguration();
+const apiInstance = new .DataFactoryFileApi(configuration);
+
+let body:.DataFactoryFileApiGetFilesRequest = {
+  // number (optional)
+  size: 10,
+  // number (optional)
+  page: 0,
+};
+
+apiInstance.getFiles(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
+
+**GetFiles200Response**
+
+### 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 Data Factory File |  -  |
+**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)
+
+# **uploadFile**
+> FileDto uploadFile()
+
+
+### Example
+
+
+```typescript
+import {  } from '';
+import * as fs from 'fs';
+
+const configuration = .createConfiguration();
+const apiInstance = new .DataFactoryFileApi(configuration);
+
+let body:.DataFactoryFileApiUploadFileRequest = {
+  // HttpFile
+  file: { data: Buffer.from(fs.readFileSync('/path/to/file', 'utf-8')), name: '/path/to/file' },
+};
+
+apiInstance.uploadFile(body).then((data:any) => {
+  console.log('API called successfully. Returned data: ' + data);
+}).catch((error:any) => console.error(error));
+```
+
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **file** | [**HttpFile**] |  | defaults to undefined
+
+
+### Return type
+
+**FileDto**
+
+### Authorization
+
+[ApiKeyAuthQuery](README.md#ApiKeyAuthQuery), [ApiKeyAuthHeader](README.md#ApiKeyAuthHeader)
+
+### HTTP request headers
+
+ - **Content-Type**: multipart/form-data
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**201** | File successfully created |  -  |
+**400** | Bad Request - Malformed syntax |  -  |
+**401** | Unauthorized |  -  |
+**413** | Request Entity Too Large |  -  |
+
+[[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/JobApi.md

@@ -0,0 +1,333 @@
+# .JobApi
+
+All URIs are relative to *http://localhost*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**createJob**](JobApi.md#createJob) | **POST** /v1/data_factory/jobs | (Experimental) - Create a Job
+[**getJobById**](JobApi.md#getJobById) | **GET** /v1/data_factory/jobs/{id} | (Experimental) - Get a Job by id
+[**getJobs**](JobApi.md#getJobs) | **GET** /v1/data_factory/jobs | (Experimental) - Get a list of Job
+[**updateJob**](JobApi.md#updateJob) | **PUT** /v1/data_factory/jobs/{id} | (Experimental) - Update a Job
+[**updateJobZip**](JobApi.md#updateJobZip) | **PUT** /v1/data_factory/jobs/{id}/zip | (Experimental) - Upload a zip to update a job
+
+
+# **createJob**
+> JobDto createJob(createJobDto)
+
+
+### Example
+
+
+```typescript
+import {  } from '';
+import * as fs from 'fs';
+
+const configuration = .createConfiguration();
+const apiInstance = new .JobApi(configuration);
+
+let body:.JobApiCreateJobRequest = {
+  // CreateJobDto
+  createJobDto: {
+    key: "key_example",
+    periodicity: [
+      {},
+    ],
+    pipelineId: "pipelineId_example",
+    projectId: "projectId_example",
+    status: "DRAFT",
+    title: "title_example",
+    titleLocal: {},
+    description: "description_example",
+    descriptionLocal: {},
+    output: {},
+    tasks: [
+      {},
+    ],
+  },
+};
+
+apiInstance.createJob(body).then((data:any) => {
+  console.log('API called successfully. Returned data: ' + data);
+}).catch((error:any) => console.error(error));
+```
+
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **createJobDto** | **CreateJobDto**|  |
+
+
+### Return type
+
+**JobDto**
+
+### 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** | Job 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)
+
+# **getJobById**
+> JobDto getJobById()
+
+
+### Example
+
+
+```typescript
+import {  } from '';
+import * as fs from 'fs';
+
+const configuration = .createConfiguration();
+const apiInstance = new .JobApi(configuration);
+
+let body:.JobApiGetJobByIdRequest = {
+  // string
+  id: "id_example",
+};
+
+apiInstance.getJobById(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
+
+**JobDto**
+
+### 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** | Job 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)
+
+# **getJobs**
+> GetJobs200Response getJobs()
+
+
+### Example
+
+
+```typescript
+import {  } from '';
+import * as fs from 'fs';
+
+const configuration = .createConfiguration();
+const apiInstance = new .JobApi(configuration);
+
+let body:.JobApiGetJobsRequest = {
+  // number (optional)
+  size: 10,
+  // number (optional)
+  page: 0,
+};
+
+apiInstance.getJobs(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
+
+**GetJobs200Response**
+
+### 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 Job |  -  |
+**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)
+
+# **updateJob**
+> JobDto updateJob(updateJobDto)
+
+
+### Example
+
+
+```typescript
+import {  } from '';
+import * as fs from 'fs';
+
+const configuration = .createConfiguration();
+const apiInstance = new .JobApi(configuration);
+
+let body:.JobApiUpdateJobRequest = {
+  // string
+  id: "id_example",
+  // UpdateJobDto
+  updateJobDto: {
+    key: "key_example",
+    periodicity: [
+      {},
+    ],
+    pipelineId: "pipelineId_example",
+    projectId: "projectId_example",
+    status: "DRAFT",
+    title: "title_example",
+    titleLocal: {},
+    description: "description_example",
+    descriptionLocal: {},
+    output: {},
+    tasks: [
+      {},
+    ],
+    id: "id_example",
+  },
+};
+
+apiInstance.updateJob(body).then((data:any) => {
+  console.log('API called successfully. Returned data: ' + data);
+}).catch((error:any) => console.error(error));
+```
+
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **updateJobDto** | **UpdateJobDto**|  |
+ **id** | [**string**] |  | defaults to undefined
+
+
+### Return type
+
+**JobDto**
+
+### 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** | Job 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)
+
+# **updateJobZip**
+> JobDto updateJobZip()
+
+
+### Example
+
+
+```typescript
+import {  } from '';
+import * as fs from 'fs';
+
+const configuration = .createConfiguration();
+const apiInstance = new .JobApi(configuration);
+
+let body:.JobApiUpdateJobZipRequest = {
+  // string
+  id: "id_example",
+  // HttpFile
+  file: { data: Buffer.from(fs.readFileSync('/path/to/file', 'utf-8')), name: '/path/to/file' },
+};
+
+apiInstance.updateJobZip(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
+ **file** | [**HttpFile**] |  | defaults to undefined
+
+
+### Return type
+
+**JobDto**
+
+### Authorization
+
+[ApiKeyAuthQuery](README.md#ApiKeyAuthQuery), [ApiKeyAuthHeader](README.md#ApiKeyAuthHeader)
+
+### HTTP request headers
+
+ - **Content-Type**: multipart/form-data
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**201** | Zip successfully updated job |  -  |
+**400** | Bad Request - Malformed syntax |  -  |
+**401** | Unauthorized |  -  |
+**413** | Request Entity Too Large |  -  |
+
+[[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/JobExecutionApi.md

@@ -0,0 +1,185 @@
+# .JobExecutionApi
+
+All URIs are relative to *http://localhost*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**createJobExecution**](JobExecutionApi.md#createJobExecution) | **POST** /v1/data_factory/job_executions | (Experimental) - Create a Job execution
+[**getJobExecutionById**](JobExecutionApi.md#getJobExecutionById) | **GET** /v1/data_factory/job_executions/{id} | (Experimental) - Get a Job execution by id
+[**getJobExecutions**](JobExecutionApi.md#getJobExecutions) | **GET** /v1/data_factory/job_executions | (Experimental) - Get a list of Job execution
+
+
+# **createJobExecution**
+> JobExecutionDto createJobExecution(createJobExecutionDto)
+
+
+### Example
+
+
+```typescript
+import {  } from '';
+import * as fs from 'fs';
+
+const configuration = .createConfiguration();
+const apiInstance = new .JobExecutionApi(configuration);
+
+let body:.JobExecutionApiCreateJobExecutionRequest = {
+  // CreateJobExecutionDto
+  createJobExecutionDto: {
+    jobId: "jobId_example",
+    info: {},
+    input: {},
+  },
+};
+
+apiInstance.createJobExecution(body).then((data:any) => {
+  console.log('API called successfully. Returned data: ' + data);
+}).catch((error:any) => console.error(error));
+```
+
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **createJobExecutionDto** | **CreateJobExecutionDto**|  |
+
+
+### Return type
+
+**JobExecutionDto**
+
+### 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** | Job execution 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)
+
+# **getJobExecutionById**
+> JobExecutionDto getJobExecutionById()
+
+
+### Example
+
+
+```typescript
+import {  } from '';
+import * as fs from 'fs';
+
+const configuration = .createConfiguration();
+const apiInstance = new .JobExecutionApi(configuration);
+
+let body:.JobExecutionApiGetJobExecutionByIdRequest = {
+  // string
+  id: "id_example",
+};
+
+apiInstance.getJobExecutionById(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
+
+**JobExecutionDto**
+
+### 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** | Job 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)
+
+# **getJobExecutions**
+> GetJobExecutions200Response getJobExecutions()
+
+
+### Example
+
+
+```typescript
+import {  } from '';
+import * as fs from 'fs';
+
+const configuration = .createConfiguration();
+const apiInstance = new .JobExecutionApi(configuration);
+
+let body:.JobExecutionApiGetJobExecutionsRequest = {
+  // number (optional)
+  size: 10,
+  // number (optional)
+  page: 0,
+};
+
+apiInstance.getJobExecutions(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
+
+**GetJobExecutions200Response**
+
+### 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 Job execution |  -  |
+**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)
+
+