@product-live/api-sdk 2.23.0 → 2.26.0

package/JobApi.md

@@ -1,333 +0,0 @@
-# .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

@@ -1,185 +0,0 @@
-# .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)
-
-

package/README.md

@@ -1,80 +0,0 @@
-## @
-
-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);
-
-```