@product-live/api-sdk 2.23.0 → 2.38.0

package/VariableApi.md

@@ -1,315 +0,0 @@
-# .VariableApi
-
-All URIs are relative to *http://localhost*
-
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**createVariable**](VariableApi.md#createVariable) | **POST** /v1/data_factory/variables | (Experimental) - Create a Variable
-[**findVariables**](VariableApi.md#findVariables) | **POST** /v1/data_factory/variables/find | (Experimental) - Find a list of Variable
-[**getVariableById**](VariableApi.md#getVariableById) | **GET** /v1/data_factory/variables/{id} | (Experimental) - Get a Variable by id
-[**getVariables**](VariableApi.md#getVariables) | **GET** /v1/data_factory/variables | (Experimental) - Get a list of Variable
-[**updateVariable**](VariableApi.md#updateVariable) | **PUT** /v1/data_factory/variables/{id} | (Experimental) - Update a Variable
-
-
-# **createVariable**
-> VariableDto createVariable(createVariableDto)
-
-
-### Example
-
-
-```typescript
-import {  } from '';
-import * as fs from 'fs';
-
-const configuration = .createConfiguration();
-const apiInstance = new .VariableApi(configuration);
-
-let body:.VariableApiCreateVariableRequest = {
-  // CreateVariableDto
-  createVariableDto: {
-    key: "key_example",
-    name: "name_example",
-    status: "ACTIVE",
-    value: "value_example",
-    secret: true,
-  },
-};
-
-apiInstance.createVariable(body).then((data:any) => {
-  console.log('API called successfully. Returned data: ' + data);
-}).catch((error:any) => console.error(error));
-```
-
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **createVariableDto** | **CreateVariableDto**|  |
-
-
-### Return type
-
-**VariableDto**
-
-### 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** | Variable 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)
-
-# **findVariables**
-> GetVariables200Response findVariables(findVariablesRequest)
-
-
-### Example
-
-
-```typescript
-import {  } from '';
-import * as fs from 'fs';
-
-const configuration = .createConfiguration();
-const apiInstance = new .VariableApi(configuration);
-
-let body:.VariableApiFindVariablesRequest = {
-  // FindVariablesRequest
-  findVariablesRequest: null,
-  // number (optional)
-  size: 10,
-  // number (optional)
-  page: 0,
-};
-
-apiInstance.findVariables(body).then((data:any) => {
-  console.log('API called successfully. Returned data: ' + data);
-}).catch((error:any) => console.error(error));
-```
-
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **findVariablesRequest** | **FindVariablesRequest**|  |
- **size** | [**number**] |  | (optional) defaults to 10
- **page** | [**number**] |  | (optional) defaults to 0
-
-
-### Return type
-
-**GetVariables200Response**
-
-### 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** | Find a list of Variable |  -  |
-**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)
-
-# **getVariableById**
-> VariableDto getVariableById()
-
-
-### Example
-
-
-```typescript
-import {  } from '';
-import * as fs from 'fs';
-
-const configuration = .createConfiguration();
-const apiInstance = new .VariableApi(configuration);
-
-let body:.VariableApiGetVariableByIdRequest = {
-  // string
-  id: "id_example",
-};
-
-apiInstance.getVariableById(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
-
-**VariableDto**
-
-### 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** | Variable 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)
-
-# **getVariables**
-> GetVariables200Response getVariables()
-
-
-### Example
-
-
-```typescript
-import {  } from '';
-import * as fs from 'fs';
-
-const configuration = .createConfiguration();
-const apiInstance = new .VariableApi(configuration);
-
-let body:.VariableApiGetVariablesRequest = {
-  // number (optional)
-  size: 10,
-  // number (optional)
-  page: 0,
-};
-
-apiInstance.getVariables(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
-
-**GetVariables200Response**
-
-### 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 Variable |  -  |
-**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)
-
-# **updateVariable**
-> VariableDto updateVariable(updateVariableDto)
-
-
-### Example
-
-
-```typescript
-import {  } from '';
-import * as fs from 'fs';
-
-const configuration = .createConfiguration();
-const apiInstance = new .VariableApi(configuration);
-
-let body:.VariableApiUpdateVariableRequest = {
-  // string
-  id: "id_example",
-  // UpdateVariableDto
-  updateVariableDto: {
-    key: "key_example",
-    name: "name_example",
-    status: "ACTIVE",
-    value: "value_example",
-    secret: true,
-    id: "id_example",
-  },
-};
-
-apiInstance.updateVariable(body).then((data:any) => {
-  console.log('API called successfully. Returned data: ' + data);
-}).catch((error:any) => console.error(error));
-```
-
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **updateVariableDto** | **UpdateVariableDto**|  |
- **id** | [**string**] |  | defaults to undefined
-
-
-### Return type
-
-**VariableDto**
-
-### 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** | Variable 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/apis/DataFactoryFileApi.ts

@@ -1,307 +0,0 @@
-// TODO: better import syntax?
-import {BaseAPIRequestFactory, RequiredError, COLLECTION_FORMATS} from './baseapi';
-import {Configuration} from '../configuration';
-import {RequestContext, HttpMethod, ResponseContext, HttpFile} from '../http/http';
-import * as FormData from "form-data";
-import { URLSearchParams } from 'url';
-import {ObjectSerializer} from '../models/ObjectSerializer';
-import {ApiException} from './exception';
-import {canConsumeForm, isCodeInRange} from '../util';
-import {SecurityAuthentication} from '../auth/auth';
-
-
-import { FileDto } from '../models/FileDto';
-import { GetFiles200Response } from '../models/GetFiles200Response';
-import { GetJobExecutionById400Response } from '../models/GetJobExecutionById400Response';
-
-/**
- * no description
- */
-export class DataFactoryFileApiRequestFactory extends BaseAPIRequestFactory {
-
-    /**
-     * (Experimental) - Get a Data Factory File by id
-     * @param id 
-     */
-    public async getFileById(id: string, _options?: Configuration): Promise<RequestContext> {
-        let _config = _options || this.configuration;
-
-        // verify required parameter 'id' is not null or undefined
-        if (id === null || id === undefined) {
-            throw new RequiredError("DataFactoryFileApi", "getFileById", "id");
-        }
-
-
-        // Path Params
-        const localVarPath = '/v1/data_factory/files/{id}'
-            .replace('{' + 'id' + '}', encodeURIComponent(String(id)));
-
-        // Make Request Context
-        const requestContext = _config.baseServer.makeRequestContext(localVarPath, HttpMethod.GET);
-        requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8")
-
-
-        let authMethod: SecurityAuthentication | undefined;
-        // Apply auth methods
-        authMethod = _config.authMethods["ApiKeyAuthQuery"]
-        if (authMethod?.applySecurityAuthentication) {
-            await authMethod?.applySecurityAuthentication(requestContext);
-        }
-        // Apply auth methods
-        authMethod = _config.authMethods["ApiKeyAuthHeader"]
-        if (authMethod?.applySecurityAuthentication) {
-            await authMethod?.applySecurityAuthentication(requestContext);
-        }
-        
-        const defaultAuth: SecurityAuthentication | undefined = _options?.authMethods?.default || this.configuration?.authMethods?.default
-        if (defaultAuth?.applySecurityAuthentication) {
-            await defaultAuth?.applySecurityAuthentication(requestContext);
-        }
-
-        return requestContext;
-    }
-
-    /**
-     * (Experimental) - Get a list of Data Factory File
-     * @param size 
-     * @param page 
-     */
-    public async getFiles(size?: number, page?: number, _options?: Configuration): Promise<RequestContext> {
-        let _config = _options || this.configuration;
-
-
-
-        // Path Params
-        const localVarPath = '/v1/data_factory/files';
-
-        // Make Request Context
-        const requestContext = _config.baseServer.makeRequestContext(localVarPath, HttpMethod.GET);
-        requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8")
-
-        // Query Params
-        if (size !== undefined) {
-            requestContext.setQueryParam("size", ObjectSerializer.serialize(size, "number", ""));
-        }
-
-        // Query Params
-        if (page !== undefined) {
-            requestContext.setQueryParam("page", ObjectSerializer.serialize(page, "number", ""));
-        }
-
-
-        let authMethod: SecurityAuthentication | undefined;
-        // Apply auth methods
-        authMethod = _config.authMethods["ApiKeyAuthQuery"]
-        if (authMethod?.applySecurityAuthentication) {
-            await authMethod?.applySecurityAuthentication(requestContext);
-        }
-        // Apply auth methods
-        authMethod = _config.authMethods["ApiKeyAuthHeader"]
-        if (authMethod?.applySecurityAuthentication) {
-            await authMethod?.applySecurityAuthentication(requestContext);
-        }
-        
-        const defaultAuth: SecurityAuthentication | undefined = _options?.authMethods?.default || this.configuration?.authMethods?.default
-        if (defaultAuth?.applySecurityAuthentication) {
-            await defaultAuth?.applySecurityAuthentication(requestContext);
-        }
-
-        return requestContext;
-    }
-
-    /**
-     * Post a file so it can be consume by a Data Factory job
-     * @param file 
-     */
-    public async uploadFile(file: HttpFile, _options?: Configuration): Promise<RequestContext> {
-        let _config = _options || this.configuration;
-
-        // verify required parameter 'file' is not null or undefined
-        if (file === null || file === undefined) {
-            throw new RequiredError("DataFactoryFileApi", "uploadFile", "file");
-        }
-
-
-        // Path Params
-        const localVarPath = '/v1/data_factory/files';
-
-        // Make Request Context
-        const requestContext = _config.baseServer.makeRequestContext(localVarPath, HttpMethod.POST);
-        requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8")
-
-        // Form Params
-        const useForm = canConsumeForm([
-            'multipart/form-data',
-        ]);
-
-        let localVarFormParams
-        if (useForm) {
-            localVarFormParams = new FormData();
-        } else {
-            localVarFormParams = new URLSearchParams();
-        }
-
-        if (file !== undefined) {
-             // TODO: replace .append with .set
-             if (localVarFormParams instanceof FormData) {
-                 localVarFormParams.append('file', file.data, file.name);
-             }
-        }
-
-        requestContext.setBody(localVarFormParams);
-
-        if(!useForm) {
-            const contentType = ObjectSerializer.getPreferredMediaType([
-                "multipart/form-data"
-            ]);
-            requestContext.setHeaderParam("Content-Type", contentType);
-        }
-
-        let authMethod: SecurityAuthentication | undefined;
-        // Apply auth methods
-        authMethod = _config.authMethods["ApiKeyAuthQuery"]
-        if (authMethod?.applySecurityAuthentication) {
-            await authMethod?.applySecurityAuthentication(requestContext);
-        }
-        // Apply auth methods
-        authMethod = _config.authMethods["ApiKeyAuthHeader"]
-        if (authMethod?.applySecurityAuthentication) {
-            await authMethod?.applySecurityAuthentication(requestContext);
-        }
-        
-        const defaultAuth: SecurityAuthentication | undefined = _options?.authMethods?.default || this.configuration?.authMethods?.default
-        if (defaultAuth?.applySecurityAuthentication) {
-            await defaultAuth?.applySecurityAuthentication(requestContext);
-        }
-
-        return requestContext;
-    }
-
-}
-
-export class DataFactoryFileApiResponseProcessor {
-
-    /**
-     * Unwraps the actual response sent by the server from the response context and deserializes the response content
-     * to the expected objects
-     *
-     * @params response Response returned by the server for a request to getFileById
-     * @throws ApiException if the response code was not in [200, 299]
-     */
-     public async getFileById(response: ResponseContext): Promise<FileDto > {
-        const contentType = ObjectSerializer.normalizeMediaType(response.headers["content-type"]);
-        if (isCodeInRange("200", response.httpStatusCode)) {
-            const body: FileDto = ObjectSerializer.deserialize(
-                ObjectSerializer.parse(await response.body.text(), contentType),
-                "FileDto", ""
-            ) as FileDto;
-            return body;
-        }
-        if (isCodeInRange("400", response.httpStatusCode)) {
-            const body: GetJobExecutionById400Response = ObjectSerializer.deserialize(
-                ObjectSerializer.parse(await response.body.text(), contentType),
-                "GetJobExecutionById400Response", ""
-            ) as GetJobExecutionById400Response;
-            throw new ApiException<GetJobExecutionById400Response>(response.httpStatusCode, "Bad Request - Malformed syntax", body, response.headers);
-        }
-        if (isCodeInRange("401", response.httpStatusCode)) {
-            throw new ApiException<undefined>(response.httpStatusCode, "Unauthorized", undefined, response.headers);
-        }
-        if (isCodeInRange("404", response.httpStatusCode)) {
-            throw new ApiException<undefined>(response.httpStatusCode, "Not found", undefined, response.headers);
-        }
-
-        // Work around for missing responses in specification, e.g. for petstore.yaml
-        if (response.httpStatusCode >= 200 && response.httpStatusCode <= 299) {
-            const body: FileDto = ObjectSerializer.deserialize(
-                ObjectSerializer.parse(await response.body.text(), contentType),
-                "FileDto", ""
-            ) as FileDto;
-            return body;
-        }
-
-        throw new ApiException<string | Buffer | undefined>(response.httpStatusCode, "Unknown API Status Code!", await response.getBodyAsAny(), response.headers);
-    }
-
-    /**
-     * Unwraps the actual response sent by the server from the response context and deserializes the response content
-     * to the expected objects
-     *
-     * @params response Response returned by the server for a request to getFiles
-     * @throws ApiException if the response code was not in [200, 299]
-     */
-     public async getFiles(response: ResponseContext): Promise<GetFiles200Response > {
-        const contentType = ObjectSerializer.normalizeMediaType(response.headers["content-type"]);
-        if (isCodeInRange("200", response.httpStatusCode)) {
-            const body: GetFiles200Response = ObjectSerializer.deserialize(
-                ObjectSerializer.parse(await response.body.text(), contentType),
-                "GetFiles200Response", ""
-            ) as GetFiles200Response;
-            return body;
-        }
-        if (isCodeInRange("400", response.httpStatusCode)) {
-            const body: GetJobExecutionById400Response = ObjectSerializer.deserialize(
-                ObjectSerializer.parse(await response.body.text(), contentType),
-                "GetJobExecutionById400Response", ""
-            ) as GetJobExecutionById400Response;
-            throw new ApiException<GetJobExecutionById400Response>(response.httpStatusCode, "Bad Request - Malformed syntax", body, response.headers);
-        }
-        if (isCodeInRange("401", response.httpStatusCode)) {
-            throw new ApiException<undefined>(response.httpStatusCode, "Unauthorized", undefined, response.headers);
-        }
-
-        // Work around for missing responses in specification, e.g. for petstore.yaml
-        if (response.httpStatusCode >= 200 && response.httpStatusCode <= 299) {
-            const body: GetFiles200Response = ObjectSerializer.deserialize(
-                ObjectSerializer.parse(await response.body.text(), contentType),
-                "GetFiles200Response", ""
-            ) as GetFiles200Response;
-            return body;
-        }
-
-        throw new ApiException<string | Buffer | undefined>(response.httpStatusCode, "Unknown API Status Code!", await response.getBodyAsAny(), response.headers);
-    }
-
-    /**
-     * Unwraps the actual response sent by the server from the response context and deserializes the response content
-     * to the expected objects
-     *
-     * @params response Response returned by the server for a request to uploadFile
-     * @throws ApiException if the response code was not in [200, 299]
-     */
-     public async uploadFile(response: ResponseContext): Promise<FileDto > {
-        const contentType = ObjectSerializer.normalizeMediaType(response.headers["content-type"]);
-        if (isCodeInRange("201", response.httpStatusCode)) {
-            const body: FileDto = ObjectSerializer.deserialize(
-                ObjectSerializer.parse(await response.body.text(), contentType),
-                "FileDto", ""
-            ) as FileDto;
-            return body;
-        }
-        if (isCodeInRange("400", response.httpStatusCode)) {
-            throw new ApiException<undefined>(response.httpStatusCode, "Bad Request - Malformed syntax", undefined, response.headers);
-        }
-        if (isCodeInRange("401", response.httpStatusCode)) {
-            throw new ApiException<undefined>(response.httpStatusCode, "Unauthorized", undefined, response.headers);
-        }
-        if (isCodeInRange("413", response.httpStatusCode)) {
-            const body: GetJobExecutionById400Response = ObjectSerializer.deserialize(
-                ObjectSerializer.parse(await response.body.text(), contentType),
-                "GetJobExecutionById400Response", ""
-            ) as GetJobExecutionById400Response;
-            throw new ApiException<GetJobExecutionById400Response>(response.httpStatusCode, "Request Entity Too Large", body, response.headers);
-        }
-
-        // Work around for missing responses in specification, e.g. for petstore.yaml
-        if (response.httpStatusCode >= 200 && response.httpStatusCode <= 299) {
-            const body: FileDto = ObjectSerializer.deserialize(
-                ObjectSerializer.parse(await response.body.text(), contentType),
-                "FileDto", ""
-            ) as FileDto;
-            return body;
-        }
-
-        throw new ApiException<string | Buffer | undefined>(response.httpStatusCode, "Unknown API Status Code!", await response.getBodyAsAny(), response.headers);
-    }
-
-}